Parameters
Hide parameters
Hide parameters
ID
This field maps to the destination API tradingPartnerServiceId field.ID
This field maps to the destination API subscriber.memberId field.PII
This field maps to the destination API subscriber.firstName field.PII
This field maps to the destination API subscriber.lastName field.PII
This field maps to the destination API subscriber.dateOfBirth field.This field maps to the destination API
provider.npi field.This field maps to the destination API
provider.organizationName field.This field maps to the destination API
encounter.dateOfService field.This field maps to the destination API
encounter.serviceTypeCodes field.This field maps to the destination API
Default: in parallel field.Copy
Ask AI
{
"$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"
}
]
}
}
Copy
Ask AI
{
"$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 a result object key to be specified which will nest the action’s result data inside the downstream data context in the Workflow. Here we demonstrate how to refer to this data using the prefix$result_object_key.
Hide fields
Hide fields
Description coming soon
CEL
Copy
Ask AI
$result_object_key.meta
Example
Copy
Ask AI
{
"application_mode": "Production",
"biller_id": "B12345",
"outbound_trace_id": "OT12345",
"sender_id": "S12345",
"submitter_id": "SUB12345",
"trace_id": "T12345"
}
The sender ID Stedi assigns to this request.
CEL
Copy
Ask AI
$result_object_key.meta.sender_id
Example
Copy
Ask AI
"S12345"
The submitter ID Stedi assigns to this request.
CEL
Copy
Ask AI
$result_object_key.meta.submitter_id
Example
Copy
Ask AI
"SUB12345"
The biller ID Stedi assigns to this request.
CEL
Copy
Ask AI
$result_object_key.meta.biller_id
Example
Copy
Ask AI
"B12345"
The type of data in the request.
CEL
Copy
Ask AI
$result_object_key.meta.application_mode
Example
Copy
Ask AI
"Production"
The unique ID Stedi assigns to this request.
CEL
Copy
Ask AI
$result_object_key.meta.trace_id
Example
Copy
Ask AI
"T12345"
The value provided in the submitterTransactionIdentifier property in the original eligibility check request.
CEL
Copy
Ask AI
$result_object_key.meta.outbound_trace_id
Example
Copy
Ask AI
"OT12345"
An identifier for the payer’s response.
CEL
Copy
Ask AI
$result_object_key.control_number
Example
Copy
Ask AI
"123456"
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.
CEL
Copy
Ask AI
$result_object_key.trading_partner_service_id
Example
Copy
Ask AI
"123456"
Description coming soon
CEL
Copy
Ask AI
$result_object_key.provider
Example
Copy
Ask AI
{
"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"
}
The provider’s business name. Required if the provider is not a person.
CEL
Copy
Ask AI
$result_object_key.provider.organization_name
Example
Copy
Ask AI
"HealthCare Inc."
The provider’s first name. Required if the provider is an individual.
CEL
Copy
Ask AI
$result_object_key.provider.first_name
Example
Copy
Ask AI
"John"
The provider’s last name. Required if the provider is an individual.
CEL
Copy
Ask AI
$result_object_key.provider.last_name
Example
Copy
Ask AI
"Doe"
The provider’s National Provider Identifier (NPI).
CEL
Copy
Ask AI
$result_object_key.provider.npi
Example
Copy
Ask AI
"1234567890"
The provider’s service provider number.
CEL
Copy
Ask AI
$result_object_key.provider.service_provider_number
Example
Copy
Ask AI
"SP12345"
Only used for payer-to-payer transactions.
CEL
Copy
Ask AI
$result_object_key.provider.payor_id
Example
Copy
Ask AI
"P12345"
The provider’s Federal Taxpayer Identification Number (EIN).
CEL
Copy
Ask AI
$result_object_key.provider.tax_id
Example
Copy
Ask AI
"12-3456789"
The provider’s Social Security Number (SSN).
CEL
Copy
Ask AI
$result_object_key.provider.ssn
Example
Copy
Ask AI
"123-45-6789"
The provider’s pharmacy processor number.
CEL
Copy
Ask AI
$result_object_key.provider.pharmacy_processor_number
Example
Copy
Ask AI
"PP12345"
The provider’s role in the type of benefits specified in the request.
CEL
Copy
Ask AI
$result_object_key.provider.provider_code
Example
Copy
Ask AI
"AD"
The provider’s Taxonomy Code.
CEL
Copy
Ask AI
$result_object_key.provider.reference_identification
Example
Copy
Ask AI
"123456"
The type of provider.
CEL
Copy
Ask AI
$result_object_key.provider.provider_type
Example
Copy
Ask AI
"Individual"
The provider’s state license number.
CEL
Copy
Ask AI
$result_object_key.provider.state_licence_number
Example
Copy
Ask AI
"SL12345"
The provider’s Medicare provider number.
CEL
Copy
Ask AI
$result_object_key.provider.medicare_provider_number
Example
Copy
Ask AI
"MP12345"
The provider’s Medicaid provider number.
CEL
Copy
Ask AI
$result_object_key.provider.medicaid_provider_number
Example
Copy
Ask AI
"MD12345"
The provider’s facility ID number.
CEL
Copy
Ask AI
$result_object_key.provider.facility_id_number
Example
Copy
Ask AI
"FID12345"
The provider’s contract number.
CEL
Copy
Ask AI
$result_object_key.provider.contract_number
Example
Copy
Ask AI
"C12345"
The provider’s electronic device pin number.
CEL
Copy
Ask AI
$result_object_key.provider.device_pin_number
Example
Copy
Ask AI
"DPN12345"
The provider’s submitter identification number.
CEL
Copy
Ask AI
$result_object_key.provider.submitter_id_number
Example
Copy
Ask AI
"SID12345"
The provider’s plan network identification number.
CEL
Copy
Ask AI
$result_object_key.provider.provider_plan_network_id_number
Example
Copy
Ask AI
"PPN12345"
The provider’s facility network identification number.
CEL
Copy
Ask AI
$result_object_key.provider.facility_network_id_number
Example
Copy
Ask AI
"FN12345"
The provider’s prior identifier number.
CEL
Copy
Ask AI
$result_object_key.provider.prior_identifier_number
Example
Copy
Ask AI
"PIN12345"
The state that assigned the state license number.
CEL
Copy
Ask AI
$result_object_key.provider.information_receiver_additional_identifier_state
Example
Copy
Ask AI
"NY"
Description coming soon
CEL
Copy
Ask AI
$result_object_key.provider.address
Example
Copy
Ask AI
{
"address1": "123 Main St",
"address2": "Apt 4B",
"city": "New York",
"country_code": "US",
"country_sub_division_code": "NYC",
"postal_code": "10001",
"state": "NY"
}
The first line of the address.
CEL
Copy
Ask AI
$result_object_key.provider.address.address1
Example
Copy
Ask AI
"123 Main St"
The second line of the address.
CEL
Copy
Ask AI
$result_object_key.provider.address.address2
Example
Copy
Ask AI
"Apt 4B"
The city.
CEL
Copy
Ask AI
$result_object_key.provider.address.city
Example
Copy
Ask AI
"New York"
The US state or Canadian province code.
CEL
Copy
Ask AI
$result_object_key.provider.address.state
Example
Copy
Ask AI
"NY"
The United States or Canadian postal code.
CEL
Copy
Ask AI
$result_object_key.provider.address.postal_code
Example
Copy
Ask AI
"10001"
The two-letter country code.
CEL
Copy
Ask AI
$result_object_key.provider.address.country_code
Example
Copy
Ask AI
"US"
The country subdivision code.
CEL
Copy
Ask AI
$result_object_key.provider.address.country_sub_division_code
Example
Copy
Ask AI
"NYC"
Description coming soon
CEL
Copy
Ask AI
$result_object_key.subscriber
Example
Copy
Ask AI
{
"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."
}
The member ID for the subscriber’s insurance policy.
CEL
Copy
Ask AI
$result_object_key.subscriber.member_id
Example
Copy
Ask AI
"123456"
The subscriber’s date of birth
CEL
Copy
Ask AI
$result_object_key.subscriber.date_of_birth
Example
Copy
Ask AI
"19800101"
The patient’s first name.
CEL
Copy
Ask AI
$result_object_key.subscriber.first_name
Example
Copy
Ask AI
"John"
The patient’s middle name or middle initial.
CEL
Copy
Ask AI
$result_object_key.subscriber.middle_name
Example
Copy
Ask AI
"A"
The subscriber’s last name.
CEL
Copy
Ask AI
$result_object_key.subscriber.last_name
Example
Copy
Ask AI
"Doe"
The name suffix, such as Jr., Sr., or III.
CEL
Copy
Ask AI
$result_object_key.subscriber.suffix
Example
Copy
Ask AI
"Jr."
Code indicating the subscriber’s gender. Available options: M, F
CEL
Copy
Ask AI
$result_object_key.subscriber.gender
Example
Copy
Ask AI
"M"
The subscriber’s Social Security Number (SSN).
CEL
Copy
Ask AI
$result_object_key.subscriber.ssn
Example
Copy
Ask AI
"123-45-6789"
The group number associated with the subscriber’s insurance policy.
CEL
Copy
Ask AI
$result_object_key.subscriber.group_number
Example
Copy
Ask AI
"G12345"
The subscriber’s identification card number.
CEL
Copy
Ask AI
$result_object_key.subscriber.id_card
Example
Copy
Ask AI
"ID12345"
The provider code. Available options: AD, AT, BI, CO, CV, H, HH, LA, OT, P1, P2, PC, PE, R, RF, SB, SK, SU
CEL
Copy
Ask AI
$result_object_key.subscriber.provider_code
Example
Copy
Ask AI
"AD"
The reference identification qualifier. Available options: 9K, D3, EI, HPI, PXC, SY, TJ
CEL
Copy
Ask AI
$result_object_key.subscriber.reference_identification_qualifier
Example
Copy
Ask AI
"9K"
The provider identifier.
CEL
Copy
Ask AI
$result_object_key.subscriber.provider_identifier
Example
Copy
Ask AI
"P12345"
Description coming soon
CEL
Copy
Ask AI
$result_object_key.subscriber.health_care_code_information
Example
Copy
Ask AI
[
{
"diagnosis_code": "12345",
"diagnosis_type_code": "BK"
}
]
Mapped array of: The type of diagnosis code. Available options: BK, ABK, BF, ABF
CEL
Copy
Ask AI
$result_object_key.subscriber.health_care_code_information.map(x, x.diagnosis_type_code)
Example
Copy
Ask AI
[
"BK"
]
Mapped array of: The diagnosis code.
CEL
Copy
Ask AI
$result_object_key.subscriber.health_care_code_information.map(x, x.diagnosis_code)
Example
Copy
Ask AI
[
"12345"
]
Description coming soon
CEL
Copy
Ask AI
$result_object_key.subscriber.address
Example
Copy
Ask AI
{
"address1": "123 Main St",
"address2": "Apt 4B",
"city": "New York",
"country_code": "US",
"country_sub_division_code": "NYC",
"postal_code": "10001",
"state": "NY"
}
The first line of the address.
CEL
Copy
Ask AI
$result_object_key.subscriber.address.address1
Example
Copy
Ask AI
"123 Main St"
The second line of the address.
CEL
Copy
Ask AI
$result_object_key.subscriber.address.address2
Example
Copy
Ask AI
"Apt 4B"
The city.
CEL
Copy
Ask AI
$result_object_key.subscriber.address.city
Example
Copy
Ask AI
"New York"
The US state or Canadian province code.
CEL
Copy
Ask AI
$result_object_key.subscriber.address.state
Example
Copy
Ask AI
"NY"
The United States or Canadian postal code.
CEL
Copy
Ask AI
$result_object_key.subscriber.address.postal_code
Example
Copy
Ask AI
"10001"
The two-letter country code.
CEL
Copy
Ask AI
$result_object_key.subscriber.address.country_code
Example
Copy
Ask AI
"US"
The country subdivision code.
CEL
Copy
Ask AI
$result_object_key.subscriber.address.country_sub_division_code
Example
Copy
Ask AI
"NYC"
Description coming soon
CEL
Copy
Ask AI
$result_object_key.subscriber.additional_identification
Example
Copy
Ask AI
{
"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"
}
The insurance plan number.
CEL
Copy
Ask AI
$result_object_key.subscriber.additional_identification.plan_number
Example
Copy
Ask AI
"P12345"
The insurance group or policy number.
CEL
Copy
Ask AI
$result_object_key.subscriber.additional_identification.policy_number
Example
Copy
Ask AI
"POL12345"
The member identification number.
CEL
Copy
Ask AI
$result_object_key.subscriber.additional_identification.member_identification_number
Example
Copy
Ask AI
"M12345"
The contract number.
CEL
Copy
Ask AI
$result_object_key.subscriber.additional_identification.contract_number
Example
Copy
Ask AI
"C12345"
The medical record identification number.
CEL
Copy
Ask AI
$result_object_key.subscriber.additional_identification.medical_record_identification_number
Example
Copy
Ask AI
"MR12345"
The patient account number.
CEL
Copy
Ask AI
$result_object_key.subscriber.additional_identification.patient_account_number
Example
Copy
Ask AI
"PA12345"
The health insurance claim number.
CEL
Copy
Ask AI
$result_object_key.subscriber.additional_identification.health_insurance_claim_number
Example
Copy
Ask AI
"HIC12345"
The identification card serial number.
CEL
Copy
Ask AI
$result_object_key.subscriber.additional_identification.identification_card_serial_number
Example
Copy
Ask AI
"IDCS12345"
The insurance policy number.
CEL
Copy
Ask AI
$result_object_key.subscriber.additional_identification.insurance_policy_number
Example
Copy
Ask AI
"IP12345"
The plan network identification number.
CEL
Copy
Ask AI
$result_object_key.subscriber.additional_identification.plan_network_identification_number
Example
Copy
Ask AI
"PNI12345"
The Property and Casualty Claim Number.
CEL
Copy
Ask AI
$result_object_key.subscriber.additional_identification.agency_claim_number
Example
Copy
Ask AI
"AC12345"
The number assigned to each family member born with the same birth date.
CEL
Copy
Ask AI
$result_object_key.subscriber.birth_sequence_number
Example
Copy
Ask AI
"1"
The case number associated with the subscriber.
CEL
Copy
Ask AI
$result_object_key.subscriber.case_number
Example
Copy
Ask AI
"C12345"
The Medicaid Recipient Identification Number.
CEL
Copy
Ask AI
$result_object_key.subscriber.medicaid_recipient_identification_number
Example
Copy
Ask AI
"M12345"
The dollar amount the subscriber will apply toward their spend down amount.
CEL
Copy
Ask AI
$result_object_key.subscriber.spend_down_amount
Example
Copy
Ask AI
100
The subscriber’s spend down total billed amount.
CEL
Copy
Ask AI
$result_object_key.subscriber.spend_down_total_billed_amount
Example
Copy
Ask AI
200
This property is no longer used.
CEL
Copy
Ask AI
$result_object_key.subscriber.coverage_level_code
Example
Copy
Ask AI
"N/A"
Description coming soon
CEL
Copy
Ask AI
$result_object_key.subscriber_trace_numbers
Example
Copy
Ask AI
[
{
"originating_company_identifier": "OCI12345",
"reference_identification": "RI12345",
"secondary_reference_identification": "SRI12345",
"trace_type": "Trace Type",
"trace_type_code": "TT123"
}
]
Mapped array of: The code that identifies the type of trace number.
CEL
Copy
Ask AI
$result_object_key.subscriber_trace_numbers.map(x, x.trace_type_code)
Example
Copy
Ask AI
[
"TT123"
]
Mapped array of: The full name of the traceTypeCode.
CEL
Copy
Ask AI
$result_object_key.subscriber_trace_numbers.map(x, x.trace_type)
Example
Copy
Ask AI
[
"Trace Type"
]
Mapped array of: The unique trace number assigned to the transaction.
CEL
Copy
Ask AI
$result_object_key.subscriber_trace_numbers.map(x, x.reference_identification)
Example
Copy
Ask AI
[
"RI12345"
]
Mapped array of: The identifier of the organization that assigned the trace number.
CEL
Copy
Ask AI
$result_object_key.subscriber_trace_numbers.map(x, x.originating_company_identifier)
Example
Copy
Ask AI
[
"OCI12345"
]
Mapped array of: Identifies a subdivision within the organization that assigned the trace number.
CEL
Copy
Ask AI
$result_object_key.subscriber_trace_numbers.map(x, x.secondary_reference_identification)
Example
Copy
Ask AI
[
"SRI12345"
]
Description coming soon
CEL
Copy
Ask AI
$result_object_key.payer
Example
Copy
Ask AI
{
"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."
}
The entity identifier code for the payer.
CEL
Copy
Ask AI
$result_object_key.payer.entity_identifier
Example
Copy
Ask AI
"EI123"
The entity type qualifier for the payer.
CEL
Copy
Ask AI
$result_object_key.payer.entity_type
Example
Copy
Ask AI
"ET123"
The payer’s first name, when the payer is an individual (not commonly used).
CEL
Copy
Ask AI
$result_object_key.payer.first_name
Example
Copy
Ask AI
"John"
The payer’s last name. Used when the payer is an individual (not commonly used).
CEL
Copy
Ask AI
$result_object_key.payer.last_name
Example
Copy
Ask AI
"Doe"
The payer’s business name, when the payer is not a person.
CEL
Copy
Ask AI
$result_object_key.payer.name
Example
Copy
Ask AI
"Payer Inc."
The payer’s middle name or initial, when the payer is an individual (not commonly used).
CEL
Copy
Ask AI
$result_object_key.payer.middle_name
Example
Copy
Ask AI
"A"
The payer’s name suffix, such as Jr. or III. Used when the payer is an individual (not commonly used).
CEL
Copy
Ask AI
$result_object_key.payer.suffix
Example
Copy
Ask AI
"Jr."
The payer’s federal taxpayer’s identification number.
CEL
Copy
Ask AI
$result_object_key.payer.federal_taxpayers_id_number
Example
Copy
Ask AI
"FTIN12345"
The payer’s National Association of Insurance Commissioners (NAIC) identification number.
CEL
Copy
Ask AI
$result_object_key.payer.naic
Example
Copy
Ask AI
"NAIC12345"
The payer’s National Provider Identifier (NPI).
CEL
Copy
Ask AI
$result_object_key.payer.npi
Example
Copy
Ask AI
"NPI12345"
The payer’s Centers for Medicare and Medicaid Services PlanID.
CEL
Copy
Ask AI
$result_object_key.payer.centers_for_medicare_and_medicaid_plan_id
Example
Copy
Ask AI
"CMS12345"
The payor identification.
CEL
Copy
Ask AI
$result_object_key.payer.payor_identification
Example
Copy
Ask AI
"PID12345"
Description coming soon
CEL
Copy
Ask AI
$result_object_key.payer.contact_information
Example
Copy
Ask AI
{
"contacts": [
{
"communication_mode": "Phone",
"communication_number": "123-456-7890"
}
],
"name": "Jane Doe"
}
The name of the contact person.
CEL
Copy
Ask AI
$result_object_key.payer.contact_information.name
Example
Copy
Ask AI
"Jane Doe"
Description coming soon
CEL
Copy
Ask AI
$result_object_key.payer.contact_information.contacts
Example
Copy
Ask AI
[
{
"communication_mode": "Phone",
"communication_number": "123-456-7890"
}
]
Mapped array of: The type of communication number provided.
CEL
Copy
Ask AI
$result_object_key.payer.contact_information.contacts.map(x, x.communication_mode)
Example
Copy
Ask AI
[
"Phone"
]
Mapped array of: The communication number referenced in communicationMode.
CEL
Copy
Ask AI
$result_object_key.payer.contact_information.contacts.map(x, x.communication_number)
Example
Copy
Ask AI
[
"123-456-7890"
]
Description coming soon
CEL
Copy
Ask AI
$result_object_key.payer.aaa_errors
Example
Copy
Ask AI
[
{
"code": "ERR123",
"description": "Invalid request",
"followup_action": "Resubmit",
"location": "Segment N3",
"possible_resolutions": "Check the request format"
}
]
Mapped array of: The error code.
CEL
Copy
Ask AI
$result_object_key.payer.aaa_errors.map(x, x.code)
Example
Copy
Ask AI
[
"ERR123"
]
Mapped array of: The error description.
CEL
Copy
Ask AI
$result_object_key.payer.aaa_errors.map(x, x.description)
Example
Copy
Ask AI
[
"Invalid request"
]
Mapped array of: The location of the error within the original X12 EDI response.
CEL
Copy
Ask AI
$result_object_key.payer.aaa_errors.map(x, x.location)
Example
Copy
Ask AI
[
"Segment N3"
]
Mapped array of: Information to help you correct the error.
CEL
Copy
Ask AI
$result_object_key.payer.aaa_errors.map(x, x.possible_resolutions)
Example
Copy
Ask AI
[
"Check the request format"
]
Mapped array of: Allowed actions you can take, based on the rejection reason code.
CEL
Copy
Ask AI
$result_object_key.payer.aaa_errors.map(x, x.followup_action)
Example
Copy
Ask AI
[
"Resubmit"
]
The payer’s Electronic Transmitter Identification Number (ETIN).
CEL
Copy
Ask AI
$result_object_key.payer.etin
Example
Copy
Ask AI
"ETIN12345"
Description coming soon
CEL
Copy
Ask AI
$result_object_key.plan_information
Example
Copy
Ask AI
{
"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"
}
The state license number.
CEL
Copy
Ask AI
$result_object_key.plan_information.state_license_number
Example
Copy
Ask AI
"SL12345"
The Medicare provider number.
CEL
Copy
Ask AI
$result_object_key.plan_information.medicare_provider_number
Example
Copy
Ask AI
"MP12345"
The Medicaid provider number.
CEL
Copy
Ask AI
$result_object_key.plan_information.medicaid_provider_number
Example
Copy
Ask AI
"MD12345"
The facility ID number.
CEL
Copy
Ask AI
$result_object_key.plan_information.facility_id_number
Example
Copy
Ask AI
"FID12345"
The personal identification number (PIN).
CEL
Copy
Ask AI
$result_object_key.plan_information.personal_identification_number
Example
Copy
Ask AI
"PIN12345"
The plan number.
CEL
Copy
Ask AI
$result_object_key.plan_information.plan_number
Example
Copy
Ask AI
"PL12345"
The plan description.
CEL
Copy
Ask AI
$result_object_key.plan_information.plan_description
Example
Copy
Ask AI
"Health Plan"
The group or policy number.
CEL
Copy
Ask AI
$result_object_key.plan_information.policy_number
Example
Copy
Ask AI
"POL12345"
The member identification number - only used when checking eligibility with a Workers’ Compensation or Property and Casualty insurer.
CEL
Copy
Ask AI
$result_object_key.plan_information.member_id
Example
Copy
Ask AI
"MID12345"
The case number.
CEL
Copy
Ask AI
$result_object_key.plan_information.case_number
Example
Copy
Ask AI
"C12345"
The family unit number.
CEL
Copy
Ask AI
$result_object_key.plan_information.family_unit_number
Example
Copy
Ask AI
"F12345"
The group number.
CEL
Copy
Ask AI
$result_object_key.plan_information.group_number
Example
Copy
Ask AI
"G12345"
The group description.
CEL
Copy
Ask AI
$result_object_key.plan_information.group_description
Example
Copy
Ask AI
"Group Plan"
The referral number.
CEL
Copy
Ask AI
$result_object_key.plan_information.referral_number
Example
Copy
Ask AI
"R12345"
The alternative list ID - identifies a list of alternative drugs with the associated formulary status for the patient.
CEL
Copy
Ask AI
$result_object_key.plan_information.alternative_list_id
Example
Copy
Ask AI
"AL12345"
The class of contract code - used to identify the applicable class of contract for claims processing.
CEL
Copy
Ask AI
$result_object_key.plan_information.class_of_contract_code
Example
Copy
Ask AI
"CC123"
The coverage list ID - identifies a list of drugs that have coverage limitations for the patient.
CEL
Copy
Ask AI
$result_object_key.plan_information.coverage_list_id
Example
Copy
Ask AI
"CL12345"
The contract number of a contract between the payer and the provider that requested the eligibility check.
CEL
Copy
Ask AI
$result_object_key.plan_information.contract_number
Example
Copy
Ask AI
"C12345"
The medical record identification number.
CEL
Copy
Ask AI
$result_object_key.plan_information.medical_record_identification_number
Example
Copy
Ask AI
"MR12345"
The electronic device pin number.
CEL
Copy
Ask AI
$result_object_key.plan_information.electronic_device_pin
Example
Copy
Ask AI
"EDP12345"
The submitter identification number.
CEL
Copy
Ask AI
$result_object_key.plan_information.submitter_identification_number
Example
Copy
Ask AI
"SID12345"
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.
CEL
Copy
Ask AI
$result_object_key.plan_information.patient_account_number
Example
Copy
Ask AI
"PA12345"
The health insurance claim number.
CEL
Copy
Ask AI
$result_object_key.plan_information.hic_number
Example
Copy
Ask AI
"HIC12345"
The drug formulary number.
CEL
Copy
Ask AI
$result_object_key.plan_information.drug_formulary_number
Example
Copy
Ask AI
"DF12345"
The prior authorization number.
CEL
Copy
Ask AI
$result_object_key.plan_information.prior_authorization_number
Example
Copy
Ask AI
"PA12345"
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.
CEL
Copy
Ask AI
$result_object_key.plan_information.id_card_serial_number
Example
Copy
Ask AI
"IDCS12345"
The identity card number, used when the Identity Card Number is different than the Member Identification Number.
CEL
Copy
Ask AI
$result_object_key.plan_information.id_card_number
Example
Copy
Ask AI
"ID12345"
The National Provider Identifier (NPI) assigned by the Centers for Medicare and Medicaid Services.
CEL
Copy
Ask AI
$result_object_key.plan_information.centers_for_medicare_and_medicaid_services_npi
Example
Copy
Ask AI
"CMSNPI12345"
The issue number.
CEL
Copy
Ask AI
$result_object_key.plan_information.issue_number
Example
Copy
Ask AI
"IN12345"
The insurance policy number.
CEL
Copy
Ask AI
$result_object_key.plan_information.insurance_policy_number
Example
Copy
Ask AI
"IP12345"
The user identification.
CEL
Copy
Ask AI
$result_object_key.plan_information.user_identification
Example
Copy
Ask AI
"UID12345"
The medical assistance category.
CEL
Copy
Ask AI
$result_object_key.plan_information.medical_assistance_category
Example
Copy
Ask AI
"MAC123"
The eligibility category.
CEL
Copy
Ask AI
$result_object_key.plan_information.eligibility_category
Example
Copy
Ask AI
"EC123"
The plan network identification number.
CEL
Copy
Ask AI
$result_object_key.plan_information.plan_network_id_number
Example
Copy
Ask AI
"PNI12345"
The plan, group, or plan network name.
CEL
Copy
Ask AI
$result_object_key.plan_information.plan_network_id_description
Example
Copy
Ask AI
"Plan Network"
The facility network identification number.
CEL
Copy
Ask AI
$result_object_key.plan_information.facility_network_identification_number
Example
Copy
Ask AI
"FNI12345"
The Medicaid recipient identification number.
CEL
Copy
Ask AI
$result_object_key.plan_information.medicaid_recipient_id_number
Example
Copy
Ask AI
"MRID12345"
The prior identifier number.
CEL
Copy
Ask AI
$result_object_key.plan_information.prior_id_number
Example
Copy
Ask AI
"PID12345"
The social security number.
CEL
Copy
Ask AI
$result_object_key.plan_information.social_security_number
Example
Copy
Ask AI
"SSN12345"
The federal taxpayer’s identification number.
CEL
Copy
Ask AI
$result_object_key.plan_information.federal_taxpayers_identification_number
Example
Copy
Ask AI
"FTIN12345"
The agency claim number, only used when the information source is a Property and Casualty payer.
CEL
Copy
Ask AI
$result_object_key.plan_information.agency_claim_number
Example
Copy
Ask AI
"AC12345"
Description coming soon
CEL
Copy
Ask AI
$result_object_key.plan_date_information
Example
Copy
Ask AI
{
"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"
}
The date of discharge.
CEL
Copy
Ask AI
$result_object_key.plan_date_information.discharge
Example
Copy
Ask AI
"2023-01-01"
The issue date.
CEL
Copy
Ask AI
$result_object_key.plan_date_information.issue
Example
Copy
Ask AI
"2023-01-01"
The effective date of change.
CEL
Copy
Ask AI
$result_object_key.plan_date_information.effective_date_of_change
Example
Copy
Ask AI
"2023-01-01"
The plan date.
CEL
Copy
Ask AI
$result_object_key.plan_date_information.plan
Example
Copy
Ask AI
"2023-01-01"
The eligibility date.
CEL
Copy
Ask AI
$result_object_key.plan_date_information.eligibility
Example
Copy
Ask AI
"2023-01-01"
The date added.
CEL
Copy
Ask AI
$result_object_key.plan_date_information.added
Example
Copy
Ask AI
"2023-01-01"
The COBRA begin date.
CEL
Copy
Ask AI
$result_object_key.plan_date_information.cobra_begin
Example
Copy
Ask AI
"2023-01-01"
The COBRA end date.
CEL
Copy
Ask AI
$result_object_key.plan_date_information.cobra_end
Example
Copy
Ask AI
"2023-01-31"
The premium paid to date begin.
CEL
Copy
Ask AI
$result_object_key.plan_date_information.premium_paid_to_date_begin
Example
Copy
Ask AI
"2023-01-01"
The premium paid to date end.
CEL
Copy
Ask AI
$result_object_key.plan_date_information.premium_paid_to_date_end
Example
Copy
Ask AI
"2023-01-31"
The plan begin date.
CEL
Copy
Ask AI
$result_object_key.plan_date_information.plan_begin
Example
Copy
Ask AI
"2023-01-01"
The plan end date.
CEL
Copy
Ask AI
$result_object_key.plan_date_information.plan_end
Example
Copy
Ask AI
"2023-01-31"
The eligibility begin date.
CEL
Copy
Ask AI
$result_object_key.plan_date_information.eligibility_begin
Example
Copy
Ask AI
"2023-01-01"
The eligibility end date.
CEL
Copy
Ask AI
$result_object_key.plan_date_information.eligibility_end
Example
Copy
Ask AI
"2023-01-31"
The enrollment date.
CEL
Copy
Ask AI
$result_object_key.plan_date_information.enrollment
Example
Copy
Ask AI
"2023-01-01"
The admission date.
CEL
Copy
Ask AI
$result_object_key.plan_date_information.admission
Example
Copy
Ask AI
"2023-01-01"
The date of death.
CEL
Copy
Ask AI
$result_object_key.plan_date_information.date_of_death
Example
Copy
Ask AI
"2023-01-01"
The certification date.
CEL
Copy
Ask AI
$result_object_key.plan_date_information.certification
Example
Copy
Ask AI
"2023-01-01"
The service date.
CEL
Copy
Ask AI
$result_object_key.plan_date_information.service
Example
Copy
Ask AI
"2023-01-01"
The policy effective date.
CEL
Copy
Ask AI
$result_object_key.plan_date_information.policy_effective
Example
Copy
Ask AI
"2023-01-01"
The policy expiration date.
CEL
Copy
Ask AI
$result_object_key.plan_date_information.policy_expiration
Example
Copy
Ask AI
"2023-01-31"
The date of last update.
CEL
Copy
Ask AI
$result_object_key.plan_date_information.date_of_last_update
Example
Copy
Ask AI
"2023-01-01"
The status date.
CEL
Copy
Ask AI
$result_object_key.plan_date_information.status
Example
Copy
Ask AI
"2023-01-01"
Description coming soon
CEL
Copy
Ask AI
$result_object_key.errors
Example
Copy
Ask AI
[
{
"code": "ERR123",
"description": "Invalid request",
"followup_action": "Resubmit",
"location": "Segment N3",
"possible_resolutions": "Check the request format"
}
]
Mapped array of: The error code.
CEL
Copy
Ask AI
$result_object_key.errors.map(x, x.code)
Example
Copy
Ask AI
[
"ERR123"
]
Mapped array of: The error description.
CEL
Copy
Ask AI
$result_object_key.errors.map(x, x.description)
Example
Copy
Ask AI
[
"Invalid request"
]
Mapped array of: The location of the error within the original X12 EDI response.
CEL
Copy
Ask AI
$result_object_key.errors.map(x, x.location)
Example
Copy
Ask AI
[
"Segment N3"
]
Mapped array of: Information to help you correct the error.
CEL
Copy
Ask AI
$result_object_key.errors.map(x, x.possible_resolutions)
Example
Copy
Ask AI
[
"Check the request format"
]
Mapped array of: Allowed actions you can take, based on the rejection reason code.
CEL
Copy
Ask AI
$result_object_key.errors.map(x, x.followup_action)
Example
Copy
Ask AI
[
"Resubmit"
]
Description coming soon
CEL
Copy
Ask AI
$result_object_key.warnings
Example
Copy
Ask AI
[
{
"code": "WARN123",
"description": "This is a warning"
}
]
Mapped array of: The warning code.
CEL
Copy
Ask AI
$result_object_key.warnings.map(x, x.code)
Example
Copy
Ask AI
[
"WARN123"
]
Mapped array of: The warning description.
CEL
Copy
Ask AI
$result_object_key.warnings.map(x, x.description)
Example
Copy
Ask AI
[
"This is a warning"
]
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.
CEL
Copy
Ask AI
$result_object_key.status
Example
Copy
Ask AI
"Error"
The transaction set acknowledgment code provided in in the X12 EDI 999 response.
CEL
Copy
Ask AI
$result_object_key.transaction_set_acknowledgement
Example
Copy
Ask AI
"ACK"
The implementation transaction set error code provided in IK502 of the 999 transaction.
CEL
Copy
Ask AI
$result_object_key.implementation_transaction_set_syntax_error
Example
Copy
Ask AI
"ERR"
Description coming soon
CEL
Copy
Ask AI
$result_object_key.dependents
Example
Copy
Ask AI
[
{
"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."
}
]
Mapped array of: The member ID for the dependent’s insurance policy.
CEL
Copy
Ask AI
$result_object_key.dependents.map(x, x.member_id)
Example
Copy
Ask AI
[
"123456"
]
Mapped array of: The dependent’s date of birth.
CEL
Copy
Ask AI
$result_object_key.dependents.map(x, x.date_of_birth)
Example
Copy
Ask AI
[
"19800101"
]
Mapped array of: The dependent’s first name.
CEL
Copy
Ask AI
$result_object_key.dependents.map(x, x.first_name)
Example
Copy
Ask AI
[
"John"
]
Mapped array of: The dependent’s middle name or middle initial.
CEL
Copy
Ask AI
$result_object_key.dependents.map(x, x.middle_name)
Example
Copy
Ask AI
[
"A"
]
Mapped array of: The dependent’s last name.
CEL
Copy
Ask AI
$result_object_key.dependents.map(x, x.last_name)
Example
Copy
Ask AI
[
"Doe"
]
Mapped array of: The name suffix, such as Jr., Sr., or III.
CEL
Copy
Ask AI
$result_object_key.dependents.map(x, x.suffix)
Example
Copy
Ask AI
[
"Jr."
]
Mapped array of: Code indicating the dependent’s gender. Available options: M, F
CEL
Copy
Ask AI
$result_object_key.dependents.map(x, x.gender)
Example
Copy
Ask AI
[
"M"
]
Mapped array of: The dependent’s Social Security Number (SSN).
CEL
Copy
Ask AI
$result_object_key.dependents.map(x, x.ssn)
Example
Copy
Ask AI
[
"123-45-6789"
]
Mapped array of: The group number associated with the dependent’s insurance policy.
CEL
Copy
Ask AI
$result_object_key.dependents.map(x, x.group_number)
Example
Copy
Ask AI
[
"G12345"
]
Mapped array of: The dependent’s identification card number.
CEL
Copy
Ask AI
$result_object_key.dependents.map(x, x.id_card)
Example
Copy
Ask AI
[
"ID12345"
]
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
CEL
Copy
Ask AI
$result_object_key.dependents.map(x, x.provider_code)
Example
Copy
Ask AI
[
"AD"
]
Mapped array of: The reference identification qualifier. Available options: 9K, D3, EI, HPI, PXC, SY, TJ
CEL
Copy
Ask AI
$result_object_key.dependents.map(x, x.reference_identification_qualifier)
Example
Copy
Ask AI
[
"9K"
]
Mapped array of: The provider identifier.
CEL
Copy
Ask AI
$result_object_key.dependents.map(x, x.provider_identifier)
Example
Copy
Ask AI
[
"P12345"
]
Description coming soon
CEL
Copy
Ask AI
$result_object_key.dependents.map(x, x.health_care_code_information)
Example
Copy
Ask AI
[
[
{
"diagnosis_code": "12345",
"diagnosis_type_code": "BK"
}
]
]
Description coming soon
CEL
Copy
Ask AI
$result_object_key.dependents.map(x, x.address)
Example
Copy
Ask AI
[
{
"address1": "123 Main St",
"address2": "Apt 4B",
"city": "New York",
"country_code": "US",
"country_sub_division_code": "NYC",
"postal_code": "10001",
"state": "NY"
}
]
Description coming soon
CEL
Copy
Ask AI
$result_object_key.dependents.map(x, x.additional_identification)
Example
Copy
Ask AI
[
{
"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"
}
]
Mapped array of: The number assigned to each family member born with the same birth date.
CEL
Copy
Ask AI
$result_object_key.dependents.map(x, x.birth_sequence_number)
Example
Copy
Ask AI
[
"1"
]
Mapped array of: The case number associated with the dependent.
CEL
Copy
Ask AI
$result_object_key.dependents.map(x, x.case_number)
Example
Copy
Ask AI
[
"C12345"
]
Mapped array of: The Medicaid Recipient Identification Number.
CEL
Copy
Ask AI
$result_object_key.dependents.map(x, x.medicaid_recipient_identification_number)
Example
Copy
Ask AI
[
"M12345"
]
Mapped array of: The dollar amount the dependent will apply toward their spend down amount.
CEL
Copy
Ask AI
$result_object_key.dependents.map(x, x.spend_down_amount)
Example
Copy
Ask AI
[
100
]
Mapped array of: The dependent’s spend down total billed amount.
CEL
Copy
Ask AI
$result_object_key.dependents.map(x, x.spend_down_total_billed_amount)
Example
Copy
Ask AI
[
200
]
Mapped array of: This property is no longer used.
CEL
Copy
Ask AI
$result_object_key.dependents.map(x, x.coverage_level_code)
Example
Copy
Ask AI
[
"N/A"
]
Description coming soon
CEL
Copy
Ask AI
$result_object_key.benefits_information
Example
Copy
Ask AI
[
{
"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"
}
]
Mapped array of: The benefit code.
CEL
Copy
Ask AI
$result_object_key.benefits_information.map(x, x.code)
Example
Copy
Ask AI
[
"BC123"
]
Mapped array of: The benefit name.
CEL
Copy
Ask AI
$result_object_key.benefits_information.map(x, x.name)
Example
Copy
Ask AI
[
"Benefit Name"
]
Mapped array of: The coverage level code.
CEL
Copy
Ask AI
$result_object_key.benefits_information.map(x, x.coverage_level_code)
Example
Copy
Ask AI
[
"CLC123"
]
Mapped array of: The coverage level.
CEL
Copy
Ask AI
$result_object_key.benefits_information.map(x, x.coverage_level)
Example
Copy
Ask AI
[
"Coverage Level"
]
Mapped array of: The service type codes.
CEL
Copy
Ask AI
$result_object_key.benefits_information.map(x, x.service_type_codes)
Example
Copy
Ask AI
[
[
"STC123",
"STC456"
]
]
Mapped array of: The insurance type code.
CEL
Copy
Ask AI
$result_object_key.benefits_information.map(x, x.insurance_type_code)
Example
Copy
Ask AI
[
"ITC123"
]
Mapped array of: The insurance type.
CEL
Copy
Ask AI
$result_object_key.benefits_information.map(x, x.insurance_type)
Example
Copy
Ask AI
[
"Insurance Type"
]
Mapped array of: The plan coverage.
CEL
Copy
Ask AI
$result_object_key.benefits_information.map(x, x.plan_coverage)
Example
Copy
Ask AI
[
"Plan Coverage"
]
Mapped array of: The time qualifier code.
CEL
Copy
Ask AI
$result_object_key.benefits_information.map(x, x.time_qualifier_code)
Example
Copy
Ask AI
[
"TQC123"
]
Mapped array of: The time qualifier.
CEL
Copy
Ask AI
$result_object_key.benefits_information.map(x, x.time_qualifier)
Example
Copy
Ask AI
[
"Time Qualifier"
]
Mapped array of: The benefit amount.
CEL
Copy
Ask AI
$result_object_key.benefits_information.map(x, x.benefit_amount)
Example
Copy
Ask AI
[
"1000"
]
Mapped array of: The benefit percent.
CEL
Copy
Ask AI
$result_object_key.benefits_information.map(x, x.benefit_percent)
Example
Copy
Ask AI
[
"80"
]
Mapped array of: The quantity qualifier code.
CEL
Copy
Ask AI
$result_object_key.benefits_information.map(x, x.quantity_qualifier_code)
Example
Copy
Ask AI
[
"QQC123"
]
Mapped array of: The quantity qualifier.
CEL
Copy
Ask AI
$result_object_key.benefits_information.map(x, x.quantity_qualifier)
Example
Copy
Ask AI
[
"Quantity Qualifier"
]
Mapped array of: The benefit quantity.
CEL
Copy
Ask AI
$result_object_key.benefits_information.map(x, x.benefit_quantity)
Example
Copy
Ask AI
[
"10"
]
Mapped array of: The authorization or certification indicator.
CEL
Copy
Ask AI
$result_object_key.benefits_information.map(x, x.auth_or_cert_indicator)
Example
Copy
Ask AI
[
"Y"
]
Mapped array of: The in-plan network indicator.
CEL
Copy
Ask AI
$result_object_key.benefits_information.map(x, x.in_plan_network_indicator)
Example
Copy
Ask AI
[
"Y"
]
Mapped array of: The header loop identifier.
CEL
Copy
Ask AI
$result_object_key.benefits_information.map(x, x.header_loop_identifier)
Example
Copy
Ask AI
[
"HLI123"
]
Mapped array of: The trailer loop identifier.
CEL
Copy
Ask AI
$result_object_key.benefits_information.map(x, x.trailer_loop_identifier)
Example
Copy
Ask AI
[
"TLI123"
]
Description coming soon
CEL
Copy
Ask AI
$result_object_key.benefits_information.map(x, x.composite_medical_procedure_identifier)
Example
Copy
Ask AI
[
{
"diagnosis_code_pointer": [
"DCP1",
"DCP2"
],
"procedure_code": "PROC123",
"procedure_modifiers": [
"MOD1",
"MOD2"
],
"product_or_service_id": [
"PSID123",
"PSID456"
],
"product_or_service_id_qualifier": "HC"
}
]
Description coming soon
CEL
Copy
Ask AI
$result_object_key.benefits_information.map(x, x.benefits_additional_information)
Example
Copy
Ask AI
[
{
"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"
}
]
Description coming soon
CEL
Copy
Ask AI
$result_object_key.benefits_information.map(x, x.benefits_service_delivery)
Example
Copy
Ask AI
[
[
{
"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"
}
]
]
Description coming soon
CEL
Copy
Ask AI
$result_object_key.benefits_information.map(x, x.additional_information)
Example
Copy
Ask AI
[
[
{
"description": "Description"
}
]
]
Description coming soon
CEL
Copy
Ask AI
$result_object_key.benefits_information.map(x, x.eligibility_additional_information_list)
Example
Copy
Ask AI
[
[
{
"code_category": "Category",
"code_list_qualifier": "Code List Qualifier",
"code_list_qualifier_code": "CLQC123",
"industry": "Industry",
"industry_code": "IC123",
"injured_body_part_name": "Arm"
}
]
]
Description coming soon
CEL
Copy
Ask AI
$result_object_key.benefits_information.map(x, x.benefits_date_information)
Example
Copy
Ask AI
[
{
"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"
}
]
Description coming soon
CEL
Copy
Ask AI
$result_object_key.benefits_information.map(x, x.benefits_related_entity)
Example
Copy
Ask AI
[
{
"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"
}
}
]
Description coming soon
CEL
Copy
Ask AI
$result_object_key.benefits_information.map(x, x.benefits_related_entities)
Example
Copy
Ask AI
[
[
{
"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"
}
}
]
]
Description coming soon
CEL
Copy
Ask AI
$result_object_key.benefits_information.map(x, x.eligibility_additional_information)
Example
Copy
Ask AI
[
{
"code_category": "Category",
"code_list_qualifier": "Code List Qualifier",
"code_list_qualifier_code": "CLQC123",
"industry": "Industry",
"industry_code": "IC123",
"injured_body_part_name": "Arm"
}
]
Description coming soon
CEL
Copy
Ask AI
$result_object_key.in_network_eligibility_summary
Example
Copy
Ask AI
{
"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"
}
The subscriber (or dependent) is actively covered by the insurance payer
CEL
Copy
Ask AI
$result_object_key.in_network_eligibility_summary.is_active_and_covered
Example
Copy
Ask AI
true
The type of insurance for the requested service type code
CEL
Copy
Ask AI
$result_object_key.in_network_eligibility_summary.insurance_type
Example
Copy
Ask AI
"Point of Service (POS)"
The individual deductible for the requested service type code for the calendar year
CEL
Copy
Ask AI
$result_object_key.in_network_eligibility_summary.individual_deductible_dollars
Example
Copy
Ask AI
1000
The family deductible for the requested service type code for the calendar year
CEL
Copy
Ask AI
$result_object_key.in_network_eligibility_summary.family_deductible_dollars
Example
Copy
Ask AI
2000
The individual deductible remaining for the requested service type code for the remaining insurance period
CEL
Copy
Ask AI
$result_object_key.in_network_eligibility_summary.individual_deductible_remaining_dollars
Example
Copy
Ask AI
1000
The family deductible remaining for the requested service type code for the remaining insurance period
CEL
Copy
Ask AI
$result_object_key.in_network_eligibility_summary.family_deductible_remaining_dollars
Example
Copy
Ask AI
842.21
The co-pay for the requested service type code
CEL
Copy
Ask AI
$result_object_key.in_network_eligibility_summary.co_pay_dollars
Example
Copy
Ask AI
100
The coinsurance percentage for the requested service type code
CEL
Copy
Ask AI
$result_object_key.in_network_eligibility_summary.coinsurance_percentage
Example
Copy
Ask AI
20
The limitations for the requested service type code
CEL
Copy
Ask AI
$result_object_key.in_network_eligibility_summary.limitations
Example
Copy
Ask AI
[
"COMMERCIAL",
"20 sessions per year"
]
The plan name for the insurance
CEL
Copy
Ask AI
$result_object_key.in_network_eligibility_summary.plan_name
Example
Copy
Ask AI
"OA Managed Choice POS"
