Thresholds

Remove a patient vital threshold

Remove a patient vital threshold using Ovok’s Slim API.

MethodPath
DELETE/v1/slim/threshold/patient/:patientId/vitals/:code

Authentication · Access policies

Removes one resident's threshold for a single vital code in Signals, so that code no longer alerts for the resident.

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:update (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; otherwise 404.

Request

Path parameters

NameTypeRequiredDescription
patientIdstring (uuid)YesThe resident's Patient id.
codestringYesThe vital code, as the device sends it (for example 8480-6). 1 to 64 characters from letters, digits, ., _ and -. Codes the threshold routes own answer 400.

Behaviour

  • Answers 204 with no body once Signals confirms the removal. A 502 means Signals did not confirm; the call is safe to repeat.
  • Codes the threshold routes own (for example SpO₂ and pulse rate) are refused with 400.
  • code must be 1 to 64 characters from letters, digits, ., _ and -.

Example

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

Successful response

204 — Signals confirmed the removal.

No body.

Errors

StatusMeaning
400code is not a vital code, or it is a code the /v1/slim/threshold and /v2/slim/threshold routes own.
401Bearer token is missing, invalid or expired.
403You are not a practitioner, admin or System Owner, or you lack Goal:update.
404No patient with this id exists, or the patient is outside your project and its sub-projects or carries no project.
502Signals did not confirm the removal. Nothing changed; send it again.
503The access policy could not be read right now. Retry.

Last updated on

On this page