Skip to main content

List recent medical notifications

MethodPath
GET/v1/slim/notifications/recent/medical

Authentication · Access policies

Lists the newest unacknowledged medical notifications for your project, open and closed. Use it for a medical notification bell. Medical episodes are decided by Signals; Ovok reads them from Signals and adds the resident context.

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 filters on the resident's project stamp, and Ovok checks each resolved resident against your project.

Behaviour​

  • The filter is fixed by the server: unacknowledged episodes, open or closed, newest first, at most count (1 to 50, default 20). A closed episode stays here until someone acknowledges it with POST /v1/slim/notifications/medical/{episodeId}/ack. Each row's episode.status (OPEN or CLOSED) says whether it is still running.
  • Rows have the same shape as GET /v1/slim/notifications/medical, including episode.firedBand.
  • nextCursor is set when more unacknowledged episodes exist beyond count. A bell can ignore it.
  • A resident who cannot be resolved into your project is left out, so a page can hold fewer than count rows.
  • A resident with no Signals project stamp matches no project and does not appear.
  • When the project's Signals tenant has episodic alerts switched off, the list is empty.
  • A 503 with signals_unavailable means Signals could not be reached, not that there are no notifications; retry after retryAfterSec.
  • Out-of-bed is not here; read GET /v1/slim/notifications/recent/oob.

Example​

curl -X GET 'https://api.sandbox.ovok.com/v1/slim/notifications/recent/medical?count=20' \
-H "Authorization: Bearer ${OVOK_TOKEN}"

Successful response​

200 — The newest unacknowledged medical notifications, open and closed.

Errors​

StatusMeaning
401Bearer token is missing, invalid or expired.
403You 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.
422A query parameter fails validation.