Devices
List live device rows
List live device rows using Ovok’s Slim API.
| Method | Path |
|---|---|
GET | /v1/slim/device/live |
Authentication · Access policies
Lists live device rows for the dashboard's monitoring views: each device with its resident, location, zone, current telemetry and alerts.
Auth: bearer token. The caller must be a practitioner, an admin or a System Owner, and needs search and read on Patient, Device, Location, Observation and Organization.
Scope: the caller's project (from the token).
Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
page | integer | No | Zero-based page number. Default 0, minimum 0. |
count | integer | No | Rows per page. Default 20, minimum 1, maximum 100. |
sortBy | "locationName" | "patientName" | "patientNickname" | "organizationName" | "effectiveHeartRate" | "effectiveRespiratoryRate" | "effectiveSleepStatus" | "admissionDate" | "dischargeDate" | No | Sort column. Default locationName. |
orderBy | "ASC" | "DESC" | No | Sort direction. Upper case only. Default ASC. |
search | string | No | Fuzzy match on resident nickname and name, location name, zone name, and device name, identifier and serial. Trimmed, at least 1 character. |
deviceId | string | No | Keep only this device, matched against the device identifier. |
organizationId | string | No | A zone id, assigned or unassigned. A zone id also matches devices in its child zones. |
effectiveSleepStatus | "disconnected" | "connected" | "awake" | "away" | "asleep" | No | Keep devices in this sleep status. |
residentState | "active" | "discharged-recent" | "discharged" | "archived" | No | Accepted and ignored. |
includeUnassigned | boolean | No | true also returns devices without a resident. Any other value is false. Default false. |
Behaviour
- By default only devices with a resident assigned are returned. Set
includeUnassigned=trueto include devices without a resident. organizationIdtakes a zone id,assignedorunassigned. A zone id also matches devices in its child zones.deviceIdrestricts the result to one device, matched against the device identifier.effectiveSleepStatusfilters on the device's current sleep status.searchmatches resident nickname and name, location name, zone name, and device name, identifier and serial. Matching is fuzzy, plus a substring match on the device fields.residentStateis accepted but ignored.- Telemetry is read fresh on every request. The device structure is cached and refreshed when you write through the Slim routes.
pageis zero-based.countdefaults to 20, maximum 100.- For polling only the telemetry and alerts, use
GET /v1/slim/device/live/telemetrywith the same query. - The route returns 503 when the server is at capacity for live reads or the device list cannot be built. Retry shortly.
Example
curl -X GET 'https://api.sandbox.ovok.com/v1/slim/device/live?page=0&count=20&sortBy=locationName&orderBy=ASC' \
-H "Authorization: Bearer ${OVOK_TOKEN}"Successful response
200 — One page of live device rows.
{
"total": 1,
"page": 0,
"count": 20,
"resources": [
{
"device": {
"resourceType": "Device",
"id": "8c5e7a21-4b9d-4f36-a1c8-0d2e6b9f3a54",
"deviceName": [{ "name": "Demo/1000001" }],
"status": "active",
"identifier": [{ "system": "https://api.ovok.com/identifier/device-id", "value": "Demo/1000001" }],
"patient": { "reference": "Patient/3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21" },
"location": { "reference": "Location/5d2a9c64-7e1b-4830-b6f5-9a3c1e8d7b02", "display": "Room 101 Bed 1" }
},
"patient": {
"resourceType": "Patient",
"id": "3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21",
"name": [{ "use": "nickname", "given": ["demo-resident"], "family": "" }]
},
"location": { "id": "5d2a9c64-7e1b-4830-b6f5-9a3c1e8d7b02", "name": "Room 101 Bed 1" },
"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 }
},
"alerts": {
"heartRate": { "alert": false, "value": null, "message": null, "communicationRequestId": null, "observationId": null, "color": null, "state": "normal", "updatedAt": null },
"respiratoryRate": { "alert": false, "value": null, "message": null, "communicationRequestId": null, "observationId": null, "color": null, "state": "normal", "updatedAt": null },
"outOfBed": null
},
"calculatedFields": {
"deviceName": "Demo/1000001",
"statusReason": [],
"locationName": "Room 101 Bed 1",
"patientName": "demo-resident",
"patientNickname": "demo-resident",
"organizationName": "Zone A",
"residentState": "active",
"effectiveSleepStatus": "asleep",
"active": true,
"admissionDate": "2026-10-01T08:00:00.000Z"
}
}
]
}device is a FHIR resource and can carry more elements. patient is a trimmed resident summary, not a full FHIR Patient resource.
| Field | Type | Description |
|---|---|---|
total | integer | Number of rows after filtering, across all pages. |
page | integer | Page number of this response. |
count | integer | Page size of this response. |
resources | object[] | The rows of this page. |
resources[].device | object | The Device resource. Its location.display holds the location name. Left out when the row has none. |
resources[].patient | object | The resident summary with id, name, meta (status tag) and extension (stay dates). Left out when the device has no resident. |
resources[].location | object | The device's location. Left out when there is none. |
resources[].location.id | string (uuid) | Location id. |
resources[].location.name | string | Location name. Empty string when it has none. |
resources[].organization | object | The device's 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. Every metric in it 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. |
resources[].alerts | object | Current alerts of the resident on the device. |
resources[].alerts.heartRate | object | Heart rate alert. |
resources[].alerts.heartRate.alert | boolean | true while the alert is active. |
resources[].alerts.heartRate.state | "alert" | "normal" | alert while the alert is active, otherwise normal. |
resources[].alerts.heartRate.color | string | null | Alert color. null when there is no alert. |
resources[].alerts.heartRate.value | object | null | Alert details as recorded by Signals. null when there is no alert. |
resources[].alerts.heartRate.message | object | null | Alert message as recorded by Signals. null when there is no alert. |
resources[].alerts.heartRate.communicationRequestId | string | null | Id of the alert's CommunicationRequest. |
resources[].alerts.heartRate.observationId | string | null | Id of the Observation that raised the alert. |
resources[].alerts.heartRate.updatedAt | string | null | When the alert last changed. |
resources[].alerts.respiratoryRate | object | Respiratory rate alert, with the same fields as resources[].alerts.heartRate. |
resources[].alerts.outOfBed | object | null | The active out-of-bed episode of the resident. null when there is none or an open episode has no start time. |
resources[].alerts.outOfBed.outOfBed | true | Always true. |
resources[].alerts.outOfBed.communicationRequestId | string | Id of the Signals episode. |
resources[].alerts.outOfBed.sinceTime | string | When the resident left the bed, as an ISO 8601 time string. |
resources[].calculatedFields | object | Display values computed for the row. |
resources[].calculatedFields.deviceName | string | Device name. |
resources[].calculatedFields.statusReason | object[] | Why the platform marked the device, when it did. Empty array when nothing was recorded. |
resources[].calculatedFields.statusReason[].code | string | Reason code, such as no-assigned-resident. Stable. Render from this. |
resources[].calculatedFields.statusReason[].display | string | null | A sentence for the code. null for a code that has none. |
resources[].calculatedFields.locationName | string | Location name. Empty string when there is none. |
resources[].calculatedFields.patientName | string | The resident's full display name. Empty string when there is none. |
resources[].calculatedFields.patientNickname | string | The resident's nickname (Resident ID). Empty string when there is none. |
resources[].calculatedFields.organizationName | string | Zone name. Empty string when there is none. |
resources[].calculatedFields.residentState | "active" | "discharged-recent" | "discharged" | "archived" | Resident state. active when there is no resident. |
resources[].calculatedFields.effectiveSleepStatus | string | Current sleep status, as resources[].telemetry.effectiveSleepStatus.value. Empty string when unknown. |
resources[].calculatedFields.active | boolean | true when the device is connected. |
resources[].calculatedFields.admissionDate | string | Admission time of the resident. Left out when there is none. |
resources[].calculatedFields.dischargeDate | string | Discharge time of the resident. Left out when there is none. |
Errors
| Status | Meaning |
|---|---|
401 | Bearer token is missing, invalid or expired. |
403 | You are not a practitioner, admin or System Owner, you lack search or read on Patient, Device, Location, Observation or Organization, your session has no project, or you cannot access the project. |
422 | A query parameter fails validation. |
503 | The server is at capacity for live reads, or the device list cannot be built and no earlier complete list exists. Retry after the number of seconds in the Retry-After header. |
Last updated on