Patients

Get patient current vitals

Get patient current vitals using Ovok’s Slim API.

MethodPath
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

NameTypeRequiredDescription
idstring (uuid)YesPatient 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 telemetry can 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 }
      }
    }
  ]
}
FieldTypeDescription
totalintegerNumber of entries. One per device assigned to the resident.
resourcesobject[]The entries, at most 100.
resources[].deviceobjectThe device. Left out when there is none.
resources[].device.idstring (uuid)Device id.
resources[].device.namestringDevice name.
resources[].patientobjectThe resident. Left out when there is none.
resources[].patient.idstring (uuid)Patient id.
resources[].patient.namestringThe resident's full display name. Empty string when no name resolves.
resources[].patient.nicknamestring | nullThe resident's nickname (Resident ID).
resources[].organizationobjectThe 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. Left out when the device has none. Every metric below 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.

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.
422id is not a UUID.

Last updated on

On this page