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 | |
emails[].type | enum | No | Values: WORK, HOME, OTHER |
telephones | HealthcareTelephone[] | No | Phone numbers of the patient |
telephones[].telephone | string | Yes | |
telephones[].type | enum | No | Values: WORK, HOME, MOBILE, FAX, OTHER |
address | object | No | Home address of the patient |
address.address1 | string | No | |
address.address2 | string | No | |
address.city | string | No | |
address.region | string | No | |
address.postal_code | string | No | |
address.country | string | No | |
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 |
metadata | HealthcareMetadata[] | No | |
metadata[].id | string | No | |
metadata[].value | object | No | |
metadata[].namespace | string | No | |
metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT |
metadata[].extra_data | object | No | |
metadata[].slug | string | No |
Are we missing anything? Let us know