Eligibility Check

Invoices can be used to collect payments from patients. Invoices can be directly sent to the patient's email for a patient to complete or can be automatically collected if the patient's billing information is on file.

The eligibility_check model


  • Name
    id
    Type
    string
    Description

    Unique identifier for the Eligibility Check.

  • Name
    object
    Type
    string
    Description

    Always 'eligibility_check'.

  • Name
    patient
    Type
    string
    Description

    Patient Eligibility Check is associated with.

  • Name
    provider
    Type
    string
    Description

    The patient's provider name.

  • Name
    insurance_policy
    Type
    string
    Description

    The name of the Patient's insurance policy.

  • Name
    group_number
    Type
    string
    Description

    The name of the Patient's insurance policy.

  • Name
    plan_start_date
    Type
    string
    Description

    The name of the Patient's insurance policy.

  • Name
    planstatus
    Type
    array of objects
    Description
    Relevant planstatus for eligibility_check.
  • Name
    benefit
    Type
    array of objects
    Description
    Relevant benefit for eligibility_check.
  • Name
    response
    Type
    object
    Description

    The full, unparsed 271 file received from payer.

  • Name
    created_by
    Type
    string
    Description

    Creator of the invoice.

  • Name
    created_at
    Type
    number
    Description

    Timestamp (in ISO 8601 format) of when the invoice was created.

Response

{
    "id": "elck_m6TVCgqM9BMNcOF5lsl8",
    "object": "eligibilityCheck",
    "patient": "user_Z1zXZKvqrpwxbznuW6lJ",
    "provider": "user_tIaZsBPeECJG82W5vqn8",
    "insurance_policy": "plcy_uwtVfmQlU0zMryaFjQg4",

    "group_number": "sendInvoice",
    "plan_start_date": "sendInvoice",

    "PlanStatus": [
        {
            "statusCode": "needs_review",
            "status": "user_idjkvxZTqfJD734feQHa",
            "plan_details?": "user_QtD0YaeDw4VyS9UPBpX4",
            "service_type_codes": 1684220332000,
        }
    ],
    "Benefit": [
        {
            "code": "in_progress",
            "name": "user_idjkvxZTqfJD734feQHa",

            "insurance_type_code?": 1653798303000,
            "insurance_type?": "user_idjkvxZTqfJD734feQHa",
            "plan_coverage?": "user_idjkvxZTqfJD734feQHa",

            "coverage_level_code?": "user_idjkvxZTqfJD734feQHa",
            "coverage_level?": "user_idjkvxZTqfJD734feQHa",
            "service_type_codes?": "user_idjkvxZTqfJD734feQHa",
            "service_types?": "user_idjkvxZTqfJD734feQHa",

            "time_qualifier_code?": "user_idjkvxZTqfJD734feQHa",
            "time_qualifier?": "user_idjkvxZTqfJD734feQHa",
            "benefit_amount?": "user_idjkvxZTqfJD734feQHa",
            "benefit_percent?": "user_idjkvxZTqfJD734feQHa",

            "auth0rCertIndicator?": "user_idjkvxZTqfJD734feQHa",

            "in_plan_network_indicator_code?": "user_idjkvxZTqfJD734feQHa",
            "in_plan_network_indicator?": "user_idjkvxZTqfJD734feQHa",

            "additional_information": "user_idjkvxZTqfJD734feQHa",
        },
    ],
    "created_by": "user_Z1zXZKvqrpwxbznuW6lJ",
    "created_at": 1653798303000,
}