> ## Documentation Index
> Fetch the complete documentation index at: https://docs.morf.health/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Check Eligibility

> Documentation for the Check Eligibility action for Stedi

![images/stedi.svg](https://mintcdn.com/morfhealth/EU2WCxuXGIUQcziR/images/stedi.svg?fit=max\&auto=format\&n=EU2WCxuXGIUQcziR\&q=85\&s=4286090ba34294d07e2d4cd56f61ba0f)

Morf runs insurance eligibility checks through our partnership with Stedi, in two modes:

* **Asynchronous** — the Check Eligibility workflow action runs the check inside a Morf workflow. See the [walkthrough below](#asynchronous-eligibility-checks-workflow-action) and the [Parameters](#parameters) reference.
* **Synchronous** — a Morf form calls the eligibility endpoint directly, so patients see their eligibility status immediately. See the [form setup guide](#synchronous-eligibility-checks-morf-forms) and the [endpoint API reference](#eligibility-check-endpoint-api-reference).

## Asynchronous Eligibility Checks (Workflow Action)

Morf can run asynchronous insurance eligibility checks through our partnership with Stedi. Using the Stedi Check Eligibility action in your Morf workflow automates the patient's eligibility check, saving admin staff time from manual checks.

**Run an asynchronous eligibility check when:**

* Insurance information is entered in your intake form
* An insurance policy is created in your EHR
* Any time insurance information is captured

**Use eligibility check results to:**

* Update the patient chart in your EHR
* Alert your team of ineligible patients via Slack
* Send an SMS or email to your patient with the eligibility check results

*Have something else in mind? Reach out to Morf support to learn more about how Morf's Stedi eligibility checks can fit into your workflows.*

#### Prerequisites

Before you begin, confirm you have:

1. A Morf organization.
2. A Feathery form collecting insurance info connected to your Morf organization. Follow the [Feathery Setup Instructions](https://docs.morf.health/docs/knowledge_base/feathery_setup.md) to get started. The form must collect:
   * `insurance_plan_name`
   * `member_id`
   * `first_name`
   * `last_name`
   * `date_of_birth`
   * `insurance_relationship`
3. Your organization's insurance information:
   * Organization Name
   * Organization or Provider NPI
   * Service Type Codes
4. Custom profile properties in Morf to store eligibility check results:
   * `stedi_payer_id`
   * `copay`
   * `coinsurance`
   * `deductible`

#### Instructions

##### 1. Create a workflow in Morf

In the **Workflows** tab, click **+ New Workflow**. Select a trigger to kick off the workflow. For this example, select the **Feathery Form Step Submission** trigger.

##### 2. Configure Update Profile Properties node

> [!TIP]
>
> Primary and secondary insurance properties are standard properties in Morf.

Save the Feathery form insurance information filled out by the patient to the Morf `primary_insurance` profile properties in the **Update Profile Properties** node.

##### 3. Configure Stedi Payer ID mapping

In the **Update Profile Properties** node, add `stedi_payer_id` to the **Map Properties** section. For the value, open a CEL expression and input the following, swapping in your org's accepted insurance plans and corresponding payer IDs from the [Stedi Payer Network](https://www.stedi.com/healthcare/network):

```
{"Aetna" : "60054",
 "Cigna" : "62308",
 "UnitedHealthcare" : "87726",
}[get_current_property_value("primary_insurance").?plan_name.orValue("Other")]
```

##### 4. Add and configure the Stedi Check Eligibility action

Add the Stedi Check Eligibility action to the workflow. Rename the object name to `stedi_eligibility_result` for use in downstream logic.

Map the `primary_insurance` Morf properties to the corresponding parameters in the **Map Properties** section of the action. Be sure to swap in your org-specific values for organization name, NPI, and service type codes.

##### 5. Add branching logic based on eligibility results

Add filters after the Stedi Check Eligibility action to route executions based on the eligibility result.

![Stedi branching logic](https://mintcdn.com/morfhealth/nPXB9VnqEsa3Ru-D/images/stedi_branching.png?fit=max\&auto=format\&n=nPXB9VnqEsa3Ru-D\&q=85\&s=f142e04fd90ca78fcaf36452c0d15508)

In the filters, input the following CEL expressions to route executions based on the result of the Check Eligibility action for the eligible and not eligible insurances.

**Is Eligible:**

```
stedi_eligibility_result.in_network_eligibility_summary.is_active_and_covered == true
```

**Is Not Eligible:**

```
stedi_eligibility_result.in_network_eligibility_summary.is_active_and_covered == false
```

##### 6. (Optional) Save eligibility results to Morf profile

Using an **Update Profile Properties** action, save the results of the eligibility check to the custom profile properties `copay`, `coinsurance`, and `deductible`. These values are sourced from `in_network_eligibility_summary`, created by Morf from the returned Stedi response.

![Save Stedi results to Morf profile](https://mintcdn.com/morfhealth/nPXB9VnqEsa3Ru-D/images/stedi_save_results.png?fit=max\&auto=format\&n=nPXB9VnqEsa3Ru-D\&q=85\&s=450364c3cb33a3b57985dc8cd8e3ab1f)

##### 7. (Optional) Slack message for ineligible results

To alert a team member about ineligible patients, configure a **Send Incoming Webhook Message** action on the ineligible branch.

#### Testing

Morf's Stedi Check Eligibility action accepts mock patient data to test the endpoint using Morf's test API key.

In the **Check Eligibility** node configuration, set the **Use Test API Key** parameter to `true`. This allows mock patient eligibility data to be used to test the workflow.

To test full functionality, trigger the workflow using mock patient data from [Stedi's mock eligibility examples](https://www.stedi.com/docs/healthcare/api-reference/mock-requests-eligibility-checks#test-api-key).

## Synchronous Eligibility Checks (Morf Forms)

Morf can run synchronous insurance eligibility checks through our partnership with Stedi. Using the Stedi Eligibility Endpoint in your Morf form instantly returns a user's insurance eligibility, saving admin staff time from manual checks.

**Run a synchronous eligibility check when:**

* Insurance information is entered in your intake form

**Use eligibility check results to:**

* Dynamically route patients through your intake form
* Update the patient chart in your EHR
* Send an SMS or email to your patient with the eligibility check results

*Have something else in mind? Reach out to Morf support to learn more about how Morf's Stedi eligibility checks can fit into your practice.*

#### Prerequisites

Before you begin, confirm you have:

1. A Morf token (contact Morf to get this).
2. A Morf organization.
3. Completed the baseline [Feathery Setup Instructions](https://docs.morf.health/docs/knowledge_base/feathery_setup.md).
4. Your organization's insurance information:
   * Organization Name
   * Organization or Provider NPI
   * Accepted Insurance Plans
   * Service Type Codes
5. Feathery fields that collect patient information before the eligibility check runs. Confirm the field IDs match exactly:
   * `first_name`
   * `last_name`
   * `date_of_birth`
   * `insurance_plan_name`
   * `member_id`
   * `insurance_relationship`
   * `policy_holder_first_name`
   * `policy_holder_last_name`
   * `policy_holder_dob`

#### Instructions

##### 1. Create hidden fields

In the form, go to **Settings > Data Tracking > Edit Hidden Fields** and add:

* `morf_token`
* `stedi_payer_id`
* `is_active_and_covered`

To surface returned insurance plan information from the eligibility check result, also add:

* `insurance_type`
* `plan_name`
* `individual_deductible_remaining_dollars`
* `co_insurance_percentage`
* `copay_dollars`
* `individual_deductible_dollars`

##### 2. Create step: Insurance Information

1. Create a new step named `Insurance Information`.
2. Add the required form fields:
   * `first_name`
   * `last_name`
   * `date_of_birth`
   * `insurance_plan_name`
   * `member_id`
   * `insurance_relationship` (e.g. self, parent, spouse)
3. Look up the Stedi Payer ID for each accepted insurance plan on the [Stedi Payer Network](https://www.stedi.com/healthcare/network). Example: Aetna's Payer ID is `60054`.
4. Configure `insurance_plan_name` as a dropdown:
   * **Display label:** the insurance plan name (e.g. `Aetna`)
   * **Option value:** the Stedi Payer ID (e.g. `60054`)

> [!TIP]
>
> If the policy holder is the person completing the form, you do not need to collect their first name, last name, or date of birth again.

##### 3. Create step: Eligibility Check in Progress

1. Create a new step named `Eligibility Check in Progress`.
2. Add a loading image to the step — this will serve as the trigger element for the logic rule when viewed.

##### 4. Create step: Eligibility Confirmed

1. Create a new step named `Eligibility Confirmed`. Users land here when their insurance is eligible for your services.
2. Optionally surface returned insurance information by referencing hidden fields in curly brackets — e.g. `{{insurance_type}}`, `{{copay_dollars}}`.

##### 5. Create step: Eligibility Failed

Create a new step named `Eligibility Failed`. Users land here if their insurance is not eligible for your services.

##### 6. Edit logic rule: Set Environment Variables

Add `morf_token` to your existing **Set Environment Variables** logic rule, with staging and production token values.

> [accordion] View code
>
> ```jsx theme={null}
> if (feathery.isTestForm()) {
>   morf_token.value = 'morf_sandbox...';
> } else {
>   morf_token.value = 'morf_production...';
> }
> ```

##### 7. Create logic rule: Initialize Verification Check

1. Go to **Logic > Create New Logic Rule**.
2. Name the rule `Initialize Verification Check`.
3. Configure the trigger:
   * **Event trigger:** Form Element is Viewed
   * **Element trigger:** the loader element on the **Eligibility Check in Progress** step
4. Go to **Advanced Logic > Edit Code** and add the following. Replace `organizationName`, `npi`, and `service_codes` with your organization's values.

> [accordion] View code
>
> ```jsx theme={null}
> // Organization specific variables
> const organizationName = "Morf Health";
> const npi = "1999999984";
> const service_codes = ["30"];
>
> const morfEligibilityEndpoint = 'https://api.morf.healthcare/v1/stedi/check_eligibility';
>
> function formatDob(dob) {
>   const date = new Date(dob);
>   return {
>     year: date.getFullYear(),
>     month: date.getMonth() + 1,
>     day: date.getDate()
>   };
> }
>
> function constructRequest() {
>   return {
>     tradingPartnerServiceId: insurance_plan_name1.value,
>     subscriber: {
>       lastName: last_name.value,
>       memberId: insurance_policy_member_id.value,
>       firstName: first_name.value,
>       dateOfBirth: formatDob(date_of_birth.value.split('-'))
>     },
>     provider: {
>       organizationName,
>       npi
>     },
>     encounter: {
>       service_type_codes: service_codes
>     },
>     useTestApiKey: feathery.isTestForm()
>   };
> }
>
> const primaryInsuranceResp = await feathery.http.post(
>   morfEligibilityEndpoint,
>   constructRequest()
> );
>
> console.log("API response:", primaryInsuranceResp);
>
> if (!primaryInsuranceResp || primaryInsuranceResp.error) {
>   console.error("API returned error:", primaryInsuranceResp?.error);
>   return feathery.goToStep("Eligibility Failed");
> }
>
> if (!primaryInsuranceResp.data) {
>   console.error("No data in API response:", primaryInsuranceResp);
>   return feathery.goToStep("Eligibility Failed");
> }
>
> const summary = primaryInsuranceResp.data.in_network_eligibility_summary;
>
> if (summary?.is_active_and_covered == true) {
>   copay_dollars.value = summary.co_pay_dollars;
>   co_insurance_percentage.value = summary.coinsurance_percentage;
>   insurance_type.value = summary.insurance_type;
>   individual_deductible_remaining_dollars.value = summary.individual_deductible_remaining_dollars;
>   return feathery.goToStep("Eligibility Confirmed");
> }
>
> console.warn("Member not active/covered");
> return feathery.goToStep("Eligibility Failed");
> ```

##### 8. Add endpoint API connector

Add an API connector for the Morf x Stedi Eligibility endpoint:

* **URL:** `https://api.morf.healthcare/v1/stedi/check_eligibility`
* **Method:** POST
* **Headers:**
  * `Content-Type: application/json`
  * `Authorization: Bearer {{morf_token}}`

##### 9. (Optional) Adding dependents to the eligibility check

Update the **Initialize Verification Check** rule with an updated request that includes dependent information.

> [accordion] View code
>
> ```jsx theme={null}
> // Organization specific variables
> const organizationName = "Morf Health";
> const npi = "1999999984";
> const service_codes = ["30"];
>
> const morfEligibilityEndpoint = 'https://api.morf.healthcare/v1/stedi/check_eligibility';
>
> function formatDob(dob) {
>   const date = new Date(dob);
>   return {
>     year: date.getFullYear(),
>     month: date.getMonth() + 1,
>     day: date.getDate()
>   };
> }
>
> // Insurance Plan + ID -> Stedi Payer ID
> const selected = insurance_plan_name.value || "";
> const match = selected.match(/-\s*(\d+)/);
> const stedi_payer_id = match ? match[1] : "";
>
> function constructRequest() {
>   return {
>     tradingPartnerServiceId: stedi_payer_id,
>     memberId: insurance_policy_member_id.value,
>     relationship: insurance_relationship.value,
>     subscriber: {
>       firstName:
>         insurance_relationship.value == 'Self'
>           ? first_name.value
>           : policy_holder_first_name.value,
>       lastName:
>         insurance_relationship.value == 'Self'
>           ? last_name.value
>           : policy_holder_last_name.value,
>       ...(insurance_relationship.value === 'Self' && {
>         dateOfBirth: formatDob(date_of_birth.value.split('-'))
>       })
>     },
>     ...(insurance_relationship.value !== 'Self' && {
>       dependent: {
>         firstName: first_name.value,
>         lastName: last_name.value,
>         dateOfBirth: formatDob(date_of_birth.value),
>         relationship: insurance_relationship.value,
>       }
>     }),
>     provider: {
>       organizationName,
>       npi
>     },
>     encounter: {
>       service_type_codes: service_codes
>     },
>     useTestApiKey: feathery.isTestForm()
>   };
> }
>
> const primaryInsuranceResp = await feathery.http.post(
>   morfEligibilityEndpoint,
>   constructRequest()
> );
>
> const summary = primaryInsuranceResp.data.in_network_eligibility_summary;
>
> if (summary?.is_active_and_covered == true) {
>   copay_dollars.value = summary.co_pay_dollars;
>   co_insurance_percentage.value = summary.coinsurance_percentage;
>   insurance_type.value = summary.insurance_type;
>   individual_deductible_remaining_dollars.value = summary.individual_deductible_remaining_dollars;
>   return feathery.goToStep("Eligibility Confirmed");
> }
>
> console.warn("Member not active/covered");
> return feathery.goToStep("Eligibility Failed");
> ```

#### Testing

Stedi offers mock eligibility requests for testing. See the [Stedi mock requests documentation](https://www.stedi.com/docs/healthcare/api-reference/mock-requests-eligibility-checks#test-api-key) for available test cases.

Open the **test version** of your form and fill in information matching one of the mock eligibility results. Use the test `npi`, `organizationName`, and `serviceTypeCodes` shown below:

> [accordion] Example test request
>
> ```jsx theme={null}
> "provider": {
>     "organizationName": "Provider Name",
>     "npi": "1999999984"
> },
> "subscriber": {
>     "firstName": "Jane",
>     "lastName": "Doe",
>     "dateOfBirth": "20040404",
>     "memberId": "AETNA12345"
> },
> "encounter": {
>     "serviceTypeCodes": ["30"]
> }
> ```

# Eligibility Check Endpoint API Reference

Morf's eligibility endpoint is a wrapper around the Stedi API, with dates broken out into objects. Fields are required unless noted as optional. Use this endpoint when enabling synchronous eligiblity checks in your Morf form.

See also: [Stedi's eligibility check documentation](https://www.stedi.com/docs/healthcare/send-eligibility-checks#body---json).

### Request

* A `subscriber` is the patient that's insured.
* For a dependent, include a `dependent` object structured the same as `subscriber`.
* We recommend including `member_id`, `date_of_birth`, `first_name`, and `last_name` — payers are required to return a response if the member is in their database.

**Endpoint:** `POST https://api.morf.healthcare/v1/stedi/check_eligibility`

**Headers:**

* `Authorization: $API_KEY`
* `Content-Type: application/json`

> [accordion] Example request
>
> ```json theme={null}
> {
>   "subscriber": {
>     "member_id": "AETNA12345",
>     "first_name": "Jane",
>     "last_name": "Doe",
>     "date_of_birth": {
>       "year": 2004,
>       "month": 4,
>       "day": 4
>     }
>   },
>   "control_number": "f5738daf-7023-4eb0-a6a1-b626721d2292",
>   "trading_partner_service_id": "60054",
>   "encounter": {
>     "date_of_service": {
>       "year": 2025,
>       "month": 1,
>       "day": 1
>     },
>     "service_type_codes": [
>       "30"
>     ]
>   },
>   "provider": {
>     "npi": "1999999984",
>     "organization_name": "Provider Name"
>   }
> }
> ```

| Field | Notes |
| - | - |
| `control_number` | Any unique request ID (e.g. the form responder's ID) |
| `trading_partner_service_id` | Payer ID — reach out to Morf if you need help finding this |
| `encounter.date_of_service` | Optional. Omit to check eligibility for today |
| `encounter.service_type_codes` | Fixed based on the service classes you provide |

### Response

A successful response returns a `200` status code with the fields below at the top level. Use `is_active_and_covered` and other fields for downstream logic.

> [accordion] Example response
>
> ```json theme={null}
> {
>   "in_network_eligibility_summary": {
>     "co_pay_dollars": 100,
>     "coinsurance_percentage": 20,
>     "family_deductible_dollars": 2000,
>     "family_deductible_remaining_dollars": 842.21,
>     "individual_deductible_dollars": 1000,
>     "individual_deductible_remaining_dollars": 1000,
>     "insurance_type": "Point of Service (POS)",
>     "is_active_and_covered": true,
>     "limitations": [
>       "COMMERCIAL",
>       "20 sessions per year"
>     ],
>     "plan_name": "OA Managed Choice POS"
>   }
>   ... // Other fields left out for clarity here
>
> }
> ```

# Parameters

**Action** `Parameters`

**parameters**

**Payer ID** `string` *required*

`ID`
This field maps to the destination API `tradingPartnerServiceId` field.

**Insurance Plan Member ID** `string` *required*

`ID`
This field maps to the destination API `subscriber.memberId` field.

**Insured First Name** `string`

`PII`
This field maps to the destination API `subscriber.firstName` field.

**Insured Last Name** `string` *required*

`PII`
This field maps to the destination API `subscriber.lastName` field.

**Insured Date Of Birth** `values.v1.Date` *required*

`PII`
This field maps to the destination API `subscriber.dateOfBirth` field.

**Provider National Provider Identifier (NPI)** `string` *required*

This field maps to the destination API `provider.npi` field.

**Provider Organization Name** `string` *required*

This field maps to the destination API `provider.organizationName` field.

**Encounter Date Of Service** `values.v1.Date`

This field maps to the destination API `encounter.dateOfService` field.

**Encounter Service Type Codes** `[]string` *required*

This field maps to the destination API `encounter.serviceTypeCodes` field.

**Process Service Types Sequentially** `bool`

This field maps to the destination API `Default: in parallel` field.

**Use Test API Key** `bool`

This field maps to the destination API `Default: false` field.

```json Result Object Example theme={null}
{
  "$result_object_key": {
    "benefits_information": [
      {
        "additional_information": [
          {
            "description": "Description"
          }
        ],
        "auth_or_cert_indicator": "Y",
        "benefit_amount": "1000",
        "benefit_percent": "80",
        "benefit_quantity": "10",
        "benefits_additional_information": {
          "alternative_list_id": "AL12345",
          "coverage_list_id": "CL12345",
          "drug_formulary_number": "DF12345",
          "family_unit_number": "F12345",
          "group_number": "G12345",
          "hic_number": "HIC12345",
          "insurance_policy_number": "IP12345",
          "medicaid_recipient_id_number": "MRID12345",
          "medical_assistance_category": "MAC123",
          "member_id": "M12345",
          "plan_network_id_number": "PNI12345",
          "plan_number": "P12345",
          "policy_number": "POL12345",
          "prior_authorization_number": "PA12345",
          "referral_number": "R12345"
        },
        "benefits_date_information": {
          "added": "2023-01-01",
          "admission": [
            {
              "date": "2023-01-01",
              "end_date": "2023-01-31",
              "start_date": "2023-01-01"
            }
          ],
          "benefit": "2023-01-01",
          "benefit_begin": "2023-01-01",
          "benefit_end": "2023-01-31",
          "certification": "2023-01-01",
          "cobra_begin": "2023-01-01",
          "cobra_end": "2023-01-31",
          "completion": "2023-01-31",
          "coordination_of_benefits": "2023-01-01",
          "date_of_death": "2023-01-01",
          "date_of_last_update": "2023-01-01",
          "discharges": [
            {
              "date": "2023-01-01",
              "end_date": "2023-01-31",
              "start_date": "2023-01-01"
            }
          ],
          "effective_date_of_change": "2023-01-01",
          "eligibility": "2023-01-01",
          "eligibility_begin": "2023-01-01",
          "eligibility_end": "2023-01-31",
          "enrollment": "2023-01-01",
          "issue": "2023-01-01",
          "latest_visit_or_consultation": "2023-01-01",
          "period_end": "2023-01-31",
          "period_start": "2023-01-01",
          "plan": "2023-01-01",
          "plan_begin": "2023-01-01",
          "plan_end": "2023-01-31",
          "policy_effective": "2023-01-01",
          "policy_expiration": "2023-01-31",
          "premium_paid_to_date_begin": "2023-01-01",
          "premium_paid_to_date_end": "2023-01-31",
          "primary_care_provider": "2023-01-01",
          "service": "2023-01-01",
          "status": "2023-01-01"
        },
        "benefits_related_entities": [
          {
            "address": {
              "address1": "123 Main St",
              "address2": "Apt 4B",
              "city": "New York",
              "country_code": "US",
              "country_sub_division_code": "NYC",
              "postal_code": "10001",
              "state": "NY"
            },
            "contact_information": {
              "contacts": [
                {
                  "communication_mode": "Phone",
                  "communication_number": "123-456-7890"
                }
              ],
              "name": "Jane Doe"
            },
            "entity_first_name": "John",
            "entity_identification": {
              "code": "ID123",
              "value": "Value123"
            },
            "entity_identifier": "EI123",
            "entity_middle_name": "A",
            "entity_name": "Entity Name",
            "entity_relationship": "Relationship",
            "entity_suffix": "Jr.",
            "entity_type": "ET123",
            "provider_information": {
              "provider_code": "PC123",
              "reference_identification": "RI123"
            }
          }
        ],
        "benefits_related_entity": {
          "address": {
            "address1": "123 Main St",
            "address2": "Apt 4B",
            "city": "New York",
            "country_code": "US",
            "country_sub_division_code": "NYC",
            "postal_code": "10001",
            "state": "NY"
          },
          "contact_information": {
            "contacts": [
              {
                "communication_mode": "Phone",
                "communication_number": "123-456-7890"
              }
            ],
            "name": "Jane Doe"
          },
          "entity_first_name": "John",
          "entity_identification": {
            "code": "ID123",
            "value": "Value123"
          },
          "entity_identifier": "EI123",
          "entity_middle_name": "A",
          "entity_name": "Entity Name",
          "entity_relationship": "Relationship",
          "entity_suffix": "Jr.",
          "entity_type": "ET123",
          "provider_information": {
            "provider_code": "PC123",
            "reference_identification": "RI123"
          }
        },
        "benefits_service_delivery": [
          {
            "delivery_or_calendar_pattern_code": "DCPC123",
            "delivery_or_calendar_pattern_qualifier": "Pattern Qualifier",
            "delivery_or_calendar_pattern_qualifier_code": "DCQC123",
            "delivery_pattern_time_code": "DPTC123",
            "delivery_pattern_time_qualifier": "Time Qualifier",
            "delivery_pattern_time_qualifier_code": "DPTQC123",
            "num_of_periods": "5",
            "quantity": "10",
            "quantity_qualifier": "Quantity Qualifier",
            "quantity_qualifier_code": "QQC123",
            "sample_selection_modulus": "SSM123",
            "time_period_qualifier": "Time Qualifier",
            "time_period_qualifier_code": "TPQC123",
            "unit_for_measurement_code": "UMC123",
            "unit_for_measurement_qualifier": "Unit Qualifier",
            "unit_for_measurement_qualifier_code": "UMQC123"
          }
        ],
        "code": "BC123",
        "composite_medical_procedure_identifier": {
          "diagnosis_code_pointer": [
            "DCP1",
            "DCP2"
          ],
          "procedure_code": "PROC123",
          "procedure_modifiers": [
            "MOD1",
            "MOD2"
          ],
          "product_or_service_id": [
            "PSID123",
            "PSID456"
          ],
          "product_or_service_id_qualifier": "HC"
        },
        "coverage_level": "Coverage Level",
        "coverage_level_code": "CLC123",
        "eligibility_additional_information": {
          "code_category": "Category",
          "code_list_qualifier": "Code List Qualifier",
          "code_list_qualifier_code": "CLQC123",
          "industry": "Industry",
          "industry_code": "IC123",
          "injured_body_part_name": "Arm"
        },
        "eligibility_additional_information_list": [
          {
            "code_category": "Category",
            "code_list_qualifier": "Code List Qualifier",
            "code_list_qualifier_code": "CLQC123",
            "industry": "Industry",
            "industry_code": "IC123",
            "injured_body_part_name": "Arm"
          }
        ],
        "header_loop_identifier": "HLI123",
        "in_plan_network_indicator": "Y",
        "insurance_type": "Insurance Type",
        "insurance_type_code": "ITC123",
        "name": "Benefit Name",
        "plan_coverage": "Plan Coverage",
        "quantity_qualifier": "Quantity Qualifier",
        "quantity_qualifier_code": "QQC123",
        "service_type_codes": [
          "STC123",
          "STC456"
        ],
        "time_qualifier": "Time Qualifier",
        "time_qualifier_code": "TQC123",
        "trailer_loop_identifier": "TLI123"
      }
    ],
    "control_number": "123456",
    "dependents": [
      {
        "additional_identification": {
          "agency_claim_number": "AC12345",
          "contract_number": "C12345",
          "health_insurance_claim_number": "HIC12345",
          "identification_card_serial_number": "IDCS12345",
          "insurance_policy_number": "IP12345",
          "medical_record_identification_number": "MR12345",
          "member_identification_number": "M12345",
          "patient_account_number": "PA12345",
          "plan_network_identification_number": "PNI12345",
          "plan_number": "P12345",
          "policy_number": "POL12345"
        },
        "address": {
          "address1": "123 Main St",
          "address2": "Apt 4B",
          "city": "New York",
          "country_code": "US",
          "country_sub_division_code": "NYC",
          "postal_code": "10001",
          "state": "NY"
        },
        "birth_sequence_number": "1",
        "case_number": "C12345",
        "coverage_level_code": "N/A",
        "date_of_birth": "19800101",
        "first_name": "John",
        "gender": "M",
        "group_number": "G12345",
        "health_care_code_information": [
          {
            "diagnosis_code": "12345",
            "diagnosis_type_code": "BK"
          }
        ],
        "id_card": "ID12345",
        "last_name": "Doe",
        "medicaid_recipient_identification_number": "M12345",
        "member_id": "123456",
        "middle_name": "A",
        "provider_code": "AD",
        "provider_identifier": "P12345",
        "reference_identification_qualifier": "9K",
        "spend_down_amount": 100,
        "spend_down_total_billed_amount": 200,
        "ssn": "123-45-6789",
        "suffix": "Jr."
      }
    ],
    "errors": [
      {
        "code": "ERR123",
        "description": "Invalid request",
        "followup_action": "Resubmit",
        "location": "Segment N3",
        "possible_resolutions": "Check the request format"
      }
    ],
    "implementation_transaction_set_syntax_error": "ERR",
    "in_network_eligibility_summary": {
      "co_pay_dollars": 100,
      "coinsurance_percentage": 20,
      "family_deductible_dollars": 2000,
      "family_deductible_remaining_dollars": 842.21,
      "individual_deductible_dollars": 1000,
      "individual_deductible_remaining_dollars": 1000,
      "insurance_type": "Point of Service (POS)",
      "is_active_and_covered": true,
      "limitations": [
        "COMMERCIAL",
        "20 sessions per year"
      ],
      "plan_name": "OA Managed Choice POS"
    },
    "meta": {
      "application_mode": "Production",
      "biller_id": "B12345",
      "outbound_trace_id": "OT12345",
      "sender_id": "S12345",
      "submitter_id": "SUB12345",
      "trace_id": "T12345"
    },
    "payer": {
      "aaa_errors": [
        {
          "code": "ERR123",
          "description": "Invalid request",
          "followup_action": "Resubmit",
          "location": "Segment N3",
          "possible_resolutions": "Check the request format"
        }
      ],
      "centers_for_medicare_and_medicaid_plan_id": "CMS12345",
      "contact_information": {
        "contacts": [
          {
            "communication_mode": "Phone",
            "communication_number": "123-456-7890"
          }
        ],
        "name": "Jane Doe"
      },
      "entity_identifier": "EI123",
      "entity_type": "ET123",
      "etin": "ETIN12345",
      "federal_taxpayers_id_number": "FTIN12345",
      "first_name": "John",
      "last_name": "Doe",
      "middle_name": "A",
      "naic": "NAIC12345",
      "name": "Payer Inc.",
      "npi": "NPI12345",
      "payor_identification": "PID12345",
      "suffix": "Jr."
    },
    "plan_date_information": {
      "added": "2023-01-01",
      "admission": "2023-01-01",
      "certification": "2023-01-01",
      "cobra_begin": "2023-01-01",
      "cobra_end": "2023-01-31",
      "date_of_death": "2023-01-01",
      "date_of_last_update": "2023-01-01",
      "discharge": "2023-01-01",
      "effective_date_of_change": "2023-01-01",
      "eligibility": "2023-01-01",
      "eligibility_begin": "2023-01-01",
      "eligibility_end": "2023-01-31",
      "enrollment": "2023-01-01",
      "issue": "2023-01-01",
      "plan": "2023-01-01",
      "plan_begin": "2023-01-01",
      "plan_end": "2023-01-31",
      "policy_effective": "2023-01-01",
      "policy_expiration": "2023-01-31",
      "premium_paid_to_date_begin": "2023-01-01",
      "premium_paid_to_date_end": "2023-01-31",
      "service": "2023-01-01",
      "status": "2023-01-01"
    },
    "plan_information": {
      "agency_claim_number": "AC12345",
      "alternative_list_id": "AL12345",
      "case_number": "C12345",
      "centers_for_medicare_and_medicaid_services_npi": "CMSNPI12345",
      "class_of_contract_code": "CC123",
      "contract_number": "C12345",
      "coverage_list_id": "CL12345",
      "drug_formulary_number": "DF12345",
      "electronic_device_pin": "EDP12345",
      "eligibility_category": "EC123",
      "facility_id_number": "FID12345",
      "facility_network_identification_number": "FNI12345",
      "family_unit_number": "F12345",
      "federal_taxpayers_identification_number": "FTIN12345",
      "group_description": "Group Plan",
      "group_number": "G12345",
      "hic_number": "HIC12345",
      "id_card_number": "ID12345",
      "id_card_serial_number": "IDCS12345",
      "insurance_policy_number": "IP12345",
      "issue_number": "IN12345",
      "medicaid_provider_number": "MD12345",
      "medicaid_recipient_id_number": "MRID12345",
      "medical_assistance_category": "MAC123",
      "medical_record_identification_number": "MR12345",
      "medicare_provider_number": "MP12345",
      "member_id": "MID12345",
      "patient_account_number": "PA12345",
      "personal_identification_number": "PIN12345",
      "plan_description": "Health Plan",
      "plan_network_id_description": "Plan Network",
      "plan_network_id_number": "PNI12345",
      "plan_number": "PL12345",
      "policy_number": "POL12345",
      "prior_authorization_number": "PA12345",
      "prior_id_number": "PID12345",
      "referral_number": "R12345",
      "social_security_number": "SSN12345",
      "state_license_number": "SL12345",
      "submitter_identification_number": "SID12345",
      "user_identification": "UID12345"
    },
    "provider": {
      "address": {
        "address1": "123 Main St",
        "address2": "Apt 4B",
        "city": "New York",
        "country_code": "US",
        "country_sub_division_code": "NYC",
        "postal_code": "10001",
        "state": "NY"
      },
      "contract_number": "C12345",
      "device_pin_number": "DPN12345",
      "facility_id_number": "FID12345",
      "facility_network_id_number": "FN12345",
      "first_name": "John",
      "information_receiver_additional_identifier_state": "NY",
      "last_name": "Doe",
      "medicaid_provider_number": "MD12345",
      "medicare_provider_number": "MP12345",
      "npi": "1234567890",
      "organization_name": "HealthCare Inc.",
      "payor_id": "P12345",
      "pharmacy_processor_number": "PP12345",
      "prior_identifier_number": "PIN12345",
      "provider_code": "AD",
      "provider_plan_network_id_number": "PPN12345",
      "provider_type": "Individual",
      "reference_identification": "123456",
      "service_provider_number": "SP12345",
      "ssn": "123-45-6789",
      "state_licence_number": "SL12345",
      "submitter_id_number": "SID12345",
      "tax_id": "12-3456789"
    },
    "status": "Error",
    "subscriber": {
      "additional_identification": {
        "agency_claim_number": "AC12345",
        "contract_number": "C12345",
        "health_insurance_claim_number": "HIC12345",
        "identification_card_serial_number": "IDCS12345",
        "insurance_policy_number": "IP12345",
        "medical_record_identification_number": "MR12345",
        "member_identification_number": "M12345",
        "patient_account_number": "PA12345",
        "plan_network_identification_number": "PNI12345",
        "plan_number": "P12345",
        "policy_number": "POL12345"
      },
      "address": {
        "address1": "123 Main St",
        "address2": "Apt 4B",
        "city": "New York",
        "country_code": "US",
        "country_sub_division_code": "NYC",
        "postal_code": "10001",
        "state": "NY"
      },
      "birth_sequence_number": "1",
      "case_number": "C12345",
      "coverage_level_code": "N/A",
      "date_of_birth": "19800101",
      "first_name": "John",
      "gender": "M",
      "group_number": "G12345",
      "health_care_code_information": [
        {
          "diagnosis_code": "12345",
          "diagnosis_type_code": "BK"
        }
      ],
      "id_card": "ID12345",
      "last_name": "Doe",
      "medicaid_recipient_identification_number": "M12345",
      "member_id": "123456",
      "middle_name": "A",
      "provider_code": "AD",
      "provider_identifier": "P12345",
      "reference_identification_qualifier": "9K",
      "spend_down_amount": 100,
      "spend_down_total_billed_amount": 200,
      "ssn": "123-45-6789",
      "suffix": "Jr."
    },
    "subscriber_trace_numbers": [
      {
        "originating_company_identifier": "OCI12345",
        "reference_identification": "RI12345",
        "secondary_reference_identification": "SRI12345",
        "trace_type": "Trace Type",
        "trace_type_code": "TT123"
      }
    ],
    "trading_partner_service_id": "123456",
    "transaction_set_acknowledgement": "ACK",
    "warnings": [
      {
        "code": "WARN123",
        "description": "This is a warning"
      }
    ]
  }
}
```

```json Result Object Description theme={null}
{
  "$result_object_key": {
    "benefits_information": {
      "additional_information": {
        "description": "The additional information description."
      },
      "auth_or_cert_indicator": "The authorization or certification indicator.",
      "benefit_amount": "The benefit amount.",
      "benefit_percent": "The benefit percent.",
      "benefit_quantity": "The benefit quantity.",
      "benefits_additional_information": {
        "alternative_list_id": "The alternative list ID - identifies a list of alternative drugs with the associated formulary status for the patient.",
        "coverage_list_id": "The coverage list ID - identifies a list of drugs that have coverage limitations for the patient.",
        "drug_formulary_number": "The drug formulary number.",
        "family_unit_number": "The family unit number.",
        "group_number": "The group number.",
        "hic_number": "The health insurance claim number.",
        "insurance_policy_number": "The insurance policy number.",
        "medicaid_recipient_id_number": "The Medicaid recipient identification number.",
        "medical_assistance_category": "The medical assistance category.",
        "member_id": "The member identification number.",
        "plan_network_id_number": "The plan network identification number.",
        "plan_number": "The insurance plan number.",
        "policy_number": "The insurance group or policy number.",
        "prior_authorization_number": "The prior authorization number.",
        "referral_number": "The referral number."
      },
      "benefits_date_information": {
        "added": "The date added.",
        "admission": {
          "date": "The admission date.",
          "end_date": "The admission end date.",
          "start_date": "The admission start date."
        },
        "benefit": "The benefit date.",
        "benefit_begin": "The benefit begin date.",
        "benefit_end": "The benefit end date.",
        "certification": "The certification date.",
        "cobra_begin": "The COBRA begin date.",
        "cobra_end": "The COBRA end date.",
        "completion": "The completion date.",
        "coordination_of_benefits": "The coordination of benefits date.",
        "date_of_death": "The date of death.",
        "date_of_last_update": "The date of last update.",
        "discharges": {
          "date": "The discharge date.",
          "end_date": "The discharge end date.",
          "start_date": "The discharge start date."
        },
        "effective_date_of_change": "The effective date of change.",
        "eligibility": "The eligibility date.",
        "eligibility_begin": "The eligibility begin date.",
        "eligibility_end": "The eligibility end date.",
        "enrollment": "The enrollment date.",
        "issue": "The issue date.",
        "latest_visit_or_consultation": "The latest visit or consultation date.",
        "period_end": "The end date of the period.",
        "period_start": "The start date of the period.",
        "plan": "The plan date.",
        "plan_begin": "The plan begin date.",
        "plan_end": "The plan end date.",
        "policy_effective": "The policy effective date.",
        "policy_expiration": "The policy expiration date.",
        "premium_paid_to_date_begin": "The premium paid to date begin.",
        "premium_paid_to_date_end": "The premium paid to date end.",
        "primary_care_provider": "The primary care provider date.",
        "service": "The service date.",
        "status": "The status date."
      },
      "benefits_related_entities": {
        "address": {
          "address1": "The first line of the address.",
          "address2": "The second line of the address.",
          "city": "The city.",
          "country_code": "The two-letter country code.",
          "country_sub_division_code": "The country subdivision code.",
          "postal_code": "The United States or Canadian postal code.",
          "state": "The US state or Canadian province code."
        },
        "contact_information": {
          "contacts": {
            "communication_mode": "The type of communication number provided.",
            "communication_number": "The communication number referenced in communicationMode."
          },
          "name": "The name of the contact person."
        },
        "entity_first_name": "The entity's first name.",
        "entity_identification": {
          "code": "The identification code.",
          "value": "The identification value."
        },
        "entity_identifier": "The entity identifier code.",
        "entity_middle_name": "The entity's middle name or initial.",
        "entity_name": "The entity name.",
        "entity_relationship": "The entity's relationship.",
        "entity_suffix": "The entity's name suffix, such as Jr. or III.",
        "entity_type": "The entity type qualifier.",
        "provider_information": {
          "provider_code": "The provider code.",
          "reference_identification": "The reference identification."
        }
      },
      "benefits_related_entity": {
        "address": {
          "address1": "The first line of the address.",
          "address2": "The second line of the address.",
          "city": "The city.",
          "country_code": "The two-letter country code.",
          "country_sub_division_code": "The country subdivision code.",
          "postal_code": "The United States or Canadian postal code.",
          "state": "The US state or Canadian province code."
        },
        "contact_information": {
          "contacts": {
            "communication_mode": "The type of communication number provided.",
            "communication_number": "The communication number referenced in communicationMode."
          },
          "name": "The name of the contact person."
        },
        "entity_first_name": "The entity's first name.",
        "entity_identification": {
          "code": "The identification code.",
          "value": "The identification value."
        },
        "entity_identifier": "The entity identifier code.",
        "entity_middle_name": "The entity's middle name or initial.",
        "entity_name": "The entity name.",
        "entity_relationship": "The entity's relationship.",
        "entity_suffix": "The entity's name suffix, such as Jr. or III.",
        "entity_type": "The entity type qualifier.",
        "provider_information": {
          "provider_code": "The provider code.",
          "reference_identification": "The reference identification."
        }
      },
      "benefits_service_delivery": {
        "delivery_or_calendar_pattern_code": "The delivery or calendar pattern code.",
        "delivery_or_calendar_pattern_qualifier": "The delivery or calendar pattern qualifier.",
        "delivery_or_calendar_pattern_qualifier_code": "The delivery or calendar pattern qualifier code.",
        "delivery_pattern_time_code": "The delivery pattern time code.",
        "delivery_pattern_time_qualifier": "The delivery pattern time qualifier.",
        "delivery_pattern_time_qualifier_code": "The delivery pattern time qualifier code.",
        "num_of_periods": "The number of periods.",
        "quantity": "The quantity.",
        "quantity_qualifier": "The quantity qualifier.",
        "quantity_qualifier_code": "The quantity qualifier code.",
        "sample_selection_modulus": "The sample selection modulus.",
        "time_period_qualifier": "The time period qualifier.",
        "time_period_qualifier_code": "The time period qualifier code.",
        "unit_for_measurement_code": "The unit for measurement code.",
        "unit_for_measurement_qualifier": "The unit for measurement qualifier.",
        "unit_for_measurement_qualifier_code": "The unit for measurement qualifier code."
      },
      "code": "The benefit code.",
      "composite_medical_procedure_identifier": {
        "diagnosis_code_pointer": "The diagnosis code pointer.",
        "procedure_code": "The procedure code.",
        "procedure_modifiers": "Procedure modifiers that provide additional information.",
        "product_or_service_id": "The product or service ID.",
        "product_or_service_id_qualifier": "Code identifying the type/source of the procedureCode."
      },
      "coverage_level": "The coverage level.",
      "coverage_level_code": "The coverage level code.",
      "eligibility_additional_information": {
        "code_category": "The code category.",
        "code_list_qualifier": "The code list qualifier.",
        "code_list_qualifier_code": "The code list qualifier code.",
        "industry": "The industry.",
        "industry_code": "The industry code.",
        "injured_body_part_name": "The injured body part name."
      },
      "eligibility_additional_information_list": {
        "code_category": "The code category.",
        "code_list_qualifier": "The code list qualifier.",
        "code_list_qualifier_code": "The code list qualifier code.",
        "industry": "The industry.",
        "industry_code": "The industry code.",
        "injured_body_part_name": "The injured body part name."
      },
      "header_loop_identifier": "The header loop identifier.",
      "in_plan_network_indicator": "The in-plan network indicator.",
      "insurance_type": "The insurance type.",
      "insurance_type_code": "The insurance type code.",
      "name": "The benefit name.",
      "plan_coverage": "The plan coverage.",
      "quantity_qualifier": "The quantity qualifier.",
      "quantity_qualifier_code": "The quantity qualifier code.",
      "service_type_codes": "The service type codes.",
      "time_qualifier": "The time qualifier.",
      "time_qualifier_code": "The time qualifier code.",
      "trailer_loop_identifier": "The trailer loop identifier."
    },
    "control_number": "An identifier for the payer's response.",
    "dependents": {
      "additional_identification": {
        "agency_claim_number": "The Property and Casualty Claim Number.",
        "contract_number": "The contract number.",
        "health_insurance_claim_number": "The health insurance claim number.",
        "identification_card_serial_number": "The identification card serial number.",
        "insurance_policy_number": "The insurance policy number.",
        "medical_record_identification_number": "The medical record identification number.",
        "member_identification_number": "The member identification number.",
        "patient_account_number": "The patient account number.",
        "plan_network_identification_number": "The plan network identification number.",
        "plan_number": "The insurance plan number.",
        "policy_number": "The insurance group or policy number."
      },
      "address": {
        "address1": "The first line of the address.",
        "address2": "The second line of the address.",
        "city": "The city.",
        "country_code": "The two-letter country code.",
        "country_sub_division_code": "The country subdivision code.",
        "postal_code": "The United States or Canadian postal code.",
        "state": "The US state or Canadian province code."
      },
      "birth_sequence_number": "The number assigned to each family member born with the same birth date.",
      "case_number": "The case number associated with the dependent.",
      "coverage_level_code": "This property is no longer used.",
      "date_of_birth": "The dependent's date of birth.",
      "first_name": "The dependent's first name.",
      "gender": "Code indicating the dependent's gender. Available options: M, F",
      "group_number": "The group number associated with the dependent's insurance policy.",
      "health_care_code_information": {
        "diagnosis_code": "The diagnosis code.",
        "diagnosis_type_code": "The type of diagnosis code. Available options: BK, ABK, BF, ABF"
      },
      "id_card": "The dependent's identification card number.",
      "last_name": "The dependent's last name.",
      "medicaid_recipient_identification_number": "The Medicaid Recipient Identification Number.",
      "member_id": "The member ID for the dependent's insurance policy.",
      "middle_name": "The dependent's middle name or middle initial.",
      "provider_code": "The provider code. Available options: AD, AT, BI, CO, CV, H, HH, LA, OT, P1, P2, PC, PE, R, RF, SB, SK, SU",
      "provider_identifier": "The provider identifier.",
      "reference_identification_qualifier": "The reference identification qualifier. Available options: 9K, D3, EI, HPI, PXC, SY, TJ",
      "spend_down_amount": "The dollar amount the dependent will apply toward their spend down amount.",
      "spend_down_total_billed_amount": "The dependent's spend down total billed amount.",
      "ssn": "The dependent's Social Security Number (SSN).",
      "suffix": "The name suffix, such as Jr., Sr., or III."
    },
    "errors": {
      "code": "The error code.",
      "description": "The error description.",
      "followup_action": "Allowed actions you can take, based on the rejection reason code.",
      "location": "The location of the error within the original X12 EDI response.",
      "possible_resolutions": "Information to help you correct the error."
    },
    "implementation_transaction_set_syntax_error": "The implementation transaction set error code provided in IK502 of the 999 transaction.",
    "in_network_eligibility_summary": {
      "co_pay_dollars": "The co-pay for the requested service type code",
      "coinsurance_percentage": "The coinsurance percentage for the requested service type code",
      "family_deductible_dollars": "The family deductible for the requested service type code for the calendar year",
      "family_deductible_remaining_dollars": "The family deductible remaining for the requested service type code for the remaining insurance period",
      "individual_deductible_dollars": "The individual deductible for the requested service type code for the calendar year",
      "individual_deductible_remaining_dollars": "The individual deductible remaining for the requested service type code for the remaining insurance period",
      "insurance_type": "The type of insurance for the requested service type code",
      "is_active_and_covered": "The subscriber (or dependent) is actively covered by the insurance payer",
      "limitations": "The limitations for the requested service type code",
      "plan_name": "The plan name for the insurance"
    },
    "meta": {
      "application_mode": "The type of data in the request.",
      "biller_id": "The biller ID Stedi assigns to this request.",
      "outbound_trace_id": "The value provided in the submitterTransactionIdentifier property in the original eligibility check request.",
      "sender_id": "The sender ID Stedi assigns to this request.",
      "submitter_id": "The submitter ID Stedi assigns to this request.",
      "trace_id": "The unique ID Stedi assigns to this request."
    },
    "payer": {
      "aaa_errors": {
        "code": "The error code.",
        "description": "The error description.",
        "followup_action": "Allowed actions you can take, based on the rejection reason code.",
        "location": "The location of the error within the original X12 EDI response.",
        "possible_resolutions": "Information to help you correct the error."
      },
      "centers_for_medicare_and_medicaid_plan_id": "The payer's Centers for Medicare and Medicaid Services PlanID.",
      "contact_information": {
        "contacts": {
          "communication_mode": "The type of communication number provided.",
          "communication_number": "The communication number referenced in communicationMode."
        },
        "name": "The name of the contact person."
      },
      "entity_identifier": "The entity identifier code for the payer.",
      "entity_type": "The entity type qualifier for the payer.",
      "etin": "The payer's Electronic Transmitter Identification Number (ETIN).",
      "federal_taxpayers_id_number": "The payer's federal taxpayer's identification number.",
      "first_name": "The payer's first name, when the payer is an individual (not commonly used).",
      "last_name": "The payer's last name. Used when the payer is an individual (not commonly used).",
      "middle_name": "The payer's middle name or initial, when the payer is an individual (not commonly used).",
      "naic": "The payer's National Association of Insurance Commissioners (NAIC) identification number.",
      "name": "The payer's business name, when the payer is not a person.",
      "npi": "The payer's National Provider Identifier (NPI).",
      "payor_identification": "The payor identification.",
      "suffix": "The payer's name suffix, such as Jr. or III. Used when the payer is an individual (not commonly used)."
    },
    "plan_date_information": {
      "added": "The date added.",
      "admission": "The admission date.",
      "certification": "The certification date.",
      "cobra_begin": "The COBRA begin date.",
      "cobra_end": "The COBRA end date.",
      "date_of_death": "The date of death.",
      "date_of_last_update": "The date of last update.",
      "discharge": "The date of discharge.",
      "effective_date_of_change": "The effective date of change.",
      "eligibility": "The eligibility date.",
      "eligibility_begin": "The eligibility begin date.",
      "eligibility_end": "The eligibility end date.",
      "enrollment": "The enrollment date.",
      "issue": "The issue date.",
      "plan": "The plan date.",
      "plan_begin": "The plan begin date.",
      "plan_end": "The plan end date.",
      "policy_effective": "The policy effective date.",
      "policy_expiration": "The policy expiration date.",
      "premium_paid_to_date_begin": "The premium paid to date begin.",
      "premium_paid_to_date_end": "The premium paid to date end.",
      "service": "The service date.",
      "status": "The status date."
    },
    "plan_information": {
      "agency_claim_number": "The agency claim number, only used when the information source is a Property and Casualty payer.",
      "alternative_list_id": "The alternative list ID - identifies a list of alternative drugs with the associated formulary status for the patient.",
      "case_number": "The case number.",
      "centers_for_medicare_and_medicaid_services_npi": "The National Provider Identifier (NPI) assigned by the Centers for Medicare and Medicaid Services.",
      "class_of_contract_code": "The class of contract code - used to identify the applicable class of contract for claims processing.",
      "contract_number": "The contract number of a contract between the payer and the provider that requested the eligibility check.",
      "coverage_list_id": "The coverage list ID - identifies a list of drugs that have coverage limitations for the patient.",
      "drug_formulary_number": "The drug formulary number.",
      "electronic_device_pin": "The electronic device pin number.",
      "eligibility_category": "The eligibility category.",
      "facility_id_number": "The facility ID number.",
      "facility_network_identification_number": "The facility network identification number.",
      "family_unit_number": "The family unit number.",
      "federal_taxpayers_identification_number": "The federal taxpayer's identification number.",
      "group_description": "The group description.",
      "group_number": "The group number.",
      "hic_number": "The health insurance claim number.",
      "id_card_number": "The identity card number, used when the Identity Card Number is different than the Member Identification Number.",
      "id_card_serial_number": "The identification card serial number. The Identification Card Serial Number uniquely identifies the identification card when multiple cards have been or will be issued to a member, such as a replacement card.",
      "insurance_policy_number": "The insurance policy number.",
      "issue_number": "The issue number.",
      "medicaid_provider_number": "The Medicaid provider number.",
      "medicaid_recipient_id_number": "The Medicaid recipient identification number.",
      "medical_assistance_category": "The medical assistance category.",
      "medical_record_identification_number": "The medical record identification number.",
      "medicare_provider_number": "The Medicare provider number.",
      "member_id": "The member identification number - only used when checking eligibility with a Workers' Compensation or Property and Casualty insurer.",
      "patient_account_number": "The patient account number. If you included this value in the original eligibility request, the payer will return the same value here in the response.",
      "personal_identification_number": "The personal identification number (PIN).",
      "plan_description": "The plan description.",
      "plan_network_id_description": "The plan, group, or plan network name.",
      "plan_network_id_number": "The plan network identification number.",
      "plan_number": "The plan number.",
      "policy_number": "The group or policy number.",
      "prior_authorization_number": "The prior authorization number.",
      "prior_id_number": "The prior identifier number.",
      "referral_number": "The referral number.",
      "social_security_number": "The social security number.",
      "state_license_number": "The state license number.",
      "submitter_identification_number": "The submitter identification number.",
      "user_identification": "The user identification."
    },
    "provider": {
      "address": {
        "address1": "The first line of the address.",
        "address2": "The second line of the address.",
        "city": "The city.",
        "country_code": "The two-letter country code.",
        "country_sub_division_code": "The country subdivision code.",
        "postal_code": "The United States or Canadian postal code.",
        "state": "The US state or Canadian province code."
      },
      "contract_number": "The provider's contract number.",
      "device_pin_number": "The provider's electronic device pin number.",
      "facility_id_number": "The provider's facility ID number.",
      "facility_network_id_number": "The provider's facility network identification number.",
      "first_name": "The provider's first name. Required if the provider is an individual.",
      "information_receiver_additional_identifier_state": "The state that assigned the state license number.",
      "last_name": "The provider's last name. Required if the provider is an individual.",
      "medicaid_provider_number": "The provider's Medicaid provider number.",
      "medicare_provider_number": "The provider's Medicare provider number.",
      "npi": "The provider's National Provider Identifier (NPI).",
      "organization_name": "The provider's business name. Required if the provider is not a person.",
      "payor_id": "Only used for payer-to-payer transactions.",
      "pharmacy_processor_number": "The provider's pharmacy processor number.",
      "prior_identifier_number": "The provider's prior identifier number.",
      "provider_code": "The provider's role in the type of benefits specified in the request.",
      "provider_plan_network_id_number": "The provider's plan network identification number.",
      "provider_type": "The type of provider.",
      "reference_identification": "The provider's Taxonomy Code.",
      "service_provider_number": "The provider's service provider number.",
      "ssn": "The provider's Social Security Number (SSN).",
      "state_licence_number": "The provider's state license number.",
      "submitter_id_number": "The provider's submitter identification number.",
      "tax_id": "The provider's Federal Taxpayer Identification Number (EIN)."
    },
    "status": "Errors Stedi encountered when generating or sending the final X12 EDI transaction to the payer. These can include validation errors and payer unavailable errors that prevent delivery.",
    "subscriber": {
      "additional_identification": {
        "agency_claim_number": "The Property and Casualty Claim Number.",
        "contract_number": "The contract number.",
        "health_insurance_claim_number": "The health insurance claim number.",
        "identification_card_serial_number": "The identification card serial number.",
        "insurance_policy_number": "The insurance policy number.",
        "medical_record_identification_number": "The medical record identification number.",
        "member_identification_number": "The member identification number.",
        "patient_account_number": "The patient account number.",
        "plan_network_identification_number": "The plan network identification number.",
        "plan_number": "The insurance plan number.",
        "policy_number": "The insurance group or policy number."
      },
      "address": {
        "address1": "The first line of the address.",
        "address2": "The second line of the address.",
        "city": "The city.",
        "country_code": "The two-letter country code.",
        "country_sub_division_code": "The country subdivision code.",
        "postal_code": "The United States or Canadian postal code.",
        "state": "The US state or Canadian province code."
      },
      "birth_sequence_number": "The number assigned to each family member born with the same birth date.",
      "case_number": "The case number associated with the subscriber.",
      "coverage_level_code": "This property is no longer used.",
      "date_of_birth": "The subscriber's date of birth",
      "first_name": "The patient's first name.",
      "gender": "Code indicating the subscriber's gender. Available options: M, F",
      "group_number": "The group number associated with the subscriber's insurance policy.",
      "health_care_code_information": {
        "diagnosis_code": "The diagnosis code.",
        "diagnosis_type_code": "The type of diagnosis code. Available options: BK, ABK, BF, ABF"
      },
      "id_card": "The subscriber's identification card number.",
      "last_name": "The subscriber's last name.",
      "medicaid_recipient_identification_number": "The Medicaid Recipient Identification Number.",
      "member_id": "The member ID for the subscriber's insurance policy.",
      "middle_name": "The patient's middle name or middle initial.",
      "provider_code": "The provider code. Available options: AD, AT, BI, CO, CV, H, HH, LA, OT, P1, P2, PC, PE, R, RF, SB, SK, SU",
      "provider_identifier": "The provider identifier.",
      "reference_identification_qualifier": "The reference identification qualifier. Available options: 9K, D3, EI, HPI, PXC, SY, TJ",
      "spend_down_amount": "The dollar amount the subscriber will apply toward their spend down amount.",
      "spend_down_total_billed_amount": "The subscriber's spend down total billed amount.",
      "ssn": "The subscriber's Social Security Number (SSN).",
      "suffix": "The name suffix, such as Jr., Sr., or III."
    },
    "subscriber_trace_numbers": {
      "originating_company_identifier": "The identifier of the organization that assigned the trace number.",
      "reference_identification": "The unique trace number assigned to the transaction.",
      "secondary_reference_identification": "Identifies a subdivision within the organization that assigned the trace number.",
      "trace_type": "The full name of the traceTypeCode.",
      "trace_type_code": "The code that identifies the type of trace number."
    },
    "trading_partner_service_id": "An ID for the payer you identified in the original eligibility check request. This value may differ from the tradingPartnerServiceId you submitted in the original request because it reflects the payer's internal concept of their ID, not necessarily the ID Stedi uses to route requests to this payer.",
    "transaction_set_acknowledgement": "The transaction set acknowledgment code provided in in the X12 EDI 999 response.",
    "warnings": {
      "code": "The warning code.",
      "description": "The warning description."
    }
  }
}
```

### Result Object Field Details

You can use the result of the action's data as inputs to downstream workflow actions.

Each fetch action requires an object name, which nests the action's result data inside the downstream data context in the workflow. See [Passing Data Between Actions](https://docs.morf.health/docs/knowledge_base/passing_data_between_actions.md) for how to set it and reference the result from downstream nodes.

Here we demonstrate how to refer to this data using the prefix `$result_object_key`.

**CheckEligibilityResponse** `Fetch Action Response Object`

**fields**

**meta** `object`

*Description coming soon*

```json CEL theme={null}
$result_object_key.meta
```

```json Example theme={null}
{
"application_mode": "Production",
"biller_id": "B12345",
"outbound_trace_id": "OT12345",
"sender_id": "S12345",
"submitter_id": "SUB12345",
"trace_id": "T12345"
}
```

**meta.sender\_id** `string`

The sender ID Stedi assigns to this request.

```json CEL theme={null}
$result_object_key.meta.sender_id
```

```json Example theme={null}
"S12345"
```

**meta.submitter\_id** `string`

The submitter ID Stedi assigns to this request.

```json CEL theme={null}
$result_object_key.meta.submitter_id
```

```json Example theme={null}
"SUB12345"
```

**meta.biller\_id** `string`

The biller ID Stedi assigns to this request.

```json CEL theme={null}
$result_object_key.meta.biller_id
```

```json Example theme={null}
"B12345"
```

**meta.application\_mode** `string`

The type of data in the request.

```json CEL theme={null}
$result_object_key.meta.application_mode
```

```json Example theme={null}
"Production"
```

**meta.trace\_id** `string`

The unique ID Stedi assigns to this request.

```json CEL theme={null}
$result_object_key.meta.trace_id
```

```json Example theme={null}
"T12345"
```

**meta.outbound\_trace\_id** `string`

The value provided in the submitterTransactionIdentifier property in the original eligibility check request.

```json CEL theme={null}
$result_object_key.meta.outbound_trace_id
```

```json Example theme={null}
"OT12345"
```

**control\_number** `string`

An identifier for the payer's response.

```json CEL theme={null}
$result_object_key.control_number
```

```json Example theme={null}
"123456"
```

**trading\_partner\_service\_id** `string`

An ID for the payer you identified in the original eligibility check request. This value may differ from the tradingPartnerServiceId you submitted in the original request because it reflects the payer's internal concept of their ID, not necessarily the ID Stedi uses to route requests to this payer.

```json CEL theme={null}
$result_object_key.trading_partner_service_id
```

```json Example theme={null}
"123456"
```

**provider** `object`

*Description coming soon*

```json CEL theme={null}
$result_object_key.provider
```

```json Example theme={null}
{
"address": {
"address1": "123 Main St",
"address2": "Apt 4B",
"city": "New York",
"country_code": "US",
"country_sub_division_code": "NYC",
"postal_code": "10001",
"state": "NY"
},
"contract_number": "C12345",
"device_pin_number": "DPN12345",
"facility_id_number": "FID12345",
"facility_network_id_number": "FN12345",
"first_name": "John",
"information_receiver_additional_identifier_state": "NY",
"last_name": "Doe",
"medicaid_provider_number": "MD12345",
"medicare_provider_number": "MP12345",
"npi": "1234567890",
"organization_name": "HealthCare Inc.",
"payor_id": "P12345",
"pharmacy_processor_number": "PP12345",
"prior_identifier_number": "PIN12345",
"provider_code": "AD",
"provider_plan_network_id_number": "PPN12345",
"provider_type": "Individual",
"reference_identification": "123456",
"service_provider_number": "SP12345",
"ssn": "123-45-6789",
"state_licence_number": "SL12345",
"submitter_id_number": "SID12345",
"tax_id": "12-3456789"
}
```

**provider.organization\_name** `string`

The provider's business name. Required if the provider is not a person.

```json CEL theme={null}
$result_object_key.provider.organization_name
```

```json Example theme={null}
"HealthCare Inc."
```

**provider.first\_name** `string`

The provider's first name. Required if the provider is an individual.

```json CEL theme={null}
$result_object_key.provider.first_name
```

```json Example theme={null}
"John"
```

**provider.last\_name** `string`

The provider's last name. Required if the provider is an individual.

```json CEL theme={null}
$result_object_key.provider.last_name
```

```json Example theme={null}
"Doe"
```

**provider.npi** `string`

The provider's National Provider Identifier (NPI).

```json CEL theme={null}
$result_object_key.provider.npi
```

```json Example theme={null}
"1234567890"
```

**provider.service\_provider\_number** `string`

The provider's service provider number.

```json CEL theme={null}
$result_object_key.provider.service_provider_number
```

```json Example theme={null}
"SP12345"
```

**provider.payor\_id** `string`

Only used for payer-to-payer transactions.

```json CEL theme={null}
$result_object_key.provider.payor_id
```

```json Example theme={null}
"P12345"
```

**provider.tax\_id** `string`

The provider's Federal Taxpayer Identification Number (EIN).

```json CEL theme={null}
$result_object_key.provider.tax_id
```

```json Example theme={null}
"12-3456789"
```

**provider.ssn** `string`

The provider's Social Security Number (SSN).

```json CEL theme={null}
$result_object_key.provider.ssn
```

```json Example theme={null}
"123-45-6789"
```

**provider.pharmacy\_processor\_number** `string`

The provider's pharmacy processor number.

```json CEL theme={null}
$result_object_key.provider.pharmacy_processor_number
```

```json Example theme={null}
"PP12345"
```

**provider.provider\_code** `string`

The provider's role in the type of benefits specified in the request.

```json CEL theme={null}
$result_object_key.provider.provider_code
```

```json Example theme={null}
"AD"
```

**provider.reference\_identification** `string`

The provider's Taxonomy Code.

```json CEL theme={null}
$result_object_key.provider.reference_identification
```

```json Example theme={null}
"123456"
```

**provider.provider\_type** `string`

The type of provider.

```json CEL theme={null}
$result_object_key.provider.provider_type
```

```json Example theme={null}
"Individual"
```

**provider.state\_licence\_number** `string`

The provider's state license number.

```json CEL theme={null}
$result_object_key.provider.state_licence_number
```

```json Example theme={null}
"SL12345"
```

**provider.medicare\_provider\_number** `string`

The provider's Medicare provider number.

```json CEL theme={null}
$result_object_key.provider.medicare_provider_number
```

```json Example theme={null}
"MP12345"
```

**provider.medicaid\_provider\_number** `string`

The provider's Medicaid provider number.

```json CEL theme={null}
$result_object_key.provider.medicaid_provider_number
```

```json Example theme={null}
"MD12345"
```

**provider.facility\_id\_number** `string`

The provider's facility ID number.

```json CEL theme={null}
$result_object_key.provider.facility_id_number
```

```json Example theme={null}
"FID12345"
```

**provider.contract\_number** `string`

The provider's contract number.

```json CEL theme={null}
$result_object_key.provider.contract_number
```

```json Example theme={null}
"C12345"
```

**provider.device\_pin\_number** `string`

The provider's electronic device pin number.

```json CEL theme={null}
$result_object_key.provider.device_pin_number
```

```json Example theme={null}
"DPN12345"
```

**provider.submitter\_id\_number** `string`

The provider's submitter identification number.

```json CEL theme={null}
$result_object_key.provider.submitter_id_number
```

```json Example theme={null}
"SID12345"
```

**provider.provider\_plan\_network\_id\_number** `string`

The provider's plan network identification number.

```json CEL theme={null}
$result_object_key.provider.provider_plan_network_id_number
```

```json Example theme={null}
"PPN12345"
```

**provider.facility\_network\_id\_number** `string`

The provider's facility network identification number.

```json CEL theme={null}
$result_object_key.provider.facility_network_id_number
```

```json Example theme={null}
"FN12345"
```

**provider.prior\_identifier\_number** `string`

The provider's prior identifier number.

```json CEL theme={null}
$result_object_key.provider.prior_identifier_number
```

```json Example theme={null}
"PIN12345"
```

**provider.information\_receiver\_additional\_identifier\_state** `string`

The state that assigned the state license number.

```json CEL theme={null}
$result_object_key.provider.information_receiver_additional_identifier_state
```

```json Example theme={null}
"NY"
```

**provider.address** `object`

*Description coming soon*

```json CEL theme={null}
$result_object_key.provider.address
```

```json Example theme={null}
{
"address1": "123 Main St",
"address2": "Apt 4B",
"city": "New York",
"country_code": "US",
"country_sub_division_code": "NYC",
"postal_code": "10001",
"state": "NY"
}
```

**provider.address.address1** `string`

The first line of the address.

```json CEL theme={null}
$result_object_key.provider.address.address1
```

```json Example theme={null}
"123 Main St"
```

**provider.address.address2** `string`

The second line of the address.

```json CEL theme={null}
$result_object_key.provider.address.address2
```

```json Example theme={null}
"Apt 4B"
```

**provider.address.city** `string`

The city.

```json CEL theme={null}
$result_object_key.provider.address.city
```

```json Example theme={null}
"New York"
```

**provider.address.state** `string`

The US state or Canadian province code.

```json CEL theme={null}
$result_object_key.provider.address.state
```

```json Example theme={null}
"NY"
```

**provider.address.postal\_code** `string`

The United States or Canadian postal code.

```json CEL theme={null}
$result_object_key.provider.address.postal_code
```

```json Example theme={null}
"10001"
```

**provider.address.country\_code** `string`

The two-letter country code.

```json CEL theme={null}
$result_object_key.provider.address.country_code
```

```json Example theme={null}
"US"
```

**provider.address.country\_sub\_division\_code** `string`

The country subdivision code.

```json CEL theme={null}
$result_object_key.provider.address.country_sub_division_code
```

```json Example theme={null}
"NYC"
```

**subscriber** `object`

*Description coming soon*

```json CEL theme={null}
$result_object_key.subscriber
```

```json Example theme={null}
{
"additional_identification": {
"agency_claim_number": "AC12345",
"contract_number": "C12345",
"health_insurance_claim_number": "HIC12345",
"identification_card_serial_number": "IDCS12345",
"insurance_policy_number": "IP12345",
"medical_record_identification_number": "MR12345",
"member_identification_number": "M12345",
"patient_account_number": "PA12345",
"plan_network_identification_number": "PNI12345",
"plan_number": "P12345",
"policy_number": "POL12345"
},
"address": {
"address1": "123 Main St",
"address2": "Apt 4B",
"city": "New York",
"country_code": "US",
"country_sub_division_code": "NYC",
"postal_code": "10001",
"state": "NY"
},
"birth_sequence_number": "1",
"case_number": "C12345",
"coverage_level_code": "N/A",
"date_of_birth": "19800101",
"first_name": "John",
"gender": "M",
"group_number": "G12345",
"health_care_code_information": [
{
"diagnosis_code": "12345",
"diagnosis_type_code": "BK"
}
],
"id_card": "ID12345",
"last_name": "Doe",
"medicaid_recipient_identification_number": "M12345",
"member_id": "123456",
"middle_name": "A",
"provider_code": "AD",
"provider_identifier": "P12345",
"reference_identification_qualifier": "9K",
"spend_down_amount": 100,
"spend_down_total_billed_amount": 200,
"ssn": "123-45-6789",
"suffix": "Jr."
}
```

**subscriber.member\_id** `string`

The member ID for the subscriber's insurance policy.

```json CEL theme={null}
$result_object_key.subscriber.member_id
```

```json Example theme={null}
"123456"
```

**subscriber.date\_of\_birth** `values.v1.Date`

The subscriber's date of birth

```json CEL theme={null}
$result_object_key.subscriber.date_of_birth
```

```json Example theme={null}
"19800101"
```

**subscriber.first\_name** `string`

The patient's first name.

```json CEL theme={null}
$result_object_key.subscriber.first_name
```

```json Example theme={null}
"John"
```

**subscriber.middle\_name** `string`

The patient's middle name or middle initial.

```json CEL theme={null}
$result_object_key.subscriber.middle_name
```

```json Example theme={null}
"A"
```

**subscriber.last\_name** `string`

The subscriber's last name.

```json CEL theme={null}
$result_object_key.subscriber.last_name
```

```json Example theme={null}
"Doe"
```

**subscriber.suffix** `string`

The name suffix, such as Jr., Sr., or III.

```json CEL theme={null}
$result_object_key.subscriber.suffix
```

```json Example theme={null}
"Jr."
```

**subscriber.gender** `string`

Code indicating the subscriber's gender. Available options: M, F

```json CEL theme={null}
$result_object_key.subscriber.gender
```

```json Example theme={null}
"M"
```

**subscriber.ssn** `string`

The subscriber's Social Security Number (SSN).

```json CEL theme={null}
$result_object_key.subscriber.ssn
```

```json Example theme={null}
"123-45-6789"
```

**subscriber.group\_number** `string`

The group number associated with the subscriber's insurance policy.

```json CEL theme={null}
$result_object_key.subscriber.group_number
```

```json Example theme={null}
"G12345"
```

**subscriber.id\_card** `string`

The subscriber's identification card number.

```json CEL theme={null}
$result_object_key.subscriber.id_card
```

```json Example theme={null}
"ID12345"
```

**subscriber.provider\_code** `string`

The provider code. Available options: AD, AT, BI, CO, CV, H, HH, LA, OT, P1, P2, PC, PE, R, RF, SB, SK, SU

```json CEL theme={null}
$result_object_key.subscriber.provider_code
```

```json Example theme={null}
"AD"
```

**subscriber.reference\_identification\_qualifier** `string`

The reference identification qualifier. Available options: 9K, D3, EI, HPI, PXC, SY, TJ

```json CEL theme={null}
$result_object_key.subscriber.reference_identification_qualifier
```

```json Example theme={null}
"9K"
```

**subscriber.provider\_identifier** `string`

The provider identifier.

```json CEL theme={null}
$result_object_key.subscriber.provider_identifier
```

```json Example theme={null}
"P12345"
```

**subscriber.health\_care\_code\_information** `[]object`

*Description coming soon*

```json CEL theme={null}
$result_object_key.subscriber.health_care_code_information
```

```json Example theme={null}
[
{
"diagnosis_code": "12345",
"diagnosis_type_code": "BK"
}
]
```

**subscriber.health\_care\_code\_information.map(x, x.diagnosis\_type\_code)** `[]string` *required*

Mapped array of: The type of diagnosis code. Available options: BK, ABK, BF, ABF

```json CEL theme={null}
$result_object_key.subscriber.health_care_code_information.map(x, x.diagnosis_type_code)
```

```json Example theme={null}
[
"BK"
]
```

**subscriber.health\_care\_code\_information.map(x, x.diagnosis\_code)** `[]string` *required*

Mapped array of: The diagnosis code.

```json CEL theme={null}
$result_object_key.subscriber.health_care_code_information.map(x, x.diagnosis_code)
```

```json Example theme={null}
[
"12345"
]
```

**subscriber.address** `object`

*Description coming soon*

```json CEL theme={null}
$result_object_key.subscriber.address
```

```json Example theme={null}
{
"address1": "123 Main St",
"address2": "Apt 4B",
"city": "New York",
"country_code": "US",
"country_sub_division_code": "NYC",
"postal_code": "10001",
"state": "NY"
}
```

**subscriber.address.address1** `string`

The first line of the address.

```json CEL theme={null}
$result_object_key.subscriber.address.address1
```

```json Example theme={null}
"123 Main St"
```

**subscriber.address.address2** `string`

The second line of the address.

```json CEL theme={null}
$result_object_key.subscriber.address.address2
```

```json Example theme={null}
"Apt 4B"
```

**subscriber.address.city** `string`

The city.

```json CEL theme={null}
$result_object_key.subscriber.address.city
```

```json Example theme={null}
"New York"
```

**subscriber.address.state** `string`

The US state or Canadian province code.

```json CEL theme={null}
$result_object_key.subscriber.address.state
```

```json Example theme={null}
"NY"
```

**subscriber.address.postal\_code** `string`

The United States or Canadian postal code.

```json CEL theme={null}
$result_object_key.subscriber.address.postal_code
```

```json Example theme={null}
"10001"
```

**subscriber.address.country\_code** `string`

The two-letter country code.

```json CEL theme={null}
$result_object_key.subscriber.address.country_code
```

```json Example theme={null}
"US"
```

**subscriber.address.country\_sub\_division\_code** `string`

The country subdivision code.

```json CEL theme={null}
$result_object_key.subscriber.address.country_sub_division_code
```

```json Example theme={null}
"NYC"
```

**subscriber.additional\_identification** `object`

*Description coming soon*

```json CEL theme={null}
$result_object_key.subscriber.additional_identification
```

```json Example theme={null}
{
"agency_claim_number": "AC12345",
"contract_number": "C12345",
"health_insurance_claim_number": "HIC12345",
"identification_card_serial_number": "IDCS12345",
"insurance_policy_number": "IP12345",
"medical_record_identification_number": "MR12345",
"member_identification_number": "M12345",
"patient_account_number": "PA12345",
"plan_network_identification_number": "PNI12345",
"plan_number": "P12345",
"policy_number": "POL12345"
}
```

**subscriber.additional\_identification.plan\_number** `string`

The insurance plan number.

```json CEL theme={null}
$result_object_key.subscriber.additional_identification.plan_number
```

```json Example theme={null}
"P12345"
```

**subscriber.additional\_identification.policy\_number** `string`

The insurance group or policy number.

```json CEL theme={null}
$result_object_key.subscriber.additional_identification.policy_number
```

```json Example theme={null}
"POL12345"
```

**subscriber.additional\_identification.member\_identification\_number** `string`

The member identification number.

```json CEL theme={null}
$result_object_key.subscriber.additional_identification.member_identification_number
```

```json Example theme={null}
"M12345"
```

**subscriber.additional\_identification.contract\_number** `string`

The contract number.

```json CEL theme={null}
$result_object_key.subscriber.additional_identification.contract_number
```

```json Example theme={null}
"C12345"
```

**subscriber.additional\_identification.medical\_record\_identification\_number** `string`

The medical record identification number.

```json CEL theme={null}
$result_object_key.subscriber.additional_identification.medical_record_identification_number
```

```json Example theme={null}
"MR12345"
```

**subscriber.additional\_identification.patient\_account\_number** `string`

The patient account number.

```json CEL theme={null}
$result_object_key.subscriber.additional_identification.patient_account_number
```

```json Example theme={null}
"PA12345"
```

**subscriber.additional\_identification.health\_insurance\_claim\_number** `string`

The health insurance claim number.

```json CEL theme={null}
$result_object_key.subscriber.additional_identification.health_insurance_claim_number
```

```json Example theme={null}
"HIC12345"
```

**subscriber.additional\_identification.identification\_card\_serial\_number** `string`

The identification card serial number.

```json CEL theme={null}
$result_object_key.subscriber.additional_identification.identification_card_serial_number
```

```json Example theme={null}
"IDCS12345"
```

**subscriber.additional\_identification.insurance\_policy\_number** `string`

The insurance policy number.

```json CEL theme={null}
$result_object_key.subscriber.additional_identification.insurance_policy_number
```

```json Example theme={null}
"IP12345"
```

**subscriber.additional\_identification.plan\_network\_identification\_number** `string`

The plan network identification number.

```json CEL theme={null}
$result_object_key.subscriber.additional_identification.plan_network_identification_number
```

```json Example theme={null}
"PNI12345"
```

**subscriber.additional\_identification.agency\_claim\_number** `string`

The Property and Casualty Claim Number.

```json CEL theme={null}
$result_object_key.subscriber.additional_identification.agency_claim_number
```

```json Example theme={null}
"AC12345"
```

**subscriber.birth\_sequence\_number** `string`

The number assigned to each family member born with the same birth date.

```json CEL theme={null}
$result_object_key.subscriber.birth_sequence_number
```

```json Example theme={null}
"1"
```

**subscriber.case\_number** `string`

The case number associated with the subscriber.

```json CEL theme={null}
$result_object_key.subscriber.case_number
```

```json Example theme={null}
"C12345"
```

**subscriber.medicaid\_recipient\_identification\_number** `string`

The Medicaid Recipient Identification Number.

```json CEL theme={null}
$result_object_key.subscriber.medicaid_recipient_identification_number
```

```json Example theme={null}
"M12345"
```

**subscriber.spend\_down\_amount** `float64 (double)`

The dollar amount the subscriber will apply toward their spend down amount.

```json CEL theme={null}
$result_object_key.subscriber.spend_down_amount
```

```json Example theme={null}
100
```

**subscriber.spend\_down\_total\_billed\_amount** `float64 (double)`

The subscriber's spend down total billed amount.

```json CEL theme={null}
$result_object_key.subscriber.spend_down_total_billed_amount
```

```json Example theme={null}
200
```

**subscriber.coverage\_level\_code** `string`

This property is no longer used.

```json CEL theme={null}
$result_object_key.subscriber.coverage_level_code
```

```json Example theme={null}
"N/A"
```

**subscriber\_trace\_numbers** `[]object` *required*

*Description coming soon*

```json CEL theme={null}
$result_object_key.subscriber_trace_numbers
```

```json Example theme={null}
[
{
"originating_company_identifier": "OCI12345",
"reference_identification": "RI12345",
"secondary_reference_identification": "SRI12345",
"trace_type": "Trace Type",
"trace_type_code": "TT123"
}
]
```

**subscriber\_trace\_numbers.map(x, x.trace\_type\_code)** `[]string` *required*

Mapped array of: The code that identifies the type of trace number.

```json CEL theme={null}
$result_object_key.subscriber_trace_numbers.map(x, x.trace_type_code)
```

```json Example theme={null}
[
"TT123"
]
```

**subscriber\_trace\_numbers.map(x, x.trace\_type)** `[]string` *required*

Mapped array of: The full name of the traceTypeCode.

```json CEL theme={null}
$result_object_key.subscriber_trace_numbers.map(x, x.trace_type)
```

```json Example theme={null}
[
"Trace Type"
]
```

**subscriber\_trace\_numbers.map(x, x.reference\_identification)** `[]string` *required*

Mapped array of: The unique trace number assigned to the transaction.

```json CEL theme={null}
$result_object_key.subscriber_trace_numbers.map(x, x.reference_identification)
```

```json Example theme={null}
[
"RI12345"
]
```

**subscriber\_trace\_numbers.map(x, x.originating\_company\_identifier)** `[]string` *required*

Mapped array of: The identifier of the organization that assigned the trace number.

```json CEL theme={null}
$result_object_key.subscriber_trace_numbers.map(x, x.originating_company_identifier)
```

```json Example theme={null}
[
"OCI12345"
]
```

**subscriber\_trace\_numbers.map(x, x.secondary\_reference\_identification)** `[]string` *required*

Mapped array of: Identifies a subdivision within the organization that assigned the trace number.

```json CEL theme={null}
$result_object_key.subscriber_trace_numbers.map(x, x.secondary_reference_identification)
```

```json Example theme={null}
[
"SRI12345"
]
```

**payer** `object`

*Description coming soon*

```json CEL theme={null}
$result_object_key.payer
```

```json Example theme={null}
{
"aaa_errors": [
{
"code": "ERR123",
"description": "Invalid request",
"followup_action": "Resubmit",
"location": "Segment N3",
"possible_resolutions": "Check the request format"
}
],
"centers_for_medicare_and_medicaid_plan_id": "CMS12345",
"contact_information": {
"contacts": [
{
  "communication_mode": "Phone",
  "communication_number": "123-456-7890"
}
],
"name": "Jane Doe"
},
"entity_identifier": "EI123",
"entity_type": "ET123",
"etin": "ETIN12345",
"federal_taxpayers_id_number": "FTIN12345",
"first_name": "John",
"last_name": "Doe",
"middle_name": "A",
"naic": "NAIC12345",
"name": "Payer Inc.",
"npi": "NPI12345",
"payor_identification": "PID12345",
"suffix": "Jr."
}
```

**payer.entity\_identifier** `string`

The entity identifier code for the payer.

```json CEL theme={null}
$result_object_key.payer.entity_identifier
```

```json Example theme={null}
"EI123"
```

**payer.entity\_type** `string`

The entity type qualifier for the payer.

```json CEL theme={null}
$result_object_key.payer.entity_type
```

```json Example theme={null}
"ET123"
```

**payer.first\_name** `string`

The payer's first name, when the payer is an individual (not commonly used).

```json CEL theme={null}
$result_object_key.payer.first_name
```

```json Example theme={null}
"John"
```

**payer.last\_name** `string`

The payer's last name. Used when the payer is an individual (not commonly used).

```json CEL theme={null}
$result_object_key.payer.last_name
```

```json Example theme={null}
"Doe"
```

**payer.name** `string`

The payer's business name, when the payer is not a person.

```json CEL theme={null}
$result_object_key.payer.name
```

```json Example theme={null}
"Payer Inc."
```

**payer.middle\_name** `string`

The payer's middle name or initial, when the payer is an individual (not commonly used).

```json CEL theme={null}
$result_object_key.payer.middle_name
```

```json Example theme={null}
"A"
```

**payer.suffix** `string`

The payer's name suffix, such as Jr. or III. Used when the payer is an individual (not commonly used).

```json CEL theme={null}
$result_object_key.payer.suffix
```

```json Example theme={null}
"Jr."
```

**payer.federal\_taxpayers\_id\_number** `string`

The payer's federal taxpayer's identification number.

```json CEL theme={null}
$result_object_key.payer.federal_taxpayers_id_number
```

```json Example theme={null}
"FTIN12345"
```

**payer.naic** `string`

The payer's National Association of Insurance Commissioners (NAIC) identification number.

```json CEL theme={null}
$result_object_key.payer.naic
```

```json Example theme={null}
"NAIC12345"
```

**payer.npi** `string`

The payer's National Provider Identifier (NPI).

```json CEL theme={null}
$result_object_key.payer.npi
```

```json Example theme={null}
"NPI12345"
```

**payer.centers\_for\_medicare\_and\_medicaid\_plan\_id** `string`

The payer's Centers for Medicare and Medicaid Services PlanID.

```json CEL theme={null}
$result_object_key.payer.centers_for_medicare_and_medicaid_plan_id
```

```json Example theme={null}
"CMS12345"
```

**payer.payor\_identification** `string`

The payor identification.

```json CEL theme={null}
$result_object_key.payer.payor_identification
```

```json Example theme={null}
"PID12345"
```

**payer.contact\_information** `object`

*Description coming soon*

```json CEL theme={null}
$result_object_key.payer.contact_information
```

```json Example theme={null}
{
"contacts": [
{
"communication_mode": "Phone",
"communication_number": "123-456-7890"
}
],
"name": "Jane Doe"
}
```

**payer.contact\_information.name** `string`

The name of the contact person.

```json CEL theme={null}
$result_object_key.payer.contact_information.name
```

```json Example theme={null}
"Jane Doe"
```

**payer.contact\_information.contacts** `[]object`

*Description coming soon*

```json CEL theme={null}
$result_object_key.payer.contact_information.contacts
```

```json Example theme={null}
[
{
"communication_mode": "Phone",
"communication_number": "123-456-7890"
}
]
```

**payer.contact\_information.contacts.map(x, x.communication\_mode)** `[]string` *required*

Mapped array of: The type of communication number provided.

```json CEL theme={null}
$result_object_key.payer.contact_information.contacts.map(x, x.communication_mode)
```

```json Example theme={null}
[
"Phone"
]
```

**payer.contact\_information.contacts.map(x, x.communication\_number)** `[]string` *required*

Mapped array of: The communication number referenced in communicationMode.

```json CEL theme={null}
$result_object_key.payer.contact_information.contacts.map(x, x.communication_number)
```

```json Example theme={null}
[
"123-456-7890"
]
```

**payer.aaa\_errors** `[]object`

*Description coming soon*

```json CEL theme={null}
$result_object_key.payer.aaa_errors
```

```json Example theme={null}
[
{
"code": "ERR123",
"description": "Invalid request",
"followup_action": "Resubmit",
"location": "Segment N3",
"possible_resolutions": "Check the request format"
}
]
```

**payer.aaa\_errors.map(x, x.code)** `[]string` *required*

Mapped array of: The error code.

```json CEL theme={null}
$result_object_key.payer.aaa_errors.map(x, x.code)
```

```json Example theme={null}
[
"ERR123"
]
```

**payer.aaa\_errors.map(x, x.description)** `[]string` *required*

Mapped array of: The error description.

```json CEL theme={null}
$result_object_key.payer.aaa_errors.map(x, x.description)
```

```json Example theme={null}
[
"Invalid request"
]
```

**payer.aaa\_errors.map(x, x.location)** `[]string` *required*

Mapped array of: The location of the error within the original X12 EDI response.

```json CEL theme={null}
$result_object_key.payer.aaa_errors.map(x, x.location)
```

```json Example theme={null}
[
"Segment N3"
]
```

**payer.aaa\_errors.map(x, x.possible\_resolutions)** `[]string` *required*

Mapped array of: Information to help you correct the error.

```json CEL theme={null}
$result_object_key.payer.aaa_errors.map(x, x.possible_resolutions)
```

```json Example theme={null}
[
"Check the request format"
]
```

**payer.aaa\_errors.map(x, x.followup\_action)** `[]string` *required*

Mapped array of: Allowed actions you can take, based on the rejection reason code.

```json CEL theme={null}
$result_object_key.payer.aaa_errors.map(x, x.followup_action)
```

```json Example theme={null}
[
"Resubmit"
]
```

**payer.etin** `string`

The payer's Electronic Transmitter Identification Number (ETIN).

```json CEL theme={null}
$result_object_key.payer.etin
```

```json Example theme={null}
"ETIN12345"
```

**plan\_information** `object`

*Description coming soon*

```json CEL theme={null}
$result_object_key.plan_information
```

```json Example theme={null}
{
"agency_claim_number": "AC12345",
"alternative_list_id": "AL12345",
"case_number": "C12345",
"centers_for_medicare_and_medicaid_services_npi": "CMSNPI12345",
"class_of_contract_code": "CC123",
"contract_number": "C12345",
"coverage_list_id": "CL12345",
"drug_formulary_number": "DF12345",
"electronic_device_pin": "EDP12345",
"eligibility_category": "EC123",
"facility_id_number": "FID12345",
"facility_network_identification_number": "FNI12345",
"family_unit_number": "F12345",
"federal_taxpayers_identification_number": "FTIN12345",
"group_description": "Group Plan",
"group_number": "G12345",
"hic_number": "HIC12345",
"id_card_number": "ID12345",
"id_card_serial_number": "IDCS12345",
"insurance_policy_number": "IP12345",
"issue_number": "IN12345",
"medicaid_provider_number": "MD12345",
"medicaid_recipient_id_number": "MRID12345",
"medical_assistance_category": "MAC123",
"medical_record_identification_number": "MR12345",
"medicare_provider_number": "MP12345",
"member_id": "MID12345",
"patient_account_number": "PA12345",
"personal_identification_number": "PIN12345",
"plan_description": "Health Plan",
"plan_network_id_description": "Plan Network",
"plan_network_id_number": "PNI12345",
"plan_number": "PL12345",
"policy_number": "POL12345",
"prior_authorization_number": "PA12345",
"prior_id_number": "PID12345",
"referral_number": "R12345",
"social_security_number": "SSN12345",
"state_license_number": "SL12345",
"submitter_identification_number": "SID12345",
"user_identification": "UID12345"
}
```

**plan\_information.state\_license\_number** `string`

The state license number.

```json CEL theme={null}
$result_object_key.plan_information.state_license_number
```

```json Example theme={null}
"SL12345"
```

**plan\_information.medicare\_provider\_number** `string`

The Medicare provider number.

```json CEL theme={null}
$result_object_key.plan_information.medicare_provider_number
```

```json Example theme={null}
"MP12345"
```

**plan\_information.medicaid\_provider\_number** `string`

The Medicaid provider number.

```json CEL theme={null}
$result_object_key.plan_information.medicaid_provider_number
```

```json Example theme={null}
"MD12345"
```

**plan\_information.facility\_id\_number** `string`

The facility ID number.

```json CEL theme={null}
$result_object_key.plan_information.facility_id_number
```

```json Example theme={null}
"FID12345"
```

**plan\_information.personal\_identification\_number** `string`

The personal identification number (PIN).

```json CEL theme={null}
$result_object_key.plan_information.personal_identification_number
```

```json Example theme={null}
"PIN12345"
```

**plan\_information.plan\_number** `string`

The plan number.

```json CEL theme={null}
$result_object_key.plan_information.plan_number
```

```json Example theme={null}
"PL12345"
```

**plan\_information.plan\_description** `string`

The plan description.

```json CEL theme={null}
$result_object_key.plan_information.plan_description
```

```json Example theme={null}
"Health Plan"
```

**plan\_information.policy\_number** `string`

The group or policy number.

```json CEL theme={null}
$result_object_key.plan_information.policy_number
```

```json Example theme={null}
"POL12345"
```

**plan\_information.member\_id** `string`

The member identification number - only used when checking eligibility with a Workers' Compensation or Property and Casualty insurer.

```json CEL theme={null}
$result_object_key.plan_information.member_id
```

```json Example theme={null}
"MID12345"
```

**plan\_information.case\_number** `string`

The case number.

```json CEL theme={null}
$result_object_key.plan_information.case_number
```

```json Example theme={null}
"C12345"
```

**plan\_information.family\_unit\_number** `string`

The family unit number.

```json CEL theme={null}
$result_object_key.plan_information.family_unit_number
```

```json Example theme={null}
"F12345"
```

**plan\_information.group\_number** `string`

The group number.

```json CEL theme={null}
$result_object_key.plan_information.group_number
```

```json Example theme={null}
"G12345"
```

**plan\_information.group\_description** `string`

The group description.

```json CEL theme={null}
$result_object_key.plan_information.group_description
```

```json Example theme={null}
"Group Plan"
```

**plan\_information.referral\_number** `string`

The referral number.

```json CEL theme={null}
$result_object_key.plan_information.referral_number
```

```json Example theme={null}
"R12345"
```

**plan\_information.alternative\_list\_id** `string`

The alternative list ID - identifies a list of alternative drugs with the associated formulary status for the patient.

```json CEL theme={null}
$result_object_key.plan_information.alternative_list_id
```

```json Example theme={null}
"AL12345"
```

**plan\_information.class\_of\_contract\_code** `string`

The class of contract code - used to identify the applicable class of contract for claims processing.

```json CEL theme={null}
$result_object_key.plan_information.class_of_contract_code
```

```json Example theme={null}
"CC123"
```

**plan\_information.coverage\_list\_id** `string`

The coverage list ID - identifies a list of drugs that have coverage limitations for the patient.

```json CEL theme={null}
$result_object_key.plan_information.coverage_list_id
```

```json Example theme={null}
"CL12345"
```

**plan\_information.contract\_number** `string`

The contract number of a contract between the payer and the provider that requested the eligibility check.

```json CEL theme={null}
$result_object_key.plan_information.contract_number
```

```json Example theme={null}
"C12345"
```

**plan\_information.medical\_record\_identification\_number** `string`

The medical record identification number.

```json CEL theme={null}
$result_object_key.plan_information.medical_record_identification_number
```

```json Example theme={null}
"MR12345"
```

**plan\_information.electronic\_device\_pin** `string`

The electronic device pin number.

```json CEL theme={null}
$result_object_key.plan_information.electronic_device_pin
```

```json Example theme={null}
"EDP12345"
```

**plan\_information.submitter\_identification\_number** `string`

The submitter identification number.

```json CEL theme={null}
$result_object_key.plan_information.submitter_identification_number
```

```json Example theme={null}
"SID12345"
```

**plan\_information.patient\_account\_number** `string`

The patient account number. If you included this value in the original eligibility request, the payer will return the same value here in the response.

```json CEL theme={null}
$result_object_key.plan_information.patient_account_number
```

```json Example theme={null}
"PA12345"
```

**plan\_information.hic\_number** `string`

The health insurance claim number.

```json CEL theme={null}
$result_object_key.plan_information.hic_number
```

```json Example theme={null}
"HIC12345"
```

**plan\_information.drug\_formulary\_number** `string`

The drug formulary number.

```json CEL theme={null}
$result_object_key.plan_information.drug_formulary_number
```

```json Example theme={null}
"DF12345"
```

**plan\_information.prior\_authorization\_number** `string`

The prior authorization number.

```json CEL theme={null}
$result_object_key.plan_information.prior_authorization_number
```

```json Example theme={null}
"PA12345"
```

**plan\_information.id\_card\_serial\_number** `string`

The identification card serial number. The Identification Card Serial Number uniquely identifies the identification card when multiple cards have been or will be issued to a member, such as a replacement card.

```json CEL theme={null}
$result_object_key.plan_information.id_card_serial_number
```

```json Example theme={null}
"IDCS12345"
```

**plan\_information.id\_card\_number** `string`

The identity card number, used when the Identity Card Number is different than the Member Identification Number.

```json CEL theme={null}
$result_object_key.plan_information.id_card_number
```

```json Example theme={null}
"ID12345"
```

**plan\_information.centers\_for\_medicare\_and\_medicaid\_services\_npi** `string`

The National Provider Identifier (NPI) assigned by the Centers for Medicare and Medicaid Services.

```json CEL theme={null}
$result_object_key.plan_information.centers_for_medicare_and_medicaid_services_npi
```

```json Example theme={null}
"CMSNPI12345"
```

**plan\_information.issue\_number** `string`

The issue number.

```json CEL theme={null}
$result_object_key.plan_information.issue_number
```

```json Example theme={null}
"IN12345"
```

**plan\_information.insurance\_policy\_number** `string`

The insurance policy number.

```json CEL theme={null}
$result_object_key.plan_information.insurance_policy_number
```

```json Example theme={null}
"IP12345"
```

**plan\_information.user\_identification** `string`

The user identification.

```json CEL theme={null}
$result_object_key.plan_information.user_identification
```

```json Example theme={null}
"UID12345"
```

**plan\_information.medical\_assistance\_category** `string`

The medical assistance category.

```json CEL theme={null}
$result_object_key.plan_information.medical_assistance_category
```

```json Example theme={null}
"MAC123"
```

**plan\_information.eligibility\_category** `string`

The eligibility category.

```json CEL theme={null}
$result_object_key.plan_information.eligibility_category
```

```json Example theme={null}
"EC123"
```

**plan\_information.plan\_network\_id\_number** `string`

The plan network identification number.

```json CEL theme={null}
$result_object_key.plan_information.plan_network_id_number
```

```json Example theme={null}
"PNI12345"
```

**plan\_information.plan\_network\_id\_description** `string`

The plan, group, or plan network name.

```json CEL theme={null}
$result_object_key.plan_information.plan_network_id_description
```

```json Example theme={null}
"Plan Network"
```

**plan\_information.facility\_network\_identification\_number** `string`

The facility network identification number.

```json CEL theme={null}
$result_object_key.plan_information.facility_network_identification_number
```

```json Example theme={null}
"FNI12345"
```

**plan\_information.medicaid\_recipient\_id\_number** `string`

The Medicaid recipient identification number.

```json CEL theme={null}
$result_object_key.plan_information.medicaid_recipient_id_number
```

```json Example theme={null}
"MRID12345"
```

**plan\_information.prior\_id\_number** `string`

The prior identifier number.

```json CEL theme={null}
$result_object_key.plan_information.prior_id_number
```

```json Example theme={null}
"PID12345"
```

**plan\_information.social\_security\_number** `string`

The social security number.

```json CEL theme={null}
$result_object_key.plan_information.social_security_number
```

```json Example theme={null}
"SSN12345"
```

**plan\_information.federal\_taxpayers\_identification\_number** `string`

The federal taxpayer's identification number.

```json CEL theme={null}
$result_object_key.plan_information.federal_taxpayers_identification_number
```

```json Example theme={null}
"FTIN12345"
```

**plan\_information.agency\_claim\_number** `string`

The agency claim number, only used when the information source is a Property and Casualty payer.

```json CEL theme={null}
$result_object_key.plan_information.agency_claim_number
```

```json Example theme={null}
"AC12345"
```

**plan\_date\_information** `object`

*Description coming soon*

```json CEL theme={null}
$result_object_key.plan_date_information
```

```json Example theme={null}
{
"added": "2023-01-01",
"admission": "2023-01-01",
"certification": "2023-01-01",
"cobra_begin": "2023-01-01",
"cobra_end": "2023-01-31",
"date_of_death": "2023-01-01",
"date_of_last_update": "2023-01-01",
"discharge": "2023-01-01",
"effective_date_of_change": "2023-01-01",
"eligibility": "2023-01-01",
"eligibility_begin": "2023-01-01",
"eligibility_end": "2023-01-31",
"enrollment": "2023-01-01",
"issue": "2023-01-01",
"plan": "2023-01-01",
"plan_begin": "2023-01-01",
"plan_end": "2023-01-31",
"policy_effective": "2023-01-01",
"policy_expiration": "2023-01-31",
"premium_paid_to_date_begin": "2023-01-01",
"premium_paid_to_date_end": "2023-01-31",
"service": "2023-01-01",
"status": "2023-01-01"
}
```

**plan\_date\_information.discharge** `values.v1.Date`

The date of discharge.

```json CEL theme={null}
$result_object_key.plan_date_information.discharge
```

```json Example theme={null}
"2023-01-01"
```

**plan\_date\_information.issue** `values.v1.Date`

The issue date.

```json CEL theme={null}
$result_object_key.plan_date_information.issue
```

```json Example theme={null}
"2023-01-01"
```

**plan\_date\_information.effective\_date\_of\_change** `values.v1.Date`

The effective date of change.

```json CEL theme={null}
$result_object_key.plan_date_information.effective_date_of_change
```

```json Example theme={null}
"2023-01-01"
```

**plan\_date\_information.plan** `values.v1.Date`

The plan date.

```json CEL theme={null}
$result_object_key.plan_date_information.plan
```

```json Example theme={null}
"2023-01-01"
```

**plan\_date\_information.eligibility** `values.v1.Date`

The eligibility date.

```json CEL theme={null}
$result_object_key.plan_date_information.eligibility
```

```json Example theme={null}
"2023-01-01"
```

**plan\_date\_information.added** `values.v1.Date`

The date added.

```json CEL theme={null}
$result_object_key.plan_date_information.added
```

```json Example theme={null}
"2023-01-01"
```

**plan\_date\_information.cobra\_begin** `values.v1.Date`

The COBRA begin date.

```json CEL theme={null}
$result_object_key.plan_date_information.cobra_begin
```

```json Example theme={null}
"2023-01-01"
```

**plan\_date\_information.cobra\_end** `values.v1.Date`

The COBRA end date.

```json CEL theme={null}
$result_object_key.plan_date_information.cobra_end
```

```json Example theme={null}
"2023-01-31"
```

**plan\_date\_information.premium\_paid\_to\_date\_begin** `values.v1.Date`

The premium paid to date begin.

```json CEL theme={null}
$result_object_key.plan_date_information.premium_paid_to_date_begin
```

```json Example theme={null}
"2023-01-01"
```

**plan\_date\_information.premium\_paid\_to\_date\_end** `values.v1.Date`

The premium paid to date end.

```json CEL theme={null}
$result_object_key.plan_date_information.premium_paid_to_date_end
```

```json Example theme={null}
"2023-01-31"
```

**plan\_date\_information.plan\_begin** `values.v1.Date`

The plan begin date.

```json CEL theme={null}
$result_object_key.plan_date_information.plan_begin
```

```json Example theme={null}
"2023-01-01"
```

**plan\_date\_information.plan\_end** `values.v1.Date`

The plan end date.

```json CEL theme={null}
$result_object_key.plan_date_information.plan_end
```

```json Example theme={null}
"2023-01-31"
```

**plan\_date\_information.eligibility\_begin** `values.v1.Date`

The eligibility begin date.

```json CEL theme={null}
$result_object_key.plan_date_information.eligibility_begin
```

```json Example theme={null}
"2023-01-01"
```

**plan\_date\_information.eligibility\_end** `values.v1.Date`

The eligibility end date.

```json CEL theme={null}
$result_object_key.plan_date_information.eligibility_end
```

```json Example theme={null}
"2023-01-31"
```

**plan\_date\_information.enrollment** `values.v1.Date`

The enrollment date.

```json CEL theme={null}
$result_object_key.plan_date_information.enrollment
```

```json Example theme={null}
"2023-01-01"
```

**plan\_date\_information.admission** `values.v1.Date`

The admission date.

```json CEL theme={null}
$result_object_key.plan_date_information.admission
```

```json Example theme={null}
"2023-01-01"
```

**plan\_date\_information.date\_of\_death** `values.v1.Date`

The date of death.

```json CEL theme={null}
$result_object_key.plan_date_information.date_of_death
```

```json Example theme={null}
"2023-01-01"
```

**plan\_date\_information.certification** `values.v1.Date`

The certification date.

```json CEL theme={null}
$result_object_key.plan_date_information.certification
```

```json Example theme={null}
"2023-01-01"
```

**plan\_date\_information.service** `values.v1.Date`

The service date.

```json CEL theme={null}
$result_object_key.plan_date_information.service
```

```json Example theme={null}
"2023-01-01"
```

**plan\_date\_information.policy\_effective** `values.v1.Date`

The policy effective date.

```json CEL theme={null}
$result_object_key.plan_date_information.policy_effective
```

```json Example theme={null}
"2023-01-01"
```

**plan\_date\_information.policy\_expiration** `values.v1.Date`

The policy expiration date.

```json CEL theme={null}
$result_object_key.plan_date_information.policy_expiration
```

```json Example theme={null}
"2023-01-31"
```

**plan\_date\_information.date\_of\_last\_update** `values.v1.Date`

The date of last update.

```json CEL theme={null}
$result_object_key.plan_date_information.date_of_last_update
```

```json Example theme={null}
"2023-01-01"
```

**plan\_date\_information.status** `values.v1.Date`

The status date.

```json CEL theme={null}
$result_object_key.plan_date_information.status
```

```json Example theme={null}
"2023-01-01"
```

**errors** `[]object` *required*

*Description coming soon*

```json CEL theme={null}
$result_object_key.errors
```

```json Example theme={null}
[
{
"code": "ERR123",
"description": "Invalid request",
"followup_action": "Resubmit",
"location": "Segment N3",
"possible_resolutions": "Check the request format"
}
]
```

**errors.map(x, x.code)** `[]string` *required*

Mapped array of: The error code.

```json CEL theme={null}
$result_object_key.errors.map(x, x.code)
```

```json Example theme={null}
[
"ERR123"
]
```

**errors.map(x, x.description)** `[]string` *required*

Mapped array of: The error description.

```json CEL theme={null}
$result_object_key.errors.map(x, x.description)
```

```json Example theme={null}
[
"Invalid request"
]
```

**errors.map(x, x.location)** `[]string` *required*

Mapped array of: The location of the error within the original X12 EDI response.

```json CEL theme={null}
$result_object_key.errors.map(x, x.location)
```

```json Example theme={null}
[
"Segment N3"
]
```

**errors.map(x, x.possible\_resolutions)** `[]string` *required*

Mapped array of: Information to help you correct the error.

```json CEL theme={null}
$result_object_key.errors.map(x, x.possible_resolutions)
```

```json Example theme={null}
[
"Check the request format"
]
```

**errors.map(x, x.followup\_action)** `[]string` *required*

Mapped array of: Allowed actions you can take, based on the rejection reason code.

```json CEL theme={null}
$result_object_key.errors.map(x, x.followup_action)
```

```json Example theme={null}
[
"Resubmit"
]
```

**warnings** `[]object` *required*

*Description coming soon*

```json CEL theme={null}
$result_object_key.warnings
```

```json Example theme={null}
[
{
"code": "WARN123",
"description": "This is a warning"
}
]
```

**warnings.map(x, x.code)** `[]string` *required*

Mapped array of: The warning code.

```json CEL theme={null}
$result_object_key.warnings.map(x, x.code)
```

```json Example theme={null}
[
"WARN123"
]
```

**warnings.map(x, x.description)** `[]string` *required*

Mapped array of: The warning description.

```json CEL theme={null}
$result_object_key.warnings.map(x, x.description)
```

```json Example theme={null}
[
"This is a warning"
]
```

**status** `string`

Errors Stedi encountered when generating or sending the final X12 EDI transaction to the payer. These can include validation errors and payer unavailable errors that prevent delivery.

```json CEL theme={null}
$result_object_key.status
```

```json Example theme={null}
"Error"
```

**transaction\_set\_acknowledgement** `string`

The transaction set acknowledgment code provided in in the X12 EDI 999 response.

```json CEL theme={null}
$result_object_key.transaction_set_acknowledgement
```

```json Example theme={null}
"ACK"
```

**implementation\_transaction\_set\_syntax\_error** `string`

The implementation transaction set error code provided in IK502 of the 999 transaction.

```json CEL theme={null}
$result_object_key.implementation_transaction_set_syntax_error
```

```json Example theme={null}
"ERR"
```

**dependents** `[]object` *required*

*Description coming soon*

```json CEL theme={null}
$result_object_key.dependents
```

```json Example theme={null}
[
{
"additional_identification": {
"agency_claim_number": "AC12345",
"contract_number": "C12345",
"health_insurance_claim_number": "HIC12345",
"identification_card_serial_number": "IDCS12345",
"insurance_policy_number": "IP12345",
"medical_record_identification_number": "MR12345",
"member_identification_number": "M12345",
"patient_account_number": "PA12345",
"plan_network_identification_number": "PNI12345",
"plan_number": "P12345",
"policy_number": "POL12345"
},
"address": {
"address1": "123 Main St",
"address2": "Apt 4B",
"city": "New York",
"country_code": "US",
"country_sub_division_code": "NYC",
"postal_code": "10001",
"state": "NY"
},
"birth_sequence_number": "1",
"case_number": "C12345",
"coverage_level_code": "N/A",
"date_of_birth": "19800101",
"first_name": "John",
"gender": "M",
"group_number": "G12345",
"health_care_code_information": [
{
  "diagnosis_code": "12345",
  "diagnosis_type_code": "BK"
}
],
"id_card": "ID12345",
"last_name": "Doe",
"medicaid_recipient_identification_number": "M12345",
"member_id": "123456",
"middle_name": "A",
"provider_code": "AD",
"provider_identifier": "P12345",
"reference_identification_qualifier": "9K",
"spend_down_amount": 100,
"spend_down_total_billed_amount": 200,
"ssn": "123-45-6789",
"suffix": "Jr."
}
]
```

**dependents.map(x, x.member\_id)** `[]string` *required*

Mapped array of: The member ID for the dependent's insurance policy.

```json CEL theme={null}
$result_object_key.dependents.map(x, x.member_id)
```

```json Example theme={null}
[
"123456"
]
```

**dependents.map(x, x.date\_of\_birth)** `[]values.v1.Date` *required*

Mapped array of: The dependent's date of birth.

```json CEL theme={null}
$result_object_key.dependents.map(x, x.date_of_birth)
```

```json Example theme={null}
[
"19800101"
]
```

**dependents.map(x, x.first\_name)** `[]string` *required*

Mapped array of: The dependent's first name.

```json CEL theme={null}
$result_object_key.dependents.map(x, x.first_name)
```

```json Example theme={null}
[
"John"
]
```

**dependents.map(x, x.middle\_name)** `[]string` *required*

Mapped array of: The dependent's middle name or middle initial.

```json CEL theme={null}
$result_object_key.dependents.map(x, x.middle_name)
```

```json Example theme={null}
[
"A"
]
```

**dependents.map(x, x.last\_name)** `[]string` *required*

Mapped array of: The dependent's last name.

```json CEL theme={null}
$result_object_key.dependents.map(x, x.last_name)
```

```json Example theme={null}
[
"Doe"
]
```

**dependents.map(x, x.suffix)** `[]string` *required*

Mapped array of: The name suffix, such as Jr., Sr., or III.

```json CEL theme={null}
$result_object_key.dependents.map(x, x.suffix)
```

```json Example theme={null}
[
"Jr."
]
```

**dependents.map(x, x.gender)** `[]string` *required*

Mapped array of: Code indicating the dependent's gender. Available options: M, F

```json CEL theme={null}
$result_object_key.dependents.map(x, x.gender)
```

```json Example theme={null}
[
"M"
]
```

**dependents.map(x, x.ssn)** `[]string` *required*

Mapped array of: The dependent's Social Security Number (SSN).

```json CEL theme={null}
$result_object_key.dependents.map(x, x.ssn)
```

```json Example theme={null}
[
"123-45-6789"
]
```

**dependents.map(x, x.group\_number)** `[]string` *required*

Mapped array of: The group number associated with the dependent's insurance policy.

```json CEL theme={null}
$result_object_key.dependents.map(x, x.group_number)
```

```json Example theme={null}
[
"G12345"
]
```

**dependents.map(x, x.id\_card)** `[]string` *required*

Mapped array of: The dependent's identification card number.

```json CEL theme={null}
$result_object_key.dependents.map(x, x.id_card)
```

```json Example theme={null}
[
"ID12345"
]
```

**dependents.map(x, x.provider\_code)** `[]string` *required*

Mapped array of: The provider code. Available options: AD, AT, BI, CO, CV, H, HH, LA, OT, P1, P2, PC, PE, R, RF, SB, SK, SU

```json CEL theme={null}
$result_object_key.dependents.map(x, x.provider_code)
```

```json Example theme={null}
[
"AD"
]
```

**dependents.map(x, x.reference\_identification\_qualifier)** `[]string` *required*

Mapped array of: The reference identification qualifier. Available options: 9K, D3, EI, HPI, PXC, SY, TJ

```json CEL theme={null}
$result_object_key.dependents.map(x, x.reference_identification_qualifier)
```

```json Example theme={null}
[
"9K"
]
```

**dependents.map(x, x.provider\_identifier)** `[]string` *required*

Mapped array of: The provider identifier.

```json CEL theme={null}
$result_object_key.dependents.map(x, x.provider_identifier)
```

```json Example theme={null}
[
"P12345"
]
```

**dependents.map(x, x.health\_care\_code\_information)** `[]bool` *required*

*Description coming soon*

```json CEL theme={null}
$result_object_key.dependents.map(x, x.health_care_code_information)
```

```json Example theme={null}
[
[
{
"diagnosis_code": "12345",
"diagnosis_type_code": "BK"
}
]
]
```

**dependents.map(x, x.address)** `[]bool` *required*

*Description coming soon*

```json CEL theme={null}
$result_object_key.dependents.map(x, x.address)
```

```json Example theme={null}
[
{
"address1": "123 Main St",
"address2": "Apt 4B",
"city": "New York",
"country_code": "US",
"country_sub_division_code": "NYC",
"postal_code": "10001",
"state": "NY"
}
]
```

**dependents.map(x, x.additional\_identification)** `[]bool` *required*

*Description coming soon*

```json CEL theme={null}
$result_object_key.dependents.map(x, x.additional_identification)
```

```json Example theme={null}
[
{
"agency_claim_number": "AC12345",
"contract_number": "C12345",
"health_insurance_claim_number": "HIC12345",
"identification_card_serial_number": "IDCS12345",
"insurance_policy_number": "IP12345",
"medical_record_identification_number": "MR12345",
"member_identification_number": "M12345",
"patient_account_number": "PA12345",
"plan_network_identification_number": "PNI12345",
"plan_number": "P12345",
"policy_number": "POL12345"
}
]
```

**dependents.map(x, x.birth\_sequence\_number)** `[]string` *required*

Mapped array of: The number assigned to each family member born with the same birth date.

```json CEL theme={null}
$result_object_key.dependents.map(x, x.birth_sequence_number)
```

```json Example theme={null}
[
"1"
]
```

**dependents.map(x, x.case\_number)** `[]string` *required*

Mapped array of: The case number associated with the dependent.

```json CEL theme={null}
$result_object_key.dependents.map(x, x.case_number)
```

```json Example theme={null}
[
"C12345"
]
```

**dependents.map(x, x.medicaid\_recipient\_identification\_number)** `[]string` *required*

Mapped array of: The Medicaid Recipient Identification Number.

```json CEL theme={null}
$result_object_key.dependents.map(x, x.medicaid_recipient_identification_number)
```

```json Example theme={null}
[
"M12345"
]
```

**dependents.map(x, x.spend\_down\_amount)** `[]float64 (double)` *required*

Mapped array of: The dollar amount the dependent will apply toward their spend down amount.

```json CEL theme={null}
$result_object_key.dependents.map(x, x.spend_down_amount)
```

```json Example theme={null}
[
100
]
```

**dependents.map(x, x.spend\_down\_total\_billed\_amount)** `[]float64 (double)` *required*

Mapped array of: The dependent's spend down total billed amount.

```json CEL theme={null}
$result_object_key.dependents.map(x, x.spend_down_total_billed_amount)
```

```json Example theme={null}
[
200
]
```

**dependents.map(x, x.coverage\_level\_code)** `[]string` *required*

Mapped array of: This property is no longer used.

```json CEL theme={null}
$result_object_key.dependents.map(x, x.coverage_level_code)
```

```json Example theme={null}
[
"N/A"
]
```

**benefits\_information** `[]object` *required*

*Description coming soon*

```json CEL theme={null}
$result_object_key.benefits_information
```

```json Example theme={null}
[
{
"additional_information": [
{
  "description": "Description"
}
],
"auth_or_cert_indicator": "Y",
"benefit_amount": "1000",
"benefit_percent": "80",
"benefit_quantity": "10",
"benefits_additional_information": {
"alternative_list_id": "AL12345",
"coverage_list_id": "CL12345",
"drug_formulary_number": "DF12345",
"family_unit_number": "F12345",
"group_number": "G12345",
"hic_number": "HIC12345",
"insurance_policy_number": "IP12345",
"medicaid_recipient_id_number": "MRID12345",
"medical_assistance_category": "MAC123",
"member_id": "M12345",
"plan_network_id_number": "PNI12345",
"plan_number": "P12345",
"policy_number": "POL12345",
"prior_authorization_number": "PA12345",
"referral_number": "R12345"
},
"benefits_date_information": {
"added": "2023-01-01",
"admission": [
  {
    "date": "2023-01-01",
    "end_date": "2023-01-31",
    "start_date": "2023-01-01"
  }
],
"benefit": "2023-01-01",
"benefit_begin": "2023-01-01",
"benefit_end": "2023-01-31",
"certification": "2023-01-01",
"cobra_begin": "2023-01-01",
"cobra_end": "2023-01-31",
"completion": "2023-01-31",
"coordination_of_benefits": "2023-01-01",
"date_of_death": "2023-01-01",
"date_of_last_update": "2023-01-01",
"discharges": [
  {
    "date": "2023-01-01",
    "end_date": "2023-01-31",
    "start_date": "2023-01-01"
  }
],
"effective_date_of_change": "2023-01-01",
"eligibility": "2023-01-01",
"eligibility_begin": "2023-01-01",
"eligibility_end": "2023-01-31",
"enrollment": "2023-01-01",
"issue": "2023-01-01",
"latest_visit_or_consultation": "2023-01-01",
"period_end": "2023-01-31",
"period_start": "2023-01-01",
"plan": "2023-01-01",
"plan_begin": "2023-01-01",
"plan_end": "2023-01-31",
"policy_effective": "2023-01-01",
"policy_expiration": "2023-01-31",
"premium_paid_to_date_begin": "2023-01-01",
"premium_paid_to_date_end": "2023-01-31",
"primary_care_provider": "2023-01-01",
"service": "2023-01-01",
"status": "2023-01-01"
},
"benefits_related_entities": [
{
  "address": {
    "address1": "123 Main St",
    "address2": "Apt 4B",
    "city": "New York",
    "country_code": "US",
    "country_sub_division_code": "NYC",
    "postal_code": "10001",
    "state": "NY"
  },
  "contact_information": {
    "contacts": [
      {
        "communication_mode": "Phone",
        "communication_number": "123-456-7890"
      }
    ],
    "name": "Jane Doe"
  },
  "entity_first_name": "John",
  "entity_identification": {
    "code": "ID123",
    "value": "Value123"
  },
  "entity_identifier": "EI123",
  "entity_middle_name": "A",
  "entity_name": "Entity Name",
  "entity_relationship": "Relationship",
  "entity_suffix": "Jr.",
  "entity_type": "ET123",
  "provider_information": {
    "provider_code": "PC123",
    "reference_identification": "RI123"
  }
}
],
"benefits_related_entity": {
"address": {
  "address1": "123 Main St",
  "address2": "Apt 4B",
  "city": "New York",
  "country_code": "US",
  "country_sub_division_code": "NYC",
  "postal_code": "10001",
  "state": "NY"
},
"contact_information": {
  "contacts": [
    {
      "communication_mode": "Phone",
      "communication_number": "123-456-7890"
    }
  ],
  "name": "Jane Doe"
},
"entity_first_name": "John",
"entity_identification": {
  "code": "ID123",
  "value": "Value123"
},
"entity_identifier": "EI123",
"entity_middle_name": "A",
"entity_name": "Entity Name",
"entity_relationship": "Relationship",
"entity_suffix": "Jr.",
"entity_type": "ET123",
"provider_information": {
  "provider_code": "PC123",
  "reference_identification": "RI123"
}
},
"benefits_service_delivery": [
{
  "delivery_or_calendar_pattern_code": "DCPC123",
  "delivery_or_calendar_pattern_qualifier": "Pattern Qualifier",
  "delivery_or_calendar_pattern_qualifier_code": "DCQC123",
  "delivery_pattern_time_code": "DPTC123",
  "delivery_pattern_time_qualifier": "Time Qualifier",
  "delivery_pattern_time_qualifier_code": "DPTQC123",
  "num_of_periods": "5",
  "quantity": "10",
  "quantity_qualifier": "Quantity Qualifier",
  "quantity_qualifier_code": "QQC123",
  "sample_selection_modulus": "SSM123",
  "time_period_qualifier": "Time Qualifier",
  "time_period_qualifier_code": "TPQC123",
  "unit_for_measurement_code": "UMC123",
  "unit_for_measurement_qualifier": "Unit Qualifier",
  "unit_for_measurement_qualifier_code": "UMQC123"
}
],
"code": "BC123",
"composite_medical_procedure_identifier": {
"diagnosis_code_pointer": [
  "DCP1",
  "DCP2"
],
"procedure_code": "PROC123",
"procedure_modifiers": [
  "MOD1",
  "MOD2"
],
"product_or_service_id": [
  "PSID123",
  "PSID456"
],
"product_or_service_id_qualifier": "HC"
},
"coverage_level": "Coverage Level",
"coverage_level_code": "CLC123",
"eligibility_additional_information": {
"code_category": "Category",
"code_list_qualifier": "Code List Qualifier",
"code_list_qualifier_code": "CLQC123",
"industry": "Industry",
"industry_code": "IC123",
"injured_body_part_name": "Arm"
},
"eligibility_additional_information_list": [
{
  "code_category": "Category",
  "code_list_qualifier": "Code List Qualifier",
  "code_list_qualifier_code": "CLQC123",
  "industry": "Industry",
  "industry_code": "IC123",
  "injured_body_part_name": "Arm"
}
],
"header_loop_identifier": "HLI123",
"in_plan_network_indicator": "Y",
"insurance_type": "Insurance Type",
"insurance_type_code": "ITC123",
"name": "Benefit Name",
"plan_coverage": "Plan Coverage",
"quantity_qualifier": "Quantity Qualifier",
"quantity_qualifier_code": "QQC123",
"service_type_codes": [
"STC123",
"STC456"
],
"time_qualifier": "Time Qualifier",
"time_qualifier_code": "TQC123",
"trailer_loop_identifier": "TLI123"
}
]
```

**benefits\_information.map(x, x.code)** `[]string` *required*

Mapped array of: The benefit code.

```json CEL theme={null}
$result_object_key.benefits_information.map(x, x.code)
```

```json Example theme={null}
[
"BC123"
]
```

**benefits\_information.map(x, x.name)** `[]string` *required*

Mapped array of: The benefit name.

```json CEL theme={null}
$result_object_key.benefits_information.map(x, x.name)
```

```json Example theme={null}
[
"Benefit Name"
]
```

**benefits\_information.map(x, x.coverage\_level\_code)** `[]string` *required*

Mapped array of: The coverage level code.

```json CEL theme={null}
$result_object_key.benefits_information.map(x, x.coverage_level_code)
```

```json Example theme={null}
[
"CLC123"
]
```

**benefits\_information.map(x, x.coverage\_level)** `[]string` *required*

Mapped array of: The coverage level.

```json CEL theme={null}
$result_object_key.benefits_information.map(x, x.coverage_level)
```

```json Example theme={null}
[
"Coverage Level"
]
```

**benefits\_information.map(x, x.service\_type\_codes)** `[]bool` *required*

Mapped array of: The service type codes.

```json CEL theme={null}
$result_object_key.benefits_information.map(x, x.service_type_codes)
```

```json Example theme={null}
[
[
"STC123",
"STC456"
]
]
```

**benefits\_information.map(x, x.insurance\_type\_code)** `[]string` *required*

Mapped array of: The insurance type code.

```json CEL theme={null}
$result_object_key.benefits_information.map(x, x.insurance_type_code)
```

```json Example theme={null}
[
"ITC123"
]
```

**benefits\_information.map(x, x.insurance\_type)** `[]string` *required*

Mapped array of: The insurance type.

```json CEL theme={null}
$result_object_key.benefits_information.map(x, x.insurance_type)
```

```json Example theme={null}
[
"Insurance Type"
]
```

**benefits\_information.map(x, x.plan\_coverage)** `[]string` *required*

Mapped array of: The plan coverage.

```json CEL theme={null}
$result_object_key.benefits_information.map(x, x.plan_coverage)
```

```json Example theme={null}
[
"Plan Coverage"
]
```

**benefits\_information.map(x, x.time\_qualifier\_code)** `[]string` *required*

Mapped array of: The time qualifier code.

```json CEL theme={null}
$result_object_key.benefits_information.map(x, x.time_qualifier_code)
```

```json Example theme={null}
[
"TQC123"
]
```

**benefits\_information.map(x, x.time\_qualifier)** `[]string` *required*

Mapped array of: The time qualifier.

```json CEL theme={null}
$result_object_key.benefits_information.map(x, x.time_qualifier)
```

```json Example theme={null}
[
"Time Qualifier"
]
```

**benefits\_information.map(x, x.benefit\_amount)** `[]string` *required*

Mapped array of: The benefit amount.

```json CEL theme={null}
$result_object_key.benefits_information.map(x, x.benefit_amount)
```

```json Example theme={null}
[
"1000"
]
```

**benefits\_information.map(x, x.benefit\_percent)** `[]string` *required*

Mapped array of: The benefit percent.

```json CEL theme={null}
$result_object_key.benefits_information.map(x, x.benefit_percent)
```

```json Example theme={null}
[
"80"
]
```

**benefits\_information.map(x, x.quantity\_qualifier\_code)** `[]string` *required*

Mapped array of: The quantity qualifier code.

```json CEL theme={null}
$result_object_key.benefits_information.map(x, x.quantity_qualifier_code)
```

```json Example theme={null}
[
"QQC123"
]
```

**benefits\_information.map(x, x.quantity\_qualifier)** `[]string` *required*

Mapped array of: The quantity qualifier.

```json CEL theme={null}
$result_object_key.benefits_information.map(x, x.quantity_qualifier)
```

```json Example theme={null}
[
"Quantity Qualifier"
]
```

**benefits\_information.map(x, x.benefit\_quantity)** `[]string` *required*

Mapped array of: The benefit quantity.

```json CEL theme={null}
$result_object_key.benefits_information.map(x, x.benefit_quantity)
```

```json Example theme={null}
[
"10"
]
```

**benefits\_information.map(x, x.auth\_or\_cert\_indicator)** `[]string` *required*

Mapped array of: The authorization or certification indicator.

```json CEL theme={null}
$result_object_key.benefits_information.map(x, x.auth_or_cert_indicator)
```

```json Example theme={null}
[
"Y"
]
```

**benefits\_information.map(x, x.in\_plan\_network\_indicator)** `[]string` *required*

Mapped array of: The in-plan network indicator.

```json CEL theme={null}
$result_object_key.benefits_information.map(x, x.in_plan_network_indicator)
```

```json Example theme={null}
[
"Y"
]
```

**benefits\_information.map(x, x.header\_loop\_identifier)** `[]string` *required*

Mapped array of: The header loop identifier.

```json CEL theme={null}
$result_object_key.benefits_information.map(x, x.header_loop_identifier)
```

```json Example theme={null}
[
"HLI123"
]
```

**benefits\_information.map(x, x.trailer\_loop\_identifier)** `[]string` *required*

Mapped array of: The trailer loop identifier.

```json CEL theme={null}
$result_object_key.benefits_information.map(x, x.trailer_loop_identifier)
```

```json Example theme={null}
[
"TLI123"
]
```

**benefits\_information.map(x, x.composite\_medical\_procedure\_identifier)** `[]bool` *required*

*Description coming soon*

```json CEL theme={null}
$result_object_key.benefits_information.map(x, x.composite_medical_procedure_identifier)
```

```json Example theme={null}
[
{
"diagnosis_code_pointer": [
"DCP1",
"DCP2"
],
"procedure_code": "PROC123",
"procedure_modifiers": [
"MOD1",
"MOD2"
],
"product_or_service_id": [
"PSID123",
"PSID456"
],
"product_or_service_id_qualifier": "HC"
}
]
```

**benefits\_information.map(x, x.benefits\_additional\_information)** `[]bool` *required*

*Description coming soon*

```json CEL theme={null}
$result_object_key.benefits_information.map(x, x.benefits_additional_information)
```

```json Example theme={null}
[
{
"alternative_list_id": "AL12345",
"coverage_list_id": "CL12345",
"drug_formulary_number": "DF12345",
"family_unit_number": "F12345",
"group_number": "G12345",
"hic_number": "HIC12345",
"insurance_policy_number": "IP12345",
"medicaid_recipient_id_number": "MRID12345",
"medical_assistance_category": "MAC123",
"member_id": "M12345",
"plan_network_id_number": "PNI12345",
"plan_number": "P12345",
"policy_number": "POL12345",
"prior_authorization_number": "PA12345",
"referral_number": "R12345"
}
]
```

**benefits\_information.map(x, x.benefits\_service\_delivery)** `[]bool` *required*

*Description coming soon*

```json CEL theme={null}
$result_object_key.benefits_information.map(x, x.benefits_service_delivery)
```

```json Example theme={null}
[
[
{
"delivery_or_calendar_pattern_code": "DCPC123",
"delivery_or_calendar_pattern_qualifier": "Pattern Qualifier",
"delivery_or_calendar_pattern_qualifier_code": "DCQC123",
"delivery_pattern_time_code": "DPTC123",
"delivery_pattern_time_qualifier": "Time Qualifier",
"delivery_pattern_time_qualifier_code": "DPTQC123",
"num_of_periods": "5",
"quantity": "10",
"quantity_qualifier": "Quantity Qualifier",
"quantity_qualifier_code": "QQC123",
"sample_selection_modulus": "SSM123",
"time_period_qualifier": "Time Qualifier",
"time_period_qualifier_code": "TPQC123",
"unit_for_measurement_code": "UMC123",
"unit_for_measurement_qualifier": "Unit Qualifier",
"unit_for_measurement_qualifier_code": "UMQC123"
}
]
]
```

**benefits\_information.map(x, x.additional\_information)** `[]bool` *required*

*Description coming soon*

```json CEL theme={null}
$result_object_key.benefits_information.map(x, x.additional_information)
```

```json Example theme={null}
[
[
{
"description": "Description"
}
]
]
```

**benefits\_information.map(x, x.eligibility\_additional\_information\_list)** `[]bool` *required*

*Description coming soon*

```json CEL theme={null}
$result_object_key.benefits_information.map(x, x.eligibility_additional_information_list)
```

```json Example theme={null}
[
[
{
"code_category": "Category",
"code_list_qualifier": "Code List Qualifier",
"code_list_qualifier_code": "CLQC123",
"industry": "Industry",
"industry_code": "IC123",
"injured_body_part_name": "Arm"
}
]
]
```

**benefits\_information.map(x, x.benefits\_date\_information)** `[]bool` *required*

*Description coming soon*

```json CEL theme={null}
$result_object_key.benefits_information.map(x, x.benefits_date_information)
```

```json Example theme={null}
[
{
"added": "2023-01-01",
"admission": [
{
  "date": "2023-01-01",
  "end_date": "2023-01-31",
  "start_date": "2023-01-01"
}
],
"benefit": "2023-01-01",
"benefit_begin": "2023-01-01",
"benefit_end": "2023-01-31",
"certification": "2023-01-01",
"cobra_begin": "2023-01-01",
"cobra_end": "2023-01-31",
"completion": "2023-01-31",
"coordination_of_benefits": "2023-01-01",
"date_of_death": "2023-01-01",
"date_of_last_update": "2023-01-01",
"discharges": [
{
  "date": "2023-01-01",
  "end_date": "2023-01-31",
  "start_date": "2023-01-01"
}
],
"effective_date_of_change": "2023-01-01",
"eligibility": "2023-01-01",
"eligibility_begin": "2023-01-01",
"eligibility_end": "2023-01-31",
"enrollment": "2023-01-01",
"issue": "2023-01-01",
"latest_visit_or_consultation": "2023-01-01",
"period_end": "2023-01-31",
"period_start": "2023-01-01",
"plan": "2023-01-01",
"plan_begin": "2023-01-01",
"plan_end": "2023-01-31",
"policy_effective": "2023-01-01",
"policy_expiration": "2023-01-31",
"premium_paid_to_date_begin": "2023-01-01",
"premium_paid_to_date_end": "2023-01-31",
"primary_care_provider": "2023-01-01",
"service": "2023-01-01",
"status": "2023-01-01"
}
]
```

**benefits\_information.map(x, x.benefits\_related\_entity)** `[]bool` *required*

*Description coming soon*

```json CEL theme={null}
$result_object_key.benefits_information.map(x, x.benefits_related_entity)
```

```json Example theme={null}
[
{
"address": {
"address1": "123 Main St",
"address2": "Apt 4B",
"city": "New York",
"country_code": "US",
"country_sub_division_code": "NYC",
"postal_code": "10001",
"state": "NY"
},
"contact_information": {
"contacts": [
  {
    "communication_mode": "Phone",
    "communication_number": "123-456-7890"
  }
],
"name": "Jane Doe"
},
"entity_first_name": "John",
"entity_identification": {
"code": "ID123",
"value": "Value123"
},
"entity_identifier": "EI123",
"entity_middle_name": "A",
"entity_name": "Entity Name",
"entity_relationship": "Relationship",
"entity_suffix": "Jr.",
"entity_type": "ET123",
"provider_information": {
"provider_code": "PC123",
"reference_identification": "RI123"
}
}
]
```

**benefits\_information.map(x, x.benefits\_related\_entities)** `[]bool` *required*

*Description coming soon*

```json CEL theme={null}
$result_object_key.benefits_information.map(x, x.benefits_related_entities)
```

```json Example theme={null}
[
[
{
"address": {
  "address1": "123 Main St",
  "address2": "Apt 4B",
  "city": "New York",
  "country_code": "US",
  "country_sub_division_code": "NYC",
  "postal_code": "10001",
  "state": "NY"
},
"contact_information": {
  "contacts": [
    {
      "communication_mode": "Phone",
      "communication_number": "123-456-7890"
    }
  ],
  "name": "Jane Doe"
},
"entity_first_name": "John",
"entity_identification": {
  "code": "ID123",
  "value": "Value123"
},
"entity_identifier": "EI123",
"entity_middle_name": "A",
"entity_name": "Entity Name",
"entity_relationship": "Relationship",
"entity_suffix": "Jr.",
"entity_type": "ET123",
"provider_information": {
  "provider_code": "PC123",
  "reference_identification": "RI123"
}
}
]
]
```

**benefits\_information.map(x, x.eligibility\_additional\_information)** `[]bool` *required*

*Description coming soon*

```json CEL theme={null}
$result_object_key.benefits_information.map(x, x.eligibility_additional_information)
```

```json Example theme={null}
[
{
"code_category": "Category",
"code_list_qualifier": "Code List Qualifier",
"code_list_qualifier_code": "CLQC123",
"industry": "Industry",
"industry_code": "IC123",
"injured_body_part_name": "Arm"
}
]
```

**in\_network\_eligibility\_summary** `object` *required*

*Description coming soon*

```json CEL theme={null}
$result_object_key.in_network_eligibility_summary
```

```json Example theme={null}
{
"co_pay_dollars": 100,
"coinsurance_percentage": 20,
"family_deductible_dollars": 2000,
"family_deductible_remaining_dollars": 842.21,
"individual_deductible_dollars": 1000,
"individual_deductible_remaining_dollars": 1000,
"insurance_type": "Point of Service (POS)",
"is_active_and_covered": true,
"limitations": [
"COMMERCIAL",
"20 sessions per year"
],
"plan_name": "OA Managed Choice POS"
}
```

**in\_network\_eligibility\_summary.is\_active\_and\_covered** `bool` *required*

The subscriber (or dependent) is actively covered by the insurance payer

```json CEL theme={null}
$result_object_key.in_network_eligibility_summary.is_active_and_covered
```

```json Example theme={null}
true
```

**in\_network\_eligibility\_summary.insurance\_type** `string` *required*

The type of insurance for the requested service type code

```json CEL theme={null}
$result_object_key.in_network_eligibility_summary.insurance_type
```

```json Example theme={null}
"Point of Service (POS)"
```

**in\_network\_eligibility\_summary.individual\_deductible\_dollars** `float64 (double)`

The individual deductible for the requested service type code for the calendar year

```json CEL theme={null}
$result_object_key.in_network_eligibility_summary.individual_deductible_dollars
```

```json Example theme={null}
1000
```

**in\_network\_eligibility\_summary.family\_deductible\_dollars** `float64 (double)`

The family deductible for the requested service type code for the calendar year

```json CEL theme={null}
$result_object_key.in_network_eligibility_summary.family_deductible_dollars
```

```json Example theme={null}
2000
```

**in\_network\_eligibility\_summary.individual\_deductible\_remaining\_dollars** `float64 (double)`

The individual deductible remaining for the requested service type code for the remaining insurance period

```json CEL theme={null}
$result_object_key.in_network_eligibility_summary.individual_deductible_remaining_dollars
```

```json Example theme={null}
1000
```

**in\_network\_eligibility\_summary.family\_deductible\_remaining\_dollars** `float64 (double)`

The family deductible remaining for the requested service type code for the remaining insurance period

```json CEL theme={null}
$result_object_key.in_network_eligibility_summary.family_deductible_remaining_dollars
```

```json Example theme={null}
842.21
```

**in\_network\_eligibility\_summary.co\_pay\_dollars** `float64 (double)`

The co-pay for the requested service type code

```json CEL theme={null}
$result_object_key.in_network_eligibility_summary.co_pay_dollars
```

```json Example theme={null}
100
```

**in\_network\_eligibility\_summary.coinsurance\_percentage** `float64 (double)`

The coinsurance percentage for the requested service type code

```json CEL theme={null}
$result_object_key.in_network_eligibility_summary.coinsurance_percentage
```

```json Example theme={null}
20
```

**in\_network\_eligibility\_summary.limitations** `[]string` *required*

The limitations for the requested service type code

```json CEL theme={null}
$result_object_key.in_network_eligibility_summary.limitations
```

```json Example theme={null}
[
"COMMERCIAL",
"20 sessions per year"
]
```

**in\_network\_eligibility\_summary.plan\_name** `string`

The plan name for the insurance

```json CEL theme={null}
$result_object_key.in_network_eligibility_summary.plan_name
```

```json Example theme={null}
"OA Managed Choice POS"
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.