List or search patients
halaxy_list_patientsList or search patient records (demographics and contact details; HEALTH DATA). Filters combine with AND. Paged: pass next_page as page. GET /main/Patient.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | One id or several separated by commas, for example 1,2,3. | |
| name | No | Search the family, given or preferred name (matches the start of the name). | |
| page | No | Page number, 1-based (default 1). Use next_page from the previous reply. | |
| sort | No | Sort order: _lastUpdated, name, created, -_lastUpdated, -name, -created ("-" = descending). | |
| count | No | Results per page, 1-100 (default 30). | |
| No | An email address. | ||
| given | No | Start of the given name. | |
| phone | No | A phone number, local or E.164 (+61412345678). | |
| family | No | Start of the family name. | |
| status | No | Patient status, e.g. active. | |
| 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 Patient:general-practitioner. | |
| birthdate | No | Date of birth (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). | |
| last_updated | No | Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). | |
| general_practitioner | No | A Practitioner/PractitionerRole the patient has records with. |