Appointment 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 appointment |
created_at | string (date-time) | No | When the appointment was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | When the appointment was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
patient_id | string | No | The patient attending the appointment |
practitioner_ids | string[] | No | The practitioners participating in the appointment |
location_id | string | No | Where the appointment takes place |
slot_ids | string[] | No | The schedule slots this appointment occupies |
status | enum | No | Status of the appointment Values: PROPOSED, PENDING, BOOKED, ARRIVED, CHECKED_IN, FULFILLED, CANCELLED, NOSHOW, WAITLIST, ENTERED_IN_ERROR, OTHER |
start_at | string (date-time) | No | When the appointment starts (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
end_at | string (date-time) | No | When the appointment ends (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
description | string | No | Short description shown on the appointment |
service_types | HealthcareCode[] | No | Codings for the service/visit type being booked |
service_types[].system | string | No | The code system URI (e.g. http://loinc.org, http://snomed.info/sct) |
service_types[].code | string | No | The code within the system |
service_types[].display | string | No | Human-readable display text for the code |
reasons | HealthcareCode[] | No | Codings for the reason for the visit |
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 |
cancellation_reason | string | No | Why the appointment was cancelled |
notes | string | No | Free-text notes or comments |
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