Search patients
search_patientsRead-only
Search patients with an active organization connection using exact filters for name, date of birth, email, phone, or up to 25 IDs; page the full list when no filters are set.
Instructions
Patients with an active connection to the Organization, filtered with the exact-match filters the API documents (all case-insensitive; ANDed): first_name, last_name, date_of_birth, email, phone_number, or up to 25 ids. There is no partial-name search. Without filters the whole connected list is paged. Names, sex and patient number are returned; contact details, date of birth, NHS number and address only with include_contact_details (a search by email or phone still confirms that such a record exists).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | Only these patient ids (at most 25) | |
| No | Exact email address | ||
| cursor | No | next_cursor from a previous call, to continue where it stopped (send the same filters) | |
| last_name | No | Exact last name | |
| first_name | No | Exact first name | |
| max_results | No | Maximum number of records to return (pages of up to 100 are fetched until this is reached) | |
| phone_number | No | Exact phone or mobile number, E.164 where possible (+447700900123); a number without + or 00 is treated as UK | |
| date_of_birth | No | Exact date of birth, YYYY-MM-DD | |
| include_contact_details | No | Include patient contact details, date of birth, NHS number, address, third-party identifier and payment-method link, and stop redacting email addresses, phone numbers, NHS-number-shaped digit groups and UK postcodes typed into names and other text |