Event catalog

Every event a journey can react to, grouped as in the product, with the label you pick, its key, and whether it can start a journey or be waited for.

Journeys react to events: things that happen elsewhere in LeapHealthOS, such as an appointment being completed or a package being bought. This page lists every event in the catalog, grouped exactly as the pickers group them. It is a reference for administrators building entry rules and journeys.

Where you pick an event

Where	Field	What you see	Which events are offered
Entry rules	When this happens	The label, under its group	For Start a journey: events marked Start below. For the other actions: every event except lead signals.
Pause node, event branch	Event type	The label and the key, for example "Appointment completed · hos.appointment.completed"	Events marked Wait below
Routine node	Event	The label	Every event except the Journey Lifecycle group
Journey settings > Global events & interrupt handlers	Subscribe to event	The label and the key	Events marked Wait below

Start means an entry rule can start a journey from this event. Wait means a step can wait for it, or a journey can react to it as a global event. In the entry rule editor, the description under When this happens explains the selected event, and the event's fields are offered in Only when… and Hand over these details.

Entry rules need a patient

An entry rule only acts on the patient the event names. Events marked "no patient" below do not name one, so an entry rule on them never enrols, signals, closes or pauses anyone, even though the picker offers them.

Appointment (25)

Label	Key	Start	Wait	Notes
Appointment draft created	`hos.appointment.draft_created`	Yes	Yes	Payment not yet collected.
Free appointment confirmed	`hos.appointment.free_confirmed`	Yes	Yes	Confirmed without payment.
Appointment confirmed	`hos.appointment.confirmed`	Yes	Yes	Any confirmation, free or paid. Use this or a specific variant, never both.
Paid appointment confirmed	`hos.appointment.paid_confirmed`	Yes	Yes	Confirmed after payment.
Appointment pending approval	`hos.appointment.pending_approval`	Yes	Yes
Appointment approval timed out	`hos.appointment.approval_timeout_admin`	Yes	Yes
Appointment rejected	`hos.appointment.rejected`	Yes	Yes
Appointment expired	`hos.appointment.expired`	Yes	Yes	An unconfirmed appointment expired.
Appointment cancelled	`hos.appointment.cancelled`	Yes	Yes	Also cancels open action links for that appointment.
Appointment rescheduled	`hos.appointment.rescheduled`	Yes	Yes
Appointment reminder	`hos.appointment.reminder`	Yes	Yes
Appointment checked in	`hos.appointment.checked_in`	Yes	Yes
Appointment started	`hos.appointment.started`	Yes	Yes
Appointment completed	`hos.appointment.completed`	Yes	Yes
Appointment no-show	`hos.appointment.no_show`	Yes	Yes
Appointment follow-up due	`hos.appointment.follow_up`	Yes	Yes
Emergency leave declared	`hos.appointment.emergency_leave`	Yes	Yes
Emergency leave reschedule notice	`hos.appointment.emergency_leave_reschedule_notify`	Yes	Yes
Emergency leave admin notice	`hos.appointment.emergency_leave_admin_notify`	Yes	Yes
Appointment payment nudge	`hos.appointment.payment_nudge`	Yes	Yes
Appointment payment link created	`hos.appointment.payment_link_created`	Yes	Yes
Appointment QR code created	`hos.appointment.qr_code_created`	Yes	Yes
Appointment payment collected	`hos.appointment.payment_collected`	Yes	Yes
Appointment draft payment reminder	`hos.appointment.draft_payment_reminder`	Yes	Yes
Appointment counter payment reminder	`hos.appointment.counter_payment_reminder`	Yes	Yes

Patient (4)

Label	Key	Start	Wait	Notes
Patient activated	`hos.patient.activated`	Yes	Yes	Happens once per patient. Use Once per patient on rules.
Patient bereavement flagged	`patient.bereavement_flagged`	No	Yes	Happens once. System interrupt: closes running journeys by default.
Programme suspended for patient	`programme.suspended_for_patient`	No	Yes	System interrupt: pauses by default.
Transfer of care	`patient.transfer_of_care`	No	Yes	System interrupt: closes by default.

Two patient events are not raised yet

Nothing in LeapHealthOS raises Programme suspended for patient or Transfer of care today. You can add handlers for them, but they do not occur yet.

Lead signals (4)

Lead signals come from a person's enquiries (leads). They reach the running journeys of the patient linked to that lead. They can never start a journey and are not offered in entry rules at all.

Label	Key	Start	Wait	Notes
Lead form submitted	`lead.form_submitted`	No	Yes
Lead message replied	`lead.message_replied`	No	Yes
Lead campaign clicked	`lead.campaign_clicked`	No	Yes
Lead blocked	`lead.blocked`	No	Yes	Also raises the Account blocked system interrupt (pauses by default).

Billing & Payments (7)

Label	Key	Start	Wait
Bill created	`hos.bill.created`	Yes	Yes
Bill issued	`hos.bill.issued`	Yes	Yes
Bill paid	`hos.bill.paid`	Yes	Yes
Bill payment link created	`hos.bill.payment_link_created`	Yes	Yes
Bill payment due reminder	`hos.bill.payment_due_reminder`	Yes	Yes
Refund processed	`hos.refund.processed`	Yes	Yes
Deposit received	`hos.deposit.received`	Yes	Yes

Packages (7)

Package events either open a package course or end it. A Start rule on an opening event should have a Close rule on the ending events (see Entry rules). Only package events carry the patient's package, so only they work with Once per package purchase.

Label	Key	Start	Wait	Package role
Package purchased	`hos.package.purchased`	Yes	Yes	Opens
Package session redeemed	`hos.package.redeemed`	Yes	Yes	Opens
Package completed	`hos.package.completed`	Yes	Yes
Package cancelled	`hos.package.cancelled`	Yes	Yes	Ends
Package expired	`hos.package.expired`	Yes	Yes	Ends
Package expiry reminder	`hos.package.expiry_reminder`	Yes	Yes
Package sessions low	`hos.package.sessions_low`	Yes	Yes

Clinical (15)

Label	Key	Start	Wait	Notes
Prescription ready	`hos.prescription.ready`	Yes	Yes
Report ready	`hos.report.ready`	Yes	Yes
Test requested	`hos.test.requested`	Yes	Yes
Lab samples partially collected	`hos.lab.samples_partially_collected`	Yes	Yes
Vitals recorded	`hos.vitals.recorded`	Yes	Yes	Carries the recorded values.
Report uploaded	`hos.report.uploaded`	Yes	Yes
Visit created	`hos.visit.created`	Yes	Yes
Consultation recorded	`hos.clinical.consultation_recorded`	Yes	Yes
Diagnosis recorded	`hos.clinical.diagnosis_recorded`	Yes	Yes	Carries the diagnosis codes.
Prescription stopped	`hos.prescription.stopped`	Yes	Yes
Report turnaround breached	`hos.report.tat_breached`	Yes	Yes	A result missed its due date.
Test scheduled	`hos.test.scheduled`	Yes	Yes
Test samples collected	`hos.test.sample_collected`	Yes	Yes	All samples for the request.
Test cancelled	`hos.test.cancelled`	Yes	Yes
Date fact changed	`hos.clinical.date_fact_changed`	Yes	Yes	A projected clinical date moved; waits anchored on it move too.

Inventory (2)

Label	Key	Start	Wait	Notes
Dispense requested	`hos.inventory.dispense_requested`	Yes	Yes	No patient.
Dispense reversal requested	`hos.inventory.dispense_reversal_requested`	Yes	Yes	No patient.

Walk-in Queue (4)

Label	Key	Start	Wait
Walk-in token issued	`hos.walk_in.token_issued`	Yes	Yes
Walk-in token called	`hos.walk_in.token_called`	Yes	Yes
Walk-in turn approaching	`hos.walk_in.approaching_turn`	Yes	Yes
Emergency intent raised	`hos.emergency.intent_raised`	Yes	Yes

Unit Occupancy (3)

Label	Key	Start	Wait	Notes
Occupancy started	`hos.occupancy.started`	Yes	Yes	A bed, chair or machine was taken.
Occupancy released	`hos.occupancy.released`	Yes	Yes	The discharge event. No patient.
Occupancy transferred	`hos.occupancy.transferred`	No	Yes	Moved to another unit.

Label	Key	Start	Wait	Notes
Consent granted	`consent.granted`	Yes	Yes	No patient.
Consent withdrawn	`consent.withdrawn`	Yes	Yes	No patient. Raises the Consent revoked system interrupt when no other contact consent is left, which must close the journey.

Roster (2)

Label	Key	Start	Wait	Notes
Shift started	`hos.shift.started`	No	Yes	A staff member came on duty. No patient.
Shift handover	`hos.shift.handover`	No	Yes	No patient.

Forms & Tasks (7)

These events report on work a journey started. Steps wait for them; they never start a journey.

Label	Key	Start	Wait	Notes
Feedback form submitted	`feedback.form_submitted`	No	Yes	A form linked to this journey was answered.
Task dispositioned	`task.dispositioned`	No	Yes	An Engage task was closed with an outcome.
Task escalation route taken	`task.escalation_route_taken`	No	Yes
AI flow completed	`hos.ai_flow.completed`	No	Yes
Signature recorded	`hos.signature.recorded`	No	Yes	One signer signed.
Signing links delivered	`hos.sign.delivered`	No	Yes	A stage's links went out.
Signing completed	`hos.sign.completed`	No	Yes	A signing request finished.

Alerts (3)

Label	Key	Start	Wait	Notes
Alert fired	`hos.alert.fired`	No	Yes	No patient.
Alert escalated	`hos.alert.escalated`	No	Yes	No patient.
Alert resolved	`hos.alert.resolved`	No	Yes	No patient.

Journey Lifecycle (9)

The first five come from journeys themselves. Another journey can start from them, but no step can wait for them (publishing a journey that tries is refused), and a journey never reacts to its own events. The last four come from journeys linked to this one.

Label	Key	Start	Wait	Notes
Journey instance started	`journey.instance_started`	Yes	No
Journey instance terminated	`journey.instance_terminated`	Yes	No	Carries the outcome. Use it to chain one journey after another.
Journey instance suspended	`journey.instance_suspended`	Yes	No
Journey instance resumed	`journey.instance_resumed`	Yes	No
Journey branch terminated	`journey.branch_terminated`	Yes	No
A linked journey tells us something	`journey.linked_signal`	No	Yes	Sent by a Tell step or a Signal entry rule. Filter by signal name and the sender's role.
A linked journey started	`journey.linked_started`	No	Yes
A linked journey ended	`journey.linked_ended`	No	Yes	Also a system interrupt; does nothing until you choose a handler.
A linked journey was cancelled	`journey.linked_cancelled`	No	Yes	Also a system interrupt; does nothing until you choose a handler.

System interrupts

Seven system interrupts appear in every journey's Global events & interrupt handlers. Two of them are not catalog events; they are raised by the events shown.

Name in Journey settings	Raised by	Default
Bereavement recorded	Patient bereavement flagged	Close
Consent revoked	Consent withdrawn, when no other contact consent is left	Close (must close)
Programme suspended	Programme suspended for patient	Pause
Transfer of care	Transfer of care	Close
Account blocked	Lead blocked	Pause
A linked journey ended	A linked journey ended	Nothing
A linked journey was cancelled	A linked journey was cancelled	Nothing

See Schedulers and journey settings for how to change these.

journeyseventsentry rulespauseinterruptsreference