{ "$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." } }}
v1
Check Eligibility
Documentation for the Check Eligibility action for Stedi
{ "$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." } }}
Morf runs insurance eligibility checks through our partnership with Stedi, in two modes:
Asynchronous — the Check Eligibility workflow action runs the check inside a Morf workflow. See the walkthrough below and the Parameters reference.
Synchronous — a Morf form calls the eligibility endpoint directly, so patients see their eligibility status immediately. See the form setup guide and the endpoint API reference.
Morf can run asynchronous insurance eligibility checks through our partnership with Stedi. Using the Stedi Check Eligibility action in your Morf workflow automates the patient’s eligibility check, saving admin staff time from manual checks.Run an asynchronous eligibility check when:
Insurance information is entered in your intake form
An insurance policy is created in your EHR
Any time insurance information is captured
Use eligibility check results to:
Update the patient chart in your EHR
Alert your team of ineligible patients via Slack
Send an SMS or email to your patient with the eligibility check results
Have something else in mind? Reach out to Morf support to learn more about how Morf’s Stedi eligibility checks can fit into your workflows.
A Feathery form collecting insurance info connected to your Morf organization. Follow the Feathery Setup Instructions to get started. The form must collect:
insurance_plan_name
member_id
first_name
last_name
date_of_birth
insurance_relationship
Your organization’s insurance information:
Organization Name
Organization or Provider NPI
Service Type Codes
Custom profile properties in Morf to store eligibility check results:
In the Workflows tab, click + New Workflow. Select a trigger to kick off the workflow. For this example, select the Feathery Form Step Submission trigger.
2. Configure Update Profile Properties node
Primary and secondary insurance properties are standard properties in Morf.
Save the Feathery form insurance information filled out by the patient to the Morf primary_insurance profile properties in the Update Profile Properties node.
3. Configure Stedi Payer ID mapping
In the Update Profile Properties node, add stedi_payer_id to the Map Properties section. For the value, open a CEL expression and input the following, swapping in your org’s accepted insurance plans and corresponding payer IDs from the Stedi Payer Network:
4. Add and configure the Stedi Check Eligibility action
Add the Stedi Check Eligibility action to the workflow. Rename the object name to stedi_eligibility_result for use in downstream logic.Map the primary_insurance Morf properties to the corresponding parameters in the Map Properties section of the action. Be sure to swap in your org-specific values for organization name, NPI, and service type codes.
5. Add branching logic based on eligibility results
Add filters after the Stedi Check Eligibility action to route executions based on the eligibility result.In the filters, input the following CEL expressions to route executions based on the result of the Check Eligibility action for the eligible and not eligible insurances.Is Eligible:
6. (Optional) Save eligibility results to Morf profile
Using an Update Profile Properties action, save the results of the eligibility check to the custom profile properties copay, coinsurance, and deductible. These values are sourced from in_network_eligibility_summary, created by Morf from the returned Stedi response.
7. (Optional) Slack message for ineligible results
To alert a team member about ineligible patients, configure a Send Incoming Webhook Message action on the ineligible branch.
Morf’s Stedi Check Eligibility action accepts mock patient data to test the endpoint using Morf’s test API key.In the Check Eligibility node configuration, set the Use Test API Key parameter to true. This allows mock patient eligibility data to be used to test the workflow.To test full functionality, trigger the workflow using mock patient data from Stedi’s mock eligibility examples.
Morf can run synchronous insurance eligibility checks through our partnership with Stedi. Using the Stedi Eligibility Endpoint in your Morf form instantly returns a user’s insurance eligibility, saving admin staff time from manual checks.Run a synchronous eligibility check when:
Insurance information is entered in your intake form
Use eligibility check results to:
Dynamically route patients through your intake form
Update the patient chart in your EHR
Send an SMS or email to your patient with the eligibility check results
Have something else in mind? Reach out to Morf support to learn more about how Morf’s Stedi eligibility checks can fit into your practice.
Stedi offers mock eligibility requests for testing. See the Stedi mock requests documentation for available test cases.Open the test version of your form and fill in information matching one of the mock eligibility results. Use the test npi, organizationName, and serviceTypeCodes shown below:
Morf’s eligibility endpoint is a wrapper around the Stedi API, with dates broken out into objects. Fields are required unless noted as optional. Use this endpoint when enabling synchronous eligiblity checks in your Morf form.See also: Stedi’s eligibility check documentation.
For a dependent, include a dependent object structured the same as subscriber.
We recommend including member_id, date_of_birth, first_name, and last_name — payers are required to return a response if the member is in their database.
A successful response returns a 200 status code with the fields below at the top level. Use is_active_and_covered and other fields for downstream logic.
Example response
{ "in_network_eligibility_summary": { "co_pay_dollars": 100, "coinsurance_percentage": 20, "family_deductible_dollars": 2000, "family_deductible_remaining_dollars": 842.21, "individual_deductible_dollars": 1000, "individual_deductible_remaining_dollars": 1000, "insurance_type": "Point of Service (POS)", "is_active_and_covered": true, "limitations": [ "COMMERCIAL", "20 sessions per year" ], "plan_name": "OA Managed Choice POS" } ... // Other fields left out for clarity here}
{ "$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." } }}
You can use the result of the action’s data as inputs to downstream workflow actions.Each fetch action requires an object name, which nests the action’s result data inside the downstream data context in the workflow. See Passing Data Between Actions for how to set it and reference the result from downstream nodes.Here we demonstrate how to refer to this data using the prefix $result_object_key.
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.
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.
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.