OVOK DOCS
Api referenceApiOperationsSlimThresholdSlim/Threshold/Patient

Get patient effective threshold

  • Sandbox: available
  • Staging: available
  • Production: unknown
GET
/v1/slim/threshold/patient/{patientId}

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 (an admin or super admin who holds no access policy skips this check). Scope: The caller's project (from the token).

Behaviour

  • Read-only; nothing is created.
  • 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.
  • This route does not check that the resident exists; the v2 route does.

Example

curl -X GET 'https://api.sandbox.ovok.com/v1/slim/threshold/patient/c3499c27-2973-0a7f-807e-fb8676a92dcb' \  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'

Authorization

bearer
headerAuthorizationBearer <JWT>

Path Parameters

patientId*string

Response Body

Patient effective threshold retrieved successfully.

application/json
  1. response
id?string
patientId*string
projectId?string
status*string
Value in"active""revoked"
date?string
Formatdate-time
period?
settings*
Example Request
curl -X GET 'https://api.sandbox.ovok.com/v1/slim/threshold/patient/string'
Example Response
{  "id": "string",  "patientId": "string",  "projectId": "string",  "status": "active",  "date": "2019-08-24T14:15:22Z",  "period": {    "start": "2019-08-24T14:15:22Z",    "end": "2019-08-24T14:15:22Z"  },  "settings": {    "heartRate": {      "period": {        "start": "19:00:00",        "end": "09:00:00"      },      "average": 0,      "averageRange": {        "min": 0,        "max": 0      },      "mode": "organization",      "enabled": true,      "absolute": {        "enabled": true,        "min": 0,        "max": 1000      }    },    "meanHeartRate": {      "period": {        "start": "19:00:00",        "end": "09:00:00"      },      "average": 0,      "averageRange": {        "min": 0,        "max": 0      },      "mode": "organization",      "enabled": true,      "relative": {        "enabled": true,        "min": 0,        "max": 1000      }    },    "respiratoryRate": {      "period": {        "start": "19:00:00",        "end": "09:00:00"      },      "average": 0,      "averageRange": {        "min": 0,        "max": 0      },      "mode": "organization",      "enabled": true,      "absolute": {        "enabled": true,        "min": 0,        "max": 1000      }    },    "meanRespiratoryRate": {      "period": {        "start": "19:00:00",        "end": "09:00:00"      },      "average": 0,      "averageRange": {        "min": 0,        "max": 0      },      "mode": "organization",      "enabled": true,      "relative": {        "enabled": true,        "min": 0,        "max": 1000      }    },    "durationOfOutOfBed": {      "period": {        "start": "19:00:00",        "end": "09:00:00"      },      "average": 0,      "averageRange": {        "min": 0,        "max": 0      },      "mode": "organization",      "enabled": true,      "absolute": {        "enabled": true,        "max": 1000000      },      "relative": {        "enabled": true,        "max": 100      }    },    "sleepDuration": {      "period": {        "start": "19:00:00",        "end": "09:00:00"      },      "average": 0,      "averageRange": {        "min": 0,        "max": 0      },      "mode": "organization",      "enabled": true,      "absolute": {        "enabled": true,        "min": 0,        "max": 1000      }    },    "numberOfTimesGettingOutOfBed": {      "period": {        "start": "19:00:00",        "end": "09:00:00"      },      "average": 0,      "averageRange": {        "min": 0,        "max": 0      },      "mode": "organization",      "enabled": true,      "absolute": {        "enabled": true,        "max": 1000      }    },    "oxygenSaturation": {      "period": {        "start": "19:00:00",        "end": "09:00:00"      },      "average": 0,      "averageRange": {        "min": 0,        "max": 0      },      "mode": "organization",      "enabled": true,      "absolute": {        "enabled": true,        "min": 0,        "max": 0      }    },    "pulseRate": {      "period": {        "start": "19:00:00",        "end": "09:00:00"      },      "average": 0,      "averageRange": {        "min": 0,        "max": 0      },      "mode": "organization",      "enabled": true,      "absolute": {        "enabled": true,        "min": 0,        "max": 0      }    },    "perfusionIndex": {      "period": {        "start": "19:00:00",        "end": "09:00:00"      },      "average": 0,      "averageRange": {        "min": 0,        "max": 0      },      "mode": "organization",      "enabled": true,      "absolute": {        "enabled": true,        "min": 0,        "max": 0      }    },    "bodyTemperature": {      "period": {        "start": "19:00:00",        "end": "09:00:00"      },      "average": 0,      "averageRange": {        "min": 0,        "max": 0      },      "mode": "organization",      "enabled": true,      "absolute": {        "enabled": true,        "min": 0,        "max": 0      }    }  }}