Candid Integration Required Fields

The following tables outline the Profiles, CDTs, and Encounter Disposition Fields that need to be created in Designer for the Candid integration.

Important: Candid requires fields to be named in a specific format. Element names must be 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 5, Max 5, Numbers only	Yes
pdtf-zip4	Text	Min 4, Max 4, Numbers only	Yes
pdtf-tax-id	Text	None	Yes
pdtf-npi	Text	None	Yes
pdtf-state	List	Display Type: Select, US state codes	Yes

pdt-diagnosis-code

Field name	Type	Required
pdtf-diagnosis-code	Text	No
pdtf-short-description	Text	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	Display Type: Select, US state codes	Yes
pdtf-zip	Text	Min 5, Max 5, Numbers only	Yes
pdtf-zip4	Text	Min 4, Max 4, Numbers only	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 10, Max 10, Numbers only	No
pdtf-address1	Textarea	None	No
pdtf-city	Text	None	No
pdtf-state	List	Display Type: Select, US state codes	No
pdtf-zip	Text	Min 5, Max 5, Numbers only	No
pdtf-zip-plus-four-code	Text	Min 4, Max 4, Numbers only	No

pdt-procedures

The Procedure Code Dictionary can be loaded manually in Care, via API, or by a data loader.

Field name	Type	Required
pdtf-procedure-code	Text	Yes
pdtf-procedure-description	Text	Yes

pdt-payer-list

The Payer List Dictionary is provided by Candid.

Field name	Type	Required
pdtf-payer_id	Text	Yes
pdtf-primary_name	Text	Yes
pdtf-cpid	Integer	No

---

Billing Assessment CDTs

Completed within the Billing Forms Assessment.

Data Type Name	Type	Data Field Name	Type	Required
cdt-billable-status	Multi Record	cdtf-billable-status	List (BILLABLE, NOT_BILLABLE)	No
cdt-responsible-party	Multi Record	cdtf-responsible-party	List (SELF_PAY, INSURANCE_PAY)	No
cdt-synchronicity	Multi Record	cdtf-synchronicity	List (Synchronous, Asynchronous)	No
cdt-billing-org	Multi Record	cdtf-billing-org	pdt-billing-org	Yes
cdt-service-facilities	Multi Record	cdtf-service-facilities	pdt-service-facilities	Yes
cdt-referring-provider	Multi Record	cdtf-referring-provider	pdt-referring-provider	No
clinical_notes	Multi Record	category	List	No
clinical_notes	Multi Record	notes	Textarea	No
cdt-diagnosis	Multi Record	cdtf-diagnosis	pdt-diagnosis-code (Multiple: Yes)	No
cdt-npi	Multi Record	cdtf-npi	Integer	No

Field logic notes:

• cdt-billable-status — taken from Encounter Disposition first; falls back to Billing Form answers

• cdt-responsible-party — taken from the Encounter's Billing Type field; falls back to Billing Form answers

• cdt-synchronicity — SYNCHRONOUS is used as default if not present

• cdt-billing-org — taken from Encounter Disposition first; falls back to Billing Form, then last CDT record

• cdt-referring-provider — Organization Name is used if present; otherwise First and Last Name are used

• cdt-diagnosis — taken from Encounter Disposition first; falls back to Billing Form, then last CDT record

• cdt-npi — determined by Billing Type: SELF_PAY uses selfpaybillingorganizationNpi; INSURANCE uses insuranceBillingOrganizationNPI; if not set, taken from Billing Form, then User NPI in User Attributes

---

Encounter Dispositions

Data Field Name	Type	Notes
uicedf-billing-org	pdt-billing-org	Required org billing info
uicedf-billable-status	List	Options: BILLABLE, NOT_BILLABLE
uicedf-diagnosis	pdt-diagnosis-code	Diagnosis code and description
uicedf-billing-tag	List (Multiple)	Tags must be created in Candid first

---

CDTs for Data View — cdt-insurance-info

Claim CDTs and Data View are not required and will be created automatically by Welkin.

Note: Insurance info is not sent to Candid if Billing Status is "Not Billable" or Billing Type is "Self Pay."

Data Field Name	Type	Required
cdtf-subscriber-first-name	Text	Yes
cdtf-subscriber-last-name	Text	Yes
cdtf-subscriber-dob	Date	Yes
cdtf-member-id	Text	Yes
cdtf-payer-list	pdt-payer-list	Yes
cdtf-patient-relationship-to-subscriber	List	Yes
cdtf-gender	List	Yes

---

More Questions? Contact [email protected] or your Implementation/CSM directly.