Leave a note on a notification

Method	Path
POST	/v1/slim/notifications/notes

Authentication · Access policies

Leaves a note on a notification. 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 a practitioner can write notes. 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

• kind names the feed the notification comes from: oob or alarm with the row's commId as id, medical with the row's episode.id, or alert with a raw Signals alert's id (from /v1/signals/raw-alerts).
• A note on a raw alert is also listed and counted on that alert's episode. Which episode is decided once, when the note is written.
• text is trimmed and must be 1 to 2000 characters.
• The author is the calling practitioner, never a body field.
• Notes can be left on acknowledged notifications too.
• medical and alert notes are read from Signals first, so they answer 503 signals_unavailable while Signals is down. Retry once Signals is back.
• Answers 201 with the note as stored.

Example

curl -X POST 'https://api.sandbox.ovok.com/v1/slim/notifications/notes' \
  -H "Authorization: Bearer ${OVOK_TOKEN}" \
  -H 'Content-Type: application/json' \
  -d '{ "kind": "oob", "id": "3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21", "text": "Resident was in the bathroom." }'

Successful response

201 — The note as stored.

Errors

Status	Meaning
401	Bearer token is missing, invalid or expired.
403	You lack Patient:read, are not a practitioner, or your session has no project.
404	The notification or note does not exist, or belongs to another project or another kind.
422	The body fails validation (unknown kind, or text empty or over 2000 characters).