Thresholds

Get patient vital thresholds

Get patient vital thresholds using Ovok’s Slim API.

MethodPath
GET/v1/slim/threshold/patient/:patientId/vitals

Authentication · Access policies

Lists the thresholds Signals holds for one resident on vitals other than heart rate, respiratory rate, out-of-bed and sleep. Signals is the certified service that evaluates these vitals. Ovok reads the stored limits from it and does not evaluate readings.

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 Goal:read (admins and super admins skip this check). Scope: The resident must be in the caller's project (from the token) or one of its sub-projects. A resident outside that scope answers 404, the same as an unknown id.

Request

Path parameters

NameTypeRequiredDescription
patientIdstring (uuid)YesThe resident's Patient id.

Behaviour

  • Read-only.
  • Codes that the threshold routes own (GET /v2/slim/threshold/patient/{patientId}, for example SpO₂ and pulse rate) are left out of the list.
  • Each entry has code, min and max (each null for no bound on that side), the trigger version, and updatedAt.
  • A resident with no Signals record, or with no such thresholds, gets { "vitals": [] }.
  • A resident whose Signals record was left half-created by an interrupted create is completed by this read.
  • If Signals cannot be reached the route answers 502, never an empty list.

Example

curl -X GET 'https://api.sandbox.ovok.com/v1/slim/threshold/patient/3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21/vitals' \
  -H "Authorization: Bearer ${OVOK_TOKEN}"

Successful response

200 — Vital thresholds retrieved from Signals.

{
  "vitals": [
    {
      "code": "8480-6",
      "min": 90,
      "max": null,
      "version": 3,
      "updatedAt": "2026-10-09T08:30:00.000Z"
    }
  ]
}
FieldTypeDescription
vitalsobject[]One entry per threshold Signals holds for the resident on a vital these routes manage. Empty when there is none.
vitals[].codestringThe vital code the threshold applies to, as the device sends it.
vitals[].minnumber | nullAlert when a reading falls below this value. null for no lower bound, or when the stored rule has more than one lower bound.
vitals[].maxnumber | nullAlert when a reading rises above this value. null for no upper bound, or when the stored rule has more than one upper bound.
vitals[].versionintegerThe trigger version Signals holds.
vitals[].updatedAtstring (ISO 8601 date-time)When Signals last changed the trigger.

Errors

StatusMeaning
400The resident's Signals link could not be resolved because the Patient record could not be read.
401Bearer token is missing, invalid or expired.
403You are not a practitioner, admin or System Owner, or you lack Goal:read.
404No patient with this id exists, or the patient is outside your project and its sub-projects or carries no project.
502Signals did not answer, so the vital thresholds are unknown.
503The access policy could not be read right now. Retry.

Last updated on

On this page