L
Leaphealth - OSDocs

Running journeys: the Patients tab and actions

Find a patient's journey, read what it is waiting on, and pause, resume, cancel or move a stuck step along.

Once patients are on journeys, the Patients tab shows every run, and the journey detail panel lets you see exactly where one patient is and step in when something needs a person. This page is for administrators and senior nurses who look after journeys day to day.

The Patients tab

Open JourneysPatients. The list, titled Patients on journeys, shows everyone who is or was on a journey, newest first.

Column

What it shows

Patient

The patient's name. Select it to open the patient profile.

Journey

The journey name and the version the patient is running ("version N").

Status

Running, Paused or Ended.

Where it is now

The steps that are live now, "Between steps" for the moment between two steps, or the outcome once the journey has ended.

Started / Ended

When the journey started and ended ("Not ended" while it runs).

Narrow the list with the Journey filter and the Status filter (Running, paused and ended / Running / Paused / Ended). From the journeys list you can also select Patients on this journey on a journey's row to open this tab already filtered.

There is no search by patient name on this tab. To find one patient's journeys, open their profile and use the Journeys tab (see The patient profile).

Select a row to open the journey detail panel.

Journey statuses

Journey statuses

From → ToTriggerActorConditionSide effects
RunningPausedPauseStaff, an entry rule or an interruptTimers and listeners put on hold
PausedRunningResumeStaff, or the automatic resume timeTimers re-armed; overdue ones fire at once
RunningEndedClose step, Cancel journey, a Close rule or an interruptJourney, staff or ruleOpen tasks handled by the journey's close setting
PausedEndedCancel journey, a Close rule or an interruptStaff or rule
Runninginitial
The journey is moving: steps run, wait for events and wait for time.
Paused
Nothing moves. Timers and event listeners are on hold.
Endedterminal
The journey is finished and has an outcome. It cannot be restarted.

An ended journey shows how it ended: Completed, Did not complete or No outcome recorded, plus an outcome label such as "Reached the end", "Cancelled by staff", "Handed over to another journey", "Closed by an entry rule" or "Merged into another patient record". A journey that finishes with a successful Close step but had a failed step along the way is shown as No outcome recorded, not Completed.

Reading a patient's journey

The detail panel opens on the right. The header shows the patient, the journey, the version and the status. Banners appear when the journey is "Paused … — reason · Resumes automatically time" or "Interrupted: reason" (for example Consent withdrawn). When you open it from Health, it also says why the journey is stuck.

Section

What it tells you

Waiting on

Each live step: its type and name, its status (Queued, Running, Waiting), how long it has been there, the events it is waiting for and "until time" if a time limit is set. "Nothing can move this step" means no event is expected and no time is set.

Listening for

The events the journey is waiting to hear: Listening, On hold (while paused), Received or Cancelled.

Scheduled

Upcoming times, for example "Scheduled wait", "Fallback if staff don't respond", "Signing window closes", "Reminder due", "Scheduled resume", "Next repeat" (a scheduler) and "Message held until allowed hours".

Recent messages

Each message sent: channel, status, delivery, template and the values filled in. If a message was not sent, Why gives the reason. See What patients receive.

Signing

Any documents out for signature, each signer's status, and links to the signed document.

Linked journeys

Journeys of other people linked to this one, with their roles.

Activity

The journey's history, newest first: each step, event, timer and staff action, with "by staff — reason" for staff actions. Select Show more for older entries and Details for the raw facts.

Values

What the journey remembers: Initial (the values it started with), From steps (what each step produced) and Other.

The panel refreshes itself every few seconds while a step is running.

Pause, resume or cancel a journey

These buttons sit at the bottom of the panel for journeys that have not ended. Each needs a Reason, which goes on the journey's record ("Say why — it goes on the journey's record").

Pause

Pause the journey

Administrator

Open the journey and select Pause.

Give a reason and choose options

Enter a Reason. Under Advanced you can set Resume automatically (a date and time) and Open tasks: Hold open tasks (default) or Leave open tasks running.

Confirm

Select Pause.

Expected result: "Paused" appears and the status changes to Paused. The panel shows when it resumes, if you set a time.

While a journey is paused, its timers and event listeners are on hold, so no step moves. Interrupts (such as consent being withdrawn) still apply.

What to expect while a journey is paused

  • Things that happen during a pause are not picked up later. If a step was waiting for something (a task outcome, a form, a signature, a payment) and it happens while the journey is paused, the step does not move after you resume. It keeps waiting, and may later take its time-limit path instead. After resuming, check Waiting on and use Move ahead if the thing the step was waiting for already happened.
  • Open tasks are not held yet. Hold open tasks (default) currently behaves like Leave open tasks running: the journey's open tasks stay on staff worklists and can still be worked. If that matters, tell your team not to work tasks for a paused journey, or close them by hand.

Resume

Select Resume, give a reason and confirm. Timers and listeners are switched back on. Any timer whose time passed during the pause fires straight away. A scheduled automatic resume is cancelled.

Cancel journey

Select Cancel journey, give a reason and confirm.

Cancelling cannot be undone

"It ends now and cannot be resumed. The patient keeps their record." The outcome is Cancelled by staff. The journey's open tasks are handled by its On instance close setting (cancelled by default; see Schedulers and journey settings). Appointments are never touched. To put the patient back on the journey, enrol them again.

Fix a stuck step

Each live step in Waiting on has three actions: Move ahead, Skip and Retry. Each value under Values has Change. Every action needs a reason and is recorded in Activity with your name and reason. On the patient profile, steps you moved show as "Moved on manually — reason".

Action

What it does

Use it when

Move ahead

Completes the step now. In Take, choose the path to follow or Let the journey decide. Optionally pick an Outcome, type an Outcome key not listed above, and add Values to apply (key and value pairs the next conditions can read).

The thing the step waits for happened outside LeapHealthOS, or during a pause.

Skip

Completes the step as skipped and continues along the path in Continue along, preset to the step's default outcome.

The step no longer applies to this patient.

Retry

Sends the step's last attempt again. Tick Start a fresh attempt to cancel it and start the step from scratch.

A message or task failed for a reason that is now fixed (for example a missing contact detail).

Change (in Values)

Overwrites one remembered value.

A value was wrong and later conditions depend on it.

Changing values changes what happens next

Later steps and path conditions read these values. Changing one, or applying values with Move ahead, can send the patient down a different path. Check the journey design before you change anything.

If someone else acted first, you may see "Already applied", "The step had already moved on" or "The journey did not accept that". Nothing was changed; refresh and look again.

Who can do this

  • Pause, Resume and Cancel journey need the Update permission on Journeys.
  • Move ahead, Skip, Retry and Change need the Override permission on Journeys.

Staff without these permissions do not see the buttons. Permissions are set per staff type in SettingsPlatform ConfigurationSystem Settings, Organisation tab. See Who can do what in Journeys.

Activity entries you will see

Entry

Meaning

Admission attempted

Someone or something tried to enrol the patient again while this journey was running, or during its cooldown.

Step skipped at entry

The journey started part-way through, so earlier steps did not run.

Step skipped — condition not met

The step's own skip condition held.

Step started / Step completed

A step began or finished.

Moved to the next step

A path was followed.

Event received

A step heard the event it was waiting for.

Event ignored — nothing was waiting for it

The event arrived but did not match what any step was waiting for.

Event arrived late

The event came after the step had stopped waiting for it.

Scheduled time reached / Schedule moved / Schedule skipped — already past

A timer fired, was moved because a date changed, or was skipped because it was already in the past.

Path closed

One path of the journey ended.

Fallback deadline passed

A step's time limit ran out.

Arrival recorded / All arrivals in

A Gather step is collecting paths.

Interruption handled / Interruption queued / Interruption dropped

An interrupt such as consent withdrawn was acted on, queued behind another, or ignored.

Journey paused / Journey resumed / Journey ended

Status changes.

Moved ahead / Step skipped / Step retried / Value changed

Staff actions on a step.

Delivery attempted

A message, task or document was sent. If it failed, Reason: says why.

Staff action

Another staff action, with the reason given.

Step not available yet

The step type cannot run yet; the step did nothing.

Patient records merged

This journey was moved from a duplicate patient record.

journeyspatients on journeyspauseresumecancelmove aheadskipretrysupport

Was this page helpful?

Last updated on

On this page