About this integration
AI medical scribe — sessions, consult notes, and clinical documents from patient consultations. Existing AU/NZ partners only; Heidi is closed to new AU/NZ integrations. Use it from the workflow canvas with no custom glue script required.
This integration exposes 0 triggers, 13 search modules and 23 actions as workflow nodes. Authentication uses oauth authentication.
How to connect
The credential form asks for API Key and Admin Email.
Prefer the interactive builder form? Open it on the app page.
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
| Field | Type | Help |
|---|---|---|
API KeyRequired | password | Issued by Heidi to partner integrations. |
Admin EmailRequired | text | The admin identity this connection acts as. Heidi provisions one API User per email. Existing AU/NZ partners only — Heidi is closed to new AU/NZ integrations. |
Use it in workflow automation
Add Add Sessions to Patient Profile as a workflow step.
Triggers, searches and actions
Use the tables below to inspect Heidi's 0 triggers, 13 search modules, and 23 actions.
Searches
Fetch data on demand using 13 search modules that query the app during a run.
- Generate Clinical Codes
- Get Live Session Transcript
- Get Patient Profile
- Get Session
- Get Session Transcript
8more searches
Actions
23 action modules cover the full range of create, update, and delete operations.
- Add Sessions to Patient Profile
- Ask Heidi
- Convert Note to Sectional Format
- Create Account Link
- Create Document
18more actions
Explore the fields available for each Heidi trigger, search, and action.
Searches
Input fields
| Field | Type |
|---|---|
Session IDRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Session ID | text |
Consult note ID | text |
Clinical entities | array |
Created at | date |
Updated at | date |
Feedback | text |
Input fields
| Field | Type |
|---|---|
Session IDRequired | choice |
Recording Status | choice |
Output fields
| Field | Type |
|---|---|
User Uploaded Chunks | array |
Live Chunks | array |
Backup Chunks | array |
Transcript In Use | text |
Transcript | text |
Input fields
| Field | Type |
|---|---|
Patient Profile IDRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
EHR Patient ID | text |
Managed By | text |
First Name | text |
Last Name | text |
Birth Date | date |
Gender | text |
Phone | text |
Email | text |
Demographic String | text |
Additional Context | text |
Input fields
| Field | Type |
|---|---|
Session IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Session ID | text |
Session name | text |
Patient | object |
Name | text |
Gender | text |
Date of birth | date |
Audio | array |
Clinician notes | array |
Consult note | object |
Status | text |
Result | text |
Heading | text |
Brain | text |
Voice style | text |
Generation method | text |
Template ID | text |
AI command ID | text |
AI command text | text |
Feedback | text |
Duration | number |
Created at | date |
Updated at | date |
Language code | text |
Output language code | text |
Documents | array |
EHR appointment ID | text |
EHR provider | text |
EHR patient ID | text |
Input fields
| Field | Type |
|---|---|
Session IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Transcript | text |
Input fields
| Field | Type |
|---|---|
Team IDRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Country | text |
Is subscribed | boolean |
Subscribed plan | text |
Tier | text |
Plan cycle | text |
Organization ID | text |
Organization name | text |
Input fields
| Field | Type |
|---|---|
Organization IDRequired | text |
Page | number |
Page Size | number |
Order By | text |
Descending Order | boolean |
Search | text |
Role IDs | text |
Team IDs | text |
Specialty IDs | text |
Show Pending Invitations Only | boolean |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Team ID | text |
Team name | text |
User role | text |
Name | text |
Email | text |
Specialty | text |
Specialty ID | text |
Country | text |
Invitation accepted | boolean |
Is team owner | boolean |
Invitation expires at | date |
Input fields
| Field | Type |
|---|---|
EHR Patient ID | text |
EHR Provider | text |
Page | number |
Page Size | number |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
EHR Patient ID | text |
Managed By | text |
First Name | text |
Last Name | text |
Birth Date | date |
Gender | text |
Phone | text |
Email | text |
Demographic String | text |
Remember Consent | boolean |
Additional Context | text |
Session Count | number |
Input fields
| Field | Type |
|---|---|
Session IDRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
User ID | text |
Session ID | text |
Name | text |
Date | date |
Type | text |
Content | text |
Status | text |
Additional context | text |
Unstructured | boolean |
Input fields
| Field | Type |
|---|---|
Session IDRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Session ID | text |
Index | number |
Name | text |
Template ID | text |
Content | text |
Generation type | text |
Brain | text |
Input fields
| Field | Type |
|---|---|
Page Size | number |
Limit | number |
Output fields
| Field | Type |
|---|---|
Session ID | text |
Session name | text |
Patient | object |
Name | text |
Gender | text |
Date of birth | date |
Audio | array |
Clinician notes | array |
Consult note | object |
Status | text |
Result | text |
Heading | text |
Brain | text |
Voice style | text |
Generation method | text |
Template ID | text |
AI command ID | text |
AI command text | text |
Feedback | text |
Duration | number |
Created at | date |
Updated at | date |
Language code | text |
Output language code | text |
Documents | array |
EHR appointment ID | text |
EHR provider | text |
EHR patient ID | text |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Team ID | text |
Team name | text |
User role | text |
Free trial end date | date |
Joined at | date |
Member count | number |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Structure template | text |
Template category | text |
Template HTML | text |
Author name | text |
Actions
Input fields
| Field | Type |
|---|---|
Patient Profile IDRequired | choice |
Session IDsRequired | choice |
Output fields
| Field | Type |
|---|---|
Sessions | array |
Input fields
| Field | Type |
|---|---|
Session IDRequired | choice |
InstructionRequired | text |
ContentRequired | text |
Content Type | choice |
Output fields
| Field | Type |
|---|---|
Answer | text |
Input fields
| Field | Type |
|---|---|
Session IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Sectional Note (by section heading) | text |
Input fields
| Field | Type |
|---|---|
Kinde User IDRequired | text |
Input fields
| Field | Type |
|---|---|
Session IDRequired | choice |
TemplateRequired | choice |
Voice Style | choice |
BrainRequired | choice |
Content Type | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Session ID | text |
Name | text |
Template ID | text |
Brain | text |
Voice style | text |
Content type | text |
Content | text |
Input fields
| Field | Type |
|---|---|
First Name | text |
Last Name | text |
Birth Date | date |
Gender | choice |
EHR Patient ID | text |
Phone | text |
Email | |
Patient Sex Code | number |
Identifiers | array |
Demographic String | text |
Additional Context | text |
Output fields
| Field | Type |
|---|---|
ID | text |
EHR Patient ID | text |
First Name | text |
Last Name | text |
Birth Date | date |
Gender | text |
Phone | text |
Email | text |
Demographic String | text |
Additional Context | text |
Input fields
| Field | Type |
|---|---|
Patient Profile | choice |
EHR Appointment ID | text |
Output fields
| Field | Type |
|---|---|
Session ID | text |
Input fields
| Field | Type |
|---|---|
Patient Profile IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Patient Profile IDsRequired | choice |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
Patient Profile IDRequired | choice |
Session IDsRequired | choice |
Input fields
| Field | Type |
|---|---|
Session IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
Session IDRequired | choice |
Recording IDRequired | text |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Input fields
| Field | Type |
|---|---|
Session IDRequired | choice |
TemplateRequired | choice |
Voice StyleRequired | choice |
BrainRequired | choice |
Content Type | choice |
Addition | text |
Output fields
| Field | Type |
|---|---|
Consult Note | text |
Input fields
| Field | Type |
|---|---|
Session IDRequired | choice |
Custom Template (JSON)Required | text |
Output fields
| Field | Type |
|---|---|
Result | text |
Input fields
| Field | Type |
|---|---|
Session IDRequired | choice |
Section HeadingRequired | text |
Linked EHR Section IDRequired | text |
Output fields
| Field | Type |
|---|---|
Updated Consult Note | text |
Input fields
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
Headers | array |
Header | object |
Query String | array |
Parameter | object |
Body | text |
Output fields
| Field | Type |
|---|---|
Body | text |
Headers | object |
Status code | number |
No fields documented.
Input fields
| Field | Type |
|---|---|
Session IDRequired | choice |
Recording IDRequired | text |
Audio ChunkRequired | text |
Chunk IndexRequired | number |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Input fields
| Field | Type |
|---|---|
Session IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Recording ID | text |
Input fields
| Field | Type |
|---|---|
Patient Profile IDRequired | choice |
First Name | text |
Last Name | text |
Birth Date | date |
Gender | choice |
Phone | text |
Email | |
Identifiers | array |
Demographic String | text |
Remember Consent | boolean |
Additional Context | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Source | text |
EHR Patient ID | text |
First Name | text |
Last Name | text |
Birth Date | date |
Gender | text |
Phone | text |
Email | text |
Demographic String | text |
Additional Context | text |
Input fields
| Field | Type |
|---|---|
Session IDRequired | choice |
Duration | number |
Language Code | text |
Output Language Code | text |
Transcribe Mode | text |
Patient | object |
Name | text |
Gender | choice |
Date of Birth | date |
Demographic Details | text |
Clinician Notes | array |
Note | text |
EHR Patient ID | text |
EHR Appointment ID | text |
Generate Output Without Recording | boolean |
Recording Status | text |
Session Status | text |
Consent Given | boolean |
Created Time (Local) | text |
Linked Sessions for Context | choice |
Output fields
| Field | Type |
|---|---|
Session ID | text |
Session name | text |
Patient | object |
Name | text |
Gender | text |
Date of birth | date |
Audio | array |
Clinician notes | array |
Consult note | object |
Status | text |
Result | text |
Heading | text |
Brain | text |
Voice style | text |
Generation method | text |
Template ID | text |
AI command ID | text |
AI command text | text |
Feedback | text |
Duration | number |
Created at | date |
Updated at | date |
Language code | text |
Output language code | text |
Documents | array |
EHR appointment ID | text |
EHR provider | text |
EHR patient ID | text |
Input fields
| Field | Type |
|---|---|
Session IDRequired | choice |
FileRequired | text |
File name | text |
Name | text |
Date | date |
Additional Context | text |
Unstructured Document | boolean |
Output fields
| Field | Type |
|---|---|
ID | text |
User ID | text |
Session ID | text |
Name | text |
Date | date |
Type | text |
Content | text |
Status | text |
Additional context | text |
Unstructured | boolean |
Input fields
| Field | Type |
|---|---|
Session IDRequired | choice |
Audio FileRequired | text |
Recording Start Time | date |
Recording End Time | date |
Output fields
| Field | Type |
|---|---|
Uploaded Audio | object |
ID | text |
Index | number |
Status | text |
Created At | text |
Access URL | text |
Expiry | text |