Secondary care

Read raw secondary care consultation records

Requires hospital scope. Returns complete stored synthetic resources owned by and visible to hospital in your team's world without truncating or projecting their data or provenance. Exact patient filtering excludes records without that patient ID; unknown patients return an empty page. total counts matching records before pagination. Records retain storage insertion order; advance offset by items.length until reaching total. Pause simulation time for stable pagination. Includes hospital-note, clinical-note, consultation and encounter records owned by hospital. Preserves narrative text, sections, draft/signed status, signedBy, signedAt and addenda when stored. GP encounters, GP consultations and longitudinal GP EHR records are excluded. Discharge correspondence is available separately through /api/sites/hospital/documents. Hospital-note data follows HospitalNote.

get/api/sites/hospital/consultations

Request

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

Query parameters

patientstring
Example:SIM-000006

Exact synthetic patient ID; unknown patients return an empty page.

offsetinteger

Number of matching records to skip.

limitinteger

Maximum number of records to return.

worldstring

Operator only: world to inspect or mutate. Team keys always use their own world.

Response

Success

totalinteger required
offsetinteger required
limitinteger required
nownumber required

Simulation Unix timestamp in milliseconds.

Changes

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