Devices

List live device rows

List live device rows using Ovok’s Slim API.

MethodPath
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

NameTypeRequiredDescription
pageintegerNoZero-based page number. Default 0, minimum 0.
countintegerNoRows per page. Default 20, minimum 1, maximum 100.
sortBy"locationName" | "patientName" | "patientNickname" | "organizationName" | "effectiveHeartRate" | "effectiveRespiratoryRate" | "effectiveSleepStatus" | "admissionDate" | "dischargeDate"NoSort column. Default locationName.
orderBy"ASC" | "DESC"NoSort direction. Upper case only. Default ASC.
searchstringNoFuzzy match on resident nickname and name, location name, zone name, and device name, identifier and serial. Trimmed, at least 1 character.
deviceIdstringNoKeep only this device, matched against the device identifier.
organizationIdstringNoA zone id, assigned or unassigned. A zone id also matches devices in its child zones.
effectiveSleepStatus"disconnected" | "connected" | "awake" | "away" | "asleep"NoKeep devices in this sleep status.
residentState"active" | "discharged-recent" | "discharged" | "archived"NoAccepted and ignored.
includeUnassignedbooleanNotrue 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=true to include devices without a resident.
  • organizationId takes a zone id, assigned or unassigned. A zone id also matches devices in its child zones.
  • deviceId restricts the result to one device, matched against the device identifier.
  • effectiveSleepStatus filters on the device's current sleep status.
  • search matches 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.
  • residentState is accepted but ignored.
  • Telemetry is read fresh on every request. The device structure is cached and refreshed when you write through the Slim routes.
  • page is zero-based. count defaults to 20, maximum 100.
  • For polling only the telemetry and alerts, use GET /v1/slim/device/live/telemetry with 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.

FieldTypeDescription
totalintegerNumber of rows after filtering, across all pages.
pageintegerPage number of this response.
countintegerPage size of this response.
resourcesobject[]The rows of this page.
resources[].deviceobjectThe Device resource. Its location.display holds the location name. Left out when the row has none.
resources[].patientobjectThe resident summary with id, name, meta (status tag) and extension (stay dates). Left out when the device has no resident.
resources[].locationobjectThe device's location. Left out when there is none.
resources[].location.idstring (uuid)Location id.
resources[].location.namestringLocation name. Empty string when it has none.
resources[].organizationobjectThe device's zone. Left out when there is none.
resources[].organization.idstring (uuid)Zone id.
resources[].organization.namestringZone name. Empty string when it has none.
resources[].telemetryobjectLatest live telemetry of the device. Every metric in it is an object with value and ts.
resources[].telemetry.<metric>.tsinteger | nullTime of the value in epoch milliseconds.
resources[].telemetry.activeobjectvalue is true when the device is connected. A device with no activity for 10 minutes is false.
resources[].telemetry.effectiveHeartRateobjectvalue 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.effectiveRespiratoryRateobjectvalue is the respiratory rate in breaths per minute with one decimal, or null.
resources[].telemetry.effectiveSleepStatusobjectvalue is "asleep", "awake", "away", "connected" or "disconnected".
resources[].telemetry.lastMeasurementTimeobjectvalue is an ISO 8601 time string.
resources[].telemetry.lastActivityTimeobjectvalue is an ISO 8601 time string.
resources[].telemetry.nameobjectvalue is the device name. ts is null.
resources[].telemetry.effectiveOxygenSaturationobjectvalue is a number or null.
resources[].telemetry.effectivePulseRateobjectvalue is a number or null.
resources[].telemetry.effectiveSystolicBloodPressureobjectvalue is a number or null.
resources[].telemetry.effectiveDiastolicBloodPressureobjectvalue is a number or null.
resources[].telemetry.effectiveHeartRateVariabilityobjectvalue is a number or null.
resources[].telemetry.effectivePerfusionIndexobjectvalue is a number or null.
resources[].telemetry.effectiveBodyTemperatureobjectvalue is a number in degrees Celsius or null.
resources[].alertsobjectCurrent alerts of the resident on the device.
resources[].alerts.heartRateobjectHeart rate alert.
resources[].alerts.heartRate.alertbooleantrue while the alert is active.
resources[].alerts.heartRate.state"alert" | "normal"alert while the alert is active, otherwise normal.
resources[].alerts.heartRate.colorstring | nullAlert color. null when there is no alert.
resources[].alerts.heartRate.valueobject | nullAlert details as recorded by Signals. null when there is no alert.
resources[].alerts.heartRate.messageobject | nullAlert message as recorded by Signals. null when there is no alert.
resources[].alerts.heartRate.communicationRequestIdstring | nullId of the alert's CommunicationRequest.
resources[].alerts.heartRate.observationIdstring | nullId of the Observation that raised the alert.
resources[].alerts.heartRate.updatedAtstring | nullWhen the alert last changed.
resources[].alerts.respiratoryRateobjectRespiratory rate alert, with the same fields as resources[].alerts.heartRate.
resources[].alerts.outOfBedobject | nullThe active out-of-bed episode of the resident. null when there is none or an open episode has no start time.
resources[].alerts.outOfBed.outOfBedtrueAlways true.
resources[].alerts.outOfBed.communicationRequestIdstringId of the Signals episode.
resources[].alerts.outOfBed.sinceTimestringWhen the resident left the bed, as an ISO 8601 time string.
resources[].calculatedFieldsobjectDisplay values computed for the row.
resources[].calculatedFields.deviceNamestringDevice name.
resources[].calculatedFields.statusReasonobject[]Why the platform marked the device, when it did. Empty array when nothing was recorded.
resources[].calculatedFields.statusReason[].codestringReason code, such as no-assigned-resident. Stable. Render from this.
resources[].calculatedFields.statusReason[].displaystring | nullA sentence for the code. null for a code that has none.
resources[].calculatedFields.locationNamestringLocation name. Empty string when there is none.
resources[].calculatedFields.patientNamestringThe resident's full display name. Empty string when there is none.
resources[].calculatedFields.patientNicknamestringThe resident's nickname (Resident ID). Empty string when there is none.
resources[].calculatedFields.organizationNamestringZone 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.effectiveSleepStatusstringCurrent sleep status, as resources[].telemetry.effectiveSleepStatus.value. Empty string when unknown.
resources[].calculatedFields.activebooleantrue when the device is connected.
resources[].calculatedFields.admissionDatestringAdmission time of the resident. Left out when there is none.
resources[].calculatedFields.dischargeDatestringDischarge time of the resident. Left out when there is none.

Errors

StatusMeaning
401Bearer token is missing, invalid or expired.
403You 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.
422A query parameter fails validation.
503The 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

On this page