Events
Events your agency documents about a patient, caregiver or visit, such as a complaint, a compliment or an attendance issue.
Endpoints
The Event object
object
stringread-only
String representing the object's type. Always event.
id
stringread-only
Unique identifier of the event.
title
string | nullmax length 200
Short summary.
description
string | nullmax length 20000
What happened.
category
string | nullmax length 100
Category, as named in your agency's event types.
severity
string | null
How serious it was.
One of
LowMediumHighCriticalnullstatus
string | null
Where follow-up stands.
One of
OpenMonitoringAwaitingFollowUpResolvedClosednulloccurredAt
string · date-time | null
When it happened.
patientId
string | nullmax length 64
The patient involved.
caregiverId
string | nullmax length 64
The caregiver involved.
visitId
string | nullmax length 64
The visit involved.
pointValue
number | nullmin 0
Attendance points this event counts for, if your agency uses a points policy.
actionsTaken
string | nullmax length 20000
What was done.
outcome
string | nullmax length 20000
Outcome.
followUpRequired
boolean | null
Whether follow-up is needed.
followUpDueAt
string · date-time | null
When follow-up is due.
followUpNotes
string | nullmax length 20000
Follow-up notes.
resolutionNotes
string | nullmax length 20000
How it was resolved.
isConfidential
boolean | null
Whether only administrators can see it.
reportedByName
string | nullread-onlymax length 2000
Who documented it.
reportedAt
string · date-time | nullread-only
When it was documented.
resolvedAt
string · date-time | nullread-only
When it was resolved.
createdAt
string · date-time | nullread-only
When the event was created.
updatedAt
string · date-time | nullread-only
When the event was last changed.