Book an appointment
halaxy_create_appointmentWrites to the live Halaxy account. Books an appointment for a patient with a practitioner at a clinic (the practitioner role). Halaxy also creates the invoice, clinical note and reminder. Use halaxy_find_available_appointments for free times. By default a double booking is refused (HTTP 409, nothing created). POST /main/Appointment/$book.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end | Yes | End with the time zone offset, e.g. 2027-06-15T16:00:00+10:00. | |
| start | Yes | Start with the time zone offset, e.g. 2027-06-15T15:00:00+10:00. | |
| status | No | Initial status (default booked). | |
| patient_id | Yes | The patient id. | |
| practitioner_role_id | Yes | The PractitionerRole id (practitioner at a clinic), e.g. PR-1234567. | |
| healthcare_service_id | No | The appointment type id (halaxy_list_healthcare_services). | |
| fail_on_double_booking | No | Refuse if the practitioner already has an appointment then (default true). | |
| charge_item_definition_id | No | The fee id (halaxy_list_fees) booked for the appointment. |