Knowledge Base
Designer
How To
- How To Create an Assessment or Form Template
- How to Add Assessments to a Template
- Automated Notifications
- Opt Out Patients from SMS Communications
- How to Add Conditionality To Assessments
- Create User Notifications
- Create Automated Appointment Reminders
- Turning on Notifications for Communications
- Create PDFs from Forms & Assessments
- Configure Security Policies & Roles
- How to create and configure roles
- Designer: Enable Patient Delete
- Designer: How to Configure Scored Assessments
- Designer: How to Create Automations
- Encounters and their Dependencies
- DocuSign: Implementation Checklist
- Export Designer Configuration
- Create Tasks
- Communication center: how to create message templates
Overview
Features Overview
- 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
- Automations
- Presentation: Customized Layouts and Action Bar
- Data Views
- Dictionaries
- Custom Data Types (CDT)
- Change Summary and Version History
- eRx: DrFirst Overview
API Exports: Usage
API Exports
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.