Notification Events

EventDescriptionEvent data
alert.triggerAlert about one of the configured triggers. This event is generated when a trigger condition in the patient's alert configuration is met by an incoming observation.patient - ObjectId of the patient associated with the alert.
observation - ObjectId of the FHIR Observation resource that caused the trigger to fire.
component - The full FHIR Observation resource (or the specific component within it if applicable) that contained the data evaluated by the trigger.
trigger - The complete definition of the trigger rule that was activated.
value (optional) - A custom value (string or number) returned by the trigger's logic if the logic is configured to produce a specific outcome value (e.g., "Oliguria", "Severe", 1, "Normal_Range"). This field is present if the advanced trigger logic defines it.
message (optional) - A custom descriptive message returned by the trigger's logic, providing more context about the alert. This field is present if the advanced trigger logic defines it.
alert.noteAlert created as a result of a note in an observation. The alertIfNote setting must be enabled in the patient's configuration for this event to be generated.patient - ObjectId of the patient.
observation - The FHIR Observation resource that contained the note and triggered the event.
alert.inactiveAlert created due to patient inactivity (no new observations for a defined period). The alertInactiveDays setting in the patient's configuration must be set to a value greater than 0.patient - ObjectId of the patient.
lastActive - Timestamp indicating when the patient's last observation was recorded.
alert.emptyAlert generated when an observation is received with no values (empty observation). The alertIfEmpty setting must be enabled in the patient's configuration.patient - ObjectId of the patient.
observation - The empty FHIR Observation resource that triggered the event.
observation.createdGenerated every time a new observation is successfully created for a patient.patient - ObjectId of the patient.
observation - The newly created FHIR Observation resource.
patient.updatedGenerated when a patient's information (demographics, etc.) has been updated.patient - The updated Patient resource or its ObjectId.
patient.configGenerated when a patient's alert configuration (including trigger rules) has been updated.patient - ObjectId of the patient whose configuration was updated.
patient.subscribedGenerated when a new subscriber (e.g., a practitioner or system) is associated with a patient for receiving notifications.patient - ObjectId of the patient.
subscriber - Identifier of the subscriber.
patient.unsubscribedGenerated when a subscriber is dissociated from a patient.patient - ObjectId of the patient.
subscriber - Identifier of the subscriber.

Note: Internally (in the code and database), notifications are for historical reasons defined as "alerts." However, this definition does not imply an urgent situation. These notifications are solely intended to inform the user.