Skip to main content

An alarm notification's notes

MethodPath
GET/v1/slim/notifications/alarms/:id/notes

Authentication · Access policies

Lists the notes on an alarm notification. A note is a practitioner's comment on a notification, stored as a FHIR Communication whose basedOn points at the alert. The alert itself is never changed.

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). An alert or note from another project, of another kind, or that does not exist answers the same 404.

Behaviour​

  • id is the notification row's commId.
  • Newest first. Deleted notes are not listed.
  • Read-only.

Example​

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

Successful response​

200 — The notes on this notification.

Errors​

StatusMeaning
401Bearer token is missing, invalid or expired.
403You lack CommunicationRequest:read or CommunicationRequest:search.
404The notification or note does not exist, or belongs to another project or another kind.
504The note search in Medplum timed out.