Encounter 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 encounter |
created_at | string (date-time) | No | When the encounter record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | When the encounter record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
patient_id | string | No | The patient seen in the encounter |
practitioner_ids | string[] | No | The practitioners who participated in the encounter |
location_id | string | No | Where the encounter took place |
appointment_id | string | No | The appointment that scheduled this encounter |
condition_ids | string[] | No | Conditions diagnosed or addressed during the encounter |
status | enum | No | Status of the encounter Values: PLANNED, ARRIVED, TRIAGED, IN_PROGRESS, ONLEAVE, FINISHED, CANCELLED, ENTERED_IN_ERROR, UNKNOWN, OTHER |
type | enum | No | Class of the encounter (e.g. ambulatory, inpatient) Values: AMBULATORY, EMERGENCY, INPATIENT, OBSERVATION, HOME_HEALTH, VIRTUAL, OTHER |
reasons | HealthcareCode[] | No | Codings for the reason for the encounter |
reasons[].system | string | No | The code system URI (e.g. http://loinc.org, http://snomed.info/sct) |
reasons[].code | string | No | The code within the system |
reasons[].display | string | No | Human-readable display text for the code |
start_at | string (date-time) | No | When the encounter started (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
end_at | string (date-time) | No | When the encounter ended (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
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