Create a Patient Get a specific Patient By ID, externalID, externalGUID, MRN Find a Patient Update a specific Patient By ID Get all Patients for Tenant Bulk update for Patient Delete Patient by ID

Get One CDT Get All CDT

Custom Data Types (CDT)

Get all CDT Records Get CDT Record By ID Create CDT Record Delete CDT Record by ID Update CDT Record by ID Update CDT Records with bulk

Profile Formation

Get All PDT Get All PDT by name

Profile Records

Create PDT Get PDT by ID Get All PDT by name Update PDT Delete PDT Get Patients list by PDT

Get All Contacts Get Contact by ID Create Contact Update Contact

Encounters-Main

Get all Encounter Records by user ID Get all Encounter Records by patient ID Get all Encounter Records by client_id from JWT Token (work for users and api_clients tokens)Get all Encounter Records with related data by client_id from JWT Token (work for users and api_clients tokens)Get all Encounter Records with related data by patient ID Get all Encounter Records with related data by user ID Get Encounter Record by a patient ID and Encounter ID Get Encounter Record with all related data by a patient ID and encounter ID Create an Encounter for Patient Update Encounter Record by Encounter ID Delete Encounter Record by encounter ID

Encounters-Encounter Comment

Get all Encounter Comments by encounter ID Get Encounter Comment by encounter ID and comment ID Create a Comment for Encounter Update Сomment for Encounter by comment ID Delete Comment for Encounter by comment ID

Encounters-Encounter Assessment

Get all Assessment links by encounter ID Get Assessment link by encounter ID and assessment link ID Create an Assessment link for encounter Update Assessment link for encounter by assessment link ID Delete Assessment link for encounter by assessment link ID

Encounters-Encounter Disposition

Get Disposition for encounter Update Disposition for encounter

Encounters-Encounter Disposition formation

Get Disposition Formation

Encounters-Encounter Template

Get all Encounter Templates Get Encounter Template by name Create a Template for encounter Update Encounter Template by encounter template name Delete Encounter Template by template name

User-Users - Regions and Territories

Create/Update User Territories

Create User Record Read Users Records Read User Record Update User Record (Partial update)Update policies

Assessment formation

Get all Assessments Get one Assessment Get all CDTs related to Assessment

Assessment record

Create an Assessment Record Update an Assessment Record Update answers of Assessment Record Get all Assessment Records Get an Assessment Record Delete an Assessment Record

Get all SMS Get SMS by ID

Email-Email Drafts

Create email draft Update attachments Get email draft by id Get all email drafts Update email draft Delete email draft Download attachment

Get all Emails Get Email by ID

Chat/History-Chat Search

Search: get page by token

Chat: Send message from patient to care team Chat: Get messages by token Get File by fileId

Care plan-Goals-Tasks

Add Goal task Goal tasks list

Care plan-Goals-Comments

Add Goal comment Goal comments list

Care plan-Goals

Create Goal Goal details Goals list Update Goal

Care plan-Overview

Create Patient Overview Update Patient Overview

Get Care Plan by patientId

Calendar API-Calendar Working Hours

Create Work Hours Read Work Hours Update Work Hours

Calendar API-Calendar Events

Create Event Get Event by ID Copy Find Events Update Calendar Event by ID Patch update Event by ID Get Summary for the User Delete Calendar Event by ID Update Event invitation response by ID

Calendar API-Schedule

Get Schedules Get Available Schedules

Get all Programs Get Program by name

Task management-Tasks

Create new Task Search Tasks Get Task by ID Partial update Task Bulk update of Tasks status Add watcher to Task Remove watcher from Task Add comment to Task Remove comment from Task

Patient program

Get Patient's Program by name (for active only)Get Patient's Program by ID (active and finished)Update Patient Program status and assign Program Change Phase for Patient Program Unassign Patient from Program

Dictionaries-Dictionary Formation

Get all Dictionary Formations Get Dictionary Formation by name

Dictionaries-Dictionary Records

Get Dictionary Record by name and ID Get all Dictionary Records by name Add value to Dictionary Remove all values from Dictionary and set new Update Dictionary Record by name and ID Delete Dictionary Record by name and ID

Data Audit Find All Find Webhook Audit Event

Export CDT Records Export PDT Records Export Care Plans Export Voice Calls Export Patients Export Chat Messages Export Programs Export SMS Export WhatsApp Messages Export Calendar Events Export Email Export Tasks Export Assessment Export PFA Export Encounter Export Encounter Comments Export Encounter Disposition Export Contacts Export Document Summary

Document Types Formation

Get all Documents Types Get Documents Type by Name

Documents-Document Summary Records

Get all Documents Summary Records Get Document Summary Record By ID Create Document Summary Record Update Document Summary Record Delete Document Summary Record Upload Document Summary Record File Download Document Summary Record File

Documents-Document Records

Get Documents Record Create Document Record Update Document Record Delete Document Record

Unrecognized Calls

Get all unrecognzied calls Get unrecognized voice call by id Get recordings

Unrecognized Emails

Get all unrecognized emails Get unrecognized email by id Get attachments for Emails

Unrecognized SMS

Get all unrecognized SMS Get unrecognized SMS by id Get attachments for SMS

Payment and Subscription

Add payment method Create subscription

Create a Patient Get a specific Patient By ID, externalID, externalGUID, MRN Find a Patient Update a specific Patient By ID Get all Patients for Tenant Bulk update for Patient Delete Patient by ID

Get One CDT Get All CDT

Custom Data Types (CDT)

Get all CDT Records Get CDT Record By ID Create CDT Record Delete CDT Record by ID Update CDT Record by ID Update CDT Records with bulk

Profile Formation

Get All PDT Get All PDT by name

Profile Records

Create PDT Get PDT by ID Get All PDT by name Update PDT Delete PDT Get Patients list by PDT

Get All Contacts Get Contact by ID Create Contact Update Contact

Encounters-Main

Get all Encounter Records by user ID Get all Encounter Records by patient ID Get all Encounter Records by client_id from JWT Token (work for users and api_clients tokens)Get all Encounter Records with related data by client_id from JWT Token (work for users and api_clients tokens)Get all Encounter Records with related data by patient ID Get all Encounter Records with related data by user ID Get Encounter Record by a patient ID and Encounter ID Get Encounter Record with all related data by a patient ID and encounter ID Create an Encounter for Patient Update Encounter Record by Encounter ID Delete Encounter Record by encounter ID

Encounters-Encounter Comment

Get all Encounter Comments by encounter ID Get Encounter Comment by encounter ID and comment ID Create a Comment for Encounter Update Сomment for Encounter by comment ID Delete Comment for Encounter by comment ID

Encounters-Encounter Assessment

Get all Assessment links by encounter ID Get Assessment link by encounter ID and assessment link ID Create an Assessment link for encounter Update Assessment link for encounter by assessment link ID Delete Assessment link for encounter by assessment link ID

Encounters-Encounter Disposition

Get Disposition for encounter Update Disposition for encounter

Encounters-Encounter Disposition formation

Get Disposition Formation

Encounters-Encounter Template

Get all Encounter Templates Get Encounter Template by name Create a Template for encounter Update Encounter Template by encounter template name Delete Encounter Template by template name

User-Users - Regions and Territories

Create/Update User Territories

Create User Record Read Users Records Read User Record Update User Record (Partial update)Update policies

Assessment formation

Get all Assessments Get one Assessment Get all CDTs related to Assessment

Assessment record

Create an Assessment Record Update an Assessment Record Update answers of Assessment Record Get all Assessment Records Get an Assessment Record Delete an Assessment Record

Get all SMS Get SMS by ID

Email-Email Drafts

Create email draft Update attachments Get email draft by id Get all email drafts Update email draft Delete email draft Download attachment

Get all Emails Get Email by ID

Chat/History-Chat Search

Search: get page by token

Chat: Send message from patient to care team Chat: Get messages by token Get File by fileId

Care plan-Goals-Tasks

Add Goal task Goal tasks list

Care plan-Goals-Comments

Add Goal comment Goal comments list

Care plan-Goals

Create Goal Goal details Goals list Update Goal

Care plan-Overview

Create Patient Overview Update Patient Overview

Get Care Plan by patientId

Calendar API-Calendar Working Hours

Create Work Hours Read Work Hours Update Work Hours

Calendar API-Calendar Events

Create Event Get Event by ID Copy Find Events Update Calendar Event by ID Patch update Event by ID Get Summary for the User Delete Calendar Event by ID Update Event invitation response by ID

Calendar API-Schedule

Get Schedules Get Available Schedules

Get all Programs Get Program by name

Task management-Tasks

Create new Task Search Tasks Get Task by ID Partial update Task Bulk update of Tasks status Add watcher to Task Remove watcher from Task Add comment to Task Remove comment from Task

Patient program

Get Patient's Program by name (for active only)Get Patient's Program by ID (active and finished)Update Patient Program status and assign Program Change Phase for Patient Program Unassign Patient from Program

Dictionaries-Dictionary Formation

Get all Dictionary Formations Get Dictionary Formation by name

Dictionaries-Dictionary Records

Get Dictionary Record by name and ID Get all Dictionary Records by name Add value to Dictionary Remove all values from Dictionary and set new Update Dictionary Record by name and ID Delete Dictionary Record by name and ID

Data Audit Find All Find Webhook Audit Event

Export CDT Records Export PDT Records Export Care Plans Export Voice Calls Export Patients Export Chat Messages Export Programs Export SMS Export WhatsApp Messages Export Calendar Events Export Email Export Tasks Export Assessment Export PFA Export Encounter Export Encounter Comments Export Encounter Disposition Export Contacts Export Document Summary

Document Types Formation

Get all Documents Types Get Documents Type by Name

Documents-Document Summary Records

Get all Documents Summary Records Get Document Summary Record By ID Create Document Summary Record Update Document Summary Record Delete Document Summary Record Upload Document Summary Record File Download Document Summary Record File

Documents-Document Records

Get Documents Record Create Document Record Update Document Record Delete Document Record

Unrecognized Calls

Get all unrecognzied calls Get unrecognized voice call by id Get recordings

Unrecognized Emails

Get all unrecognized emails Get unrecognized email by id Get attachments for Emails

Unrecognized SMS

Get all unrecognized SMS Get unrecognized SMS by id Get attachments for SMS

Payment and Subscription

Add payment method Create subscription

Home Welkin ExportExport Document Summary

Export Document Summary

GET {{url}}/{{tenantName}}/{{instanceName}}/export/DOCUMENT_SUMMARY

Request Params

Key	Datatype	Required	Description
`start`	string

Export Contacts

Document Types Formation