Skip to main content

A raw Signals alert's notes

MethodPath
GET/v1/slim/notifications/raw-alerts/:alertId/notes

Authentication · Access policies

Lists the notes on a raw Signals alert. 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 Patient:read (admins and super admins skip this check). Scope: The alert is read from Signals first, as /v1/signals/raw-alerts/:alertId reads it: 404 when it isn't in the caller's project or the caller can't read its resident.

Behaviour​

  • Newest first. Deleted notes are not listed.
  • Answers 503 signals_unavailable while Signals is down. Retry once Signals is back.

Example​

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

Successful response​

200 — The notes on this alert.

Errors​

StatusMeaning
401Bearer token is missing, invalid or expired.
403You lack Patient:read.
404The alert is not in your project, or you cannot read its resident.
504The note search in Medplum timed out.