Skip to main content

List notes on a Signals raw alert

MethodPath
GET/v1/signals/raw-alerts/:alertId/notes

Shared authentication, project scope, and response conventions.

An alert note is a practitioner comment stored as a FHIR Communication. It does not edit the alert and is not sent to Signals. Ovok also makes these notes available through /v1/slim/notifications.

The note response has this shape:

FieldMeaning
idNote resource id.
target.kind, target.idThe target is medical plus an episode id, or alert plus a raw-alert id.
patientIdOvok Patient id, or null when unavailable.
textNote text.
author.practitionerId, author.nameAuthor identity and display name; either may be null.
createdAt, updatedAtTimestamps; either may be null.

Lists notes on one raw alert, newest first. This route works whether or not episode alerts are enabled.

Requirement or resultDetails
Access policysignals_alerts:read and read access to the alert's Patient
Success200 with total and resources
404Alert is missing, outside the project, or its Patient is not readable.
curl --request GET \
--url 'https://api.sandbox.ovok.com/v1/signals/raw-alerts/7c2e9a4b-1f3d-4b8e-a6c5-2d9f0e1b3a7c/notes' \
--header "Authorization: Bearer ${OVOK_TOKEN}"