Skip to main content

Get patient vital thresholds

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.

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.

Errors​

StatusMeaning
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.