Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Canvas Medical

Connect to a Canvas Medical EMR instance to search patients and read their recorded vitals, lab results, and other clinical observations over the FHIR R4 API.

Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

Connector
Authentication

Canvas Medical

Credentials

Canvas Medical

Connect to a Canvas Medical EMR instance to search patients and read their recorded vitals, lab results, and other observations over the FHIR R4 API.

Set up in Canvas Medical

  1. Prepare the Canvas Medical account or service that the workflow will access. Grant access to the required resources and operations.

  2. Instance: The Canvas subdomain, read from your Canvas URL: for https://modernfamilypractice.canvasmedical.com it is 'modernfamilypractice'. Includes any '-dev' or '-staging' suffix if your Canvas URL has one, e.g. 'modernfamilypractice-dev'.

  3. Client ID: Client ID of a Canvas OAuth application, found at https://{instance}.canvasmedical.com/auth/applications/. The application must be granted the Patient and Observation read scopes.

Set up in StackAI

  1. Open Settings → Connections, add a connection, and select Canvas Medical.

  2. Enter the credentials and connection details in the fields below.

  3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

Connection fields

StackAI field
Required
What to enter

Instance

Yes

The Canvas subdomain, read from your Canvas URL: for https://modernfamilypractice.canvasmedical.com it is 'modernfamilypractice'. Includes any '-dev' or '-staging' suffix if your Canvas URL has one, e.g. 'modernfamilypractice-dev'.

Client ID

Yes

Client ID of a Canvas OAuth application, found at https://{instance}.canvasmedical.com/auth/applications/. The application must be granted the Patient and Observation read scopes. Provider instructions.

Client Secret

Yes

Client Secret of the same Canvas OAuth application.

Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

Use an action

  1. Add the required Canvas Medical action to the workflow.

  2. Select a connection when the action requests one.

  3. Complete the required fields. Use the reference picker when a value comes from another workflow step.

  4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

Actions

Search Patients

Find patients in Canvas Medical by name, date of birth, gender, medical record number, email, or phone.

Required permissions: system/Patient.read.

Inputs

Field
Type
Required
Description

Name

string

No

Any part of the patient's first or last name.

Patient ID

string

No

Fetch one specific patient by their Canvas patient ID.

Date of birth

date

No

The patient's exact date of birth.

Gender

select (string)

No

Filter by the gender recorded on the patient's chart. Available values: Male, Female, Other, Unknown.

Medical record number

string

No

The patient's medical record number (MRN) or an external system identifier.

Email

string

No

The patient's email address.

Phone

string

No

The patient's 10-digit phone number.

Max patients

integer

No

Maximum number of patients to return. Default: 25.

Show advanced filters

boolean

No

Show last name, first name, active status, sort, and resume offset filters. Default: false.

Last name

string

No

The patient's last name only.

First name

string

No

The patient's first name only.

Active patients only

boolean

No

Return only active patients, or only inactive ones. Leave unset to return both.

Sort by

select (string)

No

Order the results. A leading minus sign sorts descending. Available values: Last name (A-Z), Last name (Z-A), First name (A-Z), First name (Z-A), Date of birth (oldest first), Date of birth (youngest first), Patient ID (A-Z), Patient ID (Z-A).

Start at

integer

No

Continue a previous search from where it stopped.

Outputs

Field
Type
Description

Patients

object_array

The matching patients.

Total matches

integer

How many patients match the filters in total, as reported by Canvas.

Next offset

integer

Where to resume if more patients matched than were returned.

List Observations

Read a patient's vitals, lab results, and other recorded measurements from Canvas Medical, optionally narrowed by type and date range.

Required permissions: system/Observation.read.

Inputs

Field
Type
Required
Description

Patient

string

Yes

The patient whose observations you want to read.

Type of observation

select (string)

No

Narrow to one kind of observation, such as vital signs or lab results. Available values: Vital signs, Laboratory, Social history, Survey, Exam, Imaging, Procedure, Therapy, Activity, SDOH, Functional status, Cognitive status, Disability status.

From date

date

No

Only include observations recorded on or after this date.

To date

date

No

Only include observations recorded on or before this date.

Max observations

integer

No

Maximum number of observations to return. Minimum: 1.

Show advanced filters

boolean

No

Show the LOINC code filter and the resume offset. Default: false.

LOINC code

string

No

Only include observations of one specific measurement, identified by its LOINC code.

Start at

integer

No

Continue a previous read from where it stopped. Minimum: 0.

Outputs

Field
Type
Description

Observations

object_array

The patient's observations.

Total matches

integer

How many observations match the filters in total, as reported by Canvas.

Next offset

integer

Where to resume if more observations matched than were returned.

Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.

Last updated

Was this helpful?