Get medical notification

Method	Path
GET	/v1/slim/notifications/medical/:episodeId

Authentication · Access policies

Returns one medical notification with its full value history, addressed by the episode.id a feed row carries. The episode is read from Signals, which decides medical alerts.

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 Patient:read, Device:read and Location:read (admins and super admins skip this check). Scope: The caller's project (from the token), applied on both sides: Signals matches it against the resident's project stamp, and Ovok checks the resolved resident against your project.

Behaviour

• episode is the Signals episode as Signals returned it: status, open and close times, close reason, aggregates, and every reading recorded while it ran (values). Check episode.truncated: a very long episode returns a capped series and says so.
• carehub adds the resident context: resident, room and bed, device and zone. Its fields are null when the resident has no device assigned.
• acknowledgement is null until someone acknowledges the episode.
• episode.firedBand is the band the episode was judged under, as described on GET /v1/slim/notifications/medical. It is null when it cannot be established.
• An episode in another project answers 404, the same as one that does not exist. A 404 is never caused by Signals being down.
• A 503 with signals_unavailable means Signals could not be reached; retry after retryAfterSec.

Example

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

Successful response

200 — The episode and its resident context.

Errors

Status	Meaning
401	Bearer token is missing, invalid or expired.
403	You are not a practitioner, admin or System Owner, you lack Patient:read, Device:read or Location:read, your session has no project, or you cannot access the project.
404	No episode with this id exists in your project, or its resident cannot be resolved into your project.