Skip to main content

Delete a Signals note

MethodPath
DELETE/v1/signals/notes/:noteId

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.

Only the author can delete the note. The caller must be a practitioner with signals_alerts:update.

Deletes a note from the active note feed. Only the author can delete it, and the caller must be a practitioner with signals_alerts:update.

ResultDetails
Success204 No Content; no response body. The note is marked entered-in-error so its clinical history is retained, then excluded from note lists and counts.
403Missing capability, caller is not a practitioner, or caller is not the author.
404Note does not exist in this project.
409Note changed during the write. Reload it and retry.
curl --request DELETE \
--url 'https://api.sandbox.ovok.com/v1/signals/notes/3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21' \
--header "Authorization: Bearer ${OVOK_TOKEN}"