Knowledge Base
Designer
How To
- eSignature Configuration
- Custom Field Types
- Create Advanced Automations
- Create Security Policies
- Visual Components & Dependencies
- Automated Notifications
- Automations That Trigger Outbound Communications
- CDT Configuration
- Charts & Graphs: How to Configure
- Create Formulaic Custom Data Type Fields
- Create Patient Facing Assessment (PFA) Folders
- Configure Help Section
- Configure Phone Names
- Customize Action Bar
- Defining Regions and Territories
- Document Types: How To Configure
- Filtering With Message Template Variables
- How to Add Assessments to a Template
- Filtering With Message Template Variables
- How To Associate Assessments with Programs
- How to Create Navigation Layouts
- How To Create an Assessment or Form Template
- Patient Data View
- Zoom: How to use telehealth in Designer
- Opt Out Patients from SMS Communications
- Assessments - How to Add Conditionality
- Create User Notifications
- Create Automated Appointment Reminders
- Turning on Notifications for Communications
- Create PDFs from Forms & Assessments
- Configuring Security Policies
- How to create and configure roles
- Designer: Enable Patient Delete
- Designer: How to Configure Scored Assessments
- Designer: How to Create Automations
- Encounters: Dependencies
- DocuSign: Implementation Checklist
- Export Designer Configuration
- Task Creation
- Creating a Message Template
Overview
Features Overview
- Visual Components
- Security Policy Detail
- Task Management
- API Exports: Usage
- Designer: User Access
- DocuSign: Feature Overview in Designer
- Enable Patient Delete
- Brand Terminology: Flexibility
- Designer Overview
- Forms: Conditional Logic
- Programs and Phases
- Webhooks
- Notifications and Alerts
- Data Views
- Custom Data Types (CDT)
- Change Summary and Version History
- eRx: Overview
API Exports: Usage
Welkin supports a number of APIs to retrieve export files with data across all patients. These include the following:
CDT Records | Emails |
Care Plans | Tasks |
Voice Calls | Assessments |
Patients | PFAs (Assessments sent to Patients) |
Programs | Encounters |
SMS History | Encounter Comments |
Calendar Events | Encounter Dispositions |
Chat Messages | WhatsApp Messages |
Patient Contacts |
Like all Welkin APIs, access begins with an API being created in Welkin, and that API being granted permissions through Designer. In this case, the permissions need to be granted for the API to access one or more types of exports.
The API will use the key provided during creation to Authenticate using the instructions here.
The token is valid for one hour and should be cached if the API will be accessing more than once per hour, to prevent over-stressing the system. Authorization will be blocked for five minutes if an API requests a token more than 100 times per 5 minutes.
To request any of the export categories, use the API and token per the instructions here.
In general, the format is in form: {{url}}/{{tenantName}}/{{instanceName}}/export/{{resourceName}}?start={value}&pageSize={value}
The export documents are returned in JSON format.
Any additional questions?
Please refer to the API documentation for details, and contact your Welkin Health Customer Service team with any further questions.