Notifications

An alarm notification's notes

An alarm notification's notes using Ovok’s Slim API.

MethodPath
GET/v1/slim/notifications/alarms/:id/notes

Authentication · Access policies

Lists the notes on an alarm 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 CommunicationRequest:read and CommunicationRequest:search (admins and super admins skip this check). 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.

Request

Path parameters

NameTypeRequiredDescription
idstring (uuid)YesThe notification row's commId from GET /v1/slim/notifications/alarms.

No query parameters or body.

Behaviour

  • id is the notification row's commId.
  • Newest first. At most 200 notes are returned. Deleted notes are not listed.
  • An id that belongs to an out-of-bed notification answers 404: use GET /v1/slim/notifications/oob/:id/notes for those.
  • Read-only.

Example

curl -X GET 'https://api.sandbox.ovok.com/v1/slim/notifications/alarms/3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21/notes' \
  -H "Authorization: Bearer ${OVOK_TOKEN}"

Successful response

200 — The notes on this notification, newest first.

{
  "total": 2,
  "resources": [
    {
      "id": "3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b22",
      "target": { "kind": "alarm", "id": "3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21" },
      "patientId": "3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b23",
      "text": "Resident was in the bathroom; back in bed 02:14.",
      "author": { "practitionerId": "3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b24", "name": "Demo Nurse" },
      "createdAt": "2026-10-09T02:14:40.120Z",
      "updatedAt": "2026-10-09T02:20:05.511Z"
    },
    {
      "id": "3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b25",
      "target": { "kind": "alarm", "id": "3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21" },
      "patientId": "3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b23",
      "text": "Checked on the resident.",
      "author": { "practitionerId": "3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b26", "name": "Demo Carer" },
      "createdAt": "2026-10-09T01:58:12.345Z",
      "updatedAt": "2026-10-09T01:58:12.345Z"
    }
  ]
}
FieldTypeDescription
totalintegerThe number of notes in resources, at most 200. It is not a count of notes beyond that cap.
resourcesobject[]The notes, newest first. An empty array when there are none.
resources[].idstring (uuid)The note's id. Use it with the edit, replace and delete routes.
resources[].targetobjectThe notification the note was written on.
resources[].target.kind"oob" | "alarm" | "medical" | "alert"The kind of notification. A note written on a raw Signals alert and listed on that alert's episode keeps "alert".
resources[].target.idstringThe notification's id: the row's commId for oob and alarm, the row's episode.id for medical, the raw alert's id for alert.
resources[].patientIdstring (uuid) | nullThe resident's Patient id. null when the notification has no resident.
resources[].textstringThe note's text, trimmed.
resources[].authorobjectThe practitioner who wrote the note.
resources[].author.practitionerIdstring (uuid) | nullThe author's Practitioner id.
resources[].author.namestring | nullThe author's display name when the note was written.
resources[].createdAtstring (ISO 8601 date-time) | nullWhen the note was written.
resources[].updatedAtstring (ISO 8601 date-time) | nullWhen the note was last changed.

Errors

StatusMeaning
401Bearer token is missing, invalid or expired.
403You lack CommunicationRequest:read or CommunicationRequest:search.
404The notification does not exist, or belongs to another project or another kind.
422id is not a UUID.
504The FHIR search for notification notes timed out.

Last updated on

On this page