Documo
Documo extension for Awell
Documo extension for Awell
Category: Demo. Adds 2 actions and 3 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 |
|---|---|---|
| Api Key | No | API Key Stored as a secret. |
Actions
Documo adds these 2 actions to a care flow. Add one to a step, then fill in its inputs.
Get Document Field Values
Retrieve field values for a specific document in a Documo workspace.
This action can be previewed in Studio before you publish.
| Input | Type | Required | Description |
|---|---|---|---|
| Workspace ID | string | Yes | Unique identifier (UUID) of the workspace the document belongs to. |
| Document ID | string | Yes | Unique identifier (UUID) of the document to retrieve field values for. |
Returns:
| Data point | Type |
|---|---|
fieldValues | json |
Get Document Info
Retrieve metadata about a specific document in a Documo workspace.
This action can be previewed in Studio before you publish.
| Input | Type | Required | Description |
|---|---|---|---|
| Workspace ID | string | Yes | Unique identifier (UUID) of the workspace the document belongs to. |
| Document ID | string | Yes | Unique identifier (UUID) of the document to retrieve. |
Returns:
| Data point | Type |
|---|---|
addedAt | date |
createdAt | date |
documentResponse | json |
from | string |
id | string |
isUploading | boolean |
name | string |
pagesCount | number |
sourceId | string |
sourceType | string |
statusName | string |
to | string |
typeName | string |
workspaceId | string |
workspaceName | string |
Webhooks
Documo can send these 3 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.
documentFieldValueAssigned
Payload:
| Data point | Type |
|---|---|
patientFirstName | string |
patientIdentifiers | json |
patientLastName | string |
patientMobilePhone | string |
patientZipCode | string |
receivingProviderFullName | string |
webhookData | json |
documentTypeUpdated
Payload:
| Data point | Type |
|---|---|
documentId | string |
typeId | string |
typeName | string |
userEmail | string |
webhookData | json |
workspaceId | string |
ocrDocumentCompleted
Payload:
| Data point | Type |
|---|---|
extractedInfo | json |
webhookData | json |
Setup and notes
Documo extension for Awell that integrates with Documo's intelligent document processing platform.
Webhooks
OCR Document Completed
Triggered when OCR processing completes on a document. Uses an LLM to extract patient information from the OCR text.
**Data Points:
webhookData- Full webhook payload (JSON)extractedInfo- Extracted patient information (JSON)
Document Field Value Assigned
Triggered when a field value is assigned to a document. Extracts patient and provider information from the document field assignments.
Data Points:
| Data Point | Type | Description |
|---|---|---|
webhookData | json | Full webhook payload |
patientFirstName | string | Patient's first name |
patientLastName | string | Patient's last name |
patientZipCode | string | Patient's zip code |
patientIdentifiers | json | Array of patient identifiers (e.g., MRN, insurance ID) |
patientMobilePhone | string | Patient's phone number |
receivingProviderFullName | string | Name of the receiving provider |
Field Mappings:
The webhook maps Documo field names to data points:
| Documo Field Name | Data Point |
|---|---|
| Patient First Name | patientFirstName |
| Patient Last Name | patientLastName |
| Patient Zip Code | patientZipCode |
| Patient Identifiers | patientIdentifiers |
| Patient Phone Number | patientMobilePhone |
| Receiving Provider Full Name | receivingProviderFullName |
Document Type Updated
Triggered when a document type is updated in Documo.
Data Points:
| Data Point | Type | Description |
|---|---|---|
webhookData | json | Full webhook payload |
documentId | string | Document ID |
workspaceId | string | Workspace ID |
typeName | string | Document type name (e.g., "Other") |
typeId | string | Document type ID |
userEmail | string | Email of the user who updated the type |
Settings
- Api Key**: Documo API Key
Development
Running Tests
To run tests for a specific file:
yarn run test -- <file name>Or run all Documo tests:
yarn run test -- --testPathPattern='extensions/documo' --runInBandChangelog
[Unreleased]
- Initial release
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.
Dock Health
HIPAA-compliant task management and workflow automation for healthcare. Assign, track, automate, and complete administrative to-do lists.
DocuSign
DocuSign makes your business faster, simpler and more cost-efficient with electronic agreements. Agree with confidence, with intuitive signing experiences across virtually any device.