L
Leaphealth - OSDocs

Tell node

The Tell node sends a named signal, with optional values, to the journeys linked to this one, so they can continue when this side is ready.

The Tell node (code name Signal) lets linked journeys coordinate. It sends a named signal, such as transfer_ready, to the journeys linked to this one. A Pause in the other journey waits for that signal and continues when it arrives.

Journeys are linked by an Involve node. Only journeys linked to this one hear it; the sender never hears its own signal.

When to use it

  • The partner journey tells the patient journey that a test result is in.
  • The donor journey tells the recipient journey that the donor is cleared for surgery.
  • Pass values across, for example the date of a completed test.

Configuration

Field

What it does

Options and default

Label, Notes

See Label and Notes.

—

Signal name

The name of the signal. Required.

Free text, for example transfer_ready.

To the linked journeys holding the role

Send only to linked journeys that hold this role in the link.

Empty tells every linked journey.

Values to send

Pairs of Name and Expression. name → expression; the linked journey reads them off the event. Add a pair with Add value.

Optional. Start expressions with context., initial., nodes. or patient.; other text is sent as typed.

Tell has no Skip this step when… or If this step is already in the past fields.

Outcomes and branches

The connection editor offers no Outcome list for Tell. The step finishes at once and its plain connections are followed. If no journey is linked yet, nobody receives the signal.

What happens when it runs

  1. The values in Values to send are read from this journey. A value whose expression gives nothing is not sent.
  2. The signal goes to every linked journey, or only to those holding the role in To the linked journeys holding the role.
  3. In each receiving journey:
    • If a Pause is waiting on the event journey.linked_signal with a matching Signal name (and From the role, if set), that Pause continues.
    • If no such Pause is waiting yet, the signal is kept. When a matching Pause starts later, it continues at once. Only the latest signal of each name is kept.

Patients and staff see nothing at this step.

Example

Partner result ready.

Partner journey (role partner):

  1. After the step that records the semen analysis, add a Tell step: Signal name semen_analysis_done, To the linked journeys holding the role patient. Optionally add Values to send, each an expression for a value the patient journey needs, such as a field the earlier step wrote (nodes. step name . field).

Patient journey (role patient):

  1. A Pause with an event branch on journey.linked_signal, Signal name semen_analysis_done, From the role partner, plus a 30-day time branch.
  2. Connect the event branch to the treatment-planning step, and the time branch to an Engage task for the counsellor.

Because early signals are kept, it does not matter whether the partner finishes before or after the patient reaches the Pause.

Tips and limitations

  • Use the same signal name, character for character, in the Tell step and in the Pause.
  • A Pause that leaves Signal name empty listens to every signal from linked journeys.

Simulate

Simulate shows Tell steps as not available in this version — would fail here, although the step works in live runs. Test signals on test patients instead. See Versions, drafts and simulate.

journeysnodestellsignallinked journeys

Was this page helpful?

Last updated on

On this page