Knowledge Base
Integrations
Integration Overview
Integration Information
- Acuity Set up
- eRX: Implementation Checklist
- eRx: Overview
- eRx: Setup and Configuration
- eRX: IDP Quick Tips
- eRX: Tokens
- eRX: Completing the EPCS invitation and Logistical Access Control
- eRX: How to Reset the EPCS Passphrase
- eRX: Prescribe Tapered, Titrated, & Variable Dose Medications
- eRX: Reporting
- Labs: Overview
- Labs: Setup and Configuration
- Labs: Creating a Lab Order in Health Gorilla
- Labs: Creating a Quick Order Lab in Health Gorilla
- DocuSign: Implementation Checklist
- DocuSign: Authorization
- DocuSign: Setup and Configuration in Admin
- DocuSign: Setup and Configuration in Designer
- DocuSign: Feature Overview in Care
- DocuSign: Feature Overview in Designer
- DocuSign: Creating Templates
- Docusign: Go Live Process
- eSignature Configuration
- Zoom: Setup and Configuration
- Zoom: How to Configure Zoom in Designer
- Zoom: Where Do I Find My Zoom ID?
- Zoom: Setting Up Waiting Rooms
- Sisense: Change Requests
- Paubox: Setup and Functionality
- Google Calendar Integration
- Welkin Calendar Synchronization App
- Stripe: Setup and Configuration
- Candid: Setup and Configuration
- Candid Integration - Required Fields
- Phone Tree Implementation
- Twilio: A2P Questions & Answers
- SSO Setup
- Configuring Google Single Sign On
- OneLogin: Setup and Configuration
Integration Support
Candid Integration – Required Fields
The following tables outline the Profiles, CDTs, and Encounter Disposition Fields that need to be created in the Designer Portal for the Candid integration.
Note: Candid requires the fields sent to it be named in a specific format. It is important that the element names are identical to the field names listed below.
Profiles
pdt-billing-org
| Field Name | Type | Specifications | Required |
| pdtf-organization-name | Text | None | Yes |
| pdtf-address | Text | None | Yes |
| pdtf-city | Text | None | Yes |
| pdtf-zip | Text | Min length: 5 Max length: 5 Numbers only: Yes | Yes |
| pdtf-zip4 | Text | Min length: 4 Max length: 4 Numbers only: Yes | Yes |
| pdtf-tax-id | Text | None | Yes |
| pdtf-npi | Text | None | Yes |
| pdtf-state | List | Value Type: String Display Type: Select Options: AA, AE, AP, AL, AK, AS, AZ, AR, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MH, MI, MN, MP, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VI, VT, VA, WA, WV, WI, WY | Yes |
pdt-diagnosis-code
| Field Name | Type | Specifications | Required |
| pdtf-diagnosis-code | Text | None | No |
| pdtf-short-description | Text | None | No |
pdt-service-facilities
| Field Name | Type | Specifications | Required |
| pdtf-organization-name | Text | None | Yes |
| pdtf-address | Text | None | Yes |
| pdtf-city | Text | None | Yes |
| pdtf-state | List | Value Type: String Display Type: Select Options: AA, AE, AP, AL, AK, AZ, AR, CA, CO, CT, DC, DE, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, PR, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY | Yes |
| pdtf-zip | Text | Min length: 5 Max length: 5 Numbers only: Yes | Yes |
| pdtf-zip4 | Text | Min length: 4 Max length: 4 Numbers only: Yes | Yes Note: The Zip-Plus-4 field is required for the Service Facility Address. Per CMS guidelines, use “9998” when the code is not available. |
pdt-referring-provider
| Field Name | Type | Specifications | Required |
| pdtf-first-name | Text | None | No |
| pdtf-last-name | Text | None | No |
| pdtf-organization-name | Text | None | No |
| pdtf-npi | Text | Min length: 10 Max length: 10 Numbers only: Yes | No |
| pdtf-address1 | Textarea | None | No |
| pdtf-city | Text | None | No |
| pdtf-state | List | Value Type: String Display Type: Select Options: AA, AE, AP, AL, AK, AS, AZ, AR, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MH, MI, MN, MP, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VI, VT, VA, WA, WV, WI, WY | No |
| pdtf-zip | Text | Min length: 5 Max length: 5 Numbers only: Yes | No |
| pdtf-zip-plus-four-code | Text | Min length: 4 Max length: 4 Numbers only: Yes | No |
pdt-procedures
The Procedure Code Dictionary can be loaded manually in Care, via API, or by a data loader.
| Field Name | Type | Specifications | Required |
| pdtf-procedure-code | Text | None | Yes |
| pdtf-procedure-description | Text | None | Yes |
pdt-payer-list
The Payer List Dictionary is provided by Candid
| Field Name | Type | Specifications | Required |
| pdtf-payer_id | Text | None | Yes |
| pdtf-primary_name | Text | None | Yes |
| pdtf-cpid | Integer | None | No |
Billing Assessment CDTs
The CDTs will be completed within the Billing Forms Assessment.
| Data Type Name | Type | Data Fields Name | Type | Specifications | Required |
|---|---|---|---|---|---|
| cdt-billable-status | Multi Record | cdtf-billable-status | List | Value Type: String Display Type: Select Options: BILLABLE::Billable, NOT_BILLABLE::Not billable | No Note: The field is taken from the Encounter Disposition. If it is not in the Encounter Disposition, it will be taken from the Billing Form answers. |
| cdt-responsible-party | Multi Record | cdtf-responsible-party | List | Value Type: String Display Type: Select Options: SELF_PAY::Self-pay, INSURANCE_PAY::Insurance | No Note: The Encounter UI has a preconfigured field: Billing Type. The responsible party will be taken from the Encounter based on this field. Otherwise, it will be taken from the Billing Form answers. |
| cdt-synchronicity | Multi Record | cdtf-synchronicity | N/A | Value Type: String Display Type: Select Options: Synchronous Asynchronous | No Note: SYNCHRONOUS is used as the default if the field is not present |
| cdt-billing-org | Multi Record | cdtf-billing-org | pdt-billing-org | Profile Fields: pdtf-organization-name, pdtf-address, pdtf-city, pdtf-zip, pdtf-zip4, pdtf-tax-id, pdtf-npi, pdtf-state | Yes Note: The Billing Org is taken from the Encounter Disposition. If it is not present there it will be taken from the Billing Form answers. The last CDT record will be used if it is not in the Billing Form. |
| cdt-service-facilities | Multi Record | cdtf-service-facilities | pdt-service-facilities | Profile Fields: pdtf-organization-name, pdtf-address, pdtf-city, pdtf-state, pdtf-zip, pdtf-zip4 | Yes |
| cdt-referring-provider | Multi Record | cdtf-referring-provider | pdt-referring-provider | Profile Fields: pdtf-first-name, pdtf-last-name, pdtf-organization-name, pdtf-npi, pdtf-address1, pdtf-city, pdtf-state, pdtf-zip, pdtf-zip-plus-four-code | No Note: The Organization Name will be used if it is present. If it is not, then the First and Last Names will be used. |
| Clinical_notes | Multi Record | category | List | Value Type: String Display Type: Select Options: clinical, care_plan, diagnoses, vitals, physical_exam, review_of_systems, medical_decisions, history_of_present_illness, patient_info, chief_complaint, health_record, consent, procedure, time_in_appointment | No |
| notes | Textarea | None | No | ||
| cdt-diagnosis | Multi Record | cdtf-diagnosis | pdt-diagnosis-code | Multiple: Yes Profile Fields: pdtf-diagnosis-code, pdtf-short-description | No Note: The Diagnosis Code is taken from the Encounter Disposition. If it is not present there, the Code(s) is taken from the Billing Form. If it is not present in the Form, then it will be taken from the last CDT record. |
| cdt-npi | Multi Record | cdtf-npi | Integer | No Note: If the Responsible Party (Billing Type in the Encounter UI) is SELF PAY, then the NPI is taken from the selfpaybillingorganizationNpi in the User Attributes of Admin. If the Responsible Party (Billing Type in the Encounter UI) is INSURANCE, then the NPI is taken from the insuranceBillingOrganizationNPI in the User Attributes of Admin. If the Responsible Party is not set then it is taken from the Billing Form answers If the Responsible Party is not present then it is taken from the User NPI in the User Attributes of Admin. |
Encounter Dispositions
| Data Field Name | Type | Description |
|---|---|---|
| uicedf-billing-org | pdt-billing-org | Profile Fields: pdtf-organization-name, pdtf-address, pdtf-city, pdtf-state, pdtf-zip, pdtf-zip4, pdtf-tax-id, pdtf-npi |
| uicedf-billable-status | List | Value Type: String Display Type: Select Options: BILLABLE::Billable NOT_BILLABLE::Not billable |
| uicedf-diagnosis | pdt-diagnosis-code | Profile Fields: pdtf-diagnosis-code pdtf-short-description |
| uicedf-billing-tag | List | Value Type: String Display Type: Select Multiple: Yes (The list must be multiple) Options: Tags that have been created in Candid Note: Tags must be created in Candid in order to use this field. |
CDTs for Dataview
Claim CDTs and Data View are not required, and will be created automatically by Welkin.
| Data Type Name | Type | Data Fields Name | Type | Specifications | Required |
|---|---|---|---|---|---|
| cdt-insurance-info Note: The Insurance Info is not sent to Candid if the Billing Status is “Not Billable” or the ResponsibleParty (Billing Type in the Encounter) is “Self Pay”. | Multi Record | cdtf-subscriber-first-name | Text | None | Yes |
| cdtf-subscriber-last-name | Text | None | Yes | ||
| cdtf-subscriber-dob | Date | None | Yes | ||
| cdtf-member-id | Text | None | Yes | ||
| cdtf-payer-list | pdt-payer-list | Profile Fields: pdtf-payer_id, pdtf-primary_name | Yes | ||
| cdtf-patient-relationship-to-subscriber | List | Value Type: String Display Type: Select Options: 01::Spouse 04::Grandparent 05::Grandchild 07::Niece/Nephew 10::Foster Child 15::Ward of the Court 17::Stepchild 18::Self 19::Child 20::Employee 21::Unknown 22::Handicapped Dependent 23::Sponsored Dependent 24::Dependent of Minor Dependent 29::Significant Other 32::Mother 33::Father 36::Emancipated Minor 39::Organ Donor 40::Cadaver Donor 41::Injured Plaintiff 43::Child (No Financial Responsibility) 53::Life Partner G8::Other Relationship | Yes | ||
| cdtf-gender | List | Value Type: String Display Type: Select Options: male::Male female::Female other::Other not_given::Not given unknown::Unknown | Yes |
More Questions?
If you have any questions, please email the Customer Success Management team at CSM@welkinhealth.com or contact your Implementation/CSM directly.