WestFax
Send faxes securely and in compliance with HIPAA regulations using WestFax.
Send faxes securely and in compliance with HIPAA regulations using WestFax.
Category: Communication. Adds 3 actions and 1 webhook 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 |
|---|---|---|
| URL to facesheet (PDF) | No | An optional URL for a face sheet document (in PDF format) which will be attached at the beginning of your actual message or document for faxes. This face sheet will only be included if it has been enabled at the action level. Stored as a secret. |
| Password | Yes | Your WestFax password Stored as a secret. |
| Product ID | No | Your WestFax product ID. Required for some functionality in the extension. |
| Username | Yes | Your WestFax username |
Actions
WestFax adds these 3 actions to a care flow. Add one to a step, then fill in its inputs.
Get fax document
Get fax document with WestFax.
This action can be previewed in Studio before you publish.
| Input | Type | Required | Description |
|---|---|---|---|
| Fax Id | string | Yes | Sometimes also referred to as the job ID |
Returns:
| Data point | Type |
|---|---|
date | date |
direction | string |
format | string |
pageCount | number |
status | string |
Retrieve a fax document using a fax ID, sometimes also referred to as a job ID.
Get fax document with OCR
Get fax document with WestFax and extract structured data with OCR
| Input | Type | Required | Description |
|---|---|---|---|
| Fax Id | string | Yes | Sometimes also referred to as the job ID |
| OCR Provider | string | Yes | The provider or service used for OCR One of: Awell (Landing.ai). |
| OCR Provider API Key | string | Yes | We advise using a obfuscated constant |
| Fields schema | json | No | Defines the structure of the fields to extract from the document. Providing a schema is optional but strongly recommended, as it significantly improves the accuracy of the extracted data. |
Returns:
| Data point | Type |
|---|---|
chunks | json |
date | date |
direction | string |
extractedDataBasedOnSchema | json |
extractedMetadata | json |
format | string |
markdown | string |
pageCount | number |
status | string |
Send fax
Send fax with WestFax.
This action can be previewed in Studio before you publish.
| Input | Type | Required | Description |
|---|---|---|---|
| Product Id | string | Yes | E.g. 12345678-1234-1234-1234-123456789abc |
| Feedback Email | string | No | Send a report to this address when the fax is sent |
| Number | string | Yes | Destination fax number |
| Add face sheet | boolean | No | Add cover sheet that precedes the actual message or document |
| Fax content | html | No | Content of the fax |
Returns:
| Data point | Type |
|---|---|
faxId | string |
Webhooks
WestFax can send this event 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.
faxReceived
Payload:
| Data point | Type |
|---|---|
dir | string |
jobId | string |
prod | string |
Setup and notes
WestFax is a cloud-based faxing service that offers a variety of features, including:
- Secure faxing: WestFax uses end-to-end encryption to protect your documents from unauthorized access.
- HIPAA compliance: WestFax is HIPAA compliant, so you can be sure that your medical records are safe.
- Integration with other applications: WestFax can be integrated with your existing email, CRM, and other applications.
- Mobile app: You can send and receive faxes from your mobile device with the WestFax mobile app.
- Paperless faxing: WestFax can store your faxes in the cloud, so you can access them from anywhere.
WestFax x Awell
This extension allows you to let a stakeholder (eg: a patient) send a fax as part of a care flow.
Extension settings
In order to set up this extension, you will need to provide a WestFax Username and Password. You will need as well to provide the ProductId when setting up the action - check how here.
Webhooks
Fax received
Trigger a care flow when a fax is received. Currently only works together with https://github.com/awell-health/westfax-webhook-handler
Changelog
February 2024
- Initial action to send an fax to an email
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.