Skip to main content

ClaimAPI

data object
amount_allowednumbernullable

The plan's allowed amount for the billed service(s): the maximum the payer recognizes under its provider contract. Use computed_amount_allowed when this field is missing.

amount_billednumbernullable

Amount the provider billed for the service(s) on this claim, as reported on the EOB. Use computed_amount_billed when this field is missing.

amount_not_coverednumbernullable

Portion of the billed amount the plan does not cover (for example, non-covered services or charges above the allowed amount).

amount_paidnumbernullable

Amount the payer paid toward this claim. Use computed_amount_paid when this field is missing.

amount_paid_othernumbernullable

Amount paid toward this claim by another payer (for example, a primary carrier under coordination of benefits).

check_datedatenullable

Date the payer issued payment for this claim.

check_numberstringnullable

Payer's check or EFT reference number for the payment issued on this claim.

claim_medical_lines object[]
  • Array [
  • amount_allowednumbernullable
    amount_billednumbernullable
    amount_not_coverednumbernullable
    amount_paidnumbernullable
    amount_paid_othernumbernullable
    coinsurance_patientnumbernullable
    copaymentnumbernullable
    date_of_service object
    boundsstring
    enddatenullable
    startdatenullable
    days_supplyintegernullable
    diagnosis_codestringnullable
    discountnumbernullable
    idinteger
    national_drug_codestringnullable
    patient_responsibilitynumbernullable
    prescription_type_idintegernullable
    prescription_type_strstring
    procedure_codestringnullable
    procedure_namestringnullable
    quantitynumbernullable
    reductionnumbernullable
    total_patient_responsibilitynumber
    uuiduuid
    vendor_system_idstringrequired
  • ]
  • coinsurance_patientnumbernullable

    Coinsurance the patient owes: the patient's percentage share of the allowed amount. Use computed_coinsurance_patient when this field is missing.

    computed_amount_allowednumber
    computed_amount_billednumber
    computed_amount_paidnumber
    computed_coinsurance_patientnumber
    computed_copaymentnumber
    computed_patient_responsibilitynumber
    computed_reductionnumber
    copaymentnumbernullable

    Fixed copay the patient owes for this claim. Use computed_copayment when this field is missing.

    createddatedate-timenullable
    dataobject_idintegernullable
    date_columndate-time
    date_of_service object
    boundsstring
    enddatenullable
    startdatenullable
    discountnumbernullable

    Provider discount or write-off applied against the billed amount. Use computed_discount when this field is missing.

    eob_datedatenullable

    Date of the Explanation of Benefits statement this claim was extracted from.

    group_namestringnullable

    Name of the employer or plan group the member is enrolled under, as shown on the EOB.

    group_numberstringnullable

    Payer's identifier for the employer or plan group the member is enrolled under.

    idinteger
    incurred_valuenumber
    is_incompletebooleannullable

    This claim may have incomplete data. If a claim is marked as incomplete, we typically will not send it until it gets marked as complete. Reasons for an incomplete claim include (1) documentation that isn't yet available but we expect it to be in the near future, and (2) if we notice the claim has data redacted for privacy (example: a dependent over 16 years old), but we expect to get this data when a dependent links their account.

    last_updated_statusdate-timenullable

    Used as an indicator of when the last substantial change happened to this claim. If this date gets updated, we consider it necessary to re-send the claim for processing (in data exports) / flag it as "unread" in TPA Stream / etc. Typically this date gets updated when the patient_responsibility or status changes, or otherwise when is_incomplete changes to True.

    members object[]
  • Array [
  • emailstringnullable
    employer object
    idinteger
    namestringrequired
    reimbursement_policy
    first_namestringnullable
    idinteger
    last_namestringnullable
    system_key object
    property name*string
  • ]
  • modifieddatedate-timenullable
    networkstring

    Possible values: [IN, OUT, TIER1, TIER2]

    patient_account_numberstringnullable

    The service provider's internal account number for the patient (often the provider's EMR record ID or chart number, used by the provider's billing system for payment posting). Provider-scoped, not carrier-scoped - the same patient seen at two clinics will have two different patient_account_number values.

    patient_namestringnullable

    Name of the patient the claim is for. May be the plan subscriber or one of their dependents.

    patient_payer_numberstringnullable

    Carrier-issued member ID as it appears on the insurance card (HL7 v2-0203 'MB' code). Identifies the plan member, not the individual patient: the subscriber and every dependent on the same plan typically share this value (sometimes with a per-person suffix appended by the carrier). Not suitable on its own for distinguishing which household member a claim is for - for that, use payer_patient_id. Anthem PAA does NOT populate this field - the FHIR Patient resource's MB-typed identifier is inconsistently present and even when present would be the subscriber's, not the actual claim patient's.

    patient_responsibilitynumbernullable

    Total amount the patient owes for this claim (deductible reduction, coinsurance, copay, and non-covered charges combined). Use computed_patient_responsibility when this field is missing.

    policy_holder object
    first_namestringnullable

    Policy holder's first name.

    idinteger
    last_namestringnullable

    Policy holder's last name.

    processed_ondatenullable

    Date the payer adjudicated (finished processing) the claim.

    recrawl_requestedboolean

    Attempt to recrawl when True

    reductionnumbernullable

    This is the amount the deductible was reduced by. Most systems refer to this as 'deductible'. Use computed_reduction in case this field is empty.

    remarksstringnullable

    These are the notes for the Claim.

    service_providerstringnullable

    Service Provider Name. This is the physical name, and is provided by the Payer.

    service_provider_addressstringnullable

    Physical address of Service Provider

    service_provider_billing_addressstringnullable

    Billing address of the service provider (the address tied to service_provider_billing_name), often different from the provider's physical location.

    service_provider_billing_namestringnullable

    This is the service_provider's Billing name, which is often different from their physical address name.

    service_provider_billing_npi_numberintegernullable

    NPI Number of Billing Service Provider

    service_provider_billing_numberstringnullable

    Federal Tax ID of Billing Service Provider

    service_provider_billing_phonestringnullable

    Billing contact phone number for the service provider.

    service_provider_npi_numberintegernullable

    NPI Number of Service Provider

    service_provider_numberstringnullable

    Federal Tax ID of Service Provider

    statusstring

    Possible values: [In Process, Processed, Rejected, Adjusted, Partially Approved]

    tpas_claim_statement_urlstringnullable
    type object
    namestring

    Possible values: [medical, dental, rx, vision, facility]

    type_idinteger

    Possible values: [1, 2, 3, 4, 5]

    uuiduuid
    vendor_system_idstringrequired

    This field is unique for each Payer. Occasionally TPA Stream may append data to the end of this key to enforce uniqueness, such as the date_of_service, patient_responsibility, etc.

    ClaimAPI
    {
    "data": {
    "amount_allowed": 0,
    "amount_billed": 0,
    "amount_not_covered": 0,
    "amount_paid": 0,
    "amount_paid_other": 0,
    "check_date": "2024-07-29",
    "check_number": "string",
    "claim_medical_lines": [
    {
    "amount_allowed": 0,
    "amount_billed": 0,
    "amount_not_covered": 0,
    "amount_paid": 0,
    "amount_paid_other": 0,
    "coinsurance_patient": 0,
    "copayment": 0,
    "date_of_service": {
    "bounds": "string",
    "end": "2024-07-29",
    "start": "2024-07-29"
    },
    "days_supply": 0,
    "diagnosis_code": "string",
    "discount": 0,
    "id": 0,
    "national_drug_code": "string",
    "patient_responsibility": 0,
    "prescription_type_id": 0,
    "prescription_type_str": "string",
    "procedure_code": "string",
    "procedure_name": "string",
    "quantity": 0,
    "reduction": 0,
    "total_patient_responsibility": 0,
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "vendor_system_id": "string"
    }
    ],
    "coinsurance_patient": 0,
    "computed_amount_allowed": 0,
    "computed_amount_billed": 0,
    "computed_amount_paid": 0,
    "computed_coinsurance_patient": 0,
    "computed_copayment": 0,
    "computed_patient_responsibility": 0,
    "computed_reduction": 0,
    "copayment": 0,
    "createddate": "2024-07-29T15:51:28.071Z",
    "dataobject_id": 0,
    "date_column": "2024-07-29T15:51:28.071Z",
    "date_of_service": {
    "bounds": "string",
    "end": "2024-07-29",
    "start": "2024-07-29"
    },
    "discount": 0,
    "eob_date": "2024-07-29",
    "group_name": "string",
    "group_number": "string",
    "id": 0,
    "incurred_value": 0,
    "is_incomplete": true,
    "last_updated_status": "2024-07-29T15:51:28.071Z",
    "members": [
    {
    "email": "string",
    "employer": {
    "id": 0,
    "name": "string",
    "reimbursement_policy": {}
    },
    "first_name": "string",
    "id": 0,
    "last_name": "string",
    "system_key": {
    "employee_navigator": "281BX1",
    "wex_healthcloud": "CO11B"
    }
    }
    ],
    "modifieddate": "2024-07-29T15:51:28.071Z",
    "network": "IN",
    "patient_account_number": "string",
    "patient_name": "string",
    "patient_payer_number": "string",
    "patient_responsibility": 0,
    "policy_holder": {
    "first_name": "string",
    "id": 0,
    "last_name": "string"
    },
    "processed_on": "2024-07-29",
    "recrawl_requested": true,
    "reduction": 0,
    "remarks": "string",
    "service_provider": "string",
    "service_provider_address": "string",
    "service_provider_billing_address": "string",
    "service_provider_billing_name": "string",
    "service_provider_billing_npi_number": 0,
    "service_provider_billing_number": "string",
    "service_provider_billing_phone": "string",
    "service_provider_npi_number": 0,
    "service_provider_number": "string",
    "status": "In Process",
    "tpas_claim_statement_url": "string",
    "type": {
    "name": "medical",
    "type_id": 1
    },
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "vendor_system_id": "string"
    }
    }