Slot 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 slot |
created_at | string (date-time) | No | When the slot was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | When the slot was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
practitioner_id | string | No | The practitioner whose schedule the slot belongs to |
location_id | string | No | Where the slot takes place |
status | enum | No | Availability of the slot Values: FREE, BUSY, BUSY_UNAVAILABLE, BUSY_TENTATIVE, ENTERED_IN_ERROR, OTHER |
start_at | string (date-time) | No | When the slot starts (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
end_at | string (date-time) | No | When the slot ends (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
service_types | HealthcareCode[] | No | Codings for the services that can be booked in the slot |
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 |
is_overbooked | boolean | No | Whether the slot has been overbooked |
notes | string | No | Free-text notes about the slot |
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