Awell Docs

Medplum is the open source healthcare developer platform that helps you build, test, and deliver any healthcare product or service.

Category: EHR Integrations. Adds 13 actions and 2 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.

Setting	Required	Notes
Base URL	No	Optional custom base URL for Medplum server (e.g., https://api.medplum.com/). Leave empty to use default.
Client ID	Yes	Used to authenticate with Medplum Stored as a secret.
Client secret	Yes	Used to authenticate with Medplum Stored as a secret.

Actions

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

Add side effect

Add side effect to Medication Request

Input	Type	Required	Description
The ID of the medication request you want to link the side effec to	`string`	Yes	—
Side effect	`string`	Yes	—

Create calculation observation

Create a calculation observation in Medplum

Input	Type	Required	Description
Patient ID	`string`	Yes	The identifier of the patient in Medplum to assign the response to
Questionnaire response ID	`string`	No	The identifier of the questionnaire response you want to link the calculation result to

Returns:

Data point	Type
`observationId`	`string`

Create patient

Create a patient in Medplum

Input	Type	Required	Description
First name	`string`	No	—
Last name	`string`	No	—
Mobile phone	`string`	No	—
Email	`string`	No	—
Birth date	`date`	No	—
Gender	`string`	No	Valid values are "male", "female", "other", "unknown"
Address	`string`	No	—
City	`string`	No	—
State	`string`	No	—
Country	`string`	No	—
Postal code	`string`	No	—

Returns:

Data point	Type
`patientId`	`string`

Find or create any FHIR resource in Medplum. Optionally search for existing resources by type and identifier before creating. Supports single resources or FHIR Bundles (transaction/batch) for creating multiple resources atomically.

Input	Type	Required	Description
Resource JSON	`json`	Yes	FHIR resource or Bundle as JSON. Supports single resources (e.g., Patient, Observation) or FHIR Bundles (transaction/batch) for creating multiple resources.
Search Resource Type	`string`	No	Optional: FHIR resource type to search for (e.g., Patient, Observation). If provided along with Search Identifier, the action will search for existing resources before creating a new one.
Search Identifier	`string`	No	Optional: Identifier value to search for (e.g., MRN, SSN). If provided along with Search Resource Type, the action will search for existing resources with this identifier before creating a new one.

Returns:

Data point	Type
`bundleId`	`string`
`bundleType`	`string`
`resourceId`	`string`
`resourceIds`	`string`
`resourcesCreated`	`json`
`resourceType`	`string`
`wasResourceFound`	`boolean`

Create service request

Create a service request in Medplum

Input	Type	Required	Description
Patient ID	`string`	Yes	ID of the patient in Medplum
Status	`string`	Yes	The status of the order One of: draft, active, on-hold, revoked, completed, entered-in-error, unknown.
Mobile phone	`string`	Yes	Whether the request is a proposal, plan, an original order or a reflex order. One of: proposal, plan, directive, order, original-order, reflex-order, filler-order, instance-order, option.
Priority	`string`	No	The priority of the order One of: routine, urgent, asap, stat.

Returns:

Data point	Type
`serviceRequestId`	`string`

Create task

Create a Task in Medplum

Input	Type	Required	Description
Patient ID	`string`	Yes	ID of the patient in Medplum the task is for
Task name	`string`	Yes	Briefly describes what the task involves
Description name	`text`	No	Human-readable explanation of task
Status	`string`	Yes	The status of the task One of: draft, requested, received, accepted, rejected, ready, cancelled, in-progress, on-hold, failed, completed, entered-in-error.
Intent	`string`	Yes	Indicates the "level" of actionability associated with the Task. One of: unknown, proposal, plan, order, original-order, reflex-order, filler-order, instance-order, option.
Priority	`string`	No	The priority of the task One of: routine, urgent, asap, stat.
Due date	`date`	No	—
Performer type	`string`	No	Indicate which role can/should perform this task

Returns:

Data point	Type
`taskId`	`string`

Execute Bot

Execute a Medplum Bot

Input	Type	Required	Description
Bot ID	`string`	Yes	You can find the id of your Bot by clicking on the Details tab of the Bot resource in the Medplum app
Body	`json`	No	Data in JSON format you would like to pass to the Bot

Returns:

Data point	Type
`data`	`string`
`jsonData`	`json`