FHIR read-only subsets
Search synthetic Patient records
Read-only FHIR R4-shaped subset; requires gp scope. Uses local SIM identifiers, not NHS numbers/ODS codes. No NHS profile validation, fuzzy tracing, record updates or real network access. Unsupported, repeated or empty query parameters return 400.
get/api/nhs/pds/Patient
Request
- Base URLhttps://sim.animahealth.com
- Auth
- HTTP bearer
- or HTTP bearer
- or API key in cookie sim_session
Query parameters
familystring
Case-insensitive family-name prefix.
givenstring
Case-insensitive given-name prefix.
birthdatestring date
Exact valid date; no FHIR date prefixes.
identifierstring
Exact value or system|value. Patient system https://nhs-sim.example/identifier/patient; organisation system https://nhs-sim.example/identifier/organisation.
_countinteger
Page size.
_offsetinteger
Local offset extension; not a production API claim.
Response
Synthetic FHIR-shaped result
Changes
No recorded changes to this operation across all 1 revision of this API.