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 up to 8 hours. Therefore, it can take up to 8 hours 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.

Authorizationstringrequiredheader

A Stedi API Key for authentication.

Query Parameters

pageSizenumber

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.
  • Range: ≥ 1 and ≤ 200
pageTokenstring

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

  • Required string length: 1 - 1024
batchIdstring

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.

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.

  • Format: date-time

Response

application/json

BatchEligibilityPolling 200 response

itemsarray<object>required

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

The batchId Stedi returned from the Batch Eligibility Check endpoint.

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.

  • Pattern: ^[a-zA-Z0-9-_]{1,100}$

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

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

Array item

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

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

Payers may sometimes return other non-compliant values.

Possible values
N
U
Y

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.

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.

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

Identifying information specific to this type of benefit.

Show attributes

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.

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.

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.

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

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.

Dates associated with the benefits.

  • These dates only apply to the benefitsInformation object in which this benefitsDateInformation is provided.
Show attributes

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

  • 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.

  • 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(s) for admission.

Array item

A single date.

  • Pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The end date of a range.

  • Pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The beginning date of a range.

  • Pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The benefit date.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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(s) when the patient was discharged.

Array item

A single date.

  • Pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The end date of a range.

  • Pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The beginning date of a range.

  • Pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The effective date of change.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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]))?$

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

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

Show attributes

The first line of the address.

  • Required string length: 1 - 55

The second line of the address.

  • Required string length: 1 - 55

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

  • Required string length: 2

The country subdivision code from Part 2 of ISO 3166.

  • Required string length: 1 - 3

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

  • Required string length: 5 - 9

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

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

Show attributes

The contact information.

Array item

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)

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.

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

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

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

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

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

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

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

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

The type of entity.

Payers may sometimes return other non-compliant values.

Possible values
Person
Non-Person Entity
Show attributes

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

Please use benefitsInformation.benefitsRelatedEntities instead.

Show attributes

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

Show attributes

The first line of the address.

  • Required string length: 1 - 55

The second line of the address.

  • Required string length: 1 - 55

The city.

  • Required string length: 2 - 30

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

  • Required string length: 2

The country subdivision code from Part 2 of ISO 3166.

  • Required string length: 1 - 3

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

  • Required string length: 5 - 9

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

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

Show attributes

The contact information.

Array item

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)

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.

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

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

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

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

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

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

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

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

The type of entity.

Payers may sometimes return other non-compliant values.

Possible values
Person
Non-Person Entity
Show attributes

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

The delivery or usage pattern for the benefits.

Array item

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

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

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

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.

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.

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

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

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

The name of the quantityQualifierCode. For example, Days.

Payers may sometimes return other non-compliant values.

Possible values
Days
Units
Hours
Month
Visits

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

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

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

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

The name of the unitForMeasurementQualifierCode. For example, Days.

Payers may sometimes return other non-compliant values.

Possible values
Days
Months
Visits
Week
Years

The name of the unitForMeasurementQualifierCode. For example, Days.

Payers may sometimes return other non-compliant values.

Possible values
Days
Months
Visits
Week
Years

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

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

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

Show attributes

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.

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

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.

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

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

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

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

Please use benefitsInformation.eligibilityAdditionalInformationList instead.

Show attributes

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

Payers may sometimes return other non-compliant values.

Possible values
44

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

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

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

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.

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

Array item

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

Payers may sometimes return other non-compliant values.

Possible values
44

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

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

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

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.

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

The name of the in-plan network indicator code.

Payers may sometimes return other non-compliant values.

Possible values
Yes
No
Unknown
Not Applicable

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

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

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

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

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.

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

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

An array of Service Type Codes related to the benefit type.

Possible values
1
2
3
4
5

The names of the service type codes listed in the serviceTypeCodes array.

Possible values
Medical Care
Surgical
Consultation
Diagnostic X-Ray
Diagnostic Lab

The name of the timeQualifierCode.

Payers may sometimes return other non-compliant values.

Possible values
Hour
Day
24 Hours
Years
Service Year

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

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

An identifier for the payer's response.

items[].dependentsarray<object>

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

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

The error code.

Payers may sometimes return other non-compliant values.

Possible values
15
33
35
42
43

The error type, AAA.

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

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

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.

Show attributes

The first line of the address.

  • Required string length: 1 - 55

The second line of the address.

  • Required string length: 1 - 55

The city.

  • Required string length: 2 - 30

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

  • Required string length: 2

The country subdivision code from Part 2 of ISO 3166.

  • Required string length: 1 - 3

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

  • Required string length: 5 - 9

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

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.

The member's date of birth.

  • Pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The military service date.

  • Pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

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

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

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

The military service end date.

  • Pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The entity identifier for the dependent.

Possible values
Dependent

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

The member's first name.

Code indicating the patient's gender.

Possible values
M
F
U

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

The group number associated with the insurance policy.

Information about the patient's healthcare diagnosis.

Array item

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

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.

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

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

Possible values
N

The member's last name.

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

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

The member ID for the insurance policy.

The member's middle name or initial.

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

The network identification number associated with the insurance policy.

The plan number associated with the insurance policy.

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

Possible values
Spouse
Child
Employee
Unknown
Organ Donor

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

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

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

The error code.

Payers may sometimes return other non-compliant values.

Possible values
15
41
43
44
45

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

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

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.

The provider's contact information.

Show attributes

The first line of the address.

  • Required string length: 1 - 55

The second line of the address.

  • Required string length: 1 - 55

The city.

  • Required string length: 2 - 30

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

  • Required string length: 2

The country subdivision code from Part 2 of ISO 3166.

  • Required string length: 1 - 3

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

  • Required string length: 5 - 9

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

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

A code identifying the type of provider.

Payers may sometimes return other non-compliant values.

Possible values
Provider
Third-Party Administrator
Employer
Hospital
Facility

The type of entity.

Payers may sometimes return other non-compliant values.

Possible values
Person
Non-Person Entity

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

  • Pattern: ^\d{9}$

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

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

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

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

The provider's organization name.

The Health Care Provider Taxonomy Code.

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

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

The Social Security Number (SSN).

  • Pattern: ^\d{9}$

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

The member's Social Security Number (SSN).

  • Pattern: ^\d{9}$

The military service start date.

  • Pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

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

The member's unique health identifier.

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.

items[].errorsarray<object>

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

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

The error description.

The error type, AAA.

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

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

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.

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

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

Show attributes

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

The biller ID Stedi assigns to this request.

The unique ID Stedi assigns to this request.

The sender ID Stedi assigns to this request.

The submitter ID Stedi assigns to this request.

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

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

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

The error code.

Payers may sometimes return other non-compliant values.

Possible values
04
41
42
79
80

The error description.

The error type, AAA.

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

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

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.

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

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

The contact information.

Array item

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)

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.

The name of the contact person.

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

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

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

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

The payer's federal taxpayer's identification number.

  • Pattern: ^\d{9}$

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

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

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

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

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

The payer's National Provider Identifier (NPI).

  • Pattern: ^\d{10}$

The payor identification.

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

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 date. Payers may return this information in the case of retroactive eligibility.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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]))?$

Additional identification for the subscriber's healthcare plan.

Show attributes

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

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

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

  • Pattern: ^\d{10}$

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

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

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

The drug formulary number

The electronic device pin number

The eligibility category

The facility ID number

The facility network identification number

The family unit number

The federal taxpayer's identification number

The group description

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.

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

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

The insurance policy number

The Medicaid provider number

The Medicaid recipient identification number

The medical assistance category

The medical record identification number

The Medicare provider number

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

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.

The personal identification number (PIN)

The plan description

The plan, group, or plan network name

The plan network identification number

The group or policy number

The prior authorization number

The prior identifier number

The social security number

The state license number

The submitter identification number

The user identification

items[].planStatusarray<object>deprecated

Please use benefitsInformation instead.

Array item

An array of Service Type Codes related to the benefit type.

Possible values
1
2
3
4
5

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

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

The error code.

Payers may sometimes return other non-compliant values.

Possible values
15
41
43
44
45

The error description.

The error type, AAA.

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

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

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.

The provider's contact information.

Show attributes

The first line of the address.

  • Required string length: 1 - 55

The second line of the address.

  • Required string length: 1 - 55

The city.

  • Required string length: 2 - 30

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

  • Required string length: 2

The country subdivision code from Part 2 of ISO 3166.

  • Required string length: 1 - 3

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

  • Required string length: 5 - 9

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

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

A code identifying the type of provider.

Payers may sometimes return other non-compliant values.

Possible values
Provider
Third-Party Administrator
Employer
Hospital
Facility

The type of entity.

Payers may sometimes return other non-compliant values.

Possible values
Person
Non-Person Entity

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

  • Pattern: ^\d{9}$

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

The provider's National Provider Identifier (NPI).

  • Pattern: ^\d{10}$

The Payor Identification.

The pharmacy processor number.

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

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

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

The provider's organization name.

The Health Care Provider Taxonomy Code.

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

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

The Social Security Number (SSN).

  • Pattern: ^\d{9}$

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

Deprecated; do not use.

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.

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

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

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

The error code.

Payers may sometimes return other non-compliant values.

Possible values
15
33
35
42
43

The error description.

The error type, AAA.

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

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

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.

Show attributes

The first line of the address.

  • Required string length: 1 - 55

The second line of the address.

  • Required string length: 1 - 55

The city.

  • Required string length: 2 - 30

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

  • Required string length: 2

The country subdivision code from Part 2 of ISO 3166.

  • Required string length: 1 - 3

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

  • Required string length: 5 - 9

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

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.

The member's date of birth.

  • Pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The military service date.

  • Pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

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

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

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

The military service end date.

  • Pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The entity identifier for the subscriber.

Possible values
Insured or Subscriber

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

The member's first name.

Code indicating the patient's gender.

Possible values
M
F
U

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

The group number associated with the insurance policy.

Information about the patient's healthcare diagnosis.

Array item

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

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.

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

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

Possible values
Y

The member's last name.

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

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

The member ID for the insurance policy.

The member's middle name or initial.

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

The network identification number associated with the insurance policy.

The plan number associated with the insurance policy.

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

Possible values
Self

For the subscriber, this is always 18 for Self.

Possible values
18

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

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

The error code.

Payers may sometimes return other non-compliant values.

Possible values
15
41
43
44
45

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

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

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.

The provider's contact information.

Show attributes

The first line of the address.

  • Required string length: 1 - 55

The second line of the address.

  • Required string length: 1 - 55

The city.

  • Required string length: 2 - 30

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

  • Required string length: 2

The country subdivision code from Part 2 of ISO 3166.

  • Required string length: 1 - 3

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

  • Required string length: 5 - 9

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

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

A code identifying the type of provider.

Payers may sometimes return other non-compliant values.

Possible values
Provider
Third-Party Administrator
Employer
Hospital
Facility

The type of entity.

Payers may sometimes return other non-compliant values.

Possible values
Person
Non-Person Entity

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

  • Pattern: ^\d{9}$

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

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

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

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

The provider's organization name.

The Health Care Provider Taxonomy Code.

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

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

The Social Security Number (SSN).

  • Pattern: ^\d{9}$

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

The member's Social Security Number (SSN).

  • Pattern: ^\d{9}$

The military service start date.

  • Pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

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

The member's unique health identifier.

A unique identifier the payer may assign to the transaction. Note that Stedi doesn't support setting a subscriber trace number in the eligibility check request because there is no need to include a trace number for real-time queries.

Array item

The identifier of the organization that assigned the trace number.

The unique trace number assigned to the transaction.

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

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

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).

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

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

items[].warningsarray<object>

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

Array item

The warning code.

The warning description.

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.

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.

  • Required string length: 1 - 1024