Awell Workflow

Enrich your care flows with powerful Awell actions.

Category: Workflow. Adds 17 actions and 2 webhooks to a care flow.

Actions

Awell Workflow adds these 17 actions to a care flow. Add one to a step, then fill in its inputs.

Add ad hoc track

Add a pre-configured ad hoc track to a patient care flow.

This action retries automatically on a transient failure.

Add identifier to patient

Add a new identifier to the patient's profile

This action retries automatically on a transient failure.

This action allows you to add a unique identifier to the current patient's profile. If the patient already has an identifier with the same system but a different value, this action will update the existing identifier with the new value provided.

First, it checks if this identifier (system and value) is already associated with another patient. If it's safe to proceed, it will add or update the identifier as needed. However, if another patient already has this identifier, the action will stop and notify you, preventing duplicates. To avoid conflicts, we recommend first running the "Get patient by identifier" action to check for any existing matches.

Create Navi Session

Create a Navi portal session for a stakeholder

This action retries automatically on a transient failure.

Returns:

Get current care flow ID

Get the current care flow ID

This action retries automatically on a transient failure.

No inputs — this action takes no configuration.

Returns:

Get data point value

Get the value of a data point

This action retries automatically on a transient failure.

Returns:

This action allows you to read the most recent data point value of a given data point definition id from a care flow different from the current one. The action returns multiple data points, each with a different value type. Pick the one you need from the returned data points based on the value type of the data point you want to read the value from.

Example: If the data point you want to read the value from is of type number, then you should use the valueNumber data point.

Get patient by identifier

Retrieve a patient based on the provided identifier system and value

This action can be previewed in Studio before you publish, and retries automatically on a transient failure.

Returns:

This action lets you check if a patient with a specific identifier already exists in Awell. It's particularly useful when a patient's identity is initially anonymous during the start of the care flow, but later becomes identifiable through the identifiers collected during the care flow. This check ensures whether a patient with that identifier is already present or not.

Is patient already enrolled in care flow

Checks whether the patient is already enrolled in the current care flow definition.

This action retries automatically on a transient failure.

Returns:

Checks whether the patient is already enrolled in a care flow definition. The care flow the patient is currently enrolled in does not count and is excluded from the results.

**Action fields:

• pathwayStatus: a comma-separated string of care flow statuses that will be used when looking for care flows the patient is already enrolled in. By default, we only look at active care flows. Options: "active", "completed", "missing_baseline_info", "starting", and "stopped".
• careFlowDefinitionIds: a comma-separated string of care flow definition ids that will be used when looking for care flows the patient is already enrolled in. By default, we only search for care flows that match the current care flow definition id (i.e. is the patient already included in the current care flow?).

Data points**:

• result: a boolean indicating whether the patient is already enrolled in another care flow that matches your criteria (status & care flow definition id)
• nbrOfResults: the number of care flows found for the patient that match the criteria.
• careFlowIds: a comma-separated string of care flow ids that matched your search criteria. It will be empty when the result is false because then there are no other care flow ids that match your criteria.

Check patient track enrollment status

Checks whether the patient is enrolled, has been enrolled, or is scheduled to be enrolled in a specific track. This is time-based and will return the status of the track at the time of the check.

This action retries automatically on a transient failure.

Returns:

List form answers

List form answers

This action retries automatically on a transient failure.

Returns:

Search patient by patient code (DEPRECATED, USE IDENTIFIERS)

Search whether the current patient already exists. Search happens based on the patient_code field which is taken from the patient's profile.

This action can be previewed in Studio before you publish, and retries automatically on a transient failure.

No inputs — this action takes no configuration.

Returns:

Note that this action is deprecated and we recommend using identifiers instead.

Search whether, apart from the patient currently enrolled in the care flow, another patient with the same patient_code already exists.

Data points:

1. patientAlreadyExists: a boolean which will be true if minimum one patient with the patient code already exists.
2. numberOfPatientsFound: the number of patients found with the same patient code.
3. awellPatientIds: a comma-separated string of all Awell patient ids (except the current patient) that have the same patient code as the patient currently enrolled in the care flow. Will return an empty string when there are no other patients with the same patient code.

Start care flow

Start a new care flow for the patient currently enrolled in the care flow.

This action retries automatically on a transient failure.

Returns:

Starts a new care flow for the patient enrolled in your current care flow.

**Passing baseline info: Please read the documentation on our developer hub to learn more about how to pass baseline info.

Example of how to configure a value for the baseline info action field**:

[
  {
    "data_point_definition_id": "age",
    "value": "29"
  },
  {
    "data_point_definition_id": "dob",
    "value": "1993-11-30"
  }
]

Start Care flow and session

Start a new care flow and immediately create a session

This action retries automatically on a transient failure.

Returns:

Start Hosted Pages Session

Start a new Hosted Pages session for a given stakeholder

This action retries automatically on a transient failure.

Returns:

Stop care flow

Stop the care flow the patient is currently enrolled.

This action retries automatically on a transient failure.

Stops the care flow the patient is currently enrolled in. A reason is why you are stopping the care flow is mandatory.

Stop track

Stop a track in a patient care flow (pathway).

This action retries automatically on a transient failure.

Update Baseline Datapoints

Update some (or all) of the baseline datapoints for the patient currently enrolled in the care flow.

This action retries automatically on a transient failure.

Returns:

Update patient

Update the current patient with new data.

This action retries automatically on a transient failure.

Allows updating patient data for the patient currently enrolled in the care flow.

Webhooks

Awell Workflow can send these 2 events into Awell, where each one can start a care flow or move a patient along. Point the webhook at the URL Studio shows you when you enable it.

pathwayCompleted

Payload:

pathwayStart

This event carries no payload data points.

Setup and notes

Extension settings

You will need to provide the API URL and an API key.

Webhooks

Webhooks in the Awell extension offer ways to trigger a care flow based on the end of another care flow, or from any event that happens in your system (via the pathwayStart webhook).

Changelog

April 2024

Two new action were added: "Get patient by identifier" and "Add identifier to patient".

October 26, 2023

Generic webhook to start a care flow added

April 19, 2023

Stop care flow action added. Search patients by patient code action was added. "Is patient enrolled in care flow" action added.

Where this page comes from

The settings, actions, inputs, outputs and webhooks above are generated from the extension's own code, at @awell-health/awell-extensions v2.1.159. They match what the platform actually does rather than a description of it.

Field-level detail also appears in Awell Studio when you configure the action. Something wrong or missing? Email support@awellhealth.com.