Patient
Data container to represent Patient information.
Patient data has following elements:
| Name |
Type |
Desciption |
| patientID | (string) | Unique Patient Id (PM identifier). |
| patientNbr | (string) | Unique Patient#. (not supported in this version) |
| first | (string) | Patient first name. |
| middle | (string) | Patient middle initial. |
| last | (string) | Patient last name. |
| birthdate | (string) | Patient birth date. |
| sex | (string) | Patient gender. |
| SSN | (string) | Patient Sosical Security Number. (obsolete) |
| maritalStatus | (string) | Patient marital status. |
| employmentStatus | (string) | Patient employment status. |
| studentStatus | (string) | Patient student status. |
| preferredLanguage | (string) | Patient preferred language. |
| race | (string) | Patient race. |
| ethnicity | (string) | Patient ethnicity. |
| address | (object) | Address Data structure |
| contactInfo | (object) | ContactInfo Data structure |
| MarketingPlanId | (string) | Marketing plan Id of the patient. |
| MarketingComments | (string) | Marketing comments of the patient. |
| MarketingDetails | (string) | Marketing details of the patient. |
| ReferringProviderId | (string) | Id of the provider, who referred this patient. |
| facilityId | (string) | Location Id to get or create patient from/to (for multi-location practices only. Contact Sophrona support for more explanations.) |
Notes:
- maritalStatus, employmentStatus, studentStatus, sex, race, ethnicity are practice-specific values.
- Some API functions may have a special mapping of a values above into unified format. Please see specific function documentation.
- Depends on a specific API function not all fields may be used.
JSON Example:
{
"patientID": "TS01831451",
"patientNbr": "TS01831451",
"last": "Pistol",
"first": "Peter",
"middle": "",
"birthdate": "01/01/1965",
"sex": "M",
"SSN": null,
"race": null,
"maritalStatus": "S",
"studendStatus": "unknown",
"employmentStatus": "fulltime",
"preferredLanguage": "en",
"ethnicity": null,
"address": {
"addr1": "1 Park Ave",
"addr2": "Unit 203",
"city": "Sunny Town",
"state": "IL",
"zip": "09111",
"country": "us"
},
"contactInfo": {
"phone": "8005551212",
"phoneExt": null,
"cell": null,
"fax": "8005551313",
"email": "some@dadada.net"
},
"MarketingPlanId": "6cbb1c0f-cdda-4246-8f7b-70acde82bb9b",
"MarketingComments": "Test Sophrona comment",
"MarketingDetails": "",
"ReferringProviderId": ""
}
XML Example:
See also:
API Functions,
API Data,
Address Data,
ContactInfo Data