The Schedule resource represents a container for timeslots that can be booked using an appointment.
Schedule provides the window of time (period) that slots are defined for, and what appointments can be booked. When checking availability for an appointment, the creator of the appointment should determine which schedules are applicable, then check for available slots within each schedule.
ContextIn Halaxy, each schedule entry represents the practice hours of a practitioner for a specific clinic. If a practitioner practices at multiple clinics, they will have separate schedule entries for each location. You can find practitioner schedules in Personal > Locations.
Endpoints
| Endpoint | Operation | Description |
|---|---|---|
GET /main/Schedule | List Schedules | Retrieves a collection of practice hours schedules for practitioners |
GET /main/Schedule/{id} | Show Schedules | Retrieves an individual practice hours schedule for an individual practitioner |
Schema
| Property | Description |
|---|---|
| id | string The ID of this schedule in Halaxy |
| active | boolean defaults to trueIndicates if the schedule is in active use |
| planningHorizon |
start Format: |
| actor |
Practitioner Organization PractitionerRole |