The Appointment resource represents scheduled healthcare events among patients and practitioners within the Halaxy platform
This resource supports the retrieval of appointments, including details such as participants and times.
Endpoints
| Endpoints | Operations | Description |
|---|---|---|
GET /main/Appointment | List Appointments | Retrieve a list or collection of appointments |
GET /main/Appointment/{id} | Get Appointment | Retrieve a specific appointment |
POST/main/Appointment/$book | Book Appointment | Create an appointment |
PATCH /main/Appointment/{id} | Update Appointment | Edit specific details for an existing appointment |
GET /main/Appointment/$find | Find Available Appointments | Retrieves a list of available appointments from the Slot resource |
Schema
| Property | Description |
|---|---|
| id | stringThe appointment ID in Halaxy |
| description | stringThe appointment comments |
| start | date-time requiredWhen the appointment is to take place |
| end | date-time required When the appointment is to conclude |
| minutesDuration | integer The duration of the appointment in minutes |
| created | date-time The date that this appointment was first created |
| supportingInformation |
HealthcareService
See: HealthcareService |
| location-type | The location type for the appointment
|
| participant |
PRACTITIONER type defaults to ATND / attender actor
See: PractitionerRole PATIENT actor
See: Patient appointment-participant-status See: Appointment status appointment-participant-invoice
See: Invoice |