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.
Item | Field name | Format | Req’d | Notes |
Identifiers | identifiers | Y | See ”id” format detailed below | |
Patient Id | patientID | string | Y | id of the patient |
Active Status | active | Y or N | N | If used, only those with "Y" will be added to Mirah |
Full Name | name | string | Y | {last name}, {first name} |
Given Name | givenName | string | Y* | |
Family Name | familyName | string | Y* | |
Full Name | name | string | Y* | |
string | Y** | This is required if email assessments are planned to be sent for this related person | ||
Phone | phone | string | Y** | 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 |
Relationship | relationship | mother father guardian teacher child other | Y | Use one of the 4 below options: mother father guardian teacher child other |
(*) At least one name field is required.
(**) Either email or phone is required in order to send assessments to clients.