Real-Time Eligibility Check JSON

Submit a real-time 270/271 eligibility check in JSON format

POST/change/medicalnetwork/eligibility/v3

Real-time eligibility checks are ideal for in-person patient visits, telehealth appointments, and other scenarios where you need immediate information about a patient’s coverage.

  1. Call this endpoint with a JSON payload. The required information can vary depending on the circumstances, but we recommend starting with a basic eligibility request.
  2. Stedi translates your request to the X12 270 EDI format and sends it to the payer.
  3. 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. 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 Real-time eligibility checks for a full how-to guide.

Authorization
RequiredHeader

A Stedi API Key for authentication.

Headers

(CMS requests only): Starting November 8, 2025, the Centers for Medicare & Medicaid Services (CMS) requires submitters to include network IP addresses from an eligibility request's point of origin through receipt by the HETS system. To comply with this requirement, you may need to include this header in requests to CMS.

When present, this header should contain a comma-separated list of upstream IP addresses, starting with the originating system and continuing through every intermediary. You can exclude your IP address from the list. Visit CMS traceability requirements for details and examples.

Body

application/json
controlNumber
StringDeprecatedLength: 9

Stedi generates a control number for each eligibility check, so you don’t need to include this property in your request.

dependents
Array of ObjectsItems: 1

A dependent for which you want to retrieve benefits information.

  • You can only submit one dependent per eligibility check.
  • Only include the patient's information here 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 subscriber object instead. This includes member IDs that differ only by a suffix, such as 01, because the patient can still be uniquely identified.
  • Most Medicaid plans don't support dependents, with a few exceptions. Sending this array to payers that don't support dependents will either cause an error, or the payer may ignore the information and return results for the subscriber 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.
  • Enter the patient's name exactly as written on their insurance card, if available, including any special or punctuation characters such as apostrophes, hyphens (dashes), or spaces. Visit patient names for all best practices to avoid unnecessary failures.
Array item
additionalIdentification
dependents[].additionalIdentification
Object

Use this object when you need to provide an additional identification number for the dependent. This is rarely required for standard eligibility checks.

Show attributes
agencyClaimNumber
dependents[].additionalIdentification.agencyClaimNumber
StringLength: 1 - 50

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

contractNumber
dependents[].additionalIdentification.contractNumber
StringLength: 1 - 50

The contract number for an existing contract between the payer and the provider requesting the eligibility check.

healthInsuranceClaimNumber
dependents[].additionalIdentification.healthInsuranceClaimNumber
StringLength: 1 - 50

This property is never used in practice.

identificationCardSerialNumber
dependents[].additionalIdentification.identificationCardSerialNumber
StringLength: 1 - 50

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

insurancePolicyNumber
dependents[].additionalIdentification.insurancePolicyNumber
StringLength: 1 - 50

The insurance policy number.

medicalRecordIdentificationNumber
dependents[].additionalIdentification.medicalRecordIdentificationNumber
StringLength: 1 - 50

The medical record identification number.

memberIdentificationNumber
dependents[].additionalIdentification.memberIdentificationNumber
StringLength: 1 - 50

Not intended for most use cases. Only set this when the property and casualty patient identifier is a member ID that would be used in an 837 claim submission.

If the patient has their own member ID for the health plan, you should identify them in the subscriber object. If the patient doesn't have their own member ID, don't set this property.

patientAccountNumber
dependents[].additionalIdentification.patientAccountNumber
StringLength: 1 - 50

The patient account number.

planNetworkIdentificationNumber
dependents[].additionalIdentification.planNetworkIdentificationNumber
StringLength: 1 - 50

The plan network identification number.

planNumber
dependents[].additionalIdentification.planNumber
StringLength: 1 - 50

The insurance plan number.

policyNumber
dependents[].additionalIdentification.policyNumber
StringLength: 1 - 50

The insurance group or policy number.

address
dependents[].address
Object

Address information for the dependent. The address1 and city properties are required for all standard eligibility checks. We also recommend including state for member identification.

Show attributes
address1
dependents[].address.address1
StringRequiredLength: 1 - 55

The first line of the address.

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

The second line of the address.

city
dependents[].address.city
StringRequiredLength: 2 - 30

The city.

countryCode
dependents[].address.countryCode
StringLength: 2

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

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

The country subdivision code from Part 2 of ISO 3166.

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

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

state
dependents[].address.state
String

The state or province code.

Possible values
NL
PE
NS
NB
QC
beginningCardIssueDate
dependents[].beginningCardIssueDate
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The date the insurance card was issued. Use when you need to specify a date range. Provide the end of the range in the endCardIssueDate property.

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

The date the insurance plan begins. Use when you need to specify a date range. Provide the end of the range in the endPlanIssueDate property.

birthSequenceNumber
dependents[].birthSequenceNumber
StringRegex pattern: ^[0-9]+$Length: 1 - 9

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.

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

The dependent's date of birth (DOB). 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.

eligibilityCategory
dependents[].eligibilityCategory
StringLength: 1 - 50

The eligibility category for the dependent.

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

The date the insurance card expires. Use when you need to specify a date range. Provide the start of the range in the beginningCardIssueDate property.

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

The date the insurance plan ends. Use when you need to specify a date range. Provide the start of the range in the beginningPlanIssueDate property.

firstName
dependents[].firstName
StringLength: 1 - 35

The dependent's first name.

gender
dependents[].gender
String

Code indicating the dependent's gender.

Possible values
M
F
groupNumber
dependents[].groupNumber
StringLength: 1 - 50

The group number for the dependent's insurance plan.

healthCareCodeInformation
dependents[].healthCareCodeInformation
Array of ObjectsItems: 1 - 8

Information about the dependent's health care diagnosis. You can include up to eight entries in this array.

The first array entry must have diagnosisTypeCode set to ABK. All subsequent entries must have diagnosisTypeCode set to ABF.

Array item
diagnosisCode
dependents[].healthCareCodeInformation[].diagnosisCode
StringRequiredRegex pattern: ^[A-Za-z0-9]+$Length: 1 - 30

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

diagnosisTypeCode
dependents[].healthCareCodeInformation[].diagnosisTypeCode
StringRequired

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.

Note that ICD-9 codes are deprecated and should no longer be used in eligibility checks.

Possible values
BK
ABK
BF
ABF
idCard
dependents[].idCard
StringLength: 1 - 50

The dependent's insurance card number.

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

The date the insurance card was issued. Use to specify a single date.

individualRelationshipCode
dependents[].individualRelationshipCode
String

The dependent's relationship to the subscriber. You can set this to 01 - Spouse, 19 - Child, 34 - Other Adult.

Possible values
01
19
34
issueNumber
dependents[].issueNumber
StringLength: 1 - 50

The issue number for the dependent's insurance policy.

lastName
dependents[].lastName
StringLength: 1 - 60

The dependent's last name. Don't include the dependent's name suffix, such as Jr. or III. Use the designated suffix property instead.

memberId
dependents[].memberId
StringDeprecatedRegex pattern: ^[A-Za-z0-9- ]+$Length: 2 - 80

This shape is deprecated: This property is no longer used.

middleName
dependents[].middleName
StringLength: 1 - 25

The dependent's middle name or middle initial.

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

The date the insurance plan begins. Use to specify a single date.

providerCode
dependents[].providerCode
String

Use 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

Possible values
AD
AT
BI
CO
CV
providerIdentifier
dependents[].providerIdentifier
StringRegex pattern: ^[A-Za-z0-9]+$Length: 1 - 50

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.

referenceIdentificationQualifier
dependents[].referenceIdentificationQualifier
String

The type of providerIdentifier you are using. Use for providers that are not requesting the eligibility check, such as the referring provider.

  • Set to HPI when the National Provider ID is mandated for use.
  • Set to PXC if 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

Possible values
9K
D3
EI
HPI
PXC
ssn
dependents[].ssn
StringRegex pattern: ^\d{9}$

The dependent's social security number. Don't use this for Federally-administered programs, such as Medicare.

suffix
dependents[].suffix
StringLength: 1 - 10

The dependent's name suffix, such as Sr. or III. Only include the dependent's personal name suffix - don't include professional or academic titles, such as M.D. or MBA.

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.

encounter
Object

Details about the eligibility or benefit information you are requesting for the patient.

  • If you don't specify either serviceTypeCodes or a procedureCode and productOrServiceIDQualifier, Stedi defaults to using 30 (Plan coverage and general benefits) as the only serviceTypeCodes value.
  • 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.
  • When checking eligibility for today, omit the dateOfService property to ensure consistent behavior across payers.
  • We recommend submitting dates up to 12 months in the past or up to the end of the current month. Payers aren't required to support dates outside these ranges. However, some payers such as the Centers for Medicare and Medicaid Services (CMS) do support requests for dates further in the future - especially the next calendar month. Check the payer's documentation to determine their specific behavior.
Show attributes
beginningDateOfService
encounter.beginningDateOfService
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The beginning date of service. If you include this value, you must also include the endDateOfService.

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

The date of service. 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.

diagnosisCodePointer
encounter.diagnosisCodePointer
Array of StringsItems: 1 - 4

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.

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

The end date of service. If you include this value, you must also include the beginningDateOfService.

industryCode
encounter.industryCode
String

The type of facility where the service was provided. You can set this to one of the place of service codes.

Possible values
01
02
03
04
05
medicalProcedures
encounter.medicalProcedures
Array of ObjectsItems: 1 - 98

Use only when you need to send multiple procedure codes in a single request. Otherwise, use the encounter.procedureCode and encounter.productOrServiceIDQualifier properties.

Array item
diagnosisCodePointer
encounter.medicalProcedures[].diagnosisCodePointer
Array of StringsItems: 1 - 4

The diagnosis code pointer.

procedureCode
encounter.medicalProcedures[].procedureCode
StringRequiredLength: 1 - 48

The procedure code.

procedureModifiers
encounter.medicalProcedures[].procedureModifiers
Array of StringsItems: 1 - 4

Procedure modifiers that provide additional information related to the service.

productOrServiceIDQualifier
encounter.medicalProcedures[].productOrServiceIDQualifier
StringRequired

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.

Possible values
AD
CJ
HC
ID
IV
priorAuthorizationOrReferralNumber
encounter.priorAuthorizationOrReferralNumber
String

The prior authorization or referral number for a particular benefit or procedure.

procedureCode
encounter.procedureCode
StringLength: 1 - 48

The procedure code.

procedureModifiers
encounter.procedureModifiers
Array of StringsItems: 1 - 4

The procedure modifier that provides additional information related to the performance of the service.

productOrServiceIDQualifier
encounter.productOrServiceIDQualifier
String

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.

Possible values
AD
CJ
HC
ID
IV
referenceIdentificationQualifier
encounter.referenceIdentificationQualifier
String

The type of information you provided in the priorAuthorizationOrReferralNumber property. You can set this to 9F - Referral Number or G1 - Prior Authorization Number.

Possible values
9F
G1
serviceTypeCodes
encounter.serviceTypeCodes
Array of StringsItems: 1 - 99

One or more codes classifying the type of services for which you want to receive benefits information.

If you don't 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.

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.

Payers aren't required to respond with exactly the same STC(s) in the response, so you may receive benefits information for STCs you didn't request. However, receiving different STCs can mean that the payer is ignoring the STC you sent, which is why we recommend testing payers to determine their support for specific STCs.

Possible values
1
2
3
4
5
externalPatientId
StringMax length: 36

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.

informationReceiverName
ObjectDeprecated

Use the corresponding properties in the provider object instead.

Show attributes
address
informationReceiverName.address
ObjectDeprecated

Address information for the provider.

  • Only include when specifically instructed by a payer, such as 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.
Show attributes
address1
informationReceiverName.address.address1
StringRequiredLength: 1 - 55

The first line of the address.

address2
informationReceiverName.address.address2
StringLength: 1 - 55

The second line of the address.

city
informationReceiverName.address.city
StringRequiredLength: 2 - 30

The city.

countryCode
informationReceiverName.address.countryCode
StringLength: 2

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

countrySubDivisionCode
informationReceiverName.address.countrySubDivisionCode
StringLength: 1 - 3

The country subdivision code from Part 2 of ISO 3166.

postalCode
informationReceiverName.address.postalCode
StringLength: 5 - 9

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

state
informationReceiverName.address.state
String

The state or province code.

Possible values
NL
PE
NS
NB
QC
contactNumber
informationReceiverName.contactNumber
StringDeprecatedLength: 1 - 50
contractNumber
informationReceiverName.contractNumber
StringDeprecatedLength: 1 - 50
devicePinNumber
informationReceiverName.devicePinNumber
StringDeprecatedLength: 1 - 50
facilityIdNumber
informationReceiverName.facilityIdNumber
StringDeprecatedLength: 1 - 50
facilityNetworkIdNumber
informationReceiverName.facilityNetworkIdNumber
StringDeprecatedLength: 1 - 50
federalTaxpayerIdentificationNumber
informationReceiverName.federalTaxpayerIdentificationNumber
StringDeprecatedLength: 1 - 50
informationReceiverAdditionalIdentifierState
informationReceiverName.informationReceiverAdditionalIdentifierState
StringDeprecatedLength: 1 - 80
medicaidProviderNumber
informationReceiverName.medicaidProviderNumber
StringDeprecatedLength: 1 - 50

The provider's Medicaid provider number.

medicareProviderNumber
informationReceiverName.medicareProviderNumber
StringDeprecatedLength: 1 - 50
nationalProviderIdentifier
informationReceiverName.nationalProviderIdentifier
StringDeprecatedLength: 1 - 50
priorIdentifierNumber
informationReceiverName.priorIdentifierNumber
StringDeprecatedLength: 1 - 50
providerPlanNetworkIdNumber
informationReceiverName.providerPlanNetworkIdNumber
StringDeprecatedLength: 1 - 50
socialSecurityNumber
informationReceiverName.socialSecurityNumber
StringDeprecatedLength: 1 - 50
stateLicenceNumber
informationReceiverName.stateLicenceNumber
StringDeprecatedLength: 1 - 50
submitterIdNumber
informationReceiverName.submitterIdNumber
StringDeprecatedLength: 1 - 50
portalPassword
StringLength: 1 - 50

The password that the provider uses to log in to the payer's portal. This is not commonly used.

portalUsername
StringLength: 1 - 50

The username that the provider uses to log in to the payer's portal. This is not commonly used.

provider
ObjectRequired

Information 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), or firstName and lastName (if the provider is an individual).
  • You must also provide an identifier - this is typically the provider's National Provider Identifier (npi). If the provider doesn't have an NPI, you can supply an alternative, such as their taxId or ssn.
  • Don't include additional properties, such as taxId or address, unless they are specifically required or suggested by the payer.
Show attributes
address
provider.address
Object

Address information for the provider.

  • Only include when specifically instructed by a payer, such as 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.
Show attributes
address1
provider.address.address1
StringRequiredLength: 1 - 55

The first line of the address.

address2
provider.address.address2
StringLength: 1 - 55

The second line of the address.

city
provider.address.city
StringRequiredLength: 2 - 30

The city.

countryCode
provider.address.countryCode
StringLength: 2

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

countrySubDivisionCode
provider.address.countrySubDivisionCode
StringLength: 1 - 3

The country subdivision code from Part 2 of ISO 3166.

postalCode
provider.address.postalCode
StringLength: 5 - 9

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

state
provider.address.state
String

The state or province code.

Possible values
NL
PE
NS
NB
QC
contactNumber
provider.contactNumber
StringDeprecatedLength: 1 - 50

The provider's contract number. Only include when required by a payer. This shape is deprecated: Use contractNumber instead.

contractNumber
provider.contractNumber
StringLength: 1 - 50

The provider's contract number. Only include when required by a payer.

devicePinNumber
provider.devicePinNumber
StringLength: 1 - 50

The provider's electronic device pin number. Only include when required by a payer.

employersId
provider.employersId
StringDeprecatedLength: 2 - 80

Deprecated; 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.

facilityIdNumber
provider.facilityIdNumber
StringLength: 1 - 50

The ID number for the provider's facility. Only include when required by a payer.

facilityNetworkIdNumber
provider.facilityNetworkIdNumber
StringLength: 1 - 50

The provider's facility network identification number. Only include when required by a payer.

firstName
provider.firstName
StringLength: 1 - 35

The provider's first name. This property is required if the provider is an individual.

informationReceiverAdditionalIdentifierState
provider.informationReceiverAdditionalIdentifierState
StringLength: 1 - 80

The two-character state ID of the state that assigned the stateLicenseNumber. Only include when required by a payer.

lastName
provider.lastName
StringLength: 1 - 60

The provider's last name. This property is required if the provider is an individual.

medicaidProviderNumber
provider.medicaidProviderNumber
StringLength: 1 - 50

The provider's Medicaid provider number. Only include when required by a payer.

medicareProviderNumber
provider.medicareProviderNumber
StringLength: 1 - 50

The provider's Medicare provider number. Only include when required by a payer.

npi
provider.npi
StringRegex pattern: ^\d{10}$

The 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, requests with alternate IDs are virtually never supported. In the rare circumstance that a payer has instructed you to use an alternate ID, the payer will typically require you to supply either their taxId or ssn instead.

organizationName
provider.organizationName
StringLength: 1 - 60

The provider's business name. This property is required if the provider is not an individual.

payorId
provider.payorId
StringLength: 2 - 80

Only used for payer-to-payer transactions, which are not currently supported. Do not use.

pharmacyProcessorNumber
provider.pharmacyProcessorNumber
StringLength: 2 - 80

The provider's pharmacy processor number. Only include when specifically instructed by a payer - for example, when the provider doesn't have an NPI. This use case is very rarely supported, and is typically when the provider is a non-medical provider, such as a social worker, home health aide, or transportation service.

priorIdentifierNumber
provider.priorIdentifierNumber
StringLength: 1 - 50

The provider's prior identifier number. Only include when required by a payer.

providerCode
provider.providerCode
String

Communicate the provider's role in the type of benefits specified in the request. Visit Eligibility code lists for a complete list. Only include when required by a payer.

Possible values
AD
AT
BI
CO
CV
providerPlanNetworkIdNumber
provider.providerPlanNetworkIdNumber
StringLength: 1 - 50

The provider's plan network identification number. Only include when required by a payer.

providerType
provider.providerType
String

Identify the type of provider.

Possible values
payer
third-party administrator
employer
hospital
facility
referenceIdentification
provider.referenceIdentification
String

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.

serviceProviderNumber
provider.serviceProviderNumber
StringLength: 2 - 80

The provider's service provider number. Only include when specifically instructed by a payer - for example, when the provider doesn't have an NPI. This use case is very rarely supported, and is typically when the provider is a non-medical provider, such as a social worker, home health aide, or transportation service.

servicesPlanID
provider.servicesPlanID
StringDeprecatedLength: 2 - 80
ssn
provider.ssn
StringRegex pattern: ^\d{9}$

The provider's Social Security Number (SSN). - Only include when specifically instructed by a payer - for example, if the provider doesn't have an NPI. This use case is very rarely supported, and is typically when the provider is a non-medical provider, such as a social worker, home health aide, or transportation service. - If the payer has instructed you to send an EIN but the provider operates using their SSN, use provider.taxId instead of this field. - Don't use this for Federally-administered programs, such as Medicare.

stateLicenceNumber
provider.stateLicenceNumber
StringLength: 1 - 50

The provider's state license number. If you include this information, you must also include the informationReceiverAdditionalIdentifierState. Only include when required by a payer.

submitterIdNumber
provider.submitterIdNumber
StringLength: 1 - 50

The provider's submitter identification number. Only include when required by a payer.

taxId
provider.taxId
StringRegex pattern: ^\d{9}$

The provider's Federal Taxpayer Identification Number. This is typically the provider's EIN (Employer Identification Number), but the provider's SSN may be used if the provider does not have an EIN. Only include if required by the payer.

This property is only relevant for asynchronous batch eligibility checks.

subscriber
ObjectRequired

The 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, 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 you provide all four of memberId, dateOfBirth, firstName, and lastName, 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.
  • Enter the patient's name exactly as written on their insurance card, if available, including any special or punctuation characters such as apostrophes, hyphens (dashes), or spaces. Visit patient names for all best practices to avoid unnecessary failures.
Show attributes
additionalIdentification
subscriber.additionalIdentification
Object

Use this object when you need to provide an identification number other than or in addition to the subscriber's 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.

Show attributes
agencyClaimNumber
subscriber.additionalIdentification.agencyClaimNumber
StringLength: 1 - 50

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

contractNumber
subscriber.additionalIdentification.contractNumber
StringLength: 1 - 50

The contract number for an existing contract between the payer and the provider requesting the eligibility check.

healthInsuranceClaimNumber
subscriber.additionalIdentification.healthInsuranceClaimNumber
StringLength: 1 - 50

The health insurance claim number.

identificationCardSerialNumber
subscriber.additionalIdentification.identificationCardSerialNumber
StringLength: 1 - 50

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

insurancePolicyNumber
subscriber.additionalIdentification.insurancePolicyNumber
StringLength: 1 - 50

The insurance policy number.

medicalRecordIdentificationNumber
subscriber.additionalIdentification.medicalRecordIdentificationNumber
StringLength: 1 - 50

The medical record identification number.

memberIdentificationNumber
subscriber.additionalIdentification.memberIdentificationNumber
StringLength: 1 - 50

This property is never used in practice. Supply the subscriber's member ID in subscriber.memberId.

patientAccountNumber
subscriber.additionalIdentification.patientAccountNumber
StringLength: 1 - 50

The patient account number.

planNetworkIdentificationNumber
subscriber.additionalIdentification.planNetworkIdentificationNumber
StringLength: 1 - 50

The plan network identification number.

planNumber
subscriber.additionalIdentification.planNumber
StringLength: 1 - 50

The insurance plan number.

policyNumber
subscriber.additionalIdentification.policyNumber
StringLength: 1 - 50

The insurance group or policy number.

address
subscriber.address
Object

Address information for the subscriber.

  • The address1 and city properties are required for all standard eligibility checks and MBI lookups with SSN. We also recommend including state for member identification.
  • When performing an MBI lookup without SSN (Payer ID: MBILUNOSSN), only state is required. You can omit address1 and city.
Show attributes
address1
subscriber.address.address1
StringLength: 1 - 55

The first line of the address. Required for all payers except payer ID MBILUNOSSN.

address2
subscriber.address.address2
StringLength: 1 - 55

The second line of the address.

city
subscriber.address.city
StringLength: 2 - 30

The city. Required for all payers except payer ID MBILUNOSSN.

countryCode
subscriber.address.countryCode
StringLength: 2

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

countrySubDivisionCode
subscriber.address.countrySubDivisionCode
StringLength: 1 - 3

The country subdivision code from Part 2 of ISO 3166.

postalCode
subscriber.address.postalCode
StringLength: 5 - 9

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

state
subscriber.address.state
String

The state or province code. Required for payer ID MBILUNOSSN.

Possible values
NL
PE
NS
NB
QC
beginningCardIssueDate
subscriber.beginningCardIssueDate
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The date the subscriber's insurance card was issued. Use when you need to specify a date range. Provide the end of the range in the endCardIssueDate property.

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

The date the subscriber's insurance plan begins. Use when you need to specify a date range. Provide the end of the range in the endPlanIssueDate property.

birthSequenceNumber
subscriber.birthSequenceNumber
StringRegex pattern: ^[0-9]$Length: 1 - 9

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.

caseNumber
subscriber.caseNumber
StringRegex pattern: ^[A-Za-z0-9]+$Length: 1 - 50

The case number associated with the subscriber.

coverageLevelCode
subscriber.coverageLevelCode
String

This property is no longer used.

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

The subscriber's date of birth.

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

The date the subscriber's insurance card expires. Use when you need to specify a date range. Provide the start of the range in the beginningCardIssueDate property.

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

The date the subscriber's insurance plan ends. Use when you need to specify a date range. Provide the start of the range in the beginningPlanIssueDate property.

firstName
subscriber.firstName
StringLength: 1 - 35

The patient's first name.

gender
subscriber.gender
String

Code indicating the subscriber's gender.

Possible values
M
F
groupNumber
subscriber.groupNumber
StringLength: 1 - 50

The group number associated with the subscriber's insurance policy.

healthCareCodeInformation
subscriber.healthCareCodeInformation
Array of ObjectsItems: 1 - 8

Information about the subscriber's health care diagnosis. You can include up to eight entries in this array.

The first array entry must have diagnosisTypeCode set to ABK. All subsequent entries must have diagnosisTypeCode set to ABF.

Array item
diagnosisCode
subscriber.healthCareCodeInformation[].diagnosisCode
StringRequiredRegex pattern: ^[A-Za-z0-9]+$Length: 1 - 30

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

diagnosisTypeCode
subscriber.healthCareCodeInformation[].diagnosisTypeCode
StringRequired

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.

Note that ICD-9 codes are deprecated and should no longer be used in eligibility checks.

Possible values
BK
ABK
BF
ABF
idCard
subscriber.idCard
StringLength: 1 - 50

The subscriber's identification card number. Include this property when this number is different than the subscriber's member ID. This is common in Medicaid.

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

The date the subscriber's insurance card was issued. Use to specify a single date.

lastName
subscriber.lastName
StringLength: 1 - 60

The subscriber's last name. Don't include the subscriber's name suffix, such as Jr. or III. Use the designated suffix property instead.

medicaidRecipientIdentificationNumber
subscriber.medicaidRecipientIdentificationNumber
StringRegex pattern: ^[A-Za-z0-9]+$Length: 1 - 50

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

memberId
subscriber.memberId
StringRegex pattern: ^[A-Za-z0-9- ]+$Length: 2 - 80

The member ID for the subscriber's insurance policy.

middleName
subscriber.middleName
StringLength: 1 - 25

The patient's middle name or middle initial.

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

The date the subscriber's insurance plan begins. Use to specify a single date.

providerCode
subscriber.providerCode
String

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

This property is required when the providerIdentifier and referenceIdentificationQualifier properties are populated.

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

Possible values
AD
AT
BI
CO
CV
providerIdentifier
subscriber.providerIdentifier
StringRegex pattern: ^[A-Za-z0-9]+$Length: 1 - 50

The provider identifier you specified in the referenceIdentificationQualifier property. It is required if you set the referenceIdentificationQualifier. For example, this property could contain 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.

referenceIdentificationQualifier
subscriber.referenceIdentificationQualifier
String

Use this for providers that are not requesting the eligibility check. This is the type of providerIdentifier you are providing.

  • Set to HPI when the National Provider ID is mandated for use.
  • Set to PXC if 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

Possible values
9K
D3
EI
HPI
PXC
spendDownAmount
subscriber.spendDownAmount
StringLength: 1 - 15

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

spendDownTotalBilledAmount
subscriber.spendDownTotalBilledAmount
StringLength: 1 - 15

The subscriber's spend down total billed amount.

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

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.

suffix
subscriber.suffix
StringLength: 1 - 10

The name suffix, such as Jr., Sr., or III. Only include the subscriber's personal name suffix - don't include professional or academic titles, such as M.D. or MBA.

tradingPartnerName
StringLength: 1 - 80

The payer's name, such as Cigna or Aetna.

tradingPartnerServiceId
StringRequiredLength: 1 - 80

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

Response

application/json

EligibilityCheck 200 response

benefitsInformation
Array of Objects

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

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

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

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

Array item
additionalInformation
benefitsInformation[].additionalInformation
Array of Objects

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

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

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

authOrCertIndicator
benefitsInformation[].authOrCertIndicator
String

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

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

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

Payers may sometimes return other non-compliant values.

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

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

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

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

Learn more about patient costs.

benefitPercent
benefitsInformation[].benefitPercent
String

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

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

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

Learn more about patient costs.

benefitQuantity
benefitsInformation[].benefitQuantity
String

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

benefitsAdditionalInformation
benefitsInformation[].benefitsAdditionalInformation
Object

Identifying information specific to this type of benefit.

Show attributes
alternativeListId
benefitsInformation[].benefitsAdditionalInformation.alternativeListId
String

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

coverageListId
benefitsInformation[].benefitsAdditionalInformation.coverageListId
String

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

drugFormularyNumber
benefitsInformation[].benefitsAdditionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
benefitsInformation[].benefitsAdditionalInformation.familyUnitNumber
String

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

groupDescription
benefitsInformation[].benefitsAdditionalInformation.groupDescription
String

Group name

groupNumber
benefitsInformation[].benefitsAdditionalInformation.groupNumber
String

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

hicNumber
benefitsInformation[].benefitsAdditionalInformation.hicNumber
String

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

insurancePolicyNumber
benefitsInformation[].benefitsAdditionalInformation.insurancePolicyNumber
String

The insurance policy number.

medicaidRecepientIdNumber
benefitsInformation[].benefitsAdditionalInformation.medicaidRecepientIdNumber
String

The Medicaid Recipient Identification number.

medicalAssistanceCategory
benefitsInformation[].benefitsAdditionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
benefitsInformation[].benefitsAdditionalInformation.memberId
String

The patient's member ID.

planDescription
benefitsInformation[].benefitsAdditionalInformation.planDescription
String

Plan name

planNetworkDescription
benefitsInformation[].benefitsAdditionalInformation.planNetworkDescription
String

Plan network name

planNetworkIdNumber
benefitsInformation[].benefitsAdditionalInformation.planNetworkIdNumber
String

The plan network identification number.

planNumber
benefitsInformation[].benefitsAdditionalInformation.planNumber
String

The insurance plan number.

policyNumber
benefitsInformation[].benefitsAdditionalInformation.policyNumber
String

The patient's policy number.

priorAuthorizationNumber
benefitsInformation[].benefitsAdditionalInformation.priorAuthorizationNumber
String

The prior authorization number.

referralNumber
benefitsInformation[].benefitsAdditionalInformation.referralNumber
String

The referral number.

benefitsDateInformation
benefitsInformation[].benefitsDateInformation
Object

Dates associated with the benefits.

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

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

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

The admission date or dates.

admissions
benefitsInformation[].benefitsDateInformation.admissions
Array of Objects

The date(s) for admission.

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

A single date.

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

The end date of a range.

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

The beginning date of a range.

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

The benefit date.

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

The date when the benefit begins.

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

The date when the benefit ends.

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

The certification date.

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

The date when COBRA coverage begins.

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

The date when COBRA coverage ends.

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

The completion date.

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

The coordination of benefits date.

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

The date of death.

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

The date when the plan information was last updated.

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

The discharge date.

discharges
benefitsInformation[].benefitsDateInformation.discharges
Array of Objects

The date(s) when the patient was discharged.

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

A single date.

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

The end date of a range.

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

The beginning date of a range.

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

The effective date of change.

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

Plan eligibility dates.

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

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

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

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

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

The date when the patient is enrolled in the plan.

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

The issue date.

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

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

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

The end of a period.

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

The start of a period.

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

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

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

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

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

The date coverage from the plan ends.

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

The date when the policy becomes effective.

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

The date when the policy expires.

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

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

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

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

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

The primary care provider date.

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

The service date or dates.

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

The status date.

benefitsRelatedEntities
benefitsInformation[].benefitsRelatedEntities
Array of Objects

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

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

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

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

The first line of the address.

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

The second line of the address.

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

The city.

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

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

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

The country subdivision code from Part 2 of ISO 3166.

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

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

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

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

Payers may sometimes return other non-compliant values.

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

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

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

The contact information.

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

The type of communication number provided.

Payers may sometimes return other non-compliant values.

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

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

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

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

The name of the contact person.

entityFirstname
benefitsInformation[].benefitsRelatedEntities[].entityFirstname
String

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

entityIdentification
benefitsInformation[].benefitsRelatedEntities[].entityIdentification
String

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

Payers may sometimes return other non-compliant values.

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

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

entityIdentifier
benefitsInformation[].benefitsRelatedEntities[].entityIdentifier
String

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

Payers may sometimes return other non-compliant values.

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

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

entityName
benefitsInformation[].benefitsRelatedEntities[].entityName
String

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

entityRelationship
benefitsInformation[].benefitsRelatedEntities[].entityRelationship
String

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

Payers may sometimes return other non-compliant values.

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

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

entityType
benefitsInformation[].benefitsRelatedEntities[].entityType
String

The type of entity.

Payers may sometimes return other non-compliant values.

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

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

Payers may sometimes return other non-compliant values.

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

The provider's taxonomy code.

benefitsRelatedEntity
benefitsInformation[].benefitsRelatedEntity
ObjectDeprecated

Please use benefitsInformation.benefitsRelatedEntities instead.

Show attributes
address
benefitsInformation[].benefitsRelatedEntity.address
Object

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

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

The first line of the address.

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

The second line of the address.

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

The city.

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

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

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

The country subdivision code from Part 2 of ISO 3166.

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

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

state
benefitsInformation[].benefitsRelatedEntity.address.state
String

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

Payers may sometimes return other non-compliant values.

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

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

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

The contact information.

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

The type of communication number provided.

Payers may sometimes return other non-compliant values.

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

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

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

name
benefitsInformation[].benefitsRelatedEntity.contactInformation.name
String

The name of the contact person.

entityFirstname
benefitsInformation[].benefitsRelatedEntity.entityFirstname
String

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

entityIdentification
benefitsInformation[].benefitsRelatedEntity.entityIdentification
String

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

Payers may sometimes return other non-compliant values.

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

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

entityIdentifier
benefitsInformation[].benefitsRelatedEntity.entityIdentifier
String

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

Payers may sometimes return other non-compliant values.

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

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

entityName
benefitsInformation[].benefitsRelatedEntity.entityName
String

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

entityRelationship
benefitsInformation[].benefitsRelatedEntity.entityRelationship
String

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

Payers may sometimes return other non-compliant values.

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

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

entityType
benefitsInformation[].benefitsRelatedEntity.entityType
String

The type of entity.

Payers may sometimes return other non-compliant values.

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

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

Payers may sometimes return other non-compliant values.

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

The provider's taxonomy code.

benefitsServiceDelivery
benefitsInformation[].benefitsServiceDelivery
Array of Objects

The delivery or usage pattern for the benefits.

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

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

Payers may sometimes return other non-compliant values.

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

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

Payers may sometimes return other non-compliant values.

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

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

Payers may sometimes return other non-compliant values.

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

The name of the deliveryPatternTimeCode.

Payers may sometimes return other non-compliant values.

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

The name of the deliveryPatternTimeCode.

Payers may sometimes return other non-compliant values.

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

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

Payers may sometimes return other non-compliant values.

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

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

quantity
benefitsInformation[].benefitsServiceDelivery[].quantity
String

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

quantityQualifier
benefitsInformation[].benefitsServiceDelivery[].quantityQualifier
String

The name of the quantityQualifierCode. For example, Days.

Payers may sometimes return other non-compliant values.

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

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

Payers may sometimes return other non-compliant values.

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

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

timePeriodQualifier
benefitsInformation[].benefitsServiceDelivery[].timePeriodQualifier
String

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

Payers may sometimes return other non-compliant values.

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

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

Payers may sometimes return other non-compliant values.

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

The name of the unitForMeasurementQualifierCode. For example, Days.

Payers may sometimes return other non-compliant values.

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

The name of the unitForMeasurementQualifierCode. For example, Days.

Payers may sometimes return other non-compliant values.

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

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

Payers may sometimes return other non-compliant values.

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

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

Payers may sometimes return other non-compliant values.

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

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

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

The diagnosis code pointer.

procedureCode
benefitsInformation[].compositeMedicalProcedureIdentifier.procedureCode
String

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

procedureModifiers
benefitsInformation[].compositeMedicalProcedureIdentifier.procedureModifiers
Array of Strings

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

productOrServiceID
benefitsInformation[].compositeMedicalProcedureIdentifier.productOrServiceID
String

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

productOrServiceIdQualifier
benefitsInformation[].compositeMedicalProcedureIdentifier.productOrServiceIdQualifier
String

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

productOrServiceIdQualifierCode
benefitsInformation[].compositeMedicalProcedureIdentifier.productOrServiceIdQualifierCode
String

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

coverageLevel
benefitsInformation[].coverageLevel
String

The full name of the coverage level code.

Payers may sometimes return other non-compliant values.

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

Code indicating the level of coverage for the patient.

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

Payers may sometimes return other non-compliant values.

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

Please use benefitsInformation.eligibilityAdditionalInformationList instead.

Show attributes
codeCategory
benefitsInformation[].eligibilityAdditionalInformation.codeCategory
String

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

Payers may sometimes return other non-compliant values.

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

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

codeListQualifierCode
benefitsInformation[].eligibilityAdditionalInformation.codeListQualifierCode
String

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

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

Payers may sometimes return other non-compliant values.

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

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

industryCode
benefitsInformation[].eligibilityAdditionalInformation.industryCode
String

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

injuredBodyPartName
benefitsInformation[].eligibilityAdditionalInformation.injuredBodyPartName
String

Description of injured body parts.

eligibilityAdditionalInformationList
benefitsInformation[].eligibilityAdditionalInformationList
Array of Objects

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

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

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

Payers may sometimes return other non-compliant values.

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

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

codeListQualifierCode
benefitsInformation[].eligibilityAdditionalInformationList[].codeListQualifierCode
String

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

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

Payers may sometimes return other non-compliant values.

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

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

industryCode
benefitsInformation[].eligibilityAdditionalInformationList[].industryCode
String

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

injuredBodyPartName
benefitsInformation[].eligibilityAdditionalInformationList[].injuredBodyPartName
String

Description of injured body parts.

headerLoopIdentifierCode
benefitsInformation[].headerLoopIdentifierCode
String

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

inPlanNetworkIndicator
benefitsInformation[].inPlanNetworkIndicator
String

The name of the in-plan network indicator code.

Payers may sometimes return other non-compliant values.

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

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

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

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

Payers may sometimes return other non-compliant values.

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

The full name of the insurance type code.

Payers may sometimes return other non-compliant values.

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

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

Payers may sometimes return other non-compliant values.

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

The full name of the benefits information code.

Payers may sometimes return other non-compliant values.

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

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

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

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

quantityQualifier
benefitsInformation[].quantityQualifier
String

The name of the quantityQualifierCode.

Payers may sometimes return other non-compliant values.

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

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

Payers may sometimes return other non-compliant values.

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

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

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

Payers may sometimes return other non-compliant values.

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

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

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

Payers may sometimes return other non-compliant values.

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

The name of the timeQualifierCode.

Payers may sometimes return other non-compliant values.

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

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

Payers may sometimes return other non-compliant values.

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

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

controlNumber
StringDeprecated

An identifier for the payer's response.

dependents
Array of Objects

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

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

Array item
aaaErrors
dependents[].aaaErrors
Array of Objects

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

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

The error code.

Payers may sometimes return other non-compliant values.

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

The error description.

field
dependents[].aaaErrors[].field
String

The error type, AAA.

followupAction
dependents[].aaaErrors[].followupAction
String

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

Payers may sometimes return other non-compliant values.

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

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

possibleResolutions
dependents[].aaaErrors[].possibleResolutions
String

Information to help you correct the error.

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

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

The first line of the address.

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

The second line of the address.

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

The city.

countryCode
dependents[].address.countryCode
StringLength: 2

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

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

The country subdivision code from Part 2 of ISO 3166.

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

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

state
dependents[].address.state
String

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

Payers may sometimes return other non-compliant values.

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

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

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

The member's date of birth.

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

The military service date.

dateTimePeriodFormatQualifier
dependents[].dateTimePeriodFormatQualifier
String

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

Payers may sometimes return other non-compliant values.

Possible values
D8
RD8
description
dependents[].description
String

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

employmentStatusCode
dependents[].employmentStatusCode
String

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

Payers may sometimes return other non-compliant values.

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

The military service end date.

entityIdentifier
dependents[].entityIdentifier
String

The entity identifier for the dependent.

Possible values
Dependent
entityType
dependents[].entityType
String

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

Payers may sometimes return other non-compliant values.

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

The member's first name.

gender
dependents[].gender
String

Code indicating the patient's gender.

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

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

Payers may sometimes return other non-compliant values.

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

Group name

groupNumber
dependents[].groupNumber
String

The group number associated with the insurance policy.

healthCareDiagnosisCodes
dependents[].healthCareDiagnosisCodes
Array of Objects

Information about the patient's healthcare diagnosis.

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

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

diagnosisTypeCode
dependents[].healthCareDiagnosisCodes[].diagnosisTypeCode
String

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

informationStatusCode
dependents[].informationStatusCode
String

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

Payers may sometimes return other non-compliant values.

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

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

Possible values
N
lastName
dependents[].lastName
String

The member's last name.

maintenanceReasonCode
dependents[].maintenanceReasonCode
String

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

Payers may sometimes return other non-compliant values.

Possible values
25
maintenanceTypeCode
dependents[].maintenanceTypeCode
String

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

Payers may sometimes return other non-compliant values.

Possible values
001
memberId
dependents[].memberId
StringDeprecated

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

middleName
dependents[].middleName
String

The member's middle name or initial.

militaryServiceRankCode
dependents[].militaryServiceRankCode
String

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

Payers may sometimes return other non-compliant values.

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

Plan name

planNetworkDescription
dependents[].planNetworkDescription
String

Plan network name

planNetworkIdNumber
dependents[].planNetworkIdNumber
String

The network identification number associated with the insurance policy.

planNumber
dependents[].planNumber
String

The plan number associated with the insurance policy.

relationToSubscriber
dependents[].relationToSubscriber
String

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

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

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

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

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

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

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

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

The error code.

Payers may sometimes return other non-compliant values.

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

The error description.

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

The error type, AAA.

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

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

Payers may sometimes return other non-compliant values.

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

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

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

Information to help you correct the error.

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

address
dependents[].responseProvider.address
Object

The provider's contact information.

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

The first line of the address.

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

The second line of the address.

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

The city.

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

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

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

The country subdivision code from Part 2 of ISO 3166.

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

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

state
dependents[].responseProvider.address.state
String

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

Payers may sometimes return other non-compliant values.

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

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

entityIdentifier
dependents[].responseProvider.entityIdentifier
String

A code identifying the type of provider.

Payers may sometimes return other non-compliant values.

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

The type of entity.

Payers may sometimes return other non-compliant values.

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

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

middleName
dependents[].responseProvider.middleName
String

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

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

The Payor Identification.

pharmacyProcessorNumber
dependents[].responseProvider.pharmacyProcessorNumber
String

The pharmacy processor number.

providerCode
dependents[].responseProvider.providerCode
String

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

Payers may sometimes return other non-compliant values.

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

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

providerName
dependents[].responseProvider.providerName
String

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

providerOrgName
dependents[].responseProvider.providerOrgName
String

The provider's organization name.

referenceIdentification
dependents[].responseProvider.referenceIdentification
String

The Health Care Provider Taxonomy Code.

serviceProviderNumber
dependents[].responseProvider.serviceProviderNumber
String

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

servicesPlanID
dependents[].responseProvider.servicesPlanID
String

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

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

The Social Security Number (SSN).

suffix
dependents[].responseProvider.suffix
String

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

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

The member's Social Security Number (SSN).

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

The military service start date.

suffix
dependents[].suffix
String

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

uniqueHealthIdentifier
dependents[].uniqueHealthIdentifier
String

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.

errors
Array of Objects

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

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

Array item
code
errors[].code
String

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

Payers may sometimes return other non-compliant values.

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

The error description.

field
errors[].field
String

The error type, AAA.

followupAction
errors[].followupAction
String

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

Payers may sometimes return other non-compliant values.

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

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

possibleResolutions
errors[].possibleResolutions
String

Information to help you correct the error.

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

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

meta
Object

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

Show attributes
applicationMode
meta.applicationMode
String

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

Payers may sometimes return other non-compliant values.

Possible values
production
test
information
billerId
meta.billerId
String

The biller ID Stedi assigns to this request.

outboundTraceId
meta.outboundTraceId
String

The unique ID Stedi assigns to this request.

senderId
meta.senderId
String

The sender ID Stedi assigns to this request.

submitterId
meta.submitterId
String

The submitter ID Stedi assigns to this request.

traceId
meta.traceId
String

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

payer
Object

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

Show attributes
aaaErrors
payer.aaaErrors
Array of Objects

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

Array item
code
payer.aaaErrors[].code
String

The error code.

Payers may sometimes return other non-compliant values.

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

The error description.

field
payer.aaaErrors[].field
String

The error type, AAA.

followupAction
payer.aaaErrors[].followupAction
String

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

Payers may sometimes return other non-compliant values.

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

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

possibleResolutions
payer.aaaErrors[].possibleResolutions
String

Information to help you correct the error.

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

centersForMedicareAndMedicaidPlanId
payer.centersForMedicareAndMedicaidPlanId
String

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

contactInformation
payer.contactInformation
Object

The payer's contact information.

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

Show attributes
contacts
payer.contactInformation.contacts
Array of Objects

The contact information.

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

The type of communication number provided.

Payers may sometimes return other non-compliant values.

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

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

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

name
payer.contactInformation.name
String

The name of the contact person.

employersId
payer.employersId
StringDeprecated

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

entityIdentifier
payer.entityIdentifier
String

The entity identifier code for the payer.

Payers may sometimes return other non-compliant values.

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

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

Payers may sometimes return other non-compliant values.

Possible values
Person
Non-Person Entity
etin
payer.etin
String

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

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

The payer's federal taxpayer's identification number.

firstName
payer.firstName
String

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

lastName
payer.lastName
String

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

middleName
payer.middleName
String

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

naic
payer.naic
String

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

name
payer.name
String

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

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

The payor identification.

suffix
payer.suffix
String

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
planDateInformation.added
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])(-\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))?$

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

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

The admission date or dates.

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

The benefit date.

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

The benefit begin date.

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

The benefit end date.

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

The certification date.

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

The date when COBRA coverage begins.

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

The date when COBRA coverage ends.

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

The completion date.

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

The coordination of benefits date.

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

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

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

The date when the plan information was last updated.

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

The discharge date.

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

The effective date of change.

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

Plan eligibility dates.

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

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

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

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

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

The date when the patient is enrolled in the plan.

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

The issue date.

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

The latest visit or consultation date.

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

The end of a period.

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

The start of a period.

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

Plan effective dates.

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

The date coverage from the plan begins.

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

The date coverage from the plan ends.

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

The date when the policy becomes effective.

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

The date when the policy expires.

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

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

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

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

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

The primary care provider date.

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

The service date or dates.

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

The status date.

Additional identification for the subscriber's healthcare plan.

Show attributes
agencyClaimNumber
planInformation.agencyClaimNumber
String

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

alternativeListId
planInformation.alternativeListId
String

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

caseNumber
planInformation.caseNumber
String

The case number

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

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

classOfContractCode
planInformation.classOfContractCode
String

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

contractNumber
planInformation.contractNumber
String

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

coverageListId
planInformation.coverageListId
String

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

drugFormularyNumber
planInformation.drugFormularyNumber
String

The drug formulary number

electronicDevicePin
planInformation.electronicDevicePin
String

The electronic device pin number

eligibilityCategory
planInformation.eligibilityCategory
String

The eligibility category

facilityIdNumber
planInformation.facilityIdNumber
String

The facility ID number

facilityNetworkIdentificationNumber
planInformation.facilityNetworkIdentificationNumber
String

The facility network identification number

familyUnitNumber
planInformation.familyUnitNumber
String

The family unit number

federalTaxpayersIdentificationNumber
planInformation.federalTaxpayersIdentificationNumber
String

The federal taxpayer's identification number

groupDescription
planInformation.groupDescription
String

The group description

groupNumber
planInformation.groupNumber
String

The group number

hicNumber
planInformation.hicNumber
String

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

idCardNumber
planInformation.idCardNumber
String

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

idCardSerialNumber
planInformation.idCardSerialNumber
String

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

insurancePolicyNumber
planInformation.insurancePolicyNumber
String

The insurance policy number

issueNumber
planInformation.issueNumber
String

The issue number

medicaidProviderNumber
planInformation.medicaidProviderNumber
String

The Medicaid provider number

medicaidRecipientIdNumber
planInformation.medicaidRecipientIdNumber
String

The Medicaid recipient identification number

medicalAssistanceCategory
planInformation.medicalAssistanceCategory
String

The medical assistance category

medicalRecordIdentificationNumber
planInformation.medicalRecordIdentificationNumber
String

The medical record identification number

medicareProviderNumber
planInformation.medicareProviderNumber
String

The Medicare provider number

memberId
planInformation.memberId
String

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

patientAccountNumber
planInformation.patientAccountNumber
String

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

personalIdentificationNumber
planInformation.personalIdentificationNumber
String

The personal identification number (PIN)

planDescription
planInformation.planDescription
String

The plan description

planNetworkIdDescription
planInformation.planNetworkIdDescription
String

The plan, group, or plan network name

planNetworkIdNumber
planInformation.planNetworkIdNumber
String

The plan network identification number

planNumber
planInformation.planNumber
String

The plan number

policyNumber
planInformation.policyNumber
String

The group or policy number

priorAuthorizationNumber
planInformation.priorAuthorizationNumber
String

The prior authorization number

priorIdNumber
planInformation.priorIdNumber
String

The prior identifier number

referralNumber
planInformation.referralNumber
String

The referral number

socialSecurityNumber
planInformation.socialSecurityNumber
String

The social security number

stateLicenseNumber
planInformation.stateLicenseNumber
String

The state license number

submitterIdentificationNumber
planInformation.submitterIdentificationNumber
String

The submitter identification number

userIdentification
planInformation.userIdentification
String

The user identification

planStatus
Array of ObjectsDeprecated

Please use benefitsInformation instead.

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

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

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

Payers may sometimes return other non-compliant values.

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

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

Show attributes
aaaErrors
provider.aaaErrors
Array of Objects

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

Array item
code
provider.aaaErrors[].code
String

The error code.

Payers may sometimes return other non-compliant values.

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

The error description.

field
provider.aaaErrors[].field
String

The error type, AAA.

followupAction
provider.aaaErrors[].followupAction
String

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

Payers may sometimes return other non-compliant values.

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

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

possibleResolutions
provider.aaaErrors[].possibleResolutions
String

Information to help you correct the error.

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

address
provider.address
Object

The provider's contact information.

Show attributes
address1
provider.address.address1
StringLength: 1 - 55

The first line of the address.

address2
provider.address.address2
StringLength: 1 - 55

The second line of the address.

city
provider.address.city
StringLength: 2 - 30

The city.

countryCode
provider.address.countryCode
StringLength: 2

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

countrySubDivisionCode
provider.address.countrySubDivisionCode
StringLength: 1 - 3

The country subdivision code from Part 2 of ISO 3166.

postalCode
provider.address.postalCode
StringLength: 5 - 9

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

state
provider.address.state
String

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

Payers may sometimes return other non-compliant values.

Possible values
NL
PE
NS
NB
QC
employersId
provider.employersId
StringDeprecated

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

entityIdentifier
provider.entityIdentifier
String

A code identifying the type of provider.

Payers may sometimes return other non-compliant values.

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

The type of entity.

Payers may sometimes return other non-compliant values.

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

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

middleName
provider.middleName
String

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

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

The Payor Identification.

pharmacyProcessorNumber
provider.pharmacyProcessorNumber
String

The pharmacy processor number.

providerCode
provider.providerCode
String

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

Payers may sometimes return other non-compliant values.

Possible values
AD
AT
BI
CO
CV
providerFirstName
provider.providerFirstName
String

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

providerName
provider.providerName
String

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

providerOrgName
provider.providerOrgName
String

The provider's organization name.

referenceIdentification
provider.referenceIdentification
String

The Health Care Provider Taxonomy Code.

serviceProviderNumber
provider.serviceProviderNumber
String

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

servicesPlanID
provider.servicesPlanID
String

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

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

The Social Security Number (SSN).

suffix
provider.suffix
String

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

reassociationKey
StringDeprecated
status
String

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

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

Show attributes
aaaErrors
subscriber.aaaErrors
Array of Objects

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

Array item
code
subscriber.aaaErrors[].code
String

The error code.

Payers may sometimes return other non-compliant values.

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

The error description.

field
subscriber.aaaErrors[].field
String

The error type, AAA.

followupAction
subscriber.aaaErrors[].followupAction
String

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

Payers may sometimes return other non-compliant values.

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

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

possibleResolutions
subscriber.aaaErrors[].possibleResolutions
String

Information to help you correct the error.

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

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

The first line of the address.

address2
subscriber.address.address2
StringLength: 1 - 55

The second line of the address.

city
subscriber.address.city
StringLength: 2 - 30

The city.

countryCode
subscriber.address.countryCode
StringLength: 2

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

countrySubDivisionCode
subscriber.address.countrySubDivisionCode
StringLength: 1 - 3

The country subdivision code from Part 2 of ISO 3166.

postalCode
subscriber.address.postalCode
StringLength: 5 - 9

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

state
subscriber.address.state
String

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

Payers may sometimes return other non-compliant values.

Possible values
NL
PE
NS
NB
QC
birthSequenceNumber
subscriber.birthSequenceNumber
String

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

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

The member's date of birth.

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

The military service date.

dateTimePeriodFormatQualifier
subscriber.dateTimePeriodFormatQualifier
String

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

Payers may sometimes return other non-compliant values.

Possible values
D8
RD8
description
subscriber.description
String

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

employmentStatusCode
subscriber.employmentStatusCode
String

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

Payers may sometimes return other non-compliant values.

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

The military service end date.

entityIdentifier
subscriber.entityIdentifier
String

The entity identifier for the subscriber.

Possible values
Insured or Subscriber
entityType
subscriber.entityType
String

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

Payers may sometimes return other non-compliant values.

Possible values
Person
Non-Person Entity
firstName
subscriber.firstName
String

The member's first name.

gender
subscriber.gender
String

Code indicating the patient's gender.

Possible values
M
F
U
governmentServiceAffiliationCode
subscriber.governmentServiceAffiliationCode
String

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

Payers may sometimes return other non-compliant values.

Possible values
A
B
C
D
E
groupDescription
subscriber.groupDescription
String

Group name

groupNumber
subscriber.groupNumber
String

The group number associated with the insurance policy.

healthCareDiagnosisCodes
subscriber.healthCareDiagnosisCodes
Array of Objects

Information about the patient's healthcare diagnosis.

Array item
diagnosisCode
subscriber.healthCareDiagnosisCodes[].diagnosisCode
String

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

diagnosisTypeCode
subscriber.healthCareDiagnosisCodes[].diagnosisTypeCode
String

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

informationStatusCode
subscriber.informationStatusCode
String

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

Payers may sometimes return other non-compliant values.

Possible values
A
C
L
O
P
insuredIndicator
subscriber.insuredIndicator
String

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

Possible values
Y
lastName
subscriber.lastName
String

The member's last name.

maintenanceReasonCode
subscriber.maintenanceReasonCode
String

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

Payers may sometimes return other non-compliant values.

Possible values
25
maintenanceTypeCode
subscriber.maintenanceTypeCode
String

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

Payers may sometimes return other non-compliant values.

Possible values
001
memberId
subscriber.memberId
String

The member ID for the insurance policy.

middleName
subscriber.middleName
String

The member's middle name or initial.

militaryServiceRankCode
subscriber.militaryServiceRankCode
String

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

Payers may sometimes return other non-compliant values.

Possible values
A1
A2
A3
B1
B2
planDescription
subscriber.planDescription
String

Plan name

planNetworkDescription
subscriber.planNetworkDescription
String

Plan network name

planNetworkIdNumber
subscriber.planNetworkIdNumber
String

The network identification number associated with the insurance policy.

planNumber
subscriber.planNumber
String

The plan number associated with the insurance policy.

relationToSubscriber
subscriber.relationToSubscriber
String

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

Possible values
Self
relationToSubscriberCode
subscriber.relationToSubscriberCode
String

For the subscriber, this is always 18 for Self.

Possible values
18
responseProvider
subscriber.responseProvider
Object

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

Show attributes
aaaErrors
subscriber.responseProvider.aaaErrors
Array of Objects

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

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

The error code.

Payers may sometimes return other non-compliant values.

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

The error description.

field
subscriber.responseProvider.aaaErrors[].field
String

The error type, AAA.

followupAction
subscriber.responseProvider.aaaErrors[].followupAction
String

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

Payers may sometimes return other non-compliant values.

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

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

possibleResolutions
subscriber.responseProvider.aaaErrors[].possibleResolutions
String

Information to help you correct the error.

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

address
subscriber.responseProvider.address
Object

The provider's contact information.

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

The first line of the address.

address2
subscriber.responseProvider.address.address2
StringLength: 1 - 55

The second line of the address.

city
subscriber.responseProvider.address.city
StringLength: 2 - 30

The city.

countryCode
subscriber.responseProvider.address.countryCode
StringLength: 2

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

countrySubDivisionCode
subscriber.responseProvider.address.countrySubDivisionCode
StringLength: 1 - 3

The country subdivision code from Part 2 of ISO 3166.

postalCode
subscriber.responseProvider.address.postalCode
StringLength: 5 - 9

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

state
subscriber.responseProvider.address.state
String

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

Payers may sometimes return other non-compliant values.

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

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

entityIdentifier
subscriber.responseProvider.entityIdentifier
String

A code identifying the type of provider.

Payers may sometimes return other non-compliant values.

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

The type of entity.

Payers may sometimes return other non-compliant values.

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

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

middleName
subscriber.responseProvider.middleName
String

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

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

The Payor Identification.

pharmacyProcessorNumber
subscriber.responseProvider.pharmacyProcessorNumber
String

The pharmacy processor number.

providerCode
subscriber.responseProvider.providerCode
String

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

Payers may sometimes return other non-compliant values.

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

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

providerName
subscriber.responseProvider.providerName
String

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

providerOrgName
subscriber.responseProvider.providerOrgName
String

The provider's organization name.

referenceIdentification
subscriber.responseProvider.referenceIdentification
String

The Health Care Provider Taxonomy Code.

serviceProviderNumber
subscriber.responseProvider.serviceProviderNumber
String

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

servicesPlanID
subscriber.responseProvider.servicesPlanID
String

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

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

The Social Security Number (SSN).

suffix
subscriber.responseProvider.suffix
String

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

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

The member's Social Security Number (SSN).

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

The military service start date.

suffix
subscriber.suffix
String

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

uniqueHealthIdentifier
subscriber.uniqueHealthIdentifier
String

The member's unique health identifier.

subscriberTraceNumbers
Array of Objects

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

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

Array item
originatingCompanyIdentifier
subscriberTraceNumbers[].originatingCompanyIdentifier
String

The identifier of the organization that assigned the trace number.

referenceIdentification
subscriberTraceNumbers[].referenceIdentification
String

The unique trace number assigned to the transaction.

secondaryReferenceIdentification
subscriberTraceNumbers[].secondaryReferenceIdentification
String

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

traceType
subscriberTraceNumbers[].traceType
String

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

traceTypeCode
subscriberTraceNumbers[].traceTypeCode
String

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

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.

warnings
Array of Objects

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

Array item
code
warnings[].code
String

The warning code.

description
warnings[].description
String

The warning description.

x12
String

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

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

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