Patients

Get patient

Get patient using Ovok’s Slim API.

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 Ovok AccessPolicy lets you read. There is no extra project check on this route.

Request

Path parameters

NameTypeRequiredDescription
idstring (uuid)YesPatient id.

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.

{
  "id": "3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21",
  "name": [
    { "use": "nickname", "given": ["demo-resident"], "family": "" },
    { "use": "official", "given": ["Anna"], "family": "Beispiel" }
  ],
  "gender": "male",
  "birthDate": "1940-05-01",
  "deviceId": "8c5e7a21-4b9d-4f36-a1c8-0d2e6b9f3a54",
  "organizationId": "1e6b8d30-2c4f-4a95-8d7e-b0a2c4e6f918",
  "locationId": "5d2a9c64-7e1b-4830-b6f5-9a3c1e8d7b02",
  "floor": "1",
  "room": "101",
  "bed": "A",
  "residentState": "active",
  "admissionDate": "2026-10-01T08:00:00.000Z"
}
FieldTypeDescription
idstring (uuid)Patient id.
nameobject[]The resident's names. A name stored without a use is returned as official.
name[].use"official" | "nickname" | "maiden"Kind of name.
name[].givenstring[]Given names. Empty array when none.
name[].familystringFamily name. Empty string when none.
gender"male" | "female" | "other" | "unknown"Left out when not set.
birthDatestring (YYYY-MM-DD)Left out when not set.
deviceIdstring (uuid) | nullThe resident's device. null when the resident has no device. When there are several, the most recently updated one.
organizationIdstring (uuid)Zone of that device's room. Left out when there is none.
locationIdstring (uuid)Room of that device. Left out when there is none.
floorstringFloor of the room. Left out when not set.
roomstringRoom name or number. Left out when not set.
bedstringBed. Left out when not set.
residentState"active" | "discharged-recent" | "discharged" | "archived"Resident state.
admissionDatestringAdmission time as stored. Left out when not set.
dischargeDatestringDischarge time as stored. Left out when not set.

Errors

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

Last updated on

On this page