> 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 encounter GET https://api.joincandidhealth.com/api/encounters/v4/{encounter_id} Reference: https://docs.joincandidhealth.com/api-reference/encounters/v-4/get ## 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 ### Path parameters - `encounter_id` (UUID, required) ## Response ### 200 - `benefits_assigned_to_provider` (boolean, required) — 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, required) — 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_provider` (EncounterProvider, required) — 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. - `claims` (list of Claim, required) - `clinical_notes` (list of ClinicalNoteCategory, required) — 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. - `created_at` (datetime, required) — The date and time the encounter was created. - `diagnoses` (list of Diagnosis, required) — Contains the primary and other diagnosis health care code information objects associated with this encounter. For professional claims, these diagnoses correspond with those that are set on service lines directly, where as for institutional claims these are only associated directly with the claim itself. See also Health Care Code Information objects and corresponding apis. - `encounter_id` (UUID, required) - `external_id` (string, required) — 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. - `owner_of_next_action` (enum, required) — The party who is responsible for taking the next action on an Encounter, as defined by ownership of open Tasks. - Allowed values: `CANDID`, `CUSTOMER`, `CODER`, `NONE` - `patient` (Patient, required) — Contains the identification information of the individual receiving medical services. - `patient_authorized_release` (boolean, required) — 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. - `patient_histories` (list of PatientHistoryCategory, required) - `patient_payments` (list of PatientPayment, required) - `provider_accepts_assignment` (boolean, required) — 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. - `rendering_provider` (EncounterProvider, required) — 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, required) — Defines the party to be billed with the initial balance owed on the claim. - Allowed values: `INSURANCE_PAY`, `SELF_PAY`, `UNKNOWN` - `service_facility` (EncounterServiceFacility, required) — 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 - `submission_origin` (enum, required) — The party who originally submitted the Claim. For Claims originating in Candid, this will be EncounterSubmissionOriginType.CANDID. For Encounters created with an external_claim_submission object, this will be EncounterSubmissionOriginType.EXTERNAL. - Allowed values: `CANDID`, `EXTERNAL` - `tags` (list of Tag, required) - `url` (string, required) — URL that links directly to the claim created in Candid. - `schema_instances` (list of SchemaInstance, required) — 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. - `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"). - `billing_notes` (list of BillingNote, optional) — Spot to store misc, human-readable, notes about this encounter to be used in the billing process. - `claim_creation_id` (UUID, optional) — If the encounter was created from ingested charge captures, this is the associated Charge Capture Claim Creation Id. - `claim_supplemental_information` (list of ClaimSupplementalInformation, optional) — Refers to Loop 2300 - Segment PWK on the 837P and 837i form. No more than 10 entries are permitted. - `coding_attribution` (enum, optional) — The entity that performed the coding of medical services for the claim. - Allowed values: `CANDID`, `CUSTOMER`, `TCN`, `PJF` - `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. date_of_service must be defined on either the encounter or the service lines but not both. If there are greater than zero service lines, it is recommended to specify date_of_service on the service_line instead of on the encounter to prepare for future API versions. - `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` - `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 there are greater than zero service lines, it is recommended to specify end_date_of_service on the service_line instead of on the encounter to prepare for future API versions. - `epsdt_referral` (EPSDTReferral, 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 Medication, optional) - `guarantor` (Guarantor, optional) — Personal and contact info for the guarantor of the patient responsibility. - `initial_referring_provider` (EncounterProvider, optional) - `initial_treatment_date` (date, optional) — 837p Loop2300 DTP*454, CMS1500 Box 15 - `interventions` (list of Intervention, 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. This field is populated separately via occurrence codes for UB-04 claim forms. - `last_submitted_at` (datetime, optional) — The date and time the encounter was last submitted to a payer. - `next_responsible_party` (enum, optional) — The party (payer, patient, etc.) responsible for the remainder of the balance on the claim. - Allowed values: `primary`, `secondary`, `tertiary`, `patient`, `non_insurance`, `none` - `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. - `organization_id` (UUID, optional) - `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_control_number` (string, optional) — A patient control number (PCN) is a unique identifier assigned to a patient within a healthcare system or facility. It's used to track and manage a patient's medical records, treatments, and other healthcare-related information. - `pay_to_address` (StreetAddressLongZip, 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` - `place_of_service_code_as_submitted` (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` (PropertyCasualtyPatientIdentifier, optional) — Patient identifier for Property and Casualty claims. 837p Loop2010CA - `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` (EncounterProvider, optional) - `related_causes_information` (RelatedCausesInformation, optional) - `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` - `subscriber_primary` (Subscriber, optional) — Subscriber_primary is required when responsible_party is INSURANCE_PAY (i.e. when the claim should be billed to insurance). These are not required fields when responsible_party is SELF_PAY (i.e. when the claim should be billed to the patient). However, if you collect this for patients, even self-pay, we recommend including it when sending encounters to Candid. Note: Cash Pay is no longer a valid payer_id in v4, please use responsible party to define self-pay claims. - `subscriber_secondary` (Subscriber, optional) — Contains details of the secondary insurance subscriber. - `subscriber_tertiary` (Subscriber, optional) — Contains details of the tertiary insurance subscriber. - `supervising_provider` (EncounterProvider, optional) - `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` - `vitals` (Vitals, optional) - `work_queue_id` (string, optional) - `work_queue_membership_activated_at` (datetime, optional) - `accident_state_or_province_code` (enum, optional) — 837i-REF1000 -- an optional state indicating where an accident related to the encounter occurred. - 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` - `admission_hour` (integer, optional) — 837i Loop 2300 DTP-03 Extension of the admission date with hour (0-23) details. Required for institutional submission. - `admission_source_code` (enum, optional) — 837i Loop 2300 CLI1-02 Code used to indicate the conditions under which an admission occurs. Equivalent to Form Locator 15 Point of Origin on a UB-04 claim, not used on CMS-1500 claim forms. - Allowed values: `1`, `2`, `4`, `5`, `6`, `8`, `9`, `D`, `E`, `F`, `G` - `admission_type_code` (enum, optional) — 837i Loop 2300 CL1-01 Code used to indicate the priority of an admission or visit. Equivalent to Form Locator 14 Priority of Admission on a UB-04 claim, not used on CMS-1500 claim forms. - Allowed values: `1`, `2`, `3`, `4`, `5`, `9` - `attending_provider` (EncounterProvider, optional) — 837i NM1 2500 variant for Loop ID-2310. Used to indicate the individual whom has overall responsibility for the patient in institutional claims processing. - `discharge_hour` (integer, optional) — 837i Loop 2300 DTP-03 Extension of the discharge date with hour (0-23) details. - `discharge_status` (enum, optional) — 837i CL1-03 or Form Locator 17 on a UB-04 claim form. This is a required field on UB-04 claims. Code indicating patient status as of the "statement covers through date". - Allowed values: `01`, `02`, `03`, `04`, `05`, `06`, `07`, `09`, `20`, `21`, `30`, `40`, `41`, `42`, `43`, `50`, `51`, `61`, `62`, `63`, `64`, `65`, `66`, `69`, `70`, `81`, `82`, `83`, `84`, `85`, `86`, `87`, `88`, `89`, `90`, `91`, `92`, `93`, `94`, `95` - `operating_provider` (EncounterProvider, optional) — 837i NM1 2500 variant for Loop ID-2310. Used to indicate the individual whom has primary responsibility for surgical procedures in institutional claims processing. - `other_operating_provider` (EncounterProvider, optional) — 837i NM1 2500 variant for Loop ID-2310. Used to indicate the individual whom has secondary responsibility for surgical procedures in institutional claims processing. Only used when operating_provider is also set. - `submission_expectation` (enum, optional) — Describes the currently expected target form for this encounter. This affects what validations and queues the form is processed under. When this value is not set, it should be assumed to be TARGET_PROFESSIONAL. - Allowed values: `TARGET_PROFESSIONAL`, `TARGET_INSTITUTIONAL` - `treating_provider` (EncounterAdditionalProvider, optional) — The treating provider is the provider who treats the patient. This is only supported for professional encounters. - `type_of_bill` (TypeOfBillComposite, optional) — Four digit code used in institutional forms to indicate the type of bill (e.g., hospital inpatient, hospital outpatient). First digit is a leading 0, followed by the type_of_facility, type_of_care, then frequency_code. Professional forms are not required to submit this attribute. You may send the 4 digit code via raw_code, or each individual digit separately via composite_codes. ## Types ### EncounterProvider - `address` (StreetAddressLongZip, required) - `npi` (string, required) - `provider_id` (UUID, required) - `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 - `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` - `qualifier` (enum, optional) - Allowed values: `DQ`, `DN`, `DK`, `P3` - `secondary_identification` (ProviderSecondaryIdentification, optional) — Only one of provider_commercial_license_type or secondary_identification may be provided 837i Loop2010BB G2 Secondary Identification - `tax_id` (string, optional) - `taxonomy_code` (string, optional) ### Claim - `claim_id` (UUID, required) - `status` (enum, required) - 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` - `service_lines` (list of ServiceLine, required) - `eras` (list of ERA, required) - `clearinghouse` (string, optional) - `clearinghouse_claim_id` (string, optional) - `payer_claim_id` (string, optional) - `clia_number` (string, optional) ### ClinicalNoteCategory - `category` (enum, required) - 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 string, required) - `notes_structured` (list of ClinicalNote, optional) ### Diagnosis - `code` (string, required) — 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 - `code_type` (enum, required) — 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` - `created_at` (datetime, required) - `diagnosis_id` (UUID, required) - `encounter_id` (UUID, required) - `updated_at` (datetime, required) - `name` (string, optional) — Empty string not allowed. - `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` ### Patient - `address` (StreetAddressShortZip, required) — Box 5 on the CMS-1500 claim form or Form Locator 9 on a UB-04 claim form. - `auto_charge_consent` (boolean, required) - `date_of_birth` (date, required) — 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) - `email_consent` (boolean, required) - `external_id` (string, required) — The ID used to identify this individual in your system. For example, your internal patient ID or an EHR patient ID. - `first_name` (string, required) - `gender` (enum, required) - Allowed values: `male`, `female`, `other`, `not_given`, `unknown` - `individual_id` (UUID, required) - `last_name` (string, required) - `non_insurance_payers_info` (list of PatientNonInsurancePayerInfo, required) - `phone_consent` (boolean, required) - `phone_numbers` (list of PhoneNumber, required) - `non_insurance_payers` (list of NonInsurancePayer, required, deprecated) - `email` (string, optional) ### PatientHistoryCategory - `category` (enum, required) - Allowed values: `present_illness`, `medical`, `family`, `social` - `questions` (list of IntakeQuestion, required) — Must contain at least one item. ### PatientPayment - `patient_payment_id` (string, required) - `organization_id` (UUID, required) - `source_internal_id` (string, required) - `source` (enum, required) - Allowed values: `MANUAL_ENTRY`, `CHARGEBEE_PAYMENTS`, `CHARGEBEE MANUALLY VOIDED BY CANDID`, `CHARGEBEE_REFUNDS`, `SQUARE_REFUNDS`, `SQUARE_PAYMENTS`, `STRIPE_CHARGES`, `STRIPE_REFUNDS`, `ELATION_PAYMENTS` - `amount_cents` (integer, required) - `payment_timestamp` (datetime, optional) - `status` (enum, optional) - Allowed values: `PENDING`, `paid`, `CANCELED`, `voided`, `FAILED`, `COMPLETED`, `succeeded`, `pending`, `failed`, `requires_action`, `canceled` - `payment_name` (string, optional) - `payment_note` (string, optional) - `patient_external_id` (string, optional) - `encounter_external_id` (string, optional) - `service_line_id` (UUID, optional) ### EncounterServiceFacility - `service_facility_id` (UUID, required) - `organization_name` (string, required) - `address` (StreetAddressLongZip, required) — 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. - `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. - `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. ### Tag - `color` (enum, required) - Allowed values: `black`, `white`, `gray`, `red`, `yellow`, `green`, `blue`, `indigo`, `purple`, `pink` - `creator_id` (string, required) - `description` (string, required) - `tag_id` (string, required) ### SchemaInstance - `schema_id` (UUID, required) — The schema to which the content must adhere. - `content` (map from string to any, required) — 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. ### BillingNote - `billing_note_id` (UUID, required) - `created_at` (datetime, required) — An [RFC 3339, section 5.6 datetime](https://ijmacd.github.io/rfc3339-iso8601/). For example, 2017-07-21T17:32:28Z. - `encounter_id` (UUID, required) - `text` (string, required) — Empty string not allowed. - `author_auth0_id` (string, optional) - `author_name` (string, optional) - `billing_note_metadata` (BillingNoteMetadata, optional) - `billing_note_type` (enum, optional) - Allowed values: `manual`, `system`, `queue_added`, `queue_moved`, `task_created` ### ClaimSupplementalInformation - `attachment_report_type_code` (enum, required) - 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, required) - Allowed values: `AA`, `BM`, `EL`, `FX` - `attachment_control_number` (string, optional) ### EPSDTReferral - `condition_indicator1` (enum, required) - 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` ### Medication - `name` (string, required) - `rx_cui` (string, optional) - `dosage` (string, optional) - `dosage_form` (string, optional) - `frequency` (string, optional) - `as_needed` (boolean, optional) ### Guarantor - `address` (StreetAddressShortZip, required) - `auto_charge_consent` (boolean, required) - `email_consent` (boolean, required) - `external_id` (string, required) - `first_name` (string, required) - `guarantor_id` (UUID, required) - `last_name` (string, required) - `phone_consent` (boolean, required) - `phone_numbers` (list of PhoneNumber, required) - `date_of_birth` (date, optional) - `email` (string, optional) ### Intervention - `name` (string, required) - `category` (enum, required) - Allowed values: `allopathic`, `naturopathic`, `tests`, `lifestyle` - `description` (string, optional) — "Examples: 'Birth Control LAC', 'Tracking', 'Stress Management', 'Supplement', 'Labs'" - `medication` (Medication, optional) — Required when `type` is `allopathic`. - `labs` (list of Lab, optional) — Required when `type` is `tests`. ### StreetAddressLongZip - `address1` (string, required) - `city` (string, required) - `state` (enum, required) - 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, required) — 5-digit zip code - `zip_plus_four_code` (string, required) — 4-digit zip add-on code https://en.wikipedia.org/wiki/ZIP_Code#ZIP+4 - `address2` (string, optional) ### PropertyCasualtyPatientIdentifier - `property_casualty_patient_identifier_qualifier` (enum, required) — 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, required) — Represents REF02 on the EDI 837 Loop 2010CA Property and Casualty Patient Identifier segment. Value cannot exceed 50 characters ### RelatedCausesInformation - `related_causes_code_1` (enum, required) - 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) ### Subscriber - `first_name` (string, required) - `gender` (enum, required) - Allowed values: `male`, `female`, `other`, `not_given`, `unknown` - `individual_id` (UUID, required) - `insurance_card` (InsuranceCard, required) - `last_name` (string, required) - `patient_relationship_to_subscriber_code` (enum, required) - 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` - `address` (StreetAddressShortZip, optional) - `date_of_birth` (date, optional) ### Vitals - `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) ### EncounterAdditionalProvider A lighter-weight provider type with optional NPI. Used for treating providers and other additional provider roles that may not have full NPI credentials. - `provider_id` (UUID, required) - `first_name` (string, required) - `last_name` (string, required) - `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` (StreetAddressLongZip, optional) - `tax_id` (string, optional) - `license_type` (enum, optional) — The license type of the 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` ### TypeOfBillComposite - `code` (string, required) — The composite, 4 digit code of the composite, starting with a padding code 0. - `frequency_code` (enum, required) — The FL04 Institutional frequency code for the bill. The fourth digit of the composite code. - 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` - `type_of_care` (enum, required) — The FL04 Institutional type of care code for the bill. The third digit of the composite code. - Allowed values: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9` - `type_of_facility` (enum, required) — The FL04 Institutional type of facility code for the bill. The second digit of the composite code. - Allowed values: `1`, `2`, `3`, `4`, `6`, `7`, `8` ### ProviderSecondaryIdentification - `reference_identification` (string, required) — 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` ### ServiceLine - `created_at` (datetime, required) - `service_line_id` (UUID, required) - `procedure_code` (string, required) - `quantity` (string, required) — 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, required) - Allowed values: `MJ`, `UN` - `claim_id` (UUID, required) - `date_of_service_range` (DateRangeOptionalEnd, required) — A range of dates of service for this service line. If the service line is for a single date, the end date will be empty. - `date_of_service` (date, required) - `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` - `charge_amount_cents` (integer, optional) - `allowed_amount_cents` (integer, optional) - `insurance_balance_cents` (integer, optional) - `patient_balance_cents` (integer, optional) - `paid_amount_cents` (integer, optional) - `primary_paid_amount_cents` (integer, optional) - `secondary_paid_amount_cents` (integer, optional) - `tertiary_paid_amount_cents` (integer, optional) - `patient_responsibility_cents` (integer, optional) - `copay_cents` (integer, optional) - `coinsurance_cents` (integer, optional) - `deductible_cents` (integer, optional) - `diagnosis_id_zero` (UUID, optional) - `diagnosis_id_one` (UUID, optional) - `diagnosis_id_two` (UUID, optional) - `diagnosis_id_three` (UUID, optional) - `drug_identification` (DrugIdentification, optional) - `service_line_era_data` (ServiceLineERAData, optional) - `service_line_manual_adjustments` (list of ServiceLineAdjustment, optional) - `related_invoices` (list of Invoice, optional) - `related_invoice_info` (list of InvoiceInfo, optional) - `denial_reason` (ServiceLineDenialReason, optional) — The reason a given service line was denied within a given time range. A service line may be denied for different reasons over time, but only one reason at a time. - `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` - `place_of_service_code_as_submitted` (enum, optional) — 837p Loop2300, SV105. 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` - `custom_procedure_code` (string, optional) — Represents and preserves the custom CPT code received on this service line. Custom CPT codes are specific to your organization and are used for rules and reporting purposes. - `ordering_provider` (EncounterProvider, optional) - `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). - `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. - `end_date_of_service` (date, optional) - `test_results` (list of TestResult, 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. - `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. - `note` (string, optional) — Maps to NTE02 loop 2400 on the EDI 837. - `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. ### ERA - `check_date` (string, required) — ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01) - `check_number` (string, required) - `era_id` (UUID, required) ### ClinicalNote - `text` (string, required) - `author_name` (string, required) - `timestamp` (datetime, required) - `author_npi` (string, optional) ### StreetAddressShortZip - `address1` (string, required) - `city` (string, required) - `state` (enum, required) - 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, required) — 5-digit zip code - `address2` (string, optional) - `zip_plus_four_code` (string, optional) — 4-digit zip add-on code https://en.wikipedia.org/wiki/ZIP_Code#ZIP+4 ### PatientNonInsurancePayerInfo - `non_insurance_payer` (NonInsurancePayer, required) - `clinical_trial_info` (list of PatientClinicalTrialInfo, required) — A patient cannot be associated with a given trial more than once - `member_id` (string, optional) ### PhoneNumber - `number` (string, required) - `type` (enum, required) - Allowed values: `Home`, `Mobile`, `Work` ### NonInsurancePayer - `non_insurance_payer_id` (UUID, required) - `name` (string, required) - `enabled` (boolean, required) - `clinical_trials` (list of ClinicalTrial, required) - `description` (string, optional) - `category` (string, optional) - `payer_id` (string, optional) — The identifier used to route claims to this payer. Required in order to submit an 837 to this payer. Must be between 2 and 80 characters. - `address` (StreetAddressShortZip, optional) ### IntakeQuestion - `id` (string, required) - `text` (string, required) - `responses` (list of IntakeResponseAndFollowUps, optional) ### BillingNoteMetadata - `type`: `queue_added` - `queue_id` (string, required) - `queue_name` (string, required) - `type`: `queue_moved` - `from_queue_id` (string, required) - `from_queue_name` (string, required) - `to_queue_id` (string, required) - `to_queue_name` (string, required) - `type`: `task_created` - `task_id` (UUID, required) - `task_type` (string, required) ### Lab - `name` (string, required) - `code` (string, optional) - `code_type` (enum, optional) - Allowed values: `quest`, `labcorp` ### InsuranceCard - `insurance_card_id` (UUID, required) - `member_id` (string, required) - `payer_id` (string, required) - `payer_name` (string, required) - `group_number` (string, optional) — Box 11 on the CMS-1500 claim form. - `image_url_back` (string, optional) - `image_url_front` (string, optional) - `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_address` (StreetAddressLongZip, optional) - `payer_plan_group_id` (UUID, optional) - `payer_uuid` (UUID, optional) - `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` - `rx_bin` (string, optional) - `rx_pcn` (string, optional) ### DateRangeOptionalEnd - `start_date` (string, required) — ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01) - `end_date` (string, optional) — ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01) ### DrugIdentification - `service_id_qualifier` (enum, required) - Allowed values: `EN`, `EO`, `HI`, `N4`, `ON`, `UK`, `UP` - `national_drug_code` (string, required) - `national_drug_unit_count` (string, required) - `measurement_unit_code` (enum, required) - 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) ### ServiceLineERAData - `remittance_advice_remark_codes` (list of string, required) - `service_line_adjustments` (list of ServiceLineAdjustment, required, deprecated) — Deprecated. This field aggregates all CARCs across a service line's history without granular context (e.g., which CARCs relate to denials vs. payments vs. reversals), making it unsuitable for denial analysis or operational workflows. ### ServiceLineAdjustment - `created_at` (datetime, required) - `adjustment_group_code` (string, optional) - `adjustment_reason_code` (string, optional) - `adjustment_amount_cents` (integer, optional) - `adjustment_note` (string, optional) ### Invoice - `id` (UUID, required) - `created_at` (datetime, required) - `updated_at` (datetime, required) - `organzation_id` (UUID, required) - `source_id` (string, required) - `source_customer_id` (string, required) - `patient_external_id` (string, required) - `due_date` (string, required) — ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01) - `status` (enum, required) - Allowed values: `draft`, `open`, `paid`, `void`, `uncollectible`, `held` - `items` (list of InvoiceItem, required) - `note` (string, optional) - `url` (string, optional) - `customer_invoice_url` (string, optional) ### InvoiceInfo - `id` (UUID, required) - `invoice` (Invoice, required) - `invoice_type` (enum, required) - Allowed values: `STRIPE`, `CEDAR`, `HEALTHIE`, `COLLECTLY`, `THIRD_PARTY_PAYERS`, `INSTAMED`, `REVSPRING` ### ServiceLineDenialReason The reason a given service line was denied within a given time range. A service line may be denied for different reasons over time, but only one reason at a time. - `reason` (enum, optional) — Text of the denial reason - Allowed values: `Authorization Required`, `Referral Required`, `Medical Records Requested`, `Timely Filing`, `Duplicate Claim`, `Full Contractual Adjustment`, `Incorrect Place of Service`, `Incorrect Patient Gender`, `Incorrect Patient Info`, `Bundled`, `Exceeded Billable Time`, `Invalid Provider Information`, `Invalid Diagnosis Code`, `Incorrect Procedure Code`, `Invalid Modifier`, `Missing NDC Code`, `Invalid Insurance Data`, `No Active Coverage`, `Coordination of Benefits`, `Incorrect Payer`, `Credentialing`, `No Effective Contract`, `Missing W-9`, `Missing Contract Linkage`, `Non-Covered Benefit`, `Experimental Procedure`, `Not Medically Necessary`, `Info Requested from Provider`, `Info Requested from Patient`, `Billing Error`, `Unknown`, `Max Benefit Reached` ### TestResult - `value` (double, required) - `result_type` (enum, required) - Allowed values: `HEMATOCRIT`, `HEMOGLOBIN`, `LDL`, `VITAMIN_D` ### PatientClinicalTrialInfo - `clinical_trial` (ClinicalTrial, required) - `clinical_trial_arm` (string, optional) ### ClinicalTrial - `clinical_trial_id` (UUID, required) - `clinical_trial_number` (string, required) — Must be 8 characters long - `is_active` (boolean, required) - `name` (string, required) - `non_insurance_payer_id` (UUID, required) - `clinical_trial_phase` (enum, optional) - Allowed values: `Phase 1`, `Phase 2`, `Phase 3` ### IntakeResponseAndFollowUps - `response` (string, optional) - `follow_ups` (list of IntakeFollowUp, optional) ### InvoiceItem - `service_line_id` (UUID, required) - `amount_cents` (integer, required) ### Invoice - `amount_cents` (integer, required) — Total monetary amount (in cents) of all Invoice Items - `created_at` (datetime, required) - `updated_at` (datetime, required) - `organization_id` (UUID, required) - `invoice_destination_metadata` (InvoiceDestinationMetadata, required) — Contains all relevant information from the third-party service this invoice was created in - `patient_external_id` (string, required) - `due_date` (date, required) - `status` (enum, required) - Allowed values: `DRAFT`, `OPEN`, `PAID`, `VOID`, `UNCOLLECTIBLE`, `HELD` - `items` (InvoiceItemInfo, required) — The InvoiceItem rollup which contains all claim and service line invoice items - `note` (string, optional) - `url` (string, optional) — Link to the admin view of the invoice in the third-party service - `customer_invoice_url` (string, optional) — Link to the patient view of the invoice in the third-party service ### IntakeFollowUp - `id` (string, required) - `text` (string, required) - `response` (string, optional) ### InvoiceDestinationMetadata - `invoice_destination` (enum, required) — Defines which third-party service this invoice was created in - Allowed values: `STRIPE`, `CEDAR`, `HEALTHIE`, `COLLECTLY`, `THIRD_PARTY_PAYERS`, `INSTAMED`, `REVSPRING` - `source_id` (string, required) — The id of the invoice in the third-party service - `source_customer_id` (string, required) — The id of the customer that the invoice is attributed to in the third-party service - `destination_status` (string, optional) — The status of the invoice in the third-party service ### InvoiceItemInfo - `claim_invoice_items` (map from UUID to ClaimInvoiceItemInfo, required) - `unattributed_items` (list of UnattributedInvoiceItem, required) ### ClaimInvoiceItemInfo - `service_line_invoice_items` (map from UUID to ServiceLineInvoiceItem, required) - `claim_invoice_item` (ClaimInvoiceItem, optional) ### UnattributedInvoiceItem - `amount_cents` (integer, required) ### ServiceLineInvoiceItem - `service_line_id` (UUID, required) - `amount_cents` (integer, required) ### ClaimInvoiceItem - `claim_id` (UUID, required) - `amount_cents` (integer, required) ## Examples **Response** ```json { "benefits_assigned_to_provider": true, "billable_status": "BILLABLE", "billing_provider": { "address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code", "address2": "address2" }, "npi": "npi", "provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "first_name": "first_name", "last_name": "last_name", "organization_name": "organization_name", "provider_commercial_license_type": "0", "qualifier": "DQ", "secondary_identification": { "reference_identification": "reference_identification", "reference_identification_qualifier": "0B" }, "tax_id": "tax_id", "taxonomy_code": "taxonomy_code" }, "claims": [ { "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "status": "biller_received", "service_lines": [ { "created_at": "2024-01-15T09:30:00Z", "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "procedure_code": "procedure_code", "quantity": "quantity", "units": "MJ", "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "date_of_service_range": { "start_date": "start_date", "end_date": "end_date" }, "date_of_service": "2023-01-15", "modifiers": [ "AV", "AV" ], "charge_amount_cents": 1, "allowed_amount_cents": 1, "insurance_balance_cents": 1, "patient_balance_cents": 1, "paid_amount_cents": 1, "primary_paid_amount_cents": 1, "secondary_paid_amount_cents": 1, "tertiary_paid_amount_cents": 1, "patient_responsibility_cents": 1, "copay_cents": 1, "coinsurance_cents": 1, "deductible_cents": 1, "diagnosis_id_zero": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "diagnosis_id_one": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "diagnosis_id_two": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "diagnosis_id_three": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "drug_identification": { "service_id_qualifier": "EN", "national_drug_code": "national_drug_code", "national_drug_unit_count": "national_drug_unit_count", "measurement_unit_code": "ML", "link_sequence_number": "link_sequence_number", "pharmacy_prescription_number": "pharmacy_prescription_number", "conversion_formula": "conversion_formula", "drug_description": "drug_description" }, "service_line_era_data": { "remittance_advice_remark_codes": [ "remittance_advice_remark_codes", "remittance_advice_remark_codes" ], "service_line_adjustments": [ { "created_at": "2024-01-15T09:30:00Z", "adjustment_group_code": "adjustment_group_code", "adjustment_reason_code": "adjustment_reason_code", "adjustment_amount_cents": 1, "adjustment_note": "adjustment_note" }, { "created_at": "2024-01-15T09:30:00Z", "adjustment_group_code": "adjustment_group_code", "adjustment_reason_code": "adjustment_reason_code", "adjustment_amount_cents": 1, "adjustment_note": "adjustment_note" } ] }, "service_line_manual_adjustments": [ { "created_at": "2024-01-15T09:30:00Z", "adjustment_group_code": "adjustment_group_code", "adjustment_reason_code": "adjustment_reason_code", "adjustment_amount_cents": 1, "adjustment_note": "adjustment_note" }, { "created_at": "2024-01-15T09:30:00Z", "adjustment_group_code": "adjustment_group_code", "adjustment_reason_code": "adjustment_reason_code", "adjustment_amount_cents": 1, "adjustment_note": "adjustment_note" } ], "related_invoices": [ { "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "created_at": "2024-01-15T09:30:00Z", "updated_at": "2024-01-15T09:30:00Z", "organzation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "source_id": "source_id", "source_customer_id": "source_customer_id", "patient_external_id": "patient_external_id", "due_date": "due_date", "status": "draft", "items": [ { "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "amount_cents": 1 }, { "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "amount_cents": 1 } ], "note": "note", "url": "url", "customer_invoice_url": "customer_invoice_url" }, { "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "created_at": "2024-01-15T09:30:00Z", "updated_at": "2024-01-15T09:30:00Z", "organzation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "source_id": "source_id", "source_customer_id": "source_customer_id", "patient_external_id": "patient_external_id", "due_date": "due_date", "status": "draft", "items": [ { "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "amount_cents": 1 }, { "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "amount_cents": 1 } ], "note": "note", "url": "url", "customer_invoice_url": "customer_invoice_url" } ], "related_invoice_info": [ { "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "invoice": { "amount_cents": 1, "created_at": "2024-01-15T09:30:00Z", "updated_at": "2024-01-15T09:30:00Z", "organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "invoice_destination_metadata": { "invoice_destination": "STRIPE", "source_id": "source_id", "source_customer_id": "source_customer_id" }, "patient_external_id": "patient_external_id", "due_date": "2023-01-15", "status": "DRAFT", "items": { "claim_invoice_items": {}, "unattributed_items": [] }, "note": "note", "url": "url", "customer_invoice_url": "customer_invoice_url" }, "invoice_type": "STRIPE" }, { "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "invoice": { "amount_cents": 1, "created_at": "2024-01-15T09:30:00Z", "updated_at": "2024-01-15T09:30:00Z", "organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "invoice_destination_metadata": { "invoice_destination": "STRIPE", "source_id": "source_id", "source_customer_id": "source_customer_id" }, "patient_external_id": "patient_external_id", "due_date": "2023-01-15", "status": "DRAFT", "items": { "claim_invoice_items": {}, "unattributed_items": [] }, "note": "note", "url": "url", "customer_invoice_url": "customer_invoice_url" }, "invoice_type": "STRIPE" } ], "denial_reason": { "reason": "Authorization Required" }, "place_of_service_code": "01", "place_of_service_code_as_submitted": "01", "custom_procedure_code": "custom_procedure_code", "ordering_provider": { "address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code", "address2": "address2" }, "npi": "npi", "provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "first_name": "first_name", "last_name": "last_name", "organization_name": "organization_name", "provider_commercial_license_type": "0", "qualifier": "DQ", "secondary_identification": { "reference_identification": "reference_identification", "reference_identification_qualifier": "0B" }, "tax_id": "tax_id", "taxonomy_code": "taxonomy_code" }, "revenue_code": "revenue_code", "description": "description", "end_date_of_service": "2023-01-15", "test_results": [ { "value": 1.1, "result_type": "HEMATOCRIT" }, { "value": 1.1, "result_type": "HEMATOCRIT" } ], "has_epsdt_indicator": true, "has_family_planning_indicator": true, "note": "note", "prior_authorization_number": "prior_authorization_number", "external_id": "external_id" }, { "created_at": "2024-01-15T09:30:00Z", "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "procedure_code": "procedure_code", "quantity": "quantity", "units": "MJ", "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "date_of_service_range": { "start_date": "start_date", "end_date": "end_date" }, "date_of_service": "2023-01-15", "modifiers": [ "AV", "AV" ], "charge_amount_cents": 1, "allowed_amount_cents": 1, "insurance_balance_cents": 1, "patient_balance_cents": 1, "paid_amount_cents": 1, "primary_paid_amount_cents": 1, "secondary_paid_amount_cents": 1, "tertiary_paid_amount_cents": 1, "patient_responsibility_cents": 1, "copay_cents": 1, "coinsurance_cents": 1, "deductible_cents": 1, "diagnosis_id_zero": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "diagnosis_id_one": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "diagnosis_id_two": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "diagnosis_id_three": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "drug_identification": { "service_id_qualifier": "EN", "national_drug_code": "national_drug_code", "national_drug_unit_count": "national_drug_unit_count", "measurement_unit_code": "ML", "link_sequence_number": "link_sequence_number", "pharmacy_prescription_number": "pharmacy_prescription_number", "conversion_formula": "conversion_formula", "drug_description": "drug_description" }, "service_line_era_data": { "remittance_advice_remark_codes": [ "remittance_advice_remark_codes", "remittance_advice_remark_codes" ], "service_line_adjustments": [ { "created_at": "2024-01-15T09:30:00Z", "adjustment_group_code": "adjustment_group_code", "adjustment_reason_code": "adjustment_reason_code", "adjustment_amount_cents": 1, "adjustment_note": "adjustment_note" }, { "created_at": "2024-01-15T09:30:00Z", "adjustment_group_code": "adjustment_group_code", "adjustment_reason_code": "adjustment_reason_code", "adjustment_amount_cents": 1, "adjustment_note": "adjustment_note" } ] }, "service_line_manual_adjustments": [ { "created_at": "2024-01-15T09:30:00Z", "adjustment_group_code": "adjustment_group_code", "adjustment_reason_code": "adjustment_reason_code", "adjustment_amount_cents": 1, "adjustment_note": "adjustment_note" }, { "created_at": "2024-01-15T09:30:00Z", "adjustment_group_code": "adjustment_group_code", "adjustment_reason_code": "adjustment_reason_code", "adjustment_amount_cents": 1, "adjustment_note": "adjustment_note" } ], "related_invoices": [ { "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "created_at": "2024-01-15T09:30:00Z", "updated_at": "2024-01-15T09:30:00Z", "organzation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "source_id": "source_id", "source_customer_id": "source_customer_id", "patient_external_id": "patient_external_id", "due_date": "due_date", "status": "draft", "items": [ { "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "amount_cents": 1 }, { "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "amount_cents": 1 } ], "note": "note", "url": "url", "customer_invoice_url": "customer_invoice_url" }, { "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "created_at": "2024-01-15T09:30:00Z", "updated_at": "2024-01-15T09:30:00Z", "organzation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "source_id": "source_id", "source_customer_id": "source_customer_id", "patient_external_id": "patient_external_id", "due_date": "due_date", "status": "draft", "items": [ { "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "amount_cents": 1 }, { "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "amount_cents": 1 } ], "note": "note", "url": "url", "customer_invoice_url": "customer_invoice_url" } ], "related_invoice_info": [ { "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "invoice": { "amount_cents": 1, "created_at": "2024-01-15T09:30:00Z", "updated_at": "2024-01-15T09:30:00Z", "organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "invoice_destination_metadata": { "invoice_destination": "STRIPE", "source_id": "source_id", "source_customer_id": "source_customer_id" }, "patient_external_id": "patient_external_id", "due_date": "2023-01-15", "status": "DRAFT", "items": { "claim_invoice_items": {}, "unattributed_items": [] }, "note": "note", "url": "url", "customer_invoice_url": "customer_invoice_url" }, "invoice_type": "STRIPE" }, { "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "invoice": { "amount_cents": 1, "created_at": "2024-01-15T09:30:00Z", "updated_at": "2024-01-15T09:30:00Z", "organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "invoice_destination_metadata": { "invoice_destination": "STRIPE", "source_id": "source_id", "source_customer_id": "source_customer_id" }, "patient_external_id": "patient_external_id", "due_date": "2023-01-15", "status": "DRAFT", "items": { "claim_invoice_items": {}, "unattributed_items": [] }, "note": "note", "url": "url", "customer_invoice_url": "customer_invoice_url" }, "invoice_type": "STRIPE" } ], "denial_reason": { "reason": "Authorization Required" }, "place_of_service_code": "01", "place_of_service_code_as_submitted": "01", "custom_procedure_code": "custom_procedure_code", "ordering_provider": { "address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code", "address2": "address2" }, "npi": "npi", "provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "first_name": "first_name", "last_name": "last_name", "organization_name": "organization_name", "provider_commercial_license_type": "0", "qualifier": "DQ", "secondary_identification": { "reference_identification": "reference_identification", "reference_identification_qualifier": "0B" }, "tax_id": "tax_id", "taxonomy_code": "taxonomy_code" }, "revenue_code": "revenue_code", "description": "description", "end_date_of_service": "2023-01-15", "test_results": [ { "value": 1.1, "result_type": "HEMATOCRIT" }, { "value": 1.1, "result_type": "HEMATOCRIT" } ], "has_epsdt_indicator": true, "has_family_planning_indicator": true, "note": "note", "prior_authorization_number": "prior_authorization_number", "external_id": "external_id" } ], "eras": [ { "check_date": "check_date", "check_number": "check_number", "era_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, { "check_date": "check_date", "check_number": "check_number", "era_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" } ], "clearinghouse": "clearinghouse", "clearinghouse_claim_id": "clearinghouse_claim_id", "payer_claim_id": "payer_claim_id", "clia_number": "clia_number" }, { "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "status": "biller_received", "service_lines": [ { "created_at": "2024-01-15T09:30:00Z", "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "procedure_code": "procedure_code", "quantity": "quantity", "units": "MJ", "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "date_of_service_range": { "start_date": "start_date", "end_date": "end_date" }, "date_of_service": "2023-01-15", "modifiers": [ "AV", "AV" ], "charge_amount_cents": 1, "allowed_amount_cents": 1, "insurance_balance_cents": 1, "patient_balance_cents": 1, "paid_amount_cents": 1, "primary_paid_amount_cents": 1, "secondary_paid_amount_cents": 1, "tertiary_paid_amount_cents": 1, "patient_responsibility_cents": 1, "copay_cents": 1, "coinsurance_cents": 1, "deductible_cents": 1, "diagnosis_id_zero": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "diagnosis_id_one": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "diagnosis_id_two": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "diagnosis_id_three": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "drug_identification": { "service_id_qualifier": "EN", "national_drug_code": "national_drug_code", "national_drug_unit_count": "national_drug_unit_count", "measurement_unit_code": "ML", "link_sequence_number": "link_sequence_number", "pharmacy_prescription_number": "pharmacy_prescription_number", "conversion_formula": "conversion_formula", "drug_description": "drug_description" }, "service_line_era_data": { "remittance_advice_remark_codes": [ "remittance_advice_remark_codes", "remittance_advice_remark_codes" ], "service_line_adjustments": [ { "created_at": "2024-01-15T09:30:00Z", "adjustment_group_code": "adjustment_group_code", "adjustment_reason_code": "adjustment_reason_code", "adjustment_amount_cents": 1, "adjustment_note": "adjustment_note" }, { "created_at": "2024-01-15T09:30:00Z", "adjustment_group_code": "adjustment_group_code", "adjustment_reason_code": "adjustment_reason_code", "adjustment_amount_cents": 1, "adjustment_note": "adjustment_note" } ] }, "service_line_manual_adjustments": [ { "created_at": "2024-01-15T09:30:00Z", "adjustment_group_code": "adjustment_group_code", "adjustment_reason_code": "adjustment_reason_code", "adjustment_amount_cents": 1, "adjustment_note": "adjustment_note" }, { "created_at": "2024-01-15T09:30:00Z", "adjustment_group_code": "adjustment_group_code", "adjustment_reason_code": "adjustment_reason_code", "adjustment_amount_cents": 1, "adjustment_note": "adjustment_note" } ], "related_invoices": [ { "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "created_at": "2024-01-15T09:30:00Z", "updated_at": "2024-01-15T09:30:00Z", "organzation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "source_id": "source_id", "source_customer_id": "source_customer_id", "patient_external_id": "patient_external_id", "due_date": "due_date", "status": "draft", "items": [ { "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "amount_cents": 1 }, { "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "amount_cents": 1 } ], "note": "note", "url": "url", "customer_invoice_url": "customer_invoice_url" }, { "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "created_at": "2024-01-15T09:30:00Z", "updated_at": "2024-01-15T09:30:00Z", "organzation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "source_id": "source_id", "source_customer_id": "source_customer_id", "patient_external_id": "patient_external_id", "due_date": "due_date", "status": "draft", "items": [ { "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "amount_cents": 1 }, { "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "amount_cents": 1 } ], "note": "note", "url": "url", "customer_invoice_url": "customer_invoice_url" } ], "related_invoice_info": [ { "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "invoice": { "amount_cents": 1, "created_at": "2024-01-15T09:30:00Z", "updated_at": "2024-01-15T09:30:00Z", "organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "invoice_destination_metadata": { "invoice_destination": "STRIPE", "source_id": "source_id", "source_customer_id": "source_customer_id" }, "patient_external_id": "patient_external_id", "due_date": "2023-01-15", "status": "DRAFT", "items": { "claim_invoice_items": {}, "unattributed_items": [] }, "note": "note", "url": "url", "customer_invoice_url": "customer_invoice_url" }, "invoice_type": "STRIPE" }, { "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "invoice": { "amount_cents": 1, "created_at": "2024-01-15T09:30:00Z", "updated_at": "2024-01-15T09:30:00Z", "organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "invoice_destination_metadata": { "invoice_destination": "STRIPE", "source_id": "source_id", "source_customer_id": "source_customer_id" }, "patient_external_id": "patient_external_id", "due_date": "2023-01-15", "status": "DRAFT", "items": { "claim_invoice_items": {}, "unattributed_items": [] }, "note": "note", "url": "url", "customer_invoice_url": "customer_invoice_url" }, "invoice_type": "STRIPE" } ], "denial_reason": { "reason": "Authorization Required" }, "place_of_service_code": "01", "place_of_service_code_as_submitted": "01", "custom_procedure_code": "custom_procedure_code", "ordering_provider": { "address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code", "address2": "address2" }, "npi": "npi", "provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "first_name": "first_name", "last_name": "last_name", "organization_name": "organization_name", "provider_commercial_license_type": "0", "qualifier": "DQ", "secondary_identification": { "reference_identification": "reference_identification", "reference_identification_qualifier": "0B" }, "tax_id": "tax_id", "taxonomy_code": "taxonomy_code" }, "revenue_code": "revenue_code", "description": "description", "end_date_of_service": "2023-01-15", "test_results": [ { "value": 1.1, "result_type": "HEMATOCRIT" }, { "value": 1.1, "result_type": "HEMATOCRIT" } ], "has_epsdt_indicator": true, "has_family_planning_indicator": true, "note": "note", "prior_authorization_number": "prior_authorization_number", "external_id": "external_id" }, { "created_at": "2024-01-15T09:30:00Z", "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "procedure_code": "procedure_code", "quantity": "quantity", "units": "MJ", "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "date_of_service_range": { "start_date": "start_date", "end_date": "end_date" }, "date_of_service": "2023-01-15", "modifiers": [ "AV", "AV" ], "charge_amount_cents": 1, "allowed_amount_cents": 1, "insurance_balance_cents": 1, "patient_balance_cents": 1, "paid_amount_cents": 1, "primary_paid_amount_cents": 1, "secondary_paid_amount_cents": 1, "tertiary_paid_amount_cents": 1, "patient_responsibility_cents": 1, "copay_cents": 1, "coinsurance_cents": 1, "deductible_cents": 1, "diagnosis_id_zero": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "diagnosis_id_one": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "diagnosis_id_two": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "diagnosis_id_three": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "drug_identification": { "service_id_qualifier": "EN", "national_drug_code": "national_drug_code", "national_drug_unit_count": "national_drug_unit_count", "measurement_unit_code": "ML", "link_sequence_number": "link_sequence_number", "pharmacy_prescription_number": "pharmacy_prescription_number", "conversion_formula": "conversion_formula", "drug_description": "drug_description" }, "service_line_era_data": { "remittance_advice_remark_codes": [ "remittance_advice_remark_codes", "remittance_advice_remark_codes" ], "service_line_adjustments": [ { "created_at": "2024-01-15T09:30:00Z", "adjustment_group_code": "adjustment_group_code", "adjustment_reason_code": "adjustment_reason_code", "adjustment_amount_cents": 1, "adjustment_note": "adjustment_note" }, { "created_at": "2024-01-15T09:30:00Z", "adjustment_group_code": "adjustment_group_code", "adjustment_reason_code": "adjustment_reason_code", "adjustment_amount_cents": 1, "adjustment_note": "adjustment_note" } ] }, "service_line_manual_adjustments": [ { "created_at": "2024-01-15T09:30:00Z", "adjustment_group_code": "adjustment_group_code", "adjustment_reason_code": "adjustment_reason_code", "adjustment_amount_cents": 1, "adjustment_note": "adjustment_note" }, { "created_at": "2024-01-15T09:30:00Z", "adjustment_group_code": "adjustment_group_code", "adjustment_reason_code": "adjustment_reason_code", "adjustment_amount_cents": 1, "adjustment_note": "adjustment_note" } ], "related_invoices": [ { "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "created_at": "2024-01-15T09:30:00Z", "updated_at": "2024-01-15T09:30:00Z", "organzation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "source_id": "source_id", "source_customer_id": "source_customer_id", "patient_external_id": "patient_external_id", "due_date": "due_date", "status": "draft", "items": [ { "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "amount_cents": 1 }, { "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "amount_cents": 1 } ], "note": "note", "url": "url", "customer_invoice_url": "customer_invoice_url" }, { "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "created_at": "2024-01-15T09:30:00Z", "updated_at": "2024-01-15T09:30:00Z", "organzation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "source_id": "source_id", "source_customer_id": "source_customer_id", "patient_external_id": "patient_external_id", "due_date": "due_date", "status": "draft", "items": [ { "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "amount_cents": 1 }, { "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "amount_cents": 1 } ], "note": "note", "url": "url", "customer_invoice_url": "customer_invoice_url" } ], "related_invoice_info": [ { "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "invoice": { "amount_cents": 1, "created_at": "2024-01-15T09:30:00Z", "updated_at": "2024-01-15T09:30:00Z", "organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "invoice_destination_metadata": { "invoice_destination": "STRIPE", "source_id": "source_id", "source_customer_id": "source_customer_id" }, "patient_external_id": "patient_external_id", "due_date": "2023-01-15", "status": "DRAFT", "items": { "claim_invoice_items": {}, "unattributed_items": [] }, "note": "note", "url": "url", "customer_invoice_url": "customer_invoice_url" }, "invoice_type": "STRIPE" }, { "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "invoice": { "amount_cents": 1, "created_at": "2024-01-15T09:30:00Z", "updated_at": "2024-01-15T09:30:00Z", "organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "invoice_destination_metadata": { "invoice_destination": "STRIPE", "source_id": "source_id", "source_customer_id": "source_customer_id" }, "patient_external_id": "patient_external_id", "due_date": "2023-01-15", "status": "DRAFT", "items": { "claim_invoice_items": {}, "unattributed_items": [] }, "note": "note", "url": "url", "customer_invoice_url": "customer_invoice_url" }, "invoice_type": "STRIPE" } ], "denial_reason": { "reason": "Authorization Required" }, "place_of_service_code": "01", "place_of_service_code_as_submitted": "01", "custom_procedure_code": "custom_procedure_code", "ordering_provider": { "address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code", "address2": "address2" }, "npi": "npi", "provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "first_name": "first_name", "last_name": "last_name", "organization_name": "organization_name", "provider_commercial_license_type": "0", "qualifier": "DQ", "secondary_identification": { "reference_identification": "reference_identification", "reference_identification_qualifier": "0B" }, "tax_id": "tax_id", "taxonomy_code": "taxonomy_code" }, "revenue_code": "revenue_code", "description": "description", "end_date_of_service": "2023-01-15", "test_results": [ { "value": 1.1, "result_type": "HEMATOCRIT" }, { "value": 1.1, "result_type": "HEMATOCRIT" } ], "has_epsdt_indicator": true, "has_family_planning_indicator": true, "note": "note", "prior_authorization_number": "prior_authorization_number", "external_id": "external_id" } ], "eras": [ { "check_date": "check_date", "check_number": "check_number", "era_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, { "check_date": "check_date", "check_number": "check_number", "era_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" } ], "clearinghouse": "clearinghouse", "clearinghouse_claim_id": "clearinghouse_claim_id", "payer_claim_id": "payer_claim_id", "clia_number": "clia_number" } ], "clinical_notes": [ { "category": "clinical", "notes": [ "notes", "notes" ], "notes_structured": [ { "text": "text", "author_name": "author_name", "timestamp": "2024-01-15T09:30:00Z", "author_npi": "author_npi" }, { "text": "text", "author_name": "author_name", "timestamp": "2024-01-15T09:30:00Z", "author_npi": "author_npi" } ] }, { "category": "clinical", "notes": [ "notes", "notes" ], "notes_structured": [ { "text": "text", "author_name": "author_name", "timestamp": "2024-01-15T09:30:00Z", "author_npi": "author_npi" }, { "text": "text", "author_name": "author_name", "timestamp": "2024-01-15T09:30:00Z", "author_npi": "author_npi" } ] } ], "created_at": "2024-01-15T09:30:00Z", "diagnoses": [ { "code": "code", "code_type": "ABF", "created_at": "2024-01-15T09:30:00Z", "diagnosis_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "updated_at": "2024-01-15T09:30:00Z", "name": "name", "present_on_admission_indicator": "YES" }, { "code": "code", "code_type": "ABF", "created_at": "2024-01-15T09:30:00Z", "diagnosis_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "updated_at": "2024-01-15T09:30:00Z", "name": "name", "present_on_admission_indicator": "YES" } ], "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "external_id": "external_id", "owner_of_next_action": "CANDID", "patient": { "address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "address2": "address2", "zip_plus_four_code": "zip_plus_four_code" }, "auto_charge_consent": true, "date_of_birth": "2023-01-15", "email_consent": true, "external_id": "external_id", "first_name": "first_name", "gender": "male", "individual_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "last_name": "last_name", "non_insurance_payers_info": [ { "non_insurance_payer": { "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "name": "name", "enabled": true, "clinical_trials": [ { "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "clinical_trial_number": "clinical_trial_number", "is_active": true, "name": "name", "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "clinical_trial_phase": "Phase 1" }, { "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "clinical_trial_number": "clinical_trial_number", "is_active": true, "name": "name", "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "clinical_trial_phase": "Phase 1" } ], "description": "description", "category": "category", "payer_id": "payer_id", "address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "address2": "address2", "zip_plus_four_code": "zip_plus_four_code" } }, "clinical_trial_info": [ { "clinical_trial": { "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "clinical_trial_number": "clinical_trial_number", "is_active": true, "name": "name", "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "clinical_trial_phase": "Phase 1" }, "clinical_trial_arm": "clinical_trial_arm" }, { "clinical_trial": { "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "clinical_trial_number": "clinical_trial_number", "is_active": true, "name": "name", "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "clinical_trial_phase": "Phase 1" }, "clinical_trial_arm": "clinical_trial_arm" } ], "member_id": "member_id" }, { "non_insurance_payer": { "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "name": "name", "enabled": true, "clinical_trials": [ { "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "clinical_trial_number": "clinical_trial_number", "is_active": true, "name": "name", "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "clinical_trial_phase": "Phase 1" }, { "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "clinical_trial_number": "clinical_trial_number", "is_active": true, "name": "name", "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "clinical_trial_phase": "Phase 1" } ], "description": "description", "category": "category", "payer_id": "payer_id", "address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "address2": "address2", "zip_plus_four_code": "zip_plus_four_code" } }, "clinical_trial_info": [ { "clinical_trial": { "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "clinical_trial_number": "clinical_trial_number", "is_active": true, "name": "name", "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "clinical_trial_phase": "Phase 1" }, "clinical_trial_arm": "clinical_trial_arm" }, { "clinical_trial": { "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "clinical_trial_number": "clinical_trial_number", "is_active": true, "name": "name", "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "clinical_trial_phase": "Phase 1" }, "clinical_trial_arm": "clinical_trial_arm" } ], "member_id": "member_id" } ], "phone_consent": true, "phone_numbers": [ { "number": "number", "type": "Home" }, { "number": "number", "type": "Home" } ], "non_insurance_payers": [ { "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "name": "name", "enabled": true, "clinical_trials": [ { "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "clinical_trial_number": "clinical_trial_number", "is_active": true, "name": "name", "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "clinical_trial_phase": "Phase 1" }, { "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "clinical_trial_number": "clinical_trial_number", "is_active": true, "name": "name", "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "clinical_trial_phase": "Phase 1" } ], "description": "description", "category": "category", "payer_id": "payer_id", "address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "address2": "address2", "zip_plus_four_code": "zip_plus_four_code" } }, { "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "name": "name", "enabled": true, "clinical_trials": [ { "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "clinical_trial_number": "clinical_trial_number", "is_active": true, "name": "name", "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "clinical_trial_phase": "Phase 1" }, { "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "clinical_trial_number": "clinical_trial_number", "is_active": true, "name": "name", "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "clinical_trial_phase": "Phase 1" } ], "description": "description", "category": "category", "payer_id": "payer_id", "address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "address2": "address2", "zip_plus_four_code": "zip_plus_four_code" } } ], "email": "email" }, "patient_authorized_release": true, "patient_histories": [ { "category": "present_illness", "questions": [ { "id": "id", "text": "text", "responses": [ { "response": "response", "follow_ups": [] }, { "response": "response", "follow_ups": [] } ] }, { "id": "id", "text": "text", "responses": [ { "response": "response", "follow_ups": [] }, { "response": "response", "follow_ups": [] } ] } ] }, { "category": "present_illness", "questions": [ { "id": "id", "text": "text", "responses": [ { "response": "response", "follow_ups": [] }, { "response": "response", "follow_ups": [] } ] }, { "id": "id", "text": "text", "responses": [ { "response": "response", "follow_ups": [] }, { "response": "response", "follow_ups": [] } ] } ] } ], "patient_payments": [ { "patient_payment_id": "patient_payment_id", "organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "source_internal_id": "source_internal_id", "source": "MANUAL_ENTRY", "amount_cents": 1, "payment_timestamp": "2024-01-15T09:30:00Z", "status": "PENDING", "payment_name": "payment_name", "payment_note": "payment_note", "patient_external_id": "patient_external_id", "encounter_external_id": "encounter_external_id", "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, { "patient_payment_id": "patient_payment_id", "organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "source_internal_id": "source_internal_id", "source": "MANUAL_ENTRY", "amount_cents": 1, "payment_timestamp": "2024-01-15T09:30:00Z", "status": "PENDING", "payment_name": "payment_name", "payment_note": "payment_note", "patient_external_id": "patient_external_id", "encounter_external_id": "encounter_external_id", "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" } ], "provider_accepts_assignment": true, "rendering_provider": { "address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code", "address2": "address2" }, "npi": "npi", "provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "first_name": "first_name", "last_name": "last_name", "organization_name": "organization_name", "provider_commercial_license_type": "0", "qualifier": "DQ", "secondary_identification": { "reference_identification": "reference_identification", "reference_identification_qualifier": "0B" }, "tax_id": "tax_id", "taxonomy_code": "taxonomy_code" }, "responsible_party": "INSURANCE_PAY", "service_facility": { "service_facility_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "organization_name": "organization_name", "address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code", "address2": "address2" }, "npi": "npi", "secondary_identification": "secondary_identification", "mammography_certification_number": "mammography_certification_number" }, "submission_origin": "CANDID", "tags": [ { "color": "black", "creator_id": "creator_id", "description": "description", "tag_id": "tag_id" }, { "color": "black", "creator_id": "creator_id", "description": "description", "tag_id": "tag_id" } ], "url": "url", "schema_instances": [ { "schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "content": { "content": { "key": "value" } } }, { "schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "content": { "content": { "key": "value" } } } ], "accident_date": "2023-01-15", "additional_information": "additional_information", "admission_date": "2023-01-15", "appointment_type": "appointment_type", "billing_notes": [ { "billing_note_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "created_at": "2024-01-15T09:30:00Z", "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "text": "text", "author_auth0_id": "author_auth0_id", "author_name": "author_name", "billing_note_metadata": { "type": "queue_added", "queue_id": "queue_id", "queue_name": "queue_name" }, "billing_note_type": "manual" }, { "billing_note_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "created_at": "2024-01-15T09:30:00Z", "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "text": "text", "author_auth0_id": "author_auth0_id", "author_name": "author_name", "billing_note_metadata": { "type": "queue_added", "queue_id": "queue_id", "queue_name": "queue_name" }, "billing_note_type": "manual" } ], "claim_creation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "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" } ], "coding_attribution": "CANDID", "date_of_service": "2023-01-15", "delay_reason_code": "1", "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 } ], "guarantor": { "address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "address2": "address2", "zip_plus_four_code": "zip_plus_four_code" }, "auto_charge_consent": true, "email_consent": true, "external_id": "external_id", "first_name": "first_name", "guarantor_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "last_name": "last_name", "phone_consent": true, "phone_numbers": [ { "number": "number", "type": "Home" }, { "number": "number", "type": "Home" } ], "date_of_birth": "2023-01-15", "email": "email" }, "initial_referring_provider": { "address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code", "address2": "address2" }, "npi": "npi", "provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "first_name": "first_name", "last_name": "last_name", "organization_name": "organization_name", "provider_commercial_license_type": "0", "qualifier": "DQ", "secondary_identification": { "reference_identification": "reference_identification", "reference_identification_qualifier": "0B" }, "tax_id": "tax_id", "taxonomy_code": "taxonomy_code" }, "initial_treatment_date": "2023-01-15", "interventions": [ { "name": "name", "category": "allopathic", "description": "description", "medication": { "name": "name", "rx_cui": "rx_cui", "dosage": "dosage", "dosage_form": "dosage_form", "frequency": "frequency", "as_needed": true }, "labs": [ { "name": "name", "code": "code", "code_type": "quest" }, { "name": "name", "code": "code", "code_type": "quest" } ] }, { "name": "name", "category": "allopathic", "description": "description", "medication": { "name": "name", "rx_cui": "rx_cui", "dosage": "dosage", "dosage_form": "dosage_form", "frequency": "frequency", "as_needed": true }, "labs": [ { "name": "name", "code": "code", "code_type": "quest" }, { "name": "name", "code": "code", "code_type": "quest" } ] } ], "last_menstrual_period_date": "2023-01-15", "last_submitted_at": "2024-01-15T09:30:00Z", "next_responsible_party": "primary", "onset_of_current_illness_or_symptom_date": "2023-01-15", "organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "outside_lab": true, "outside_lab_charges_amount_cents": 1, "patient_control_number": "patient_control_number", "pay_to_address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code", "address2": "address2" }, "place_of_service_code": "01", "place_of_service_code_as_submitted": "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" }, "purchased_service_provider_npi": "purchased_service_provider_npi", "referral_number": "referral_number", "referring_provider": { "address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code", "address2": "address2" }, "npi": "npi", "provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "first_name": "first_name", "last_name": "last_name", "organization_name": "organization_name", "provider_commercial_license_type": "0", "qualifier": "DQ", "secondary_identification": { "reference_identification": "reference_identification", "reference_identification_qualifier": "0B" }, "tax_id": "tax_id", "taxonomy_code": "taxonomy_code" }, "related_causes_information": { "related_causes_code_1": "AA", "related_causes_code_2": "AA", "state_or_province_code": "state_or_province_code" }, "secondary_payer_carrier_code": "secondary_payer_carrier_code", "service_authorization_exception_code": "1", "subscriber_primary": { "first_name": "first_name", "gender": "male", "individual_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "insurance_card": { "insurance_card_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "member_id": "member_id", "payer_id": "payer_id", "payer_name": "payer_name", "group_number": "group_number", "image_url_back": "image_url_back", "image_url_front": "image_url_front", "insurance_type": "01", "payer_address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code", "address2": "address2" }, "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "plan_name": "plan_name", "plan_type": "09", "rx_bin": "rx_bin", "rx_pcn": "rx_pcn" }, "last_name": "last_name", "patient_relationship_to_subscriber_code": "01", "address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "address2": "address2", "zip_plus_four_code": "zip_plus_four_code" }, "date_of_birth": "2023-01-15" }, "subscriber_secondary": { "first_name": "first_name", "gender": "male", "individual_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "insurance_card": { "insurance_card_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "member_id": "member_id", "payer_id": "payer_id", "payer_name": "payer_name", "group_number": "group_number", "image_url_back": "image_url_back", "image_url_front": "image_url_front", "insurance_type": "01", "payer_address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code", "address2": "address2" }, "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "plan_name": "plan_name", "plan_type": "09", "rx_bin": "rx_bin", "rx_pcn": "rx_pcn" }, "last_name": "last_name", "patient_relationship_to_subscriber_code": "01", "address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "address2": "address2", "zip_plus_four_code": "zip_plus_four_code" }, "date_of_birth": "2023-01-15" }, "subscriber_tertiary": { "first_name": "first_name", "gender": "male", "individual_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "insurance_card": { "insurance_card_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "member_id": "member_id", "payer_id": "payer_id", "payer_name": "payer_name", "group_number": "group_number", "image_url_back": "image_url_back", "image_url_front": "image_url_front", "insurance_type": "01", "payer_address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code", "address2": "address2" }, "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "plan_name": "plan_name", "plan_type": "09", "rx_bin": "rx_bin", "rx_pcn": "rx_pcn" }, "last_name": "last_name", "patient_relationship_to_subscriber_code": "01", "address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "address2": "address2", "zip_plus_four_code": "zip_plus_four_code" }, "date_of_birth": "2023-01-15" }, "supervising_provider": { "address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code", "address2": "address2" }, "npi": "npi", "provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "first_name": "first_name", "last_name": "last_name", "organization_name": "organization_name", "provider_commercial_license_type": "0", "qualifier": "DQ", "secondary_identification": { "reference_identification": "reference_identification", "reference_identification_qualifier": "0B" }, "tax_id": "tax_id", "taxonomy_code": "taxonomy_code" }, "synchronicity": "Synchronous", "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 }, "work_queue_id": "work_queue_id", "work_queue_membership_activated_at": "2024-01-15T09:30:00Z", "accident_state_or_province_code": "AA", "admission_hour": 1, "admission_source_code": "1", "admission_type_code": "1", "attending_provider": { "address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code", "address2": "address2" }, "npi": "npi", "provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "first_name": "first_name", "last_name": "last_name", "organization_name": "organization_name", "provider_commercial_license_type": "0", "qualifier": "DQ", "secondary_identification": { "reference_identification": "reference_identification", "reference_identification_qualifier": "0B" }, "tax_id": "tax_id", "taxonomy_code": "taxonomy_code" }, "discharge_hour": 1, "discharge_status": "01", "operating_provider": { "address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code", "address2": "address2" }, "npi": "npi", "provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "first_name": "first_name", "last_name": "last_name", "organization_name": "organization_name", "provider_commercial_license_type": "0", "qualifier": "DQ", "secondary_identification": { "reference_identification": "reference_identification", "reference_identification_qualifier": "0B" }, "tax_id": "tax_id", "taxonomy_code": "taxonomy_code" }, "other_operating_provider": { "address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code", "address2": "address2" }, "npi": "npi", "provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "first_name": "first_name", "last_name": "last_name", "organization_name": "organization_name", "provider_commercial_license_type": "0", "qualifier": "DQ", "secondary_identification": { "reference_identification": "reference_identification", "reference_identification_qualifier": "0B" }, "tax_id": "tax_id", "taxonomy_code": "taxonomy_code" }, "submission_expectation": "TARGET_PROFESSIONAL", "treating_provider": { "provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "first_name": "first_name", "last_name": "last_name", "npi": "npi", "taxonomy_code": "taxonomy_code", "address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code", "address2": "address2" }, "tax_id": "tax_id", "license_type": "MD" }, "type_of_bill": { "code": "code", "frequency_code": "0", "type_of_care": "1", "type_of_facility": "1" } } ``` **SDK Code** ```python import requests url = "https://api.joincandidhealth.com/api/encounters/v4/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" headers = {"Authorization": "."} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.joincandidhealth.com/api/encounters/v4/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32'; 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/encounters/v4/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" 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/encounters/v4/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32") 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/encounters/v4/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32") .header("Authorization", ".") .asString(); ``` ```php request('GET', 'https://api.joincandidhealth.com/api/encounters/v4/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32', [ 'headers' => [ 'Authorization' => '.', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.joincandidhealth.com/api/encounters/v4/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"); 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/encounters/v4/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")! 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() ```