> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.joincandidhealth.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.joincandidhealth.com/_mcp/server. # Get all Charge Capture Claim Creations GET https://api.joincandidhealth.com/api/charge_capture_claim_creation/v1 Reference: https://docs.joincandidhealth.com/api-reference/charge-capture-bundles/v-1/get-all ## Authentication - OAuth2 — send the obtained token as `Authorization: Bearer ` ## Servers - `https://api.joincandidhealth.com` (Production, default) - `https://api-staging.joincandidhealth.com` (Staging) - `https://sandbox-api.joincandidhealth.com` (CandidSandbox) - `https://staging-api.joincandidhealth.com` (CandidStaging) - `http://localhost:5050` (Local) ## Request ### Query parameters - `limit` (integer, optional) — Maximum number of entities per page, defaults to 100. - `sort` (enum, optional) — Defaults to created_at - Allowed values: `created_at` - `sort_direction` (enum, optional) — Sort direction. Defaults to descending order if not provided. - Allowed values: `asc`, `desc` - `page_token` (string, optional) - `patient_external_id` (string, optional) — The patient ID from the external EMR platform for the patient - `claim_creation_status` (enum, optional) — the status of the charge capture Claim Creation, refers to whether it was able to create a claim. - Allowed values: `not-started`, `in-error`, `successful`, `successful-dry-run`, `aborted`, `held` - `charge_status` (enum, optional) — the status of the charge captures - Allowed values: `planned`, `not-billable`, `billable`, `aborted`, `entered-in-error` - `charge_external_id` (string, optional) — A client-specified unique ID to associate with this encounter; for example, your internal encounter ID or a Dr. Chrono encounter ID. This field should not contain PHI. - `date_of_service_min` (date, optional) — Date formatted as YYYY-MM-DD; eg: 2019-08-24. This date must be the local date in the timezone where the service occurred. - `date_of_service_max` (date, optional) — Date formatted as YYYY-MM-DD; eg: 2019-08-24. This date must be the local date in the timezone where the service occurred. - `claim_ids` (UUID, optional) — A list of claim IDs to filter by. This will return all charge capture claim_creations that have a resulting claim with one of the IDs in this list. - `claim_creation_ids` (UUID, optional) — A list of Claim Creation IDs to filter by. - `billing_provider_npis` (string, optional) — A list of billing provider NPIs to filter by. This will return all charge capture claim_creations which include one or more charges with one of the NPIs in this list. - `service_facility_name` (string, optional) — A string to filter by. This will return all charge capture claim_creations which include one or more charges with this service facility name. - `primary_payer_ids` (string, optional) — A list of primary payer IDs to filter by. This will return all charge capture claim_creations which include one or more charges with one of the primary payer IDs in this list. - `rendering_provider_npis` (string, optional) — A list of rendering provider NPIs to filter by. This will return all charge capture claim_creations which include one or more charges with one of the NPIs in this list. - `rendering_provider_names` (string, optional) — A list of rendering provider names to filter by. This will return all charge capture claim_creations which include one or more charges with one of the names in this list. - `supervising_provider_npis` (string, optional) — A list of supervising provider NPIs to filter by. This will return all charge capture claim_creations which include one or more charges with one of the NPIs in this list. - `supervising_provider_names` (string, optional) — A list of supervising provider names to filter by. This will return all charge capture claim_creations which include one or more charges with one of the names in this list. - `claim_status` (enum, optional) — the status of the claim to filter by created from charge capture bundle. - Allowed values: `biller_received`, `coded`, `submitted_to_payer`, `missing_information`, `not_billable`, `waiting_for_provider`, `era_received`, `rejected`, `denied`, `paid`, `paid_incorrectly`, `finalized_paid`, `finalized_denied`, `held_by_customer`, `era_requires_review` - `claim_creation_category` (string, optional) — A list of claim creation categories to filter by. This will return all charge capture claim_creations which include one or more charges with one of the names in this list. - `tags` (string, optional) — A list of tags to filter by. This will return all charge captures with one of the tags. - `primary_payer_names` (string, optional) — A list of primary payer names to filter by. This will return all charge captures with one of the names. - `patient_names` (string, optional) — A list of patient names to filter by. This will return all charge captures with one of the names. - `has_charge_capture_updates` (boolean, optional) — If true, only return claim_creations that have charge captures that have been updated since the Claim Creation has had a status of BILLED. See the updates property on ChargeCapture for more details. ## Response ### 200 - `items` (list of ChargeCaptureClaimCreation, required) - `next_page_token` (string, optional) - `prev_page_token` (string, optional) ## Types ### ChargeCaptureClaimCreation - `id` (UUID, required) - `status` (enum, required) — Status of the Claim Creation, Successful means that the Claim Creation created a corresponding Claim - Allowed values: `not-started`, `in-error`, `successful`, `successful-dry-run`, `aborted`, `held` - `characteristics` (map from string to any, required) — A dictionary of characteristics that are used to group charge captures together based on the bundling configuration. Example: \{"service\_facility.npi": "99999999", "date\_of\_service": "2023-01-01"} - `errors` (list of ChargeCaptureError, required) — All errors that were found when the Claim was attempted to be created. Errors can correspond to the Claim Creation as a whole or specific underlying Charge Captures. - `created_encounter_id` (UUID, optional) - `encounter_creation_input` (ChargeCaptureData, optional) — If a ChargeCaptureBundle attempts creation, this is the input that was created from the underlying charges and used to attempt encounter creation. - `most_recent_claim_preview_id` (UUID, optional) — The ID of the most recently created claim preview associated with this bundle, if any exists. ### ChargeCaptureError - `id` (UUID, required) - `message` (string, required) — A human readable error explaining why this charge capture Claim Creation failed to create a claim. - `claim_creation_id` (UUID, required) — The ID of the ChargeCaptureClaimCreation associated with this Error. - `charge_capture_id` (UUID, optional) — The underlying Charge Capture that this error object references. The Charge Capture referenced will be a part of the Claim Creation tied to this error. Errors may also refer to all charge_captures present in a Claim Creation, in which case this field will be null. - `resolved` (boolean, optional) — Whether or not the error has been resolved as part of user workflows - `resolved_by` (string, optional) — A string denoting who resolved the error within candid's system. - `resolution_reason` (string, optional) — A string denoting how or why an error was resolved. - `field_in_error` (string, optional) — The field of the corresponding underlying ChargeCapture that has a field that is failing validations, is not present but marked as required, or otherwise in error. ### ChargeCaptureData - `accident_date` (date, optional) — 837p Loop2300 DTP*439, CMS1500 Box 15 - `additional_information` (string, optional) — Defines additional information on the claim needed by the payer. Box 19 on the CMS-1500 claim form or Form Locator 80 on a UB-04 claim form. - `admission_date` (date, optional) — 837p Loop2300 DTP*435, CMS-1500 Box 18 or UB-04 Form Locator 12. Required on all ambulance claims when the patient was known to be admitted to the hospital. OR Required on all claims involving inpatient medical visits. - `appointment_type` (string, optional) — Human-readable description of the appointment type (ex: "Acupuncture - Headaches"). - `benefits_assigned_to_provider` (boolean, optional) — Whether this patient has authorized insurance payments to be made to you, not them. If false, patient may receive reimbursement. Box 13 on the CMS-1500 claim form or Form Locator 53 on a UB-04 claim form. - `billable_status` (enum, optional) — Defines if the Encounter is to be billed by Candid to the responsible_party. Examples for when this should be set to NOT_BILLABLE include if the Encounter has not occurred yet or if there is no intention of ever billing the responsible_party. - Allowed values: `BILLABLE`, `NOT_BILLABLE` - `billing_notes` (list of BillingNoteBaseOptional, optional) — Spot to store misc, human-readable, notes about this encounter to be used in the billing process. - `billing_provider` (BillingProviderUpdateWithOptionalAddress, optional) — The billing provider is the provider or business entity submitting the claim. Billing provider may be, but is not necessarily, the same person/NPI as the rendering provider. From a payer's perspective, this represents the person or entity being reimbursed. When a contract exists with the target payer, the billing provider should be the entity contracted with the payer. In some circumstances, this will be an individual provider. In that case, submit that provider's NPI and the tax ID (TIN) that the provider gave to the payer during contracting. In other cases, the billing entity will be a medical group. If so, submit the group NPI and the group's tax ID. Box 33 on the CMS-1500 claim form or Form Locator 1 on a UB-04 claim form. - `claim_supplemental_information` (list of ClaimSupplementalInformationOptional, optional) — Refers to Loop 2300 - Segment PWK on the 837P and 837i form. No more than 10 entries are permitted. - `clinical_notes` (list of ClinicalNoteCategoryCreateOptional, optional) — Holds a collection of clinical observations made by healthcare providers during patient encounters. Please note that medical records for appeals should be sent using the Encounter Attachments API. - `date_of_service` (date, optional) — Date formatted as YYYY-MM-DD; eg: 2019-08-24. This date must be the local date in the timezone where the service occurred. Box 24a on the CMS-1500 claim form or Form Locator 45 on the UB-04 claim form. If service occurred over a range of dates, this should be the start date. If service lines have distinct date_of_service values, updating the encounter's date_of_service will fail. If all service line date_of_service values are the same, updating the encounter's date_of_service will update all service line date_of_service values. - `delay_reason_code` (enum, optional) — Code indicating the reason why a claim submission was delayed. Corresponds to CLM-20 in the 837 specification (both professional and institutional). - Allowed values: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `15`, `16`, `17` - `diagnoses` (list of DiagnosisCreateOptional, optional) — Ideally, this field should contain no more than 12 diagnoses. However, more diagnoses may be submitted at this time, and coders will later prioritize the 12 that will be submitted to the payor. - `discharge_date` (date, optional) — 837p Loop2300 DTP*096, CMS-1500 Box 18 Required for inpatient claims when the patient was discharged from the facility and the discharge date is known. Not used on an institutional claim. - `end_date_of_service` (date, optional) — Date formatted as YYYY-MM-DD; eg: 2019-08-25. This date must be the local date in the timezone where the service occurred. If omitted, the Encounter is assumed to be for a single day. Must not be temporally before the date_of_service field. If service lines have distinct end_date_of_service values, updating the encounter's end_date_of_service will fail. If all service line end_date_of_service values are the same, updating the encounter's end_date_of_service will update all service line date_of_service values. - `epsdt_referral` (EPSDTReferralOptional, optional) — Refers to Box 24H on the CMS1500 form and Loop 2300 CRC - EPSDT Referral on the 837P and 837i form - `existing_medications` (list of MedicationOptional, optional) — Existing medications that should be on the encounter. Note all current existing medications on encounter will be overridden with this list. - `external_id` (string, optional) — A client-specified unique ID to associate with this encounter; for example, your internal encounter ID or a Dr. Chrono encounter ID. This field should not contain PHI. - `guarantor` (GuarantorOptional, optional) — Personal and contact info for the guarantor of the patient responsibility. - `initial_referring_provider` (InitialReferringProviderUpdateWithOptionalAddress, optional) — The second iteration of Loop ID-2310. Use code "P3 - Primary Care Provider" in this loop to indicate the initial referral from the primary care provider or whatever provider wrote the initial referral for this patient's episode of care being billed/reported in this transaction. - `initial_treatment_date` (date, optional) — 837p Loop2300 DTP*454, CMS1500 Box 15 - `interventions` (list of InterventionOptional, optional) - `last_menstrual_period_date` (date, optional) — 837p Loop2300 DTP*484, CMS-1500 Box 14 Required when, in the judgment of the provider, the services on this claim are related to the patient's pregnancy.de This field is populated separately via occurrence codes for UB-04 claim forms. - `onset_of_current_illness_or_symptom_date` (date, optional) — 837p Loop2300 DTP*431, CMS-1500 Box 14 Required for the initial medical service or visit performed in response to a medical emergency when the date is available and is different than the date of service. OR This date is the onset of acute symptoms for the current illness or condition. For UB-04 claims, this is populated separately via occurrence codes. - `outside_lab` (boolean, optional) — Indicates whether lab services were performed outside the billing entity. Box 20 (Yes/No) on the CMS-1500 claim form. - `outside_lab_charges_amount_cents` (integer, optional) — The charges associated with outside lab services, in cents. Box 20 (Charges) on the CMS-1500 claim form. Applicable when outside_lab is true. - `patient` (PatientUpdateWithOptionalAddress, optional) — Contains the identification information of the individual receiving medical services. - `patient_histories` (list of PatientHistoryCategoryOptional, optional) - `pay_to_address` (StreetAddressShortZipOptional, optional) — Specifies the address to which payments for the claim should be sent. - `place_of_service_code` (enum, optional) — Box 24B on the CMS-1500 claim form. 837p Loop2300, CLM-05-1. 02 for telemedicine, 11 for in-person. Full list [here](https://www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set). - Allowed values: `01`, `02`, `03`, `04`, `05`, `06`, `07`, `08`, `09`, `10`, `11`, `12`, `13`, `14`, `15`, `16`, `17`, `18`, `19`, `20`, `21`, `22`, `23`, `24`, `25`, `26`, `31`, `32`, `33`, `34`, `41`, `42`, `49`, `50`, `51`, `52`, `53`, `54`, `55`, `56`, `57`, `58`, `60`, `61`, `62`, `65`, `71`, `72`, `81`, `99` - `prior_authorization_number` (string, optional) — Box 23 on the CMS-1500 claim form or Form Locator 63 on a UB-04 claim form. - `property_casualty_claim_number` (string, optional) — 837p Loop2010 REF02, CMS1500 Box 11b - `property_casualty_patient_identifier` (PropertyCasualtyPatientIdentifierCreateOptional, optional) — Patient identifier for Property and Casualty claims. 837p Loop2010CA - `provider_accepts_assignment` (boolean, optional) — Whether you have accepted the patient's authorization for insurance payments to be made to you, not them. Box 27 on the CMS-1500 claim form. There is no exact equivalent of this field on a UB-04 claim, however contributes to the concept of Form Locator 53. - `purchased_service_provider_npi` (string, optional) — NPI of the provider that performed the outside lab service. Box 20 on the CMS-1500 claim form. Required to record outside lab charges. - `referral_number` (string, optional) — Refers to REF*9F on the 837p. Value cannot be greater than 50 characters. - `referring_provider` (ReferringProviderUpdateWithOptionalAddress, optional) — The final provider who referred the services that were rendered. All physicians who order services or refer Medicare beneficiaries must report this data. - `related_causes_information` (RelatedCausesInformationCreateOptional, optional) — Corresponds to box 10a on the CMS-1500 (Loop 2300 on 837) - `rendering_provider` (RenderingProviderUpdateWithOptionalAddress, optional) — The rendering provider is the practitioner -- physician, nurse practitioner, etc. -- performing the service. For telehealth services, the rendering provider performs the visit, asynchronous communication, or other service. The rendering provider address should generally be the same as the service facility address. - `responsible_party` (enum, optional) — Defines the party to be billed with the initial balance owed on the claim. Use SELF_PAY if you intend to bill self pay/cash pay. - Allowed values: `INSURANCE_PAY`, `SELF_PAY`, `UNKNOWN` - `schema_instances` (list of SchemaInstanceOptional, optional) — Key-value pairs that must adhere to a schema created via the Custom Schema API. Multiple schema instances cannot be created for the same schema on an encounter. Updating schema instances utilizes PUT semantics, so the schema instances on the encounter will be set to whatever inputs are provided. If null is provided as an input, then the encounter's schema instances will be cleared. - `secondary_payer_carrier_code` (string, optional) — When Medicaid is billed as the secondary payer the Carrier Code is used to identify the primary payer. This is required for certain states. - `service_authorization_exception_code` (enum, optional) — 837p Loop2300 REF*4N Required when mandated by government law or regulation to obtain authorization for specific service(s) but, for the reasons listed in one of the enum values of ServiceAuthorizationExceptionCode, the service was performed without obtaining the authorization. - Allowed values: `1`, `2`, `3`, `4`, `5`, `6`, `7` - `service_facility` (EncounterServiceFacilityUpdateWithOptionalAddress, optional) — Encounter Service facility is typically the location a medical service was rendered, such as a provider office or hospital. For telehealth, service facility can represent the provider's location when the service was delivered (e.g., home), or the location where an in-person visit would have taken place, whichever is easier to identify. If the provider is in-network, service facility may be defined in payer contracts. Box 32 on the CMS-1500 claim form. There is no equivalent on the paper UB-04 claim form, but this field is equivalent to Loop 2310E Service Facility Location details on an 837i form, and is used when this is different to the entity identified as the Billing Provider. Note that for an in-network claim to be successfully adjudicated, the service facility address listed - `service_facility_id` (UUID, optional) — The ID of an existing Organization Service Facility to use for this encounter. The service facility's canonical data (name, address, NPI, etc.) will be populated automatically. If the value does not match an existing Organization Service Facility, the request will fail with a 422 error. This field is mutually exclusive with service_facility — providing both will result in a 422 error. - `service_lines` (list of ServiceLineCreateOptional, optional) — Each service line must be linked to a diagnosis. Concretely, `service_line.diagnosis_pointers`must contain at least one entry which should be in bounds of the diagnoses list field. - `subscriber_primary` (SubscriberCreateOptional, optional) — Contains details of the primary insurance subscriber. - `subscriber_secondary` (SubscriberCreateOptional, optional) — Contains details of the secondary insurance subscriber. - `subscriber_tertiary` (SubscriberCreateOptional, optional) — Contains details of the tertiary insurance subscriber. - `supervising_provider` (SupervisingProviderUpdateWithOptionalAddress, optional) — Required when the rendering provider is supervised by a physician. If not required by this implementation guide, do not send. - `synchronicity` (enum, optional) — Whether or not this was a synchronous or asynchronous encounter. Asynchronous encounters occur when providers and patients communicate online using forms, instant messaging, or other pre-recorded digital mediums. Synchronous encounters occur in live, real-time settings where the patient interacts directly with the provider, such as over video or a phone call. - Allowed values: `Synchronous`, `Asynchronous` - `tag_ids` (list of string, optional) — Names of tags that should be on the encounter. Note all tags on encounter will be overridden with this list. - `vitals` (VitalsUpdate, optional) — If a vitals entity already exists for the encounter, then all values will be updated to the provided values. Otherwise, a new vitals object will be created for the encounter. - `external_claim_submission` (ExternalClaimSubmissionCreateOptional, optional) — ***This field is in beta.*** To be included for claims that have been submitted outside of Candid. Candid supports posting remits and payments to these claims and working them in-platform (e.g. editing, resubmitting). - `patient_authorized_release` (boolean, optional) — Whether this patient has authorized the release of medical information for billing purpose. Box 12 on the CMS-1500 claim form or Form Locator 52 on a UB-04 claim form. - `treating_provider` (TreatingProviderUpdateWithOptionalAddress, optional) — The treating provider is the provider who treats the patient. This is supported for professional and institutional encounters. ### BillingNoteBaseOptional - `text` (string, optional) — Empty string not allowed. ### BillingProviderUpdateWithOptionalAddress The billing provider is the provider or business entity submitting the claim. Billing provider may be, but is not necessarily, the same person/NPI as the rendering provider. From a payer's perspective, this represents the person or entity being reimbursed. When a contract exists with the target payer, the billing provider should be the entity contracted with the payer. In some circumstances, this will be an individual provider. In that case, submit that provider's NPI and the tax ID (TIN) that the provider gave to the payer during contracting. In other cases, the billing entity will be a medical group. If so, submit the group NPI and the group's tax ID. Box 33 on the CMS-1500 claim or Form Locator 1 on a UB-04 claim form. The address fields here are optional. - `address` (StreetAddressShortZipOptional, optional) - `first_name` (string, optional) — If the provider is an individual, this should be set instead of organization name - `last_name` (string, optional) — If the provider is an individual, this should be set instead of organization name - `npi` (string, optional) - `organization_name` (string, optional) — If the provider is an organization, this should be set instead of first + last name - `provider_commercial_license_type` (enum, optional) — 837i Loop2010BB G2 Provider Commercial Number - Allowed values: `0`, `A`, `B`, `C`, `D`, `E`, `F`, `G`, `H`, `I` - `secondary_identification` (BillingProviderSecondaryIdentificationOptional, optional) — Only one of provider_commercial_license_type or secondary_identification may be provided 837i Loop2010BB G2 Secondary Identification - `tax_id` (string, optional) — If the provider has a contract with insurance, this must be the same tax ID given to the payer on an IRS W-9 form completed during contracting. - `taxonomy_code` (string, optional) ### ClaimSupplementalInformationOptional - `attachment_report_type_code` (enum, optional) - Allowed values: `03`, `04`, `05`, `06`, `07`, `08`, `09`, `10`, `11`, `13`, `15`, `21`, `A3`, `A4`, `AM`, `AS`, `B2`, `B3`, `B4`, `BR`, `BS`, `BT`, `CB`, `CK`, `CT`, `D2`, `DA`, `DB`, `DG`, `DJ`, `DS`, `EB`, `HC`, `HR`, `I5`, `IR`, `LA`, `M1`, `MT`, `NN`, `OB`, `OC`, `OD`, `OE`, `OX`, `OZ`, `P4`, `P5`, `PE`, `PN`, `PO`, `PQ`, `PY`, `PZ`, `RB`, `RR`, `RT`, `RX`, `SG`, `V5`, `XP` - `attachment_transmission_code` (enum, optional) - Allowed values: `AA`, `BM`, `EL`, `FX` - `attachment_control_number` (string, optional) ### ClinicalNoteCategoryCreateOptional - `category` (enum, optional) - Allowed values: `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` - `notes` (list of ClinicalNoteOptional, optional) ### DiagnosisCreateOptional - `name` (string, optional) — Empty string not allowed. - `code_type` (enum, optional) — Typically, providers submitting claims to Candid are using ICD-10 diagnosis codes. If you are using ICD-10 codes, the primary diagnosis code listed on the claim should use the ABK code_type. If more than one diagnosis is being submitted on a claim, please use ABF for the rest of the listed diagnoses. If you are using ICD-9 diagnosis codes, use BK and BF for the principal and following diagnosis code(s) respectively. - Allowed values: `ABF`, `ABJ`, `ABK`, `APR`, `BF`, `BJ`, `BK`, `PR`, `DR`, `LOI` - `code` (string, optional) — Empty string not allowed. Should be of the appropriate format for the provided `code_type`. Must obey the ICD-10 format if an ICD-10 code_type is provided, specifically: - Letter - Digit - Digit or the letter `A` or `B` - (Optional) Period `.` - Up to 4 (or as few as 0) letters and digits - `present_on_admission_indicator` (enum, optional) — For Institutional claims only. A "Y" indicates that the onset occurred prior to admission to the hospital. An "N" indicates that the onset did NOT occur prior to admission to the hospital. A "U" indicates that it is unknown whether the onset occurred prior to admission to the hospital or not. - Allowed values: `YES`, `NO`, `UNKNOWN`, `NOT_APPLICABLE` ### EPSDTReferralOptional - `condition_indicator1` (enum, optional) - Allowed values: `AV`, `NU`, `S2`, `ST` - `condition_indicator2` (enum, optional) - Allowed values: `AV`, `NU`, `S2`, `ST` - `condition_indicator3` (enum, optional) - Allowed values: `AV`, `NU`, `S2`, `ST` ### MedicationOptional - `name` (string, optional) - `rx_cui` (string, optional) - `dosage` (string, optional) - `dosage_form` (string, optional) - `frequency` (string, optional) - `as_needed` (boolean, optional) ### GuarantorOptional - `first_name` (string, optional) - `last_name` (string, optional) - `external_id` (string, optional) — A unique identifier for the guarantor assigned by an external system. - `date_of_birth` (date, optional) — Date formatted as YYYY-MM-DD; eg: 2019-08-25. - `address` (StreetAddressShortZipOptional, optional) - `phone_numbers` (list of PhoneNumberOptional, optional) - `phone_consent` (boolean, optional) - `email` (string, optional) - `email_consent` (boolean, optional) - `auto_charge_consent` (boolean, optional) ### InitialReferringProviderUpdateWithOptionalAddress - `address` (StreetAddressShortZipOptional, optional) - `first_name` (string, optional) — If the provider is an individual, this should be set instead of organization name - `last_name` (string, optional) — If the provider is an individual, this should be set instead of organization name - `npi` (string, optional) — A National Provider Identifier is a unique 10-digit identification number issued to health care providers in the United States - `organization_name` (string, optional) — If the provider is an organization, this should be set instead of first + last name - `qualifier` (enum, optional) - Allowed values: `DQ`, `DN`, `DK`, `P3` - `secondary_identification` (ReferringProviderSecondaryIdentificationOptional, optional) - `taxonomy_code` (string, optional) ### InterventionOptional - `name` (string, optional) - `category` (enum, optional) - Allowed values: `allopathic`, `naturopathic`, `tests`, `lifestyle` - `description` (string, optional) — "Examples: 'Birth Control LAC', 'Tracking', 'Stress Management', 'Supplement', 'Labs'" - `medication` (MedicationOptional, optional) — Required when `type` is `allopathic`. - `labs` (list of LabOptional, optional) — Required when `type` is `tests`. ### PatientUpdateWithOptionalAddress - `first_name` (string, optional) - `last_name` (string, optional) - `gender` (enum, optional) - Allowed values: `male`, `female`, `other`, `not_given`, `unknown` - `external_id` (string, optional) — The ID used to identify this individual in your system. For example, your internal patient ID or an EHR patient ID. - `date_of_birth` (date, optional) — Box 3 on the CMS-1500 claim form or Form Locator 10 on a UB-04 claim form. The date format should be in ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01) - `address` (StreetAddressShortZipOptional, optional) — Box 5 on the CMS-1500 claim form or Form Locator 9 on a UB-04 claim form. - `phone_numbers` (list of PhoneNumberOptional, optional) - `phone_consent` (boolean, optional) - `email` (string, optional) - `email_consent` (boolean, optional) - `auto_charge_consent` (boolean, optional) - `non_insurance_payers_info` (list of PatientNonInsurancePayerInfoCreateOptional, optional) — On update, we will replace the existing list of non-insurance payers with the new list if populated. - `non_insurance_payers` (list of UUID, optional, deprecated) — On update, we will replace the existing list of non-insurance payers with the new list if populated. ### PatientHistoryCategoryOptional - `category` (enum, optional) - Allowed values: `present_illness`, `medical`, `family`, `social` - `questions` (list of IntakeQuestionOptional, optional) — Must contain at least one item. ### StreetAddressShortZipOptional - `address1` (string, optional) - `address2` (string, optional) - `city` (string, optional) - `state` (enum, optional) - Allowed values: `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`, `FC` - `zip_code` (string, optional) — 5-digit zip code - `zip_plus_four_code` (string, optional) — 4-digit zip add-on code https://en.wikipedia.org/wiki/ZIP_Code#ZIP+4 ### PropertyCasualtyPatientIdentifierCreateOptional - `property_casualty_patient_identifier_qualifier` (enum, optional) — Represents REF01 on the EDI 837 Loop 2010CA Property and Casualty Patient Identifier segment. Valid values include 1W (Member Identification Number) and SY (Social Security Number). - Allowed values: `1W`, `SY` - `property_casualty_patient_identifier` (string, optional) — Represents REF02 on the EDI 837 Loop 2010CA Property and Casualty Patient Identifier segment. Value cannot exceed 50 characters ### ReferringProviderUpdateWithOptionalAddress - `address` (StreetAddressShortZipOptional, optional) - `first_name` (string, optional) — If the provider is an individual, this should be set instead of organization name - `last_name` (string, optional) — If the provider is an individual, this should be set instead of organization name - `npi` (string, optional) — A National Provider Identifier is a unique 10-digit identification number issued to health care providers in the United States - `organization_name` (string, optional) — If the provider is an organization, this should be set instead of first + last name - `secondary_identification` (ReferringProviderSecondaryIdentificationOptional, optional) - `taxonomy_code` (string, optional) - `qualifier` (enum, optional, deprecated) — Deprecated. This field will be removed in a future release. - Allowed values: `DQ`, `DN`, `DK`, `P3` ### RelatedCausesInformationCreateOptional - `related_causes_code_1` (enum, optional) - Allowed values: `AA`, `AB`, `AP`, `EM`, `OA`, `ZZ` - `related_causes_code_2` (enum, optional) - Allowed values: `AA`, `AB`, `AP`, `EM`, `OA`, `ZZ` - `state_or_province_code` (string, optional) ### RenderingProviderUpdateWithOptionalAddress - `address` (StreetAddressShortZipOptional, optional) - `first_name` (string, optional) — If the provider is an individual, this should be set instead of organization name - `last_name` (string, optional) — If the provider is an individual, this should be set instead of organization name - `npi` (string, optional) — A National Provider Identifier is a unique 10-digit identification number issued to health care providers in the United States - `organization_name` (string, optional) — If the provider is an organization, this should be set instead of first + last name - `secondary_identification` (ProviderSecondaryIdentificationOptional, optional) — Only one of provider_commercial_license_type or secondary_identification may be provided 837i Loop2310BB G2 Secondary Identification - `taxonomy_code` (string, optional) ### SchemaInstanceOptional - `schema_id` (UUID, optional) — The schema to which the content must adhere. - `content` (map from string to any, optional) — A set of key-value pairs that adhere to the naming and type convention of the schema. Not all keys in the schema must be included, but attaching any key that does not exist in the schema or attaching a key with the incorrect value type will result in errors. ### EncounterServiceFacilityUpdateWithOptionalAddress - `organization_name` (string, optional) - `npi` (string, optional) — An NPI specific to the service facility if applicable, i.e. if it has one and is not under the billing provider's NPI. Box 32 section (a) of the CMS-1500 claim form. - `address` (StreetAddressShortZipOptional, optional) — zip_plus_four_code is required for service facility address. When the zip_plus_four_code is not available use "9998" as per CMS documentation. - `secondary_identification` (string, optional) — An additional identifier for the service facility other than the facility's NPI. Some payers may require this field. Potential examples: state license number, provider commercial number, or location number. Box 32 section (b) of the CMS-1500 claim form. - `mammography_certification_number` (string, optional) — The associated mammography certification number for this service facility. This is a 6 digit code assigned by the FDA. ### ServiceLineCreateOptional - `modifiers` (list of enum, optional) - Allowed values: `AV`, `AU`, `AW`, `AY`, `07`, `08`, `09`, `10`, `11`, `12`, `13`, `14`, `15`, `16`, `22`, `23`, `24`, `25`, `26`, `27`, `28`, `32`, `33`, `47`, `50`, `51`, `52`, `53`, `54`, `55`, `56`, `57`, `58`, `59`, `62`, `63`, `66`, `73`, `74`, `76`, `77`, `78`, `79`, `80`, `81`, `82`, `90`, `91`, `92`, `93`, `95`, `96`, `97`, `99`, `A1`, `A2`, `A3`, `A4`, `A5`, `A6`, `A7`, `A8`, `A9`, `AA`, `AB`, `AD`, `AE`, `AF`, `AG`, `AH`, `AI`, `AJ`, `AK`, `AM`, `AO`, `AP`, `AQ`, `AR`, `AS`, `AT`, `AZ`, `BA`, `BL`, `BO`, `BP`, `BR`, `BU`, `CA`, `CB`, `CC`, `CD`, `CE`, `CF`, `CG`, `CH`, `CI`, `CJ`, `CK`, `CL`, `CM`, `CN`, `CR`, `CS`, `CT`, `CO`, `CQ`, `DA`, `E1`, `E2`, `E3`, `E4`, `EA`, `EB`, `EC`, `ED`, `EE`, `EJ`, `EM`, `EP`, `ER`, `ET`, `EV`, `EX`, `EY`, `F1`, `F2`, `F3`, `F4`, `F5`, `F6`, `F7`, `F8`, `F9`, `FA`, `FB`, `FC`, `FP`, `FQ`, `FR`, `FS`, `FT`, `FX`, `FY`, `G0`, `G1`, `G2`, `G3`, `G4`, `G5`, `G6`, `G7`, `G8`, `G9`, `GA`, `GB`, `GC`, `GE`, `GF`, `GG`, `GH`, `GJ`, `GK`, `GL`, `GM`, `GN`, `GO`, `GP`, `GQ`, `GR`, `GS`, `GT`, `GU`, `GV`, `GW`, `GX`, `GY`, `GZ`, `HA`, `HB`, `HC`, `HD`, `HE`, `HF`, `HG`, `HH`, `HI`, `HJ`, `HK`, `HL`, `HM`, `HN`, `HO`, `HP`, `HQ`, `HR`, `HS`, `HT`, `HU`, `HV`, `HW`, `HX`, `HY`, `HZ`, `J1`, `J2`, `J3`, `J4`, `J5`, `JA`, `JB`, `JC`, `JD`, `JE`, `JG`, `JW`, `JZ`, `K0`, `K1`, `K2`, `K3`, `K4`, `KA`, `KB`, `KC`, `KD`, `KE`, `KF`, `KG`, `KH`, `KI`, `KJ`, `KK`, `KL`, `KM`, `KN`, `KO`, `KP`, `KQ`, `KR`, `KS`, `KT`, `KU`, `KV`, `KW`, `KX`, `KY`, `KZ`, `LC`, `LD`, `LL`, `LM`, `LR`, `LS`, `LT`, `LU`, `M2`, `MA`, `MB`, `MC`, `MD`, `ME`, `MF`, `MG`, `MH`, `MS`, `N1`, `N2`, `N3`, `NB`, `NR`, `NU`, `P1`, `P2`, `P3`, `P4`, `P5`, `P6`, `PA`, `PB`, `PC`, `PD`, `PI`, `PL`, `PM`, `PN`, `PO`, `PS`, `PT`, `Q0`, `Q1`, `Q2`, `Q3`, `Q4`, `Q5`, `Q6`, `Q7`, `Q8`, `Q9`, `QA`, `QB`, `QC`, `QD`, `QE`, `QF`, `QG`, `QH`, `QJ`, `QK`, `QL`, `QM`, `QN`, `QP`, `QQ`, `QR`, `QS`, `QT`, `QW`, `QX`, `QY`, `QZ`, `RA`, `RB`, `RC`, `RD`, `RE`, `RI`, `RR`, `RT`, `SA`, `SB`, `SC`, `SD`, `SE`, `SF`, `SG`, `SH`, `SJ`, `SL`, `SM`, `SN`, `SQ`, `SS`, `ST`, `SU`, `SV`, `SW`, `SY`, `T1`, `T2`, `T3`, `T4`, `T5`, `T6`, `T7`, `T8`, `T9`, `TA`, `TB`, `TC`, `TD`, `TE`, `TF`, `TG`, `TH`, `TJ`, `TK`, `TL`, `TM`, `TN`, `TP`, `TQ`, `TR`, `TS`, `TT`, `TU`, `TV`, `TW`, `U1`, `U2`, `U3`, `U4`, `U5`, `U6`, `U7`, `U8`, `U9`, `UA`, `UB`, `UC`, `UD`, `UE`, `UF`, `UG`, `UH`, `UJ`, `UK`, `UN`, `UP`, `UQ`, `UR`, `US`, `V1`, `V2`, `V3`, `W1`, `W2`, `W3`, `WC`, `WH`, `X4`, `XE`, `XP`, `XS`, `XU`, `XY`, `ZZ` - `has_epsdt_indicator` (boolean, optional) — Maps to SV1-11 on the 837-P and Box 24H on the CMS-1500. If the value is true, the box will be populated with "Y". Otherwise, the box will not be populated. - `has_family_planning_indicator` (boolean, optional) — Maps to SV1-12 on the 837-P and Box 24I on the CMS-1500. If the value is true, the box will be populated with "Y". Otherwise, the box will not be populated. - `procedure_code` (string, optional) - `quantity` (string, optional) — String representation of a Decimal that can be parsed by most libraries. For professional claims, a ServiceLine quantity cannot contain more than one digit of precision (Example: 1.1 is valid, 1.11 is not). For institutional claims, a ServiceLine quantity cannot contain more than three decimal digits of precision. - `units` (enum, optional) - Allowed values: `MJ`, `UN` - `charge_amount_cents` (integer, optional) — The total amount charged for this service line, factoring in quantity. If procedure_code is updated and this is not, the system will attempt to set it based on chargemasters entries and the service line’s quantity. For example, if a single unit has an entry of 100 cents and 2 units were rendered, the charge_amount_cents will be set to 200, if there is no chargemaster entry, it will default to the amount set in this field. - `diagnosis_pointers` (list of integer, optional) — Indices (zero-indexed) of all the diagnoses this service line references - `drug_identification` (DrugIdentificationOptional, optional) - `place_of_service_code` (enum, optional) — 837p Loop2300, SV105. This enum is not used or required in 837i claims. If your organization does not intend to submit claims with a different place of service at the service line level, this field should not be populated. 02 for telemedicine, 11 for in-person. Full list [here](https://www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set). - Allowed values: `01`, `02`, `03`, `04`, `05`, `06`, `07`, `08`, `09`, `10`, `11`, `12`, `13`, `14`, `15`, `16`, `17`, `18`, `19`, `20`, `21`, `22`, `23`, `24`, `25`, `26`, `31`, `32`, `33`, `34`, `41`, `42`, `49`, `50`, `51`, `52`, `53`, `54`, `55`, `56`, `57`, `58`, `60`, `61`, `62`, `65`, `71`, `72`, `81`, `99` - `description` (string, optional) — A free-form description to clarify the related data elements and their content. Maps to SV1-01, C003-07 on a 837-P and SV2-02, C003-07 on a 837-I form. - `date_of_service` (date, optional) - `end_date_of_service` (date, optional) - `ordering_provider` (OrderingProviderOptional, optional) — Required when the service or supply was ordered by a provider who is different than the rendering provider for this service line. If not required by this implementation guide, do not send. - `test_results` (list of TestResultOptional, optional) — Contains a list of test results. Test result types may map to MEA-02 on the 837-P (ex: Hemoglobin, Hematocrit). This is unused by 837-i and ignored for institutional service lines. No more than 5 MEA-02 test results may be submitted per service line. - `note` (string, optional) — Maps to NTE02 loop 2400 on the EDI 837. - `revenue_code` (string, optional) — A 4 digit code that specifies facility department or type of service arrangement for institutional service line items (837i). This code is not required for professional claim billing (837p). - `prior_authorization_number` (string, optional) — Prior authorization number for this service line. Maps to the appropriate REF segment on Loop 2400 of the EDI 837p. This is not used for institutional claims (EDI 837i). - `external_id` (string, optional) — An external identifier for this service line. This is not used in the EDI 837, but can be used to identify the service line in external systems. This field should not contain PHI. Must be unique on a given claim. ### SubscriberCreateOptional - `address` (StreetAddressShortZipOptional, optional) - `date_of_birth` (date, optional) - `first_name` (string, optional) - `gender` (enum, optional) - Allowed values: `male`, `female`, `other`, `not_given`, `unknown` - `insurance_card` (InsuranceCardCreateOptional, optional) — Please reference our [Payer Information](https://docs.joincandidhealth.com/introduction/payer-information) documentation for more details on how to populate the `insurance_card` fields. - `last_name` (string, optional) - `patient_relationship_to_subscriber_code` (enum, optional) - Allowed values: `01`, `04`, `05`, `07`, `10`, `15`, `17`, `18`, `19`, `20`, `21`, `22`, `23`, `24`, `29`, `32`, `33`, `36`, `39`, `40`, `41`, `43`, `53`, `G8` ### SupervisingProviderUpdateWithOptionalAddress - `address` (StreetAddressShortZipOptional, optional) - `first_name` (string, optional) — If the provider is an individual, this should be set instead of organization name - `last_name` (string, optional) — If the provider is an individual, this should be set instead of organization name - `npi` (string, optional) — A National Provider Identifier is a unique 10-digit identification number issued to health care providers in the United States - `organization_name` (string, optional) — If the provider is an organization, this should be set instead of first + last name - `secondary_identification` (SupervisingProviderSecondaryIdentificationOptional, optional) - `taxonomy_code` (string, optional) ### VitalsUpdate - `height_in` (integer, optional) - `weight_lbs` (integer, optional) - `blood_pressure_systolic_mmhg` (integer, optional) - `blood_pressure_diastolic_mmhg` (integer, optional) - `body_temperature_f` (double, optional) - `hemoglobin_gdl` (double, optional) - `hematocrit_pct` (double, optional) ### ExternalClaimSubmissionCreateOptional - `claim_created_at` (datetime, optional) — When the claim was created in the external system. - `patient_control_number` (string, optional) — The Patient Control Number sent on the claim to the payer. To guarantee compatibility with all payers, this field must consist only of uppercase letters and numbers and be no more than 14 characters long. - `submission_records` (list of ClaimSubmissionRecordCreateOptional, optional) — A successful claim submission record will be created for each value provided. An empty list may be provided for cases where the claim originated in an external system but was never submitted to a payer. ### TreatingProviderUpdateWithOptionalAddress Update type for the treating provider with optional address fields. Used in contexts where address fields may be partially provided. - `first_name` (string, optional) - `last_name` (string, optional) - `npi` (string, optional) — A National Provider Identifier is a unique 10-digit identification number issued to health care providers in the United States - `taxonomy_code` (string, optional) - `address` (StreetAddressLongZipOptional, optional) - `license_type` (enum, optional) — The license type of the treating provider (e.g., MD, NP, PA, LCSW). - Allowed values: `MD`, `NP`, `PA`, `LMFT`, `LCPC`, `LCSW`, `PMHNP`, `FNP`, `LPCC`, `DO`, `RD`, `SLP`, `APRN`, `LPC`, `PHD`, `PSYD`, `LMSW`, `LMHC`, `OTHER_MASTERS`, `BCBA`, `UNKNOWN`, `RPH`, `PHT`, `LAC`, `LMT`, `DC`, `ND`, `MA`, `PT`, `IBCLC`, `RN`, `DPT`, `LCMHC`, `CNM`, `RNFA`, `ACSW`, `APC`, `BCABA`, `BHA`, `OD`, `DPM`, `DA`, `DDS`, `DEH`, `DMD`, `PTA`, `LCADC`, `LCAT`, `LCMHCS`, `LCMHCA`, `LCSWA`, `LICSW`, `LISW`, `LMFTS`, `LMFTA`, `LPCI`, `LSCSW`, `MHCA`, `MHT`, `RBT`, `RCSWI`, `RHMCI`, `LPN`, `OTD`, `OMS`, `MFTA`, `APCC`, `DNP`, `AGNPBC`, `ANP`, `FNPPP`, `LCSWR`, `ALC`, `RMFTI`, `LAMFT`, `LPCA`, `LSWI`, `CSW`, `CPC`, `LGMFT`, `LLPC`, `PLPC`, `PLMFT`, `LMHCA`, `CIT`, `CT`, `MFT`, `LSW`, `PLMHP`, `PCMSW`, `LMHP`, `OTR/L`, `RPA`, `COTA`, `CRNP`, `SLP-CF`, `NP-C`, `PA-C`, `AMFT`, `CDN`, `CGC`, `CNS`, `MDPHD`, `AuD`, `ATC`, `LAT`, `OTA`, `LSSP`, `SLPA`, `EdD`, `SWT`, `IMFT` ### BillingProviderSecondaryIdentificationOptional - `reference_identification` (string, optional) — Represents REF02 on the EDI 837 Loop 2010BB Billing Provider Secondary Identification segment. Value cannot exceed 50 characters - `reference_identification_qualifier` (enum, optional) — Represents REF01 on the EDI 837 Loop 2010BB Billing Provider Secondary Identification segment. Valid values include G2 (Provider Commercial Number) and LU (Location Number). Defaults to G2 if not set. - Allowed values: `G2`, `LU` ### ClinicalNoteOptional - `text` (string, optional) - `author_name` (string, optional) - `author_npi` (string, optional) - `timestamp` (datetime, optional) ### PhoneNumberOptional - `number` (string, optional) - `type` (enum, optional) - Allowed values: `Home`, `Mobile`, `Work` ### ReferringProviderSecondaryIdentificationOptional - `reference_identification` (string, optional) - `reference_identification_qualifier` (enum, optional) - Allowed values: `0B`, `1G`, `G2` ### LabOptional - `name` (string, optional) - `code` (string, optional) - `code_type` (enum, optional) - Allowed values: `quest`, `labcorp` ### PatientNonInsurancePayerInfoCreateOptional - `non_insurance_payer_id` (UUID, optional) - `member_id` (string, optional) - `clinical_trial_info` (list of PatientClinicalTrialInfoCreateOptional, optional) ### IntakeQuestionOptional - `id` (string, optional) - `text` (string, optional) - `responses` (list of IntakeResponseAndFollowUpsOptional, optional) ### ProviderSecondaryIdentificationOptional - `reference_identification` (string, optional) — Represents REF02 on the EDI 837 Loop 2010BB Billing Provider Secondary Identification segment. Value cannot exceed 50 characters - `reference_identification_qualifier` (enum, optional) — Represents REF01 on the EDI 837 Loop 2010BB Provider Secondary Identification segment. - Allowed values: `0B`, `1G`, `G2`, `LU` ### DrugIdentificationOptional - `service_id_qualifier` (enum, optional) - Allowed values: `EN`, `EO`, `HI`, `N4`, `ON`, `UK`, `UP` - `national_drug_code` (string, optional) - `national_drug_unit_count` (string, optional) - `measurement_unit_code` (enum, optional) - Allowed values: `ML`, `UN`, `GR`, `F2`, `ME` - `link_sequence_number` (string, optional) - `pharmacy_prescription_number` (string, optional) - `conversion_formula` (string, optional) - `drug_description` (string, optional) ### OrderingProviderOptional - `address` (StreetAddressLongZipOptional, optional) - `first_name` (string, optional) — If the provider is an individual, this should be set instead of organization name - `last_name` (string, optional) — If the provider is an individual, this should be set instead of organization name - `npi` (string, optional) — A National Provider Identifier is a unique 10-digit identification number issued to health care providers in the United States - `organization_name` (string, optional) — If the provider is an organization, this should be set instead of first + last name - `taxonomy_code` (string, optional) ### TestResultOptional - `value` (double, optional) - `result_type` (enum, optional) - Allowed values: `HEMATOCRIT`, `HEMOGLOBIN`, `LDL`, `VITAMIN_D` ### InsuranceCardCreateOptional - `group_number` (string, optional) — Box 11 on the CMS-1500 claim form. - `plan_name` (string, optional) — Box 11c on the CMS-1500 claim form. - `plan_type` (enum, optional) - Allowed values: `09`, `11`, `12`, `13`, `14`, `15`, `16`, `17`, `AM`, `BL`, `CH`, `CI`, `DS`, `FI`, `HM`, `LM`, `MA`, `MB`, `MC`, `OF`, `TV`, `VA`, `WC`, `ZZ` - `insurance_type` (enum, optional) — Code identifying the type of insurance policy within a specific insurance program (X12 008020 Element 1336) - Allowed values: `01`, `12`, `13`, `14`, `15`, `16`, `17`, `18`, `19`, `41`, `42`, `43`, `47`, `AP`, `C1`, `CO`, `CP`, `D`, `DB`, `E`, `EP`, `FF`, `GP`, `HA`, `HB`, `HD`, `HG`, `HM`, `HN`, `HP`, `HS`, `IN`, `IP`, `LC`, `LD`, `LI`, `LT`, `M`, `MA`, `MB`, `MC`, `MD`, `ME`, `MF`, `MH`, `MI`, `MJ`, `MK`, `ML`, `MM`, `MN`, `MO`, `MP`, `MR`, `MT`, `MV`, `OA`, `OT`, `PE`, `PL`, `PP`, `PR`, `PS`, `QM`, `RP`, `SP`, `TF`, `U`, `WC`, `WU` - `payer_plan_group_id` (UUID, optional) - `payer_address` (StreetAddressLongZipOptional, optional) - `member_id` (string, optional) - `payer_name` (string, optional) - `payer_id` (string, optional) - `rx_bin` (string, optional) - `rx_pcn` (string, optional) - `image_url_front` (string, optional) - `image_url_back` (string, optional) - `emr_payer_crosswalk` (enum, optional) — Set to PAYER_PLAN_GROUP to use Payer Plans for automatic payer resolution. See Payer Information documentation for details. - Allowed values: `HEALTHIE`, `CANVAS`, `WAYSTAR`, `PAYER_PLAN_GROUP` - `payer_plan_group_name` (string, optional) — When using emr_payer_crosswalk set to PAYER_PLAN_GROUP, specify the payer plan name here. See Payer Information documentation for details. ### SupervisingProviderSecondaryIdentificationOptional - `reference_identification` (string, optional) - `reference_identification_qualifier` (enum, optional) - Allowed values: `0B`, `1G`, `G2`, `LU` ### ClaimSubmissionRecordCreateOptional Data about each external submission. - `submitted_at` (datetime, optional) — When the claim was submitted to the payer. - `claim_frequency_code` (enum, optional) - Allowed values: `0`, `1`, `2`, `3`, `4`, `5`, `7`, `8`, `9`, `A`, `B`, `C`, `D`, `E`, `F`, `G`, `H`, `I`, `J`, `K`, `M`, `O`, `P`, `Q`, `X`, `Y`, `Z` - `payer_responsibility` (enum, optional) - Allowed values: `primary`, `secondary` - `intended_submission_medium` (enum, optional) — The medium by which the claim was submitted to the payer: paper or electronic. If omitted, defaults to electronic. - Allowed values: `paper`, `electronic` ### StreetAddressLongZipOptional - `address1` (string, optional) - `address2` (string, optional) - `city` (string, optional) - `state` (enum, optional) - Allowed values: `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`, `FC` - `zip_code` (string, optional) — 5-digit zip code - `zip_plus_four_code` (string, optional) — 4-digit zip add-on code https://en.wikipedia.org/wiki/ZIP_Code#ZIP+4 ### PatientClinicalTrialInfoCreateOptional - `clinical_trial_arm` (string, optional) - `clinical_trial_id` (UUID, optional) ### IntakeResponseAndFollowUpsOptional - `response` (string, optional) - `follow_ups` (list of IntakeFollowUpOptional, optional) ### IntakeFollowUpOptional - `id` (string, optional) - `text` (string, optional) - `response` (string, optional) ## Examples **Response** ```json { "items": [ { "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "status": "not-started", "characteristics": { "characteristics": { "key": "value" } }, "errors": [ { "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "message": "message", "claim_creation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "charge_capture_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "resolved": true, "resolved_by": "resolved_by", "resolution_reason": "resolution_reason", "field_in_error": "field_in_error" }, { "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "message": "message", "claim_creation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "charge_capture_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "resolved": true, "resolved_by": "resolved_by", "resolution_reason": "resolution_reason", "field_in_error": "field_in_error" } ], "created_encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "encounter_creation_input": { "accident_date": "2023-01-15", "additional_information": "additional_information", "admission_date": "2023-01-15", "appointment_type": "appointment_type", "benefits_assigned_to_provider": true, "billable_status": "BILLABLE", "billing_notes": [ { "text": "text" }, { "text": "text" } ], "billing_provider": { "address": { "address1": "address1", "address2": "address2", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code" }, "first_name": "first_name", "last_name": "last_name", "npi": "npi", "organization_name": "organization_name", "provider_commercial_license_type": "0", "secondary_identification": { "reference_identification": "reference_identification", "reference_identification_qualifier": "G2" }, "tax_id": "tax_id", "taxonomy_code": "taxonomy_code" }, "claim_supplemental_information": [ { "attachment_report_type_code": "03", "attachment_transmission_code": "AA", "attachment_control_number": "attachment_control_number" }, { "attachment_report_type_code": "03", "attachment_transmission_code": "AA", "attachment_control_number": "attachment_control_number" } ], "clinical_notes": [ { "category": "clinical", "notes": [ {}, {} ] }, { "category": "clinical", "notes": [ {}, {} ] } ], "date_of_service": "2023-01-15", "delay_reason_code": "1", "diagnoses": [ { "name": "name", "code_type": "ABF", "code": "code", "present_on_admission_indicator": "YES" }, { "name": "name", "code_type": "ABF", "code": "code", "present_on_admission_indicator": "YES" } ], "discharge_date": "2023-01-15", "end_date_of_service": "2023-01-15", "epsdt_referral": { "condition_indicator1": "AV", "condition_indicator2": "AV", "condition_indicator3": "AV" }, "existing_medications": [ { "name": "name", "rx_cui": "rx_cui", "dosage": "dosage", "dosage_form": "dosage_form", "frequency": "frequency", "as_needed": true }, { "name": "name", "rx_cui": "rx_cui", "dosage": "dosage", "dosage_form": "dosage_form", "frequency": "frequency", "as_needed": true } ], "external_id": "external_id", "guarantor": { "first_name": "first_name", "last_name": "last_name", "external_id": "external_id", "date_of_birth": "2023-01-15", "address": { "address1": "address1", "address2": "address2", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code" }, "phone_numbers": [ {}, {} ], "phone_consent": true, "email": "email", "email_consent": true, "auto_charge_consent": true }, "initial_referring_provider": { "address": { "address1": "address1", "address2": "address2", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code" }, "first_name": "first_name", "last_name": "last_name", "npi": "npi", "organization_name": "organization_name", "qualifier": "DQ", "secondary_identification": { "reference_identification": "reference_identification", "reference_identification_qualifier": "0B" }, "taxonomy_code": "taxonomy_code" }, "initial_treatment_date": "2023-01-15", "interventions": [ { "name": "name", "category": "allopathic", "description": "description", "medication": {}, "labs": [ {}, {} ] }, { "name": "name", "category": "allopathic", "description": "description", "medication": {}, "labs": [ {}, {} ] } ], "last_menstrual_period_date": "2023-01-15", "onset_of_current_illness_or_symptom_date": "2023-01-15", "outside_lab": true, "outside_lab_charges_amount_cents": 1, "patient": { "first_name": "first_name", "last_name": "last_name", "gender": "male", "external_id": "external_id", "date_of_birth": "2023-01-15", "address": { "address1": "address1", "address2": "address2", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code" }, "phone_numbers": [ {}, {} ], "phone_consent": true, "email": "email", "email_consent": true, "auto_charge_consent": true, "non_insurance_payers_info": [ {}, {} ], "non_insurance_payers": [ "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" ] }, "patient_histories": [ { "category": "present_illness", "questions": [ {}, {} ] }, { "category": "present_illness", "questions": [ {}, {} ] } ], "pay_to_address": { "address1": "address1", "address2": "address2", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code" }, "place_of_service_code": "01", "prior_authorization_number": "prior_authorization_number", "property_casualty_claim_number": "property_casualty_claim_number", "property_casualty_patient_identifier": { "property_casualty_patient_identifier_qualifier": "1W", "property_casualty_patient_identifier": "property_casualty_patient_identifier" }, "provider_accepts_assignment": true, "purchased_service_provider_npi": "purchased_service_provider_npi", "referral_number": "referral_number", "referring_provider": { "address": { "address1": "address1", "address2": "address2", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code" }, "first_name": "first_name", "last_name": "last_name", "npi": "npi", "organization_name": "organization_name", "secondary_identification": { "reference_identification": "reference_identification", "reference_identification_qualifier": "0B" }, "taxonomy_code": "taxonomy_code", "qualifier": "DQ" }, "related_causes_information": { "related_causes_code_1": "AA", "related_causes_code_2": "AA", "state_or_province_code": "state_or_province_code" }, "rendering_provider": { "address": { "address1": "address1", "address2": "address2", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code" }, "first_name": "first_name", "last_name": "last_name", "npi": "npi", "organization_name": "organization_name", "secondary_identification": { "reference_identification": "reference_identification", "reference_identification_qualifier": "0B" }, "taxonomy_code": "taxonomy_code" }, "responsible_party": "INSURANCE_PAY", "schema_instances": [ { "schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "content": { "content": { "key": "value" } } }, { "schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "content": { "content": { "key": "value" } } } ], "secondary_payer_carrier_code": "secondary_payer_carrier_code", "service_authorization_exception_code": "1", "service_facility": { "organization_name": "organization_name", "npi": "npi", "address": { "address1": "address1", "address2": "address2", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code" }, "secondary_identification": "secondary_identification", "mammography_certification_number": "mammography_certification_number" }, "service_facility_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "service_lines": [ { "modifiers": [ "AV", "AV" ], "has_epsdt_indicator": true, "has_family_planning_indicator": true, "procedure_code": "procedure_code", "quantity": "quantity", "units": "MJ", "charge_amount_cents": 1, "diagnosis_pointers": [ 1, 1 ], "drug_identification": {}, "place_of_service_code": "01", "description": "description", "date_of_service": "2023-01-15", "end_date_of_service": "2023-01-15", "ordering_provider": {}, "test_results": [ {}, {} ], "note": "note", "revenue_code": "revenue_code", "prior_authorization_number": "prior_authorization_number", "external_id": "external_id" }, { "modifiers": [ "AV", "AV" ], "has_epsdt_indicator": true, "has_family_planning_indicator": true, "procedure_code": "procedure_code", "quantity": "quantity", "units": "MJ", "charge_amount_cents": 1, "diagnosis_pointers": [ 1, 1 ], "drug_identification": {}, "place_of_service_code": "01", "description": "description", "date_of_service": "2023-01-15", "end_date_of_service": "2023-01-15", "ordering_provider": {}, "test_results": [ {}, {} ], "note": "note", "revenue_code": "revenue_code", "prior_authorization_number": "prior_authorization_number", "external_id": "external_id" } ], "subscriber_primary": { "address": { "address1": "address1", "address2": "address2", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code" }, "date_of_birth": "2023-01-15", "first_name": "first_name", "gender": "male", "insurance_card": { "group_number": "group_number", "plan_name": "plan_name", "plan_type": "09", "insurance_type": "01", "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "payer_address": {}, "member_id": "member_id", "payer_name": "payer_name", "payer_id": "payer_id", "rx_bin": "rx_bin", "rx_pcn": "rx_pcn", "image_url_front": "image_url_front", "image_url_back": "image_url_back", "emr_payer_crosswalk": "HEALTHIE", "payer_plan_group_name": "payer_plan_group_name" }, "last_name": "last_name", "patient_relationship_to_subscriber_code": "01" }, "subscriber_secondary": { "address": { "address1": "address1", "address2": "address2", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code" }, "date_of_birth": "2023-01-15", "first_name": "first_name", "gender": "male", "insurance_card": { "group_number": "group_number", "plan_name": "plan_name", "plan_type": "09", "insurance_type": "01", "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "payer_address": {}, "member_id": "member_id", "payer_name": "payer_name", "payer_id": "payer_id", "rx_bin": "rx_bin", "rx_pcn": "rx_pcn", "image_url_front": "image_url_front", "image_url_back": "image_url_back", "emr_payer_crosswalk": "HEALTHIE", "payer_plan_group_name": "payer_plan_group_name" }, "last_name": "last_name", "patient_relationship_to_subscriber_code": "01" }, "subscriber_tertiary": { "address": { "address1": "address1", "address2": "address2", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code" }, "date_of_birth": "2023-01-15", "first_name": "first_name", "gender": "male", "insurance_card": { "group_number": "group_number", "plan_name": "plan_name", "plan_type": "09", "insurance_type": "01", "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "payer_address": {}, "member_id": "member_id", "payer_name": "payer_name", "payer_id": "payer_id", "rx_bin": "rx_bin", "rx_pcn": "rx_pcn", "image_url_front": "image_url_front", "image_url_back": "image_url_back", "emr_payer_crosswalk": "HEALTHIE", "payer_plan_group_name": "payer_plan_group_name" }, "last_name": "last_name", "patient_relationship_to_subscriber_code": "01" }, "supervising_provider": { "address": { "address1": "address1", "address2": "address2", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code" }, "first_name": "first_name", "last_name": "last_name", "npi": "npi", "organization_name": "organization_name", "secondary_identification": { "reference_identification": "reference_identification", "reference_identification_qualifier": "0B" }, "taxonomy_code": "taxonomy_code" }, "synchronicity": "Synchronous", "tag_ids": [ "tag_ids", "tag_ids" ], "vitals": { "height_in": 1, "weight_lbs": 1, "blood_pressure_systolic_mmhg": 1, "blood_pressure_diastolic_mmhg": 1, "body_temperature_f": 1.1, "hemoglobin_gdl": 1.1, "hematocrit_pct": 1.1 }, "external_claim_submission": { "claim_created_at": "2024-01-15T09:30:00Z", "patient_control_number": "patient_control_number", "submission_records": [ {}, {} ] }, "patient_authorized_release": true, "treating_provider": { "first_name": "first_name", "last_name": "last_name", "npi": "npi", "taxonomy_code": "taxonomy_code", "address": { "address1": "address1", "address2": "address2", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code" }, "license_type": "MD" } }, "most_recent_claim_preview_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, { "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "status": "not-started", "characteristics": { "characteristics": { "key": "value" } }, "errors": [ { "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "message": "message", "claim_creation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "charge_capture_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "resolved": true, "resolved_by": "resolved_by", "resolution_reason": "resolution_reason", "field_in_error": "field_in_error" }, { "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "message": "message", "claim_creation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "charge_capture_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "resolved": true, "resolved_by": "resolved_by", "resolution_reason": "resolution_reason", "field_in_error": "field_in_error" } ], "created_encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "encounter_creation_input": { "accident_date": "2023-01-15", "additional_information": "additional_information", "admission_date": "2023-01-15", "appointment_type": "appointment_type", "benefits_assigned_to_provider": true, "billable_status": "BILLABLE", "billing_notes": [ { "text": "text" }, { "text": "text" } ], "billing_provider": { "address": { "address1": "address1", "address2": "address2", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code" }, "first_name": "first_name", "last_name": "last_name", "npi": "npi", "organization_name": "organization_name", "provider_commercial_license_type": "0", "secondary_identification": { "reference_identification": "reference_identification", "reference_identification_qualifier": "G2" }, "tax_id": "tax_id", "taxonomy_code": "taxonomy_code" }, "claim_supplemental_information": [ { "attachment_report_type_code": "03", "attachment_transmission_code": "AA", "attachment_control_number": "attachment_control_number" }, { "attachment_report_type_code": "03", "attachment_transmission_code": "AA", "attachment_control_number": "attachment_control_number" } ], "clinical_notes": [ { "category": "clinical", "notes": [ {}, {} ] }, { "category": "clinical", "notes": [ {}, {} ] } ], "date_of_service": "2023-01-15", "delay_reason_code": "1", "diagnoses": [ { "name": "name", "code_type": "ABF", "code": "code", "present_on_admission_indicator": "YES" }, { "name": "name", "code_type": "ABF", "code": "code", "present_on_admission_indicator": "YES" } ], "discharge_date": "2023-01-15", "end_date_of_service": "2023-01-15", "epsdt_referral": { "condition_indicator1": "AV", "condition_indicator2": "AV", "condition_indicator3": "AV" }, "existing_medications": [ { "name": "name", "rx_cui": "rx_cui", "dosage": "dosage", "dosage_form": "dosage_form", "frequency": "frequency", "as_needed": true }, { "name": "name", "rx_cui": "rx_cui", "dosage": "dosage", "dosage_form": "dosage_form", "frequency": "frequency", "as_needed": true } ], "external_id": "external_id", "guarantor": { "first_name": "first_name", "last_name": "last_name", "external_id": "external_id", "date_of_birth": "2023-01-15", "address": { "address1": "address1", "address2": "address2", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code" }, "phone_numbers": [ {}, {} ], "phone_consent": true, "email": "email", "email_consent": true, "auto_charge_consent": true }, "initial_referring_provider": { "address": { "address1": "address1", "address2": "address2", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code" }, "first_name": "first_name", "last_name": "last_name", "npi": "npi", "organization_name": "organization_name", "qualifier": "DQ", "secondary_identification": { "reference_identification": "reference_identification", "reference_identification_qualifier": "0B" }, "taxonomy_code": "taxonomy_code" }, "initial_treatment_date": "2023-01-15", "interventions": [ { "name": "name", "category": "allopathic", "description": "description", "medication": {}, "labs": [ {}, {} ] }, { "name": "name", "category": "allopathic", "description": "description", "medication": {}, "labs": [ {}, {} ] } ], "last_menstrual_period_date": "2023-01-15", "onset_of_current_illness_or_symptom_date": "2023-01-15", "outside_lab": true, "outside_lab_charges_amount_cents": 1, "patient": { "first_name": "first_name", "last_name": "last_name", "gender": "male", "external_id": "external_id", "date_of_birth": "2023-01-15", "address": { "address1": "address1", "address2": "address2", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code" }, "phone_numbers": [ {}, {} ], "phone_consent": true, "email": "email", "email_consent": true, "auto_charge_consent": true, "non_insurance_payers_info": [ {}, {} ], "non_insurance_payers": [ "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" ] }, "patient_histories": [ { "category": "present_illness", "questions": [ {}, {} ] }, { "category": "present_illness", "questions": [ {}, {} ] } ], "pay_to_address": { "address1": "address1", "address2": "address2", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code" }, "place_of_service_code": "01", "prior_authorization_number": "prior_authorization_number", "property_casualty_claim_number": "property_casualty_claim_number", "property_casualty_patient_identifier": { "property_casualty_patient_identifier_qualifier": "1W", "property_casualty_patient_identifier": "property_casualty_patient_identifier" }, "provider_accepts_assignment": true, "purchased_service_provider_npi": "purchased_service_provider_npi", "referral_number": "referral_number", "referring_provider": { "address": { "address1": "address1", "address2": "address2", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code" }, "first_name": "first_name", "last_name": "last_name", "npi": "npi", "organization_name": "organization_name", "secondary_identification": { "reference_identification": "reference_identification", "reference_identification_qualifier": "0B" }, "taxonomy_code": "taxonomy_code", "qualifier": "DQ" }, "related_causes_information": { "related_causes_code_1": "AA", "related_causes_code_2": "AA", "state_or_province_code": "state_or_province_code" }, "rendering_provider": { "address": { "address1": "address1", "address2": "address2", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code" }, "first_name": "first_name", "last_name": "last_name", "npi": "npi", "organization_name": "organization_name", "secondary_identification": { "reference_identification": "reference_identification", "reference_identification_qualifier": "0B" }, "taxonomy_code": "taxonomy_code" }, "responsible_party": "INSURANCE_PAY", "schema_instances": [ { "schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "content": { "content": { "key": "value" } } }, { "schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "content": { "content": { "key": "value" } } } ], "secondary_payer_carrier_code": "secondary_payer_carrier_code", "service_authorization_exception_code": "1", "service_facility": { "organization_name": "organization_name", "npi": "npi", "address": { "address1": "address1", "address2": "address2", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code" }, "secondary_identification": "secondary_identification", "mammography_certification_number": "mammography_certification_number" }, "service_facility_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "service_lines": [ { "modifiers": [ "AV", "AV" ], "has_epsdt_indicator": true, "has_family_planning_indicator": true, "procedure_code": "procedure_code", "quantity": "quantity", "units": "MJ", "charge_amount_cents": 1, "diagnosis_pointers": [ 1, 1 ], "drug_identification": {}, "place_of_service_code": "01", "description": "description", "date_of_service": "2023-01-15", "end_date_of_service": "2023-01-15", "ordering_provider": {}, "test_results": [ {}, {} ], "note": "note", "revenue_code": "revenue_code", "prior_authorization_number": "prior_authorization_number", "external_id": "external_id" }, { "modifiers": [ "AV", "AV" ], "has_epsdt_indicator": true, "has_family_planning_indicator": true, "procedure_code": "procedure_code", "quantity": "quantity", "units": "MJ", "charge_amount_cents": 1, "diagnosis_pointers": [ 1, 1 ], "drug_identification": {}, "place_of_service_code": "01", "description": "description", "date_of_service": "2023-01-15", "end_date_of_service": "2023-01-15", "ordering_provider": {}, "test_results": [ {}, {} ], "note": "note", "revenue_code": "revenue_code", "prior_authorization_number": "prior_authorization_number", "external_id": "external_id" } ], "subscriber_primary": { "address": { "address1": "address1", "address2": "address2", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code" }, "date_of_birth": "2023-01-15", "first_name": "first_name", "gender": "male", "insurance_card": { "group_number": "group_number", "plan_name": "plan_name", "plan_type": "09", "insurance_type": "01", "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "payer_address": {}, "member_id": "member_id", "payer_name": "payer_name", "payer_id": "payer_id", "rx_bin": "rx_bin", "rx_pcn": "rx_pcn", "image_url_front": "image_url_front", "image_url_back": "image_url_back", "emr_payer_crosswalk": "HEALTHIE", "payer_plan_group_name": "payer_plan_group_name" }, "last_name": "last_name", "patient_relationship_to_subscriber_code": "01" }, "subscriber_secondary": { "address": { "address1": "address1", "address2": "address2", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code" }, "date_of_birth": "2023-01-15", "first_name": "first_name", "gender": "male", "insurance_card": { "group_number": "group_number", "plan_name": "plan_name", "plan_type": "09", "insurance_type": "01", "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "payer_address": {}, "member_id": "member_id", "payer_name": "payer_name", "payer_id": "payer_id", "rx_bin": "rx_bin", "rx_pcn": "rx_pcn", "image_url_front": "image_url_front", "image_url_back": "image_url_back", "emr_payer_crosswalk": "HEALTHIE", "payer_plan_group_name": "payer_plan_group_name" }, "last_name": "last_name", "patient_relationship_to_subscriber_code": "01" }, "subscriber_tertiary": { "address": { "address1": "address1", "address2": "address2", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code" }, "date_of_birth": "2023-01-15", "first_name": "first_name", "gender": "male", "insurance_card": { "group_number": "group_number", "plan_name": "plan_name", "plan_type": "09", "insurance_type": "01", "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "payer_address": {}, "member_id": "member_id", "payer_name": "payer_name", "payer_id": "payer_id", "rx_bin": "rx_bin", "rx_pcn": "rx_pcn", "image_url_front": "image_url_front", "image_url_back": "image_url_back", "emr_payer_crosswalk": "HEALTHIE", "payer_plan_group_name": "payer_plan_group_name" }, "last_name": "last_name", "patient_relationship_to_subscriber_code": "01" }, "supervising_provider": { "address": { "address1": "address1", "address2": "address2", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code" }, "first_name": "first_name", "last_name": "last_name", "npi": "npi", "organization_name": "organization_name", "secondary_identification": { "reference_identification": "reference_identification", "reference_identification_qualifier": "0B" }, "taxonomy_code": "taxonomy_code" }, "synchronicity": "Synchronous", "tag_ids": [ "tag_ids", "tag_ids" ], "vitals": { "height_in": 1, "weight_lbs": 1, "blood_pressure_systolic_mmhg": 1, "blood_pressure_diastolic_mmhg": 1, "body_temperature_f": 1.1, "hemoglobin_gdl": 1.1, "hematocrit_pct": 1.1 }, "external_claim_submission": { "claim_created_at": "2024-01-15T09:30:00Z", "patient_control_number": "patient_control_number", "submission_records": [ {}, {} ] }, "patient_authorized_release": true, "treating_provider": { "first_name": "first_name", "last_name": "last_name", "npi": "npi", "taxonomy_code": "taxonomy_code", "address": { "address1": "address1", "address2": "address2", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code" }, "license_type": "MD" } }, "most_recent_claim_preview_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" } ], "next_page_token": "next_page_token", "prev_page_token": "prev_page_token" } ``` **SDK Code** ```python import requests url = "https://api.joincandidhealth.com/api/charge_capture_claim_creation/v1" headers = {"Authorization": "."} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.joincandidhealth.com/api/charge_capture_claim_creation/v1'; const options = {method: 'GET', headers: {Authorization: '.'}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.joincandidhealth.com/api/charge_capture_claim_creation/v1" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", ".") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.joincandidhealth.com/api/charge_capture_claim_creation/v1") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = '.' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.joincandidhealth.com/api/charge_capture_claim_creation/v1") .header("Authorization", ".") .asString(); ``` ```php request('GET', 'https://api.joincandidhealth.com/api/charge_capture_claim_creation/v1', [ 'headers' => [ 'Authorization' => '.', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.joincandidhealth.com/api/charge_capture_claim_creation/v1"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "."); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "."] let request = NSMutableURLRequest(url: NSURL(string: "https://api.joincandidhealth.com/api/charge_capture_claim_creation/v1")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```