Thresholds

Get patient effective threshold

Get patient effective threshold using Ovok’s Slim API.

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

Authentication · Access policies

Returns the thresholds in effect for one resident: their own limits where they have them, and the home's limits everywhere else.

Deprecated. Use GET /v2/slim/threshold/patient/{patientId}. This v1 route stays available, unchanged, until every client has moved.

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 caller's project (from the token).

Request

Path parameters

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

Behaviour

  • Read-only; nothing is created.
  • When the home has never saved thresholds, its default template is used: heart rate enabled at 40–110 bpm, respiratory rate enabled at 8–25 breaths/min, and every other metric (including out of bed) disabled. The template date is the request time.
  • Each metric carries mode: patient (the resident's own limits) or organization (the home's limits, copied in). A few legacy records still read patient-auto; saves can no longer set it.
  • Medical limits are read from Signals, which evaluates them, where available. When Signals cannot answer, Ovok's stored copy is returned instead, and each metric read that way carries signalsSourceStale: true. A metric that is enabled here while Signals holds no rule for it reads enabled: false with signalsRuleMissing: true.
  • This route does not check that the resident exists; the v2 route does. An unknown id gets the home's thresholds back.
  • The signalsSync health verdict is only on Get patient effective threshold (v2). If the home has set limit ranges, this route includes ranges as stored, which the home's own v1 route never returns.
  • A relative (baseline) band is anchored to the resident's baseline: average carries the baseline average and averageRange the multipliers applied to it.

Example

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

Successful response

200 — Patient effective threshold retrieved successfully.

{
  "patientId": "3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21",
  "projectId": "3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b11",
  "status": "active",
  "date": "2026-10-09T08:30:00.000Z",
  "settings": {
    "heartRate": {
      "period": { "start": "19:00:00", "end": "09:00:00" },
      "mode": "patient",
      "enabled": true,
      "absolute": { "enabled": true, "min": 50, "max": 100 }
    },
    "meanHeartRate": {
      "period": { "start": "19:00:00", "end": "09:00:00" },
      "mode": "organization",
      "enabled": false,
      "relative": { "enabled": false, "min": 0, "max": 0 }
    },
    "respiratoryRate": {
      "period": { "start": "19:00:00", "end": "09:00:00" },
      "mode": "organization",
      "enabled": true,
      "absolute": { "enabled": true, "min": 8, "max": 25 }
    },
    "meanRespiratoryRate": {
      "period": { "start": "19:00:00", "end": "09:00:00" },
      "mode": "organization",
      "enabled": false,
      "relative": { "enabled": false, "min": 0, "max": 0 }
    },
    "durationOfOutOfBed": {
      "period": { "mode": "organization", "start": "19:00:00", "end": "09:00:00", "timezone": null },
      "mode": "organization",
      "enabled": true,
      "absolute": { "enabled": true, "max": 600 }
    },
    "sleepDuration": {
      "period": { "start": "19:00:00", "end": "09:00:00" },
      "mode": "organization",
      "enabled": true,
      "absolute": { "enabled": true, "min": 7, "max": 10 }
    },
    "numberOfTimesGettingOutOfBed": {
      "period": { "start": "19:00:00", "end": "09:00:00" },
      "mode": "organization",
      "enabled": true,
      "absolute": { "enabled": true, "max": 0 }
    }
  }
}
FieldTypeDescription
patientIdstringThe id from the path.
projectIdstringThe caller's project.
status"active" | "revoked"active while the home's template is active.
datestring (ISO 8601 date-time)When the home's thresholds were last saved, or the time of the request for a home with nothing stored. It does not move when only the resident's own limits are saved.
rangesobjectOnly when the home has set limit ranges: { min, max } (both number) under the vital's name (heartRate, respiratoryRate, oxygenSaturation, pulseRate, perfusionIndex, bodyTemperature), for the vitals the home set.
settingsobjectThe limits in effect per metric. A metric the home has not stored is omitted.
settings.heartRateobjectHeart-rate limit.
settings.heartRate.mode"organization" | "patient" | "patient-auto"patient is the resident's own limit, organization the home's. patient-auto appears only on a legacy record.
settings.heartRate.enabledbooleanWhether the metric alerts.
settings.heartRate.absoluteobjectThe fixed band.
settings.heartRate.absolute.enabledbooleanWhether the fixed band is armed.
settings.heartRate.absolute.minnumberLower bound in beats per minute. Omitted when none is stored.
settings.heartRate.absolute.maxnumberUpper bound in beats per minute. Omitted when none is stored.
settings.heartRate.relativeobjectThe relative (baseline) band as multipliers: { enabled, min, max }, min and max omitted when none is stored. Only on metrics that carry one.
settings.heartRate.periodobjectThe bed-time window. Present on every metric (the default 19:00 to 09:00 unless one is stored) but used only by durationOfOutOfBed.
settings.heartRate.period.mode"organization" | "patient"Only on durationOfOutOfBed: whether the window is the home's or the resident's own.
settings.heartRate.period.startstring (HH:MM:SS)Window start.
settings.heartRate.period.endstring (HH:MM:SS) | nullWindow end. Equal to start means 24 hours; before start crosses midnight.
settings.heartRate.period.timezonestring | nullOnly on durationOfOutOfBed: the zone stored with the window.
settings.heartRate.averagenumberThe baseline average a relative band is anchored to. Only with an armed relative band.
settings.heartRate.averageRangeobjectThe multipliers applied to average: { min, max }, both number. Only with average.
settings.heartRate.baselineUnavailablebooleantrue when a relative band has no anchor because the baseline could not be read. Omitted otherwise.
settings.heartRate.signalsSourceStalebooleantrue when the limit was not read live from Signals. Omitted otherwise.
settings.heartRate.signalsRuleMissingbooleantrue when the metric is enabled here but Signals holds no rule for it. Omitted otherwise.
settings.respiratoryRateobjectRespiratory-rate limit. Same fields as settings.heartRate, in breaths per minute.
settings.meanHeartRateobjectBaseline (mean) heart-rate band: the same fields, with relative instead of absolute.
settings.meanRespiratoryRateobjectBaseline (mean) respiratory-rate band. Same fields as settings.meanHeartRate.
settings.durationOfOutOfBedobjectOut-of-bed limit. The same fields, with absolute.max in seconds and an optional relative band.
settings.sleepDurationobjectSleep-duration limit. The same fields, with absolute.min and absolute.max in hours.
settings.numberOfTimesGettingOutOfBedobjectOut-of-bed count limit. The same fields, with absolute.max a count.
settings.oxygenSaturationobjectOptional vital. Present only when the home watches it or Signals holds a limit for the resident: mode, enabled and absolute ({ enabled, min, max }, an open side omitted).
settings.pulseRateobjectOptional vital. Same fields as settings.oxygenSaturation.
settings.perfusionIndexobjectOptional vital. Same fields as settings.oxygenSaturation.
settings.bodyTemperatureobjectOptional vital. Same fields as settings.oxygenSaturation.

Errors

StatusMeaning
400Your session has no project.
401Bearer token is missing, invalid or expired.
403You are not a practitioner, admin or System Owner, or you lack Goal:read.
502The home's stored thresholds could not be read.
503The access policy could not be read right now. Retry.

Last updated on

On this page