Search patients
Searches for Patient resources within the clinic the token belongs to. Returns a Bundle of type searchset, never a bare array. No matches is a 200 with total: 0, not a 404.
Every parameter narrows the result: they combine with AND, never OR.
total counts the matches across every page, not the page returned. To walk the pages, follow the next link in the Bundle and send that URL unchanged.
Sorting is not supported, so the order of results is stable but not meaningful.
Query parameters
The logical id of the resource to search for. Matched exactly and case-sensitively; it does not accept the system|value form. A resource belonging to another clinic returns no match rather than an error.
Filter by last-updated time. Accepts the prefixes ge, gt, le and lt, or no prefix at all, which matches the whole period given. A bare date such as 2026-08-01 therefore covers that entire day.
Number of results per page. Defaults to 50 and is capped at 100: a larger value returns 100 rather than an error.
Pagination cursor. Do not build this value yourself — take the next link from the Bundle and send that URL unchanged. The cursor is opaque and its format may change.
Matches the beginning of either the given or the family name, ignoring case. Gar finds Garcia and Garrido; arcia finds nothing. Accents are not yet ignored, so Garcia does not find García.
The family name, matched by prefix like name.
A given name, matched by prefix like name. Only the first given name is searched, so a middle name will not match.
Date of birth (YYYY-MM-DD). Matched exactly.
One of male, female, other or unknown. Matched exactly.
An email address or a phone number, matched exactly. Email ignores case; a phone number must be written exactly as it is stored, in E.164 form.
Response
A searchset Bundle of matching resources.
Changes
No recorded changes to this endpoint across all 1 revision of this API.