Skip to main content

Add a note to a Signals episode

MethodPath
POST/v1/signals/alerts/:episodeId/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 note to an episode. Only a practitioner can write a note. The route author comes from the bearer token; do not send an author field.

Input or resultDetails
Access policysignals_alerts:update
Patient accessRead access to the episode's Patient; this note operation does not require Patient update.
Body{ "text": "..." }; trimmed text must contain 1–2,000 characters.
Success201 with the saved note.
403Missing capability or caller is not a practitioner.
404Episode 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/alerts/0b6f8c1e-2a4d-4e7b-9c3f-1d5e8a7b6c4d/notes' \
--header "Authorization: Bearer ${OVOK_TOKEN}" \
--header 'Content-Type: application/json' \
--data '{ "text": "Checked on the resident; resting." }'