Poll Batch Eligibility Checks

Retrieve batch eligibility check results

GET/eligibility-manager/polling/batch-eligibility

This endpoint retrieves the results of asynchronous eligibility checks you submitted through the asynchronous Batch Eligibility Checks endpoint or through CSV upload in the Stedi portal. It doesn't return results for real-time eligibility checks.

  1. Call this endpoint. You can optionally add one or more query parameters to filter the results you want to retrieve.
  2. The endpoint returns completed checks matching the criteria. Stedi retries checks that fail due to payer connectivity issues for 8 - 24 hours. It can take up to the configured retry period for all checks in a batch to return results.

Each item in the response contains the benefits information for a completed eligibility check. Note that our documentation lists all enums officially allowed in the eligibility response. Some payers return non-compliant values, which Stedi passes through as is.

Visit Retrieve batch results for a complete how-to guide.

Pagination

By default, the response includes the results for up to 10 eligibility checks within a single page - each eligibility response is represented as one item in the items array. You can control the number of results returned per page using the pageSize query parameter, which accepts a value between 1 and 200.

When there are additional pages of results, the response includes the nextPageToken property. To retrieve the next page of results, call the endpoint with the same batchId and other query parameters, and set the pageToken query parameter to the nextPageToken value. Repeat this process until the response doesn't include a nextPageToken property.

If you set the page size to a value > 20, Stedi returns the requested batch check results in gzip format to reduce the size. Many common HTTP clients accept gzip by default, but if not, you must add the Accept-Encoding: gzip header to your request and resubmit.

Authorization
RequiredHeader

A Stedi API Key for authentication.

Query Parameters

pageSize
IntegerRange: ≥ 1 and ≤ 200

The maximum number of check results to return in a page - each check is represented as one item in the items array. If not specified, the default is 10.

  • If you set the page size to a value > 20, Stedi returns the requested batch check results in gzip format to reduce the size. Many common HTTP clients accept gzip by default, but if not, you must add the Accept-Encoding: gzip header to your request and resubmit.
  • When check results are especially large, Stedi may return fewer than the requested number per page. In these cases, you can use the nextPageToken property to retrieve the rest of the requested results.
pageToken
StringLength: 1 - 1024

A token returned by a previous call to this operation in the nextPageToken property. If not specified, Stedi returns the first page of results.

batchId
String

An identifier for a batch of eligibility checks submitted through the Batch Eligibility Check endpoint. Use this to retrieve results for eligibility checks in the batch.

startDateTime
StringFormat: date-time

An ISO 8601 formatted string. For example 2023-08-28T00:00:00Z. Stedi returns asynchronous eligibility checks that have completed processing after this time. Completed means that the payer has successfully returned a benefits response, the check has failed due to errors in the request, or that the payer has been unavailable for 8 hours and Stedi will no longer attempt to retry.

Response

application/json

BatchEligibilityPolling 200 response

items
Array of ObjectsRequired

Each eligibility check response is included as a separate item in this array. The response shape is identical to the shape of the response for the Real-Time Eligibility Check endpoint, with the addition of two new properties that help you correlate the results with individual eligibility checks. - batchId contains the batchId Stedi returned from the Batch Eligibility Check endpoint when making the request. - submitterTransactionIdentifier contains the unique identifier for the eligibility check that you submitted in the request.

Array item
batchId
items[].batchId
String

The batchId Stedi returned from the Batch Eligibility Check endpoint.

batchName
items[].batchName
StringRegex pattern: ^[a-zA-Z0-9-_]{1,100}$

The name Stedi uses when displaying this batch on the Eligibility check batches page. If you didn't specify a name when submitting the batch, this is the same as the batchId.

benefitsInformation
items[].benefitsInformation
Array of Objects

Information about the patient's healthcare benefits, such as coverage level (individual vs. family), coverage type (deductibles, co-pays, etc.), out of pocket maximums, and more.

Payers typically return at least the following properties: code, coverageLevelCode, serviceTypeCodes, and either benefitAmount or benefitPercent. However, the exact properties returned in this object are up to the payer's discretion.

The payer may send benefits information for service type codes (STCs) you didn't request - this is expected. The STC you send in the request tells the payer the types of benefits information you want, but they aren't required to respond with exactly the same STC(s) in the response. Receiving different STCs than you requested can also mean that the payer is ignoring the STC you sent, which is why we recommend testing payers to determine their support for specific STCs.

Visit Determine patient benefits for more information about benefit types, details about how to interpret the benefitsInformation array, and additional examples.

Array item
additionalInformation
items[].benefitsInformation[].additionalInformation
Array of Objects

A free-form message containing additional information about the benefits in the response.

Array item
description
items[].benefitsInformation[].additionalInformation[].description
String

A free-form message containing additional information about the benefits in the response.

authOrCertIndicator
items[].benefitsInformation[].authOrCertIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification. Can be Y - Yes, N - No, or U - Unknown.

  • When this property is set to U, it means the payer can't determine in real time whether prior authorization is required for the service. They may require additional details, like diagnosis or place of service to make a determination. Check the additionalInformation.description property for any additional clarification. You can also contact the payer directly or use their provider portal to get more information.
  • Some payers may send additional notes about prior authorization rules in the additionalInformation.description property. Payers may also send prior authorization notes in a separate benefitsInformation object with a code of 1 (Active coverage), CB (Coverage Benefit), or D (Benefit Description).

Visit our patient benefits docs to learn more about prior authorization.

Payers may sometimes return other non-compliant values.

Possible values
N
U
Y
benefitAmount
items[].benefitsInformation[].benefitAmount
String

The monetary benefit amount, such as a patient's co-pay or deductible. This value is expressed as a decimal, such as 100.00.

The payer will always send a value in this property when the benefitsInformation.code = B - Co-Payment, C - Deductible, G - Out of Pocket (Stop Loss), J - Cost Containment, or Y - Spend Down. For those codes, this value represents the patient's portion of responsibility.

The payer will never send this value when benefitsInformation.code = A - Co-Insurance. This property can contain zero when the patient has no responsibility.

Learn more about patient costs.

benefitPercent
items[].benefitsInformation[].benefitPercent
String

The percentage of the benefit, such as co-insurance. This property can contain zero when the patient has no responsibility.

The payer will always send a value in this property when benefitsInformation.code = A - Co-Insurance. For this code, this value represents the patient's portion of the responsibility. The percentage is expressed as a decimal, such as 0.80 represents 80%.

The payer will never send a value in this property when benefitsInformation.code = B - Co-Payment, C - Deductible, G - Out of Pocket (Stop Loss), J - Cost Containment, or Y - Spend Down.

Learn more about patient costs.

benefitQuantity
items[].benefitsInformation[].benefitQuantity
String

The quantity of the benefit, qualified by the type specified in quantityQualifier. For example, 10 when the quantityQualifier is Visits.

benefitsAdditionalInformation
items[].benefitsInformation[].benefitsAdditionalInformation
Object

Identifying information specific to this type of benefit.

Show attributes
alternativeListId
items[].benefitsInformation[].benefitsAdditionalInformation.alternativeListId
String

The alternative list ID. This identifier allows the payer to specify a list of drugs and its alternative drugs with the associated formulary status for the patient.

coverageListId
items[].benefitsInformation[].benefitsAdditionalInformation.coverageListId
String

The coverage list ID. This identifier allows the payer to specify the identifier of a list of drugs that have coverage limitations for the associated patient.

drugFormularyNumber
items[].benefitsInformation[].benefitsAdditionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
items[].benefitsInformation[].benefitsAdditionalInformation.familyUnitNumber
String

The family unit number. This is returned when the payer is a pharmacy benefits manager (PBM) and the patient has a suffix to their member ID number that is used in the NCPDP Telecom Standard Insurance Segment, in field 303-C3 (Person Code). For all other uses, the family unit number (suffix) is considered part of the patient's member ID number.

groupDescription
items[].benefitsInformation[].benefitsAdditionalInformation.groupDescription
String

Group name

groupNumber
items[].benefitsInformation[].benefitsAdditionalInformation.groupNumber
String

The group number for the patient's health insurance plan.

hicNumber
items[].benefitsInformation[].benefitsAdditionalInformation.hicNumber
String

The health insurance claim number (HICN). Note that CMS previously used the HICN to uniquely identify Medicare beneficiaries. However, they have since transitioned to a new, randomized Medicare Beneficiary Identifier (MBI) format. The HICN is no longer used for Medicare transactions but this property is now used by some payers to return MBI. If you receive a value in this property that matches the format specified in the Medicare Beneficiary Identifier documentation, the number is likely an MBI and we recommend sending a follow-up eligibility check to CMS for additional benefits data. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

insurancePolicyNumber
items[].benefitsInformation[].benefitsAdditionalInformation.insurancePolicyNumber
String

The insurance policy number.

medicaidRecepientIdNumber
items[].benefitsInformation[].benefitsAdditionalInformation.medicaidRecepientIdNumber
String

The Medicaid Recipient Identification number.

medicalAssistanceCategory
items[].benefitsInformation[].benefitsAdditionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
items[].benefitsInformation[].benefitsAdditionalInformation.memberId
String

The patient's member ID.

planDescription
items[].benefitsInformation[].benefitsAdditionalInformation.planDescription
String

Plan name

planNetworkDescription
items[].benefitsInformation[].benefitsAdditionalInformation.planNetworkDescription
String

Plan network name

planNetworkIdNumber
items[].benefitsInformation[].benefitsAdditionalInformation.planNetworkIdNumber
String

The plan network identification number.

planNumber
items[].benefitsInformation[].benefitsAdditionalInformation.planNumber
String

The insurance plan number.

policyNumber
items[].benefitsInformation[].benefitsAdditionalInformation.policyNumber
String

The patient's policy number.

priorAuthorizationNumber
items[].benefitsInformation[].benefitsAdditionalInformation.priorAuthorizationNumber
String

The prior authorization number.

referralNumber
items[].benefitsInformation[].benefitsAdditionalInformation.referralNumber
String

The referral number.

benefitsDateInformation
items[].benefitsInformation[].benefitsDateInformation
Object

Dates associated with the benefits.

  • This is where you can find benefit-specific eligibility dates, if provided. These dates override dates provided in planDateInformation for this benefit type.
  • This is where the payer may specify the last time the service was rendered (latestVisitOrConsultation), which you can use to determine whether the patient has already reached the allowed frequency, if applicable. For example, this object could contain the date when the patient received their last dental cleaning.
  • These dates only apply to the benefitsInformation object in which this benefitsDateInformation is provided.
Show attributes
added
items[].benefitsInformation[].benefitsDateInformation.added
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

Added date. Payers may return this information in the case of retroactive eligibility.

admission
items[].benefitsInformation[].benefitsDateInformation.admission
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The admission date or dates.

admissions
items[].benefitsInformation[].benefitsDateInformation.admissions
Array of Objects

The date(s) for admission.

Array item
date
items[].benefitsInformation[].benefitsDateInformation.admissions[].date
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

A single date.

endDate
items[].benefitsInformation[].benefitsDateInformation.admissions[].endDate
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The end date of a range.

startDate
items[].benefitsInformation[].benefitsDateInformation.admissions[].startDate
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The beginning date of a range.

benefit
items[].benefitsInformation[].benefitsDateInformation.benefit
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The benefit date.

benefitBegin
items[].benefitsInformation[].benefitsDateInformation.benefitBegin
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The date when the benefit begins.

benefitEnd
items[].benefitsInformation[].benefitsDateInformation.benefitEnd
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The date when the benefit ends.

certification
items[].benefitsInformation[].benefitsDateInformation.certification
StringDeprecatedRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The certification date.

cobraBegin
items[].benefitsInformation[].benefitsDateInformation.cobraBegin
StringDeprecatedRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The date when COBRA coverage begins.

cobraEnd
items[].benefitsInformation[].benefitsDateInformation.cobraEnd
StringDeprecatedRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The date when COBRA coverage ends.

completion
items[].benefitsInformation[].benefitsDateInformation.completion
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The completion date.

coordinationOfBenefits
items[].benefitsInformation[].benefitsDateInformation.coordinationOfBenefits
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The coordination of benefits date.

dateOfDeath
items[].benefitsInformation[].benefitsDateInformation.dateOfDeath
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The date of death.

dateOfLastUpdate
items[].benefitsInformation[].benefitsDateInformation.dateOfLastUpdate
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The date when the plan information was last updated.

discharge
items[].benefitsInformation[].benefitsDateInformation.discharge
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The discharge date.

discharges
items[].benefitsInformation[].benefitsDateInformation.discharges
Array of Objects

The date(s) when the patient was discharged.

Array item
date
items[].benefitsInformation[].benefitsDateInformation.discharges[].date
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

A single date.

endDate
items[].benefitsInformation[].benefitsDateInformation.discharges[].endDate
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The end date of a range.

startDate
items[].benefitsInformation[].benefitsDateInformation.discharges[].startDate
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The beginning date of a range.

effectiveDateOfChange
items[].benefitsInformation[].benefitsDateInformation.effectiveDateOfChange
StringDeprecatedRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The effective date of change.

eligibility
items[].benefitsInformation[].benefitsDateInformation.eligibility
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

Plan eligibility dates.

eligibilityBegin
items[].benefitsInformation[].benefitsDateInformation.eligibilityBegin
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The date when the patient is first eligible for benefits under the plan.

eligibilityEnd
items[].benefitsInformation[].benefitsDateInformation.eligibilityEnd
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The date when the patient is no longer eligible for benefits under the plan.

enrollment
items[].benefitsInformation[].benefitsDateInformation.enrollment
StringDeprecatedRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The date when the patient is enrolled in the plan.

issue
items[].benefitsInformation[].benefitsDateInformation.issue
StringDeprecatedRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The issue date.

latestVisitOrConsultation
items[].benefitsInformation[].benefitsDateInformation.latestVisitOrConsultation
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The latest visit or consultation date. This date may be used to determine whether the patient has already reached the allowed frequency for a specific benefit.

periodEnd
items[].benefitsInformation[].benefitsDateInformation.periodEnd
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The end of a period.

periodStart
items[].benefitsInformation[].benefitsDateInformation.periodStart
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The start of a period.

plan
items[].benefitsInformation[].benefitsDateInformation.plan
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

Only included when multiple plans apply to the patient or multiple plan periods apply.

planBegin
items[].benefitsInformation[].benefitsDateInformation.planBegin
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

Only included when multiple plans apply to the patient or multiple plan periods apply.

planEnd
items[].benefitsInformation[].benefitsDateInformation.planEnd
StringDeprecatedRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The date coverage from the plan ends.

policyEffective
items[].benefitsInformation[].benefitsDateInformation.policyEffective
StringDeprecatedRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The date when the policy becomes effective.

policyExpiration
items[].benefitsInformation[].benefitsDateInformation.policyExpiration
StringDeprecatedRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The date when the policy expires.

premiumPaidToDateEnd
items[].benefitsInformation[].benefitsDateInformation.premiumPaidToDateEnd
StringDeprecatedRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The end of period when the plan premium payments are up-to-date.

premiumPaidtoDateBegin
items[].benefitsInformation[].benefitsDateInformation.premiumPaidtoDateBegin
StringDeprecatedRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The start of the period when the plan premium was paid in full.

primaryCareProvider
items[].benefitsInformation[].benefitsDateInformation.primaryCareProvider
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The primary care provider date.

service
items[].benefitsInformation[].benefitsDateInformation.service
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The service date or dates.

status
items[].benefitsInformation[].benefitsDateInformation.status
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The status date.

benefitsRelatedEntities
items[].benefitsInformation[].benefitsRelatedEntities
Array of Objects

Other entities associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer. When present, this array typically contains information about the patient's primary care provider (PCP), another organization that handles a specific benefit type (such as telehealth mental health services), or another health plan for the patient (coordination of benefits scenarios).

  • This is where information for a crossover carrier such as Medicaid or Medicare is provided, if it's applicable to the patient and the payer supports it.
  • For Blue Cross Blue Shield (BCBS) payers, Stedi returns an entry containing information about the patient's home plan - the plan that actually verified the coverage. In this object, the entityIdentifier property is set to Party Performing Verification. Learn more
Array item
address
items[].benefitsInformation[].benefitsRelatedEntities[].address
Object

The address of the entity, such as a provider or organization.

Show attributes
address1
items[].benefitsInformation[].benefitsRelatedEntities[].address.address1
StringLength: 1 - 55

The first line of the address.

address2
items[].benefitsInformation[].benefitsRelatedEntities[].address.address2
StringLength: 1 - 55

The second line of the address.

city
items[].benefitsInformation[].benefitsRelatedEntities[].address.city
StringLength: 2 - 30

The city.

countryCode
items[].benefitsInformation[].benefitsRelatedEntities[].address.countryCode
StringLength: 2

The two-letter country code from Part 1 of ISO 3166.

countrySubDivisionCode
items[].benefitsInformation[].benefitsRelatedEntities[].address.countrySubDivisionCode
StringLength: 1 - 3

The country subdivision code from Part 2 of ISO 3166.

postalCode
items[].benefitsInformation[].benefitsRelatedEntities[].address.postalCode
StringLength: 5 - 9

The United States or Canadian postal code, excluding punctuation and blanks.

state
items[].benefitsInformation[].benefitsRelatedEntities[].address.state
String

The US state or Canadian province code with unknown option. For example, TN for Tennessee or NB for New Brunswick.

Payers may sometimes return other non-compliant values.

Possible values
NL
PE
NS
NB
QC
contactInformation
items[].benefitsInformation[].benefitsRelatedEntities[].contactInformation
Object

The contact information for the entity, such as a phone number or email address.

Show attributes
contacts
items[].benefitsInformation[].benefitsRelatedEntities[].contactInformation.contacts
Array of Objects

The contact information.

Array item
communicationMode
items[].benefitsInformation[].benefitsRelatedEntities[].contactInformation.contacts[].communicationMode
String

The type of communication number provided.

Payers may sometimes return other non-compliant values.

Possible values
Electronic Data Interchange Access Number
Electronic Mail
Facsimile
Telephone
Uniform Resource Locator (URL)
communicationNumber
items[].benefitsInformation[].benefitsRelatedEntities[].contactInformation.contacts[].communicationNumber
String

The communication number referenced in communicationMode. It includes the country or area code when applicable.

Note that phone numbers are formatted as AAABBBCCCC, where AAA represents the area code, BBB represents the telephone number prefix, and CCCC represents the telephone number. Phone numbers are provided without separators, such as dashes or parentheses. For example, 5551123345 for 555-112-3345.

name
items[].benefitsInformation[].benefitsRelatedEntities[].contactInformation.name
String

The name of the contact person.

entityFirstname
items[].benefitsInformation[].benefitsRelatedEntities[].entityFirstname
String

The first name of the entity, if the entity is a person.

entityIdentification
items[].benefitsInformation[].benefitsRelatedEntities[].entityIdentification
String

Code identifying the type of identifier in the entityIdentificationValue property. Visit Eligibility code lists for a complete list.

Payers may sometimes return other non-compliant values.

Possible values
24
34
46
FA
FI
entityIdentificationValue
items[].benefitsInformation[].benefitsRelatedEntities[].entityIdentificationValue
String

The identification number for the entity, qualified by the code in entityIdentification.

entityIdentifier
items[].benefitsInformation[].benefitsRelatedEntities[].entityIdentifier
String

Code identifying an organizational entity, a physical location, property, or individual. When set to Party Performing Verification for a BCBS payer, this is the patient's home plan.

Payers may sometimes return other non-compliant values.

Possible values
Contracted Service Provider
Preferred Provider Organization (PPO)
Provider
Third-Party Administrator
Employer
entityMiddlename
items[].benefitsInformation[].benefitsRelatedEntities[].entityMiddlename
String

The middle name or initial of the entity, if the entity is a person.

entityName
items[].benefitsInformation[].benefitsRelatedEntities[].entityName
String

The last name (if the entity is a person) or the business name (if the entity is an organization).

entityRelationship
items[].benefitsInformation[].benefitsRelatedEntities[].entityRelationship
String

Code specifying the relationship between the entity and the patient. Can be 01 - Parent, 02 - Child, 27 - Domestic Partner, 41 - Spouse, 48 - Employee, 65 - Other, or 72 - Unknown.

Payers may sometimes return other non-compliant values.

Possible values
01
02
27
41
48
entitySuffix
items[].benefitsInformation[].benefitsRelatedEntities[].entitySuffix
String

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

entityType
items[].benefitsInformation[].benefitsRelatedEntities[].entityType
String

The type of entity.

Payers may sometimes return other non-compliant values.

Possible values
Person
Non-Person Entity
providerInformation
items[].benefitsInformation[].benefitsRelatedEntities[].providerInformation
Object
Show attributes
providerCode
items[].benefitsInformation[].benefitsRelatedEntities[].providerInformation.providerCode
String

A code that communicates the provider's role in the type of benefits information in the response. Visit Eligibility code lists for a complete list.

Payers may sometimes return other non-compliant values.

Possible values
AD
AT
BI
CO
CV
referenceIdentification
items[].benefitsInformation[].benefitsRelatedEntities[].providerInformation.referenceIdentification
String

The provider's taxonomy code.

benefitsRelatedEntity
items[].benefitsInformation[].benefitsRelatedEntity
ObjectDeprecated

Please use benefitsInformation.benefitsRelatedEntities instead.

Show attributes
address
items[].benefitsInformation[].benefitsRelatedEntity.address
Object

The address of the entity, such as a provider or organization.

Show attributes
address1
items[].benefitsInformation[].benefitsRelatedEntity.address.address1
StringLength: 1 - 55

The first line of the address.

address2
items[].benefitsInformation[].benefitsRelatedEntity.address.address2
StringLength: 1 - 55

The second line of the address.

city
items[].benefitsInformation[].benefitsRelatedEntity.address.city
StringLength: 2 - 30

The city.

countryCode
items[].benefitsInformation[].benefitsRelatedEntity.address.countryCode
StringLength: 2

The two-letter country code from Part 1 of ISO 3166.

countrySubDivisionCode
items[].benefitsInformation[].benefitsRelatedEntity.address.countrySubDivisionCode
StringLength: 1 - 3

The country subdivision code from Part 2 of ISO 3166.

postalCode
items[].benefitsInformation[].benefitsRelatedEntity.address.postalCode
StringLength: 5 - 9

The United States or Canadian postal code, excluding punctuation and blanks.

state
items[].benefitsInformation[].benefitsRelatedEntity.address.state
String

The US state or Canadian province code with unknown option. For example, TN for Tennessee or NB for New Brunswick.

Payers may sometimes return other non-compliant values.

Possible values
NL
PE
NS
NB
QC
contactInformation
items[].benefitsInformation[].benefitsRelatedEntity.contactInformation
Object

The contact information for the entity, such as a phone number or email address.

Show attributes
contacts
items[].benefitsInformation[].benefitsRelatedEntity.contactInformation.contacts
Array of Objects

The contact information.

Array item
communicationMode
items[].benefitsInformation[].benefitsRelatedEntity.contactInformation.contacts[].communicationMode
String

The type of communication number provided.

Payers may sometimes return other non-compliant values.

Possible values
Electronic Data Interchange Access Number
Electronic Mail
Facsimile
Telephone
Uniform Resource Locator (URL)
communicationNumber
items[].benefitsInformation[].benefitsRelatedEntity.contactInformation.contacts[].communicationNumber
String

The communication number referenced in communicationMode. It includes the country or area code when applicable.

Note that phone numbers are formatted as AAABBBCCCC, where AAA represents the area code, BBB represents the telephone number prefix, and CCCC represents the telephone number. Phone numbers are provided without separators, such as dashes or parentheses. For example, 5551123345 for 555-112-3345.

name
items[].benefitsInformation[].benefitsRelatedEntity.contactInformation.name
String

The name of the contact person.

entityFirstname
items[].benefitsInformation[].benefitsRelatedEntity.entityFirstname
String

The first name of the entity, if the entity is a person.

entityIdentification
items[].benefitsInformation[].benefitsRelatedEntity.entityIdentification
String

Code identifying the type of identifier in the entityIdentificationValue property. Visit Eligibility code lists for a complete list.

Payers may sometimes return other non-compliant values.

Possible values
24
34
46
FA
FI
entityIdentificationValue
items[].benefitsInformation[].benefitsRelatedEntity.entityIdentificationValue
String

The identification number for the entity, qualified by the code in entityIdentification.

entityIdentifier
items[].benefitsInformation[].benefitsRelatedEntity.entityIdentifier
String

Code identifying an organizational entity, a physical location, property, or individual. When set to Party Performing Verification for a BCBS payer, this is the patient's home plan.

Payers may sometimes return other non-compliant values.

Possible values
Contracted Service Provider
Preferred Provider Organization (PPO)
Provider
Third-Party Administrator
Employer
entityMiddlename
items[].benefitsInformation[].benefitsRelatedEntity.entityMiddlename
String

The middle name or initial of the entity, if the entity is a person.

entityName
items[].benefitsInformation[].benefitsRelatedEntity.entityName
String

The last name (if the entity is a person) or the business name (if the entity is an organization).

entityRelationship
items[].benefitsInformation[].benefitsRelatedEntity.entityRelationship
String

Code specifying the relationship between the entity and the patient. Can be 01 - Parent, 02 - Child, 27 - Domestic Partner, 41 - Spouse, 48 - Employee, 65 - Other, or 72 - Unknown.

Payers may sometimes return other non-compliant values.

Possible values
01
02
27
41
48
entitySuffix
items[].benefitsInformation[].benefitsRelatedEntity.entitySuffix
String

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

entityType
items[].benefitsInformation[].benefitsRelatedEntity.entityType
String

The type of entity.

Payers may sometimes return other non-compliant values.

Possible values
Person
Non-Person Entity
providerInformation
items[].benefitsInformation[].benefitsRelatedEntity.providerInformation
Object
Show attributes
providerCode
items[].benefitsInformation[].benefitsRelatedEntity.providerInformation.providerCode
String

A code that communicates the provider's role in the type of benefits information in the response. Visit Eligibility code lists for a complete list.

Payers may sometimes return other non-compliant values.

Possible values
AD
AT
BI
CO
CV
referenceIdentification
items[].benefitsInformation[].benefitsRelatedEntity.providerInformation.referenceIdentification
String

The provider's taxonomy code.

benefitsServiceDelivery
items[].benefitsInformation[].benefitsServiceDelivery
Array of Objects

The delivery or usage pattern for the benefits.

Array item
deliveryOrCalendarPatternCode
items[].benefitsInformation[].benefitsServiceDelivery[].deliveryOrCalendarPatternCode
String

The name of the deliveryOrCalendarPatternCode. For example, Last Working Day of Period.

Payers may sometimes return other non-compliant values.

Possible values
1st Week of the Month
2nd Week of the Month
3rd Week of the Month
4th Week of the Month
5th Week of the Month
deliveryOrCalendarPatternQualifier
items[].benefitsInformation[].benefitsServiceDelivery[].deliveryOrCalendarPatternQualifier
String

The name of the deliveryOrCalendarPatternCode. For example, Last Working Day of Period.

Payers may sometimes return other non-compliant values.

Possible values
1st Week of the Month
2nd Week of the Month
3rd Week of the Month
4th Week of the Month
5th Week of the Month
deliveryOrCalendarPatternQualifierCode
items[].benefitsInformation[].benefitsServiceDelivery[].deliveryOrCalendarPatternQualifierCode
String

Code that specifies the routine shipments, deliveries, or calendar pattern. For example 9 - Last Working Day of Period. Visit Eligibility code lists for a complete list.

Payers may sometimes return other non-compliant values.

Possible values
1
2
3
4
5
deliveryPatternTimeCode
items[].benefitsInformation[].benefitsServiceDelivery[].deliveryPatternTimeCode
String

The name of the deliveryPatternTimeCode.

Payers may sometimes return other non-compliant values.

Possible values
1st Shift (Normal Working Hours)
2nd Shift
3rd Shift
A.M.
P.M.
deliveryPatternTimeQualifier
items[].benefitsInformation[].benefitsServiceDelivery[].deliveryPatternTimeQualifier
String

The name of the deliveryPatternTimeCode.

Payers may sometimes return other non-compliant values.

Possible values
1st Shift (Normal Working Hours)
2nd Shift
3rd Shift
A.M.
P.M.
deliveryPatternTimeQualifierCode
items[].benefitsInformation[].benefitsServiceDelivery[].deliveryPatternTimeQualifierCode
String

Code specifying the time for routine shipments or deliveries. Visit Eligibility code lists for a complete list.

Payers may sometimes return other non-compliant values.

Possible values
A
B
C
D
E
numOfPeriods
items[].benefitsInformation[].benefitsServiceDelivery[].numOfPeriods
String

The number of periods in the time period. For example, 12 when the timePeriodQualifier is Hour.

quantity
items[].benefitsInformation[].benefitsServiceDelivery[].quantity
String

The quantity of the benefit. For example, 10 when the quantityQualifier is Visits.

quantityQualifier
items[].benefitsInformation[].benefitsServiceDelivery[].quantityQualifier
String

The name of the quantityQualifierCode. For example, Days.

Payers may sometimes return other non-compliant values.

Possible values
Days
Units
Hours
Month
Visits
quantityQualifierCode
items[].benefitsInformation[].benefitsServiceDelivery[].quantityQualifierCode
String

Code specifying the type of quantity for the benefit. Can be DY - Days, FL - Units, HS - Hours, MN - Month, and VS - Visits.

Payers may sometimes return other non-compliant values.

Possible values
DY
FL
HS
MN
VS
sampleSelectionModulus
items[].benefitsInformation[].benefitsServiceDelivery[].sampleSelectionModulus
String

Specifies the sampling frequency, based on the unit of measure. For example every 2 months or once per calendar year.

timePeriodQualifier
items[].benefitsInformation[].benefitsServiceDelivery[].timePeriodQualifier
String

The name of the timePeriodQualifierCode. For example, Calendar Year.

Payers may sometimes return other non-compliant values.

Possible values
Hour
Day
Years
Service Year
Calendar Year
timePeriodQualifierCode
items[].benefitsInformation[].benefitsServiceDelivery[].timePeriodQualifierCode
String

Code specifying the time period for the benefit information. Visit Eligibility code lists for a complete list.

Payers may sometimes return other non-compliant values.

Possible values
6
7
21
22
23
unitForMeasurementCode
items[].benefitsInformation[].benefitsServiceDelivery[].unitForMeasurementCode
StringDeprecated

The name of the unitForMeasurementQualifierCode. For example, Days.

Payers may sometimes return other non-compliant values.

Possible values
Days
Months
Visits
Week
Years
unitForMeasurementQualifier
items[].benefitsInformation[].benefitsServiceDelivery[].unitForMeasurementQualifier
String

The name of the unitForMeasurementQualifierCode. For example, Days.

Payers may sometimes return other non-compliant values.

Possible values
Days
Months
Visits
Week
Years
unitForMeasurementQualifierCode
items[].benefitsInformation[].benefitsServiceDelivery[].unitForMeasurementQualifierCode
String

Code specifying the unit of measurement. For example, DA - Days, MO - Months, VS - Visits, WK - Week, and YR - Years.

Payers may sometimes return other non-compliant values.

Possible values
DA
MO
VS
WK
YR
code
items[].benefitsInformation[].code
String

The code indicating the type of benefits information. Visit Eligibility and benefit codes for more information.

Payers may sometimes return other non-compliant values.

Possible values
1
2
3
4
5
compositeMedicalProcedureIdentifier
items[].benefitsInformation[].compositeMedicalProcedureIdentifier
Object

Identifies relevant medical procedures by their standard codes and modifiers (if applicable).

Show attributes
diagnosisCodePointer
items[].benefitsInformation[].compositeMedicalProcedureIdentifier.diagnosisCodePointer
Array of Strings

The diagnosis code pointer.

procedureCode
items[].benefitsInformation[].compositeMedicalProcedureIdentifier.procedureCode
String

The procedure code. Many payers do not support eligibility checks for specific procedure codes. If the payer does not support procedure codes, they return a generic benefits response for the service type code 30.

procedureModifiers
items[].benefitsInformation[].compositeMedicalProcedureIdentifier.procedureModifiers
Array of Strings

Procedure modifiers that provides additional information related to the performance of the service.

productOrServiceID
items[].benefitsInformation[].compositeMedicalProcedureIdentifier.productOrServiceID
String

The product or service ID. This value represents the end of the range of applicable procedure codes. The beginning of the range is listed in procedureCode.

productOrServiceIdQualifier
items[].benefitsInformation[].compositeMedicalProcedureIdentifier.productOrServiceIdQualifier
String

The name of the productOrServiceIdQualifierCode. For example, American Dental Association.

productOrServiceIdQualifierCode
items[].benefitsInformation[].compositeMedicalProcedureIdentifier.productOrServiceIdQualifierCode
String

Identifies the external code list used to provide the specified procedure or service codes. Can be AD - American Dental Association, CJ - Current Procedural Terminology (CPT) codes, HC - Health Care Financing Administration Common Procedural Coding System (HCPCS) Codes, ID - International Classification of Diseases 9th Revision, Clinical Modification (ICD-9-CM) - Procedure, IV - Home Infusion EDI Coalition (HIEC) Product/Service Code, N4 - National Drug Code in 5-4-2 Format, or ZZ - Mutually Defined

coverageLevel
items[].benefitsInformation[].coverageLevel
String

The full name of the coverage level code.

Payers may sometimes return other non-compliant values.

Possible values
Children Only
Dependents Only
Employee and Children
Employee Only
Employee and Spouse
coverageLevelCode
items[].benefitsInformation[].coverageLevelCode
String

Code indicating the level of coverage for the patient.

This will either be CHD - Children Only, DEP - Dependents Only, ECH - Employee and Children, EMP - Employee Only, ESP - Employee and Spouse, FAM - Family, IND - Individual, SPC - Spouse and Children, SPO - Spouse Only, or Unknown.

Payers may sometimes return other non-compliant values.

Possible values
CHD
DEP
ECH
EMP
ESP
eligibilityAdditionalInformation
items[].benefitsInformation[].eligibilityAdditionalInformation
ObjectDeprecated

Please use benefitsInformation.eligibilityAdditionalInformationList instead.

Show attributes
codeCategory
items[].benefitsInformation[].eligibilityAdditionalInformation.codeCategory
String

The code category. Always set to 44 - Nature of Injury.

Payers may sometimes return other non-compliant values.

Possible values
44
codeListQualifier
items[].benefitsInformation[].eligibilityAdditionalInformation.codeListQualifier
String

The name of the codeListQualifierCode. For example Mutually Defined when the code is set to ZZ.

codeListQualifierCode
items[].benefitsInformation[].eligibilityAdditionalInformation.codeListQualifierCode
String

Identifies a specific industry code list. Can be GR - National Council on Compensation Insurance (NCCI) Nature of Injury Code, NI - Nature of Injury Code, or ZZ - Mutually Defined.

When this is set to ZZ, the industryCode property will be set to a place of service code.

Payers may sometimes return other non-compliant values.

Possible values
GR
NI
ZZ
industry
items[].benefitsInformation[].eligibilityAdditionalInformation.industry
String

The name of the industryCode. For example Pharmacy when the code is 01.

industryCode
items[].benefitsInformation[].eligibilityAdditionalInformation.industryCode
String

The specific industry code. When codeListQualifierCode is set to ZZ - Mutually Defined, this property will be set to a place of service code. Visit the Place of Service Code Set for a complete list of these codes and their descriptions.

injuredBodyPartName
items[].benefitsInformation[].eligibilityAdditionalInformation.injuredBodyPartName
String

Description of injured body parts.

eligibilityAdditionalInformationList
items[].benefitsInformation[].eligibilityAdditionalInformationList
Array of Objects

Used when there are multiple Nature of Injury Codes or a Facility Type Codes included in the response.

Array item
codeCategory
items[].benefitsInformation[].eligibilityAdditionalInformationList[].codeCategory
String

The code category. Always set to 44 - Nature of Injury.

Payers may sometimes return other non-compliant values.

Possible values
44
codeListQualifier
items[].benefitsInformation[].eligibilityAdditionalInformationList[].codeListQualifier
String

The name of the codeListQualifierCode. For example Mutually Defined when the code is set to ZZ.

codeListQualifierCode
items[].benefitsInformation[].eligibilityAdditionalInformationList[].codeListQualifierCode
String

Identifies a specific industry code list. Can be GR - National Council on Compensation Insurance (NCCI) Nature of Injury Code, NI - Nature of Injury Code, or ZZ - Mutually Defined.

When this is set to ZZ, the industryCode property will be set to a place of service code.

Payers may sometimes return other non-compliant values.

Possible values
GR
NI
ZZ
industry
items[].benefitsInformation[].eligibilityAdditionalInformationList[].industry
String

The name of the industryCode. For example Pharmacy when the code is 01.

industryCode
items[].benefitsInformation[].eligibilityAdditionalInformationList[].industryCode
String

The specific industry code. When codeListQualifierCode is set to ZZ - Mutually Defined, this property will be set to a place of service code. Visit the Place of Service Code Set for a complete list of these codes and their descriptions.

injuredBodyPartName
items[].benefitsInformation[].eligibilityAdditionalInformationList[].injuredBodyPartName
String

Description of injured body parts.

headerLoopIdentifierCode
items[].benefitsInformation[].headerLoopIdentifierCode
String

The loop header identifier number in the LS segment of the original X12 EDI transaction.

inPlanNetworkIndicator
items[].benefitsInformation[].inPlanNetworkIndicator
String

The name of the in-plan network indicator code.

Payers may sometimes return other non-compliant values.

Possible values
Yes
No
Unknown
Not Applicable
inPlanNetworkIndicatorCode
items[].benefitsInformation[].inPlanNetworkIndicatorCode
String

Code indicating whether the benefit is in-network or out-of-network. Can be Y - Yes, N - No, U - Unknown, or W - Not Applicable

Code U indicates that it is unknown whether the benefits are in or out-of-network. Code W indicates that the benefit applies to both in and out-of-network providers.

Note that this property doesn't indicate whether the provider is in or out-of-network for the patient. To determine that, you must check with the payer directly.

Payers may sometimes return other non-compliant values.

Possible values
Y
N
U
W
insuranceType
items[].benefitsInformation[].insuranceType
String

The full name of the insurance type code.

Payers may sometimes return other non-compliant values.

Possible values
Medicare Secondary Working Aged Beneficiary or Spouse with Employer Group Health Plan
Medicare Secondary End-Stage Renal Disease Beneficiary in the Mandated Coordination Period with an Employer's Group Health Plan
Medicare Secondary, No-fault Insurance including Auto is Primary
Medicare Secondary Worker's Compensation
Medicare Secondary Public Health Service (PHS)or Other Federal Agency
insuranceTypeCode
items[].benefitsInformation[].insuranceTypeCode
String

Code identifying the type of insurance policy. Visit Eligibility code lists for a complete list.

Payers may sometimes return other non-compliant values.

Possible values
12
13
14
15
16
name
items[].benefitsInformation[].name
String

The full name of the benefits information code.

Payers may sometimes return other non-compliant values.

Possible values
Active Coverage
Active - Full Risk Capitation
Active - Services Capitated
Active - Services Capitated to Primary Care Physician
Active - Pending Investigation
planCoverage
items[].benefitsInformation[].planCoverage
String

The specific product name or special program name for an insurance plan. For example Gold 1-2-3.

Payers are normally required to send the plan name when benefitsInformation.code is set to values 1 - 8 and the benefitsInformation.serviceTypeCodes contains 30 (Health Benefit Plan Coverage). However, behavior may vary by payer, so don't rely on this information being present in the response. Note that the plan name returned in this property may not exactly match the name the payer uses in official plan documents or marketing literature.

Visit What's the plan name? in the benefits response documentation for more details.

quantityQualifier
items[].benefitsInformation[].quantityQualifier
String

The name of the quantityQualifierCode.

Payers may sometimes return other non-compliant values.

Possible values
Minimum
Quantity Used
Covered - Actual
Covered - Estimated
Number of Co-insurance Days
quantityQualifierCode
items[].benefitsInformation[].quantityQualifierCode
String

Code indicating the type of quantity for the benefit. Visit Eligibility code lists for a complete list.

Payers may sometimes return other non-compliant values.

Possible values
8H
99
CA
CE
D3
serviceTypeCodes
items[].benefitsInformation[].serviceTypeCodes
Array of Strings

Service Type Codes (STCs) related to the benefit type. For example, 7 - Anesthesia. Visit Service Type Codes for a complete list.

This list is specific to X12 version 005010, which is the mandated version for eligibility checks. It differs from the current X12 Service Type Codes list, which applies to X12 versions later than 005010.

Payers may sometimes return other non-compliant values.

Possible values
1
2
3
4
5
serviceTypes
items[].benefitsInformation[].serviceTypes
Array of Strings

The names of the Service Type Codes listed in the serviceTypeCodes array. Visit Service Type Codes for a complete list of codes and their names.

The word physician in service type codes refers to any healthcare provider, including physician assistants, nurse practitioners, and other types of healthcare professionals.

Payers may sometimes return other non-compliant values.

Possible values
Medical Care
Surgical
Consultation
Diagnostic X-Ray
Diagnostic Lab
timeQualifier
items[].benefitsInformation[].timeQualifier
String

The name of the timeQualifierCode.

Payers may sometimes return other non-compliant values.

Possible values
Hour
Day
24 Hours
Years
Service Year
timeQualifierCode
items[].benefitsInformation[].timeQualifierCode
String

Code indicating the time period for the benefit information. Visit Eligibility code lists for a complete list.

Payers may sometimes return other non-compliant values.

Possible values
6
7
13
21
22
trailerLoopIdentifierCode
items[].benefitsInformation[].trailerLoopIdentifierCode
String

The loop trailer identifier number in the LE segment of the original X12 EDI transaction.

controlNumber
items[].controlNumber
StringDeprecated

An identifier for the payer's response.

dependents
items[].dependents
Array of Objects

Information about the patient when they are a dependent. When the patient is a dependent, this array will contain a single object with the patient's information. When the patient is a subscriber, or considered to be a subscriber because they have a unique member ID, their information is returned in the subscriber object, and this array will be empty.

When present, this object will always include the dependent's name for identification, but many payers will also return the date of birth and other identifying information.

Array item
aaaErrors
items[].dependents[].aaaErrors
Array of Objects

When a payer rejects your eligibility check, the response contains one or more AAA errors that specify the reasons for the rejection and any recommended follow-up actions. Common reasons for rejection at the subscriber or dependent level include missing or incorrect identifying information and that the payer was unable to locate the patient in their system. Learn more

Array item
code
items[].dependents[].aaaErrors[].code
String

The error code.

Payers may sometimes return other non-compliant values.

Possible values
15
33
35
42
43
description
items[].dependents[].aaaErrors[].description
String

The error description.

field
items[].dependents[].aaaErrors[].field
String

The error type, AAA.

followupAction
items[].dependents[].aaaErrors[].followupAction
String

Allowed actions you can take, based on the rejection reason code. For example Please Correct and Resubmit.

Payers may sometimes return other non-compliant values.

Possible values
Please Correct and Resubmit
Resubmission Not Allowed
Resubmission Allowed
Do Not Resubmit; Inquiry Initiated to a Third Party
Please Wait 30 Days and Resubmit
location
items[].dependents[].aaaErrors[].location
String

The location of the error within the original X12 EDI response.

possibleResolutions
items[].dependents[].aaaErrors[].possibleResolutions
String

Information to help you correct the error.

We periodically update this guidance, so these strings may change at any time and may differ between eligibility responses. Don't build programmatic logic that depends on matching these strings exactly.

address
items[].dependents[].address
Object
Show attributes
address1
items[].dependents[].address.address1
StringLength: 1 - 55

The first line of the address.

address2
items[].dependents[].address.address2
StringLength: 1 - 55

The second line of the address.

city
items[].dependents[].address.city
StringLength: 2 - 30

The city.

countryCode
items[].dependents[].address.countryCode
StringLength: 2

The two-letter country code from Part 1 of ISO 3166.

countrySubDivisionCode
items[].dependents[].address.countrySubDivisionCode
StringLength: 1 - 3

The country subdivision code from Part 2 of ISO 3166.

postalCode
items[].dependents[].address.postalCode
StringLength: 5 - 9

The United States or Canadian postal code, excluding punctuation and blanks.

state
items[].dependents[].address.state
String

The US state or Canadian province code with unknown option. For example, TN for Tennessee or NB for New Brunswick.

Payers may sometimes return other non-compliant values.

Possible values
NL
PE
NS
NB
QC
birthSequenceNumber
items[].dependents[].birthSequenceNumber
String

The number assigned to each family member born with the same birth date, such as twins or triplets. Indicates the birth order when there are multiple births associated with the provided birth date.

dateOfBirth
items[].dependents[].dateOfBirth
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The member's date of birth.

dateTimePeriod
items[].dependents[].dateTimePeriod
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The military service date.

dateTimePeriodFormatQualifier
items[].dependents[].dateTimePeriodFormatQualifier
String

The format of the military service date and time period. Can be D8 - Date or RD8 - Range of Dates.

Payers may sometimes return other non-compliant values.

Possible values
D8
RD8
description
items[].dependents[].description
String

Context that identifies the exact military unit. Used to report military service data.

employmentStatusCode
items[].dependents[].employmentStatusCode
String

The member's employment status code, used to report military service data. Visit Eligibility code lists for a complete list.

Payers may sometimes return other non-compliant values.

Possible values
AE
AO
AS
AT
AU
endDateTimePeriod
items[].dependents[].endDateTimePeriod
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The military service end date.

entityIdentifier
items[].dependents[].entityIdentifier
String

The entity identifier for the dependent.

Possible values
Dependent
entityType
items[].dependents[].entityType
String

The entity type for the member. It can technically be set to Person or Non-Person Entity. In practice, our customers only receive Person.

Payers may sometimes return other non-compliant values.

Possible values
Person
Non-Person Entity
firstName
items[].dependents[].firstName
String

The member's first name.

gender
items[].dependents[].gender
String

Code indicating the patient's gender.

Possible values
M
F
U
governmentServiceAffiliationCode
items[].dependents[].governmentServiceAffiliationCode
String

The member's government service affiliation code, used to report military service data. Visit Eligibility code lists for a complete list.

Payers may sometimes return other non-compliant values.

Possible values
A
B
C
D
E
groupDescription
items[].dependents[].groupDescription
String

Group name

groupNumber
items[].dependents[].groupNumber
String

The group number associated with the insurance policy.

healthCareDiagnosisCodes
items[].dependents[].healthCareDiagnosisCodes
Array of Objects

Information about the patient's healthcare diagnosis.

Array item
diagnosisCode
items[].dependents[].healthCareDiagnosisCodes[].diagnosisCode
String

The diagnosis code. The decimal points are omitted in diagnosis codes - the decimal point is assumed.

diagnosisTypeCode
items[].dependents[].healthCareDiagnosisCodes[].diagnosisTypeCode
String

The type of diagnosis code provided. It can be ABK - International Classification of Diseases Clinical Modification (ICD-10-CM) Principal Diagnosis or BK - International Classification of Diseases Clinical Modification (ICD-9-CM) Principal Diagnosis.

informationStatusCode
items[].dependents[].informationStatusCode
String

The status of the member's information, used to report military service data. Visit Eligibility code lists for a complete list.

Payers may sometimes return other non-compliant values.

Possible values
A
C
L
O
P
insuredIndicator
items[].dependents[].insuredIndicator
String

Indicates the status of the insured. For the dependent, this is always N.

Possible values
N
lastName
items[].dependents[].lastName
String

The member's last name.

maintenanceReasonCode
items[].dependents[].maintenanceReasonCode
String

Code identifying the reason for the changes to subscriber identifying information, such as name, date of birth, or address. This is always 25

Payers may sometimes return other non-compliant values.

Possible values
25
maintenanceTypeCode
items[].dependents[].maintenanceTypeCode
String

The maintenance type code. Used to acknowledge a change in the identifying elements for the subscriber from those submitted in the original eligibility check request. It can also be included when the payer used the birth sequence number from the original request to locate the subscriber in their system. This is always 001

Payers may sometimes return other non-compliant values.

Possible values
001
memberId
items[].dependents[].memberId
StringDeprecated

This property will never be populated. Please use subscriber.memberId instead.

middleName
items[].dependents[].middleName
String

The member's middle name or initial.

militaryServiceRankCode
items[].dependents[].militaryServiceRankCode
String

The member's military service rank code. Visit Eligibility code lists for a complete list.

Payers may sometimes return other non-compliant values.

Possible values
A1
A2
A3
B1
B2
planDescription
items[].dependents[].planDescription
String

Plan name

planNetworkDescription
items[].dependents[].planNetworkDescription
String

Plan network name

planNetworkIdNumber
items[].dependents[].planNetworkIdNumber
String

The network identification number associated with the insurance policy.

planNumber
items[].dependents[].planNumber
String

The plan number associated with the insurance policy.

relationToSubscriber
items[].dependents[].relationToSubscriber
String

The name of the relationToSubscriberCode. For example, Child when the code is 19.

Possible values
Spouse
Child
Employee
Unknown
Organ Donor
relationToSubscriberCode
items[].dependents[].relationToSubscriberCode
String

For the dependent, this can be 01 - Spouse, 19 - Child, 20 Employee, 21 - Unknown, 39 - Organ Donor, 40 - Cadaver Donor, 53 - Life Partner, or G8 - Other Relationship.

Possible values
01
19
20
21
39
responseProvider
items[].dependents[].responseProvider
Object

Information about the entity that submitted the original eligibility check request. This may be an individual practitioner, a medical group, a hospital, or another type of healthcare provider. This object will always include at least one identifier, such as the provider's NPI, tax ID, or EIN.

Show attributes
aaaErrors
items[].dependents[].responseProvider.aaaErrors
Array of Objects

When a payer rejects your eligibility check, the response contains one or more AAA errors that specify the reasons for the rejection and any recommended follow-up actions. Common reasons for rejection at the provider level include missing or incorrect information and issues with the provider's NPI registration with the payer. Learn more

Array item
code
items[].dependents[].responseProvider.aaaErrors[].code
String

The error code.

Payers may sometimes return other non-compliant values.

Possible values
15
41
43
44
45
description
items[].dependents[].responseProvider.aaaErrors[].description
String

The error description.

field
items[].dependents[].responseProvider.aaaErrors[].field
String

The error type, AAA.

followupAction
items[].dependents[].responseProvider.aaaErrors[].followupAction
String

Allowed actions you can take, based on the rejection reason code. For example Please Correct and Resubmit.

Payers may sometimes return other non-compliant values.

Possible values
Please Correct and Resubmit
Resubmission Not Allowed
Resubmission Allowed
Do Not Resubmit; Inquiry Initiated to a Third Party
Please Wait 30 Days and Resubmit
location
items[].dependents[].responseProvider.aaaErrors[].location
String

The location of the error within the original X12 EDI response.

possibleResolutions
items[].dependents[].responseProvider.aaaErrors[].possibleResolutions
String

Information to help you correct the error.

We periodically update this guidance, so these strings may change at any time and may differ between eligibility responses. Don't build programmatic logic that depends on matching these strings exactly.

address
items[].dependents[].responseProvider.address
Object

The provider's contact information.

Show attributes
address1
items[].dependents[].responseProvider.address.address1
StringLength: 1 - 55

The first line of the address.

address2
items[].dependents[].responseProvider.address.address2
StringLength: 1 - 55

The second line of the address.

city
items[].dependents[].responseProvider.address.city
StringLength: 2 - 30

The city.

countryCode
items[].dependents[].responseProvider.address.countryCode
StringLength: 2

The two-letter country code from Part 1 of ISO 3166.

countrySubDivisionCode
items[].dependents[].responseProvider.address.countrySubDivisionCode
StringLength: 1 - 3

The country subdivision code from Part 2 of ISO 3166.

postalCode
items[].dependents[].responseProvider.address.postalCode
StringLength: 5 - 9

The United States or Canadian postal code, excluding punctuation and blanks.

state
items[].dependents[].responseProvider.address.state
String

The US state or Canadian province code with unknown option. For example, TN for Tennessee or NB for New Brunswick.

Payers may sometimes return other non-compliant values.

Possible values
NL
PE
NS
NB
QC
employersId
items[].dependents[].responseProvider.employersId
StringDeprecated

Deprecated; The provider's identification number for the entity receiving the benefits information. This shape is deprecated: This property is no longer used.

entityIdentifier
items[].dependents[].responseProvider.entityIdentifier
String

A code identifying the type of provider.

Payers may sometimes return other non-compliant values.

Possible values
Provider
Third-Party Administrator
Employer
Hospital
Facility
entityType
items[].dependents[].responseProvider.entityType
String

The type of entity.

Payers may sometimes return other non-compliant values.

Possible values
Person
Non-Person Entity
federalTaxpayersIdNumber
items[].dependents[].responseProvider.federalTaxpayersIdNumber
StringRegex pattern: ^\d{9}$

The Federal Taxpayer Identification Number (also known as an EIN).

middleName
items[].dependents[].responseProvider.middleName
String

The provider's middle name. This applies to providers that are an individual.

npi
items[].dependents[].responseProvider.npi
StringRegex pattern: ^\d{10}$
payorIdentification
items[].dependents[].responseProvider.payorIdentification
String

The Payor Identification.

pharmacyProcessorNumber
items[].dependents[].responseProvider.pharmacyProcessorNumber
String

The pharmacy processor number.

providerCode
items[].dependents[].responseProvider.providerCode
String

A code that communicates the provider's role in the type of benefits information in the response. Visit Eligibility code lists for a complete list.

Payers may sometimes return other non-compliant values.

Possible values
AD
AT
BI
CO
CV
providerFirstName
items[].dependents[].responseProvider.providerFirstName
String

The provider's first name. This applies to providers that are an individual.

providerName
items[].dependents[].responseProvider.providerName
String

The provider's last name. This applies to providers that are an individual.

providerOrgName
items[].dependents[].responseProvider.providerOrgName
String

The provider's organization name.

referenceIdentification
items[].dependents[].responseProvider.referenceIdentification
String

The Health Care Provider Taxonomy Code.

serviceProviderNumber
items[].dependents[].responseProvider.serviceProviderNumber
String

The service provider number. This is an identification number assigned by the payer.

servicesPlanID
items[].dependents[].responseProvider.servicesPlanID
String

The Centers for Medicare and Medicaid Services (CMS) Plan ID.

ssn
items[].dependents[].responseProvider.ssn
StringRegex pattern: ^\d{9}$

The Social Security Number (SSN).

suffix
items[].dependents[].responseProvider.suffix
String

The provider's name suffix, such as Jr., Sr., or III.

ssn
items[].dependents[].ssn
StringRegex pattern: ^\d{9}$

The member's Social Security Number (SSN).

startDateTimePeriod
items[].dependents[].startDateTimePeriod
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The military service start date.

suffix
items[].dependents[].suffix
String

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

uniqueHealthIdentifier
items[].dependents[].uniqueHealthIdentifier
String

The member's unique health identifier.

eligibilitySearchId
items[].eligibilitySearchId
String

An identifier that allows Stedi to group eligibility checks for the same patient into a unified record within Eligibility Manager called an eligibility search.

This property is for use by Stedi tools only, such as Stedi's MCP server.

errors
items[].errors
Array of Objects

When a payer rejects your eligibility check, the response contains one or more AAA errors that specify the reasons for the rejection and any recommended follow-up actions.

Any errors that occur at the payer, provider, subscriber, or dependents levels are also included in this array, allowing you to review all errors in a central location. If there are no AAA errors, this array will be empty.

Array item
code
items[].errors[].code
String

The error code. Visit Eligibility troubleshooting for a complete list of all possible error codes and descriptions.

Payers may sometimes return other non-compliant values.

Possible values
04
15
33
35
41
description
items[].errors[].description
String

The error description.

field
items[].errors[].field
String

The error type, AAA.

followupAction
items[].errors[].followupAction
String

Allowed actions you can take, based on the rejection reason code. For example Please Correct and Resubmit.

Payers may sometimes return other non-compliant values.

Possible values
Please Correct and Resubmit
Resubmission Not Allowed
Please Resubmit Original Transaction
Resubmission Allowed
Do Not Resubmit; Inquiry Initiated to a Third Party
location
items[].errors[].location
String

The location of the error within the original X12 EDI response.

possibleResolutions
items[].errors[].possibleResolutions
String

Information to help you correct the error.

We periodically update this guidance, so these strings may change at any time and may differ between eligibility responses. Don't build programmatic logic that depends on matching these strings exactly.

implementationTransactionSetSyntaxError
items[].implementationTransactionSetSyntaxError
String

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

meta
items[].meta
Object

Metadata about the response. Stedi uses this data for tracking and troubleshooting.

Show attributes
applicationMode
items[].meta.applicationMode
String

The type of data in the request. This is either production when you send a request with a standard API key or test when you send a request in test mode with a test API key. The information value is not currently used.

Payers may sometimes return other non-compliant values.

Possible values
production
test
information
billerId
items[].meta.billerId
String

The biller ID Stedi assigns to this request.

outboundTraceId
items[].meta.outboundTraceId
String

The unique ID Stedi assigns to this request.

senderId
items[].meta.senderId
String

The sender ID Stedi assigns to this request.

submitterId
items[].meta.submitterId
String

The submitter ID Stedi assigns to this request.

traceId
items[].meta.traceId
String

The transaction identifier the payer sends in the response. This should be the same as the outboundTraceId.

payer
items[].payer
Object

Information about the payer providing the benefits information. The response will always include the payer's business name and an identifier, such as the payer's tax ID. Most payers also include contact information.

Show attributes
aaaErrors
items[].payer.aaaErrors
Array of Objects

When a payer rejects your eligibility check, the response contains one or more AAA errors that specify the reasons for the rejection and any recommended follow-up actions. Common reasons for rejection at the payer level include issues with payer enrollment and that the payer's system is down or experiencing issues. Learn more

Array item
code
items[].payer.aaaErrors[].code
String

The error code.

Payers may sometimes return other non-compliant values.

Possible values
04
41
42
79
80
description
items[].payer.aaaErrors[].description
String

The error description.

field
items[].payer.aaaErrors[].field
String

The error type, AAA.

followupAction
items[].payer.aaaErrors[].followupAction
String

Allowed actions you can take, based on the rejection reason code. For example Please Correct and Resubmit.

Payers may sometimes return other non-compliant values.

Possible values
Please Correct and Resubmit
Resubmission Not Allowed
Please Resubmit Original Transaction
Resubmission Allowed
Do Not Resubmit; Inquiry Initiated to a Third Party
location
items[].payer.aaaErrors[].location
String

The location of the error within the original X12 EDI response.

possibleResolutions
items[].payer.aaaErrors[].possibleResolutions
String

Information to help you correct the error.

We periodically update this guidance, so these strings may change at any time and may differ between eligibility responses. Don't build programmatic logic that depends on matching these strings exactly.

centersForMedicareAndMedicaidPlanId
items[].payer.centersForMedicareAndMedicaidPlanId
String

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

contactInformation
items[].payer.contactInformation
Object

The payer's contact information.

Note that when contacts.communicationMode is set to UR, the communicationNumber property may not contain a valid URL. Most payers provide a partial web address for their provider portal, or something similar, such as www.example.com/portal. You must add the appropriate scheme and separators, such as https:// or http://, to make it a valid URL.

Show attributes
contacts
items[].payer.contactInformation.contacts
Array of Objects

The contact information.

Array item
communicationMode
items[].payer.contactInformation.contacts[].communicationMode
String

The type of communication number provided.

Payers may sometimes return other non-compliant values.

Possible values
Electronic Data Interchange Access Number
Electronic Mail
Facsimile
Telephone
Uniform Resource Locator (URL)
communicationNumber
items[].payer.contactInformation.contacts[].communicationNumber
String

The communication number referenced in communicationMode. It includes the country or area code when applicable.

Note that phone numbers are formatted as AAABBBCCCC, where AAA represents the area code, BBB represents the telephone number prefix, and CCCC represents the telephone number. Phone numbers are provided without separators, such as dashes or parentheses. For example, 5551123345 for 555-112-3345.

name
items[].payer.contactInformation.name
String

The name of the contact person.

employersId
items[].payer.employersId
StringDeprecated

Deprecated; The payer's identification number for the entity receiving the benefits information. This shape is deprecated: This property is no longer used.

entityIdentifier
items[].payer.entityIdentifier
String

The entity identifier code for the payer.

Payers may sometimes return other non-compliant values.

Possible values
Third-Party Administrator
Employer
Gateway Provider
Plan Sponsor
Payer
entityType
items[].payer.entityType
String

The entity type qualifier for the payer. Can be set to Person (not commonly used) or Non-Person Entity (most common).

Payers may sometimes return other non-compliant values.

Possible values
Person
Non-Person Entity
etin
items[].payer.etin
String

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

federalTaxpayersIdNumber
items[].payer.federalTaxpayersIdNumber
StringRegex pattern: ^\d{9}$

The payer's federal taxpayer's identification number.

firstName
items[].payer.firstName
String

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

lastName
items[].payer.lastName
String

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

middleName
items[].payer.middleName
String

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

naic
items[].payer.naic
String

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

name
items[].payer.name
String

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

npi
items[].payer.npi
StringRegex pattern: ^\d{10}$
payorIdentification
items[].payer.payorIdentification
String

The payor identification.

suffix
items[].payer.suffix
String

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

planDateInformation
items[].planDateInformation
Object

Contains the dates associated with the subscriber and dependents' (if applicable) insurance plan. This information is used to determine their eligibility for benefits.

  • Most fields contain a single date, but some can contain either a single date or a date range. Each field's documentation specifies its format.
  • Fields that can contain either a single date or date range include: plan, eligibility, planBegin, admission, and service.
  • The provided dates apply to every benefit within the patient's health plan unless specifically noted within a benefitsInformation.benefitsDateInformation object.
  • If the payer sends back date(s) that are different for the subscriber and dependents, Stedi includes only the dates for the dependent in this object and omits the subscriber's date(s). Dependents can have different coverage dates than the subscriber due to qualifying life events, such as starting a new job or passing the age limit for coverage through their parent's plan.
  • Most payers return either plan or planBegin and planEnd, but the exact dates returned depend on the payer's discretion and the patient's insurance plan.
  • If the date of service is after the earliest ending plan, eligibility, planEnd, eligibilityEnd, policyEffective, or policyExpiration value, the patient likely doesn't have active coverage.
Show attributes
added
items[].planDateInformation.added
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

Added date. Payers may return this information in the case of retroactive eligibility.

admission
items[].planDateInformation.admission
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The admission date or dates.

benefit
items[].planDateInformation.benefit
StringDeprecatedRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The benefit date.

benefitBegin
items[].planDateInformation.benefitBegin
StringDeprecatedRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The benefit begin date.

benefitEnd
items[].planDateInformation.benefitEnd
StringDeprecatedRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The benefit end date.

certification
items[].planDateInformation.certification
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The certification date.

cobraBegin
items[].planDateInformation.cobraBegin
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The date when COBRA coverage begins.

cobraEnd
items[].planDateInformation.cobraEnd
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The date when COBRA coverage ends.

completion
items[].planDateInformation.completion
StringDeprecatedRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The completion date.

coordinationOfBenefits
items[].planDateInformation.coordinationOfBenefits
StringDeprecatedRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The coordination of benefits date.

dateOfDeath
items[].planDateInformation.dateOfDeath
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The date of death. Payers may return this information in the case of a deceased subscriber or dependent.

dateOfLastUpdate
items[].planDateInformation.dateOfLastUpdate
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The date when the plan information was last updated.

discharge
items[].planDateInformation.discharge
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The discharge date.

effectiveDateOfChange
items[].planDateInformation.effectiveDateOfChange
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The effective date of change.

eligibility
items[].planDateInformation.eligibility
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

Plan eligibility dates.

eligibilityBegin
items[].planDateInformation.eligibilityBegin
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The date when the patient is first eligible for benefits under the plan.

eligibilityEnd
items[].planDateInformation.eligibilityEnd
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The date when the patient is no longer eligible for benefits under the plan.

enrollment
items[].planDateInformation.enrollment
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The date when the patient is enrolled in the plan.

issue
items[].planDateInformation.issue
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The issue date.

latestVisitOrConsultation
items[].planDateInformation.latestVisitOrConsultation
StringDeprecatedRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The latest visit or consultation date.

periodEnd
items[].planDateInformation.periodEnd
StringDeprecatedRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The end of a period.

periodStart
items[].planDateInformation.periodStart
StringDeprecatedRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The start of a period.

plan
items[].planDateInformation.plan
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

Plan effective dates.

planBegin
items[].planDateInformation.planBegin
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The date coverage from the plan begins.

planEnd
items[].planDateInformation.planEnd
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The date coverage from the plan ends.

policyEffective
items[].planDateInformation.policyEffective
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The date when the policy becomes effective.

policyExpiration
items[].planDateInformation.policyExpiration
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The date when the policy expires.

premiumPaidToDateBegin
items[].planDateInformation.premiumPaidToDateBegin
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The start of the period when the plan premium was paid in full.

premiumPaidToDateEnd
items[].planDateInformation.premiumPaidToDateEnd
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The end of period when the plan premium payments are up-to-date.

primaryCareProvider
items[].planDateInformation.primaryCareProvider
StringDeprecatedRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The primary care provider date.

service
items[].planDateInformation.service
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The service date or dates.

status
items[].planDateInformation.status
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

The status date.

planInformation
items[].planInformation
Object

Additional identification for the subscriber's healthcare plan.

Show attributes
agencyClaimNumber
items[].planInformation.agencyClaimNumber
String

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

alternativeListId
items[].planInformation.alternativeListId
String

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

caseNumber
items[].planInformation.caseNumber
String

The case number

centersForMedicareAndMedicaidServicesNPI
items[].planInformation.centersForMedicareAndMedicaidServicesNPI
StringRegex pattern: ^\d{10}$

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

classOfContractCode
items[].planInformation.classOfContractCode
String

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

contractNumber
items[].planInformation.contractNumber
String

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

coverageListId
items[].planInformation.coverageListId
String

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

drugFormularyNumber
items[].planInformation.drugFormularyNumber
String

The drug formulary number

electronicDevicePin
items[].planInformation.electronicDevicePin
String

The electronic device pin number

eligibilityCategory
items[].planInformation.eligibilityCategory
String

The eligibility category

facilityIdNumber
items[].planInformation.facilityIdNumber
String

The facility ID number

facilityNetworkIdentificationNumber
items[].planInformation.facilityNetworkIdentificationNumber
String

The facility network identification number

familyUnitNumber
items[].planInformation.familyUnitNumber
String

The family unit number

federalTaxpayersIdentificationNumber
items[].planInformation.federalTaxpayersIdentificationNumber
String

The federal taxpayer's identification number

groupDescription
items[].planInformation.groupDescription
String

The group description

groupNumber
items[].planInformation.groupNumber
String

The group number

hicNumber
items[].planInformation.hicNumber
String

The health insurance claim number (HICN). Note that CMS previously used the HICN to uniquely identify Medicare beneficiaries. However, they have since transitioned to a new, randomized Medicare Beneficiary Identifier (MBI) format. The HICN is no longer used for Medicare transactions but this property is now used by some payers to return MBI. If you receive a value in this property that matches the format specified in the Medicare Beneficiary Identifier documentation, the number is likely an MBI and we recommend sending a follow-up eligibility check to CMS for additional benefits data. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

idCardNumber
items[].planInformation.idCardNumber
String

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

idCardSerialNumber
items[].planInformation.idCardSerialNumber
String

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

insurancePolicyNumber
items[].planInformation.insurancePolicyNumber
String

The insurance policy number

issueNumber
items[].planInformation.issueNumber
String

The issue number

medicaidProviderNumber
items[].planInformation.medicaidProviderNumber
String

The Medicaid provider number

medicaidRecipientIdNumber
items[].planInformation.medicaidRecipientIdNumber
String

The Medicaid recipient identification number

medicalAssistanceCategory
items[].planInformation.medicalAssistanceCategory
String

The medical assistance category

medicalRecordIdentificationNumber
items[].planInformation.medicalRecordIdentificationNumber
String

The medical record identification number

medicareProviderNumber
items[].planInformation.medicareProviderNumber
String

The Medicare provider number

memberId
items[].planInformation.memberId
String

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

patientAccountNumber
items[].planInformation.patientAccountNumber
String

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

personalIdentificationNumber
items[].planInformation.personalIdentificationNumber
String

The personal identification number (PIN)

planDescription
items[].planInformation.planDescription
String

The plan description

planNetworkIdDescription
items[].planInformation.planNetworkIdDescription
String

The plan, group, or plan network name

planNetworkIdNumber
items[].planInformation.planNetworkIdNumber
String

The plan network identification number

planNumber
items[].planInformation.planNumber
String

The plan number

policyNumber
items[].planInformation.policyNumber
String

The group or policy number

priorAuthorizationNumber
items[].planInformation.priorAuthorizationNumber
String

The prior authorization number

priorIdNumber
items[].planInformation.priorIdNumber
String

The prior identifier number

referralNumber
items[].planInformation.referralNumber
String

The referral number

socialSecurityNumber
items[].planInformation.socialSecurityNumber
String

The social security number

stateLicenseNumber
items[].planInformation.stateLicenseNumber
String

The state license number

submitterIdentificationNumber
items[].planInformation.submitterIdentificationNumber
String

The submitter identification number

userIdentification
items[].planInformation.userIdentification
String

The user identification

planStatus
items[].planStatus
Array of ObjectsDeprecated

Please use benefitsInformation instead.

Array item
planDetails
items[].planStatus[].planDetails
StringDeprecated
serviceTypeCodes
items[].planStatus[].serviceTypeCodes
Array of StringsDeprecated

Service Type Codes (STCs) related to the benefit type. For example, 7 - Anesthesia. Visit Service Type Codes for a complete list.

This list is specific to X12 version 005010, which is the mandated version for eligibility checks. It differs from the current X12 Service Type Codes list, which applies to X12 versions later than 005010.

Payers may sometimes return other non-compliant values.

Possible values
1
2
3
4
5
status
items[].planStatus[].status
StringDeprecated
statusCode
items[].planStatus[].statusCode
StringDeprecated
provider
items[].provider
Object

Information about the entity that submitted the original eligibility check request. This may be an individual practitioner, a medical group, a hospital, or another type of healthcare provider. This object will always include at least one identifier, such as the provider's NPI, tax ID, or EIN.

Show attributes
aaaErrors
items[].provider.aaaErrors
Array of Objects

When a payer rejects your eligibility check, the response contains one or more AAA errors that specify the reasons for the rejection and any recommended follow-up actions. Common reasons for rejection at the provider level include missing or incorrect information and issues with the provider's NPI registration with the payer. Learn more

Array item
code
items[].provider.aaaErrors[].code
String

The error code.

Payers may sometimes return other non-compliant values.

Possible values
15
41
43
44
45
description
items[].provider.aaaErrors[].description
String

The error description.

field
items[].provider.aaaErrors[].field
String

The error type, AAA.

followupAction
items[].provider.aaaErrors[].followupAction
String

Allowed actions you can take, based on the rejection reason code. For example Please Correct and Resubmit.

Payers may sometimes return other non-compliant values.

Possible values
Please Correct and Resubmit
Resubmission Not Allowed
Resubmission Allowed
Do Not Resubmit; Inquiry Initiated to a Third Party
Please Wait 30 Days and Resubmit
location
items[].provider.aaaErrors[].location
String

The location of the error within the original X12 EDI response.

possibleResolutions
items[].provider.aaaErrors[].possibleResolutions
String

Information to help you correct the error.

We periodically update this guidance, so these strings may change at any time and may differ between eligibility responses. Don't build programmatic logic that depends on matching these strings exactly.

address
items[].provider.address
Object

The provider's contact information.

Show attributes
address1
items[].provider.address.address1
StringLength: 1 - 55

The first line of the address.

address2
items[].provider.address.address2
StringLength: 1 - 55

The second line of the address.

city
items[].provider.address.city
StringLength: 2 - 30

The city.

countryCode
items[].provider.address.countryCode
StringLength: 2

The two-letter country code from Part 1 of ISO 3166.

countrySubDivisionCode
items[].provider.address.countrySubDivisionCode
StringLength: 1 - 3

The country subdivision code from Part 2 of ISO 3166.

postalCode
items[].provider.address.postalCode
StringLength: 5 - 9

The United States or Canadian postal code, excluding punctuation and blanks.

state
items[].provider.address.state
String

The US state or Canadian province code with unknown option. For example, TN for Tennessee or NB for New Brunswick.

Payers may sometimes return other non-compliant values.

Possible values
NL
PE
NS
NB
QC
employersId
items[].provider.employersId
StringDeprecated

Deprecated; The provider's identification number for the entity receiving the benefits information. This shape is deprecated: This property is no longer used.

entityIdentifier
items[].provider.entityIdentifier
String

A code identifying the type of provider.

Payers may sometimes return other non-compliant values.

Possible values
Provider
Third-Party Administrator
Employer
Hospital
Facility
entityType
items[].provider.entityType
String

The type of entity.

Payers may sometimes return other non-compliant values.

Possible values
Person
Non-Person Entity
federalTaxpayersIdNumber
items[].provider.federalTaxpayersIdNumber
StringRegex pattern: ^\d{9}$

The Federal Taxpayer Identification Number (also known as an EIN).

middleName
items[].provider.middleName
String

The provider's middle name. This applies to providers that are an individual.

npi
items[].provider.npi
StringRegex pattern: ^\d{10}$
payorIdentification
items[].provider.payorIdentification
String

The Payor Identification.

pharmacyProcessorNumber
items[].provider.pharmacyProcessorNumber
String

The pharmacy processor number.

providerCode
items[].provider.providerCode
String

A code that communicates the provider's role in the type of benefits information in the response. Visit Eligibility code lists for a complete list.

Payers may sometimes return other non-compliant values.

Possible values
AD
AT
BI
CO
CV
providerFirstName
items[].provider.providerFirstName
String

The provider's first name. This applies to providers that are an individual.

providerName
items[].provider.providerName
String

The provider's last name. This applies to providers that are an individual.

providerOrgName
items[].provider.providerOrgName
String

The provider's organization name.

referenceIdentification
items[].provider.referenceIdentification
String

The Health Care Provider Taxonomy Code.

serviceProviderNumber
items[].provider.serviceProviderNumber
String

The service provider number. This is an identification number assigned by the payer.

servicesPlanID
items[].provider.servicesPlanID
String

The Centers for Medicare and Medicaid Services (CMS) Plan ID.

ssn
items[].provider.ssn
StringRegex pattern: ^\d{9}$

The Social Security Number (SSN).

suffix
items[].provider.suffix
String

The provider's name suffix, such as Jr., Sr., or III.

reassociationKey
items[].reassociationKey
StringDeprecated
status
items[].status
String

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

submitterTransactionIdentifier
items[].submitterTransactionIdentifier
String

The unique identifier for the eligibility check that you submitted in the original batch request.

subscriber
items[].subscriber
Object

Information about the primary policyholder for the insurance plan listed in the original eligibility check request. The response will always include either the subscriber's name or member ID for identification, but most payers will also return the subscriber's date of birth and other identifying information.

Show attributes
aaaErrors
items[].subscriber.aaaErrors
Array of Objects

When a payer rejects your eligibility check, the response contains one or more AAA errors that specify the reasons for the rejection and any recommended follow-up actions. Common reasons for rejection at the subscriber or dependent level include missing or incorrect identifying information and that the payer was unable to locate the patient in their system. Learn more

Array item
code
items[].subscriber.aaaErrors[].code
String

The error code.

Payers may sometimes return other non-compliant values.

Possible values
15
33
35
42
43
description
items[].subscriber.aaaErrors[].description
String

The error description.

field
items[].subscriber.aaaErrors[].field
String

The error type, AAA.

followupAction
items[].subscriber.aaaErrors[].followupAction
String

Allowed actions you can take, based on the rejection reason code. For example Please Correct and Resubmit.

Payers may sometimes return other non-compliant values.

Possible values
Please Correct and Resubmit
Resubmission Not Allowed
Resubmission Allowed
Do Not Resubmit; Inquiry Initiated to a Third Party
Please Wait 30 Days and Resubmit
location
items[].subscriber.aaaErrors[].location
String

The location of the error within the original X12 EDI response.

possibleResolutions
items[].subscriber.aaaErrors[].possibleResolutions
String

Information to help you correct the error.

We periodically update this guidance, so these strings may change at any time and may differ between eligibility responses. Don't build programmatic logic that depends on matching these strings exactly.

address
items[].subscriber.address
Object
Show attributes
address1
items[].subscriber.address.address1
StringLength: 1 - 55

The first line of the address.

address2
items[].subscriber.address.address2
StringLength: 1 - 55

The second line of the address.

city
items[].subscriber.address.city
StringLength: 2 - 30

The city.

countryCode
items[].subscriber.address.countryCode
StringLength: 2

The two-letter country code from Part 1 of ISO 3166.

countrySubDivisionCode
items[].subscriber.address.countrySubDivisionCode
StringLength: 1 - 3

The country subdivision code from Part 2 of ISO 3166.

postalCode
items[].subscriber.address.postalCode
StringLength: 5 - 9

The United States or Canadian postal code, excluding punctuation and blanks.

state
items[].subscriber.address.state
String

The US state or Canadian province code with unknown option. For example, TN for Tennessee or NB for New Brunswick.

Payers may sometimes return other non-compliant values.

Possible values
NL
PE
NS
NB
QC
birthSequenceNumber
items[].subscriber.birthSequenceNumber
String

The number assigned to each family member born with the same birth date, such as twins or triplets. Indicates the birth order when there are multiple births associated with the provided birth date.

dateOfBirth
items[].subscriber.dateOfBirth
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The member's date of birth.

dateTimePeriod
items[].subscriber.dateTimePeriod
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The military service date.

dateTimePeriodFormatQualifier
items[].subscriber.dateTimePeriodFormatQualifier
String

The format of the military service date and time period. Can be D8 - Date or RD8 - Range of Dates.

Payers may sometimes return other non-compliant values.

Possible values
D8
RD8
description
items[].subscriber.description
String

Context that identifies the exact military unit. Used to report military service data.

employmentStatusCode
items[].subscriber.employmentStatusCode
String

The member's employment status code, used to report military service data. Visit Eligibility code lists for a complete list.

Payers may sometimes return other non-compliant values.

Possible values
AE
AO
AS
AT
AU
endDateTimePeriod
items[].subscriber.endDateTimePeriod
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The military service end date.

entityIdentifier
items[].subscriber.entityIdentifier
String

The entity identifier for the subscriber.

Possible values
Insured or Subscriber
entityType
items[].subscriber.entityType
String

The entity type for the member. It can technically be set to Person or Non-Person Entity. In practice, our customers only receive Person.

Payers may sometimes return other non-compliant values.

Possible values
Person
Non-Person Entity
firstName
items[].subscriber.firstName
String

The member's first name.

gender
items[].subscriber.gender
String

Code indicating the patient's gender.

Possible values
M
F
U
governmentServiceAffiliationCode
items[].subscriber.governmentServiceAffiliationCode
String

The member's government service affiliation code, used to report military service data. Visit Eligibility code lists for a complete list.

Payers may sometimes return other non-compliant values.

Possible values
A
B
C
D
E
groupDescription
items[].subscriber.groupDescription
String

Group name

groupNumber
items[].subscriber.groupNumber
String

The group number associated with the insurance policy.

healthCareDiagnosisCodes
items[].subscriber.healthCareDiagnosisCodes
Array of Objects

Information about the patient's healthcare diagnosis.

Array item
diagnosisCode
items[].subscriber.healthCareDiagnosisCodes[].diagnosisCode
String

The diagnosis code. The decimal points are omitted in diagnosis codes - the decimal point is assumed.

diagnosisTypeCode
items[].subscriber.healthCareDiagnosisCodes[].diagnosisTypeCode
String

The type of diagnosis code provided. It can be ABK - International Classification of Diseases Clinical Modification (ICD-10-CM) Principal Diagnosis or BK - International Classification of Diseases Clinical Modification (ICD-9-CM) Principal Diagnosis.

informationStatusCode
items[].subscriber.informationStatusCode
String

The status of the member's information, used to report military service data. Visit Eligibility code lists for a complete list.

Payers may sometimes return other non-compliant values.

Possible values
A
C
L
O
P
insuredIndicator
items[].subscriber.insuredIndicator
String

Indicates the status of the insured. For the subscriber, this is always Y.

Possible values
Y
lastName
items[].subscriber.lastName
String

The member's last name.

maintenanceReasonCode
items[].subscriber.maintenanceReasonCode
String

Code identifying the reason for the changes to subscriber identifying information, such as name, date of birth, or address. This is always 25

Payers may sometimes return other non-compliant values.

Possible values
25
maintenanceTypeCode
items[].subscriber.maintenanceTypeCode
String

The maintenance type code. Used to acknowledge a change in the identifying elements for the subscriber from those submitted in the original eligibility check request. It can also be included when the payer used the birth sequence number from the original request to locate the subscriber in their system. This is always 001

Payers may sometimes return other non-compliant values.

Possible values
001
memberId
items[].subscriber.memberId
String

The member ID for the insurance policy.

middleName
items[].subscriber.middleName
String

The member's middle name or initial.

militaryServiceRankCode
items[].subscriber.militaryServiceRankCode
String

The member's military service rank code. Visit Eligibility code lists for a complete list.

Payers may sometimes return other non-compliant values.

Possible values
A1
A2
A3
B1
B2
planDescription
items[].subscriber.planDescription
String

Plan name

planNetworkDescription
items[].subscriber.planNetworkDescription
String

Plan network name

planNetworkIdNumber
items[].subscriber.planNetworkIdNumber
String

The network identification number associated with the insurance policy.

planNumber
items[].subscriber.planNumber
String

The plan number associated with the insurance policy.

relationToSubscriber
items[].subscriber.relationToSubscriber
String

The name of the relationToSubscriberCode. For the subscriber, this is always Self.

Possible values
Self
relationToSubscriberCode
items[].subscriber.relationToSubscriberCode
String

For the subscriber, this is always 18 for Self.

Possible values
18
responseProvider
items[].subscriber.responseProvider
Object

Information about the entity that submitted the original eligibility check request. This may be an individual practitioner, a medical group, a hospital, or another type of healthcare provider. This object will always include at least one identifier, such as the provider's NPI, tax ID, or EIN.

Show attributes
aaaErrors
items[].subscriber.responseProvider.aaaErrors
Array of Objects

When a payer rejects your eligibility check, the response contains one or more AAA errors that specify the reasons for the rejection and any recommended follow-up actions. Common reasons for rejection at the provider level include missing or incorrect information and issues with the provider's NPI registration with the payer. Learn more

Array item
code
items[].subscriber.responseProvider.aaaErrors[].code
String

The error code.

Payers may sometimes return other non-compliant values.

Possible values
15
41
43
44
45
description
items[].subscriber.responseProvider.aaaErrors[].description
String

The error description.

field
items[].subscriber.responseProvider.aaaErrors[].field
String

The error type, AAA.

followupAction
items[].subscriber.responseProvider.aaaErrors[].followupAction
String

Allowed actions you can take, based on the rejection reason code. For example Please Correct and Resubmit.

Payers may sometimes return other non-compliant values.

Possible values
Please Correct and Resubmit
Resubmission Not Allowed
Resubmission Allowed
Do Not Resubmit; Inquiry Initiated to a Third Party
Please Wait 30 Days and Resubmit
location
items[].subscriber.responseProvider.aaaErrors[].location
String

The location of the error within the original X12 EDI response.

possibleResolutions
items[].subscriber.responseProvider.aaaErrors[].possibleResolutions
String

Information to help you correct the error.

We periodically update this guidance, so these strings may change at any time and may differ between eligibility responses. Don't build programmatic logic that depends on matching these strings exactly.

address
items[].subscriber.responseProvider.address
Object

The provider's contact information.

Show attributes
address1
items[].subscriber.responseProvider.address.address1
StringLength: 1 - 55

The first line of the address.

address2
items[].subscriber.responseProvider.address.address2
StringLength: 1 - 55

The second line of the address.

city
items[].subscriber.responseProvider.address.city
StringLength: 2 - 30

The city.

countryCode
items[].subscriber.responseProvider.address.countryCode
StringLength: 2

The two-letter country code from Part 1 of ISO 3166.

countrySubDivisionCode
items[].subscriber.responseProvider.address.countrySubDivisionCode
StringLength: 1 - 3

The country subdivision code from Part 2 of ISO 3166.

postalCode
items[].subscriber.responseProvider.address.postalCode
StringLength: 5 - 9

The United States or Canadian postal code, excluding punctuation and blanks.

state
items[].subscriber.responseProvider.address.state
String

The US state or Canadian province code with unknown option. For example, TN for Tennessee or NB for New Brunswick.

Payers may sometimes return other non-compliant values.

Possible values
NL
PE
NS
NB
QC
employersId
items[].subscriber.responseProvider.employersId
StringDeprecated

Deprecated; The provider's identification number for the entity receiving the benefits information. This shape is deprecated: This property is no longer used.

entityIdentifier
items[].subscriber.responseProvider.entityIdentifier
String

A code identifying the type of provider.

Payers may sometimes return other non-compliant values.

Possible values
Provider
Third-Party Administrator
Employer
Hospital
Facility
entityType
items[].subscriber.responseProvider.entityType
String

The type of entity.

Payers may sometimes return other non-compliant values.

Possible values
Person
Non-Person Entity
federalTaxpayersIdNumber
items[].subscriber.responseProvider.federalTaxpayersIdNumber
StringRegex pattern: ^\d{9}$

The Federal Taxpayer Identification Number (also known as an EIN).

middleName
items[].subscriber.responseProvider.middleName
String

The provider's middle name. This applies to providers that are an individual.

npi
items[].subscriber.responseProvider.npi
StringRegex pattern: ^\d{10}$
payorIdentification
items[].subscriber.responseProvider.payorIdentification
String

The Payor Identification.

pharmacyProcessorNumber
items[].subscriber.responseProvider.pharmacyProcessorNumber
String

The pharmacy processor number.

providerCode
items[].subscriber.responseProvider.providerCode
String

A code that communicates the provider's role in the type of benefits information in the response. Visit Eligibility code lists for a complete list.

Payers may sometimes return other non-compliant values.

Possible values
AD
AT
BI
CO
CV
providerFirstName
items[].subscriber.responseProvider.providerFirstName
String

The provider's first name. This applies to providers that are an individual.

providerName
items[].subscriber.responseProvider.providerName
String

The provider's last name. This applies to providers that are an individual.

providerOrgName
items[].subscriber.responseProvider.providerOrgName
String

The provider's organization name.

referenceIdentification
items[].subscriber.responseProvider.referenceIdentification
String

The Health Care Provider Taxonomy Code.

serviceProviderNumber
items[].subscriber.responseProvider.serviceProviderNumber
String

The service provider number. This is an identification number assigned by the payer.

servicesPlanID
items[].subscriber.responseProvider.servicesPlanID
String

The Centers for Medicare and Medicaid Services (CMS) Plan ID.

ssn
items[].subscriber.responseProvider.ssn
StringRegex pattern: ^\d{9}$

The Social Security Number (SSN).

suffix
items[].subscriber.responseProvider.suffix
String

The provider's name suffix, such as Jr., Sr., or III.

ssn
items[].subscriber.ssn
StringRegex pattern: ^\d{9}$

The member's Social Security Number (SSN).

startDateTimePeriod
items[].subscriber.startDateTimePeriod
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The military service start date.

suffix
items[].subscriber.suffix
String

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

uniqueHealthIdentifier
items[].subscriber.uniqueHealthIdentifier
String

The member's unique health identifier.

subscriberTraceNumbers
items[].subscriberTraceNumbers
Array of Objects

A unique identifier for the eligibility request. It's used to trace the transaction. Stedi always generates a trace number for internal tracking, and the payer may generate one as well. Stedi returns both its internal trace number and the payer's trace number (if present) in this array.

You can't set your own trace number when submitting eligibility checks through this endpoint.

Array item
originatingCompanyIdentifier
items[].subscriberTraceNumbers[].originatingCompanyIdentifier
String

The identifier of the organization that assigned the trace number.

referenceIdentification
items[].subscriberTraceNumbers[].referenceIdentification
String

The unique trace number assigned to the transaction.

secondaryReferenceIdentification
items[].subscriberTraceNumbers[].secondaryReferenceIdentification
String

Identifies a subdivision within the organization that assigned the trace number.

traceType
items[].subscriberTraceNumbers[].traceType
String

The full name of the traceTypeCode. For example Current Transaction Trace Numbers.

traceTypeCode
items[].subscriberTraceNumbers[].traceTypeCode
String

The code that identifies the type of trace number. Can be 1 - Current Transaction Trace Numbers (refers to trace numbers assigned by the payer) or 2 - Referenced Trace Numbers (refers to numbers sent in the original eligibility check request).

tradingPartnerServiceId
items[].tradingPartnerServiceId
String

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

transactionSetAcknowledgement
items[].transactionSetAcknowledgement
String

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

warnings
items[].warnings
Array of Objects

Warnings indicate non-fatal issues with your eligibility check or a non-standard response from the payer.

Array item
code
items[].warnings[].code
String

The warning code.

description
items[].warnings[].description
String

The warning description.

x12
items[].x12
String

Typically this property contains the raw X12 EDI 271 Eligibility Benefit Response from the payer.

In some circumstances, this property may contain a 999 Implementation Acknowledgment instead of a 271. A 999 indicates validation errors in the X12 EDI transaction, such as improper formatting or missing or invalid values.

If the 999 is returned in this property, many of the other response properties will be empty, as they are mapped to information in the 271.

nextPageToken
StringLength: 1 - 1024

A Stedi-generated token that you can submit in the pageToken query parameter to retrieve the next page of results. If there are no more results, this property is not included in the response.