Skip to main content

CoverageEligibilityResponse

This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.

Properties

NameRequiredTypeDescription
identifierIdentifier[]

Business Identifier for coverage eligiblity request

Details

A unique identifier assigned to this coverage eligiblity request.

statuscode

active | cancelled | draft | entered-in-error

Details

The status of the resource instance.

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

purposecode[]

auth-requirements | benefits | discovery | validation

Details

Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified.

patientReference<Patient>

Intended recipient of products and services

Details

The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.

serviced[x]date, Period

Estimated date or dates of service

Details

The date or dates when the enclosed suite of services were performed or completed.

createddateTime

Response creation date

Details

The date this resource was created.

requestorReference< Practitioner | PractitionerRole | Organization >

Party responsible for the request

Details

The provider which is responsible for the request.

Typically this field would be 1..1 where this party is responsible for the claim but not necessarily professionally responsible for the provision of the individual products and services listed below.

requestReference<CoverageEligibilityRequest>

Eligibility request reference

Details

Reference to the original request resource.

outcomecode

queued | complete | error | partial

Details

The outcome of the request processing.

The resource may be used to indicate that: the request has been held (queued) for processing; that it has been processed and errors found (error); that no errors were found and that some of the adjudication has been undertaken (partial) or that all of the adjudication has been undertaken (complete).

dispositionstring

Disposition Message

Details

A human readable description of the status of the adjudication.

insurerReference<Organization>

Coverage issuer

Details

The Insurer who issued the coverage in question and is the author of the response.

insuranceCoverageEligibilityResponseInsurance[]

Patient insurance information

Details

Financial instruments for reimbursement for the health care products and services.

All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.

idstring

Unique id for inter-element referencing

Details

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extensionExtension[]

Additional content defined by implementations

Details

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

coverageReference<Coverage>

Insurance information

Details

Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.

inforceboolean

Coverage inforce indicator

Details

Flag indicating if the coverage provided is inforce currently if no service date(s) specified or for the whole duration of the service dates.

benefitPeriodPeriod

When the benefits are applicable

Details

The term of the benefits documented in this response.

itemCoverageEligibilityResponseInsuranceItem[]

Benefits and authorization details

Details

Benefits and optionally current balances, and authorization details by category or service.

idstring

Unique id for inter-element referencing

Details

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extensionExtension[]

Additional content defined by implementations

Details

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

categoryCodeableConcept

Benefit classification

Details

Code to identify the general type of benefits under which products and services are provided.

Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.

productOrServiceCodeableConcept

Billing, service, product, or drug code

Details

This contains the product, service, drug or other billing code for the item.

Code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI).

modifierCodeableConcept[]

Product or service billing modifiers

Details

Item typification or modifiers codes to convey additional context for the product or service.

For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours.

providerReference<Practitioner | PractitionerRole>

Performing practitioner

Details

The practitioner who is eligible for the provision of the product or service.

excludedboolean

Excluded from the plan

Details

True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.

namestring

Short name for the benefit

Details

A short name or tag for the benefit.

For example: MED01, or DENT2.

descriptionstring

Description of the benefit or services covered

Details

A richer description of the benefit or services covered.

For example 'DENT2 covers 100% of basic, 50% of major but excludes Ortho, Implants and Cosmetic services'.

networkCodeableConcept

In or out of network

Details

Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.

unitCodeableConcept

Individual or family

Details

Indicates if the benefits apply to an individual or to the family.

termCodeableConcept

Annual or lifetime

Details

The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'.

benefitCoverageEligibilityResponseInsuranceItemBenefit[]

Benefit Summary

Details

Benefits used to date.

idstring

Unique id for inter-element referencing

Details

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extensionExtension[]

Additional content defined by implementations

Details

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

typeCodeableConcept

Benefit classification

Details

Classification of benefit being provided.

For example: deductible, visits, benefit amount.

allowed[x]unsignedInt, string, Money

Benefits allowed

Details

The quantity of the benefit which is permitted under the coverage.

used[x]unsignedInt, string, Money

Benefits used

Details

The quantity of the benefit which have been consumed to date.

authorizationRequiredboolean

Authorization required flag

Details

A boolean flag indicating whether a preauthorization is required prior to actual service delivery.

authorizationSupportingCodeableConcept[]

Type of required supporting materials

Details

Codes or comments regarding information or actions associated with the preauthorization.

authorizationUrluri

Preauthorization requirements endpoint

Details

A web location for obtaining requirements or descriptive information regarding the preauthorization.

preAuthRefstring

Preauthorization reference

Details

A reference from the Insurer to which these services pertain to be used on further communication and as proof that the request occurred.

formCodeableConcept

Printed form identifier

Details

A code for the form to be used for printing the content.

May be needed to identify specific jurisdictional forms.

errorCoverageEligibilityResponseError[]

Processing errors

Details

Errors encountered during the processing of the request.

idstring

Unique id for inter-element referencing

Details

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extensionExtension[]

Additional content defined by implementations

Details

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

codeCodeableConcept

Error code detailing processing issues

Details

An error code,from a specified code system, which details why the eligibility check could not be performed.

Search Parameters

NameTypeDescriptionExpression
createddateThe creation dateCoverageEligibilityResponse.created
dispositionstringThe contents of the disposition messageCoverageEligibilityResponse.disposition
identifiertokenThe business identifierCoverageEligibilityResponse.identifier
insurerreferenceThe organization which generated this resourceCoverageEligibilityResponse.insurer
outcometokenThe processing outcomeCoverageEligibilityResponse.outcome
patientreferenceThe reference to the patientCoverageEligibilityResponse.patient
requestreferenceThe EligibilityRequest referenceCoverageEligibilityResponse.request
requestorreferenceThe EligibilityRequest providerCoverageEligibilityResponse.requestor
statustokenThe EligibilityRequest statusCoverageEligibilityResponse.status

Inherited Properties

NameRequiredTypeDescription
idstring

Logical id of this artifact

Details

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

metaMeta

Metadata about the resource

Details

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesuri

A set of rules under which this content was created

Details

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

languagecode

Language of the resource content

Details

The base language in which the resource is written.

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

textNarrative

Text summary of the resource, for human interpretation

Details

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

containedResource[]

Contained, inline Resources

Details

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

extensionExtension[]

Additional content defined by implementations

Details

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

modifierExtensionExtension[]

Extensions that cannot be ignored

Details

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.