Real-Time Eligibility Check (270/271) JSON

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

POST/eligibility-check

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.

Test your integration with eligibility mock requests.

Authorization
RequiredHeader

A Stedi API Key for authentication. Supports both test and production API keys.

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. Note that Stedi blocks eligibility requests to CMS when any IP address in the chain – the originating IP address or any in the X-Forwarded-For header – is located outside the United States.

Visit CMS traceability requirements for details and examples.

Body

application/json
dependent
Object

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 information 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.
Show attributes
additionalInformation
dependent.additionalInformation
Object

Additional identification numbers for the dependent.

Show attributes
agencyClaimNumber
dependent.additionalInformation.agencyClaimNumber
StringLength: 1 - 50

The agency claim number associated with the dependent.

contractNumber
dependent.additionalInformation.contractNumber
StringLength: 1 - 50

The contract number associated with the dependent's insurance plan.

eligibilityCategory
dependent.additionalInformation.eligibilityCategory
StringLength: 1 - 50

The eligibility category for the dependent.

groupNumber
dependent.additionalInformation.groupNumber
StringLength: 1 - 50

The group number for the dependent's insurance plan.

groupOrPolicyNumber
dependent.additionalInformation.groupOrPolicyNumber
StringLength: 1 - 50

The group or policy number.

identificationCardSerialNumber
dependent.additionalInformation.identificationCardSerialNumber
StringLength: 1 - 50

The identification card serial number, when it differs from the member ID.

identityCardNumber
dependent.additionalInformation.identityCardNumber
StringLength: 1 - 50

The dependent's identity card number. Include this when this number differs from the subscriber's member ID.

insurancePolicyNumber
dependent.additionalInformation.insurancePolicyNumber
StringLength: 1 - 50

The dependent's insurance policy number.

issueNumber
dependent.additionalInformation.issueNumber
StringLength: 1 - 50

The issue number for the dependent's insurance policy.

mbi
dependent.additionalInformation.mbi
StringLength: 1 - 50

The dependent's Medicare Beneficiary Identifier (MBI). The 270 carries it as the Health Insurance Claim (HIC) number, which CMS retired in favor of the MBI.

medicalRecordId
dependent.additionalInformation.medicalRecordId
StringLength: 1 - 50

The medical record identification number for the dependent.

memberId
dependent.additionalInformation.memberId
StringLength: 1 - 50

The dependent's member ID. Only set this when checking eligibility with a Property and Casualty payer and the patient identifier is a member ID that would be used in an 837 claim. If the dependent has their own member ID for a health plan, identify them in the subscriber object instead.

patientAccountNumber
dependent.additionalInformation.patientAccountNumber
StringLength: 1 - 50

The patient account number for the dependent.

planNetworkId
dependent.additionalInformation.planNetworkId
StringLength: 1 - 50

The plan network identification number for the dependent.

planNumber
dependent.additionalInformation.planNumber
StringLength: 1 - 50

The plan number for the dependent's insurance plan.

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

The dependent's Social Security Number (SSN). Don't use this for Federally-administered programs, such as Medicare.

address
dependent.address
Object

The dependent's address.

Show attributes
addressLine1
dependent.address.addressLine1
StringRequiredLength: 1 - 55

The first line of the address.

addressLine2
dependent.address.addressLine2
StringLength: 1 - 55

The second line of the address.

city
dependent.address.city
StringRequiredLength: 2 - 30

The city.

country
dependent.address.country
StringLength: 2

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

countrySubdivision
dependent.address.countrySubdivision
StringLength: 1 - 3

The country subdivision code from Part 2 of ISO 3166.

postalCode
dependent.address.postalCode
StringLength: 5 - 9

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

state
dependent.address.state
StringLength: 2

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

dateOfBirth
dependent.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 may immediately return an error when it's not provided.

gender
dependent.gender
String

Code indicating the dependent's gender.

Possible values
FEMALE
MALE
name
dependent.name
ObjectRequired

The dependent's name.

Show attributes
person
dependent.name.person
ObjectRequired

The dependent's name.

Show attributes
firstName
dependent.name.person.firstName
StringRequiredLength: 1 - 35

The dependent's first name.

lastName
dependent.name.person.lastName
StringRequiredLength: 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.

middleName
dependent.name.person.middleName
StringLength: 1 - 25

The dependent's middle name or middle initial.

suffix
dependent.name.person.suffix
StringLength: 1 - 10

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

provider
dependent.provider
Object

Information about a provider associated with the dependent who isn't the entity requesting the eligibility check, such as a referring provider. The requesting provider is specified in the request's root provider.

Show attributes
code
dependent.provider.code
String

A code indicating the type of provider. Visit Eligibility code lists for a complete list.

Possible values
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
dependent.provider.reference
StringLength: 1 - 50

The provider's taxonomy code.

relationToSubscriber
dependent.relationToSubscriber
String

The dependent's relationship to the subscriber.

Possible values
SPOUSE
CHILD
OTHER_ADULT

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

encounter
Object

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

  • You can optionally include service type codes (STCs) or procedure codes to request benefits for specific services.
  • You can specify either a single service date or a date range using dates.service. The payer defaults to using the current date in their timezone if you don't include one.
  • When checking eligibility for today, omit the service date 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
additionalInformation
encounter.additionalInformation
Object

Additional information about the encounter.

Show attributes
priorAuthNumber
encounter.additionalInformation.priorAuthNumber
StringLength: 1 - 50

The prior authorization number for a particular benefit or procedure.

referralNumber
encounter.additionalInformation.referralNumber
StringLength: 1 - 50

The referral number for a particular benefit or procedure.

dates
encounter.dates
Object

The dates of service for the eligibility inquiry.

Show attributes
service
encounter.dates.service
Object

The service date or date range.

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

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

placeOfService
encounter.placeOfService
Object

The type of facility where providers deliver the service. Uses one of the place of service codes.

Show attributes
code
encounter.placeOfService.code
StringRequired

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
services
encounter.services
Array of Objects

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

  • You can include service type codes (STCs) or procedure codes to request specific types of benefits information. For medical benefits, you'll almost always need an STC because most medical payers don't support procedure codes (CPT/HCPCS/CDT). For dental benefits, many payers support procedure codes. Visit STCs and procedure codes for guidance on choosing the right codes.
  • We recommend including one service per request. Not all payers support all service type codes, not all payers support multiple codes in the same request, and payers aren't required to respond with exactly the same codes you sent.
  • If you don't specify any services, Stedi defaults to using service type code 30 (Health Benefit Plan Coverage).
Array item
system
encounter.services[].system
StringRequired

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
encounter.services[].value
StringRequiredLength: 1 - 48

The service or procedure code value.

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.

payerId
StringRequiredLength: 1 - 80

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.
  • You must include leading 0 characters - payer IDs are alphanumeric strings and must be treated as complete strings, not integers. For example, use 00540 for SISCO, not 540.
payerName
StringLength: 1 - 60

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

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 provider's name as either a person (with name.person) or an organization (with name.organization).
  • 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 tin or ssn.
  • Don't include additional properties, such as tin or address, unless they are specifically required or suggested by the payer.
Show attributes
additionalInformation
provider.additionalInformation
Object

Additional identification numbers for the provider. Only include when specifically required by a payer.

Show attributes
contractNumber
provider.additionalInformation.contractNumber
StringLength: 1 - 50

The provider's contract number.

electronicDevicePin
provider.additionalInformation.electronicDevicePin
StringLength: 1 - 50

The provider's electronic device PIN.

facilityIdNumber
provider.additionalInformation.facilityIdNumber
StringLength: 1 - 50

The ID number for the provider's facility.

facilityNetworkId
provider.additionalInformation.facilityNetworkId
StringLength: 1 - 50

The provider's facility network identification number.

medicaidProviderNumber
provider.additionalInformation.medicaidProviderNumber
StringLength: 1 - 50

The provider's Medicaid provider number.

medicareProviderNumber
provider.additionalInformation.medicareProviderNumber
StringLength: 1 - 50

The provider's Medicare provider number.

personalIdentificationNumber
provider.additionalInformation.personalIdentificationNumber
StringLength: 1 - 50

The provider's personal identification number.

planNetworkId
provider.additionalInformation.planNetworkId
StringLength: 1 - 50

The provider's plan network identification number.

priorIdentifierNumber
provider.additionalInformation.priorIdentifierNumber
StringLength: 1 - 50

The provider's prior identifier number.

stateLicense
provider.additionalInformation.stateLicense
Object

The provider's state license information. If you include this, you must provide at least the license number.

Show attributes
number
provider.additionalInformation.stateLicense.number
StringRequiredLength: 1 - 50

The provider's state license number.

state
provider.additionalInformation.stateLicense.state
StringLength: 2

The state or province code that issued the license.

submitterId
provider.additionalInformation.submitterId
StringLength: 1 - 50

The provider's submitter ID.

userId
provider.additionalInformation.userId
StringLength: 1 - 50

The provider's user ID.

address
provider.address
Object

The provider's address. 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.

Show attributes
addressLine1
provider.address.addressLine1
StringRequiredLength: 1 - 55

The first line of the address.

addressLine2
provider.address.addressLine2
StringLength: 1 - 55

The second line of the address.

city
provider.address.city
StringRequiredLength: 2 - 30

The city.

country
provider.address.country
StringLength: 2

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

countrySubdivision
provider.address.countrySubdivision
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
StringLength: 2

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

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

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin. Only include when the payer requires it.

name
provider.name
ObjectRequired

The provider's name, as either a person or an organization.

2 variants:
person
provider.name.person
ObjectRequired

The name of a provider who is a person.

Show attributes
firstName
provider.name.person.firstName
StringLength: 1 - 35

The provider's first name.

lastName
provider.name.person.lastName
StringRequiredLength: 1 - 60

The provider's last name.

middleName
provider.name.person.middleName
StringLength: 1 - 25

The provider's middle name or middle initial.

suffix
provider.name.person.suffix
StringLength: 1 - 10

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

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

The provider's National Provider Identifier (NPI).

All healthcare providers eligible for an NPI must provide this identifier. Some non-traditional providers such as transportation services, durable medical equipment (DME) suppliers, or alternative medicine practitioners can't receive an NPI. If the provider doesn't have an NPI, payers virtually never support requests with alternate IDs. 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 tin or ssn instead.

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.

provider
provider.provider
Object

Information about the provider's role and taxonomy. Only include when required by a payer.

Show attributes
code
provider.provider.code
String

A code indicating the type of provider. Visit Eligibility code lists for a complete list.

Possible values
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
provider.provider.reference
StringLength: 1 - 50

The provider's taxonomy code.

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.

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.tin instead of this field.
  • Don't use this for Federally-administered programs, such as Medicare.
tin
provider.tin
StringRegex pattern: ^\d{9}$

The provider's Federal Taxpayer Identification Number. This is typically the provider's EIN (Employer Identification Number), but you may use the provider's SSN if the provider doesn't have an EIN. Only include if the payer requires it.

type
provider.type
String

The type of provider making the request.

Possible values
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
HOSPITAL
FACILITY
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 dependent empty.

  • At a minimum, our API requires that you supply at least one of these fields in the request: memberId, dateOfBirth, or name.person.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, name.person.firstName, and name.person.lastName, payers must 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
additionalInformation
subscriber.additionalInformation
Object

Additional identification numbers for the subscriber. 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.additionalInformation.agencyClaimNumber
StringLength: 1 - 50

The agency claim number associated with the subscriber.

caseNumber
subscriber.additionalInformation.caseNumber
StringLength: 1 - 50

The case number associated with the subscriber.

contractNumber
subscriber.additionalInformation.contractNumber
StringLength: 1 - 50

The contract number associated with the subscriber's insurance plan.

groupNumber
subscriber.additionalInformation.groupNumber
StringLength: 1 - 50

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

groupOrPolicyNumber
subscriber.additionalInformation.groupOrPolicyNumber
StringLength: 1 - 50

The group or policy number.

identificationCardSerialNumber
subscriber.additionalInformation.identificationCardSerialNumber
StringLength: 1 - 50

The identification card serial number, when it differs from the member ID.

identityCardNumber
subscriber.additionalInformation.identityCardNumber
StringLength: 1 - 50

The subscriber's identity card number. Include this property when this number differs from the subscriber's member ID. This is common in Medicaid.

insurancePolicyNumber
subscriber.additionalInformation.insurancePolicyNumber
StringLength: 1 - 50

The subscriber's insurance policy number.

mbi
subscriber.additionalInformation.mbi
StringLength: 1 - 50

The subscriber's Medicare Beneficiary Identifier (MBI). The 270 carries it as the Health Insurance Claim (HIC) number, which CMS retired in favor of the MBI. Don't include it unless it differs from the member ID.

medicaidRecipientId
subscriber.additionalInformation.medicaidRecipientId
StringLength: 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). Don't supply this value unless it differs from the memberId.

medicalRecordId
subscriber.additionalInformation.medicalRecordId
StringLength: 1 - 50

The medical record identification number for the subscriber.

patientAccountNumber
subscriber.additionalInformation.patientAccountNumber
StringLength: 1 - 50

The patient account number for the subscriber.

planNetworkId
subscriber.additionalInformation.planNetworkId
StringLength: 1 - 50

The plan network identification number for the subscriber.

planNumber
subscriber.additionalInformation.planNumber
StringLength: 1 - 50

The plan number for the subscriber's insurance plan.

ssn
subscriber.additionalInformation.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.

address
subscriber.address
Object

The subscriber's address.

Show attributes
addressLine1
subscriber.address.addressLine1
StringLength: 1 - 55

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

addressLine2
subscriber.address.addressLine2
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.

country
subscriber.address.country
StringLength: 2

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

countrySubdivision
subscriber.address.countrySubdivision
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
StringLength: 2

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

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.

gender
subscriber.gender
String

Code indicating the subscriber's gender.

Possible values
FEMALE
MALE
memberId
subscriber.memberId
StringLength: 2 - 80

The member ID for the subscriber's insurance policy.

name
subscriber.name
Object

The subscriber's name, as either a person or an organization.

2 variants:
person
subscriber.name.person
ObjectRequired

The name of a subscriber who is a person.

Show attributes
firstName
subscriber.name.person.firstName
StringLength: 1 - 35

The subscriber's first name.

lastName
subscriber.name.person.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.

middleName
subscriber.name.person.middleName
StringLength: 1 - 25

The subscriber's middle name or middle initial.

suffix
subscriber.name.person.suffix
StringLength: 1 - 10

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

provider
subscriber.provider
Object

Information about a provider associated with the subscriber who isn't the entity requesting the eligibility check, such as a referring provider. The requesting provider is specified in the request's root provider.

Show attributes
code
subscriber.provider.code
String

A code indicating the type of provider. Visit Eligibility code lists for a complete list.

Possible values
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
subscriber.provider.reference
StringLength: 1 - 50

The provider's taxonomy code.

Response

application/json
dependent
Object

Information about the dependent from the eligibility check request. Note that the payer may return the dependent in the subscriber object instead. When present, this object will always include the dependent's name for identification, but many payers also include the date of birth and other identifying information.

Show attributes
additionalInformation
dependent.additionalInformation
Object

Additional identifying information for the dependent.

Show attributes
agencyClaimNumber
dependent.additionalInformation.agencyClaimNumber
String

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

classOfContractCode
dependent.additionalInformation.classOfContractCode
String

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

contractNumber
dependent.additionalInformation.contractNumber
String

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

eligibilityCategory
dependent.additionalInformation.eligibilityCategory
String

The eligibility category for the dependent.

familyUnitNumber
dependent.additionalInformation.familyUnitNumber
String

The family unit number.

group
dependent.additionalInformation.group
Object

The group number and group description.

Show attributes
name
dependent.additionalInformation.group.name
String

The name or description associated with number.

number
dependent.additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
dependent.additionalInformation.groupOrPolicyNumber
String

The group or policy number.

identificationCardSerialNumber
dependent.additionalInformation.identificationCardSerialNumber
String

Used when the identification card has a number in addition to the member ID.

identityCardNumber
dependent.additionalInformation.identityCardNumber
String

The identity card number. Present when this number differs from the member ID.

insurancePolicyNumber
dependent.additionalInformation.insurancePolicyNumber
String

The insurance policy number.

issueNumber
dependent.additionalInformation.issueNumber
String

The issue number.

mbi
dependent.additionalInformation.mbi
String

The patient's Medicare Beneficiary Identifier (MBI). If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
dependent.additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalRecordId
dependent.additionalInformation.medicalRecordId
String

The medical record identification number.

memberId
dependent.additionalInformation.memberId
String

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

patientAccountNumber
dependent.additionalInformation.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.

plan
dependent.additionalInformation.plan
Object

The plan number and plan description.

Show attributes
name
dependent.additionalInformation.plan.name
String

The name or description associated with number.

number
dependent.additionalInformation.plan.number
StringRequired

The identification number.

planNetwork
dependent.additionalInformation.planNetwork
Object

The plan network identification number and the plan, group, or plan network name.

Show attributes
name
dependent.additionalInformation.planNetwork.name
String

The name or description associated with number.

number
dependent.additionalInformation.planNetwork.number
StringRequired

The identification number.

priorIdentifierNumber
dependent.additionalInformation.priorIdentifierNumber
String

The prior identifier number.

ssn
dependent.additionalInformation.ssn
String

The patient's Social Security Number (SSN).

address
dependent.address
Object

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

Show attributes
addressLine1
dependent.address.addressLine1
String

The first line of the address.

addressLine2
dependent.address.addressLine2
String

The second line of the address.

city
dependent.address.city
String

The city.

country
dependent.address.country
String

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

countrySubdivision
dependent.address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
dependent.address.postalCode
String

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

state
dependent.address.state
String

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

birthSequenceNumber
dependent.birthSequenceNumber
Integer

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

The patient's date of birth as an ISO 8601 YYYY-MM-DD string. For example, 1985-03-15 represents March 15, 1985.

dates
dependent.dates
Object

Dates associated with patient attributes, as ISO 8601 date ranges.

Show attributes
added
dependent.dates.added
Object

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

Show attributes
end
dependent.dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

admission
dependent.dates.admission
Object

The admission date or dates.

Show attributes
end
dependent.dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

certification
dependent.dates.certification
Object

The certification date.

Show attributes
end
dependent.dates.certification.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

cobra
dependent.dates.cobra
Object

Consolidated Omnibus Budget Reconciliation Act (COBRA) date.

Show attributes
end
dependent.dates.cobra.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

dateOfDeath
dependent.dates.dateOfDeath
Object

The date of death.

Show attributes
end
dependent.dates.dateOfDeath.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

dateOfLastUpdate
dependent.dates.dateOfLastUpdate
Object

The date when the patient information was last updated.

Show attributes
end
dependent.dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

discharge
dependent.dates.discharge
Object

The discharge date.

Show attributes
end
dependent.dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

effectiveDateOfChange
dependent.dates.effectiveDateOfChange
Object

The effective date of change.

Show attributes
end
dependent.dates.effectiveDateOfChange.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

eligibility
dependent.dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
dependent.dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

enrollment
dependent.dates.enrollment
Object

The enrollment date.

Show attributes
end
dependent.dates.enrollment.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

issue
dependent.dates.issue
Object

The issue date.

Show attributes
end
dependent.dates.issue.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

plan
dependent.dates.plan
Object

Plan effective dates.

Show attributes
end
dependent.dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

policy
dependent.dates.policy
Object

The policy date.

Show attributes
end
dependent.dates.policy.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

premiumPaidToDate
dependent.dates.premiumPaidToDate
Object

Premium paid to date.

Show attributes
end
dependent.dates.premiumPaidToDate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

service
dependent.dates.service
Object

The service date or dates.

Show attributes
end
dependent.dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

status
dependent.dates.status
Object

The status date.

Show attributes
end
dependent.dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

gender
dependent.gender
String

Code indicating the patient's gender.

Payers may sometimes return other non-compliant values.

Possible values
FEMALE
MALE
UNKNOWN
maintenance
dependent.maintenance
Object

Maintenance information indicating whether the payer signaled that the patient's identifying information differs from what you submitted.

Show attributes
indicator
dependent.maintenance.indicator
String

Whether the payer signaled that the patient's identifying information differs from what you submitted.

Possible values
NONE
PAYER_INDICATED
name
dependent.name
ObjectRequired

The dependent's name.

Show attributes
person
dependent.name.person
ObjectRequired

The person's name.

Show attributes
firstName
dependent.name.person.firstName
String

The person's first name.

lastName
dependent.name.person.lastName
String

The person's last name.

middleName
dependent.name.person.middleName
String

The person's middle name or initial.

suffix
dependent.name.person.suffix
String

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

provider
dependent.provider
Object

Information about a provider associated with this entity.

Show attributes
code
dependent.provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
dependent.provider.reference
String

The provider's taxonomy code.

relationToSubscriber
dependent.relationToSubscriber
String

The dependent's relationship to the subscriber.

Payers may sometimes return other non-compliant values.

Possible values
SPOUSE
CHILD
EMPLOYEE
UNKNOWN
ORGAN_DONOR

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

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

errors
Array of Objects

AAA rejection errors from the payer. AAA errors specify the reasons for the rejection and any recommended follow-up actions.

Array item
code
errors[].code
StringRequired

The AAA reject reason code.

description
errors[].description
StringRequired

The human-readable description of the error.

followupAction
errors[].followupAction
StringRequired

The recommended follow-up action.

location
errors[].location
StringRequired

The location in the 271 response where the error occurred.

Payers may sometimes return other non-compliant values.

Possible values
ENVELOPE
PAYER
PROVIDER
SUBSCRIBER
SUBSCRIBER_BENEFITS
possibleResolutions
errors[].possibleResolutions
String

Detailed guidance on possible ways to resolve the error.

id
StringRequired

A globally unique identifier for this eligibility check across all Stedi accounts. It's formatted as ec_<uuid>. For example: ec_550e8400-e29b-41d4-a716-446655440000. You can use this ID to track this eligibility check and to construct deep links to eligibility checks in the Stedi portal.

meta
Object

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

Show attributes
outboundTraceId
meta.outboundTraceId
String

The transaction identifier Stedi assigns to the outbound request's BHT03 element.

Although this is a unique identifier, we recommend using id instead to identify and track eligibility checks. An eligibility check's id is guaranteed to be globally unique, and you can use it to deep link to the eligibility check's results within the Stedi portal.

subscriberTraceNumbers
meta.subscriberTraceNumbers
Array of Objects

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

Array item
originatingCompanyIdentifier
meta.subscriberTraceNumbers[].originatingCompanyIdentifier
String

The identifier of the organization that assigned the trace number.

referenceIdentification
meta.subscriberTraceNumbers[].referenceIdentification
String

The unique trace number assigned to the transaction.

secondaryReferenceIdentification
meta.subscriberTraceNumbers[].secondaryReferenceIdentification
String

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

type
meta.subscriberTraceNumbers[].type
String

Whether the payer assigned this trace number to the current transaction (CURRENT_TRANSACTION) or is echoing one from the original request (REFERENCED_TRANSACTION).

Payers may sometimes return other non-compliant values.

Possible values
CURRENT_TRANSACTION
REFERENCED_TRANSACTION
traceId
meta.traceId
String

The transaction identifier from the response's BHT03 element. Matches the request's BHT03 if provided, otherwise matches the Stedi-generated outboundTraceId.

payer
ObjectRequired

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
contacts
payer.contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
payer.contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
payer.contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
payer.contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
payer.contacts[].name
String

The name of the contact person.

phoneNumbers
payer.contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
payer.contacts[].urls
Array of Strings

The contact's URLs.

ein
payer.ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
payer.etin
String

Electronic Transmitter Identification Number.

identification
payer.identification
String

Typically the identification the payer reported for itself in the 271 response (NM109 with the PI qualifier). This value comes from the payer and may not match a Stedi Payer Network ID; use the root-level payerId for the canonical payer ID.

naicId
payer.naicId
String

National Association of Insurance Commissioners Identification

name
payer.name
Object

The entity's name, as either a person or an organization.

2 variants:
person
payer.name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
payer.name.person.firstName
String

The person's first name.

lastName
payer.name.person.lastName
String

The person's last name.

middleName
payer.name.person.middleName
String

The person's middle name or initial.

suffix
payer.name.person.suffix
String

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

tin
payer.tin
String

The Federal Taxpayer Identification Number.

type
payer.type
StringRequired

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
payerId
String

The primary payer ID from the Stedi Payer Network. This ID is consistent across eligibility and claims systems and matches the payer ID printed on the member's ID card. You can use it as the payerId in subsequent eligibility check requests.

plans
Array of Objects

The patient's insurance plans, grouped by plan name. Each plan contains the benefits that apply to the patient.

Array item
benefits
plans[].benefits
ObjectRequired

Benefit information from the payer, organized into categories like cost-sharing (co-insurance, deductibles, copayments), coverage details (exclusions, limitations), and eligibility statuses.

Show attributes
benefitDescription
plans[].benefits.benefitDescription
Array of Objects

A list of free-text benefit descriptions from the payer.

Payers sometimes use this type to communicate information that's difficult to capture elsewhere in the response. The description is included as free text in messages or identifiers in additionalInformation.

Array item
additionalInformation
plans[].benefits.benefitDescription[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.benefitDescription[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.benefitDescription[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.benefitDescription[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.benefitDescription[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.benefitDescription[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.benefitDescription[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.benefitDescription[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.benefitDescription[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.benefitDescription[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.benefitDescription[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.benefitDescription[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.benefitDescription[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.benefitDescription[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.benefitDescription[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.benefitDescription[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.benefitDescription[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.benefitDescription[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.benefitDescription[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.benefitDescription[].amount
String

The monetary amount associated with this benefit.

coverageLevel
plans[].benefits.benefitDescription[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.benefitDescription[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.benefitDescription[].dates.added
Object

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

Show attributes
end
plans[].benefits.benefitDescription[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.benefitDescription[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.benefitDescription[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.benefitDescription[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.benefitDescription[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.benefitDescription[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.benefitDescription[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.benefitDescription[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.benefitDescription[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.benefitDescription[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.benefitDescription[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.benefitDescription[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.benefitDescription[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.benefitDescription[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.benefitDescription[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.benefitDescription[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.benefitDescription[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.benefitDescription[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.benefitDescription[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.benefitDescription[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.benefitDescription[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.benefitDescription[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.benefitDescription[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.benefitDescription[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.benefitDescription[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.benefitDescription[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.benefitDescription[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.benefitDescription[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.benefitDescription[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.benefitDescription[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.benefitDescription[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.benefitDescription[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.benefitDescription[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.benefitDescription[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.benefitDescription[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.benefitDescription[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.benefitDescription[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.benefitDescription[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.benefitDescription[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.benefitDescription[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.benefitDescription[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.benefitDescription[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.benefitDescription[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.benefitDescription[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.benefitDescription[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.benefitDescription[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.benefitDescription[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
messages
plans[].benefits.benefitDescription[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.benefitDescription[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.benefitDescription[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.benefitDescription[].network.id
String

The plan network identification number.

indicator
plans[].benefits.benefitDescription[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
percent
plans[].benefits.benefitDescription[].percent
String

The percentage associated with this benefit.

placesOfService
plans[].benefits.benefitDescription[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.benefitDescription[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.benefitDescription[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.benefitDescription[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.benefitDescription[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
relatedEntities
plans[].benefits.benefitDescription[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.benefitDescription[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.benefitDescription[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.benefitDescription[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.benefitDescription[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.benefitDescription[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.benefitDescription[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.benefitDescription[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.benefitDescription[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.benefitDescription[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.benefitDescription[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.benefitDescription[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.benefitDescription[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.benefitDescription[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.benefitDescription[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.benefitDescription[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.benefitDescription[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.benefitDescription[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.benefitDescription[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.benefitDescription[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.benefitDescription[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.benefitDescription[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.benefitDescription[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.benefitDescription[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.benefitDescription[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.benefitDescription[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.benefitDescription[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.benefitDescription[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.benefitDescription[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.benefitDescription[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.benefitDescription[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.benefitDescription[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.benefitDescription[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.benefitDescription[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.benefitDescription[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.benefitDescription[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.benefitDescription[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.benefitDescription[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.benefitDescription[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.benefitDescription[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.benefitDescription[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.benefitDescription[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.benefitDescription[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.benefitDescription[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.benefitDescription[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.benefitDescription[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.benefitDescription[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.benefitDescription[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.benefitDescription[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.benefitDescription[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.benefitDescription[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

benefitDisclaimer
plans[].benefits.benefitDisclaimer
Array of Objects

A list of disclaimers from the payer.

A legal or advisory disclaimer attached to the benefit information. The X12 standard discourages use of this type, but many commercial payers still send disclaimers. When present, the disclaimer text arrives in messages, and there should be only one disclaimer per individual response.

Array item
additionalInformation
plans[].benefits.benefitDisclaimer[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.benefitDisclaimer[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.benefitDisclaimer[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.benefitDisclaimer[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.benefitDisclaimer[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.benefitDisclaimer[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.benefitDisclaimer[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.benefitDisclaimer[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.benefitDisclaimer[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.benefitDisclaimer[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.benefitDisclaimer[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.benefitDisclaimer[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.benefitDisclaimer[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.benefitDisclaimer[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.benefitDisclaimer[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.benefitDisclaimer[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.benefitDisclaimer[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.benefitDisclaimer[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.benefitDisclaimer[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.benefitDisclaimer[].amount
String

The monetary amount associated with this benefit.

coverageLevel
plans[].benefits.benefitDisclaimer[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.benefitDisclaimer[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.benefitDisclaimer[].dates.added
Object

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

Show attributes
end
plans[].benefits.benefitDisclaimer[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.benefitDisclaimer[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.benefitDisclaimer[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.benefitDisclaimer[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.benefitDisclaimer[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.benefitDisclaimer[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.benefitDisclaimer[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.benefitDisclaimer[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.benefitDisclaimer[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.benefitDisclaimer[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.benefitDisclaimer[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.benefitDisclaimer[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.benefitDisclaimer[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.benefitDisclaimer[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.benefitDisclaimer[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.benefitDisclaimer[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.benefitDisclaimer[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.benefitDisclaimer[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.benefitDisclaimer[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.benefitDisclaimer[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.benefitDisclaimer[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.benefitDisclaimer[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.benefitDisclaimer[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.benefitDisclaimer[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.benefitDisclaimer[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.benefitDisclaimer[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.benefitDisclaimer[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.benefitDisclaimer[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.benefitDisclaimer[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.benefitDisclaimer[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.benefitDisclaimer[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.benefitDisclaimer[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.benefitDisclaimer[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.benefitDisclaimer[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.benefitDisclaimer[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.benefitDisclaimer[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.benefitDisclaimer[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.benefitDisclaimer[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.benefitDisclaimer[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.benefitDisclaimer[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.benefitDisclaimer[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.benefitDisclaimer[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.benefitDisclaimer[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.benefitDisclaimer[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.benefitDisclaimer[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.benefitDisclaimer[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.benefitDisclaimer[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
messages
plans[].benefits.benefitDisclaimer[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.benefitDisclaimer[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.benefitDisclaimer[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.benefitDisclaimer[].network.id
String

The plan network identification number.

indicator
plans[].benefits.benefitDisclaimer[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
percent
plans[].benefits.benefitDisclaimer[].percent
String

The percentage associated with this benefit.

placesOfService
plans[].benefits.benefitDisclaimer[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.benefitDisclaimer[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.benefitDisclaimer[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.benefitDisclaimer[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.benefitDisclaimer[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
relatedEntities
plans[].benefits.benefitDisclaimer[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.benefitDisclaimer[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.benefitDisclaimer[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.benefitDisclaimer[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.benefitDisclaimer[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.benefitDisclaimer[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.benefitDisclaimer[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.benefitDisclaimer[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.benefitDisclaimer[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.benefitDisclaimer[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.benefitDisclaimer[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.benefitDisclaimer[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.benefitDisclaimer[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.benefitDisclaimer[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.benefitDisclaimer[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.benefitDisclaimer[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.benefitDisclaimer[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.benefitDisclaimer[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.benefitDisclaimer[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.benefitDisclaimer[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.benefitDisclaimer[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.benefitDisclaimer[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.benefitDisclaimer[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.benefitDisclaimer[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.benefitDisclaimer[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.benefitDisclaimer[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.benefitDisclaimer[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.benefitDisclaimer[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.benefitDisclaimer[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.benefitDisclaimer[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.benefitDisclaimer[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.benefitDisclaimer[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.benefitDisclaimer[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.benefitDisclaimer[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.benefitDisclaimer[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.benefitDisclaimer[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.benefitDisclaimer[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.benefitDisclaimer[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.benefitDisclaimer[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.benefitDisclaimer[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.benefitDisclaimer[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.benefitDisclaimer[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.benefitDisclaimer[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.benefitDisclaimer[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.benefitDisclaimer[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.benefitDisclaimer[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.benefitDisclaimer[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.benefitDisclaimer[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.benefitDisclaimer[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.benefitDisclaimer[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.benefitDisclaimer[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

cannotProcess
plans[].benefits.cannotProcess
Array of Objects

A list of entries indicating the payer couldn't process your request.

Indicates that the payer couldn't process your request. A common cause is requesting benefits information for a service type or procedure code the payer doesn't support.

Array item
additionalInformation
plans[].benefits.cannotProcess[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.cannotProcess[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.cannotProcess[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.cannotProcess[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.cannotProcess[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.cannotProcess[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.cannotProcess[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.cannotProcess[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.cannotProcess[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.cannotProcess[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.cannotProcess[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.cannotProcess[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.cannotProcess[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.cannotProcess[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.cannotProcess[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.cannotProcess[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.cannotProcess[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.cannotProcess[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.cannotProcess[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.cannotProcess[].amount
String

The monetary amount associated with this benefit.

coverageLevel
plans[].benefits.cannotProcess[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.cannotProcess[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.cannotProcess[].dates.added
Object

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

Show attributes
end
plans[].benefits.cannotProcess[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.cannotProcess[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.cannotProcess[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.cannotProcess[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.cannotProcess[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.cannotProcess[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.cannotProcess[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.cannotProcess[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.cannotProcess[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.cannotProcess[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.cannotProcess[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.cannotProcess[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.cannotProcess[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.cannotProcess[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.cannotProcess[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.cannotProcess[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.cannotProcess[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.cannotProcess[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.cannotProcess[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.cannotProcess[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.cannotProcess[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.cannotProcess[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.cannotProcess[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.cannotProcess[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.cannotProcess[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.cannotProcess[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.cannotProcess[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.cannotProcess[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.cannotProcess[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.cannotProcess[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.cannotProcess[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.cannotProcess[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.cannotProcess[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.cannotProcess[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.cannotProcess[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.cannotProcess[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.cannotProcess[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.cannotProcess[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.cannotProcess[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.cannotProcess[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.cannotProcess[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.cannotProcess[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.cannotProcess[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.cannotProcess[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.cannotProcess[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.cannotProcess[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.cannotProcess[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
messages
plans[].benefits.cannotProcess[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.cannotProcess[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.cannotProcess[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.cannotProcess[].network.id
String

The plan network identification number.

indicator
plans[].benefits.cannotProcess[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
percent
plans[].benefits.cannotProcess[].percent
String

The percentage associated with this benefit.

placesOfService
plans[].benefits.cannotProcess[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.cannotProcess[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.cannotProcess[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.cannotProcess[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.cannotProcess[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
relatedEntities
plans[].benefits.cannotProcess[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.cannotProcess[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.cannotProcess[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.cannotProcess[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.cannotProcess[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.cannotProcess[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.cannotProcess[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.cannotProcess[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.cannotProcess[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.cannotProcess[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.cannotProcess[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.cannotProcess[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.cannotProcess[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.cannotProcess[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.cannotProcess[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.cannotProcess[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.cannotProcess[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.cannotProcess[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.cannotProcess[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.cannotProcess[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.cannotProcess[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.cannotProcess[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.cannotProcess[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.cannotProcess[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.cannotProcess[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.cannotProcess[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.cannotProcess[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.cannotProcess[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.cannotProcess[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.cannotProcess[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.cannotProcess[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.cannotProcess[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.cannotProcess[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.cannotProcess[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.cannotProcess[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.cannotProcess[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.cannotProcess[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.cannotProcess[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.cannotProcess[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.cannotProcess[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.cannotProcess[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.cannotProcess[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.cannotProcess[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.cannotProcess[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.cannotProcess[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.cannotProcess[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.cannotProcess[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.cannotProcess[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.cannotProcess[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.cannotProcess[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.cannotProcess[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

cardReportedStolen
plans[].benefits.cardReportedStolen
Array of Objects

A list of entries indicating the patient's card has been reported lost or stolen.

This typically means that the payer has flagged the patient's member ID to prevent identity theft. The patient may still have active coverage, but you likely won't be able to run transactions with the patient's information until they resolve the issue.

Array item
additionalInformation
plans[].benefits.cardReportedStolen[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.cardReportedStolen[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.cardReportedStolen[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.cardReportedStolen[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.cardReportedStolen[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.cardReportedStolen[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.cardReportedStolen[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.cardReportedStolen[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.cardReportedStolen[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.cardReportedStolen[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.cardReportedStolen[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.cardReportedStolen[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.cardReportedStolen[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.cardReportedStolen[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.cardReportedStolen[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.cardReportedStolen[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.cardReportedStolen[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.cardReportedStolen[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.cardReportedStolen[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.cardReportedStolen[].amount
String

The monetary amount associated with this benefit.

coverageLevel
plans[].benefits.cardReportedStolen[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.cardReportedStolen[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.cardReportedStolen[].dates.added
Object

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

Show attributes
end
plans[].benefits.cardReportedStolen[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.cardReportedStolen[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.cardReportedStolen[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.cardReportedStolen[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.cardReportedStolen[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.cardReportedStolen[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.cardReportedStolen[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.cardReportedStolen[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.cardReportedStolen[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.cardReportedStolen[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.cardReportedStolen[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.cardReportedStolen[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.cardReportedStolen[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.cardReportedStolen[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.cardReportedStolen[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.cardReportedStolen[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.cardReportedStolen[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.cardReportedStolen[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.cardReportedStolen[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.cardReportedStolen[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.cardReportedStolen[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.cardReportedStolen[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.cardReportedStolen[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.cardReportedStolen[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.cardReportedStolen[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.cardReportedStolen[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.cardReportedStolen[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.cardReportedStolen[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.cardReportedStolen[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.cardReportedStolen[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.cardReportedStolen[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.cardReportedStolen[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.cardReportedStolen[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.cardReportedStolen[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.cardReportedStolen[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.cardReportedStolen[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.cardReportedStolen[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.cardReportedStolen[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.cardReportedStolen[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.cardReportedStolen[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.cardReportedStolen[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.cardReportedStolen[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.cardReportedStolen[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.cardReportedStolen[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.cardReportedStolen[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.cardReportedStolen[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.cardReportedStolen[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
messages
plans[].benefits.cardReportedStolen[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.cardReportedStolen[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.cardReportedStolen[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.cardReportedStolen[].network.id
String

The plan network identification number.

indicator
plans[].benefits.cardReportedStolen[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
percent
plans[].benefits.cardReportedStolen[].percent
String

The percentage associated with this benefit.

placesOfService
plans[].benefits.cardReportedStolen[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.cardReportedStolen[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.cardReportedStolen[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.cardReportedStolen[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.cardReportedStolen[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
relatedEntities
plans[].benefits.cardReportedStolen[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.cardReportedStolen[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.cardReportedStolen[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.cardReportedStolen[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.cardReportedStolen[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.cardReportedStolen[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.cardReportedStolen[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.cardReportedStolen[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.cardReportedStolen[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.cardReportedStolen[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.cardReportedStolen[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.cardReportedStolen[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.cardReportedStolen[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.cardReportedStolen[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.cardReportedStolen[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.cardReportedStolen[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.cardReportedStolen[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.cardReportedStolen[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.cardReportedStolen[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.cardReportedStolen[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.cardReportedStolen[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.cardReportedStolen[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.cardReportedStolen[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.cardReportedStolen[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.cardReportedStolen[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.cardReportedStolen[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.cardReportedStolen[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.cardReportedStolen[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.cardReportedStolen[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.cardReportedStolen[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.cardReportedStolen[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.cardReportedStolen[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.cardReportedStolen[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.cardReportedStolen[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.cardReportedStolen[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.cardReportedStolen[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.cardReportedStolen[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.cardReportedStolen[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.cardReportedStolen[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.cardReportedStolen[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.cardReportedStolen[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.cardReportedStolen[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.cardReportedStolen[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.cardReportedStolen[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.cardReportedStolen[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.cardReportedStolen[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.cardReportedStolen[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.cardReportedStolen[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.cardReportedStolen[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.cardReportedStolen[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.cardReportedStolen[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

coInsurance
plans[].benefits.coInsurance
Array of Objects

A list of co-insurance benefit entries from the payer.

The percent is the patient's share of costs, expressed as a decimal (such as 0.8 for 80%). The decimal precision reflects what the payer sent. A value of 0 indicates the payer reported no co-insurance responsibility.

Array item
additionalInformation
plans[].benefits.coInsurance[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.coInsurance[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.coInsurance[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.coInsurance[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.coInsurance[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.coInsurance[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.coInsurance[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.coInsurance[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.coInsurance[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.coInsurance[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.coInsurance[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.coInsurance[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.coInsurance[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.coInsurance[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.coInsurance[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.coInsurance[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.coInsurance[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.coInsurance[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.coInsurance[].additionalInformation.referralNumber
String

The referral number.

coverageLevel
plans[].benefits.coInsurance[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.coInsurance[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.coInsurance[].dates.added
Object

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

Show attributes
end
plans[].benefits.coInsurance[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coInsurance[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.coInsurance[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.coInsurance[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coInsurance[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.coInsurance[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.coInsurance[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coInsurance[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.coInsurance[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.coInsurance[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coInsurance[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.coInsurance[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.coInsurance[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coInsurance[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.coInsurance[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.coInsurance[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coInsurance[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.coInsurance[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.coInsurance[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coInsurance[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.coInsurance[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.coInsurance[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coInsurance[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.coInsurance[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.coInsurance[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coInsurance[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.coInsurance[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.coInsurance[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coInsurance[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.coInsurance[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.coInsurance[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coInsurance[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.coInsurance[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.coInsurance[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coInsurance[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.coInsurance[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.coInsurance[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coInsurance[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.coInsurance[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.coInsurance[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coInsurance[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.coInsurance[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.coInsurance[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.coInsurance[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.coInsurance[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.coInsurance[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.coInsurance[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
messages
plans[].benefits.coInsurance[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.coInsurance[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.coInsurance[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.coInsurance[].network.id
String

The plan network identification number.

indicator
plans[].benefits.coInsurance[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
percent
plans[].benefits.coInsurance[].percent
StringRequired

The percentage value for this benefit, expressed as a decimal (e.g., 0.80 for 80%).

placesOfService
plans[].benefits.coInsurance[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.coInsurance[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.coInsurance[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.coInsurance[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.coInsurance[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
relatedEntities
plans[].benefits.coInsurance[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.coInsurance[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.coInsurance[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.coInsurance[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.coInsurance[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.coInsurance[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.coInsurance[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.coInsurance[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.coInsurance[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.coInsurance[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.coInsurance[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.coInsurance[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.coInsurance[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.coInsurance[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.coInsurance[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.coInsurance[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.coInsurance[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.coInsurance[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.coInsurance[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.coInsurance[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.coInsurance[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.coInsurance[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.coInsurance[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.coInsurance[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.coInsurance[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.coInsurance[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.coInsurance[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.coInsurance[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.coInsurance[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.coInsurance[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.coInsurance[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.coInsurance[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.coInsurance[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.coInsurance[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.coInsurance[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.coInsurance[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.coInsurance[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.coInsurance[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.coInsurance[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.coInsurance[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.coInsurance[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.coInsurance[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.coInsurance[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.coInsurance[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.coInsurance[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.coInsurance[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.coInsurance[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.coInsurance[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.coInsurance[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.coInsurance[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.coInsurance[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

timePeriod
plans[].benefits.coInsurance[].timePeriod
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
HOUR
DAY
24_HOURS
YEARS
SERVICE_YEAR
coPayment
plans[].benefits.coPayment
Array of Objects

A list of copayment benefit entries from the payer.

The amount is the fixed amount the patient pays for a service. The decimal precision reflects what the payer sent (for example, 25.0 or 40).

Array item
additionalInformation
plans[].benefits.coPayment[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.coPayment[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.coPayment[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.coPayment[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.coPayment[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.coPayment[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.coPayment[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.coPayment[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.coPayment[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.coPayment[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.coPayment[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.coPayment[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.coPayment[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.coPayment[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.coPayment[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.coPayment[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.coPayment[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.coPayment[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.coPayment[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.coPayment[].amount
StringRequired

The monetary amount for this benefit.

coverageLevel
plans[].benefits.coPayment[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.coPayment[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.coPayment[].dates.added
Object

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

Show attributes
end
plans[].benefits.coPayment[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coPayment[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.coPayment[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.coPayment[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coPayment[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.coPayment[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.coPayment[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coPayment[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.coPayment[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.coPayment[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coPayment[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.coPayment[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.coPayment[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coPayment[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.coPayment[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.coPayment[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coPayment[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.coPayment[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.coPayment[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coPayment[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.coPayment[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.coPayment[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coPayment[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.coPayment[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.coPayment[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coPayment[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.coPayment[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.coPayment[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coPayment[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.coPayment[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.coPayment[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coPayment[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.coPayment[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.coPayment[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coPayment[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.coPayment[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.coPayment[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coPayment[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.coPayment[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.coPayment[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coPayment[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.coPayment[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.coPayment[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.coPayment[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.coPayment[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.coPayment[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.coPayment[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
messages
plans[].benefits.coPayment[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.coPayment[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.coPayment[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.coPayment[].network.id
String

The plan network identification number.

indicator
plans[].benefits.coPayment[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
placesOfService
plans[].benefits.coPayment[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.coPayment[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.coPayment[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.coPayment[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.coPayment[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
quantity
plans[].benefits.coPayment[].quantity
Object

The quantity the amount applies to, when the payer sends one. For example, 60 days of inpatient care.

Show attributes
qualifier
plans[].benefits.coPayment[].quantity.qualifier
String

The unit of measure for value.

Payers may sometimes return other non-compliant values.

Possible values
MINIMUM
QUANTITY_USED
COVERED_ACTUAL
COVERED_ESTIMATED
NUMBER_OF_CO_INSURANCE_DAYS
value
plans[].benefits.coPayment[].quantity.value
String

The numeric quantity. For example, 10 when the qualifier is VISITS.

relatedEntities
plans[].benefits.coPayment[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.coPayment[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.coPayment[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.coPayment[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.coPayment[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.coPayment[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.coPayment[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.coPayment[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.coPayment[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.coPayment[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.coPayment[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.coPayment[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.coPayment[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.coPayment[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.coPayment[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.coPayment[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.coPayment[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.coPayment[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.coPayment[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.coPayment[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.coPayment[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.coPayment[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.coPayment[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.coPayment[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.coPayment[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.coPayment[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.coPayment[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.coPayment[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.coPayment[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.coPayment[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.coPayment[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.coPayment[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.coPayment[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.coPayment[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.coPayment[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.coPayment[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.coPayment[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.coPayment[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.coPayment[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.coPayment[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.coPayment[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.coPayment[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.coPayment[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.coPayment[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.coPayment[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.coPayment[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.coPayment[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.coPayment[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.coPayment[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.coPayment[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.coPayment[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

timePeriod
plans[].benefits.coPayment[].timePeriod
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
HOUR
DAY
24_HOURS
YEARS
SERVICE_YEAR
contactFollowingEntityForInformation
plans[].benefits.contactFollowingEntityForInformation
Array of Objects

A list of entries directing you to contact another entity for benefit information.

Indicates that the payer can't supply the information you requested and is directing you to another entity. The entity's information is listed in the relatedEntities array.

Array item
additionalInformation
plans[].benefits.contactFollowingEntityForInformation[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.contactFollowingEntityForInformation[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.contactFollowingEntityForInformation[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.contactFollowingEntityForInformation[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.contactFollowingEntityForInformation[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.contactFollowingEntityForInformation[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.contactFollowingEntityForInformation[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.contactFollowingEntityForInformation[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.contactFollowingEntityForInformation[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.contactFollowingEntityForInformation[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.contactFollowingEntityForInformation[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.contactFollowingEntityForInformation[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.contactFollowingEntityForInformation[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.contactFollowingEntityForInformation[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.contactFollowingEntityForInformation[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.contactFollowingEntityForInformation[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.contactFollowingEntityForInformation[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.contactFollowingEntityForInformation[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.contactFollowingEntityForInformation[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.contactFollowingEntityForInformation[].amount
String

The monetary amount associated with this benefit.

coverageLevel
plans[].benefits.contactFollowingEntityForInformation[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.contactFollowingEntityForInformation[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.contactFollowingEntityForInformation[].dates.added
Object

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

Show attributes
end
plans[].benefits.contactFollowingEntityForInformation[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.contactFollowingEntityForInformation[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.contactFollowingEntityForInformation[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.contactFollowingEntityForInformation[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.contactFollowingEntityForInformation[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.contactFollowingEntityForInformation[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.contactFollowingEntityForInformation[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.contactFollowingEntityForInformation[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.contactFollowingEntityForInformation[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.contactFollowingEntityForInformation[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.contactFollowingEntityForInformation[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.contactFollowingEntityForInformation[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.contactFollowingEntityForInformation[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.contactFollowingEntityForInformation[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.contactFollowingEntityForInformation[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.contactFollowingEntityForInformation[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.contactFollowingEntityForInformation[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.contactFollowingEntityForInformation[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.contactFollowingEntityForInformation[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.contactFollowingEntityForInformation[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.contactFollowingEntityForInformation[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.contactFollowingEntityForInformation[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.contactFollowingEntityForInformation[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.contactFollowingEntityForInformation[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.contactFollowingEntityForInformation[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.contactFollowingEntityForInformation[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.contactFollowingEntityForInformation[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.contactFollowingEntityForInformation[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.contactFollowingEntityForInformation[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.contactFollowingEntityForInformation[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.contactFollowingEntityForInformation[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.contactFollowingEntityForInformation[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.contactFollowingEntityForInformation[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.contactFollowingEntityForInformation[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.contactFollowingEntityForInformation[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.contactFollowingEntityForInformation[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.contactFollowingEntityForInformation[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.contactFollowingEntityForInformation[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.contactFollowingEntityForInformation[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.contactFollowingEntityForInformation[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.contactFollowingEntityForInformation[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.contactFollowingEntityForInformation[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.contactFollowingEntityForInformation[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.contactFollowingEntityForInformation[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.contactFollowingEntityForInformation[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.contactFollowingEntityForInformation[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.contactFollowingEntityForInformation[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
messages
plans[].benefits.contactFollowingEntityForInformation[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.contactFollowingEntityForInformation[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.contactFollowingEntityForInformation[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.contactFollowingEntityForInformation[].network.id
String

The plan network identification number.

indicator
plans[].benefits.contactFollowingEntityForInformation[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
percent
plans[].benefits.contactFollowingEntityForInformation[].percent
String

The percentage associated with this benefit.

placesOfService
plans[].benefits.contactFollowingEntityForInformation[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.contactFollowingEntityForInformation[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.contactFollowingEntityForInformation[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.contactFollowingEntityForInformation[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.contactFollowingEntityForInformation[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
relatedEntities
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.contactFollowingEntityForInformation[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.contactFollowingEntityForInformation[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.contactFollowingEntityForInformation[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.contactFollowingEntityForInformation[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.contactFollowingEntityForInformation[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.contactFollowingEntityForInformation[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.contactFollowingEntityForInformation[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.contactFollowingEntityForInformation[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.contactFollowingEntityForInformation[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.contactFollowingEntityForInformation[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.contactFollowingEntityForInformation[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.contactFollowingEntityForInformation[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.contactFollowingEntityForInformation[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.contactFollowingEntityForInformation[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

costContainment
plans[].benefits.costContainment
Array of Objects

A list of cost containment benefit entries from the payer.

Cost containment refers to rules a health plan may have in place to control the cost of care. This benefit is typically included when the patient has Medicaid coverage. The amount represents the total the patient pays out-of-pocket before benefits begin. The decimal precision reflects what the payer sent (for example, 500.0 or 500).

Array item
additionalInformation
plans[].benefits.costContainment[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.costContainment[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.costContainment[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.costContainment[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.costContainment[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.costContainment[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.costContainment[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.costContainment[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.costContainment[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.costContainment[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.costContainment[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.costContainment[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.costContainment[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.costContainment[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.costContainment[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.costContainment[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.costContainment[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.costContainment[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.costContainment[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.costContainment[].amount
StringRequired

The monetary amount for this benefit.

coverageLevel
plans[].benefits.costContainment[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.costContainment[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.costContainment[].dates.added
Object

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

Show attributes
end
plans[].benefits.costContainment[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.costContainment[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.costContainment[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.costContainment[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.costContainment[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.costContainment[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.costContainment[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.costContainment[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.costContainment[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.costContainment[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.costContainment[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.costContainment[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.costContainment[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.costContainment[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.costContainment[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.costContainment[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.costContainment[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.costContainment[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.costContainment[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.costContainment[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.costContainment[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.costContainment[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.costContainment[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.costContainment[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.costContainment[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.costContainment[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.costContainment[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.costContainment[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.costContainment[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.costContainment[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.costContainment[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.costContainment[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.costContainment[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.costContainment[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.costContainment[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.costContainment[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.costContainment[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.costContainment[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.costContainment[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.costContainment[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.costContainment[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.costContainment[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.costContainment[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.costContainment[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.costContainment[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.costContainment[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.costContainment[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
messages
plans[].benefits.costContainment[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.costContainment[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.costContainment[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.costContainment[].network.id
String

The plan network identification number.

indicator
plans[].benefits.costContainment[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
placesOfService
plans[].benefits.costContainment[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.costContainment[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.costContainment[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.costContainment[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.costContainment[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
quantity
plans[].benefits.costContainment[].quantity
Object

The quantity the amount applies to, when the payer sends one. For example, 60 days of inpatient care.

Show attributes
qualifier
plans[].benefits.costContainment[].quantity.qualifier
String

The unit of measure for value.

Payers may sometimes return other non-compliant values.

Possible values
MINIMUM
QUANTITY_USED
COVERED_ACTUAL
COVERED_ESTIMATED
NUMBER_OF_CO_INSURANCE_DAYS
value
plans[].benefits.costContainment[].quantity.value
String

The numeric quantity. For example, 10 when the qualifier is VISITS.

relatedEntities
plans[].benefits.costContainment[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.costContainment[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.costContainment[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.costContainment[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.costContainment[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.costContainment[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.costContainment[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.costContainment[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.costContainment[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.costContainment[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.costContainment[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.costContainment[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.costContainment[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.costContainment[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.costContainment[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.costContainment[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.costContainment[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.costContainment[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.costContainment[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.costContainment[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.costContainment[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.costContainment[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.costContainment[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.costContainment[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.costContainment[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.costContainment[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.costContainment[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.costContainment[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.costContainment[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.costContainment[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.costContainment[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.costContainment[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.costContainment[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.costContainment[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.costContainment[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.costContainment[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.costContainment[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.costContainment[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.costContainment[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.costContainment[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.costContainment[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.costContainment[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.costContainment[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.costContainment[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.costContainment[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.costContainment[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.costContainment[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.costContainment[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.costContainment[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.costContainment[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.costContainment[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

timePeriod
plans[].benefits.costContainment[].timePeriod
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
HOUR
DAY
24_HOURS
YEARS
SERVICE_YEAR
coverageBasis
plans[].benefits.coverageBasis
Array of Objects

A list of coverage basis entries from the payer.

Describes the financial basis of the patient's health plan or eligibility for enrollment. For example, payers may use this type to indicate that a plan is fully insured, meaning the payer assumes full financial responsibility for medical claims. Payers may also use this type to indicate carve-out benefits, such as when the patient is enrolled in state-managed health programs, or to explain why a member was allowed to enroll in the plan (such as age range or having a disability). The detail is usually included as free text in messages or identifiers in additionalInformation.

Array item
additionalInformation
plans[].benefits.coverageBasis[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.coverageBasis[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.coverageBasis[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.coverageBasis[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.coverageBasis[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.coverageBasis[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.coverageBasis[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.coverageBasis[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.coverageBasis[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.coverageBasis[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.coverageBasis[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.coverageBasis[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.coverageBasis[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.coverageBasis[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.coverageBasis[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.coverageBasis[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.coverageBasis[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.coverageBasis[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.coverageBasis[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.coverageBasis[].amount
String

The monetary amount associated with this benefit.

coverageLevel
plans[].benefits.coverageBasis[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.coverageBasis[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.coverageBasis[].dates.added
Object

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

Show attributes
end
plans[].benefits.coverageBasis[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coverageBasis[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.coverageBasis[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.coverageBasis[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coverageBasis[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.coverageBasis[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.coverageBasis[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coverageBasis[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.coverageBasis[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.coverageBasis[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coverageBasis[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.coverageBasis[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.coverageBasis[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coverageBasis[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.coverageBasis[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.coverageBasis[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coverageBasis[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.coverageBasis[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.coverageBasis[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coverageBasis[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.coverageBasis[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.coverageBasis[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coverageBasis[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.coverageBasis[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.coverageBasis[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coverageBasis[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.coverageBasis[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.coverageBasis[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coverageBasis[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.coverageBasis[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.coverageBasis[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coverageBasis[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.coverageBasis[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.coverageBasis[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coverageBasis[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.coverageBasis[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.coverageBasis[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coverageBasis[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.coverageBasis[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.coverageBasis[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.coverageBasis[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.coverageBasis[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.coverageBasis[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.coverageBasis[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.coverageBasis[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.coverageBasis[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.coverageBasis[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
messages
plans[].benefits.coverageBasis[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.coverageBasis[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.coverageBasis[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.coverageBasis[].network.id
String

The plan network identification number.

indicator
plans[].benefits.coverageBasis[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
percent
plans[].benefits.coverageBasis[].percent
String

The percentage associated with this benefit.

placesOfService
plans[].benefits.coverageBasis[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.coverageBasis[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.coverageBasis[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.coverageBasis[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.coverageBasis[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
relatedEntities
plans[].benefits.coverageBasis[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.coverageBasis[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.coverageBasis[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.coverageBasis[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.coverageBasis[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.coverageBasis[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.coverageBasis[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.coverageBasis[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.coverageBasis[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.coverageBasis[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.coverageBasis[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.coverageBasis[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.coverageBasis[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.coverageBasis[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.coverageBasis[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.coverageBasis[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.coverageBasis[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.coverageBasis[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.coverageBasis[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.coverageBasis[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.coverageBasis[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.coverageBasis[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.coverageBasis[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.coverageBasis[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.coverageBasis[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.coverageBasis[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.coverageBasis[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.coverageBasis[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.coverageBasis[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.coverageBasis[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.coverageBasis[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.coverageBasis[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.coverageBasis[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.coverageBasis[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.coverageBasis[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.coverageBasis[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.coverageBasis[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.coverageBasis[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.coverageBasis[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.coverageBasis[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.coverageBasis[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.coverageBasis[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.coverageBasis[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.coverageBasis[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.coverageBasis[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.coverageBasis[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.coverageBasis[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.coverageBasis[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.coverageBasis[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.coverageBasis[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.coverageBasis[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

deductible
plans[].benefits.deductible
Array of Objects

A list of deductible benefit entries from the payer.

The amount is what the patient must pay before the plan begins covering costs. The decimal precision reflects what the payer sent (for example, 1500.0 or 1000). Check timePeriod to determine what the amount represents. A calendar-year deductible is the patient's total for the year, while a remaining deductible is the amount still owed before the plan pays.

Array item
additionalInformation
plans[].benefits.deductible[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.deductible[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.deductible[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.deductible[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.deductible[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.deductible[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.deductible[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.deductible[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.deductible[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.deductible[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.deductible[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.deductible[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.deductible[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.deductible[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.deductible[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.deductible[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.deductible[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.deductible[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.deductible[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.deductible[].amount
StringRequired

The monetary amount for this benefit.

coverageLevel
plans[].benefits.deductible[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.deductible[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.deductible[].dates.added
Object

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

Show attributes
end
plans[].benefits.deductible[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.deductible[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.deductible[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.deductible[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.deductible[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.deductible[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.deductible[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.deductible[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.deductible[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.deductible[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.deductible[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.deductible[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.deductible[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.deductible[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.deductible[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.deductible[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.deductible[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.deductible[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.deductible[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.deductible[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.deductible[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.deductible[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.deductible[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.deductible[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.deductible[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.deductible[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.deductible[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.deductible[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.deductible[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.deductible[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.deductible[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.deductible[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.deductible[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.deductible[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.deductible[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.deductible[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.deductible[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.deductible[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.deductible[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.deductible[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.deductible[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.deductible[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.deductible[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.deductible[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.deductible[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.deductible[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.deductible[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
messages
plans[].benefits.deductible[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.deductible[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.deductible[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.deductible[].network.id
String

The plan network identification number.

indicator
plans[].benefits.deductible[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
placesOfService
plans[].benefits.deductible[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.deductible[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.deductible[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.deductible[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.deductible[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
quantity
plans[].benefits.deductible[].quantity
Object

The quantity the amount applies to, when the payer sends one. For example, 60 days of inpatient care.

Show attributes
qualifier
plans[].benefits.deductible[].quantity.qualifier
String

The unit of measure for value.

Payers may sometimes return other non-compliant values.

Possible values
MINIMUM
QUANTITY_USED
COVERED_ACTUAL
COVERED_ESTIMATED
NUMBER_OF_CO_INSURANCE_DAYS
value
plans[].benefits.deductible[].quantity.value
String

The numeric quantity. For example, 10 when the qualifier is VISITS.

relatedEntities
plans[].benefits.deductible[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.deductible[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.deductible[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.deductible[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.deductible[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.deductible[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.deductible[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.deductible[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.deductible[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.deductible[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.deductible[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.deductible[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.deductible[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.deductible[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.deductible[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.deductible[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.deductible[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.deductible[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.deductible[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.deductible[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.deductible[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.deductible[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.deductible[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.deductible[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.deductible[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.deductible[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.deductible[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.deductible[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.deductible[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.deductible[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.deductible[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.deductible[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.deductible[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.deductible[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.deductible[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.deductible[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.deductible[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.deductible[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.deductible[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.deductible[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.deductible[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.deductible[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.deductible[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.deductible[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.deductible[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.deductible[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.deductible[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.deductible[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.deductible[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.deductible[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.deductible[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

timePeriod
plans[].benefits.deductible[].timePeriod
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
HOUR
DAY
24_HOURS
YEARS
SERVICE_YEAR
exclusions
plans[].benefits.exclusions
Array of Objects

A list of services or conditions the plan excludes from coverage.

An exclusion is a service or condition the plan doesn't cover for any patient. This is different from a nonCovered entry, which reports that this patient doesn't have coverage for a specific service you submitted in the request.

Array item
additionalInformation
plans[].benefits.exclusions[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.exclusions[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.exclusions[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.exclusions[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.exclusions[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.exclusions[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.exclusions[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.exclusions[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.exclusions[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.exclusions[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.exclusions[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.exclusions[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.exclusions[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.exclusions[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.exclusions[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.exclusions[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.exclusions[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.exclusions[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.exclusions[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.exclusions[].amount
String

The monetary amount associated with this benefit.

coverageLevel
plans[].benefits.exclusions[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.exclusions[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.exclusions[].dates.added
Object

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

Show attributes
end
plans[].benefits.exclusions[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.exclusions[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.exclusions[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.exclusions[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.exclusions[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.exclusions[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.exclusions[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.exclusions[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.exclusions[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.exclusions[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.exclusions[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.exclusions[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.exclusions[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.exclusions[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.exclusions[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.exclusions[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.exclusions[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.exclusions[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.exclusions[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.exclusions[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.exclusions[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.exclusions[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.exclusions[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.exclusions[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.exclusions[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.exclusions[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.exclusions[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.exclusions[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.exclusions[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.exclusions[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.exclusions[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.exclusions[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.exclusions[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.exclusions[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.exclusions[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.exclusions[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.exclusions[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.exclusions[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.exclusions[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.exclusions[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.exclusions[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.exclusions[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.exclusions[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.exclusions[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.exclusions[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.exclusions[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.exclusions[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
messages
plans[].benefits.exclusions[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.exclusions[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.exclusions[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.exclusions[].network.id
String

The plan network identification number.

indicator
plans[].benefits.exclusions[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
percent
plans[].benefits.exclusions[].percent
String

The percentage associated with this benefit.

placesOfService
plans[].benefits.exclusions[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.exclusions[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.exclusions[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.exclusions[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.exclusions[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
relatedEntities
plans[].benefits.exclusions[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.exclusions[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.exclusions[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.exclusions[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.exclusions[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.exclusions[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.exclusions[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.exclusions[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.exclusions[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.exclusions[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.exclusions[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.exclusions[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.exclusions[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.exclusions[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.exclusions[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.exclusions[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.exclusions[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.exclusions[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.exclusions[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.exclusions[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.exclusions[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.exclusions[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.exclusions[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.exclusions[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.exclusions[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.exclusions[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.exclusions[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.exclusions[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.exclusions[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.exclusions[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.exclusions[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.exclusions[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.exclusions[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.exclusions[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.exclusions[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.exclusions[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.exclusions[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.exclusions[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.exclusions[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.exclusions[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.exclusions[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.exclusions[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.exclusions[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.exclusions[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.exclusions[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.exclusions[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.exclusions[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.exclusions[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.exclusions[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.exclusions[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.exclusions[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

healthCareFacility
plans[].benefits.healthCareFacility
Array of Objects

A list of health care facility information relevant to the patient's benefits.

These typically indicate an institution or provider network the patient is required or expected to use. The facility's information is available in the relatedEntities array. Rarely returned.

Array item
additionalInformation
plans[].benefits.healthCareFacility[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.healthCareFacility[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.healthCareFacility[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.healthCareFacility[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.healthCareFacility[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.healthCareFacility[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.healthCareFacility[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.healthCareFacility[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.healthCareFacility[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.healthCareFacility[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.healthCareFacility[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.healthCareFacility[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.healthCareFacility[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.healthCareFacility[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.healthCareFacility[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.healthCareFacility[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.healthCareFacility[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.healthCareFacility[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.healthCareFacility[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.healthCareFacility[].amount
String

The monetary amount associated with this benefit.

coverageLevel
plans[].benefits.healthCareFacility[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.healthCareFacility[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.healthCareFacility[].dates.added
Object

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

Show attributes
end
plans[].benefits.healthCareFacility[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.healthCareFacility[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.healthCareFacility[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.healthCareFacility[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.healthCareFacility[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.healthCareFacility[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.healthCareFacility[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.healthCareFacility[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.healthCareFacility[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.healthCareFacility[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.healthCareFacility[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.healthCareFacility[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.healthCareFacility[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.healthCareFacility[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.healthCareFacility[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.healthCareFacility[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.healthCareFacility[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.healthCareFacility[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.healthCareFacility[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.healthCareFacility[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.healthCareFacility[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.healthCareFacility[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.healthCareFacility[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.healthCareFacility[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.healthCareFacility[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.healthCareFacility[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.healthCareFacility[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.healthCareFacility[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.healthCareFacility[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.healthCareFacility[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.healthCareFacility[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.healthCareFacility[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.healthCareFacility[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.healthCareFacility[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.healthCareFacility[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.healthCareFacility[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.healthCareFacility[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.healthCareFacility[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.healthCareFacility[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.healthCareFacility[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.healthCareFacility[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.healthCareFacility[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.healthCareFacility[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.healthCareFacility[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.healthCareFacility[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.healthCareFacility[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.healthCareFacility[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
messages
plans[].benefits.healthCareFacility[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.healthCareFacility[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.healthCareFacility[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.healthCareFacility[].network.id
String

The plan network identification number.

indicator
plans[].benefits.healthCareFacility[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
percent
plans[].benefits.healthCareFacility[].percent
String

The percentage associated with this benefit.

placesOfService
plans[].benefits.healthCareFacility[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.healthCareFacility[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.healthCareFacility[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.healthCareFacility[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.healthCareFacility[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
relatedEntities
plans[].benefits.healthCareFacility[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.healthCareFacility[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.healthCareFacility[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.healthCareFacility[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.healthCareFacility[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.healthCareFacility[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.healthCareFacility[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.healthCareFacility[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.healthCareFacility[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.healthCareFacility[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.healthCareFacility[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.healthCareFacility[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.healthCareFacility[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.healthCareFacility[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.healthCareFacility[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.healthCareFacility[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.healthCareFacility[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.healthCareFacility[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.healthCareFacility[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.healthCareFacility[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.healthCareFacility[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.healthCareFacility[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.healthCareFacility[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.healthCareFacility[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.healthCareFacility[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.healthCareFacility[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.healthCareFacility[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.healthCareFacility[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.healthCareFacility[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.healthCareFacility[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.healthCareFacility[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.healthCareFacility[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.healthCareFacility[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.healthCareFacility[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.healthCareFacility[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.healthCareFacility[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.healthCareFacility[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.healthCareFacility[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.healthCareFacility[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.healthCareFacility[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.healthCareFacility[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.healthCareFacility[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.healthCareFacility[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.healthCareFacility[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.healthCareFacility[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.healthCareFacility[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.healthCareFacility[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.healthCareFacility[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.healthCareFacility[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.healthCareFacility[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.healthCareFacility[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

invalidEntries
plans[].benefits.invalidEntries
Object

Benefit entries that Stedi couldn't include in the standard arrays due to data validation issues, such as missing required amounts or incorrect unit types.

Show attributes
coInsurance
plans[].benefits.invalidEntries.coInsurance
Array of Objects

Invalid co-insurance entries.

Array item
additionalInformation
plans[].benefits.invalidEntries.coInsurance[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.invalidEntries.coInsurance[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.invalidEntries.coInsurance[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.invalidEntries.coInsurance[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.invalidEntries.coInsurance[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.invalidEntries.coInsurance[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.invalidEntries.coInsurance[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.invalidEntries.coInsurance[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.invalidEntries.coInsurance[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.invalidEntries.coInsurance[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.invalidEntries.coInsurance[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.invalidEntries.coInsurance[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.invalidEntries.coInsurance[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.invalidEntries.coInsurance[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.invalidEntries.coInsurance[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.invalidEntries.coInsurance[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.invalidEntries.coInsurance[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.invalidEntries.coInsurance[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.invalidEntries.coInsurance[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.invalidEntries.coInsurance[].amount
String

The monetary amount, if present.

coverageLevel
plans[].benefits.invalidEntries.coInsurance[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.invalidEntries.coInsurance[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.invalidEntries.coInsurance[].dates.added
Object

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

Show attributes
end
plans[].benefits.invalidEntries.coInsurance[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.coInsurance[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.invalidEntries.coInsurance[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.invalidEntries.coInsurance[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.coInsurance[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.invalidEntries.coInsurance[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.invalidEntries.coInsurance[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.coInsurance[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.invalidEntries.coInsurance[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.invalidEntries.coInsurance[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.coInsurance[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.invalidEntries.coInsurance[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.invalidEntries.coInsurance[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.coInsurance[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.invalidEntries.coInsurance[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.invalidEntries.coInsurance[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.coInsurance[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.invalidEntries.coInsurance[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.invalidEntries.coInsurance[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.coInsurance[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.invalidEntries.coInsurance[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.invalidEntries.coInsurance[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.coInsurance[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.invalidEntries.coInsurance[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.invalidEntries.coInsurance[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.coInsurance[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.invalidEntries.coInsurance[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.invalidEntries.coInsurance[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.coInsurance[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.invalidEntries.coInsurance[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.invalidEntries.coInsurance[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.coInsurance[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.invalidEntries.coInsurance[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.invalidEntries.coInsurance[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.coInsurance[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.invalidEntries.coInsurance[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.invalidEntries.coInsurance[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.coInsurance[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.invalidEntries.coInsurance[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.invalidEntries.coInsurance[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.coInsurance[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.invalidEntries.coInsurance[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.invalidEntries.coInsurance[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.invalidEntries.coInsurance[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.invalidEntries.coInsurance[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.invalidEntries.coInsurance[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.invalidEntries.coInsurance[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
invalidReasons
plans[].benefits.invalidEntries.coInsurance[].invalidReasons
Array of ObjectsRequired

Reasons explaining why this entry is invalid.

Array item
code
plans[].benefits.invalidEntries.coInsurance[].invalidReasons[].code
StringRequired

A machine-readable code identifying the validation issue.

Payers may sometimes return other non-compliant values.

Possible values
MISSING_AMOUNT
MISSING_PERCENT
UNEXPECTED_AMOUNT
UNEXPECTED_PERCENT
description
plans[].benefits.invalidEntries.coInsurance[].invalidReasons[].description
StringRequired

A human-readable description of the validation issue.

messages
plans[].benefits.invalidEntries.coInsurance[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.invalidEntries.coInsurance[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.invalidEntries.coInsurance[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.invalidEntries.coInsurance[].network.id
String

The plan network identification number.

indicator
plans[].benefits.invalidEntries.coInsurance[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
percent
plans[].benefits.invalidEntries.coInsurance[].percent
String

The percentage, if present.

placesOfService
plans[].benefits.invalidEntries.coInsurance[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.invalidEntries.coInsurance[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.invalidEntries.coInsurance[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.invalidEntries.coInsurance[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.invalidEntries.coInsurance[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
quantity
plans[].benefits.invalidEntries.coInsurance[].quantity
Object

The quantity, if present.

Show attributes
qualifier
plans[].benefits.invalidEntries.coInsurance[].quantity.qualifier
String

The unit of measure for value.

Payers may sometimes return other non-compliant values.

Possible values
MINIMUM
QUANTITY_USED
COVERED_ACTUAL
COVERED_ESTIMATED
NUMBER_OF_CO_INSURANCE_DAYS
value
plans[].benefits.invalidEntries.coInsurance[].quantity.value
String

The numeric quantity. For example, 10 when the qualifier is VISITS.

relatedEntities
plans[].benefits.invalidEntries.coInsurance[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.invalidEntries.coInsurance[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.invalidEntries.coInsurance[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.invalidEntries.coInsurance[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.invalidEntries.coInsurance[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.invalidEntries.coInsurance[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.invalidEntries.coInsurance[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.invalidEntries.coInsurance[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.invalidEntries.coInsurance[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.invalidEntries.coInsurance[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.invalidEntries.coInsurance[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.invalidEntries.coInsurance[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.invalidEntries.coInsurance[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.invalidEntries.coInsurance[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.invalidEntries.coInsurance[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

timePeriod
plans[].benefits.invalidEntries.coInsurance[].timePeriod
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
HOUR
DAY
24_HOURS
YEARS
SERVICE_YEAR
coPayment
plans[].benefits.invalidEntries.coPayment
Array of Objects

Invalid co-payment entries.

Array item
additionalInformation
plans[].benefits.invalidEntries.coPayment[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.invalidEntries.coPayment[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.invalidEntries.coPayment[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.invalidEntries.coPayment[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.invalidEntries.coPayment[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.invalidEntries.coPayment[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.invalidEntries.coPayment[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.invalidEntries.coPayment[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.invalidEntries.coPayment[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.invalidEntries.coPayment[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.invalidEntries.coPayment[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.invalidEntries.coPayment[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.invalidEntries.coPayment[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.invalidEntries.coPayment[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.invalidEntries.coPayment[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.invalidEntries.coPayment[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.invalidEntries.coPayment[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.invalidEntries.coPayment[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.invalidEntries.coPayment[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.invalidEntries.coPayment[].amount
String

The monetary amount, if present.

coverageLevel
plans[].benefits.invalidEntries.coPayment[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.invalidEntries.coPayment[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.invalidEntries.coPayment[].dates.added
Object

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

Show attributes
end
plans[].benefits.invalidEntries.coPayment[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.coPayment[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.invalidEntries.coPayment[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.invalidEntries.coPayment[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.coPayment[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.invalidEntries.coPayment[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.invalidEntries.coPayment[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.coPayment[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.invalidEntries.coPayment[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.invalidEntries.coPayment[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.coPayment[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.invalidEntries.coPayment[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.invalidEntries.coPayment[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.coPayment[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.invalidEntries.coPayment[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.invalidEntries.coPayment[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.coPayment[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.invalidEntries.coPayment[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.invalidEntries.coPayment[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.coPayment[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.invalidEntries.coPayment[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.invalidEntries.coPayment[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.coPayment[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.invalidEntries.coPayment[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.invalidEntries.coPayment[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.coPayment[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.invalidEntries.coPayment[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.invalidEntries.coPayment[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.coPayment[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.invalidEntries.coPayment[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.invalidEntries.coPayment[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.coPayment[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.invalidEntries.coPayment[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.invalidEntries.coPayment[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.coPayment[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.invalidEntries.coPayment[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.invalidEntries.coPayment[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.coPayment[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.invalidEntries.coPayment[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.invalidEntries.coPayment[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.coPayment[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.invalidEntries.coPayment[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.invalidEntries.coPayment[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.invalidEntries.coPayment[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.invalidEntries.coPayment[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.invalidEntries.coPayment[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.invalidEntries.coPayment[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
invalidReasons
plans[].benefits.invalidEntries.coPayment[].invalidReasons
Array of ObjectsRequired

Reasons explaining why this entry is invalid.

Array item
code
plans[].benefits.invalidEntries.coPayment[].invalidReasons[].code
StringRequired

A machine-readable code identifying the validation issue.

Payers may sometimes return other non-compliant values.

Possible values
MISSING_AMOUNT
MISSING_PERCENT
UNEXPECTED_AMOUNT
UNEXPECTED_PERCENT
description
plans[].benefits.invalidEntries.coPayment[].invalidReasons[].description
StringRequired

A human-readable description of the validation issue.

messages
plans[].benefits.invalidEntries.coPayment[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.invalidEntries.coPayment[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.invalidEntries.coPayment[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.invalidEntries.coPayment[].network.id
String

The plan network identification number.

indicator
plans[].benefits.invalidEntries.coPayment[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
percent
plans[].benefits.invalidEntries.coPayment[].percent
String

The percentage, if present.

placesOfService
plans[].benefits.invalidEntries.coPayment[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.invalidEntries.coPayment[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.invalidEntries.coPayment[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.invalidEntries.coPayment[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.invalidEntries.coPayment[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
quantity
plans[].benefits.invalidEntries.coPayment[].quantity
Object

The quantity, if present.

Show attributes
qualifier
plans[].benefits.invalidEntries.coPayment[].quantity.qualifier
String

The unit of measure for value.

Payers may sometimes return other non-compliant values.

Possible values
MINIMUM
QUANTITY_USED
COVERED_ACTUAL
COVERED_ESTIMATED
NUMBER_OF_CO_INSURANCE_DAYS
value
plans[].benefits.invalidEntries.coPayment[].quantity.value
String

The numeric quantity. For example, 10 when the qualifier is VISITS.

relatedEntities
plans[].benefits.invalidEntries.coPayment[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.invalidEntries.coPayment[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.invalidEntries.coPayment[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.invalidEntries.coPayment[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.invalidEntries.coPayment[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.invalidEntries.coPayment[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.invalidEntries.coPayment[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.invalidEntries.coPayment[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.invalidEntries.coPayment[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.invalidEntries.coPayment[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.invalidEntries.coPayment[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.invalidEntries.coPayment[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.invalidEntries.coPayment[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.invalidEntries.coPayment[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.invalidEntries.coPayment[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

timePeriod
plans[].benefits.invalidEntries.coPayment[].timePeriod
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
HOUR
DAY
24_HOURS
YEARS
SERVICE_YEAR
costContainment
plans[].benefits.invalidEntries.costContainment
Array of Objects

Invalid cost containment entries.

Array item
additionalInformation
plans[].benefits.invalidEntries.costContainment[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.invalidEntries.costContainment[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.invalidEntries.costContainment[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.invalidEntries.costContainment[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.invalidEntries.costContainment[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.invalidEntries.costContainment[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.invalidEntries.costContainment[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.invalidEntries.costContainment[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.invalidEntries.costContainment[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.invalidEntries.costContainment[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.invalidEntries.costContainment[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.invalidEntries.costContainment[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.invalidEntries.costContainment[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.invalidEntries.costContainment[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.invalidEntries.costContainment[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.invalidEntries.costContainment[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.invalidEntries.costContainment[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.invalidEntries.costContainment[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.invalidEntries.costContainment[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.invalidEntries.costContainment[].amount
String

The monetary amount, if present.

coverageLevel
plans[].benefits.invalidEntries.costContainment[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.invalidEntries.costContainment[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.invalidEntries.costContainment[].dates.added
Object

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

Show attributes
end
plans[].benefits.invalidEntries.costContainment[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.costContainment[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.invalidEntries.costContainment[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.invalidEntries.costContainment[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.costContainment[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.invalidEntries.costContainment[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.invalidEntries.costContainment[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.costContainment[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.invalidEntries.costContainment[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.invalidEntries.costContainment[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.costContainment[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.invalidEntries.costContainment[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.invalidEntries.costContainment[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.costContainment[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.invalidEntries.costContainment[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.invalidEntries.costContainment[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.costContainment[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.invalidEntries.costContainment[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.invalidEntries.costContainment[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.costContainment[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.invalidEntries.costContainment[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.invalidEntries.costContainment[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.costContainment[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.invalidEntries.costContainment[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.invalidEntries.costContainment[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.costContainment[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.invalidEntries.costContainment[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.invalidEntries.costContainment[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.costContainment[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.invalidEntries.costContainment[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.invalidEntries.costContainment[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.costContainment[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.invalidEntries.costContainment[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.invalidEntries.costContainment[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.costContainment[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.invalidEntries.costContainment[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.invalidEntries.costContainment[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.costContainment[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.invalidEntries.costContainment[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.invalidEntries.costContainment[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.costContainment[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.invalidEntries.costContainment[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.invalidEntries.costContainment[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.invalidEntries.costContainment[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.invalidEntries.costContainment[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.invalidEntries.costContainment[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.invalidEntries.costContainment[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
invalidReasons
plans[].benefits.invalidEntries.costContainment[].invalidReasons
Array of ObjectsRequired

Reasons explaining why this entry is invalid.

Array item
code
plans[].benefits.invalidEntries.costContainment[].invalidReasons[].code
StringRequired

A machine-readable code identifying the validation issue.

Payers may sometimes return other non-compliant values.

Possible values
MISSING_AMOUNT
MISSING_PERCENT
UNEXPECTED_AMOUNT
UNEXPECTED_PERCENT
description
plans[].benefits.invalidEntries.costContainment[].invalidReasons[].description
StringRequired

A human-readable description of the validation issue.

messages
plans[].benefits.invalidEntries.costContainment[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.invalidEntries.costContainment[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.invalidEntries.costContainment[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.invalidEntries.costContainment[].network.id
String

The plan network identification number.

indicator
plans[].benefits.invalidEntries.costContainment[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
percent
plans[].benefits.invalidEntries.costContainment[].percent
String

The percentage, if present.

placesOfService
plans[].benefits.invalidEntries.costContainment[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.invalidEntries.costContainment[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.invalidEntries.costContainment[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.invalidEntries.costContainment[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.invalidEntries.costContainment[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
quantity
plans[].benefits.invalidEntries.costContainment[].quantity
Object

The quantity, if present.

Show attributes
qualifier
plans[].benefits.invalidEntries.costContainment[].quantity.qualifier
String

The unit of measure for value.

Payers may sometimes return other non-compliant values.

Possible values
MINIMUM
QUANTITY_USED
COVERED_ACTUAL
COVERED_ESTIMATED
NUMBER_OF_CO_INSURANCE_DAYS
value
plans[].benefits.invalidEntries.costContainment[].quantity.value
String

The numeric quantity. For example, 10 when the qualifier is VISITS.

relatedEntities
plans[].benefits.invalidEntries.costContainment[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.invalidEntries.costContainment[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.invalidEntries.costContainment[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.invalidEntries.costContainment[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.invalidEntries.costContainment[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.invalidEntries.costContainment[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.invalidEntries.costContainment[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.invalidEntries.costContainment[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.invalidEntries.costContainment[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.invalidEntries.costContainment[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.invalidEntries.costContainment[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.invalidEntries.costContainment[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.invalidEntries.costContainment[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.invalidEntries.costContainment[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.invalidEntries.costContainment[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

timePeriod
plans[].benefits.invalidEntries.costContainment[].timePeriod
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
HOUR
DAY
24_HOURS
YEARS
SERVICE_YEAR
deductible
plans[].benefits.invalidEntries.deductible
Array of Objects

Invalid deductible entries.

Array item
additionalInformation
plans[].benefits.invalidEntries.deductible[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.invalidEntries.deductible[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.invalidEntries.deductible[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.invalidEntries.deductible[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.invalidEntries.deductible[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.invalidEntries.deductible[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.invalidEntries.deductible[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.invalidEntries.deductible[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.invalidEntries.deductible[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.invalidEntries.deductible[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.invalidEntries.deductible[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.invalidEntries.deductible[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.invalidEntries.deductible[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.invalidEntries.deductible[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.invalidEntries.deductible[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.invalidEntries.deductible[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.invalidEntries.deductible[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.invalidEntries.deductible[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.invalidEntries.deductible[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.invalidEntries.deductible[].amount
String

The monetary amount, if present.

coverageLevel
plans[].benefits.invalidEntries.deductible[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.invalidEntries.deductible[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.invalidEntries.deductible[].dates.added
Object

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

Show attributes
end
plans[].benefits.invalidEntries.deductible[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.deductible[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.invalidEntries.deductible[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.invalidEntries.deductible[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.deductible[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.invalidEntries.deductible[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.invalidEntries.deductible[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.deductible[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.invalidEntries.deductible[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.invalidEntries.deductible[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.deductible[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.invalidEntries.deductible[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.invalidEntries.deductible[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.deductible[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.invalidEntries.deductible[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.invalidEntries.deductible[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.deductible[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.invalidEntries.deductible[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.invalidEntries.deductible[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.deductible[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.invalidEntries.deductible[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.invalidEntries.deductible[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.deductible[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.invalidEntries.deductible[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.invalidEntries.deductible[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.deductible[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.invalidEntries.deductible[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.invalidEntries.deductible[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.deductible[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.invalidEntries.deductible[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.invalidEntries.deductible[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.deductible[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.invalidEntries.deductible[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.invalidEntries.deductible[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.deductible[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.invalidEntries.deductible[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.invalidEntries.deductible[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.deductible[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.invalidEntries.deductible[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.invalidEntries.deductible[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.deductible[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.invalidEntries.deductible[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.invalidEntries.deductible[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.invalidEntries.deductible[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.invalidEntries.deductible[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.invalidEntries.deductible[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.invalidEntries.deductible[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
invalidReasons
plans[].benefits.invalidEntries.deductible[].invalidReasons
Array of ObjectsRequired

Reasons explaining why this entry is invalid.

Array item
code
plans[].benefits.invalidEntries.deductible[].invalidReasons[].code
StringRequired

A machine-readable code identifying the validation issue.

Payers may sometimes return other non-compliant values.

Possible values
MISSING_AMOUNT
MISSING_PERCENT
UNEXPECTED_AMOUNT
UNEXPECTED_PERCENT
description
plans[].benefits.invalidEntries.deductible[].invalidReasons[].description
StringRequired

A human-readable description of the validation issue.

messages
plans[].benefits.invalidEntries.deductible[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.invalidEntries.deductible[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.invalidEntries.deductible[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.invalidEntries.deductible[].network.id
String

The plan network identification number.

indicator
plans[].benefits.invalidEntries.deductible[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
percent
plans[].benefits.invalidEntries.deductible[].percent
String

The percentage, if present.

placesOfService
plans[].benefits.invalidEntries.deductible[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.invalidEntries.deductible[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.invalidEntries.deductible[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.invalidEntries.deductible[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.invalidEntries.deductible[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
quantity
plans[].benefits.invalidEntries.deductible[].quantity
Object

The quantity, if present.

Show attributes
qualifier
plans[].benefits.invalidEntries.deductible[].quantity.qualifier
String

The unit of measure for value.

Payers may sometimes return other non-compliant values.

Possible values
MINIMUM
QUANTITY_USED
COVERED_ACTUAL
COVERED_ESTIMATED
NUMBER_OF_CO_INSURANCE_DAYS
value
plans[].benefits.invalidEntries.deductible[].quantity.value
String

The numeric quantity. For example, 10 when the qualifier is VISITS.

relatedEntities
plans[].benefits.invalidEntries.deductible[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.invalidEntries.deductible[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.invalidEntries.deductible[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.invalidEntries.deductible[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.invalidEntries.deductible[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.invalidEntries.deductible[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.invalidEntries.deductible[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.invalidEntries.deductible[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.invalidEntries.deductible[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.invalidEntries.deductible[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.invalidEntries.deductible[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.invalidEntries.deductible[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.invalidEntries.deductible[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.invalidEntries.deductible[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.invalidEntries.deductible[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.invalidEntries.deductible[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.invalidEntries.deductible[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.invalidEntries.deductible[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.invalidEntries.deductible[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.invalidEntries.deductible[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.invalidEntries.deductible[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.invalidEntries.deductible[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.invalidEntries.deductible[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.invalidEntries.deductible[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.invalidEntries.deductible[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.invalidEntries.deductible[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.invalidEntries.deductible[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.invalidEntries.deductible[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.invalidEntries.deductible[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.invalidEntries.deductible[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.invalidEntries.deductible[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.invalidEntries.deductible[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.invalidEntries.deductible[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.invalidEntries.deductible[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.invalidEntries.deductible[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.invalidEntries.deductible[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.invalidEntries.deductible[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.invalidEntries.deductible[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.invalidEntries.deductible[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.invalidEntries.deductible[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.invalidEntries.deductible[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.invalidEntries.deductible[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.invalidEntries.deductible[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.invalidEntries.deductible[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.invalidEntries.deductible[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.invalidEntries.deductible[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.invalidEntries.deductible[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.invalidEntries.deductible[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.invalidEntries.deductible[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.invalidEntries.deductible[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.invalidEntries.deductible[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

timePeriod
plans[].benefits.invalidEntries.deductible[].timePeriod
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
HOUR
DAY
24_HOURS
YEARS
SERVICE_YEAR
limitations
plans[].benefits.invalidEntries.limitations
Array of Objects

Invalid limitation entries.

Array item
additionalInformation
plans[].benefits.invalidEntries.limitations[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.invalidEntries.limitations[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.invalidEntries.limitations[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.invalidEntries.limitations[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.invalidEntries.limitations[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.invalidEntries.limitations[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.invalidEntries.limitations[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.invalidEntries.limitations[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.invalidEntries.limitations[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.invalidEntries.limitations[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.invalidEntries.limitations[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.invalidEntries.limitations[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.invalidEntries.limitations[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.invalidEntries.limitations[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.invalidEntries.limitations[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.invalidEntries.limitations[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.invalidEntries.limitations[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.invalidEntries.limitations[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.invalidEntries.limitations[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.invalidEntries.limitations[].amount
String

The monetary amount, if present.

coverageLevel
plans[].benefits.invalidEntries.limitations[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.invalidEntries.limitations[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.invalidEntries.limitations[].dates.added
Object

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

Show attributes
end
plans[].benefits.invalidEntries.limitations[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.limitations[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.invalidEntries.limitations[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.invalidEntries.limitations[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.limitations[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.invalidEntries.limitations[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.invalidEntries.limitations[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.limitations[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.invalidEntries.limitations[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.invalidEntries.limitations[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.limitations[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.invalidEntries.limitations[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.invalidEntries.limitations[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.limitations[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.invalidEntries.limitations[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.invalidEntries.limitations[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.limitations[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.invalidEntries.limitations[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.invalidEntries.limitations[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.limitations[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.invalidEntries.limitations[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.invalidEntries.limitations[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.limitations[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.invalidEntries.limitations[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.invalidEntries.limitations[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.limitations[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.invalidEntries.limitations[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.invalidEntries.limitations[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.limitations[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.invalidEntries.limitations[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.invalidEntries.limitations[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.limitations[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.invalidEntries.limitations[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.invalidEntries.limitations[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.limitations[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.invalidEntries.limitations[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.invalidEntries.limitations[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.limitations[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.invalidEntries.limitations[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.invalidEntries.limitations[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.limitations[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.invalidEntries.limitations[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.invalidEntries.limitations[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.invalidEntries.limitations[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.invalidEntries.limitations[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.invalidEntries.limitations[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.invalidEntries.limitations[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
invalidReasons
plans[].benefits.invalidEntries.limitations[].invalidReasons
Array of ObjectsRequired

Reasons explaining why this entry is invalid.

Array item
code
plans[].benefits.invalidEntries.limitations[].invalidReasons[].code
StringRequired

A machine-readable code identifying the validation issue.

Payers may sometimes return other non-compliant values.

Possible values
MISSING_AMOUNT
MISSING_PERCENT
UNEXPECTED_AMOUNT
UNEXPECTED_PERCENT
description
plans[].benefits.invalidEntries.limitations[].invalidReasons[].description
StringRequired

A human-readable description of the validation issue.

messages
plans[].benefits.invalidEntries.limitations[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.invalidEntries.limitations[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.invalidEntries.limitations[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.invalidEntries.limitations[].network.id
String

The plan network identification number.

indicator
plans[].benefits.invalidEntries.limitations[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
percent
plans[].benefits.invalidEntries.limitations[].percent
String

The percentage, if present.

placesOfService
plans[].benefits.invalidEntries.limitations[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.invalidEntries.limitations[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.invalidEntries.limitations[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.invalidEntries.limitations[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.invalidEntries.limitations[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
quantity
plans[].benefits.invalidEntries.limitations[].quantity
Object

The quantity, if present.

Show attributes
qualifier
plans[].benefits.invalidEntries.limitations[].quantity.qualifier
String

The unit of measure for value.

Payers may sometimes return other non-compliant values.

Possible values
MINIMUM
QUANTITY_USED
COVERED_ACTUAL
COVERED_ESTIMATED
NUMBER_OF_CO_INSURANCE_DAYS
value
plans[].benefits.invalidEntries.limitations[].quantity.value
String

The numeric quantity. For example, 10 when the qualifier is VISITS.

relatedEntities
plans[].benefits.invalidEntries.limitations[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.invalidEntries.limitations[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.invalidEntries.limitations[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.invalidEntries.limitations[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.invalidEntries.limitations[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.invalidEntries.limitations[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.invalidEntries.limitations[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.invalidEntries.limitations[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.invalidEntries.limitations[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.invalidEntries.limitations[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.invalidEntries.limitations[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.invalidEntries.limitations[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.invalidEntries.limitations[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.invalidEntries.limitations[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.invalidEntries.limitations[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.invalidEntries.limitations[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.invalidEntries.limitations[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.invalidEntries.limitations[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.invalidEntries.limitations[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.invalidEntries.limitations[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.invalidEntries.limitations[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.invalidEntries.limitations[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.invalidEntries.limitations[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.invalidEntries.limitations[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.invalidEntries.limitations[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.invalidEntries.limitations[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.invalidEntries.limitations[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.invalidEntries.limitations[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.invalidEntries.limitations[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.invalidEntries.limitations[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.invalidEntries.limitations[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.invalidEntries.limitations[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.invalidEntries.limitations[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.invalidEntries.limitations[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.invalidEntries.limitations[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.invalidEntries.limitations[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.invalidEntries.limitations[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.invalidEntries.limitations[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.invalidEntries.limitations[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.invalidEntries.limitations[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.invalidEntries.limitations[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.invalidEntries.limitations[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.invalidEntries.limitations[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.invalidEntries.limitations[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.invalidEntries.limitations[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.invalidEntries.limitations[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.invalidEntries.limitations[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.invalidEntries.limitations[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.invalidEntries.limitations[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.invalidEntries.limitations[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.invalidEntries.limitations[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

timePeriod
plans[].benefits.invalidEntries.limitations[].timePeriod
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
HOUR
DAY
24_HOURS
YEARS
SERVICE_YEAR
outOfPocket
plans[].benefits.invalidEntries.outOfPocket
Array of Objects

Invalid out-of-pocket entries.

Array item
additionalInformation
plans[].benefits.invalidEntries.outOfPocket[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.invalidEntries.outOfPocket[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.invalidEntries.outOfPocket[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.invalidEntries.outOfPocket[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.invalidEntries.outOfPocket[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.invalidEntries.outOfPocket[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.invalidEntries.outOfPocket[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.invalidEntries.outOfPocket[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.invalidEntries.outOfPocket[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.invalidEntries.outOfPocket[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.invalidEntries.outOfPocket[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.invalidEntries.outOfPocket[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.invalidEntries.outOfPocket[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.invalidEntries.outOfPocket[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.invalidEntries.outOfPocket[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.invalidEntries.outOfPocket[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.invalidEntries.outOfPocket[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.invalidEntries.outOfPocket[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.invalidEntries.outOfPocket[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.invalidEntries.outOfPocket[].amount
String

The monetary amount, if present.

coverageLevel
plans[].benefits.invalidEntries.outOfPocket[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.invalidEntries.outOfPocket[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.invalidEntries.outOfPocket[].dates.added
Object

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

Show attributes
end
plans[].benefits.invalidEntries.outOfPocket[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.outOfPocket[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.invalidEntries.outOfPocket[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.invalidEntries.outOfPocket[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.outOfPocket[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.invalidEntries.outOfPocket[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.invalidEntries.outOfPocket[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.outOfPocket[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.invalidEntries.outOfPocket[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.invalidEntries.outOfPocket[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.outOfPocket[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.invalidEntries.outOfPocket[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.invalidEntries.outOfPocket[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.outOfPocket[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.invalidEntries.outOfPocket[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.invalidEntries.outOfPocket[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.outOfPocket[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.invalidEntries.outOfPocket[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.invalidEntries.outOfPocket[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.outOfPocket[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.invalidEntries.outOfPocket[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.invalidEntries.outOfPocket[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.outOfPocket[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.invalidEntries.outOfPocket[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.invalidEntries.outOfPocket[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.outOfPocket[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.invalidEntries.outOfPocket[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.invalidEntries.outOfPocket[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.outOfPocket[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.invalidEntries.outOfPocket[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.invalidEntries.outOfPocket[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.outOfPocket[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.invalidEntries.outOfPocket[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.invalidEntries.outOfPocket[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.outOfPocket[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.invalidEntries.outOfPocket[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.invalidEntries.outOfPocket[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.outOfPocket[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.invalidEntries.outOfPocket[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.invalidEntries.outOfPocket[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.outOfPocket[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.invalidEntries.outOfPocket[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.invalidEntries.outOfPocket[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.invalidEntries.outOfPocket[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.invalidEntries.outOfPocket[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.invalidEntries.outOfPocket[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.invalidEntries.outOfPocket[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
invalidReasons
plans[].benefits.invalidEntries.outOfPocket[].invalidReasons
Array of ObjectsRequired

Reasons explaining why this entry is invalid.

Array item
code
plans[].benefits.invalidEntries.outOfPocket[].invalidReasons[].code
StringRequired

A machine-readable code identifying the validation issue.

Payers may sometimes return other non-compliant values.

Possible values
MISSING_AMOUNT
MISSING_PERCENT
UNEXPECTED_AMOUNT
UNEXPECTED_PERCENT
description
plans[].benefits.invalidEntries.outOfPocket[].invalidReasons[].description
StringRequired

A human-readable description of the validation issue.

messages
plans[].benefits.invalidEntries.outOfPocket[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.invalidEntries.outOfPocket[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.invalidEntries.outOfPocket[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.invalidEntries.outOfPocket[].network.id
String

The plan network identification number.

indicator
plans[].benefits.invalidEntries.outOfPocket[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
percent
plans[].benefits.invalidEntries.outOfPocket[].percent
String

The percentage, if present.

placesOfService
plans[].benefits.invalidEntries.outOfPocket[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.invalidEntries.outOfPocket[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.invalidEntries.outOfPocket[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.invalidEntries.outOfPocket[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.invalidEntries.outOfPocket[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
quantity
plans[].benefits.invalidEntries.outOfPocket[].quantity
Object

The quantity, if present.

Show attributes
qualifier
plans[].benefits.invalidEntries.outOfPocket[].quantity.qualifier
String

The unit of measure for value.

Payers may sometimes return other non-compliant values.

Possible values
MINIMUM
QUANTITY_USED
COVERED_ACTUAL
COVERED_ESTIMATED
NUMBER_OF_CO_INSURANCE_DAYS
value
plans[].benefits.invalidEntries.outOfPocket[].quantity.value
String

The numeric quantity. For example, 10 when the qualifier is VISITS.

relatedEntities
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.invalidEntries.outOfPocket[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.invalidEntries.outOfPocket[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.invalidEntries.outOfPocket[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.invalidEntries.outOfPocket[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.invalidEntries.outOfPocket[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.invalidEntries.outOfPocket[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.invalidEntries.outOfPocket[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.invalidEntries.outOfPocket[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.invalidEntries.outOfPocket[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.invalidEntries.outOfPocket[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.invalidEntries.outOfPocket[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.invalidEntries.outOfPocket[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.invalidEntries.outOfPocket[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.invalidEntries.outOfPocket[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

timePeriod
plans[].benefits.invalidEntries.outOfPocket[].timePeriod
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
HOUR
DAY
24_HOURS
YEARS
SERVICE_YEAR
spendDown
plans[].benefits.invalidEntries.spendDown
Array of Objects

Invalid spend down entries.

Array item
additionalInformation
plans[].benefits.invalidEntries.spendDown[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.invalidEntries.spendDown[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.invalidEntries.spendDown[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.invalidEntries.spendDown[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.invalidEntries.spendDown[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.invalidEntries.spendDown[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.invalidEntries.spendDown[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.invalidEntries.spendDown[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.invalidEntries.spendDown[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.invalidEntries.spendDown[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.invalidEntries.spendDown[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.invalidEntries.spendDown[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.invalidEntries.spendDown[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.invalidEntries.spendDown[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.invalidEntries.spendDown[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.invalidEntries.spendDown[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.invalidEntries.spendDown[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.invalidEntries.spendDown[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.invalidEntries.spendDown[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.invalidEntries.spendDown[].amount
String

The monetary amount, if present.

coverageLevel
plans[].benefits.invalidEntries.spendDown[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.invalidEntries.spendDown[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.invalidEntries.spendDown[].dates.added
Object

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

Show attributes
end
plans[].benefits.invalidEntries.spendDown[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.spendDown[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.invalidEntries.spendDown[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.invalidEntries.spendDown[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.spendDown[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.invalidEntries.spendDown[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.invalidEntries.spendDown[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.spendDown[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.invalidEntries.spendDown[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.invalidEntries.spendDown[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.spendDown[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.invalidEntries.spendDown[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.invalidEntries.spendDown[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.spendDown[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.invalidEntries.spendDown[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.invalidEntries.spendDown[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.spendDown[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.invalidEntries.spendDown[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.invalidEntries.spendDown[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.spendDown[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.invalidEntries.spendDown[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.invalidEntries.spendDown[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.spendDown[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.invalidEntries.spendDown[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.invalidEntries.spendDown[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.spendDown[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.invalidEntries.spendDown[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.invalidEntries.spendDown[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.spendDown[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.invalidEntries.spendDown[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.invalidEntries.spendDown[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.spendDown[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.invalidEntries.spendDown[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.invalidEntries.spendDown[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.spendDown[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.invalidEntries.spendDown[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.invalidEntries.spendDown[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.spendDown[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.invalidEntries.spendDown[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.invalidEntries.spendDown[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.invalidEntries.spendDown[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.invalidEntries.spendDown[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.invalidEntries.spendDown[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.invalidEntries.spendDown[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.invalidEntries.spendDown[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.invalidEntries.spendDown[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.invalidEntries.spendDown[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
invalidReasons
plans[].benefits.invalidEntries.spendDown[].invalidReasons
Array of ObjectsRequired

Reasons explaining why this entry is invalid.

Array item
code
plans[].benefits.invalidEntries.spendDown[].invalidReasons[].code
StringRequired

A machine-readable code identifying the validation issue.

Payers may sometimes return other non-compliant values.

Possible values
MISSING_AMOUNT
MISSING_PERCENT
UNEXPECTED_AMOUNT
UNEXPECTED_PERCENT
description
plans[].benefits.invalidEntries.spendDown[].invalidReasons[].description
StringRequired

A human-readable description of the validation issue.

messages
plans[].benefits.invalidEntries.spendDown[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.invalidEntries.spendDown[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.invalidEntries.spendDown[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.invalidEntries.spendDown[].network.id
String

The plan network identification number.

indicator
plans[].benefits.invalidEntries.spendDown[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
percent
plans[].benefits.invalidEntries.spendDown[].percent
String

The percentage, if present.

placesOfService
plans[].benefits.invalidEntries.spendDown[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.invalidEntries.spendDown[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.invalidEntries.spendDown[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.invalidEntries.spendDown[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.invalidEntries.spendDown[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
quantity
plans[].benefits.invalidEntries.spendDown[].quantity
Object

The quantity, if present.

Show attributes
qualifier
plans[].benefits.invalidEntries.spendDown[].quantity.qualifier
String

The unit of measure for value.

Payers may sometimes return other non-compliant values.

Possible values
MINIMUM
QUANTITY_USED
COVERED_ACTUAL
COVERED_ESTIMATED
NUMBER_OF_CO_INSURANCE_DAYS
value
plans[].benefits.invalidEntries.spendDown[].quantity.value
String

The numeric quantity. For example, 10 when the qualifier is VISITS.

relatedEntities
plans[].benefits.invalidEntries.spendDown[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.invalidEntries.spendDown[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.invalidEntries.spendDown[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.invalidEntries.spendDown[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.invalidEntries.spendDown[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.invalidEntries.spendDown[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.invalidEntries.spendDown[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.invalidEntries.spendDown[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.invalidEntries.spendDown[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.invalidEntries.spendDown[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.invalidEntries.spendDown[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.invalidEntries.spendDown[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.invalidEntries.spendDown[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.invalidEntries.spendDown[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.invalidEntries.spendDown[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

timePeriod
plans[].benefits.invalidEntries.spendDown[].timePeriod
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
HOUR
DAY
24_HOURS
YEARS
SERVICE_YEAR
limitations
plans[].benefits.limitations
Array of Objects

A list of benefit limitation entries, expressed as an amount, percent, or quantity.

Dental and vision plans often use this benefit type to specify an annual maximum benefit amount.

The Affordable Care Act prevents most commercial health plans from imposing limits on annual or lifetime benefit amounts, but this generally doesn't apply to government health plans and some commercial health plans may be exempt.

When present, the amount indicates the maximum benefit amount the plan allocates to the patient. The messages array often includes values like "ANNUAL MAXIMUM".

Array item
additionalInformation
plans[].benefits.limitations[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.limitations[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.limitations[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.limitations[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.limitations[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.limitations[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.limitations[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.limitations[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.limitations[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.limitations[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.limitations[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.limitations[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.limitations[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.limitations[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.limitations[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.limitations[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.limitations[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.limitations[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.limitations[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.limitations[].amount
String

The monetary amount for this limitation.

coverageLevel
plans[].benefits.limitations[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.limitations[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.limitations[].dates.added
Object

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

Show attributes
end
plans[].benefits.limitations[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.limitations[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.limitations[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.limitations[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.limitations[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.limitations[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.limitations[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.limitations[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.limitations[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.limitations[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.limitations[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.limitations[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.limitations[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.limitations[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.limitations[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.limitations[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.limitations[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.limitations[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.limitations[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.limitations[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.limitations[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.limitations[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.limitations[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.limitations[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.limitations[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.limitations[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.limitations[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.limitations[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.limitations[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.limitations[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.limitations[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.limitations[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.limitations[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.limitations[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.limitations[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.limitations[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.limitations[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.limitations[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.limitations[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.limitations[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.limitations[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.limitations[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.limitations[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.limitations[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.limitations[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.limitations[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.limitations[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
messages
plans[].benefits.limitations[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.limitations[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.limitations[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.limitations[].network.id
String

The plan network identification number.

indicator
plans[].benefits.limitations[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
percent
plans[].benefits.limitations[].percent
String

The percentage value for this limitation, expressed as a decimal (e.g., 0.80 for 80%).

placesOfService
plans[].benefits.limitations[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.limitations[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.limitations[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.limitations[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.limitations[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
quantity
plans[].benefits.limitations[].quantity
Object

The quantity for this limitation, when the payer expresses the limit as a count rather than an amount or percentage. For example, 20 visits.

Show attributes
qualifier
plans[].benefits.limitations[].quantity.qualifier
String

The unit of measure for value.

Payers may sometimes return other non-compliant values.

Possible values
MINIMUM
QUANTITY_USED
COVERED_ACTUAL
COVERED_ESTIMATED
NUMBER_OF_CO_INSURANCE_DAYS
value
plans[].benefits.limitations[].quantity.value
String

The numeric quantity. For example, 10 when the qualifier is VISITS.

relatedEntities
plans[].benefits.limitations[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.limitations[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.limitations[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.limitations[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.limitations[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.limitations[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.limitations[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.limitations[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.limitations[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.limitations[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.limitations[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.limitations[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.limitations[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.limitations[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.limitations[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.limitations[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.limitations[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.limitations[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.limitations[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.limitations[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.limitations[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.limitations[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.limitations[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.limitations[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.limitations[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.limitations[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.limitations[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.limitations[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.limitations[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.limitations[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.limitations[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.limitations[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.limitations[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.limitations[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.limitations[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.limitations[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.limitations[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.limitations[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.limitations[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.limitations[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.limitations[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.limitations[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.limitations[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.limitations[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.limitations[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.limitations[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.limitations[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.limitations[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.limitations[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.limitations[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.limitations[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

timePeriod
plans[].benefits.limitations[].timePeriod
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
HOUR
DAY
24_HOURS
YEARS
SERVICE_YEAR
managedCareCoordinator
plans[].benefits.managedCareCoordinator
Array of Objects

A list of managed care coordinator information for the patient.

When present, the care coordinator's details are in the relatedEntities array.

Array item
additionalInformation
plans[].benefits.managedCareCoordinator[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.managedCareCoordinator[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.managedCareCoordinator[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.managedCareCoordinator[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.managedCareCoordinator[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.managedCareCoordinator[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.managedCareCoordinator[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.managedCareCoordinator[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.managedCareCoordinator[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.managedCareCoordinator[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.managedCareCoordinator[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.managedCareCoordinator[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.managedCareCoordinator[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.managedCareCoordinator[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.managedCareCoordinator[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.managedCareCoordinator[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.managedCareCoordinator[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.managedCareCoordinator[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.managedCareCoordinator[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.managedCareCoordinator[].amount
String

The monetary amount associated with this benefit.

coverageLevel
plans[].benefits.managedCareCoordinator[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.managedCareCoordinator[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.managedCareCoordinator[].dates.added
Object

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

Show attributes
end
plans[].benefits.managedCareCoordinator[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.managedCareCoordinator[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.managedCareCoordinator[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.managedCareCoordinator[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.managedCareCoordinator[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.managedCareCoordinator[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.managedCareCoordinator[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.managedCareCoordinator[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.managedCareCoordinator[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.managedCareCoordinator[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.managedCareCoordinator[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.managedCareCoordinator[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.managedCareCoordinator[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.managedCareCoordinator[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.managedCareCoordinator[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.managedCareCoordinator[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.managedCareCoordinator[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.managedCareCoordinator[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.managedCareCoordinator[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.managedCareCoordinator[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.managedCareCoordinator[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.managedCareCoordinator[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.managedCareCoordinator[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.managedCareCoordinator[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.managedCareCoordinator[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.managedCareCoordinator[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.managedCareCoordinator[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.managedCareCoordinator[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.managedCareCoordinator[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.managedCareCoordinator[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.managedCareCoordinator[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.managedCareCoordinator[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.managedCareCoordinator[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.managedCareCoordinator[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.managedCareCoordinator[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.managedCareCoordinator[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.managedCareCoordinator[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.managedCareCoordinator[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.managedCareCoordinator[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.managedCareCoordinator[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.managedCareCoordinator[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.managedCareCoordinator[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.managedCareCoordinator[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.managedCareCoordinator[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.managedCareCoordinator[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.managedCareCoordinator[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.managedCareCoordinator[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
messages
plans[].benefits.managedCareCoordinator[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.managedCareCoordinator[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.managedCareCoordinator[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.managedCareCoordinator[].network.id
String

The plan network identification number.

indicator
plans[].benefits.managedCareCoordinator[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
percent
plans[].benefits.managedCareCoordinator[].percent
String

The percentage associated with this benefit.

placesOfService
plans[].benefits.managedCareCoordinator[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.managedCareCoordinator[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.managedCareCoordinator[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.managedCareCoordinator[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.managedCareCoordinator[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
relatedEntities
plans[].benefits.managedCareCoordinator[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.managedCareCoordinator[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.managedCareCoordinator[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.managedCareCoordinator[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.managedCareCoordinator[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.managedCareCoordinator[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.managedCareCoordinator[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.managedCareCoordinator[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.managedCareCoordinator[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.managedCareCoordinator[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.managedCareCoordinator[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.managedCareCoordinator[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.managedCareCoordinator[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.managedCareCoordinator[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.managedCareCoordinator[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.managedCareCoordinator[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.managedCareCoordinator[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.managedCareCoordinator[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.managedCareCoordinator[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.managedCareCoordinator[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.managedCareCoordinator[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.managedCareCoordinator[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.managedCareCoordinator[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.managedCareCoordinator[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.managedCareCoordinator[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.managedCareCoordinator[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.managedCareCoordinator[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.managedCareCoordinator[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.managedCareCoordinator[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.managedCareCoordinator[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.managedCareCoordinator[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.managedCareCoordinator[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.managedCareCoordinator[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.managedCareCoordinator[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.managedCareCoordinator[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.managedCareCoordinator[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.managedCareCoordinator[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.managedCareCoordinator[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.managedCareCoordinator[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.managedCareCoordinator[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.managedCareCoordinator[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.managedCareCoordinator[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.managedCareCoordinator[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.managedCareCoordinator[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.managedCareCoordinator[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.managedCareCoordinator[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.managedCareCoordinator[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.managedCareCoordinator[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.managedCareCoordinator[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.managedCareCoordinator[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.managedCareCoordinator[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

nonCovered
plans[].benefits.nonCovered
Array of Objects

A list of non-covered services for the patient.

Indicates that the patient's plan doesn't cover a specific service type you submitted in the eligibility check. Note that the absence of a nonCovered entry doesn't mean that a specific service is covered.

Array item
additionalInformation
plans[].benefits.nonCovered[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.nonCovered[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.nonCovered[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.nonCovered[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.nonCovered[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.nonCovered[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.nonCovered[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.nonCovered[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.nonCovered[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.nonCovered[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.nonCovered[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.nonCovered[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.nonCovered[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.nonCovered[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.nonCovered[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.nonCovered[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.nonCovered[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.nonCovered[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.nonCovered[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.nonCovered[].amount
String

The monetary amount associated with this benefit.

coverageLevel
plans[].benefits.nonCovered[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.nonCovered[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.nonCovered[].dates.added
Object

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

Show attributes
end
plans[].benefits.nonCovered[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.nonCovered[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.nonCovered[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.nonCovered[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.nonCovered[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.nonCovered[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.nonCovered[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.nonCovered[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.nonCovered[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.nonCovered[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.nonCovered[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.nonCovered[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.nonCovered[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.nonCovered[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.nonCovered[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.nonCovered[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.nonCovered[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.nonCovered[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.nonCovered[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.nonCovered[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.nonCovered[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.nonCovered[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.nonCovered[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.nonCovered[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.nonCovered[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.nonCovered[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.nonCovered[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.nonCovered[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.nonCovered[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.nonCovered[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.nonCovered[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.nonCovered[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.nonCovered[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.nonCovered[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.nonCovered[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.nonCovered[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.nonCovered[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.nonCovered[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.nonCovered[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.nonCovered[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.nonCovered[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.nonCovered[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.nonCovered[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.nonCovered[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.nonCovered[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.nonCovered[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.nonCovered[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
messages
plans[].benefits.nonCovered[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.nonCovered[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.nonCovered[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.nonCovered[].network.id
String

The plan network identification number.

indicator
plans[].benefits.nonCovered[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
percent
plans[].benefits.nonCovered[].percent
String

The percentage associated with this benefit.

placesOfService
plans[].benefits.nonCovered[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.nonCovered[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.nonCovered[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.nonCovered[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.nonCovered[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
relatedEntities
plans[].benefits.nonCovered[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.nonCovered[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.nonCovered[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.nonCovered[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.nonCovered[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.nonCovered[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.nonCovered[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.nonCovered[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.nonCovered[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.nonCovered[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.nonCovered[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.nonCovered[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.nonCovered[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.nonCovered[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.nonCovered[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.nonCovered[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.nonCovered[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.nonCovered[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.nonCovered[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.nonCovered[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.nonCovered[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.nonCovered[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.nonCovered[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.nonCovered[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.nonCovered[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.nonCovered[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.nonCovered[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.nonCovered[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.nonCovered[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.nonCovered[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.nonCovered[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.nonCovered[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.nonCovered[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.nonCovered[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.nonCovered[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.nonCovered[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.nonCovered[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.nonCovered[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.nonCovered[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.nonCovered[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.nonCovered[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.nonCovered[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.nonCovered[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.nonCovered[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.nonCovered[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.nonCovered[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.nonCovered[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.nonCovered[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.nonCovered[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.nonCovered[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.nonCovered[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

notDeemedMedicalNecessity
plans[].benefits.notDeemedMedicalNecessity
Array of Objects

A list of services the payer determined aren't medically necessary for the patient.

Indicates the payer has determined this service isn't medically necessary and won't cover it on that basis.

Array item
additionalInformation
plans[].benefits.notDeemedMedicalNecessity[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.notDeemedMedicalNecessity[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.notDeemedMedicalNecessity[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.notDeemedMedicalNecessity[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.notDeemedMedicalNecessity[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.notDeemedMedicalNecessity[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.notDeemedMedicalNecessity[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.notDeemedMedicalNecessity[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.notDeemedMedicalNecessity[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.notDeemedMedicalNecessity[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.notDeemedMedicalNecessity[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.notDeemedMedicalNecessity[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.notDeemedMedicalNecessity[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.notDeemedMedicalNecessity[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.notDeemedMedicalNecessity[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.notDeemedMedicalNecessity[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.notDeemedMedicalNecessity[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.notDeemedMedicalNecessity[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.notDeemedMedicalNecessity[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.notDeemedMedicalNecessity[].amount
String

The monetary amount associated with this benefit.

coverageLevel
plans[].benefits.notDeemedMedicalNecessity[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.notDeemedMedicalNecessity[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.notDeemedMedicalNecessity[].dates.added
Object

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

Show attributes
end
plans[].benefits.notDeemedMedicalNecessity[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.notDeemedMedicalNecessity[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.notDeemedMedicalNecessity[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.notDeemedMedicalNecessity[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.notDeemedMedicalNecessity[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.notDeemedMedicalNecessity[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.notDeemedMedicalNecessity[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.notDeemedMedicalNecessity[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.notDeemedMedicalNecessity[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.notDeemedMedicalNecessity[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.notDeemedMedicalNecessity[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.notDeemedMedicalNecessity[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.notDeemedMedicalNecessity[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.notDeemedMedicalNecessity[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.notDeemedMedicalNecessity[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.notDeemedMedicalNecessity[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.notDeemedMedicalNecessity[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.notDeemedMedicalNecessity[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.notDeemedMedicalNecessity[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.notDeemedMedicalNecessity[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.notDeemedMedicalNecessity[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.notDeemedMedicalNecessity[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.notDeemedMedicalNecessity[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.notDeemedMedicalNecessity[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.notDeemedMedicalNecessity[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.notDeemedMedicalNecessity[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.notDeemedMedicalNecessity[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.notDeemedMedicalNecessity[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.notDeemedMedicalNecessity[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.notDeemedMedicalNecessity[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.notDeemedMedicalNecessity[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.notDeemedMedicalNecessity[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.notDeemedMedicalNecessity[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.notDeemedMedicalNecessity[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.notDeemedMedicalNecessity[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.notDeemedMedicalNecessity[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.notDeemedMedicalNecessity[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.notDeemedMedicalNecessity[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.notDeemedMedicalNecessity[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.notDeemedMedicalNecessity[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.notDeemedMedicalNecessity[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.notDeemedMedicalNecessity[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.notDeemedMedicalNecessity[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.notDeemedMedicalNecessity[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.notDeemedMedicalNecessity[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.notDeemedMedicalNecessity[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.notDeemedMedicalNecessity[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
messages
plans[].benefits.notDeemedMedicalNecessity[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.notDeemedMedicalNecessity[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.notDeemedMedicalNecessity[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.notDeemedMedicalNecessity[].network.id
String

The plan network identification number.

indicator
plans[].benefits.notDeemedMedicalNecessity[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
percent
plans[].benefits.notDeemedMedicalNecessity[].percent
String

The percentage associated with this benefit.

placesOfService
plans[].benefits.notDeemedMedicalNecessity[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.notDeemedMedicalNecessity[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.notDeemedMedicalNecessity[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.notDeemedMedicalNecessity[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.notDeemedMedicalNecessity[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
relatedEntities
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.notDeemedMedicalNecessity[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.notDeemedMedicalNecessity[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.notDeemedMedicalNecessity[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.notDeemedMedicalNecessity[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.notDeemedMedicalNecessity[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.notDeemedMedicalNecessity[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.notDeemedMedicalNecessity[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.notDeemedMedicalNecessity[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.notDeemedMedicalNecessity[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.notDeemedMedicalNecessity[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.notDeemedMedicalNecessity[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.notDeemedMedicalNecessity[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.notDeemedMedicalNecessity[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.notDeemedMedicalNecessity[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

otherOrAdditionalPayer
plans[].benefits.otherOrAdditionalPayer
Array of Objects

A list of other payers with coverage responsibility for the patient.

Indicates another payer that has coverage responsibility for the patient. This is the signal for coordination of benefits (COB) scenarios. The other payer's details are available in the relatedEntities array.

Array item
additionalInformation
plans[].benefits.otherOrAdditionalPayer[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.otherOrAdditionalPayer[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.otherOrAdditionalPayer[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.otherOrAdditionalPayer[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.otherOrAdditionalPayer[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.otherOrAdditionalPayer[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.otherOrAdditionalPayer[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.otherOrAdditionalPayer[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.otherOrAdditionalPayer[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.otherOrAdditionalPayer[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.otherOrAdditionalPayer[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.otherOrAdditionalPayer[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.otherOrAdditionalPayer[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.otherOrAdditionalPayer[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.otherOrAdditionalPayer[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.otherOrAdditionalPayer[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.otherOrAdditionalPayer[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.otherOrAdditionalPayer[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.otherOrAdditionalPayer[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.otherOrAdditionalPayer[].amount
String

The monetary amount associated with this benefit.

coverageLevel
plans[].benefits.otherOrAdditionalPayer[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.otherOrAdditionalPayer[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.otherOrAdditionalPayer[].dates.added
Object

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

Show attributes
end
plans[].benefits.otherOrAdditionalPayer[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.otherOrAdditionalPayer[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.otherOrAdditionalPayer[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.otherOrAdditionalPayer[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.otherOrAdditionalPayer[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.otherOrAdditionalPayer[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.otherOrAdditionalPayer[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.otherOrAdditionalPayer[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.otherOrAdditionalPayer[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.otherOrAdditionalPayer[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.otherOrAdditionalPayer[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.otherOrAdditionalPayer[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.otherOrAdditionalPayer[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.otherOrAdditionalPayer[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.otherOrAdditionalPayer[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.otherOrAdditionalPayer[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.otherOrAdditionalPayer[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.otherOrAdditionalPayer[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.otherOrAdditionalPayer[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.otherOrAdditionalPayer[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.otherOrAdditionalPayer[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.otherOrAdditionalPayer[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.otherOrAdditionalPayer[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.otherOrAdditionalPayer[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.otherOrAdditionalPayer[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.otherOrAdditionalPayer[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.otherOrAdditionalPayer[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.otherOrAdditionalPayer[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.otherOrAdditionalPayer[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.otherOrAdditionalPayer[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.otherOrAdditionalPayer[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.otherOrAdditionalPayer[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.otherOrAdditionalPayer[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.otherOrAdditionalPayer[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.otherOrAdditionalPayer[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.otherOrAdditionalPayer[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.otherOrAdditionalPayer[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.otherOrAdditionalPayer[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.otherOrAdditionalPayer[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.otherOrAdditionalPayer[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.otherOrAdditionalPayer[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.otherOrAdditionalPayer[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.otherOrAdditionalPayer[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.otherOrAdditionalPayer[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.otherOrAdditionalPayer[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.otherOrAdditionalPayer[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.otherOrAdditionalPayer[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
messages
plans[].benefits.otherOrAdditionalPayer[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.otherOrAdditionalPayer[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.otherOrAdditionalPayer[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.otherOrAdditionalPayer[].network.id
String

The plan network identification number.

indicator
plans[].benefits.otherOrAdditionalPayer[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
percent
plans[].benefits.otherOrAdditionalPayer[].percent
String

The percentage associated with this benefit.

placesOfService
plans[].benefits.otherOrAdditionalPayer[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.otherOrAdditionalPayer[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.otherOrAdditionalPayer[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.otherOrAdditionalPayer[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.otherOrAdditionalPayer[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
relatedEntities
plans[].benefits.otherOrAdditionalPayer[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.otherOrAdditionalPayer[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.otherOrAdditionalPayer[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.otherOrAdditionalPayer[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.otherOrAdditionalPayer[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.otherOrAdditionalPayer[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.otherOrAdditionalPayer[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.otherOrAdditionalPayer[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.otherOrAdditionalPayer[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.otherOrAdditionalPayer[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.otherOrAdditionalPayer[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.otherOrAdditionalPayer[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.otherOrAdditionalPayer[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.otherOrAdditionalPayer[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.otherOrAdditionalPayer[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

otherSourceOfData
plans[].benefits.otherSourceOfData
Array of Objects

A list of entries indicating the benefit information originates from another source.

Indicates the information provided came from a source other than the payer's own system. Rarely returned.

Array item
additionalInformation
plans[].benefits.otherSourceOfData[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.otherSourceOfData[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.otherSourceOfData[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.otherSourceOfData[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.otherSourceOfData[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.otherSourceOfData[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.otherSourceOfData[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.otherSourceOfData[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.otherSourceOfData[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.otherSourceOfData[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.otherSourceOfData[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.otherSourceOfData[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.otherSourceOfData[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.otherSourceOfData[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.otherSourceOfData[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.otherSourceOfData[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.otherSourceOfData[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.otherSourceOfData[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.otherSourceOfData[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.otherSourceOfData[].amount
String

The monetary amount associated with this benefit.

coverageLevel
plans[].benefits.otherSourceOfData[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.otherSourceOfData[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.otherSourceOfData[].dates.added
Object

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

Show attributes
end
plans[].benefits.otherSourceOfData[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.otherSourceOfData[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.otherSourceOfData[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.otherSourceOfData[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.otherSourceOfData[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.otherSourceOfData[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.otherSourceOfData[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.otherSourceOfData[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.otherSourceOfData[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.otherSourceOfData[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.otherSourceOfData[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.otherSourceOfData[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.otherSourceOfData[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.otherSourceOfData[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.otherSourceOfData[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.otherSourceOfData[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.otherSourceOfData[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.otherSourceOfData[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.otherSourceOfData[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.otherSourceOfData[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.otherSourceOfData[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.otherSourceOfData[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.otherSourceOfData[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.otherSourceOfData[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.otherSourceOfData[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.otherSourceOfData[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.otherSourceOfData[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.otherSourceOfData[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.otherSourceOfData[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.otherSourceOfData[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.otherSourceOfData[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.otherSourceOfData[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.otherSourceOfData[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.otherSourceOfData[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.otherSourceOfData[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.otherSourceOfData[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.otherSourceOfData[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.otherSourceOfData[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.otherSourceOfData[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.otherSourceOfData[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.otherSourceOfData[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.otherSourceOfData[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.otherSourceOfData[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.otherSourceOfData[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.otherSourceOfData[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.otherSourceOfData[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.otherSourceOfData[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
messages
plans[].benefits.otherSourceOfData[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.otherSourceOfData[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.otherSourceOfData[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.otherSourceOfData[].network.id
String

The plan network identification number.

indicator
plans[].benefits.otherSourceOfData[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
percent
plans[].benefits.otherSourceOfData[].percent
String

The percentage associated with this benefit.

placesOfService
plans[].benefits.otherSourceOfData[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.otherSourceOfData[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.otherSourceOfData[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.otherSourceOfData[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.otherSourceOfData[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
relatedEntities
plans[].benefits.otherSourceOfData[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.otherSourceOfData[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.otherSourceOfData[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.otherSourceOfData[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.otherSourceOfData[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.otherSourceOfData[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.otherSourceOfData[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.otherSourceOfData[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.otherSourceOfData[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.otherSourceOfData[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.otherSourceOfData[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.otherSourceOfData[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.otherSourceOfData[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.otherSourceOfData[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.otherSourceOfData[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.otherSourceOfData[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.otherSourceOfData[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.otherSourceOfData[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.otherSourceOfData[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.otherSourceOfData[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.otherSourceOfData[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.otherSourceOfData[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.otherSourceOfData[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.otherSourceOfData[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.otherSourceOfData[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.otherSourceOfData[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.otherSourceOfData[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.otherSourceOfData[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.otherSourceOfData[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.otherSourceOfData[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.otherSourceOfData[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.otherSourceOfData[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.otherSourceOfData[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.otherSourceOfData[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.otherSourceOfData[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.otherSourceOfData[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.otherSourceOfData[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.otherSourceOfData[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.otherSourceOfData[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.otherSourceOfData[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.otherSourceOfData[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.otherSourceOfData[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.otherSourceOfData[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.otherSourceOfData[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.otherSourceOfData[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.otherSourceOfData[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.otherSourceOfData[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.otherSourceOfData[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.otherSourceOfData[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.otherSourceOfData[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.otherSourceOfData[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

outOfPocket
plans[].benefits.outOfPocket
Array of Objects

A list of out-of-pocket maximum benefit entries from the payer.

The amount is the limit on what the patient pays. The decimal precision reflects what the payer sent (for example, 5000.0 or 5000). Check timePeriod to determine whether an amount is the full maximum or the amount remaining.

Array item
additionalInformation
plans[].benefits.outOfPocket[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.outOfPocket[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.outOfPocket[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.outOfPocket[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.outOfPocket[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.outOfPocket[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.outOfPocket[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.outOfPocket[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.outOfPocket[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.outOfPocket[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.outOfPocket[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.outOfPocket[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.outOfPocket[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.outOfPocket[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.outOfPocket[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.outOfPocket[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.outOfPocket[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.outOfPocket[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.outOfPocket[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.outOfPocket[].amount
StringRequired

The monetary amount for this benefit.

coverageLevel
plans[].benefits.outOfPocket[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.outOfPocket[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.outOfPocket[].dates.added
Object

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

Show attributes
end
plans[].benefits.outOfPocket[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.outOfPocket[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.outOfPocket[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.outOfPocket[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.outOfPocket[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.outOfPocket[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.outOfPocket[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.outOfPocket[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.outOfPocket[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.outOfPocket[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.outOfPocket[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.outOfPocket[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.outOfPocket[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.outOfPocket[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.outOfPocket[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.outOfPocket[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.outOfPocket[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.outOfPocket[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.outOfPocket[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.outOfPocket[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.outOfPocket[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.outOfPocket[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.outOfPocket[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.outOfPocket[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.outOfPocket[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.outOfPocket[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.outOfPocket[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.outOfPocket[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.outOfPocket[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.outOfPocket[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.outOfPocket[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.outOfPocket[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.outOfPocket[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.outOfPocket[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.outOfPocket[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.outOfPocket[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.outOfPocket[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.outOfPocket[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.outOfPocket[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.outOfPocket[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.outOfPocket[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.outOfPocket[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.outOfPocket[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.outOfPocket[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.outOfPocket[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.outOfPocket[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.outOfPocket[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
messages
plans[].benefits.outOfPocket[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.outOfPocket[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.outOfPocket[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.outOfPocket[].network.id
String

The plan network identification number.

indicator
plans[].benefits.outOfPocket[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
placesOfService
plans[].benefits.outOfPocket[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.outOfPocket[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.outOfPocket[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.outOfPocket[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.outOfPocket[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
quantity
plans[].benefits.outOfPocket[].quantity
Object

The quantity the amount applies to, when the payer sends one. For example, 60 days of inpatient care.

Show attributes
qualifier
plans[].benefits.outOfPocket[].quantity.qualifier
String

The unit of measure for value.

Payers may sometimes return other non-compliant values.

Possible values
MINIMUM
QUANTITY_USED
COVERED_ACTUAL
COVERED_ESTIMATED
NUMBER_OF_CO_INSURANCE_DAYS
value
plans[].benefits.outOfPocket[].quantity.value
String

The numeric quantity. For example, 10 when the qualifier is VISITS.

relatedEntities
plans[].benefits.outOfPocket[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.outOfPocket[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.outOfPocket[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.outOfPocket[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.outOfPocket[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.outOfPocket[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.outOfPocket[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.outOfPocket[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.outOfPocket[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.outOfPocket[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.outOfPocket[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.outOfPocket[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.outOfPocket[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.outOfPocket[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.outOfPocket[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.outOfPocket[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.outOfPocket[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.outOfPocket[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.outOfPocket[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.outOfPocket[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.outOfPocket[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.outOfPocket[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.outOfPocket[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.outOfPocket[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.outOfPocket[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.outOfPocket[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.outOfPocket[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.outOfPocket[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.outOfPocket[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.outOfPocket[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.outOfPocket[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.outOfPocket[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.outOfPocket[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.outOfPocket[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.outOfPocket[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.outOfPocket[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.outOfPocket[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.outOfPocket[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.outOfPocket[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.outOfPocket[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.outOfPocket[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.outOfPocket[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.outOfPocket[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.outOfPocket[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.outOfPocket[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.outOfPocket[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.outOfPocket[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.outOfPocket[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.outOfPocket[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.outOfPocket[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.outOfPocket[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

timePeriod
plans[].benefits.outOfPocket[].timePeriod
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
HOUR
DAY
24_HOURS
YEARS
SERVICE_YEAR
preExistingCondition
plans[].benefits.preExistingCondition
Array of Objects

A list of coverage restrictions due to pre-existing conditions.

Indicates coverage for this benefit is restricted because of a pre-existing condition.

Array item
additionalInformation
plans[].benefits.preExistingCondition[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.preExistingCondition[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.preExistingCondition[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.preExistingCondition[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.preExistingCondition[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.preExistingCondition[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.preExistingCondition[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.preExistingCondition[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.preExistingCondition[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.preExistingCondition[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.preExistingCondition[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.preExistingCondition[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.preExistingCondition[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.preExistingCondition[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.preExistingCondition[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.preExistingCondition[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.preExistingCondition[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.preExistingCondition[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.preExistingCondition[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.preExistingCondition[].amount
String

The monetary amount associated with this benefit.

coverageLevel
plans[].benefits.preExistingCondition[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.preExistingCondition[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.preExistingCondition[].dates.added
Object

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

Show attributes
end
plans[].benefits.preExistingCondition[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.preExistingCondition[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.preExistingCondition[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.preExistingCondition[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.preExistingCondition[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.preExistingCondition[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.preExistingCondition[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.preExistingCondition[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.preExistingCondition[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.preExistingCondition[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.preExistingCondition[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.preExistingCondition[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.preExistingCondition[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.preExistingCondition[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.preExistingCondition[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.preExistingCondition[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.preExistingCondition[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.preExistingCondition[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.preExistingCondition[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.preExistingCondition[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.preExistingCondition[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.preExistingCondition[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.preExistingCondition[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.preExistingCondition[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.preExistingCondition[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.preExistingCondition[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.preExistingCondition[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.preExistingCondition[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.preExistingCondition[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.preExistingCondition[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.preExistingCondition[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.preExistingCondition[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.preExistingCondition[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.preExistingCondition[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.preExistingCondition[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.preExistingCondition[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.preExistingCondition[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.preExistingCondition[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.preExistingCondition[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.preExistingCondition[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.preExistingCondition[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.preExistingCondition[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.preExistingCondition[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.preExistingCondition[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.preExistingCondition[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.preExistingCondition[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.preExistingCondition[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
messages
plans[].benefits.preExistingCondition[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.preExistingCondition[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.preExistingCondition[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.preExistingCondition[].network.id
String

The plan network identification number.

indicator
plans[].benefits.preExistingCondition[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
percent
plans[].benefits.preExistingCondition[].percent
String

The percentage associated with this benefit.

placesOfService
plans[].benefits.preExistingCondition[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.preExistingCondition[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.preExistingCondition[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.preExistingCondition[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.preExistingCondition[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
relatedEntities
plans[].benefits.preExistingCondition[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.preExistingCondition[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.preExistingCondition[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.preExistingCondition[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.preExistingCondition[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.preExistingCondition[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.preExistingCondition[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.preExistingCondition[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.preExistingCondition[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.preExistingCondition[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.preExistingCondition[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.preExistingCondition[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.preExistingCondition[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.preExistingCondition[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.preExistingCondition[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.preExistingCondition[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.preExistingCondition[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.preExistingCondition[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.preExistingCondition[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.preExistingCondition[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.preExistingCondition[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.preExistingCondition[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.preExistingCondition[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.preExistingCondition[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.preExistingCondition[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.preExistingCondition[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.preExistingCondition[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.preExistingCondition[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.preExistingCondition[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.preExistingCondition[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.preExistingCondition[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.preExistingCondition[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.preExistingCondition[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.preExistingCondition[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.preExistingCondition[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.preExistingCondition[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.preExistingCondition[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.preExistingCondition[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.preExistingCondition[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.preExistingCondition[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.preExistingCondition[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.preExistingCondition[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.preExistingCondition[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.preExistingCondition[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.preExistingCondition[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.preExistingCondition[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.preExistingCondition[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.preExistingCondition[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.preExistingCondition[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.preExistingCondition[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.preExistingCondition[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

primaryCareProvider
plans[].benefits.primaryCareProvider
Array of Objects

A list of primary care providers for the patient.

A PCP is the main healthcare provider responsible for managing a patient's care and coordinating referrals to specialists. When present, the provider's information is available in the relatedEntities array.

Array item
additionalInformation
plans[].benefits.primaryCareProvider[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.primaryCareProvider[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.primaryCareProvider[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.primaryCareProvider[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.primaryCareProvider[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.primaryCareProvider[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.primaryCareProvider[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.primaryCareProvider[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.primaryCareProvider[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.primaryCareProvider[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.primaryCareProvider[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.primaryCareProvider[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.primaryCareProvider[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.primaryCareProvider[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.primaryCareProvider[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.primaryCareProvider[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.primaryCareProvider[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.primaryCareProvider[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.primaryCareProvider[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.primaryCareProvider[].amount
String

The monetary amount associated with this benefit.

coverageLevel
plans[].benefits.primaryCareProvider[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.primaryCareProvider[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.primaryCareProvider[].dates.added
Object

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

Show attributes
end
plans[].benefits.primaryCareProvider[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.primaryCareProvider[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.primaryCareProvider[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.primaryCareProvider[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.primaryCareProvider[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.primaryCareProvider[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.primaryCareProvider[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.primaryCareProvider[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.primaryCareProvider[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.primaryCareProvider[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.primaryCareProvider[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.primaryCareProvider[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.primaryCareProvider[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.primaryCareProvider[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.primaryCareProvider[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.primaryCareProvider[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.primaryCareProvider[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.primaryCareProvider[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.primaryCareProvider[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.primaryCareProvider[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.primaryCareProvider[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.primaryCareProvider[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.primaryCareProvider[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.primaryCareProvider[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.primaryCareProvider[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.primaryCareProvider[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.primaryCareProvider[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.primaryCareProvider[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.primaryCareProvider[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.primaryCareProvider[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.primaryCareProvider[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.primaryCareProvider[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.primaryCareProvider[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.primaryCareProvider[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.primaryCareProvider[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.primaryCareProvider[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.primaryCareProvider[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.primaryCareProvider[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.primaryCareProvider[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.primaryCareProvider[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.primaryCareProvider[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.primaryCareProvider[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.primaryCareProvider[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.primaryCareProvider[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.primaryCareProvider[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.primaryCareProvider[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.primaryCareProvider[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
messages
plans[].benefits.primaryCareProvider[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.primaryCareProvider[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.primaryCareProvider[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.primaryCareProvider[].network.id
String

The plan network identification number.

indicator
plans[].benefits.primaryCareProvider[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
percent
plans[].benefits.primaryCareProvider[].percent
String

The percentage associated with this benefit.

placesOfService
plans[].benefits.primaryCareProvider[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.primaryCareProvider[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.primaryCareProvider[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.primaryCareProvider[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.primaryCareProvider[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
relatedEntities
plans[].benefits.primaryCareProvider[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.primaryCareProvider[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.primaryCareProvider[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.primaryCareProvider[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.primaryCareProvider[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.primaryCareProvider[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.primaryCareProvider[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.primaryCareProvider[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.primaryCareProvider[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.primaryCareProvider[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.primaryCareProvider[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.primaryCareProvider[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.primaryCareProvider[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.primaryCareProvider[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.primaryCareProvider[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.primaryCareProvider[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.primaryCareProvider[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.primaryCareProvider[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.primaryCareProvider[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.primaryCareProvider[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.primaryCareProvider[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.primaryCareProvider[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.primaryCareProvider[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.primaryCareProvider[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.primaryCareProvider[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.primaryCareProvider[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.primaryCareProvider[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.primaryCareProvider[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.primaryCareProvider[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.primaryCareProvider[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.primaryCareProvider[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.primaryCareProvider[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.primaryCareProvider[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.primaryCareProvider[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.primaryCareProvider[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.primaryCareProvider[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.primaryCareProvider[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.primaryCareProvider[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.primaryCareProvider[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.primaryCareProvider[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.primaryCareProvider[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.primaryCareProvider[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.primaryCareProvider[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.primaryCareProvider[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.primaryCareProvider[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.primaryCareProvider[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.primaryCareProvider[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.primaryCareProvider[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.primaryCareProvider[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.primaryCareProvider[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.primaryCareProvider[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

priorYearsHistory
plans[].benefits.priorYearsHistory
Array of Objects

A list of historical benefits information for the patient.

Array item
additionalInformation
plans[].benefits.priorYearsHistory[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.priorYearsHistory[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.priorYearsHistory[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.priorYearsHistory[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.priorYearsHistory[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.priorYearsHistory[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.priorYearsHistory[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.priorYearsHistory[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.priorYearsHistory[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.priorYearsHistory[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.priorYearsHistory[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.priorYearsHistory[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.priorYearsHistory[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.priorYearsHistory[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.priorYearsHistory[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.priorYearsHistory[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.priorYearsHistory[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.priorYearsHistory[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.priorYearsHistory[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.priorYearsHistory[].amount
String

The monetary amount associated with this benefit.

coverageLevel
plans[].benefits.priorYearsHistory[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.priorYearsHistory[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.priorYearsHistory[].dates.added
Object

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

Show attributes
end
plans[].benefits.priorYearsHistory[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.priorYearsHistory[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.priorYearsHistory[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.priorYearsHistory[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.priorYearsHistory[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.priorYearsHistory[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.priorYearsHistory[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.priorYearsHistory[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.priorYearsHistory[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.priorYearsHistory[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.priorYearsHistory[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.priorYearsHistory[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.priorYearsHistory[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.priorYearsHistory[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.priorYearsHistory[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.priorYearsHistory[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.priorYearsHistory[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.priorYearsHistory[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.priorYearsHistory[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.priorYearsHistory[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.priorYearsHistory[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.priorYearsHistory[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.priorYearsHistory[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.priorYearsHistory[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.priorYearsHistory[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.priorYearsHistory[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.priorYearsHistory[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.priorYearsHistory[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.priorYearsHistory[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.priorYearsHistory[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.priorYearsHistory[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.priorYearsHistory[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.priorYearsHistory[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.priorYearsHistory[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.priorYearsHistory[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.priorYearsHistory[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.priorYearsHistory[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.priorYearsHistory[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.priorYearsHistory[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.priorYearsHistory[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.priorYearsHistory[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.priorYearsHistory[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.priorYearsHistory[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.priorYearsHistory[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.priorYearsHistory[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.priorYearsHistory[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.priorYearsHistory[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
messages
plans[].benefits.priorYearsHistory[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.priorYearsHistory[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.priorYearsHistory[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.priorYearsHistory[].network.id
String

The plan network identification number.

indicator
plans[].benefits.priorYearsHistory[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
percent
plans[].benefits.priorYearsHistory[].percent
String

The percentage associated with this benefit.

placesOfService
plans[].benefits.priorYearsHistory[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.priorYearsHistory[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.priorYearsHistory[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.priorYearsHistory[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.priorYearsHistory[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
relatedEntities
plans[].benefits.priorYearsHistory[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.priorYearsHistory[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.priorYearsHistory[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.priorYearsHistory[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.priorYearsHistory[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.priorYearsHistory[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.priorYearsHistory[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.priorYearsHistory[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.priorYearsHistory[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.priorYearsHistory[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.priorYearsHistory[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.priorYearsHistory[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.priorYearsHistory[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.priorYearsHistory[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.priorYearsHistory[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.priorYearsHistory[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.priorYearsHistory[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.priorYearsHistory[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.priorYearsHistory[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.priorYearsHistory[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.priorYearsHistory[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.priorYearsHistory[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.priorYearsHistory[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.priorYearsHistory[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.priorYearsHistory[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.priorYearsHistory[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.priorYearsHistory[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.priorYearsHistory[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.priorYearsHistory[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.priorYearsHistory[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.priorYearsHistory[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.priorYearsHistory[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.priorYearsHistory[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.priorYearsHistory[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.priorYearsHistory[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.priorYearsHistory[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.priorYearsHistory[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.priorYearsHistory[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.priorYearsHistory[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.priorYearsHistory[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.priorYearsHistory[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.priorYearsHistory[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.priorYearsHistory[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.priorYearsHistory[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.priorYearsHistory[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.priorYearsHistory[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.priorYearsHistory[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.priorYearsHistory[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.priorYearsHistory[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.priorYearsHistory[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.priorYearsHistory[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

reserve
plans[].benefits.reserve
Array of Objects

A list of reserve benefits for the patient.

This type is primarily used by Medicare (HETS) to indicate lifetime reserve benefit amounts separate from annual limits. For example, Medicare Lifetime Reserve days – the limited pool of additional inpatient hospital days a patient can use after exhausting a benefit period.

Array item
additionalInformation
plans[].benefits.reserve[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.reserve[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.reserve[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.reserve[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.reserve[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.reserve[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.reserve[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.reserve[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.reserve[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.reserve[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.reserve[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.reserve[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.reserve[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.reserve[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.reserve[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.reserve[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.reserve[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.reserve[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.reserve[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.reserve[].amount
String

The monetary amount associated with this benefit.

coverageLevel
plans[].benefits.reserve[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.reserve[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.reserve[].dates.added
Object

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

Show attributes
end
plans[].benefits.reserve[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.reserve[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.reserve[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.reserve[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.reserve[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.reserve[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.reserve[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.reserve[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.reserve[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.reserve[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.reserve[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.reserve[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.reserve[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.reserve[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.reserve[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.reserve[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.reserve[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.reserve[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.reserve[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.reserve[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.reserve[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.reserve[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.reserve[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.reserve[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.reserve[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.reserve[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.reserve[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.reserve[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.reserve[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.reserve[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.reserve[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.reserve[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.reserve[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.reserve[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.reserve[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.reserve[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.reserve[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.reserve[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.reserve[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.reserve[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.reserve[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.reserve[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.reserve[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.reserve[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.reserve[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.reserve[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.reserve[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
messages
plans[].benefits.reserve[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.reserve[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.reserve[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.reserve[].network.id
String

The plan network identification number.

indicator
plans[].benefits.reserve[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
percent
plans[].benefits.reserve[].percent
String

The percentage associated with this benefit.

placesOfService
plans[].benefits.reserve[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.reserve[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.reserve[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.reserve[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.reserve[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
relatedEntities
plans[].benefits.reserve[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.reserve[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.reserve[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.reserve[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.reserve[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.reserve[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.reserve[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.reserve[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.reserve[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.reserve[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.reserve[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.reserve[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.reserve[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.reserve[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.reserve[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.reserve[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.reserve[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.reserve[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.reserve[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.reserve[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.reserve[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.reserve[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.reserve[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.reserve[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.reserve[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.reserve[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.reserve[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.reserve[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.reserve[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.reserve[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.reserve[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.reserve[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.reserve[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.reserve[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.reserve[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.reserve[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.reserve[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.reserve[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.reserve[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.reserve[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.reserve[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.reserve[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.reserve[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.reserve[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.reserve[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.reserve[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.reserve[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.reserve[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.reserve[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.reserve[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.reserve[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

secondSurgicalOpinionRequired
plans[].benefits.secondSurgicalOpinionRequired
Array of Objects

A list of benefits requiring a second surgical opinion for coverage.

Indicates the plan requires a second surgical opinion before this benefit is available. This is a precondition for obtaining the benefit.

Array item
additionalInformation
plans[].benefits.secondSurgicalOpinionRequired[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.secondSurgicalOpinionRequired[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.secondSurgicalOpinionRequired[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.secondSurgicalOpinionRequired[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.secondSurgicalOpinionRequired[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.secondSurgicalOpinionRequired[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.secondSurgicalOpinionRequired[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.secondSurgicalOpinionRequired[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.secondSurgicalOpinionRequired[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.secondSurgicalOpinionRequired[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.secondSurgicalOpinionRequired[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.secondSurgicalOpinionRequired[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.secondSurgicalOpinionRequired[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.secondSurgicalOpinionRequired[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.secondSurgicalOpinionRequired[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.secondSurgicalOpinionRequired[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.secondSurgicalOpinionRequired[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.secondSurgicalOpinionRequired[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.secondSurgicalOpinionRequired[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.secondSurgicalOpinionRequired[].amount
String

The monetary amount associated with this benefit.

coverageLevel
plans[].benefits.secondSurgicalOpinionRequired[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.secondSurgicalOpinionRequired[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.secondSurgicalOpinionRequired[].dates.added
Object

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

Show attributes
end
plans[].benefits.secondSurgicalOpinionRequired[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.secondSurgicalOpinionRequired[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.secondSurgicalOpinionRequired[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.secondSurgicalOpinionRequired[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.secondSurgicalOpinionRequired[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.secondSurgicalOpinionRequired[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.secondSurgicalOpinionRequired[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.secondSurgicalOpinionRequired[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.secondSurgicalOpinionRequired[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.secondSurgicalOpinionRequired[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.secondSurgicalOpinionRequired[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.secondSurgicalOpinionRequired[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.secondSurgicalOpinionRequired[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.secondSurgicalOpinionRequired[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.secondSurgicalOpinionRequired[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.secondSurgicalOpinionRequired[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.secondSurgicalOpinionRequired[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.secondSurgicalOpinionRequired[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.secondSurgicalOpinionRequired[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.secondSurgicalOpinionRequired[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.secondSurgicalOpinionRequired[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.secondSurgicalOpinionRequired[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.secondSurgicalOpinionRequired[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.secondSurgicalOpinionRequired[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.secondSurgicalOpinionRequired[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.secondSurgicalOpinionRequired[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.secondSurgicalOpinionRequired[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.secondSurgicalOpinionRequired[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.secondSurgicalOpinionRequired[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.secondSurgicalOpinionRequired[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.secondSurgicalOpinionRequired[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.secondSurgicalOpinionRequired[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.secondSurgicalOpinionRequired[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.secondSurgicalOpinionRequired[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.secondSurgicalOpinionRequired[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.secondSurgicalOpinionRequired[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.secondSurgicalOpinionRequired[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.secondSurgicalOpinionRequired[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.secondSurgicalOpinionRequired[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.secondSurgicalOpinionRequired[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.secondSurgicalOpinionRequired[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.secondSurgicalOpinionRequired[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.secondSurgicalOpinionRequired[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.secondSurgicalOpinionRequired[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.secondSurgicalOpinionRequired[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.secondSurgicalOpinionRequired[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.secondSurgicalOpinionRequired[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
messages
plans[].benefits.secondSurgicalOpinionRequired[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.secondSurgicalOpinionRequired[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.secondSurgicalOpinionRequired[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.secondSurgicalOpinionRequired[].network.id
String

The plan network identification number.

indicator
plans[].benefits.secondSurgicalOpinionRequired[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
percent
plans[].benefits.secondSurgicalOpinionRequired[].percent
String

The percentage associated with this benefit.

placesOfService
plans[].benefits.secondSurgicalOpinionRequired[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.secondSurgicalOpinionRequired[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.secondSurgicalOpinionRequired[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.secondSurgicalOpinionRequired[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.secondSurgicalOpinionRequired[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
relatedEntities
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.secondSurgicalOpinionRequired[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.secondSurgicalOpinionRequired[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.secondSurgicalOpinionRequired[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.secondSurgicalOpinionRequired[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.secondSurgicalOpinionRequired[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.secondSurgicalOpinionRequired[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.secondSurgicalOpinionRequired[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.secondSurgicalOpinionRequired[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.secondSurgicalOpinionRequired[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.secondSurgicalOpinionRequired[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.secondSurgicalOpinionRequired[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.secondSurgicalOpinionRequired[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.secondSurgicalOpinionRequired[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.secondSurgicalOpinionRequired[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

servicesRestrictedToFollowingProvider
plans[].benefits.servicesRestrictedToFollowingProvider
Array of Objects

A list of services restricted to specific providers.

Indicates the benefit is available only when delivered by a particular provider, identified in relatedEntities. This doesn't confirm whether that provider is in or out of network with the payer.

Array item
additionalInformation
plans[].benefits.servicesRestrictedToFollowingProvider[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.servicesRestrictedToFollowingProvider[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.servicesRestrictedToFollowingProvider[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.servicesRestrictedToFollowingProvider[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.servicesRestrictedToFollowingProvider[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.servicesRestrictedToFollowingProvider[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.servicesRestrictedToFollowingProvider[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.servicesRestrictedToFollowingProvider[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.servicesRestrictedToFollowingProvider[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.servicesRestrictedToFollowingProvider[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.servicesRestrictedToFollowingProvider[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.servicesRestrictedToFollowingProvider[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.servicesRestrictedToFollowingProvider[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.servicesRestrictedToFollowingProvider[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.servicesRestrictedToFollowingProvider[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.servicesRestrictedToFollowingProvider[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.servicesRestrictedToFollowingProvider[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.servicesRestrictedToFollowingProvider[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.servicesRestrictedToFollowingProvider[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.servicesRestrictedToFollowingProvider[].amount
String

The monetary amount associated with this benefit.

coverageLevel
plans[].benefits.servicesRestrictedToFollowingProvider[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.servicesRestrictedToFollowingProvider[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.added
Object

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

Show attributes
end
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.servicesRestrictedToFollowingProvider[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.servicesRestrictedToFollowingProvider[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.servicesRestrictedToFollowingProvider[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.servicesRestrictedToFollowingProvider[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.servicesRestrictedToFollowingProvider[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.servicesRestrictedToFollowingProvider[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.servicesRestrictedToFollowingProvider[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
messages
plans[].benefits.servicesRestrictedToFollowingProvider[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.servicesRestrictedToFollowingProvider[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.servicesRestrictedToFollowingProvider[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.servicesRestrictedToFollowingProvider[].network.id
String

The plan network identification number.

indicator
plans[].benefits.servicesRestrictedToFollowingProvider[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
percent
plans[].benefits.servicesRestrictedToFollowingProvider[].percent
String

The percentage associated with this benefit.

placesOfService
plans[].benefits.servicesRestrictedToFollowingProvider[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.servicesRestrictedToFollowingProvider[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.servicesRestrictedToFollowingProvider[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.servicesRestrictedToFollowingProvider[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.servicesRestrictedToFollowingProvider[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
relatedEntities
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.servicesRestrictedToFollowingProvider[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.servicesRestrictedToFollowingProvider[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.servicesRestrictedToFollowingProvider[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.servicesRestrictedToFollowingProvider[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.servicesRestrictedToFollowingProvider[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.servicesRestrictedToFollowingProvider[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.servicesRestrictedToFollowingProvider[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.servicesRestrictedToFollowingProvider[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.servicesRestrictedToFollowingProvider[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.servicesRestrictedToFollowingProvider[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.servicesRestrictedToFollowingProvider[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.servicesRestrictedToFollowingProvider[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.servicesRestrictedToFollowingProvider[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.servicesRestrictedToFollowingProvider[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

spendDown
plans[].benefits.spendDown
Array of Objects

A list of spend down benefit entries from the payer.

Spend down is a process that allows individuals with high medical expenses to qualify for Medicaid even if their income is above the Medicaid income limit. The amount represents the total the patient pays out-of-pocket before they can receive Medicaid benefits. The decimal precision reflects what the payer sent (for example, 1500.0 or 1500).

Array item
additionalInformation
plans[].benefits.spendDown[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.spendDown[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.spendDown[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.spendDown[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.spendDown[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.spendDown[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.spendDown[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.spendDown[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.spendDown[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.spendDown[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.spendDown[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.spendDown[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.spendDown[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.spendDown[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.spendDown[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.spendDown[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.spendDown[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.spendDown[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.spendDown[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.spendDown[].amount
StringRequired

The monetary amount for this benefit.

coverageLevel
plans[].benefits.spendDown[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.spendDown[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.spendDown[].dates.added
Object

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

Show attributes
end
plans[].benefits.spendDown[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.spendDown[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.spendDown[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.spendDown[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.spendDown[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.spendDown[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.spendDown[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.spendDown[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.spendDown[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.spendDown[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.spendDown[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.spendDown[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.spendDown[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.spendDown[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.spendDown[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.spendDown[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.spendDown[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.spendDown[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.spendDown[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.spendDown[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.spendDown[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.spendDown[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.spendDown[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.spendDown[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.spendDown[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.spendDown[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.spendDown[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.spendDown[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.spendDown[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.spendDown[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.spendDown[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.spendDown[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.spendDown[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.spendDown[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.spendDown[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.spendDown[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.spendDown[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.spendDown[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.spendDown[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.spendDown[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.spendDown[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.spendDown[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.spendDown[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.spendDown[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.spendDown[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.spendDown[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.spendDown[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
messages
plans[].benefits.spendDown[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.spendDown[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.spendDown[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.spendDown[].network.id
String

The plan network identification number.

indicator
plans[].benefits.spendDown[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
placesOfService
plans[].benefits.spendDown[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.spendDown[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.spendDown[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.spendDown[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.spendDown[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
quantity
plans[].benefits.spendDown[].quantity
Object

The quantity the amount applies to, when the payer sends one. For example, 60 days of inpatient care.

Show attributes
qualifier
plans[].benefits.spendDown[].quantity.qualifier
String

The unit of measure for value.

Payers may sometimes return other non-compliant values.

Possible values
MINIMUM
QUANTITY_USED
COVERED_ACTUAL
COVERED_ESTIMATED
NUMBER_OF_CO_INSURANCE_DAYS
value
plans[].benefits.spendDown[].quantity.value
String

The numeric quantity. For example, 10 when the qualifier is VISITS.

relatedEntities
plans[].benefits.spendDown[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.spendDown[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.spendDown[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.spendDown[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.spendDown[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.spendDown[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.spendDown[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.spendDown[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.spendDown[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.spendDown[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.spendDown[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.spendDown[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.spendDown[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.spendDown[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.spendDown[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.spendDown[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.spendDown[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.spendDown[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.spendDown[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.spendDown[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.spendDown[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.spendDown[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.spendDown[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.spendDown[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.spendDown[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.spendDown[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.spendDown[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.spendDown[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.spendDown[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.spendDown[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.spendDown[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.spendDown[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.spendDown[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.spendDown[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.spendDown[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.spendDown[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.spendDown[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.spendDown[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.spendDown[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.spendDown[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.spendDown[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.spendDown[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.spendDown[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.spendDown[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.spendDown[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.spendDown[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.spendDown[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.spendDown[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.spendDown[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.spendDown[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.spendDown[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

timePeriod
plans[].benefits.spendDown[].timePeriod
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
HOUR
DAY
24_HOURS
YEARS
SERVICE_YEAR
statuses
plans[].benefits.statuses
Array of Objects

Eligibility status benefit entries from the payer. Each entry indicates whether the patient has active or inactive coverage for a specific service, network, and coverage level.

Array item
additionalInformation
plans[].benefits.statuses[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.statuses[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.statuses[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.statuses[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.statuses[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.statuses[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.statuses[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.statuses[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.statuses[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.statuses[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.statuses[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.statuses[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.statuses[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.statuses[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.statuses[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.statuses[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.statuses[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.statuses[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.statuses[].additionalInformation.referralNumber
String

The referral number.

coverageLevel
plans[].benefits.statuses[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.statuses[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.statuses[].dates.added
Object

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

Show attributes
end
plans[].benefits.statuses[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.statuses[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.statuses[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.statuses[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.statuses[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.statuses[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.statuses[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.statuses[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.statuses[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.statuses[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.statuses[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.statuses[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.statuses[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.statuses[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.statuses[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.statuses[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.statuses[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.statuses[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.statuses[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.statuses[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.statuses[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.statuses[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.statuses[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.statuses[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.statuses[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.statuses[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.statuses[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.statuses[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.statuses[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.statuses[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.statuses[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.statuses[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.statuses[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.statuses[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.statuses[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.statuses[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.statuses[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.statuses[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.statuses[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.statuses[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.statuses[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.statuses[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.statuses[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.statuses[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.statuses[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.statuses[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.statuses[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
messages
plans[].benefits.statuses[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.statuses[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.statuses[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.statuses[].network.id
String

The plan network identification number.

indicator
plans[].benefits.statuses[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
placesOfService
plans[].benefits.statuses[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.statuses[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.statuses[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.statuses[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.statuses[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
relatedEntities
plans[].benefits.statuses[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.statuses[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.statuses[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.statuses[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.statuses[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.statuses[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.statuses[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.statuses[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.statuses[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.statuses[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.statuses[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.statuses[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.statuses[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.statuses[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.statuses[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.statuses[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.statuses[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.statuses[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.statuses[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.statuses[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.statuses[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.statuses[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.statuses[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.statuses[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.statuses[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.statuses[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.statuses[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.statuses[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.statuses[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.statuses[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.statuses[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.statuses[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.statuses[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.statuses[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.statuses[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.statuses[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.statuses[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.statuses[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.statuses[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.statuses[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.statuses[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.statuses[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.statuses[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.statuses[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.statuses[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.statuses[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.statuses[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.statuses[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.statuses[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.statuses[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.statuses[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

status
plans[].benefits.statuses[].status
StringRequired

The patient's coverage status, indicating whether their coverage is active or inactive for specific services.

Possible values
ACTIVE_COVERAGE
ACTIVE_FULL_RISK_CAPITATION
ACTIVE_SERVICES_CAPITATED
ACTIVE_SERVICES_CAPITATED_TO_PRIMARY_CARE_PROVIDER
ACTIVE_PENDING_INVESTIGATION
unlimited
plans[].benefits.unlimited
Array of Objects

A list of unlimited benefits for the patient's plan.

For example, unlimited physical therapy visits or unlimited preventive care.

Array item
additionalInformation
plans[].benefits.unlimited[].additionalInformation
Object

Additional plan, group, and policy identification numbers for this benefit entry.

Show attributes
alternativeListId
plans[].benefits.unlimited[].additionalInformation.alternativeListId
String

The alternative list ID. This identifier lets the payer point to a list of drugs and their alternatives, along with the formulary status that applies to the patient.

coverageListId
plans[].benefits.unlimited[].additionalInformation.coverageListId
String

The coverage list ID. This identifier lets the payer point to a list of drugs that have coverage limitations for the patient.

drugFormularyNumber
plans[].benefits.unlimited[].additionalInformation.drugFormularyNumber
String

The drug formulary number.

familyUnitNumber
plans[].benefits.unlimited[].additionalInformation.familyUnitNumber
String

The family unit number. Pharmacy benefits managers (PBMs) return this when the patient has a suffix to their member ID. For all other payers, the suffix is considered part of the member ID.

group
plans[].benefits.unlimited[].additionalInformation.group
Object

The group number for the patient's health insurance plan and, when the payer sends one, the group name.

Show attributes
name
plans[].benefits.unlimited[].additionalInformation.group.name
String

The name or description associated with number.

number
plans[].benefits.unlimited[].additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
plans[].benefits.unlimited[].additionalInformation.groupOrPolicyNumber
String

A group or policy number from the payer. Present when Stedi can't determine the type. Contact the payer for confirmation.

insurancePolicyNumber
plans[].benefits.unlimited[].additionalInformation.insurancePolicyNumber
String

The insurance policy number.

mbi
plans[].benefits.unlimited[].additionalInformation.mbi
String

The Medicare Beneficiary Identifier (MBI), the randomized identifier CMS uses to identify Medicare beneficiaries. If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
plans[].benefits.unlimited[].additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalAssistanceCategory
plans[].benefits.unlimited[].additionalInformation.medicalAssistanceCategory
String

The medical assistance category.

memberId
plans[].benefits.unlimited[].additionalInformation.memberId
String

The patient's member ID.

plan
plans[].benefits.unlimited[].additionalInformation.plan
Object

The insurance plan number and, when the payer sends one, the plan name.

Show attributes
name
plans[].benefits.unlimited[].additionalInformation.plan.name
String

The name or description associated with number.

number
plans[].benefits.unlimited[].additionalInformation.plan.number
StringRequired

The identification number.

priorAuthNumber
plans[].benefits.unlimited[].additionalInformation.priorAuthNumber
String

The prior authorization number.

referralNumber
plans[].benefits.unlimited[].additionalInformation.referralNumber
String

The referral number.

amount
plans[].benefits.unlimited[].amount
String

The monetary amount associated with this benefit.

coverageLevel
plans[].benefits.unlimited[].coverageLevel
StringRequired

The level of coverage this benefit applies to, such as INDIVIDUAL or FAMILY. Defaults to INDIVIDUAL when the payer doesn't send a coverage level.

Payers may sometimes return other non-compliant values.

Possible values
CHILDREN_ONLY
DEPENDENTS_ONLY
EMPLOYEE_AND_CHILDREN
EMPLOYEE_ONLY
EMPLOYEE_AND_SPOUSE
dates
plans[].benefits.unlimited[].dates
Object

Dates associated with this benefit, as ISO 8601 date ranges.

Show attributes
added
plans[].benefits.unlimited[].dates.added
Object

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

Show attributes
end
plans[].benefits.unlimited[].dates.added.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.unlimited[].dates.added.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

admission
plans[].benefits.unlimited[].dates.admission
Object

The admission date or dates.

Show attributes
end
plans[].benefits.unlimited[].dates.admission.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.unlimited[].dates.admission.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

benefit
plans[].benefits.unlimited[].dates.benefit
Object

The benefit date.

Show attributes
end
plans[].benefits.unlimited[].dates.benefit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.unlimited[].dates.benefit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

completion
plans[].benefits.unlimited[].dates.completion
Object

The completion date.

Show attributes
end
plans[].benefits.unlimited[].dates.completion.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.unlimited[].dates.completion.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

coordinationOfBenefits
plans[].benefits.unlimited[].dates.coordinationOfBenefits
Object

The coordination of benefits date.

Show attributes
end
plans[].benefits.unlimited[].dates.coordinationOfBenefits.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.unlimited[].dates.coordinationOfBenefits.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

dateOfLastUpdate
plans[].benefits.unlimited[].dates.dateOfLastUpdate
Object

The date when the plan information was last updated.

Show attributes
end
plans[].benefits.unlimited[].dates.dateOfLastUpdate.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.unlimited[].dates.dateOfLastUpdate.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

discharge
plans[].benefits.unlimited[].dates.discharge
Object

The discharge date.

Show attributes
end
plans[].benefits.unlimited[].dates.discharge.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.unlimited[].dates.discharge.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

eligibility
plans[].benefits.unlimited[].dates.eligibility
Object

Plan eligibility dates.

Show attributes
end
plans[].benefits.unlimited[].dates.eligibility.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.unlimited[].dates.eligibility.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

latestVisit
plans[].benefits.unlimited[].dates.latestVisit
Object

The latest visit or consultation date.

Show attributes
end
plans[].benefits.unlimited[].dates.latestVisit.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.unlimited[].dates.latestVisit.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

period
plans[].benefits.unlimited[].dates.period
Object

A period date range.

Show attributes
end
plans[].benefits.unlimited[].dates.period.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.unlimited[].dates.period.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

plan
plans[].benefits.unlimited[].dates.plan
Object

Plan effective dates.

Show attributes
end
plans[].benefits.unlimited[].dates.plan.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.unlimited[].dates.plan.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

primaryCareProvider
plans[].benefits.unlimited[].dates.primaryCareProvider
Object

The primary care provider date.

Show attributes
end
plans[].benefits.unlimited[].dates.primaryCareProvider.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.unlimited[].dates.primaryCareProvider.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

service
plans[].benefits.unlimited[].dates.service
Object

The service date or dates.

Show attributes
end
plans[].benefits.unlimited[].dates.service.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.unlimited[].dates.service.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

status
plans[].benefits.unlimited[].dates.status
Object

The status date.

Show attributes
end
plans[].benefits.unlimited[].dates.status.end
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The inclusive end of the range.

start
plans[].benefits.unlimited[].dates.status.start
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The start of the range, or a single point-in-time date.

diagnosis
plans[].benefits.unlimited[].diagnosis
Object

The diagnosis this benefit covers. Present when the benefit is limited to specific diagnoses from the patient's diagnosis list.

Show attributes
codeSystem
plans[].benefits.unlimited[].diagnosis.codeSystem
StringRequired

The code system for diagnosis codes. Only supports ICD-10-CM.

Possible values
ICD-10-CM
codes
plans[].benefits.unlimited[].diagnosis.codes
Array of ObjectsRequired

Diagnosis codes associated with this benefit entry.

Array item
definition
plans[].benefits.unlimited[].diagnosis.codes[].definition
String

The human-readable definition of the diagnosis code.

value
plans[].benefits.unlimited[].diagnosis.codes[].value
StringRequired

The diagnosis code value.

insuranceType
plans[].benefits.unlimited[].insuranceType
String

Code identifying the type of insurance policy.

Payers may sometimes return other non-compliant values.

Possible values
DISABILITY
MEDICARE_POINT_OF_SERVICE_POS
MULTIPLE_OPTIONS_HEALTH_PLAN
MEDICARE_SECONDARY_WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EMPLOYER_GROUP_HEALTH_PLAN
MEDICARE_SECONDARY_ENDSTAGE_RENAL_DISEASE_BENEFICIARY_IN_THE_MANDATED_COORDINATION_PERIOD_WITH_AN_EMPLOYERS_GROUP_HEALTH_PLAN
messages
plans[].benefits.unlimited[].messages
Array of Strings

Free-form messages from the payer providing additional information about this benefit entry, like prior authorization requirements, network restrictions, benefit limits, or plan details. Message content isn't standardized and varies by payer.

network
plans[].benefits.unlimited[].network
Object

Network information for a benefit, including the in-plan network indicator and plan network identification.

Show attributes
description
plans[].benefits.unlimited[].network.description
String

The plan, group, or plan network name.

id
plans[].benefits.unlimited[].network.id
String

The plan network identification number.

indicator
plans[].benefits.unlimited[].network.indicator
String

Code indicating whether the benefit is in-network or out-of-network.

Payers may sometimes return other non-compliant values.

Possible values
IN_NETWORK
OUT_OF_NETWORK
IN_AND_OUT_OF_NETWORK
percent
plans[].benefits.unlimited[].percent
String

The percentage associated with this benefit.

placesOfService
plans[].benefits.unlimited[].placesOfService
Array of Objects

The locations where providers may deliver healthcare services for this benefit. Common examples include physician offices, hospitals, and patient homes. When present, this indicates facility-specific coverage details.

Array item
code
plans[].benefits.unlimited[].placesOfService[].code
String

The place of service code identifying the type of facility.

Payers may sometimes return other non-compliant values.

Possible values
01
03
04
05
06
name
plans[].benefits.unlimited[].placesOfService[].name
String

The human-readable name of the place of service.

planCoverageDescription
plans[].benefits.unlimited[].planCoverageDescription
String

The plan coverage description from EB05. Populated when the EB05 value doesn't relate to a plan (e.g., payer used EB05 for benefit-level info rather than a plan name).

priorAuthIndicator
plans[].benefits.unlimited[].priorAuthIndicator
String

Code indicating whether the benefit is subject to prior authorization or certification.

Payers may sometimes return other non-compliant values.

Possible values
REQUIRED
NOT_REQUIRED
relatedEntities
plans[].benefits.unlimited[].relatedEntities
Array of Objects

Another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer.

Array item
address
plans[].benefits.unlimited[].relatedEntities[].address
Object

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

Show attributes
addressLine1
plans[].benefits.unlimited[].relatedEntities[].address.addressLine1
String

The first line of the address.

addressLine2
plans[].benefits.unlimited[].relatedEntities[].address.addressLine2
String

The second line of the address.

city
plans[].benefits.unlimited[].relatedEntities[].address.city
String

The city.

country
plans[].benefits.unlimited[].relatedEntities[].address.country
String

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

countrySubdivision
plans[].benefits.unlimited[].relatedEntities[].address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
plans[].benefits.unlimited[].relatedEntities[].address.postalCode
String

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

state
plans[].benefits.unlimited[].relatedEntities[].address.state
String

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

contacts
plans[].benefits.unlimited[].relatedEntities[].contacts
Array of Objects

The entity's contact information.

Array item
ediNumbers
plans[].benefits.unlimited[].relatedEntities[].contacts[].ediNumbers
Array of Strings

The contact's EDI numbers.

emails
plans[].benefits.unlimited[].relatedEntities[].contacts[].emails
Array of Strings

The contact's email addresses.

faxNumbers
plans[].benefits.unlimited[].relatedEntities[].contacts[].faxNumbers
Array of Strings

The contact's fax numbers.

name
plans[].benefits.unlimited[].relatedEntities[].contacts[].name
String

The name of the contact person.

phoneNumbers
plans[].benefits.unlimited[].relatedEntities[].contacts[].phoneNumbers
Array of Strings

The contact's phone numbers.

urls
plans[].benefits.unlimited[].relatedEntities[].contacts[].urls
Array of Strings

The contact's URLs.

ein
plans[].benefits.unlimited[].relatedEntities[].ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

etin
plans[].benefits.unlimited[].relatedEntities[].etin
String

Electronic Transmitter Identification Number.

facilityId
plans[].benefits.unlimited[].relatedEntities[].facilityId
String

Facility Identification.

memberId
plans[].benefits.unlimited[].relatedEntities[].memberId
String

Member Identification Number

naicId
plans[].benefits.unlimited[].relatedEntities[].naicId
String

National Association of Insurance Commissioners Identification

name
plans[].benefits.unlimited[].relatedEntities[].name
Object

The entity's name, as either a person or an organization.

2 variants:
person
plans[].benefits.unlimited[].relatedEntities[].name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
plans[].benefits.unlimited[].relatedEntities[].name.person.firstName
String

The person's first name.

lastName
plans[].benefits.unlimited[].relatedEntities[].name.person.lastName
String

The person's last name.

middleName
plans[].benefits.unlimited[].relatedEntities[].name.person.middleName
String

The person's middle name or initial.

suffix
plans[].benefits.unlimited[].relatedEntities[].name.person.suffix
String

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

npi
plans[].benefits.unlimited[].relatedEntities[].npi
String

Centers for Medicare and Medicaid Services National Provider Identifier

payerId
plans[].benefits.unlimited[].relatedEntities[].payerId
String

Payer Identification

pharmacyProcessorNumber
plans[].benefits.unlimited[].relatedEntities[].pharmacyProcessorNumber
String

Pharmacy Processor Number

provider
plans[].benefits.unlimited[].relatedEntities[].provider
Object

Information about a provider associated with the related entity.

Show attributes
code
plans[].benefits.unlimited[].relatedEntities[].provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
plans[].benefits.unlimited[].relatedEntities[].provider.reference
String

The provider's taxonomy code.

relationship
plans[].benefits.unlimited[].relatedEntities[].relationship
String

Code specifying the relationship between the entity and the patient.

Payers may sometimes return other non-compliant values.

Possible values
PARENT
CHILD
DOMESTIC_PARTNER
SPOUSE
EMPLOYEE
serviceProviderNumber
plans[].benefits.unlimited[].relatedEntities[].serviceProviderNumber
String

Service Provider Number

ssn
plans[].benefits.unlimited[].relatedEntities[].ssn
String

Social Security Number.

tin
plans[].benefits.unlimited[].relatedEntities[].tin
String

The Federal Taxpayer Identification Number.

type
plans[].benefits.unlimited[].relatedEntities[].type
StringRequired

The entity identifier code for the benefit related entity.

Payers may sometimes return other non-compliant values.

Possible values
CONTRACTED_SERVICE_PROVIDER
PREFERRED_PROVIDER_ORGANIZATION
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
service
plans[].benefits.unlimited[].service
Object

The service or procedure that this benefit applies to, using a code or code range within a code system like CPT, HCPCS, or NDC.

Show attributes
definition
plans[].benefits.unlimited[].service.definition
String

The human-readable definition of the code.

range
plans[].benefits.unlimited[].service.range
Object

A range of service or procedure codes, defined by start and end codes. For example, CPT codes 99201 through 99215.

Show attributes
end
plans[].benefits.unlimited[].service.range.end
ObjectRequired

The last code in the range. The range is inclusive of this code.

Show attributes
definition
plans[].benefits.unlimited[].service.range.end.definition
String

The human-readable definition of the code.

value
plans[].benefits.unlimited[].service.range.end.value
StringRequired

The service or procedure code value.

start
plans[].benefits.unlimited[].service.range.start
ObjectRequired

The first code in the range.

Show attributes
definition
plans[].benefits.unlimited[].service.range.start.definition
String

The human-readable definition of the code.

value
plans[].benefits.unlimited[].service.range.start.value
StringRequired

The service or procedure code value.

system
plans[].benefits.unlimited[].service.system
String

The code system that the value belongs to, such as CPT, HCPCS, or STC.

Payers may sometimes return other non-compliant values.

Possible values
STC
CDT
CPT
NDC
HCPCS
value
plans[].benefits.unlimited[].service.value
String

The service or procedure code value.

serviceLimits
plans[].benefits.unlimited[].serviceLimits
Array of Items

Service delivery limits for this benefit, like visit frequency restrictions, age boundaries, or delivery schedules.

Array item
3 variants:
ageMaximum
plans[].benefits.unlimited[].serviceLimits[].ageMaximum
IntegerRequired

The maximum patient age (in years) for this benefit.

name
plans[].name
String

The name of the plan. Stedi derives this from the plan names the payer sends in the benefit entries. This property is present when the payer sends consistent plan names, and absent when the data is missing, ambiguous, or contradictory. When absent, check each benefit's planCoverageDescription for the plan information.

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
additionalInformation
provider.additionalInformation
Object

Additional identifying information for the provider.

Show attributes
contractNumber
provider.additionalInformation.contractNumber
String

The provider's contract number.

electronicDevicePin
provider.additionalInformation.electronicDevicePin
String

The provider's electronic device PIN.

facilityIdNumber
provider.additionalInformation.facilityIdNumber
String

The ID number for the provider's facility.

facilityNetworkId
provider.additionalInformation.facilityNetworkId
String

The provider's facility network identification number.

medicaidProviderNumber
provider.additionalInformation.medicaidProviderNumber
String

The provider's Medicaid provider number.

medicareProviderNumber
provider.additionalInformation.medicareProviderNumber
String

The provider's Medicare provider number.

personalIdentificationNumber
provider.additionalInformation.personalIdentificationNumber
String

The provider's personal identification number.

planNetworkId
provider.additionalInformation.planNetworkId
String

The provider's plan network identification number.

priorIdentifierNumber
provider.additionalInformation.priorIdentifierNumber
String

The provider's prior identifier number.

stateLicense
provider.additionalInformation.stateLicense
Object

The provider's state license information.

Show attributes
number
provider.additionalInformation.stateLicense.number
StringRequired

The provider's state license number.

state
provider.additionalInformation.stateLicense.state
String

The state or province code that issued the license.

submitterId
provider.additionalInformation.submitterId
String

The provider's submitter ID.

userId
provider.additionalInformation.userId
String

The provider's user ID.

address
provider.address
Object

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

Show attributes
addressLine1
provider.address.addressLine1
String

The first line of the address.

addressLine2
provider.address.addressLine2
String

The second line of the address.

city
provider.address.city
String

The city.

country
provider.address.country
String

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

countrySubdivision
provider.address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
provider.address.postalCode
String

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.

ein
provider.ein
String

The Employer Identification Number (EIN), distinct from the Federal Taxpayer Identification Number in tin.

name
provider.name
Object

The entity's name, as either a person or an organization.

2 variants:
person
provider.name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
provider.name.person.firstName
String

The person's first name.

lastName
provider.name.person.lastName
String

The person's last name.

middleName
provider.name.person.middleName
String

The person's middle name or initial.

suffix
provider.name.person.suffix
String

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

npi
provider.npi
String
pharmacyProcessorNumber
provider.pharmacyProcessorNumber
String

The pharmacy processor number.

provider
provider.provider
Object

Information about the provider's role and taxonomy.

Show attributes
code
provider.provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
provider.provider.reference
String

The provider's taxonomy code.

serviceProviderNumber
provider.serviceProviderNumber
String

The service provider number. This is an identification number the payer assigns.

ssn
provider.ssn
String

The Social Security Number (SSN).

tin
provider.tin
String

The Federal Taxpayer Identification Number.

type
provider.type
StringRequired

A code identifying the type of provider.

Payers may sometimes return other non-compliant values.

Possible values
PROVIDER
THIRD_PARTY_ADMINISTRATOR
EMPLOYER
HOSPITAL
FACILITY

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
additionalInformation
subscriber.additionalInformation
Object

Additional identifying information for the subscriber.

Show attributes
agencyClaimNumber
subscriber.additionalInformation.agencyClaimNumber
String

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

caseNumber
subscriber.additionalInformation.caseNumber
String

The case number associated with the subscriber.

classOfContractCode
subscriber.additionalInformation.classOfContractCode
String

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

contractNumber
subscriber.additionalInformation.contractNumber
String

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

familyUnitNumber
subscriber.additionalInformation.familyUnitNumber
String

The family unit number.

group
subscriber.additionalInformation.group
Object

The group number and group description.

Show attributes
name
subscriber.additionalInformation.group.name
String

The name or description associated with number.

number
subscriber.additionalInformation.group.number
StringRequired

The identification number.

groupOrPolicyNumber
subscriber.additionalInformation.groupOrPolicyNumber
String

The group or policy number.

identificationCardSerialNumber
subscriber.additionalInformation.identificationCardSerialNumber
String

Used when the identification card has a number in addition to the member ID.

identityCardNumber
subscriber.additionalInformation.identityCardNumber
String

The identity card number. Present when this number differs from the member ID.

insurancePolicyNumber
subscriber.additionalInformation.insurancePolicyNumber
String

The insurance policy number.

issueNumber
subscriber.additionalInformation.issueNumber
String

The issue number.

mbi
subscriber.additionalInformation.mbi
String

The patient's Medicare Beneficiary Identifier (MBI). If you receive an MBI, we recommend sending a follow-up eligibility check to CMS (payer ID: CMS) for additional benefits data. Visit Medicare Beneficiary Identifier documentation for more information about the MBI format. This most commonly occurs with patients who are covered by both Medicare and Medicaid.

medicaidRecipientId
subscriber.additionalInformation.medicaidRecipientId
String

The Medicaid recipient identification number.

medicalRecordId
subscriber.additionalInformation.medicalRecordId
String

The medical record identification number.

memberId
subscriber.additionalInformation.memberId
String

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

patientAccountNumber
subscriber.additionalInformation.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.

plan
subscriber.additionalInformation.plan
Object

The plan number and plan description.

Show attributes
name
subscriber.additionalInformation.plan.name
String

The name or description associated with number.

number
subscriber.additionalInformation.plan.number
StringRequired

The identification number.

planNetwork
subscriber.additionalInformation.planNetwork
Object

The plan network identification number and the plan, group, or plan network name.

Show attributes
name
subscriber.additionalInformation.planNetwork.name
String

The name or description associated with number.

number
subscriber.additionalInformation.planNetwork.number
StringRequired

The identification number.

priorIdentifierNumber
subscriber.additionalInformation.priorIdentifierNumber
String

The prior identifier number.

ssn
subscriber.additionalInformation.ssn
String

The patient's Social Security Number (SSN).

address
subscriber.address
Object

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

Show attributes
addressLine1
subscriber.address.addressLine1
String

The first line of the address.

addressLine2
subscriber.address.addressLine2
String

The second line of the address.

city
subscriber.address.city
String

The city.

country
subscriber.address.country
String

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

countrySubdivision
subscriber.address.countrySubdivision
String

The country subdivision code from Part 2 of ISO 3166.

postalCode
subscriber.address.postalCode
String

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.

birthSequenceNumber
subscriber.birthSequenceNumber
Integer

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 patient's date of birth as an ISO 8601 YYYY-MM-DD string. For example, 1985-03-15 represents March 15, 1985.

dates
subscriber.dates
Object

Dates associated with patient attributes, as ISO 8601 date ranges.

Show attributes
added
subscriber.dates.added
Object

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

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

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

admission
subscriber.dates.admission
Object

The admission date or dates.

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

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

certification
subscriber.dates.certification
Object

The certification date.

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

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

cobra
subscriber.dates.cobra
Object

Consolidated Omnibus Budget Reconciliation Act (COBRA) date.

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

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

dateOfDeath
subscriber.dates.dateOfDeath
Object

The date of death.

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

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

dateOfLastUpdate
subscriber.dates.dateOfLastUpdate
Object

The date when the patient information was last updated.

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

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

discharge
subscriber.dates.discharge
Object

The discharge date.

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

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

effectiveDateOfChange
subscriber.dates.effectiveDateOfChange
Object

The effective date of change.

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

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

eligibility
subscriber.dates.eligibility
Object

Plan eligibility dates.

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

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

enrollment
subscriber.dates.enrollment
Object

The enrollment date.

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

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

issue
subscriber.dates.issue
Object

The issue date.

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

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

plan
subscriber.dates.plan
Object

Plan effective dates.

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

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

policy
subscriber.dates.policy
Object

The policy date.

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

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

premiumPaidToDate
subscriber.dates.premiumPaidToDate
Object

Premium paid to date.

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

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

service
subscriber.dates.service
Object

The service date or dates.

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

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

status
subscriber.dates.status
Object

The status date.

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

The inclusive end of the range.

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

The start of the range, or a single point-in-time date.

gender
subscriber.gender
String

Code indicating the patient's gender.

Payers may sometimes return other non-compliant values.

Possible values
FEMALE
MALE
UNKNOWN
maintenance
subscriber.maintenance
Object

Maintenance information indicating whether the payer signaled that the patient's identifying information differs from what you submitted.

Show attributes
indicator
subscriber.maintenance.indicator
String

Whether the payer signaled that the patient's identifying information differs from what you submitted.

Possible values
NONE
PAYER_INDICATED
memberId
subscriber.memberId
String

The member ID for the insurance policy.

name
subscriber.name
Object

The entity's name, as either a person or an organization.

2 variants:
person
subscriber.name.person
ObjectRequired

A person's name. Maps to elements NM103 through NM107.

Show attributes
firstName
subscriber.name.person.firstName
String

The person's first name.

lastName
subscriber.name.person.lastName
String

The person's last name.

middleName
subscriber.name.person.middleName
String

The person's middle name or initial.

suffix
subscriber.name.person.suffix
String

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

provider
subscriber.provider
Object

Information about a provider associated with this entity.

Show attributes
code
subscriber.provider.code
String

A code that communicates the entity'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
ADMITTING
ATTENDING
BILLING
CONSULTING
COVERING
reference
subscriber.provider.reference
String

The provider's taxonomy code.

warnings
Array of Objects

Issues with your eligibility request that could affect the results, or information about the response. For example, warnings can help explain why the request was rejected.

Array item
code
warnings[].code
String

The warning code.

description
warnings[].description
String

The warning description.

x12
StringRequired

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 this property contains a 999, many of the other response properties will be empty, as Stedi populates them with information from the 271.