List notes on a Signals episode
| Method | Path |
|---|---|
GET | /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:
| Field | Meaning |
|---|---|
id | Note resource id. |
target.kind, target.id | The target is medical plus an episode id, or alert plus a raw-alert id. |
patientId | Ovok Patient id, or null when unavailable. |
text | Note text. |
author.practitionerId, author.name | Author identity and display name; either may be null. |
createdAt, updatedAt | Timestamps; either may be null. |
Lists notes attached to an episode, newest first. This includes notes written on raw alerts that belong to the episode; those notes retain target.kind: alert and their raw-alert id.
| Requirement or result | Details |
|---|---|
| Access policy | signals_alerts:read and read access to the episode's Patient |
| Success | 200 with total and resources |
404 | Episode is missing, outside the project, or its Patient is not readable. |
curl --request GET \
--url 'https://api.sandbox.ovok.com/v1/signals/alerts/0b6f8c1e-2a4d-4e7b-9c3f-1d5e8a7b6c4d/notes' \
--header "Authorization: Bearer ${OVOK_TOKEN}"