Skip to main content

Flat File Integration - Related People

File Name​

When sending the file to the server it should be named using the following format: "relatedpersons_{timestamp}.csv"

Which Data​

We suggest sending data for all related people

Notes on Naming Fields​

You may specify either:

  • Full name as one field
  • First (Given) and Last (Family) name separately.

Emails and Phone Numbers​

Mirah does not require you to send a phone number or an email in order for the integration to process. However, if customers wish to have related people receive notifications for assessments we strongly suggest that both are included.

Data Fields​

NOTE: Please follow all field name and note formats, including case sensitivity.

ItemField nameFormatReq’dNotes
IdentifiersidentifiersIdentityYSee ”id” format detailed below
Patient IdpatientIDstringYid of the patient
Active StatusactiveY or NNIf used, only those with "Y" will be added to Mirah
Full NamenamestringY{last name}, {first name}
Given NamegivenNamestringY*
Family NamefamilyNamestringY*
Full NamenamestringY*
EmailemailstringY**This is required if email assessments are planned to be sent for this related person
PhonephonestringY**E.g. (617) 5551212 See http://www.itu.int/rec/T-REC-E.123-200102-I/e for more complex casesThis is required if text messages are planned to be sent. If possible, send only cell phone numbers
RelationshiprelationshipmotherfatherguardianteacherchildotherYUse one of the 4 below options:motherfatherguardianteacherchildother

(*) At least one name field is required.

(**) Either email or phone is required in order to send assessments to clients.