List appointments
halaxy_list_appointmentsList or search appointments (HEALTH DATA: names the patient). Filters combine with AND. Paged: pass next_page as page. GET /main/Appointment.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | One id or several separated by commas, for example 1,2,3. | |
| date | No | Appointment date/time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). | |
| page | No | Page number, 1-based (default 1). Use next_page from the previous reply. | |
| sort | No | Sort order: date, -date ("-" = descending). | |
| count | No | Results per page, 1-100 (default 30). | |
| created | No | Created (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). | |
| include | No | Also return related resources in "included": any of Appointment:patient, Appointment:practitioner-role. | |
| patient | No | Patient id. | |
| part_status | No | The patient's participation status, e.g. booked, arrived, cancelled. | |
| last_updated | No | Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). | |
| organization | No | The clinic (Organization) id including its prefix. | |
| practitioner | No | Practitioner id, e.g. PR-123. | |
| include_iterate | No | Also return resources related to an included one (needs the matching include): any of PractitionerRole:practitioner, PractitionerRole:organization. | |
| practitioner_role | No | PractitionerRole id. |