Skip to main content

Get patient

MethodPath
GET/v1/slim/patient/:id

Authentication · Access policies

Returns one resident (patient) by id, with their names, resident state and current placement. The response is the shape PUT /v1/slim/patient/{id} accepts back.

Auth: Bearer token. The caller must be a practitioner, an admin, a super admin, or hold the "System Owner" access policy. The access policy must grant Patient:read (admins and super admins skip this check). Scope: The resident is read with the caller's own token, so you get any patient your Medplum access lets you read. There is no extra project check on this route.

Behaviour​

  • Read-only.
  • deviceId is one device id, or null when the resident has no device. If the resident is on several devices, it is the most recently updated one. locationId, floor, room, bed and organizationId describe that same device's placement.
  • residentState is active, discharged-recent (discharged within the last 30 days), discharged or archived.
  • admissionDate and dischargeDate are returned as stored.
  • A name entry without a use is returned as official.

Example​

curl -X GET 'https://api.sandbox.ovok.com/v1/slim/patient/3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21' \
-H "Authorization: Bearer ${OVOK_TOKEN}"

Successful response​

200 — Patient retrieved successfully.

Errors​

StatusMeaning
401Bearer token is missing, invalid or expired.
403You are not a practitioner, admin or System Owner, you lack Patient:read, or Medplum refuses you the patient.
404No patient with this id exists.
422id is not a UUID.