Notifications

A medical notification's notes

A medical notification's notes using Ovok’s Slim API.

MethodPath
GET/v1/slim/notifications/medical/:episodeId/notes

Authentication · Access policies

Lists the notes on a medical 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, Device:read and Location:read (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
episodeIdstringYesThe feed row's episode.id.

No query parameters or body.

Behaviour

  • episodeId is the feed row's episode.id.
  • Newest first. At most 200 notes are returned. Deleted notes are not listed.
  • Notes written on one of the episode's raw alerts are listed here too, with target.kind "alert".
  • The episode is read from Signals first, as the detail and the acknowledgement read it, so this answers 503 signals_unavailable while Signals is down. The body carries retryAfterSec, and the response has a Retry-After header with the same value.

Example

curl -X GET 'https://api.sandbox.ovok.com/v1/slim/notifications/medical/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": "medical", "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": "medical", "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 Patient:read, Device:read or Location:read, your session has no project, or you cannot access the project.
404The episode does not exist, belongs to another project, or its resident cannot be resolved in your project.
503Signals could not be reached. The body has error: "signals_unavailable" (signals_unavailable) and retryAfterSec; retry after that many seconds.
504The FHIR search for notification notes timed out.

Last updated on

On this page