Skip to main content

Add a note to a Signals raw alert

MethodPath
POST/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.

Adds a practitioner note to one raw alert. The body and text limits match the episode-note route. If the alert belongs to an episode, Ovok also includes the note in that episode's note list and count. The episode association is decided when the note is created.

Requirement or resultDetails
Access policysignals_alerts:update
Patient accessRead access to the alert's Patient; Patient update is not required for this note operation.
Body{ "text": "..." }; trimmed text must contain 1–2,000 characters.
Success201 with the saved note.
403Missing capability or caller is not a practitioner.
404Alert is missing, outside the project, or its Patient is not readable.
422text is empty or exceeds 2,000 characters.
curl --request POST \
--url 'https://api.sandbox.ovok.com/v1/signals/raw-alerts/7c2e9a4b-1f3d-4b8e-a6c5-2d9f0e1b3a7c/notes' \
--header "Authorization: Bearer ${OVOK_TOKEN}" \
--header 'Content-Type: application/json' \
--data '{ "text": "Sensor was repositioned." }'