Patients
Get patient
Get patient using Ovok’s Slim API.
| Method | Path |
|---|---|
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
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Patient id. |
Behaviour
- Read-only.
deviceIdis one device id, ornullwhen the resident has no device. If the resident is on several devices, it is the most recently updated one.locationId,floor,room,bedandorganizationIddescribe that same device's placement.residentStateisactive,discharged-recent(discharged within the last 30 days),dischargedorarchived.admissionDateanddischargeDateare returned as stored.- A
nameentry without auseis returned asofficial.
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"
}| Field | Type | Description |
|---|---|---|
id | string (uuid) | Patient id. |
name | object[] | The resident's names. A name stored without a use is returned as official. |
name[].use | "official" | "nickname" | "maiden" | Kind of name. |
name[].given | string[] | Given names. Empty array when none. |
name[].family | string | Family name. Empty string when none. |
gender | "male" | "female" | "other" | "unknown" | Left out when not set. |
birthDate | string (YYYY-MM-DD) | Left out when not set. |
deviceId | string (uuid) | null | The resident's device. null when the resident has no device. When there are several, the most recently updated one. |
organizationId | string (uuid) | Zone of that device's room. Left out when there is none. |
locationId | string (uuid) | Room of that device. Left out when there is none. |
floor | string | Floor of the room. Left out when not set. |
room | string | Room name or number. Left out when not set. |
bed | string | Bed. Left out when not set. |
residentState | "active" | "discharged-recent" | "discharged" | "archived" | Resident state. |
admissionDate | string | Admission time as stored. Left out when not set. |
dischargeDate | string | Discharge time as stored. Left out when not set. |
Errors
Last updated on