> For the complete documentation index, see [llms.txt](https://docs.welkinhealth.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.welkinhealth.com/integrations/billing-candid/candid-integration-required-fields.md). # 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 or your Implementation/CSM directly. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.welkinhealth.com/integrations/billing-candid/candid-integration-required-fields.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.