Delete a note
| Method | Path |
|---|---|
DELETE | /v1/slim/notifications/notes/:noteId |
Authentication · Access policies
Deletes a note. A note is a practitioner's comment on a notification, stored as a FHIR Communication whose basedOn points at the alert. The alert itself is never changed.
Auth: Bearer token. The caller must be a practitioner, an admin, a super admin, or hold the "System Owner" access policy. The access policy must grant Patient:read (admins and super admins skip this check). Only the note's author can delete it.
Scope: The caller's project (from the token). An alert or note from another project, of another kind, or that does not exist answers the same 404.
Behaviour
- The note is marked
entered-in-error, not erased, so the clinical record and its history survive. - A deleted note leaves every list and every
noteCount. - Answers 204 with no body.
Example
curl -X DELETE 'https://api.sandbox.ovok.com/v1/slim/notifications/notes/3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21' \
-H "Authorization: Bearer ${OVOK_TOKEN}"
Successful response
204 — The note was deleted. No response body is returned.
Errors
| Status | Meaning |
|---|---|
401 | Bearer token is missing, invalid or expired. |
403 | You lack Patient:read or are not the note's author. |
404 | The notification or note does not exist, or belongs to another project or another kind. |
409 | The note changed while this delete was in flight. Reload it and try again. |