Incidents

Incident reports: falls, injuries, medication errors and other events that need follow-up, often for regulatory reporting.

Endpoints

The Incident object

object
stringread-only

String representing the object's type. Always incident.

id
stringread-only

Unique identifier of the incident.

title
string | nullmax length 200

Short summary.

description
string | nullmax length 20000

What happened.

incidentDateTime
string · date-time | null

When the incident happened.

category
string | null

Kind of incident.

One ofFallMedicationBehavioralInjuryEquipmentAttendanceConductOthernull
severity
string | null

How serious it was.

One ofLowMediumHighCriticalnull
status
string | null

Where follow-up stands. New incidents start Open.

One ofOpenMonitoringAwaitingFollowUpResolvedClosednull
patientId
string | nullmax length 64

The patient involved.

caregiverId
string | nullmax length 64

The caregiver involved.

visitId
string | nullmax length 64

The visit during which it happened.

actionsTaken
string | nullmax length 20000

What was done at the time.

injuryBodyPart
string | nullmax length 100

Body part injured, if any.

witnessName
string | nullmax length 200

Witness, if any.

emergencyServicesContacted
boolean | null

Whether 911 or other emergency services were called.

hospitalTransport
boolean | null

Whether the patient went to hospital.

hospitalName
string | nullmax length 200

Hospital, if transported.

physicianNotified
boolean | null

Whether the patient's physician was told.

familyNotified
boolean | null

Whether family was told.

regulatoryReportRequired
boolean | null

Whether the incident must be reported to a regulator.

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.

resolved
boolean | null

Whether the incident is resolved.

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 reported it.

reportedAt
string · date-time | nullread-only

When it was reported.

resolvedAt
string · date-time | nullread-only

When it was resolved.

createdAt
string · date-time | nullread-only

When the incident was created.

updatedAt
string · date-time | nullread-only

When the incident was last changed.