List recent alarm notifications
| Method | Path |
|---|---|
GET | /v1/slim/notifications/recent/alarms |
Authentication · Access policies
Lists the newest active device alarms and attention presses for your project. Use it for an alarm bell. It has the same response shape as GET /v1/slim/notifications/recent/oob.
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 CommunicationRequest:read and CommunicationRequest:search (admins and super admins skip this check).
Scope: The caller's project (from the token).
Behaviour
- Device alarms and attention presses are decided by the sending system. Ovok stores and forwards them.
- Returns at most
countrows (1 to 50, default 20), newest first by event time. - Always read from Medplum, limited to the
deviceAlarmandattentiontypes, sowarmisfalseandsourceismedplum. totalcounts alarm rows only. It is an estimate, capped at the list result cap (1,000 by default).- Acknowledge a row with
PATCH /v1/slim/notifications/{id}/ack; it then leaves this bell. - Out-of-bed is on
GET /v1/slim/notifications/recent/oob, medical notifications onGET /v1/slim/notifications/recent/medical.
Example
curl -X GET 'https://api.sandbox.ovok.com/v1/slim/notifications/recent/alarms?count=20' \
-H "Authorization: Bearer ${OVOK_TOKEN}"
Successful response
200 — Recent alarm notifications retrieved successfully.
Errors
| Status | Meaning |
|---|---|
401 | Bearer token is missing, invalid or expired. |
403 | You are not a practitioner, admin or System Owner, you lack CommunicationRequest:read or CommunicationRequest:search, your session has no project, or you cannot access the project. |
422 | A query parameter fails validation. |
504 | The Medplum search timed out. |