Add a new appointment for a specific practitioner and location
This endpoint uses the $book operation, which functions differently from other standard POST endpoints. This is because creating an appointment automatically involves multiple other actions, such as creating an invoice, clinical note and reminder.
The request structure for the $book operation requires the appointment properties to be created as separate entries under the parameter property.
Use our recipe
As an example, refer to our to view how to structure a request for this endpoint.
Request schema
| Parameter Name | Description / Contents |
|---|---|
| appt-resource | The general details for the appointment start end minutesDuration resourceType participant > actor |
| appt-id (optional) | An existing appointment to book this patient, such as for group appointments Note: If adding to a group appointment, use this parameter instead of See also: Appointment |
| patient-id | The patient this appointment is booked for See also: Patient |
| healthcare-service-id | The appointment type used for this appointment See also: HealthcareService |
| location-type | The method used for this appointment (e.g. clinic telehealth phone phone organization |
| status | The appointment status (e.g. booked confirmed pending) |
| charge-item-definition-id | The fee booked for this appointment See also: ChargeItemDefinition |
Parameters
Invalid input
Forbidden
Unprocessable entity