Healthie

Easily orchestrate actions in Healthie and receive webhooks events.

Category: EHR Integrations. Adds 30 actions and 23 webhooks to a care flow.

What to configure

Set these once, on the extension in Awell Studio. An action fails at run time if a required setting is missing.

Actions

Healthie adds these 30 actions to a care flow. Add one to a step, then fill in its inputs.

Apply tag to a patient

Apply a tag to a patient in Healthie.

This action can be previewed in Studio before you publish.

Adds a tag (existing one, identified by an id) to a patient. Although the Healthie API call allows assigning multiple tags per API call, for simplicity of the logic this action can only take one tag as input. Assigning multiple tags is possible by adding multiple actions.

Archive patient

Archive a patient in Healthie.

This action can be previewed in Studio before you publish.

Archives a patient with a given id.

Assign patient to group

Assign or remove a patient from a group in Healthie.

This action can be previewed in Studio before you publish.

Cancel appointment

Cancel an appointment in Healthie.

This action can be previewed in Studio before you publish.

Cancels an appointment with a given id.

Check patient tag

Check if a patient has the given tag in their active tags in Healthie.

This action can be previewed in Studio before you publish.

Returns:

Checks that a patient has an active tag with given id

Check scheduled appointments

Check if the given patient has an active appointment scheduled for the given appointment type.

This action can be previewed in Studio before you publish.

Returns:

Checks that a patient has active scheduled appointment with given appointmentTypeId

Close chat conversation

Close a chat conversation in Healthie.

This action can be previewed in Studio before you publish.

Closes chat conversation with a given id as a provider with the given provider_id.

Complete task

Complete a task in Healthie.

This action can be previewed in Studio before you publish.

Create 1:1 appointment

Create a 1:1 appointment in Healthie.

This action can be previewed in Studio before you publish.

Returns:

Create charting note

Create a charting note in Healthie.

This action can be previewed in Studio before you publish.

Creates a charting note with the provided note_content.

Prerequisites and set-up:

1. The form specified by the form_id exists in Healthie.
2. The form specified by the form_id is a charting form (click "Convert to charting form" in the form options).
3. The form contains at least one question of type textarea (long text answer). The action will write the content of the charting note in the first question of that type it finds in the form.

Create goal

Create a goal for a patient in Healthie

This action can be previewed in Studio before you publish.

Returns:

Create metric entry

Create a metric entry for a patient in Healthie.

This action can be previewed in Studio before you publish.

Create a metric entry for a patient in Healthie. The category of the metric is the literal name of the metric in Healthie. So if you have a metric in Healthie called "Weight", you should use "Weight" as the category.

Create a patient

Create a patient in Healthie.

This action can be previewed in Studio before you publish.

Returns:

Creates a new patient according to the passed fields. After completion the healthiePatientId will be exposed as a data point in the care flow.

Create task

Create a new task in Healthie.

This action can be previewed in Studio before you publish.

Returns:

Delete appointment

Delete an appointment in Healthie.

This action can be previewed in Studio before you publish.

Deletes an appointment with a given id.

Delete goal

Delete a goal for a patient in Healthie

This action can be previewed in Studio before you publish.

Delete task

Delete a task in Healthie.

This action can be previewed in Studio before you publish.

Get appointment

Retrieve the details of an appointment in Healthie.

This action can be previewed in Studio before you publish.

Returns:

Get form answers

Retrieve form answers from form answer group

This action can be previewed in Studio before you publish.

Returns:

This action will retrieve the form answers for a answer group with a given ID. The complete form answers object will be stored as JSON and will be available in Awell Studio as a data point

Example of a form answers response:

[
  {
    "id": "640",
    "label": "Please enter some information about the person who referred you.",
    "answer": ""
  },
  {
    "id": "641",
    "label": "Name",
    "answer": "Chris"
  }
]

Derrived data points can be used to then store the answer of a specific question in a data point. You can use the following JSONPath expression to retrieve the answer for a given question ID: $[?(@.id == '<ID>')].answer

Get metric entry

Get most recent metric entry of a given category from Healthie.

This action can be previewed in Studio before you publish.

Returns:

Retrieve the most recent metric entry from a given category.

Get patient

Retrieve the details of a patient in Healthie.

This action can be previewed in Studio before you publish.

Returns:

Get set password link

Get the set password link for a patient

This action can be previewed in Studio before you publish.

Returns:

Lock form answers

Lock form answers from form answer group to prevent further editing

This action can be previewed in Studio before you publish.

Push form responses to Healthie

Pushes all form response from the current step to a Healthie form

Returns:

Push form response to Healthie

Pushes an Awell form response to a Healthie form

Returns:

Remove tag from a patient

Remove a tag from a patient in Healthie.

This action can be previewed in Studio before you publish.

Removes a tag (identified by an id) from a patient.

Send chat message

Send a chat message to a patient in Healthie.

This action can be previewed in Studio before you publish.

Returns:

Send form completion request

Send a form completion request to a patient in Healthie.

This action can be previewed in Studio before you publish.

Send a form completion request to the patient. You will need the Healthie patient ID and the ID of the form you would like the patient to complete.

Although the Healthie API call allows sending form completion requests to multiple users per API call (see recipient_ids in their docs), we decided that every action only sends one form completion request. This heavily simplifies the logic and better fits our domain model (1-to-1 relationship between patient and pathway). If a user would like to send multiple form completion requests, they you can just add multiple actions.

Update a patient

Update a patient in Healthie.

This action can be previewed in Studio before you publish.

Updates a specific patient (defined by the provided id) according to the passed fields.

Update patient quick note

Update a patient quick note in Healthie.

This action can be previewed in Studio before you publish.

Webhooks

Healthie can send these 23 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.

appliedTagCreated

Payload:

appliedTagDeleted

Payload:

appointmentCreated

Payload:

appointmentDeleted

Payload:

appointmentUpdated

Payload:

formAnswerGroupCreated

Payload:

formAnswerGroupDeleted

Payload:

formAnswerGroupLocked

Payload:

formAnswerGroupSigned

Payload:

goalCreated

Payload:

goalUpdated

Payload:

labOrderCreated

Payload:

labOrderUpdated

Payload:

messageCreated

Payload:

messageDeleted

Payload:

metricEntryCreated

Payload:

metricEntryUpdated

Payload:

patientCreated

Payload:

patientUpdated

Payload:

requestFormCompletionCreated

Payload:

requestFormCompletionUpdated

Payload:

taskCreated

Payload:

taskUpdated

Payload:

Setup and notes

Healthie offers infrastructure for next generation digital health organizations that provide virtual-first care. Healthie’s API-first and fully brandable suite of solutions (Scheduling, EMR, Client Engagement) enables healthcare builders to launch and scale best-in-class experiences for their members. Healthie also offers a built-in marketplace of business and clinical integrations used by our organizations.

To learn more, visit www.gethealthie.com.

Healthie x Awell

With this extension, organizations are able to build clinical workflows in Awell’s low-code platform and easily integrate them into Healthie. By doing so, Healthie’s customers can automate routine clinical tasks, synchronize data between systems and drive seamless coordination between care team and patients.

By combining Healthie’s web and mobile platform with our clinical workflows, clinicians will be able to provide the right care, at the right time for the right patient.

Extension settings

In order to set up this extension, you will need to provide a Healthie API key and Api url. You can obtain an API key via the Healthie portal (Settings > Developer > API keys). You can obtain API url in the DOCUMENTATION in Environments section.

Please note that the extension automatically prefixes the API key with Basic so please provide your raw API key without Basic in front.

Send chat message action

Sends a chat message to a patient in name of the provided provider ID. Will create a new conversation if no active conversation between patient and provider exists or sends a message in an existing conversation if there is an active conversation between the two.

Create location

Creates a location. ID of the created location is stored as locationId data point.

Changelog

January 2024

• Add "Check patient tag" action
• Add "Check scheduled appointments" action

October 2023

• Add "Update patient quick notes" action
• Add "Create metric entry" action.

September 5, 2023

• add Healthie gender to Sex in iso format mapper in getPatient

May 2023

• New webhooks added: appliedTagCreated, appliedTagDeleted, appointmentDeleted, appointmentUpdated, formAnswerGroupCreated, formAnswerGroupDeleted, formAnswerGroupLocked, formAnswerGroupSigned, labOrderCreated, labOrderUpdated, messageCreated, messageDeleted, metricEntryCreated, metricEntryDeleted, metricEntryUpdated, patientUpdated, requestFormCompletionCreated, requestFormCompletionDeleted, requestFormCompletionUpdated, taskCreated, taskDeleted, taskUpdated

April 2023

• Create task action: now also adds support for reminders.

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.