Appointments
Appointments represent scheduled clinical interactions between patients and practitioners.Create an Appointment
New Fields
Based On (ServiceRequest)
Link an appointment to the ServiceRequest it was created to assess:Requested Period
Specify preferred time windows when the patient is available:Created Timestamp
Track when the appointment was initially created (defaults to now):Status Lifecycle
| Status | Description |
|---|---|
proposed | Suggested but not confirmed |
pending | Awaiting confirmation |
booked | Confirmed and scheduled |
checked-in | Patient has checked in |
arrived | Patient is at the facility |
fulfilled | Appointment completed |
cancelled | Cancelled before completion |
noshow | Patient did not attend |
waitlist | On a waitlist |
Update an Appointment
Search Appointments
Priority
Priority is an integer from 0-9:| Value | Meaning |
|---|---|
0 | Routine (default) |
1-3 | Low urgency |
4-6 | Medium urgency |
7-9 | High urgency |
Complete Field Reference
| Field | Type | Required | Description |
|---|---|---|---|
status | string | Yes | proposed, pending, booked, arrived, fulfilled, cancelled, noshow, checked-in, waitlist |
patientId | string | Yes | Patient reference |
practitionerId | string | No | Practitioner reference |
start | string | No | Start time (ISO 8601) |
end | string | No | End time (ISO 8601) |
minutesDuration | number | No | Duration in minutes (max 1440) |
appointmentType | string | No | routine, walkin, urgent, followup |
serviceType | string | No | Service being booked |
serviceCategory | string | No | Service category |
specialty | string | No | Required specialty |
reasonCode | string | No | Reason for appointment |
priority | number | No | 0 (routine) to 9 (urgent) |
description | string | No | Subject line |
comment | string | No | Additional comments |
patientInstruction | string | No | Instructions for patient |
cancelationReason | string | No | Reason for cancellation |
basedOnId | string | No | ServiceRequest this appointment assesses |
requestedPeriod | Array<{ start?, end? }> | No | Preferred time windows |
created | string | No | When initially created (defaults to now) |