Insurance Discovery Check

Submit an insurance discovery check in JSON format

POST/insurance-discovery/check/v1

Insurance discovery checks search for a patient's active coverage using only their demographic data.

  1. Call this endpoint with as much patient demographic information as possible.
  2. Stedi searches for active coverage for the patient.
  3. The endpoint returns an array of potential active coverages along with subscriber details and benefits information.

We recommend using insurance discovery checks as a backup when eligibility checks fail or aren't possible. Because of their limitations, you shouldn't rely on them as your primary method for verifying patient coverage.

Visit Insurance discovery checks for a full how-to guide.

Authorizationstringrequiredheader

A Stedi API Key for authentication.

Body

application/json
providerobjectrequired

Information about the provider requesting the insurance discovery check.

Show Attributes
provider.npistringrequired

The provider's National Provider Identifier (NPI).

  • Pattern: ^[12].*$
  • Required string length: 10 - 15
subscriberobjectrequired

Demographic information for the patient when they are the health plan subscriber. We strongly recommend providing as much information as possible to improve the probability of finding matching coverage.

We especially recommend providing the subscriber's Social Security Number and their address - particularly their zip code.

Show Attributes
subscriber.firstNamestringrequired

The subscriber's first name.

  • Required string length: 1 - 25
subscriber.lastNamestringrequired

The subscriber's last name.

  • Required string length: 1 - 25

The subscriber's middle name or initial.

  • Required string length: 1 - 25

The subscriber's date of birth (DOB), formatted as YYYYMMDD.

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

The subscriber's Social Security Number (SSN). We strongly recommend providing this information if possible to improve the probability of finding matching coverage. The patient's full SSN is preferred, but even the last 4 digits of the SSN can help narrow down matching coverage.

  • Pattern: ^(?:\d{9}|\d{3}-\d{2}-\d{4}|\d{4})$

The subscriber's gender. This can be set to either M - Male or F - Female.

Possible values
M
F

The subscriber's current or previous address. We strongly recommend providing this information if possible to improve the probability of finding matching coverage.

We especially recommend providing the patient’s ZIP code, as this helps narrow down the list of probable payers. Zip code search isn’t an exact match, so even the first 3-4 digits of the patient’s current zip code can help improve the results. If the patient’s current address isn’t available, you can try a full or partial zip code from one of the patient’s previous addresses or even one in close proximity.

Show Attributes

The first line of the address.

  • Required string length: 1 - 55

The second line of the address.

  • Required string length: 1 - 55

The city.

  • Required string length: 2 - 30

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

Payers may sometimes return other non-compliant values.

Possible values
NL
PE
NS
NB
QC

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

  • Required string length: 5 - 9

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

  • Required string length: 2

The country subdivision code from Part 2 of ISO 3166.

  • Required string length: 1 - 3
dependentobject

Demographic information for the patient when they are a dependent on a health plan.

  • We strongly recommend providing as much information as possible to improve the probability of finding matching coverage. We especially recommend providing the dependent's Social Security Number and their address - particularly their zip code.
  • You should provide information for both the subscriber and the dependent in the request when possible.
  • If you only have the dependent's information, you should identify them in the subscriber object instead and leave this object empty. Note that some payers require information about both the dependent and the subscriber, so providing only the dependent's information limits Stedi's ability to return coverage matches for those payers.
Show Attributes
dependent.firstNamestringrequired

The dependent's first name.

  • Required string length: 1 - 25
dependent.lastNamestringrequired

The dependent's last name.

  • Required string length: 1 - 25

The dependent's middle name or initial.

  • Required string length: 1 - 25

The dependent's date of birth (DOB), formatted as YYYYMMDD.

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

The dependent's Social Security Number (SSN). We strongly recommend providing this information if possible to improve the probability of finding matching coverage.

  • Pattern: ^(?:\d{9}|\d{3}-\d{2}-\d{4}|\d{4})$

The dependent's gender. This can be set to either M - Male or F - Female.

Possible values
M
F

The dependent's address. We strongly recommend providing this information if possible to improve the probability of finding matching coverage.

We especially recommend providing the patient’s ZIP code, as this helps narrow down the list of probable payers. Zip code search isn’t an exact match, so even the first 3-4 digits of the patient’s current zip code can help improve the results. If the patient’s current address isn’t available, you can try a full or partial zip code from one of the patient’s previous addresses or even one in close proximity.

Show Attributes

The first line of the address.

  • Required string length: 1 - 55

The second line of the address.

  • Required string length: 1 - 55

The city.

  • Required string length: 2 - 30

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

Payers may sometimes return other non-compliant values.

Possible values
NL
PE
NS
NB
QC

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

  • Required string length: 5 - 9

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

  • Required string length: 2

The country subdivision code from Part 2 of ISO 3166.

  • Required string length: 1 - 3
encounterobject

The date range for the service being requested. If you don't specify a service date (either a single day or a range of dates), Stedi defaults to the current date.

You can specify either a single dateOfService or a beginningDateOfService and endDateOfService.

Show Attributes

The beginning date, formatted as YYYYMMDD.

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

The end date, formatted as YYYYMMDD. If you don't specify an end date, Stedi defaults to the same date as beginningDateOfService.

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

The date of service, formatted as YYYYMMDD. You can use this value to specify a single occasion. If you don't specify a service date (either a single day or a range of dates), Stedi defaults to the current date.

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

Response

application/json

InsuranceDiscoveryCheck 200 response

metaobject

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

Show Attributes

The type of data in the request. This is always production.

Payers may sometimes return other non-compliant values.

Possible values
production
test
information

The unique ID Stedi assigns to this request.

A unique ID for this insurance discovery check. You can use it to retrieve the results asynchronously through the Insurance Discovery Check Results endpoint.

statusstring

The status of the discovery check. This is either PENDING or COMPLETE. - If the status is COMPLETE, the items array will contain any potential coverage matches Stedi found for the patient. - If the status is PENDING, the check is still in progress. You can immediately begin polling the Insurance Discovery Check Results endpoint to retrieve the results asynchronously.

Possible values
PENDING
COMPLETE
itemsarray<object>

An array of potential coverage matches for the patient. This will only be populated if the insurance discovery check status is COMPLETE. Each item in the array contains information about a potential match, including the provider, subscriber, payer, and plan information.

Array Item

Information about the provider who requested the insurance discovery check.

Show Attributes

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

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

The provider's organization name.

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

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

A code identifying the type of provider.

Payers may sometimes return other non-compliant values.

Possible values
Provider
Third-Party Administrator
Employer
Hospital
Facility

The type of entity.

Payers may sometimes return other non-compliant values.

Possible values
Person
Non-Person Entity

The provider's National Provider Identifier (NPI).

  • Pattern: ^\d{10}$

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

Payers may sometimes return other non-compliant values.

Possible values
AD
AT
BI
CO
CV

The Health Care Provider Taxonomy Code.

The Social Security Number (SSN).

  • Pattern: ^\d{9}$

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

  • Pattern: ^\d{9}$

The Payor Identification.

The pharmacy processor number.

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

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

The provider's contact information.

Show Attributes

The first line of the address.

  • Required string length: 1 - 55

The second line of the address.

  • Required string length: 1 - 55

The city.

  • Required string length: 2 - 30

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

Payers may sometimes return other non-compliant values.

Possible values
NL
PE
NS
NB
QC

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

  • Required string length: 5 - 9

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

  • Required string length: 2

The country subdivision code from Part 2 of ISO 3166.

  • Required string length: 1 - 3

Information about the subscriber for this coverage. You should always review this information to ensure that the coverage Stedi found is a match for the patient.

Show Attributes

Information about the patient's healthcare diagnosis.

Array Item

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

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

The member ID for the insurance policy.

The member's first name.

The member's last name.

The member's middle name or initial.

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

Code indicating the patient's gender.

Possible values
M
F
U

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

Payers may sometimes return other non-compliant values.

Possible values
Person
Non-Person Entity

The member's unique health identifier.

The member's date of birth.

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

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

Payers may sometimes return other non-compliant values.

Possible values
A
C
L
O
P

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

Payers may sometimes return other non-compliant values.

Possible values
AE
AO
AS
AT
AU

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

Payers may sometimes return other non-compliant values.

Possible values
A
B
C
D
E

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

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

Payers may sometimes return other non-compliant values.

Possible values
A1
A2
A3
B1
B2

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

Payers may sometimes return other non-compliant values.

Possible values
D8
RD8

The military service date.

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

The military service start date.

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

The military service end date.

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

The member's Social Security Number (SSN).

  • Pattern: ^\d{9}$

The group number associated with the insurance policy.

The plan number associated with the insurance policy.

The network identification number associated with the insurance policy.

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

Payers may sometimes return other non-compliant values.

Possible values
001

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

Payers may sometimes return other non-compliant values.

Possible values
25

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

Show Attributes

The first line of the address.

  • Required string length: 1 - 55

The second line of the address.

  • Required string length: 1 - 55

The city.

  • Required string length: 2 - 30

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

Payers may sometimes return other non-compliant values.

Possible values
NL
PE
NS
NB
QC

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

  • Required string length: 5 - 9

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

  • Required string length: 2

The country subdivision code from Part 2 of ISO 3166.

  • Required string length: 1 - 3

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

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

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

The provider's organization name.

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

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

A code identifying the type of provider.

Payers may sometimes return other non-compliant values.

Possible values
Provider
Third-Party Administrator
Employer
Hospital
Facility

The type of entity.

Payers may sometimes return other non-compliant values.

Possible values
Person
Non-Person Entity

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

Payers may sometimes return other non-compliant values.

Possible values
AD
AT
BI
CO
CV

The Health Care Provider Taxonomy Code.

The Social Security Number (SSN).

  • Pattern: ^\d{9}$

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

  • Pattern: ^\d{9}$

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

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

The provider's contact information.

Show Attributes

The first line of the address.

  • Required string length: 1 - 55

The second line of the address.

  • Required string length: 1 - 55

The city.

  • Required string length: 2 - 30

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

Payers may sometimes return other non-compliant values.

Possible values
NL
PE
NS
NB
QC

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

  • Required string length: 5 - 9

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

  • Required string length: 2

The country subdivision code from Part 2 of ISO 3166.

  • Required string length: 1 - 3

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

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

Array Item

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

Information to help you correct the error.

The error code.

Payers may sometimes return other non-compliant values.

Possible values
15
41
43
44
45

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

Payers may sometimes return other non-compliant values.

Possible values
Please Correct and Resubmit
Resubmission Not Allowed
Resubmission Allowed
Do Not Resubmit; Inquiry Initiated to a Third Party
Please Wait 30 Days and Resubmit

The entity identifier for the subscriber.

Possible values
Insured or Subscriber

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

Possible values
Self

For the subscriber, this is always 18 for Self.

Possible values
18

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

Possible values
Y

Information about the dependent for this coverage. You should always review this information to ensure that the coverage Stedi found is a match for the patient.

Show Attributes

Information about the patient's healthcare diagnosis.

Array Item

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

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

The member ID for the insurance policy.

The member's first name.

The member's last name.

The member's middle name or initial.

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

Code indicating the patient's gender.

Possible values
M
F
U

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

Payers may sometimes return other non-compliant values.

Possible values
Person
Non-Person Entity

The member's unique health identifier.

The member's date of birth.

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

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

Payers may sometimes return other non-compliant values.

Possible values
A
C
L
O
P

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

Payers may sometimes return other non-compliant values.

Possible values
AE
AO
AS
AT
AU

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

Payers may sometimes return other non-compliant values.

Possible values
A
B
C
D
E

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

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

Payers may sometimes return other non-compliant values.

Possible values
A1
A2
A3
B1
B2

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

Payers may sometimes return other non-compliant values.

Possible values
D8
RD8

The military service date.

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

The military service start date.

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

The military service end date.

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

The member's Social Security Number (SSN).

  • Pattern: ^\d{9}$

The group number associated with the insurance policy.

The plan number associated with the insurance policy.

The network identification number associated with the insurance policy.

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

Payers may sometimes return other non-compliant values.

Possible values
001

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

Payers may sometimes return other non-compliant values.

Possible values
25

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

Show Attributes

The first line of the address.

  • Required string length: 1 - 55

The second line of the address.

  • Required string length: 1 - 55

The city.

  • Required string length: 2 - 30

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

Payers may sometimes return other non-compliant values.

Possible values
NL
PE
NS
NB
QC

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

  • Required string length: 5 - 9

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

  • Required string length: 2

The country subdivision code from Part 2 of ISO 3166.

  • Required string length: 1 - 3

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

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

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

The provider's organization name.

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

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

A code identifying the type of provider.

Payers may sometimes return other non-compliant values.

Possible values
Provider
Third-Party Administrator
Employer
Hospital
Facility

The type of entity.

Payers may sometimes return other non-compliant values.

Possible values
Person
Non-Person Entity

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

Payers may sometimes return other non-compliant values.

Possible values
AD
AT
BI
CO
CV

The Health Care Provider Taxonomy Code.

The Social Security Number (SSN).

  • Pattern: ^\d{9}$

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

  • Pattern: ^\d{9}$

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

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

The provider's contact information.

Show Attributes

The first line of the address.

  • Required string length: 1 - 55

The second line of the address.

  • Required string length: 1 - 55

The city.

  • Required string length: 2 - 30

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

Payers may sometimes return other non-compliant values.

Possible values
NL
PE
NS
NB
QC

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

  • Required string length: 5 - 9

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

  • Required string length: 2

The country subdivision code from Part 2 of ISO 3166.

  • Required string length: 1 - 3

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

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

Array Item

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

Information to help you correct the error.

The error code.

Payers may sometimes return other non-compliant values.

Possible values
15
41
43
44
45

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

Payers may sometimes return other non-compliant values.

Possible values
Please Correct and Resubmit
Resubmission Not Allowed
Resubmission Allowed
Do Not Resubmit; Inquiry Initiated to a Third Party
Please Wait 30 Days and Resubmit

The entity identifier for the dependent.

Possible values
Dependent

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

Possible values
Spouse
Child
Employee
Unknown
Organ Donor

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

Possible values
01
19
20
21
39

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

Possible values
N

Information about the payer for this coverage. Note that payer names and IDs aren't normalized, so you'll need to handle matching these results to Stedi's Payer Network or your own internal payer list.

Show Attributes

The entity identifier code for the payer.

Payers may sometimes return other non-compliant values.

Possible values
Third-Party Administrator
Employer
Gateway Provider
Plan Sponsor
Payer

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

Payers may sometimes return other non-compliant values.

Possible values
Person
Non-Person Entity

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

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

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

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

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

The payer's federal taxpayer's identification number.

  • Pattern: ^\d{9}$

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

The payer's National Provider Identifier (NPI).

  • Pattern: ^\d{10}$

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

The payor identification.

The payer's contact information.

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

Show Attributes

The name of the contact person.

The contact information.

Array Item

The type of communication number provided.

Payers may sometimes return other non-compliant values.

Possible values
Electronic Data Interchange Access Number
Electronic Mail
Facsimile
Telephone
Uniform Resource Locator (URL)

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

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

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

Additional identification for the patient's health plan.

Show Attributes

The state license number

The Medicare provider number

The Medicaid provider number

The facility ID number

The personal identification number (PIN)

The plan description

The group or policy number

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

The family unit number

The group description

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

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

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

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

The medical record identification number

The electronic device pin number

The submitter identification number

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

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

The drug formulary number

The prior authorization number

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

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

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

  • Pattern: ^\d{10}$

The insurance policy number

The user identification

The medical assistance category

The eligibility category

The plan network identification number

The plan, group, or plan network name

The facility network identification number

The Medicaid recipient identification number

The prior identifier number

The social security number

The federal taxpayer's identification number

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

Contains the dates associated with coverage for this health plan. This information can help you determine the patient's eligibility for benefits. - All dates are formatted as YYYYMMDD (for single dates) or as YYYYMMDD-YYYYMMDD (for date ranges). - Properties contain a single date unless otherwise noted. - Most payers return either plan or planBegin and planEnd, but the exact dates returned depend on the payer's discretion and the specific health plan. - If the date of service is after the earliest ending plan, eligibility, planEnd, eligibilityEnd, policyEffective, or policyExpiration value, the patient likely doesn't have active coverage.

Show Attributes

The discharge date.

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

The issue date.

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

The effective date of change.

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

Plan effective dates.

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

Plan eligibility dates.

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

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

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

The date when COBRA coverage begins.

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

The date when COBRA coverage ends.

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

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

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

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

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

The date coverage from the plan begins.

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

The date coverage from the plan ends.

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

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

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

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

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

The date when the patient is enrolled in the plan.

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

The admission date or dates.

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

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

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

The certification date.

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

The service date or dates.

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

The date when the policy becomes effective.

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

The date when the policy expires.

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

The date when the plan information was last updated.

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

The status date.

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

Information about the patient's healthcare benefits, such as coverage level (individual vs. family), coverage type (deductibles, copays, etc.), out of pocket maximums, and more. This is the same information you would get from a standard eligibility check.

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

Visit Determine patient benefits in our eligibility check documentation for more information about benefit types, details about how to interpret the response, and additional examples.

Array Item

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

Payers may sometimes return other non-compliant values.

Possible values
1
2
3
4
5

The full name of the benefits information code.

Payers may sometimes return other non-compliant values.

Possible values
Active Coverage
Active - Full Risk Capitation
Active - Services Capitated
Active - Services Capitated to Primary Care Physician
Active - Pending Investigation

Code indicating the level of coverage for the patient.

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

Payers may sometimes return other non-compliant values.

Possible values
CHD
DEP
ECH
EMP
ESP

The full name of the coverage level code.

Payers may sometimes return other non-compliant values.

Possible values
Children Only
Dependents Only
Employee and Children
Employee Only
Employee and Spouse

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

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

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

Payers may sometimes return other non-compliant values.

Possible values
12
13
14
15
16

The full name of the insurance type code.

Payers may sometimes return other non-compliant values.

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

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

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

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

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

Payers may sometimes return other non-compliant values.

Possible values
6
7
13
21
22

The name of the timeQualifierCode.

Payers may sometimes return other non-compliant values.

Possible values
Hour
Day
24 Hours
Years
Service Year

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

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

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

Learn more about patient costs.

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

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

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

Learn more about patient costs.

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

Payers may sometimes return other non-compliant values.

Possible values
8H
99
CA
CE
D3

The name of the quantityQualifierCode.

Payers may sometimes return other non-compliant values.

Possible values
Minimum
Quantity Used
Covered - Actual
Covered - Estimated
Number of Co-insurance Days

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

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

Payers may sometimes return other non-compliant values.

Possible values
N
U
Y

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

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

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

Payers may sometimes return other non-compliant values.

Possible values
Y
N
U
W

The name of the in-plan network indicator code.

Payers may sometimes return other non-compliant values.

Possible values
Yes
No
Unknown
Not Applicable

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

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

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

Show Attributes

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

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

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

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

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

Identifying information specific to this type of benefit.

Show Attributes

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

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

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

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

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

The delivery or usage pattern for the benefits.

Array Item

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

Payers may sometimes return other non-compliant values.

Possible values
DY
FL
HS
MN
VS

The name of the quantityQualifierCode. For example, Days.

Payers may sometimes return other non-compliant values.

Possible values
Days
Units
Hours
Month
Visits

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

Possible values
Days
Months
Visits
Week
Years

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

Payers may sometimes return other non-compliant values.

Possible values
DA
MO
VS
WK
YR

The name of the unitForMeasurementQualifierCode. For example, Days.

Payers may sometimes return other non-compliant values.

Possible values
Days
Months
Visits
Week
Years

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

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

Payers may sometimes return other non-compliant values.

Possible values
6
7
21
22
23

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

Payers may sometimes return other non-compliant values.

Possible values
Hour
Day
Years
Service Year
Calendar Year

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

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

Payers may sometimes return other non-compliant values.

Possible values
1st Week of the Month
2nd Week of the Month
3rd Week of the Month
4th Week of the Month
5th Week of the Month

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

Payers may sometimes return other non-compliant values.

Possible values
1
2
3
4
5

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

Payers may sometimes return other non-compliant values.

Possible values
1st Week of the Month
2nd Week of the Month
3rd Week of the Month
4th Week of the Month
5th Week of the Month

The name of the deliveryPatternTimeCode.

Payers may sometimes return other non-compliant values.

Possible values
1st Shift (Normal Working Hours)
2nd Shift
3rd Shift
A.M.
P.M.

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

Payers may sometimes return other non-compliant values.

Possible values
A
B
C
D
E

The name of the deliveryPatternTimeCode.

Payers may sometimes return other non-compliant values.

Possible values
1st Shift (Normal Working Hours)
2nd Shift
3rd Shift
A.M.
P.M.

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

Array Item

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

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

Array Item

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

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

Payers may sometimes return other non-compliant values.

Possible values
GR
NI
ZZ

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

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

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

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

Payers may sometimes return other non-compliant values.

Possible values
44

All other entities associated with the eligibility or benefits.

Array Item

Code identifying an organizational entity, a physical location, property or an individual.

Payers may sometimes return other non-compliant values.

Possible values
Contracted Service Provider
Preferred Provider Organization (PPO)
Provider
Third-Party Administrator
Employer

The type of entity.

Payers may sometimes return other non-compliant values.

Possible values
Person
Non-Person Entity

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

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

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

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

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

Payers may sometimes return other non-compliant values.

Possible values
24
34
46
FA
FI

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

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

Payers may sometimes return other non-compliant values.

Possible values
01
02
27
41
48
Show Attributes

The first line of the address.

  • Required string length: 1 - 55

The second line of the address.

  • Required string length: 1 - 55

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

Payers may sometimes return other non-compliant values.

Possible values
NL
PE
NS
NB
QC

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

  • Required string length: 5 - 9

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

  • Required string length: 2

The country subdivision code from Part 2 of ISO 3166.

  • Required string length: 1 - 3
Show Attributes

The contact information.

Array Item

The type of communication number provided.

Payers may sometimes return other non-compliant values.

Possible values
Electronic Data Interchange Access Number
Electronic Mail
Facsimile
Telephone
Uniform Resource Locator (URL)

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

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

Show Attributes

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

Payers may sometimes return other non-compliant values.

Possible values
AD
AT
BI
CO
CV

Information indicating how likely it is that this coverage is a match for the patient submitted in the insurance discovery request.

Even if the confidence level is high, you must always check the subscriber information to confirm that the coverage is a match for the patient.

Show Attributes

The confidence level for the match.

Possible values
REVIEW_NEEDED
HIGH

A reason for the confidence level. For example, This record was identified as a low confidence match due to a DOB partial match.

The number of potential coverage matches for the patient. This will be 0 if Stedi didn't find any matching coverage.

errorsarray<object>

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

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

Array Item

The error type, AAA.

The error description.

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

Information to help you correct the error.

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

Payers may sometimes return other non-compliant values.

Possible values
04
15
33
35
41

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

Payers may sometimes return other non-compliant values.

Possible values
Please Correct and Resubmit
Resubmission Not Allowed
Please Resubmit Original Transaction
Resubmission Allowed
Do Not Resubmit; Inquiry Initiated to a Third Party