Healthcare
- Payers
- Transaction enrollment
- Eligibility checks
- Claim submission
- Claim status
- Remittances
EDI platform
- Generate EDI
- Transactions
- File Executions
- Fragments
- Mappings
- Events
Real-Time Eligibility Check
This endpoint sends real-time eligibility checks to payers. Visit Check eligibility for a full how-to guide.
- Call this endpoint with a JSON payload.
- Stedi translates your request to the X12 270 EDI format and sends it to the payer.
- The endpoint returns a synchronous response from the payer in both JSON and raw X12 EDI format. The response contains the patient’s eligibility and benefits information.
Test endpoint
When you submit specific mock requests, Stedi returns mock benefits data from the specified payer you can use for testing. You need a Stedi API key for authentication, and you must set the stedi-test header to true.
Mock requests are free for testing purposes and won’t incur any charges in your Stedi account.
Notes:
encounter: Only service type code30is supported.provider: You can use any organization name and any NPI, as long as it passes check digit validation. To generate a dummy NPI, you can use this free tool.subscriber: You must use the exact values in the test request. Other birthdates, first names, last names, and member IDs return errors.
curl --request POST \
--url 'https://healthcare.us.stedi.com/2024-04-01/change/medicalnetwork/eligibility/v3' \
--header 'Authorization: Key {api_key}' \
--header 'stedi-test: true' \
--header 'Content-Type: application/json' \
--data '{
"controlNumber":"123456789",
"tradingPartnerServiceId": "62308",
"provider": {
"organizationName": "Provider Name",
"npi": "0123456789"
},
"subscriber": {
"firstName": "James",
"lastName": "Jones",
"dateOfBirth": "19910202",
"memberId": "23456789100"
},
"encounter": {
"serviceTypeCodes": ["30"]
}
}'
Visit Send mock requests for additional mock requests.
Basic eligibility check
The content of your eligibility request depends on your use case and the payer’s requirements. However, a basic eligibility check includes the following information in the request body:
| Information | Description |
|---|---|
controlNumber | An integer used to identify the transaction. It does not need to be globally unique. |
tradingPartnerServiceId | You can find the payer ID in our list of supported payers. |
provider object, name | You must include the provider’s name - either the firstName and lastName of a specific provider within a practice or the organizationName. |
provider object, identifier | You must include an identifier. Most often this is the National Provider Identifier (NPI). The NPI is a unique, 10-digit identification number assigned to healthcare providers according to HIPAA standards. |
subscriber and/or dependents objects | At a minimum, our API requires that you supply at least one of these fields in the request: memberId, dateOfBirth, or lastName. However, each payer has different requirements, so you should supply the fields necessary for each payer to identify the subscriber in their system. When all four of memberId, dateOfBirth, firstName, and lastName are provided, payers are required to return a response if the member is in their database. Some payers may be able to search with less information, but this varies by payer. We recommend always including the patient’s member ID when possible. Learn more about patient information. |
encounter object, service dates | You can specify either a single dateOfService or a beginningDateOfService and endDateOfService. The payer defaults to using the current date in their timezone if you don’t include one. We recommend submitting dates up to 12 months in the past or up to the end of the current month. Dates outside of these ranges are likely to be rejected by many payers, since they may have archived older data and they cannot guarantee eligibility for future months. |
encounter object, service or procedure codes | Specify serviceTypeCodes and/or a procedureCode and productOrServiceIDQualifier to request specific types of benefits information. We don’t know which payers support multiple service type codes, so we recommend including no more than one in each request. If you do not include any of these fields, Stedi defaults to using 30 (Plan coverage and general benefits) as the only serviceTypeCodes value. Learn more about checking eligibility for specific services. |
Character restrictions
Don’t include the following characters in your request data: ~, *, : and ^. They are reserved for delimiters in the resulting X12 EDI transaction, and X12 doesn’t support using escape sequences to represent delimiters or special characters. Stedi returns a 400 error if you include these restricted characters in your request.
Only use the X12 Basic and Extended character sets in request data. Using characters outside these sets may cause validation and HTTP 400 errors.
The X12 Basic character set includes uppercase letters, digits, space, and some special characters. Lowercase letters and special language characters like ñ are not included.
The following special characters are included:
The Extended character set includes the characters listed in Basic, plus lowercase letters and additional special characters, such as @.
The following additional special characters are included:
Autocorrection
Stedi automatically replaces backticks (`), also known as backquotes or grave accents, with a single quote (') in subscriber and dependents first and last names. This autocorrection prevents errors when submitting your request to payers and intermediary clearinghouses. Stedi returns a message in the response’s warnings array when it makes this replacement.
Conditional requirements
Note that objects marked as required are required for all requests, while others are conditionally required depending on the circumstances. When you include a conditionally required object, you must include all of its required properties.
For example, you must always include the provider object in your request, but you only need to include the dependents object when you need to request benefits information for a dependent on the subscriber’s insurance plan.
Timeout and Concurrency
Requests to payers typically time out at 1 minute, though Stedi can keep connections open longer than that if needed.
Our real-time eligibility check endpoint has rate limiting on a per-account basis. This limit is based on concurrent requests, not requests per second. The default rate limit is 5 concurrent requests; if you need a higher limit, reach out to Support.
Insurance payers may take up to 60 seconds to respond to a request, so your transactions per second (and thus your concurrency limit) will vary based on the payer response time. If you reach the maximum concurrency limit, Stedi rejects additional requests with a 429 HTTP code until one of your previous requests is completed. Rejected requests have the following error message:
{
"message": "The request can't be submitted because the sender's submission has been throttled: CUSTOMER_LIMIT",
"code": "TOO_MANY_REQUESTS",
"eligibilitySearchId": "019249c7-e176-76b0-a46a-3aef1a519bc4"
}
Benefit response
Visit Payer benefit response for definitions of key benefit types and information about how to interpret benefits requirements such as prior authorization and referrals.
Network status: The response provides information about the patient’s general in and out-of-network coverage. It does not confirm whether a particular provider is in or out-of-network. To determine network status, you must check directly with the payer. Note that payers may have different networks for different health plans, such as employer-sponsored plans versus Medicare.
Troubleshooting
For a list of possible errors and resolution steps, visit Errors and resolutions.
Authorizations
A Stedi API Key for authentication.
Body
MedicalEligibility
An integer to identify the transaction. It doesn't need to be globally unique.
1 - 9This is the Payer ID. Visit the Payer Network for a complete list. You can send requests using the Primary Payer ID, the Stedi Payer ID, or any alias listed in the payer record.
1 - 80The primary policyholder for the insurance plan or a dependent with a unique member ID. If a dependent has a unique member ID, include their information here and leave dependents empty.
- At a minimum, our API requires that you supply at least one of these fields in the request:
memberId,dateOfBirth, orlastName. However, each payer has different requirements, so you should supply the fields necessary for each payer to identify the subscriber in their system. - When you provide all four of
memberId,dateOfBirth,firstName, andlastName, payers are required to return a response if the member is in their database. Some payers may be able to search with less information, but this varies by payer. - We recommend always including the patient's member ID when possible.
The number assigned to each family member born with the same birth date, such as twins or triplets. Use to indicate the birth order when there are multiple births associated with the provided birth date.
1 - 9The case number associated with the subscriber.
1 - 50The Medicaid Recipient Identification Number. You can provide this number to identify the subscriber when it is the primary number the payer knows a member by (such as for Medicare or Medicaid). Do not supply this value unless it is different from the memberId.
1 - 50Identify the dollar amount the subscriber will apply toward their spend down amount, if required. For some Medicaid programs, individuals must pay a certain amount towards their healthcare cost (spend down) before coverage starts.
1 - 15The subscriber's spend down total billed amount.
1 - 15This property is no longer used.
The member ID for the subscriber's insurance policy.
2 - 80The patient's first name. Can be 0-35 alphanumeric characters.
1 - 35The patient's middle name or middle initial. Can be 0-25 alphanumeric characters.
1 - 25The subscriber's last name. Can be 0-60 alphanumeric characters.
1 - 60The name suffix, such as Jr., Sr., or III. Can be 0-10 alphanumeric characters.
1 - 10Code indiciating the subscriber's gender.
M, F The subscriber's date of birth in YYYYMMDD format.
The subscriber's Social Security Number (SSN). Many commercial and government payers ignore this property due to concerns about member privacy. However, some Medicaid programs support alternative searches using the patient's Social Security Number, instead of the member ID.
1 - 11The group number associated with the subscriber's insurance policy.
1 - 50The subscriber's identification card number. Include this property when this number is different than the subscriber's member ID. This is common in Medicaid.
1 - 50Use this for providers that are not requesting the eligibility check - the requestor is specified in the provider object. For example, if you are a hospital making an eligibility request, this is where you would specify information about a referring provider's role.
You can use one of the following: AD - Admitting, AT - Attending, BI - Billing, CO - Consulting, CV - Covering, H - Hospital, HH - Home Health Care, LA - Laboratory, OT - Other Physician, P1 - Pharmacist, P2 - Pharmacy, PC - Primary Care Physician, PE - Performing, R - Rural Health Clinic, RF - Referring, SB - Submitting, SK - Skilled Nursing Facility, SU - Supervising
AD, AT, BI, CO, CV, H, HH, LA, OT, P1, P2, PC, PE, R, RF, SK, SU Use this for providers that are not requesting the eligibility check. This is the type of providerIdentifier you are providing.
- Set to
HPIwhen the National Provider ID is mandated for use. - Set to
PXCif you're identifying a type of specialty associated with services provided to the subscriber.
Otherwise, you can set to the following: 9K - Servicer, D3 - National Council for Prescription Drug Programs Pharmacy Number, EI - Employer's Identification Number, HPI - Centers for Medicare and Medicaid Services National Provider Identifier, PXC - Health Care Provider Taxonomy Code, SY - Social Security Number, TJ` - Federal Taxpayer's Identification Number
9K, D3, EI, HPI, PXC, SY, TJ The provider identifier you specified in the referenceIdentificationQualifier property. For example, the provider's National Provider ID or Federal Taxpayer Identification number. If you set the referenceIdentificationQualifier to PXC, then this property should contain the provider's taxonomy code.
1 - 50Deprecated; The date the subscriber's identification card was issued, expressed in YYYYMMDD format. This shape is deprecated: This property is no longer used.
Deprecated; The date the subscriber's identification card expires, expressed in YYYYMMDD format. This shape is deprecated: This property is no longer used.
Deprecated; The date the subscriber's identification card was issued, expressed in YYYYMMDD format. This shape is deprecated: This property is no longer used.
Deprecated; The date the subscriber's insurance plan was issued, expressed in YYYYMMDD format. This shape is deprecated: This property is no longer used.
Deprecated; The date the subscriber's insurance plan was issued, expressed in YYYYMMDD format. This shape is deprecated: This property is no longer used.
Deprecated; The date the subscriber's insurance plan ended, expressed in YYYYMMDD format. This shape is deprecated: This property is no longer used.
Information about the subscriber's health care diagnosis.
The type of diagnosis code you are providing. You can set to BK - International Classification of Diseases Clinical Modification (ICD-9-CM) Principal Diagnosis, ABK - International Classification of Diseases Clinical Modification (ICD-10-CM) Principal Diagnosis, BF- International Classification of Diseases Clinical Modification (ICD-9-CM) Diagnosis, or ABF- International Classification of Diseases Clinical Modification (ICD-10-CM) Diagnosis
BK, ABK, BF, ABF The diagnosis code. Omit the decimal points in diagnosis codes - the decimal point is assumed.
1 - 30The subscriber's address. You must include at least the address1 and city properties in this object.
The first line of the address.
1 - 55The second line of the address.
1 - 55The city.
2 - 30The state code. For example, TN for Tennessee or WA for Washington.
2The United States postal code, excluding punctuation and blanks.
3 - 15The country code. Use the alpha-2 country codes from Part 1 of ISO 3166.
2 - 3The country subdivision code. Use the country subdivision codes from Part 2 of ISO 3166.
1 - 3Use this object when you need to provide an identification number other than or in addition to the member ID. For example, you may provide the patient account number. Don't include the health insurance claim number or the medicaid recipient ID number here unless they are different from the member ID.
The insurance plan number.
1 - 50The insurance group or policy number.
1 - 50The member identification number. Use only when checking eligibility with a Workers' Compensation or Property and Casualty insurer.
1 - 50The contract number for an existing contract between the payer and the provider requesting the eligibility check.
1 - 50The medical record identification number.
1 - 50The patient account number.
1 - 50The health insurance claim number.
1 - 50The identification card serial number. You can include this when the ID card has a number in addition to the member ID number. The Identification Card Serial Number uniquely identifies the card when multiple cards have been or will be issued to a member, such as a replacement card.
1 - 50The insurance policy number.
1 - 50The plan network identification number.
1 - 50The Property and Casualty Claim Number associated with the patient. You should only submit this value when when you are submitting an eligibility request to a property and casualty payer.
1 - 50Information about the entity requesting the eligibility check. This may be an individual practitioner, a medical group, a hospital, or another type of healthcare provider.
- You must provide the
organizationName(if the entity is an organization), orfirstNameandlastName(if the provider is an individual). - You must also provide an identifier - this is typically the provider's National Provider ID (
npi). If the provider doesn't have an NPI, you can supply theirtaxIdorssn. - You shouldn't include additional properties, such as
taxIdoraddress, unless they are specifically required or suggested by the payer.
The provider's business name. This property is required if the provider is not a person.
1 - 60The provider's first name. This property is required if the provider is an individual.
1 - 35The provider's last name. This property is required if the provider is an individual.
1 - 60The provider's National Provider Identifier (NPI). This identifier is required for all healthcare providers who are eligible to receive an NPI. Some non-traditional providers such as transportation services, durable medical equipment (DME) suppliers, or alternative medicine practitioners are not eligible to receive an NPI. If the provider doesn't have an NPI, you can supply either their taxId or ssn.
2 - 80The provider's service provider number. Only include when the provider doesn't have an NPI. This is typically when the provider is a non-medical provider, such as a social worker, home health aide, or transportation service.
2 - 80Only used for payer-to-payer transactions, which are not currently supported. Do not use.
2 - 80The provider's Federal Taxpayer Identification Number (also known as an EIN).
2 - 80The provider's Social Security Number (SSN). - Only include when the provider doesn't have an NPI. This is typically when the provider is a non-medical provider, such as a social worker, home health aide, or transportation service. - Don't use this for Federally-administered programs, such as Medicare.
2 - 80The provider's pharmacy processor number. Only include when the provider doesn't have an NPI. This is typically when the provider is a non-medical provider, such as a social worker, home health aide, or transportation service.
2 - 80This shape is deprecated.
2 - 80Deprecated; The submitter's Employer's Identification Number (EIN). Only use when an employer is checking the eligibility and benefits of their employees. This shape is deprecated: This property is no longer used.
2 - 80Communicate the provider's role in the type of benefits specified in the request. For example, you could set this to RF if the provider is also the referring provider.
You can use one of the following: AD - Admitting, AT - Attending, BI - Billing, CO - Consulting, CV - Covering, H - Hospital, HH - Home Health Care, LA - Laboratory, OT - Other Physician, P1 - Pharmacist, P2 - Pharmacy, PC - Primary Care Physician, PE - Performing, R - Rural Health Clinic, RF - Referring, SB - Submitting, SK - Skilled Nursing Facility, SU - Supervising
AD, AT, BI, CO, CV, H, HH, LA, OT, P1, P2, PC, PE, R, RF, SB, SK, SU The provider's Taxonomy Code. Only used when the provider's taxonomy code is relevant to the eligibility/benefit inquiry. For example, an institutional provider such as a hospital may need to use a taxonomy code to specify a specific unit or department.
Identify the type of provider.
payer, third-party administrator, employer, hospital, facility, gateway provider, plan sponsor, provider The provider's state license number. If you include this information, you must also include the informationReceiverAdditionalIdentifierState.
1 - 50The provider's Medicare provider number.
1 - 50The provider's Medicaid provider number.
1 - 50The ID number for the provider's facility.
1 - 50The provider's contract number.
1 - 50The provider's electronic device pin number.
1 - 50The provider's submitter identification number.
1 - 50The provider's plan network identification number.
1 - 50The provider's facility network identification number.
1 - 50The provider's prior identifier number.
1 - 50The two-character state ID of the state that assigned the stateLicenseNumber.
1 - 80The address of the provider requesting the information. This is required when the provider has multiple locations and you need to identify the specific location making the request. You must include at least the address1 and city properties in this object.
The first line of the address.
1 - 55The second line of the address.
1 - 55The city.
2 - 30The state code. For example, TN for Tennessee or WA for Washington.
2The United States postal code, excluding punctuation and blanks.
3 - 15The country code. Use the alpha-2 country codes from Part 1 of ISO 3166.
2 - 3The country subdivision code. Use the country subdivision codes from Part 2 of ISO 3166.
1 - 3An internal ID or other value that you use to track the eligibility check within your company's business system. You can use any string value up to 50 characters.
The payer's name, such as Cigna or Aetna.
1 - 80The username that the provider uses to log in to the payer's portal. This is not commonly used.
1 - 50The password that the provider uses to log in to the payer's portal. This is not commonly used.
1 - 50Details about the eligibility or benefit information you are requesting for the patient.
- If you don't specify a service date (either a single day or a range of dates), the payer defaults to using the current date in their timezone.
- If you don't specify either
serviceTypeCodesor aprocedureCodeandproductOrServiceIDQualifier, Stedi defaults to using30(Plan coverage and general benefits) as the onlyserviceTypeCodesvalue. - We recommend submitting dates up to 12 months in the past or up to the end of the current month. Dates outside of these ranges are likely to be rejected by many payers, since they may have archived older data and they cannot guarantee eligibility for future months.
- Payers can have different rules for future dates of service - for example, some payers may only return benefits information for dates up to the end of the current calendar month, but others may support dates further into the future.
The beginning date of service, formatted as YYYYMMDD. If you include this value, you must also include the endDateOfService.
The end date of service, formatted as YYYYMMDD. If you include this value, you must also include the beginningDateOfService.
The date of service, formatted as YYYYMMDD. You can use this value to specify a single occasion, such as a doctor's visit. If you don't specify a service date (either a single day or a range of dates), the payer defaults to using the current date in their timezone.
One or more codes classifying the type of services for which you want to receive benefits information.
If you do not specify a service type code or a procedureCode and productOrServiceIDQualifier, Stedi defaults to using 30 - Health Benefit Plan Coverage. Visit Service Type Codes for a complete list.
Note that not all payers support all service type codes, and not all payers support multiple service type codes in the same request. We recommend including one service type code per request unless you're sure the payer supports multiple.
1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 30, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, AA, AB, AC, AD, AE, AF, AG, AH, AI, AJ, AK, AL, AM, AN, AO, AQ, AR, B1, B2, B3, BA, BB, BC, BD, BE, BF, BG, BH, BI, BJ, BK, BL, BM, BN, BP, BQ, BR, BS, BT, BU, BV, BW, BX, BY, BZ, C1, CA, CB, CC, CD, CE, CF, CG, CH, CI, CJ, CK, CL, CM, CN, CO, CP, CQ, DG, DM, DS, GF, GN, GY, IC, MH, NI, ON, PT, PU, RN, RT, TC, TN, UC The prior authorization or referral number for a particular benefit or procedure.
The type of information you provided in the priorAuthorizationOrReferralNumber property. You can set this to 9F - Referral Number or G1 - Prior Authorization Number.
9F, G1 The type of facility where the service was provided. You can set this to one of the place of service codes.
01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 31, 32, 33, 34, 41, 42, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 60, 61, 62, 65, 71, 72, 81, 99 Code identifying the type/source of the procedureCode. You can set this to AD - American Dental Association Codes, 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.
AD, CJ, HC, ID, IV, N4, ZZ The procedure code.
1 - 48The procedure modifier that provides additional information related to the performance of the service.
Diagnosis code pointers in order of importance to the service. These pointers are an index to the ICD-10 codes you included in the subscriber.healthCareCodeInformation or dependents.healthCareCodeInformation object arrays. The pointer values can be from 1 - 8 (integer numbers). If you are including diagnosis codes, you must set at least one pointer here for the primary diagnosis. Then, you can add up to three additional pointers (up to four in total). Don't put ICD-10 codes here.
Use only when you need to send multiple procedure codes in a single request. Otherwise, use the encounter.procedureCode and encounter.productOrServiceIDQualifier properties.
Code identifying the type/source of the procedureCode. You can set this to AD - American Dental Association Codes, 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.
AD, CJ, HC, ID, IV, N4, ZZ The procedure code.
1 - 48Procedure modifiers that provide additional information related to the service.
The diagnosis code pointer.
A unique identifier for the patient that Stedi uses to identify and correlate historical eligibility checks for the same individual. We recommend including this value in all requests.
The unique identifier for the eligibility search being edited and 'retried'.
Use the corresponding properties in the provider object instead.
This shape is deprecated.
This shape is deprecated.
1 - 50This shape is deprecated.
1 - 50The provider's Medicaid provider number.
1 - 50This shape is deprecated.
1 - 50This shape is deprecated.
1 - 50This shape is deprecated.
1 - 50This shape is deprecated.
1 - 50This shape is deprecated.
1 - 50This shape is deprecated.
1 - 50This shape is deprecated.
1 - 50This shape is deprecated.
1 - 50This shape is deprecated.
1 - 50This shape is deprecated.
1 - 50This shape is deprecated.
1 - 80This shape is deprecated.
The first line of the address.
1 - 55The second line of the address.
1 - 55The city.
2 - 30The state code. For example, TN for Tennessee or WA for Washington.
2The United States postal code, excluding punctuation and blanks.
3 - 15The country code. Use the alpha-2 country codes from Part 1 of ISO 3166.
2 - 3The country subdivision code. Use the country subdivision codes from Part 2 of ISO 3166.
1 - 3A dependent for which you want to retrieve benefits information.
- You can only submit one dependent per eligibility check.
- An individual qualifies as a dependent for eligibility checks when they are listed as a dependent on the subscriber's insurance plan AND the payer cannot uniquely identify them through information outside the subscriber's policy. For example, if the dependent has their own member ID number, you should identify them in the
subscriberobject instead. - Each payer has different requirements, so you should supply the fields necessary for each payer to identify the dependent in their system. However, we strongly recommend including the dependent's date of birth in the request when available because many payers return errors without it.
The number assigned to each family member born with the same birth date, such as twins or triplets. Use to indicate the birth order when there are multiple births associated with the provided birth date.
1 - 9The dependent's relationship to the subscriber. You can set this to 01 - Spouse, 19 - Child, 34 - Other Adult.
01, 19, 34 The issue number for the dependent's insurance policy.
1 - 50The eligibility category for the dependent.
1 - 50Only use for property and casualty use cases when the property and casualty patient identifier is a member ID and would be used in an 837 healthcare claim submission.
2 - 80The dependent's first name. Can be 0-35 alphanumeric characters.
1 - 35The dependent's middle name or middle initial. Can be 0-25 alphanumeric characters.
1 - 25The dependent's last name. Can be 0-60 alphanumeric characters.
1 - 60The dependent's name suffix, such as Sr. or III. Can be 0-10 alphanumeric characters.
1 - 10Code indicating the dependent's gender.
M, F The dependent's date of birth (DOB) in YYYYMMDD format. We strongly recommend including the DOB in your request. Many payers need this information to identify the patient in their system and will immediately return an error when it's not provided.
The dependent's social security number. Can be 0-50 alphanumeric characters. Don't use this for Federally-administered programs, such as Medicare.
1 - 11The group number for the dependent's insurance plan. Can be 0-50 alphanumeric characters.
1 - 50The dependent's insurance card number.
1 - 50Use this for providers that are not requesting the eligibility check - the requestor is specified in the provider object. For example, if you are a hospital making an eligibility request, this is where you would specify information about a referring provider's role.
You can use one of the following: AD - Admitting, AT - Attending, BI - Billing, CO - Consulting, CV - Covering, H - Hospital, HH - Home Health Care, LA - Laboratory, OT - Other Physician, P1 - Pharmacist, P2 - Pharmacy, PC - Primary Care Physician, PE- Performing, R- Rural Health Clinic, RF - Referring, SB - Submitting, SK - Skilled Nursing Facility, SU - Supervising
AD, AT, BI, CO, CV, H, HH, LA, OT, P1, P2, PC, PE, R, RF, SK, SU The type of providerIdentifier you are using. Use for providers that are not requesting the eligiblity check, such as the referring provider.
- Set to
HPIwhen the National Provider ID is mandated for use. - Set to
PXCif you're identifying a type of specialty associated with services provided to the dependent.
Otherwise, you can set to the following: 9K - Servicer, D3 - National Council for Prescription Drug Programs Pharmacy Number, EI - Employer's Identification Number, HPI - Centers for Medicare and Medicaid Services National Provider Identifier, PXC - Health Care Provider Taxonomy Code, SY - Social Security Number, TJ - Federal Taxpayer's Identification Number
9K, D3, EI, HPI, PXC, SY, TJ The provider identifier you specified in the referenceIdentificationQualifier property. For example, the provider's National Provider ID or Federal Taxpayer Identification number. If you set the referenceIdentificationQualifier to PXC, then this property should contain the provider's taxonomy code.
1 - 50Deprecated; The date the insurance card was issued, expressed in YYYYMMDD format. This shape is deprecated: This property is no longer used.
Deprecated; The date the insurance card expires, expressed in YYYYMMDD format. This shape is deprecated: This property is no longer used.
Deprecated; The date the identification card was issued, expressed in YYYYMMDD format. This shape is deprecated: This property is no longer used.
Deprecated; The date the insurance plan was issued, expressed in YYYYMMDD format. This shape is deprecated: This property is no longer used.
Deprecated; The date the insurance plan begins, expressed in YYYYMMDD format. This shape is deprecated: This property is no longer used.
Deprecated; The date the insurance plan ends, expressed in YYYYMMDD format. This shape is deprecated: This property is no longer used.
Information about the dependent's health care diagnosis.
The type of diagnosis code you are providing. You can set to BK - International Classification of Diseases Clinical Modification (ICD-9-CM) Principal Diagnosis, ABK - International Classification of Diseases Clinical Modification (ICD-10-CM) Principal Diagnosis, BF- International Classification of Diseases Clinical Modification (ICD-9-CM) Diagnosis, or ABF- International Classification of Diseases Clinical Modification (ICD-10-CM) Diagnosis
BK, ABK, BF, ABF The diagnosis code. Omit the decimal points in diagnosis codes - the decimal point is assumed.
1 - 30The dependent's address. You must include at least the address1 and city properties in this object.
The first line of the address.
1 - 55The second line of the address.
1 - 55The city.
2 - 30The state code. For example, TN for Tennessee or WA for Washington.
2The United States postal code, excluding punctuation and blanks.
3 - 15The country code. Use the alpha-2 country codes from Part 1 of ISO 3166.
2 - 3The country subdivision code. Use the country subdivision codes from Part 2 of ISO 3166.
1 - 3Use this object when you need to provide an identification number other than or in addition to the member ID. For example, you may provide the patient account number. Don't include the health insurance claim number or the medicaid recipient ID number here unless they are different from the member ID.
The insurance plan number.
1 - 50The insurance group or policy number.
1 - 50The member identification number. Use only when checking eligibility with a Workers' Compensation or Property and Casualty insurer.
1 - 50The contract number for an existing contract between the payer and the provider requesting the eligibility check.
1 - 50The medical record identification number.
1 - 50The patient account number.
1 - 50The health insurance claim number.
1 - 50The identification card serial number. You can include this when the ID card has a number in addition to the member ID number. The Identification Card Serial Number uniquely identifies the card when multiple cards have been or will be issued to a member, such as a replacement card.
1 - 50The insurance policy number.
1 - 50The plan network identification number.
1 - 50The Property and Casualty Claim Number associated with the patient. You should only submit this value when when you are submitting an eligibility request to a property and casualty payer.
1 - 50Response
Metadata about the response. Stedi uses this data for tracking and troubleshooting.
The sender ID Stedi assigns to this request.
The submitter ID Stedi assigns to this request.
The biller ID Stedi assigns to this request.
The type of data in the request. This is always production.
The unique ID Stedi assigns to this request.
The value provided in the submitterTransactionIdentifier property in the original eligibility check request.
An identifier for the payer's response.
Deprecated; do not use.
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.
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.
The provider's last name. This applies to providers that are an individual.
The provider's first name. This applies to providers that are an individual.
The provider's organization name.
The provider's middle name. This applies to providers that are an individual.
The provider's name suffix, such as Jr., Sr., or III.
A code identifying the type of provider. Can be Provider, Third-Party Administrator, Employer, Hospital, Facility, Gateway Provider, Plan Sponsor, or Payer.
The type of entity. Can be Person or Non-Person Entity.
The provider's National Provider Identifier (NPI).
A code that communicates the provider's role in the type of benefits information in the response.
Can be one of the following: AD - Admitting, AT - Attending, BI - Billing, CO - Consulting, CV - Covering, H - Hospital, HH - Home Health Care, LA - Laboratory, OT - Other Physician, P1 - Pharmacist, P2 - Pharmacy, PC - Primary Care Physician, PE - Performing, R - Rural Health Clinic, RF - Referring, SB - Submitting, SK - Skilled Nursing Facility, SU - Supervising.
The Health Care Provider Taxonomy Code.
Deprecated; The Employer's Identification Number (EIN). Only used when an employer is checking the eligibility and benefits of their employees. This shape is deprecated: This property is no longer used.
The Social Security Number (SSN).
The Federal Taxpayer Identification Number (also known as an EIN).
The Payor Identification.
The pharmacy processor number.
The service provider number. This is an identification number assigned by the payer.
The Centers for Medicare and Medicaid Services (CMS) Plan ID.
The provider's contact information.
The first line of the address.
1 - 55The second line of the address.
1 - 55The city.
2 - 30The state code. For example, TN for Tennessee or WA for Washington.
2The United States postal code, excluding punctuation and blanks.
3 - 15The country code. Use the alpha-2 country codes from Part 1 of ISO 3166.
2 - 3The country subdivision code. Use the country subdivision codes from Part 2 of ISO 3166.
1 - 3When 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
The error type, AAA.
The error code.
The error description.
Allowed actions you can take, based on the rejection reason code. For example Please Correct and Resubmit.
The location of the error within the original X12 EDI response.
Information to help you correct the error.
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.
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 diagnosis code. The decimal points are omitted in diagnosis codes - the decimal point is assumed.
The member ID for the subscriber's insurance policy.
The subscriber's first name.
The subscriber's last name.
The subscriber's middle name or initial.
The name suffix, such as Jr., Sr., or III.
Code indiciating the patient's gender. Can be F - Female, M - Male, or U - Unknown.
M, F, U The entity identifier for the subscriber. This is always set to IL - Insured or Subscriber.
The entity type for the subscriber. It can technically be set to Person or Non-Person Entity. In practice, our customers only receive Person.
The subscriber's unique health identifier.
The subscriber's date of birth, formatted as YYYYMMDD.
The status of the subscriber's information, used to report military service data. Can be set to A - Partial, C - Current, L - Latest, O - Oldest, P - Prior, S - Second Most Current, or T - Third Most Current.
The subscriber's employment status code, used to report military service data. Can be set to AE - Active Reserve, AO - Active Military - Overseas, AS - Academy Student, AT - Presidential Appointee, AU - Active Military - USA, CC - Contractor, DD - Dishonorably Discharged, HD - Honorably Discharged, IR - Inactive Reserves, LX - Leave of Absence: Military, PE - Plan to Enlist, RE - Recommissioned, RM - Retired Military - Overseas, RR- Retired Without Recall, or RU - Retired Military - USA.
The subscriber's government service affiliation code, used to report military service data. Can be set to A - Air Force, B - Air Force Reserves, C - Army, D - Army Reserves, E - Coast Guard, F - Marine Corps, G - Marine Corps Reserves, H - National Guard, I - Navy, J - Navy Reserves, K - Other, L- Peace Corp, M - Regular Armed Forces, N - Reserves, O - U.S. Public Health Service, Q - Foreign Military, R - American Red Cross, S - Department of Defense, U - United States Organization, W - Military Sealift Command.
Context that identifies the exact military unit. Used to report military service data.
The subscriber's military service rank code. Can be set to A1 - Admiral, A2 - Airman, A3 - Airman First Class, B1 - Basic Airman, B2 - Brigadier General, C1 - Captain, C2 - Chief Master Sergeant, C3 - Chief Petty Officer, C4 - Chief Warrant, C5 - Colonel, C6 - Commander, C7 - Commodore, C8 - Corporal, C9 - Corporal Specialist 4, E1 - Ensign, F1 - First Lieutenant, F2 - First Sergeant, F3 - First Sergeant-Master Sergeant, F4 - Fleet Admiral, G1 - General, G4 - Gunnery Sergeant, L1 - Lance Corporal, L2 - Lieutenant, L3 - Lieutenant Colonel, L4 - Lieutenant Commander, L5 - Lieutenant General, L6 - Lieutenant Junior Grade, M1 - Major, M2 - Major General, M3 - Master Chief Petty Officer, M4 - Master Gunnery Sergeant Major, M5 - Master Sergeant, M6 - Master Sergeant Specialist 8, P1 - Petty Officer First Class, P2 - Petty Officer Second Class, P3 - Petty Officer Third Class, P4 - Private, P5 - Private First Class, R1 - Rear Admiral, R2 - Recruit, S1 - Seaman, S2 - Seaman Apprentice, S3 - Seaman Recruit, S4 - Second Lieutenant, S5 - Senior Chief Petty Officer, S6 - Senior Master Sergeant, S7 - Sergeant, S8 - Sergeant First Class Specialist 7, S9 - Sergeant Major Specialist 9, SA - Sergeant Specialist 5, SB - Staff Sergeant, SC - Staff Sergeant Specialist 6, T1 - Technical Sergeant, V1 - Vice Admiral, W1 - Warrant Officer.
The format of the military service date and time period. Can be set to D8 - Date or RD8 - Range of Dates.
The military service date, formatted as YYYYMMDD.
The military service start date, formatted as YYYYMMDD.
The military service end date, formatted as YYYYMMDD.
The subscriber's Social Security Number (SSN).
The group number associated with the subscriber's insurance policy.
The plan number associated with the subscriber's insurance policy.
The network identification number associated with the subscriber's insurance policy.
The name of the relationToSubscriberCode. For the subscriber, this is always Self.
For the subscriber, this is always 18 for Self.
Indicates the status of the insured. For the subscriber, this is always Y.
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 - Change.
Code identifying the reason for the changes to subscriber identifying information, such as name, date of birth, or address. This is always 25 - Change in Identifying Data Elements.
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 first line of the address.
1 - 55The second line of the address.
1 - 55The city.
2 - 30The state code. For example, TN for Tennessee or WA for Washington.
2The United States postal code, excluding punctuation and blanks.
3 - 15The country code. Use the alpha-2 country codes from Part 1 of ISO 3166.
2 - 3The country subdivision code. Use the country subdivision codes from Part 2 of ISO 3166.
1 - 3Information 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.
The provider's last name. This applies to providers that are an individual.
The provider's first name. This applies to providers that are an individual.
The provider's organization name.
The provider's middle name. This applies to providers that are an individual.
The provider's name suffix, such as Jr., Sr., or III.
A code identifying the type of provider. Can be Provider, Third-Party Administrator, Employer, Hospital, Facility, Gateway Provider, Plan Sponsor, or Payer.
The type of entity. Can be Person or Non-Person Entity.
The provider's National Provider Identifier (NPI).
A code that communicates the provider's role in the type of benefits information in the response.
Can be one of the following: AD - Admitting, AT - Attending, BI - Billing, CO - Consulting, CV - Covering, H - Hospital, HH - Home Health Care, LA - Laboratory, OT - Other Physician, P1 - Pharmacist, P2 - Pharmacy, PC - Primary Care Physician, PE - Performing, R - Rural Health Clinic, RF - Referring, SB - Submitting, SK - Skilled Nursing Facility, SU - Supervising.
The Health Care Provider Taxonomy Code.
Deprecated; The Employer's Identification Number (EIN). Only used when an employer is checking the eligibility and benefits of their employees. This shape is deprecated: This property is no longer used.
The Social Security Number (SSN).
The Federal Taxpayer Identification Number (also known as an EIN).
The Payor Identification.
The pharmacy processor number.
The service provider number. This is an identification number assigned by the payer.
The Centers for Medicare and Medicaid Services (CMS) Plan ID.
The provider's contact information.
The first line of the address.
1 - 55The second line of the address.
1 - 55The city.
2 - 30The state code. For example, TN for Tennessee or WA for Washington.
2The United States postal code, excluding punctuation and blanks.
3 - 15The country code. Use the alpha-2 country codes from Part 1 of ISO 3166.
2 - 3The country subdivision code. Use the country subdivision codes from Part 2 of ISO 3166.
1 - 3When 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
The error type, AAA.
The error code.
The error description.
Allowed actions you can take, based on the rejection reason code. For example Please Correct and Resubmit.
The location of the error within the original X12 EDI response.
Information to help you correct the error.
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. Learn more
The error type, AAA.
The error code.
The error description.
Allowed actions you can take, based on the rejection reason code. For example Please Correct and Resubmit.
The location of the error within the original X12 EDI response.
Information to help you correct the error.
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.
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).
The full name of the traceTypeCode. For example Current Transaction Trace Numbers.
The unique trace number assigned to the transaction.
The identifier of the organization that assigned the trace number.
Identifies a subdivision within the organization that assigned the trace number.
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.
The entity identifier code for the payer. Can be 2B - Third-Party Administrator, 36 - Employer, GP - Gateway Provider, P5 Plan Sponsor, or PR - Payer.
The entity type qualifier for the payer. Can be set to 1 - Person (not commonly used) or 2 - Non-Person Entity (most common).
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 business name, when the payer is not a person.
The payer's middle name or initial, when the payer is an individual (not commonly used).
The payer's name suffix, such as Jr. or III. Used when the payer is an individual (not commonly used).
Deprecated; The payer's identification number for the entity receiving the benefits information.
The payer's federal taxpayer's identification number.
The payer's National Association of Insurance Commissioners (NAIC) identification number.
The payer's National Provider Identifier (NPI).
The payer's Centers for Medicare and Medicaid Services PlanID.
The payor identification.
The payer's contact information.
The name of the contact person.
The contact information.
The type of communication number provided. Can be ED - Electronic Data Interchange Access Number, EM - Electronic Mail, FX - Facsimile, TE - Telephone, or UR - 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.
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
The error type, AAA.
The error code.
The error description.
Allowed actions you can take, based on the rejection reason code. For example Please Correct and Resubmit.
The location of the error within the original X12 EDI response.
Information to help you correct the error.
The payer's Electronic Transmitter Identification Number (ETIN).
Additional identification for the subscriber's healthcare plan.
The state license number
The Medicare provider number
The Medicaid provider number
The facility ID number
The personal identification number (PIN)
The plan number
The plan description
The group or policy number
The member identification number - only used when checking eligibility with a Workers' Compensation or Property and Casualty insurer.
The case number
The family unit number
The group number
The group description
The referral number
The alternative list ID - identifies a list of alternative drugs with the associated formulary status for the patient.
The class of contract code - used to identify the applicable class of contract for claims processing.
The coverage list ID - identifies a list of drugs that have coverage limitations for the patient.
The contract number of a contract between the payer and the provider that requested the eligibility check.
The medical record identification number
The electronic device pin number
The submitter identification number
The patient account number. If you included this value in the original eligibility request, the payer will return the same value here in the response.
The health insurance claim number
The drug formulary number
The prior authorization 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 identity card number, used when the Identity Card Number is different than the Member Identification Number.
The National Provider Identifier (NPI) assigned by the Centers for Medicare and Medicaid Services
The issue number
The insurance policy number
The user identification
The medical assistance category
The eligibility category
The plan network identification number
The plan, group, or plan network name
The facility network identification number
The Medicaid recipient identification number
The prior identifier number
The social security number
The federal taxpayer's identification number
The agency claim number, only used when the information source is a Property and Casualty payer.
Contains the dates associated with the subscriber's insurance plan. This information is used to determine the patient's eligibility for benefits.
- All dates are formatted as YYYYMMDD (for single dates) or as YYYYMMDD-YYYYMMDD (for date ranges).
- Properties contain a single date unless otherwise noted.
- The provided dates apply to every every benefit within the patient's health plan unless specifically noted within a
benefitsInformation.benefitsDateInformationobject. - Most payers return either
planorplanBeginandplanEnd, but the exact dates returned depend on the payer's discretion and the patient's insurance plan.
Can be formatted either a single date, or as a range of dates in YYYYMMDD-YYYYMMDD format.
Can be formatted as a single date or as a range of dates in YYYYMMDD-YYYYMMDD format.
Can be formatted as a single date or as a range of dates in YYYYMMDD-YYYYMMDD format.
Can be formatted as a single date, or as a range of dates in YYYYMMDD-YYYYMMDD format.
Can be formatted as a single date, or as a range of dates in YYYYMMDD-YYYYMMDD format.
Formatted as YYYYMMDD (for single dates) or as YYYYMMDD-YYYYMMDD (for date ranges).
Can be formatted as a single date, or as a range of dates in YYYYMMDD-YYYYMMDD format.
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. Learn more
The error type, AAA.
The error code.
The error description.
Allowed actions you can take, based on the rejection reason code. For example Please Correct and Resubmit.
The location of the error within the original X12 EDI response.
Information to help you correct the error.
The transaction set acknowledgment code provided in in the X12 EDI 999 response.
The implementation transaction set error code provided in IK502 of the 999 transaction.
The raw X12 EDI 271 Eligibility Benefit Response from the payer.
Information about dependents listed in the original eligibility check request. Note that a dependent submitted in the request may be returned in the subscriber object.
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.
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 diagnosis code. The decimal points are omitted in diagnosis codes - the decimal point is assumed.
The member ID for the subscriber's insurance policy.
The dependent's first name.
The dependent's last name.
The dependent's middle name or initial.
The name suffix, such as Jr., Sr., or III.
Code indiciating the patient's gender. Can be F - Female, M - Male, or U - Unknown.
M, F, U The entity identifier for the dependent. It is always 03 - Dependent.
The entity type for the dependent. It can technically be set to Person or Non-Person Entity. In practice, our customers only receive Person.
The dependent's unique health identifier.
The dependent's date of birth, formatted as YYYYMMDD.
The status of the dependent's information, used to report military service data. Can be A - Partial, C - Current, L - Latest, O - Oldest, P - Prior, S - Second Most Current, or T - Third Most Current.
The dependent's employment status code, used to report military service data. Can be AE - Active Reserve, AO - Active Military - Overseas, AS - Academy Student, AT - Presidential Appointee, AU - Active Military - USA, CC - Contractor, DD - Dishonorably Discharged, HD - Honorably Discharged, IR - Inactive Reserves, LX - Leave of Absence: Military, PE - Plan to Enlist, RE - Recommissioned, RM - Retired Military - Overseas, RR- Retired Without Recall, or RU - Retired Military - USA.
The dependent's government service affiliation code, used to report military service data. Can be A - Air Force, B - Air Force Reserves, C - Army, D - Army Reserves, E - Coast Guard, F - Marine Corps, G - Marine Corps Reserves, H - National Guard, I - Navy, J - Navy Reserves, K - Other, L- Peace Corp, M - Regular Armed Forces, N - Reserves, O - U.S. Public Health Service, Q - Foreign Military, R - American Red Cross, S - Department of Defense, U - United States Organization, W - Military Sealift Command.
Context that identifies the exact military unit. Used to report military service data.
The dependent's military service rank code. Can be A1 - Admiral, A2 - Airman, A3 - Airman First Class, B1 - Basic Airman, B2 - Brigadier General, C1 - Captain, C2 - Chief Master Sergeant, C3 - Chief Petty Officer, C4 - Chief Warrant, C5 - Colonel, C6 - Commander, C7 - Commodore, C8 - Corporal, C9 - Corporal Specialist 4, E1 - Ensign, F1 - First Lieutenant, F2 - First Sergeant, F3 - First Sergeant-Master Sergeant, F4 - Fleet Admiral, G1 - General, G4 - Gunnery Sergeant, L1 - Lance Corporal, L2 - Lieutenant, L3 - Lieutenant Colonel, L4 - Lieutenant Commander, L5 - Lieutenant General, L6 - Lieutenant Junior Grade, M1 - Major, M2 - Major General, M3 - Master Chief Petty Officer, M4 - Master Gunnery Sergeant Major, M5 - Master Sergeant, M6 - Master Sergeant Specialist 8, P1 - Petty Officer First Class, P2 - Petty Officer Second Class, P3 - Petty Officer Third Class, P4 - Private, P5 - Private First Class, R1 - Rear Admiral, R2 - Recruit, S1 - Seaman, S2 - Seaman Apprentice, S3 - Seaman Recruit, S4 - Second Lieutenant, S5 - Senior Chief Petty Officer, S6 - Senior Master Sergeant, S7 - Sergeant, S8 - Sergeant First Class Specialist 7, S9 - Sergeant Major Specialist 9, SA - Sergeant Specialist 5, SB - Staff Sergeant, SC - Staff Sergeant Specialist 6, T1 - Technical Sergeant, V1 - Vice Admiral, W1 - Warrant Officer.
The format of the military service date and time period. Can be set to D8 - Date or RD8 - Range of Dates.
The military service date, formatted as YYYYMMDD.
The military service start date, formatted as YYYYMMDD.
The military service end date, formatted as YYYYMMDD.
The dependent's Social Security Number (SSN).
The group number associated with the subscriber's insurance policy.
The plan number associated with the subscriber's insurance policy.
The network identification number associated with the subscriber's insurance policy.
The name of the relationToSubscriberCode. For example, Child when the code is 19.
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.
Indicates the status of the insured. For the dependent, this is always N.
The maintenance type code. Used to acknowledge a change in the identifying elements for the dependent 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 dependent in their system. This is always 001 - Change.
Code identifying the reason for the changes to dependent identifying information, such as name, date of birth, or address. This is always 25 - Change in Identifying Data Elements.
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 first line of the address.
1 - 55The second line of the address.
1 - 55The city.
2 - 30The state code. For example, TN for Tennessee or WA for Washington.
2The United States postal code, excluding punctuation and blanks.
3 - 15The country code. Use the alpha-2 country codes from Part 1 of ISO 3166.
2 - 3The country subdivision code. Use the country subdivision codes from Part 2 of ISO 3166.
1 - 3Information 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.
The provider's last name. This applies to providers that are an individual.
The provider's first name. This applies to providers that are an individual.
The provider's organization name.
The provider's middle name. This applies to providers that are an individual.
The provider's name suffix, such as Jr., Sr., or III.
A code identifying the type of provider. Can be Provider, Third-Party Administrator, Employer, Hospital, Facility, Gateway Provider, Plan Sponsor, or Payer.
The type of entity. Can be Person or Non-Person Entity.
The provider's National Provider Identifier (NPI).
A code that communicates the provider's role in the type of benefits information in the response.
Can be one of the following: AD - Admitting, AT - Attending, BI - Billing, CO - Consulting, CV - Covering, H - Hospital, HH - Home Health Care, LA - Laboratory, OT - Other Physician, P1 - Pharmacist, P2 - Pharmacy, PC - Primary Care Physician, PE - Performing, R - Rural Health Clinic, RF - Referring, SB - Submitting, SK - Skilled Nursing Facility, SU - Supervising.
The Health Care Provider Taxonomy Code.
Deprecated; The Employer's Identification Number (EIN). Only used when an employer is checking the eligibility and benefits of their employees. This shape is deprecated: This property is no longer used.
The Social Security Number (SSN).
The Federal Taxpayer Identification Number (also known as an EIN).
The Payor Identification.
The pharmacy processor number.
The service provider number. This is an identification number assigned by the payer.
The Centers for Medicare and Medicaid Services (CMS) Plan ID.
The provider's contact information.
The first line of the address.
1 - 55The second line of the address.
1 - 55The city.
2 - 30The state code. For example, TN for Tennessee or WA for Washington.
2The United States postal code, excluding punctuation and blanks.
3 - 15The country code. Use the alpha-2 country codes from Part 1 of ISO 3166.
2 - 3The country subdivision code. Use the country subdivision codes from Part 2 of ISO 3166.
1 - 3When 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
The error type, AAA.
The error code.
The error description.
Allowed actions you can take, based on the rejection reason code. For example Please Correct and Resubmit.
The location of the error within the original X12 EDI response.
Information to help you correct the error.
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. Learn more
The error type, AAA.
The error code.
The error description.
Allowed actions you can take, based on the rejection reason code. For example Please Correct and Resubmit.
The location of the error within the original X12 EDI response.
Information to help you correct the error.
Information about the subscriber or dependents' healthcare benefits, such as coverage level (individual vs. family), coverage type (deductibles, copays, 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.
Visit Payer benefit response for more information about benefit types, details about how to interpret the response, and additional examples.
The eligibility or benefit information code. Visit Eligibility and benefit codes for a complete list and descriptions of common codes.
The name of the benefit information code. For example, Deductible.
Code indicating the level of coverage for the patient. Can 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, or SPO - Spouse Only.
The name of the coverage level code. For example Individual.
Codes identifying the type of services. For example, 7 - Anesthesia. Visit Service Type Codes for a complete list.
Note that the word physician in service type codes refers to any healthcare provider, including physician assistants, nurse practitioners, and other types of healthcare professionals.
The full name of the listed serviceTypeCodes. For example Psychiatric, Social Work, etc. This may be empty if the payer sends unrecognized codes in the response.
Code identifying the type of insurance policy. For example MC - Medicaid. Visit Payer benefit response for a complete list.
The name of the insurance type code. For example Medicaid.
The specific product name or special program name for an insurance plan. For example Gold 1-2-3.
Code indicating the time period for the benefit information. For example 23 - Calendar Year. Visit Eligibility code lists for a complete list.
The name of the time period qualifier code. For example Calendar Year.
Note that for the patient's deductible, Calendar Year indicates the patient's total deductible amount for the year, while Remaining indicates the amount left to meet the deductible. Visit Payer benefit response to learn more about deductibles.
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 responsibility codes.
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 responsibility codes.
Code indicating the type of quantity for the benefit. For example VS - Visits. Visit Eligibility code lists for a complete list.
The name of the quantity qualifier code. For example, Visits.
The quantity of the benefit, qualified by the type specified in quantityQualifier. For example, 10 when the quantityQualifier is Visits.
Code indicating whether the benefit is subject to prior authorization or certification. Can be Y - Yes, N - No or U - Unknown.
Code indicating whether the benefit is in-network or out-of-network. Can be Y - Yes, N - No, U - Unknown, or W - Not Applicable (when benefits are the same regardless or the plan network does not apply to the benefit).
Note that this does not indicate whether the provider is in or out-of-network for the patient. To determine that, you must check with the payer directly.
The name of the in-plan network indicator code. For example, Yes.
The loop header identifier number in the LS segment of the original X12 EDI transaction.
The loop trailer identifier number in the LE segment of the original X12 EDI transaction.
Identifies relevant medical procedures by their standard codes and modifiers (if applicable).
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 name of the productOrServiceIdQualifierCode. For example, American Dental Association.
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 diagnosis code pointer.
Identifying information specific to this type of benefit.
The delivery or usage pattern for the benefits.
Code specifying the type of quantity. Can be DY - Days, FL - Units, HS - Hours, MN - Month, or VS - Visits.
The name of the quantityQualifierCode. For example, Days.
The quantity of the benefit. For example, 10 when the quantityQualifier is Visits.
The name of the unitForMeasurementQualifierCode. For example, Days.
Specifies the sampling frequency, based on the unit of measure. For example every 2 months or once per calendar year.
Code specifying the time period for the benefit information. Can be 6 - Hour, 7 - Day, 21 - Years, 22 - Service Year, 23 - Calendar Year, 24 - Year to Date, 25 - Contract, 26 - Episode, 27 - Visit, 28 - Outlier, 29 - Remaining, 30 - Exceeded, 31 - Not Exceeded, 32 - Lifetime, 33 - Lifetime Remaining, 34 - Month, or 35 - Week.
The name of the timePeriodQualifierCode. For example, Calendar Year.
The number of periods in the time period. For example, 12 when the timePeriodQualifier is Hour.
The name of the deliveryOrCalendarPatternQualifierCode. For example, Last Working Day of Period.
A code specifying the time for routine shipments or deliveries. Can be A - 1st Shift (Normal Working Hours), B - 2nd Shift, C - 3rd Shift, D - A.M., E - P.M., F - As Directed, G - Any Shift, or Y - None (Also used to cancel or override a previous pattern).
Code specifying the unit of measurement for the quantity. Can be set to DA - Days, MO - Months, VS - Visit, WK - Week, or YR` - Years.
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.
The name of the deliveryOrCalendarPatternCode. For example, Last Working Day of Period.
Code that specifies the time for routine shipments or deliveries. For example E - P.M.
The name of the deliveryPatternTimeCode.
A free-form message containing additional information about the benefits in the response.
Used when there are multiple Nature of Injury Codes or a Facility Type Codes included in the response.
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.
The name of the codeListQualifierCode. For example Mutually Defined when the code is set to ZZ.
The specific industry code. Visit Eligibility code lists for a complete list.
The name of the industryCode. For example Pharmacy when the code is 01.
The code category. Always set to 44 - Nature of Injury.
Description of injured body parts.
Dates associated with the benefits.
- All properties may either be expressed as a single date, formatted as YYYYMMDD or as a range of dates, formatted as YYYYMMDD-YYYYMMDD.
- Dates listed only apply to the
benefitsInformationobject in which thisbenefitsDateInformationis provided.
A single date, formatted as YYYYMMDD.
The beginning date of a range, formatted as YYYYMMDD.
The end date of a range, formatted as YYYYMMDD.
Only included when multiple plans apply to the patient or multiple plan periods apply.
Only included when multiple plans apply to the patient or multiple plan periods apply.
A single date, formatted as YYYYMMDD.
The beginning date of a range, formatted as YYYYMMDD.
The end date of a range, formatted as YYYYMMDD.
Identify another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.
Code identifying an organizational entity, a physical location, property or an individual. Can be 1I - Preferred Provider Organization (PPO), 1P - Provider, 2B - Third-Party Administrator, 13 - Contracted Service Provider, 36 - Employer, 73 - Other Physician, FA - Facility, GP - Gateway Provider, GW - Group, I3 - Independent Physicians Association (IPA), IL - Insured or Subscriber, LR - Legal Representative, OC - Origin Carrier, P3 - Primary Care Provider, P4 - Prior Insurance Carrier, P5 - Plan Sponsor, PR - Payer, PRP - Primary Payer, SEP - Secondary Payer, TTP - Tertiary Payer, VER - Party Performing Verification, VN - Vendor, VY - Organization Completing Configuration Change, X3 - Utilization Management Organization, Y2 - Managed Care Organization.
The type of entity. Can be 1 - Person or 2 - Non-Person Entity.
The last name (if the entity is a person) or the business name (if the entity is an organization).
The first name of the entity, if the entity is a person.
The middle name or initial of the entity, if the entity is a person.
The name suffix, such as Sr. Jr. or III.
Code identifying the type of value provided in entityIdentificationValue. For example, FI - Federal Taxpayer's Identification Number.
The identification number for the entity, qualified by the code in entityIdentification.
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.
The first line of the address.
1 - 55The second line of the address.
1 - 55The city.
2 - 30The state code. For example, TN for Tennessee or WA for Washington.
2The United States postal code, excluding punctuation and blanks.
3 - 15The country code. Use the alpha-2 country codes from Part 1 of ISO 3166.
2 - 3The country subdivision code. Use the country subdivision codes from Part 2 of ISO 3166.
1 - 3The name of the contact person.
The contact information.
The type of communication number provided. Can be ED - Electronic Data Interchange Access Number, EM - Electronic Mail, FX - Facsimile, TE - Telephone, or UR - 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 provider code.
The provider's taxonomy code. Can be AD - Admitting, AT - Attending, BI - Billing, CO - Consulting, CV - Covering, H - Hospital, HH - Home Health Care, LA - Laboratory, OT - Other Physician, P1 - Pharmacist, P2 - Pharmacy, PC - Primary Care Physician, PE - Performing, R - Rural Health Clinic, RF - Referring, SB - Submitting, SK - Skilled Nursing Facility, or SU - Supervising.
All other entities associated with the eligibility or benefits.
Code identifying an organizational entity, a physical location, property or an individual. Can be 1I - Preferred Provider Organization (PPO), 1P - Provider, 2B - Third-Party Administrator, 13 - Contracted Service Provider, 36 - Employer, 73 - Other Physician, FA - Facility, GP - Gateway Provider, GW - Group, I3 - Independent Physicians Association (IPA), IL - Insured or Subscriber, LR - Legal Representative, OC - Origin Carrier, P3 - Primary Care Provider, P4 - Prior Insurance Carrier, P5 - Plan Sponsor, PR - Payer, PRP - Primary Payer, SEP - Secondary Payer, TTP - Tertiary Payer, VER - Party Performing Verification, VN - Vendor, VY - Organization Completing Configuration Change, X3 - Utilization Management Organization, Y2 - Managed Care Organization.
The type of entity. Can be 1 - Person or 2 - Non-Person Entity.
The last name (if the entity is a person) or the business name (if the entity is an organization).
The first name of the entity, if the entity is a person.
The middle name or initial of the entity, if the entity is a person.
The name suffix, such as Sr. Jr. or III.
Code identifying the type of value provided in entityIdentificationValue. For example, FI - Federal Taxpayer's Identification Number.
The identification number for the entity, qualified by the code in entityIdentification.
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.
The first line of the address.
1 - 55The second line of the address.
1 - 55The city.
2 - 30The state code. For example, TN for Tennessee or WA for Washington.
2The United States postal code, excluding punctuation and blanks.
3 - 15The country code. Use the alpha-2 country codes from Part 1 of ISO 3166.
2 - 3The country subdivision code. Use the country subdivision codes from Part 2 of ISO 3166.
1 - 3The name of the contact person.
The contact information.
The type of communication number provided. Can be ED - Electronic Data Interchange Access Number, EM - Electronic Mail, FX - Facsimile, TE - Telephone, or UR - 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 provider code.
The provider's taxonomy code. Can be AD - Admitting, AT - Attending, BI - Billing, CO - Consulting, CV - Covering, H - Hospital, HH - Home Health Care, LA - Laboratory, OT - Other Physician, P1 - Pharmacist, P2 - Pharmacy, PC - Primary Care Physician, PE - Performing, R - Rural Health Clinic, RF - Referring, SB - Submitting, SK - Skilled Nursing Facility, or SU - Supervising.
Identify the Nature of Injury Code or a Facility Type Code.
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.
The name of the codeListQualifierCode. For example Mutually Defined when the code is set to ZZ.
The specific industry code. Visit Eligibility code lists for a complete list.
The name of the industryCode. For example Pharmacy when the code is 01.
The code category. Always set to 44 - Nature of Injury.
Description of injured body parts.
Was this page helpful?