Patients
Get patient current vitals
Get patient current vitals using Ovok’s Slim API.
| Method | Path |
|---|---|
GET | /v1/slim/patient/:id/current-vitals |
Authentication · Access policies
Returns the latest live telemetry for a resident: one entry per device assigned to them, with the device, resident and zone.
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 search and read on Patient, Device, Location, Observation and Organization (admins and super admins skip this check).
Scope: The caller's project (from the token). A resident outside that project returns total: 0 and no entries.
Request
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Patient id. |
Behaviour
- Read-only.
- Returns one entry per device assigned to the resident, up to 100. A resident with no device returns
total: 0. - The response is cached for up to 60 seconds, so
telemetrycan lag the latest reading by up to a minute.
Example
curl -X GET 'https://api.sandbox.ovok.com/v1/slim/patient/3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21/current-vitals' \
-H "Authorization: Bearer ${OVOK_TOKEN}"Successful response
200 — Patient current vitals retrieved successfully.
{
"total": 1,
"resources": [
{
"device": { "id": "8c5e7a21-4b9d-4f36-a1c8-0d2e6b9f3a54", "name": "Demo/1000001" },
"patient": { "id": "3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21", "name": "Anna Beispiel", "nickname": "demo-resident" },
"organization": { "id": "1e6b8d30-2c4f-4a95-8d7e-b0a2c4e6f918", "name": "Zone A" },
"telemetry": {
"active": { "value": true, "ts": 1790000000000 },
"effectiveHeartRate": { "value": 62, "ts": 1789999400000 },
"effectiveRespiratoryRate": { "value": 14, "ts": 1789999400000 },
"effectiveSleepStatus": { "value": "asleep", "ts": 1789998000000 },
"lastMeasurementTime": { "value": "2026-10-09T08:50:00.000Z", "ts": 1789999800000 },
"lastActivityTime": { "value": "2026-10-09T08:53:20.000Z", "ts": 1790000000000 },
"name": { "value": "Demo/1000001", "ts": null },
"effectiveOxygenSaturation": { "value": 97, "ts": 1789999400000 },
"effectivePulseRate": { "value": null, "ts": null },
"effectiveSystolicBloodPressure": { "value": null, "ts": null },
"effectiveDiastolicBloodPressure": { "value": null, "ts": null },
"effectiveHeartRateVariability": { "value": null, "ts": null },
"effectivePerfusionIndex": { "value": null, "ts": null },
"effectiveBodyTemperature": { "value": null, "ts": null }
}
}
]
}| Field | Type | Description |
|---|---|---|
total | integer | Number of entries. One per device assigned to the resident. |
resources | object[] | The entries, at most 100. |
resources[].device | object | The device. Left out when there is none. |
resources[].device.id | string (uuid) | Device id. |
resources[].device.name | string | Device name. |
resources[].patient | object | The resident. Left out when there is none. |
resources[].patient.id | string (uuid) | Patient id. |
resources[].patient.name | string | The resident's full display name. Empty string when no name resolves. |
resources[].patient.nickname | string | null | The resident's nickname (Resident ID). |
resources[].organization | object | The zone. Left out when there is none. |
resources[].organization.id | string (uuid) | Zone id. |
resources[].organization.name | string | Zone name. Empty string when it has none. |
resources[].telemetry | object | Latest live telemetry of the device. Left out when the device has none. Every metric below is an object with value and ts. |
resources[].telemetry.<metric>.ts | integer | null | Time of the value in epoch milliseconds. |
resources[].telemetry.active | object | value is true when the device is connected. A device with no activity for 10 minutes is false. |
resources[].telemetry.effectiveHeartRate | object | value is the heart rate in beats per minute with one decimal, or null when no resident is in bed or there is no reading. |
resources[].telemetry.effectiveRespiratoryRate | object | value is the respiratory rate in breaths per minute with one decimal, or null. |
resources[].telemetry.effectiveSleepStatus | object | value is "asleep", "awake", "away", "connected" or "disconnected". |
resources[].telemetry.lastMeasurementTime | object | value is an ISO 8601 time string. |
resources[].telemetry.lastActivityTime | object | value is an ISO 8601 time string. |
resources[].telemetry.name | object | value is the device name. ts is null. |
resources[].telemetry.effectiveOxygenSaturation | object | value is a number or null. |
resources[].telemetry.effectivePulseRate | object | value is a number or null. |
resources[].telemetry.effectiveSystolicBloodPressure | object | value is a number or null. |
resources[].telemetry.effectiveDiastolicBloodPressure | object | value is a number or null. |
resources[].telemetry.effectiveHeartRateVariability | object | value is a number or null. |
resources[].telemetry.effectivePerfusionIndex | object | value is a number or null. |
resources[].telemetry.effectiveBodyTemperature | object | value is a number in degrees Celsius or null. |
Errors
Last updated on