List alarm notifications

Method	Path
GET	/v1/slim/notifications/alarms

Authentication · Access policies

Lists your project's device alarms and attention presses, filtered and paged. These are decided by the sending system; Ovok stores them as CommunicationRequests and forwards them.

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, CommunicationRequest:search and Observation:read (admins and super admins skip this check). Scope: The caller's project (from the token). The project query parameter is accepted but ignored.

Behaviour

• One row per alarm episode. Each row's alarm carries the sender's own alarm id (episodeId), its severity, type and text, so the sender can match an acknowledgement to its own record.
• type: deviceAlarm, attention, or both comma separated. Both when omitted.
• severity: RED, YELLOW, ATTENTION, comma separated, as the sender coded the alarm. Every severity when omitted.
• status defaults to active; an acknowledged alarm is completed.
• sort: newest (default) or oldest, by event time (occurrenceDateTime, then authoredOn, then id).
• patient, device, startDate, endDate, page, count, total and truncated work as on GET /v1/slim/notifications/oob: count is 1 to 100 (default 25), dates are inclusive UTC instants, and the list pages through at most the first 1,000 results (server-configurable).
• Acknowledge a row with PATCH /v1/slim/notifications/{id}/ack.
• Out-of-bed is on GET /v1/slim/notifications/oob; vital-sign alerts, decided by Signals, are on GET /v1/slim/notifications/medical.

Example

curl -X GET 'https://api.sandbox.ovok.com/v1/slim/notifications/alarms?type=deviceAlarm&severity=RED&sort=newest' \
  -H "Authorization: Bearer ${OVOK_TOKEN}"

Successful response

200 — 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, CommunicationRequest:search or Observation:read, your session has no project, or you cannot access the project.
422	A query parameter fails validation.
504	A Medplum notification search timed out.