Patient data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier for the patient |
created_at | string (date-time) | No | When the patient record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | When the patient record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | Full name of the patient |
first_name | string | No | Given name of the patient |
last_name | string | No | Family name of the patient |
gender | enum | No | Administrative gender of the patient Values: MALE, FEMALE, OTHER, UNKNOWN |
birthdate | string | No | Date of birth (YYYY-MM-DD) |
is_deceased | boolean | No | Whether the patient is deceased |
deceased_at | string (date-time) | No | When the patient died (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
emails | HealthcareEmail[] | No | Email addresses of the patient |
emails[].email | string | Yes | The email address |
emails[].type | enum | No | The kind of email address (work, home or other) Values: WORK, HOME, OTHER |
telephones | HealthcareTelephone[] | No | Phone numbers of the patient |
telephones[].telephone | string | Yes | The telephone number |
telephones[].type | enum | No | The kind of telephone number (work, home, mobile, fax or other) Values: WORK, HOME, MOBILE, FAX, OTHER |
address | object | No | Home address of the patient |
address.address1 | string | No | First line of the street address |
address.address2 | string | No | Second line of the street address |
address.city | string | No | City or locality |
address.region | string | No | Regional area (e.g., state in the U.S., province in Canada) |
address.postal_code | string | No | Postal or ZIP code |
address.country | string | No | Country |
language | string | No | Preferred language code of the patient |
identifiers | HealthcareIdentifier[] | No | Business identifiers (e.g. MRN) |
identifiers[].value | string | Yes | The identifier value |
identifiers[].type | enum | No | The kind of identifier Values: MRN, NPI, SSN, DRIVERS_LICENSE, PASSPORT, INSURANCE, OTHER |
identifiers[].system | string | No | The namespace/system URI that issued the identifier |
practitioner_ids | string[] | No | The patient's primary care practitioners |
is_active | boolean | No | Whether the patient record is in active use |
races | HealthcareCode[] | No | Codings for the patient's race (e.g. CDC race codes) |
races[].system | string | No | The code system URI (e.g. http://loinc.org, http://snomed.info/sct) |
races[].code | string | No | The code within the system |
races[].display | string | No | Human-readable display text for the code |
ethnicities | HealthcareCode[] | No | Codings for the patient's ethnicity (e.g. CDC ethnicity codes) |
ethnicities[].system | string | No | The code system URI (e.g. http://loinc.org, http://snomed.info/sct) |
ethnicities[].code | string | No | The code within the system |
ethnicities[].display | string | No | Human-readable display text for the code |
marital_status | enum | No | Marital status of the patient Values: MARRIED, SINGLE, DOMESTIC_PARTNER, SEPARATED, DIVORCED, WIDOWED, ANNULLED, UNKNOWN, OTHER |
contacts | HealthcarePatientContact[] | No | Emergency contacts, guardians and other contact persons for the patient |
contacts[].name | string | No | Full name of the contact person |
contacts[].relationship | string | No | Relationship of the contact to the patient (e.g. emergency contact, spouse) |
contacts[].telephones | HealthcareTelephone[] | No | Phone numbers of the contact person |
contacts[].telephones[].telephone | string | Yes | The telephone number |
contacts[].telephones[].type | enum | No | The kind of telephone number (work, home, mobile, fax or other) Values: WORK, HOME, MOBILE, FAX, OTHER |
contacts[].emails | HealthcareEmail[] | No | Email addresses of the contact person |
contacts[].emails[].email | string | Yes | The email address |
contacts[].emails[].type | enum | No | The kind of email address (work, home or other) Values: WORK, HOME, OTHER |
contacts[].address | HealthcarePatientContact_address | No | Postal address of the contact person |
contacts[].address.address1 | string | No | First line of the street address |
contacts[].address.address2 | string | No | Second line of the street address |
contacts[].address.city | string | No | City or locality |
contacts[].address.region | string | No | Regional area (e.g., state in the U.S., province in Canada) |
contacts[].address.postal_code | string | No | Postal or ZIP code |
contacts[].address.country | string | No | Country |
metadata | HealthcareMetadata[] | No | Custom field values |
metadata[].id | string | No | Identifier of the custom field |
metadata[].value | object | No | The custom field value |
metadata[].namespace | string | No | The scope or origin of the custom field |
metadata[].format | enum | No | The data type of the value Values: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT |
metadata[].extra_data | object | No | Additional data about the custom field |
metadata[].slug | string | No | The custom field key |
Are we missing anything? Let us know
Was this page helpful?