L
Leaphealth - OSDocs

Creating and managing journeys

Use the journeys list, create a journey, find your way around the builder screen, save your work, edit with colleagues and archive a journey.

This page covers the journeys list and the everyday work around a journey: creating it, opening it in the builder, saving, working alongside colleagues and archiving it when it is no longer needed. It is for administrators and implementation staff who build journeys.

The journeys list

Open JourneysJourneys. The list shows every active journey, the most recently edited first.

Column

What it shows

Journey

The journey's name. Click the row to open it in the builder.

Status

Published (green) once at least one version is published, otherwise Draft (amber).

Version

The latest published version, such as v3, or Not published.

Nodes

The number of steps in the current draft.

Last edited

When the journey was last changed. Hover for the exact date and time.

Actions

Open, Insights, Patients on this journey and Archive.

The row actions are:

  • Open (the edit icon): opens the builder.
  • Insights: opens the Insights tab filtered to this journey.
  • Patients on this journey: opens the Patients tab filtered to this journey.
  • Archive: shown only if your role has the Delete permission on Journeys. See "Archiving a journey" below.

Long lists are split into pages. Use Previous and Next to move between them; the footer shows Showing N. On a phone, each journey is a card with its version, node count, last edit and an Open button.

A published journey can have unpublished changes

The status stays Published while you edit the draft, and the list does not show that the draft differs from the published version. The Nodes column counts the draft, while Version shows what patients are on.

If there are no journeys yet you see No journeys yet — "Create your first journey to start orchestrating patient programs." If the list cannot load you see Couldn't load journeys with a Retry button.

Journey statuses

Journey statuses

From → ToTriggerActorConditionSide effects
DraftPublishedPublishStaff with Journeys PublishNo blocking review findingsCreates v1
PublishedPublishedPublishStaff with Journeys PublishThe draft has changed since the last versionCreates the next version
DraftArchivedArchiveStaff with Journeys DeleteJourney leaves the list
PublishedArchivedArchiveStaff with Journeys DeleteJourney leaves the list; running patients continue on their version
Draftinitial
Created but never published. No patient can enter it.
Published
At least one version is published. Patients can enter the latest version. Stays Published while the draft changes.
Archivedterminal
Removed from the list. Patients already on it continue. It cannot be restored.

Creating a journey

Start a new journey

Staff with Journeys Create

Journeys > Journeys

Select Create journey at the right of the tab bar. You see it only if your role has the Create permission on Journeys.

Name it

Enter a Journey name of up to 120 characters. The counter under the field shows how many you have used.

Create it

Select Create.

Expected result: The builder opens on an empty draft.

Choose the name carefully: a journey cannot be renamed after it is created, and it cannot be duplicated. If you leave the name empty you see Journey name is required. If creation fails you see Could not create journey. Please try again.

A new journey starts with an empty canvas and default settings: when it ends, open tasks are cancelled and the outcome of the last track to finish is the journey's outcome. You can change these in the journey's Settings (see Schedulers and journey settings).

The builder screen

The header across the top of the builder holds the journey-level controls.

Control

What it does

When it is unavailable

Back arrow

Returns to the journeys list.

Name and vN chip

The journey's name, and its latest published version once there is one.

Save status chip

Shows whether the draft is saved (see "Saving your work").

Hidden while you view a published version.

Review chip

n to fix, n likely to break a run or n to review. Opens Review before publishing.

Hidden when there are no findings.

View published

Shows the latest published version, read-only.

Only shown once the journey is published.

Settings

Journey settings: initiation fields, what happens at close, timing, interrupts and booking profiles.

Disabled while the canvas is read-only.

Schedulers

Recurring touchpoints that run while a patient is on the journey.

Disabled while the canvas is read-only.

History

Draft and published versions, with View and Restore.

Simulate

A dry walk through the journey.

Disabled for a never-published journey with no steps.

Save

Saves the draft now.

Disabled while saving, while viewing a version or while read-only.

Publish

Publishes the draft as the next version.

Disabled while saving, while read-only, or when the builder sees a blocking finding.

Settings and Schedulers are covered in Schedulers and journey settings. Review and Publish are covered in Publishing and validation rules. History and Simulate are covered in Versions, drafts and simulate. The canvas is covered in The builder canvas and how connections work.

If the journey cannot load you see Couldn't load this journey with Retry. If it has been archived or does not exist you see Journey not found with Back to journeys.

Saving your work

The builder edits one draft, and saves it for you a moment after each change. You can also select Save to save at once; you see Draft saved.

The save status chip next to the name shows:

Chip

Meaning

Saving…

A save is in progress.

Draft saved just now, Draft saved today 14:05, Draft saved yesterday 09:30, Draft saved 03 Nov 16:20

The draft is saved.

Not saved — retry (red)

The last save failed. Select Save to try again.

Hover over the chip for a reminder: "Saves automatically a few seconds after you stop typing — or use Save to sync now". If a save fails you may also see Draft not saved — your latest changes are not synced. Your browser warns you if you try to leave the page before the draft is saved.

Saving never affects patients

The draft is only a working copy. Nothing you save reaches patients until you publish. Saving a step's dialog updates the canvas; the draft itself saves a moment later.

Editing with colleagues

Several people can open the same journey. If someone is already editing when you open it, a banner shows Name is also editing this journey (or Name (+n more)…) and the chip Read-only while they edit. The canvas is read-only for you until they leave, or until you select Edit anyway.

While you work, drafts your colleagues save replace what is on your canvas. After you select Edit anyway, whoever saves last wins: your changes can overwrite theirs, and theirs yours. Agree who edits before you both make changes.

Archiving a journey

Archive a journey you no longer use, so it leaves the list and no new patients can enter it.

Find the journey

Staff with Journeys Delete

Journeys > Journeys

Find the journey in the list.

Archive it

Select the archive icon in the Actions column. You see it only if your role has the Delete permission on Journeys.

Confirm

The dialog asks Archive this journey? — "Patients already on this journey continue on the version they started. The journey leaves this list." Select Archive.

Expected result: You see Journey archived.

Archiving cannot be undone

There is no way to unarchive a journey or to see archived journeys in the list. Opening an archived journey's address shows Journey not found. Patients already on it continue to the end of their version.

Before you archive, check other journeys that hand patients to this one with a Connect or Involve step. After archiving, those journeys fail the publish check "A Connect step targets a journey that is not active for this tenant." until you change their target. To stop new patients without archiving, switch off the journey's entry rules instead (see Entry rules and enrolling patients).

What you cannot do yet

Not available in LeapHealthOS today

  • Rename a journey.
  • Duplicate or copy a journey, or copy steps between journeys.
  • Delete a journey permanently, or restore an archived one.
  • Search, filter or sort the journeys list.
journeyscreatearchivebuilderautosavedraftstatus

Was this page helpful?

Last updated on

On this page