Awell Health Developer Hub
Dev Hub

Keep in mind that you are not restricted to using just one type of trigger. Each trigger is designed for specific use cases, so you can use a variety of triggers for your care flows in Awell.

Prerequisites

Regardless of the method used to trigger care flows in Awell, there are two fundamental principles to keep in mind.

Create a patient first

In Awell, each care flow is linked to a patient. This means a patient needs to be created before starting a care flow. However, Awell’s system is flexible in the data you need to provide for patients; we can even support anonymous patients (no PHI).

We do recommend populating the patient_code field in the patient profile. The value you input here is your internal ID for the patient, which facilitates matching a patient in Awell with one in your system.

Data required at care flow start

It’s important to consider what data will be needed to start a care flow. There are two categories of data to consider:

  1. Data about the patient (see above)
  2. Data needed for the care flow logic: this includes information essential for assessing conditions and determining timings within the care flow. For instance, in pre-surgery care flows, usually the type and date of surgery is provided. These data points are then utilized within the care flow's configuration to ensure timely message delivery and relevant surgery information.

Comparing trigger types

You can learn more about each trigger type on their corresponding pages (see "Trigger types").

Awell Hosted Pages Link

By pressing a link

Use when:

Patient self-enrollment

Effort:
Details
FeatureIncluded
Triggered byPatient
Patient self-enrollmentYes
Starts Hosted PagesYes
Supports baseline infoLink: no
Session: yes
Real-timeYes
BatchNo

Awell API

By calling our API

Use when:

You want maximum control and flexibility

Effort:
Details
FeatureIncluded
Triggered byCall to our API
Patient self-enrollmentYes
Starts Hosted PagesNo
Supports baseline infoYes
Real-timeYes
BatchNo

Incoming webhooks

Based on events in external systems

Use when:

You want external system to trigger a care flow

Effort:
Details
FeatureIncluded
Triggered byEvent in external system
Patient self-enrollmentNo
Starts Hosted PagesNo
Supports baseline infoYes
Real-timeYes
BatchNo

File uploads

With a CSV, XML, JSON file

Use when:

You want a convenient and easy way to trigger care flows in batch

Effort:
Details
FeatureIncluded
Triggered byUploading a file
Patient self-enrollmentNo
Starts Hosted PagesNo
Supports baseline infoYes
Real-timeNo
BatchYes

ADT feeds

By listening to ADT messages

Use when:

Start care flows based on ADT messages

Effort:
Details
FeatureIncluded
Triggered byreceival of ADT message
Patient self-enrollmentNo
Starts Hosted PagesNo
Supports baseline infoYes
Real-timeYes
BatchNo

Awell Care

Via Awell's app

Use when:

You're using Awell Care to operate care flows

Effort:
Details
FeatureIncluded
Triggered byCare team member
Patient self-enrollmentNo
Starts Hosted PagesNo
Supports baseline infoYes
Real-timeYes
BatchNo