Qodex.ai

Welkin

Number of APIs: 180

Welcome to Welkin Health’s Developer Documentation!

This API is your guide to building applications with Welkin Health, a platform for patient relationship management. Before diving into the documentation, let's briefly revisit key concepts that will be referenced frequently in this guide.

  1. Organization (Tenant): In the Welkin context, every team is assigned a unique 'Organization', or Tenant, acting as a dedicated space to house the team's Users, apps and Environments. Essentially, your Organization is like your team's exclusive sector within Welkin's system.
  2. Environment (Instance): An Environment is an isolated database housed within an Organization. Typically, an Organization will maintain 2-3 Environments that represent different stages - development, testing, and live Environments. These stages will be used as you develop and refine your care program on Welkin.
  3. API Client: Welkin provides an auto-generated pair of keys and secrets known as an API Client. This client enables you to access the array of APIs that Welkin offers. For more information, refer to the article: User provisioning: API.
  4. Security Policies & Roles: These are sets of rules and definitions that determine what your users can see, access, and modify within the system.
  5. Designer: The Designer is where you will design and structure the experiences for your care team and patients. It's a versatile program editor, allowing you to configure the elements of your care program, including permissions and roles. For an in-depth guide, check out the article: Designer Overview.
  6. Admin: The Admin is where you manage the system settings and permissions, which includes adding, deleting, or modifying user accounts, auditing data, resetting passwords, and configuring Single Sign-On (SSO) settings.
  7. Care: Care is where your team will interact with the system to track patient interactions, document information, and communicate externally with patients. Essentially, it's the operational hub where your care team will manage patient care. For more details, visit the article: Care Overview.

For better demonstration of the API, we will use the following setup:

  • Organization (Tenant): gh
  • Environment (Instance): sb-demo

  1. Export - Export Programs GET {{url}}/{{tenantName}}/{{instanceName}}/export/PATIENT_PROGRAM

  2. Documents-Document Records - Create Document Record POST {{url}}/{{tenantName}}/{{instanceName}}/patients/{{patientId}}/document-summary/:id/files

  3. Documents-Document Records - Update Document Record PUT {{url}}/{{tenantName}}/{{instanceName}}/patients/{{patientId}}/document-summary/:id/:docType

  4. Documents-Document Records - Delete Document Record DELETE {{url}}/{{tenantName}}/{{instanceName}}/patients/{{patientId}}/document-summary/:id/:docType

  5. Unrecognized Calls - Get unrecognized voice call by id GET {{url}}/{{tenantName}}/{{instanceName}}/unrecognized-patients/voice-calls/:uuid

  6. Unrecognized Calls - Get recordings GET {{url}}/{{tenantName}}/{{instanceName}}/unrecognized-patients/voice-calls/{{uuid}}/recordings/{{fileUuid}}

  7. Unrecognized Emails - Get unrecognized email by id GET {{url}}/{{tenantName}}/{{instanceName}}/unrecognized-patients/emails/:uuid

  8. Unrecognized Emails - Get attachments for Emails GET {{url}}/{{tenantName}}/{{instanceName}}/unrecognized-patients/emails/{{uuid}}/attachments/{{fileUuid}}

  9. Unrecognized SMS - Get all unrecognized SMS GET {{url}}/{{tenantName}}/{{instanceName}}/unrecognized-patients/sms?status=DELETED, UNRECOGNISED

  10. Unrecognized SMS - Get unrecognized SMS by id GET {{url}}/{{tenantName}}/{{instanceName}}/unrecognized-patients/sms/:uuid