FHIR read-only subsets

Search synthetic Organization records

Read-only FHIR R4-shaped subset; requires referrals 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/ods/Organization

Request

  • Base URL
    https://sim.animahealth.com
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or API key in cookie sim_session

Query parameters

namestring

Case-insensitive organisation-name prefix.

active'true' | 'false'

All synthetic organisations are active; false returns none.

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

resourceType'Bundle' required
type'searchset' required
totalinteger

Changes

No recorded changes to this operation across all 1 revision of this API.