This page is part of the FHIR Specification (v3.5.0: R4 Ballot #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4
Financial Management Work Group | Maturity Level: 2 | Trial Use | Compartments: Practitioner |
Detailed Descriptions for the elements in the CoverageEligibilityResponse resource.
CoverageEligibilityResponse | |||||||||||||
Element Id | CoverageEligibilityResponse | ||||||||||||
Definition | This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource. | ||||||||||||
Control | 1..1 | ||||||||||||
Type | DomainResource | ||||||||||||
CoverageEligibilityResponse.identifier | |||||||||||||
Element Id | CoverageEligibilityResponse.identifier | ||||||||||||
Definition | The Response business identifier. | ||||||||||||
Note | This is a business identifer, not a resource identifier (see discussion) | ||||||||||||
Control | 0..* | ||||||||||||
Type | Identifier | ||||||||||||
CoverageEligibilityResponse.status | |||||||||||||
Element Id | CoverageEligibilityResponse.status | ||||||||||||
Definition | The status of the resource instance. | ||||||||||||
Control | 0..1 | ||||||||||||
Terminology Binding | Financial Resource Status Codes (Required) | ||||||||||||
Type | code | ||||||||||||
Is Modifier | true (Reason: This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid) | ||||||||||||
Summary | true | ||||||||||||
Comments | This element is labeled as a modifier because the status contains codes that mark the response as not currently valid. | ||||||||||||
CoverageEligibilityResponse.purpose | |||||||||||||
Element Id | CoverageEligibilityResponse.purpose | ||||||||||||
Definition | 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 th patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified. | ||||||||||||
Control | 1..* | ||||||||||||
Terminology Binding | EligibilityResponsePurpose (Required) | ||||||||||||
Type | code | ||||||||||||
Summary | true | ||||||||||||
CoverageEligibilityResponse.patient | |||||||||||||
Element Id | CoverageEligibilityResponse.patient | ||||||||||||
Definition | Patient Resource. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | Reference(Patient) | ||||||||||||
CoverageEligibilityResponse.serviced[x] | |||||||||||||
Element Id | CoverageEligibilityResponse.serviced[x] | ||||||||||||
Definition | The date or dates when the enclosed suite of services are proposed and for which coverage details are requested. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | date|Period | ||||||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||
CoverageEligibilityResponse.created | |||||||||||||
Element Id | CoverageEligibilityResponse.created | ||||||||||||
Definition | The date when the enclosed suite of services were performed or completed. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | dateTime | ||||||||||||
CoverageEligibilityResponse.requestProvider | |||||||||||||
Element Id | CoverageEligibilityResponse.requestProvider | ||||||||||||
Definition | The provider who is responsible for the services rendered to the patient. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | Reference(Practitioner | PractitionerRole | Organization) | ||||||||||||
CoverageEligibilityResponse.request | |||||||||||||
Element Id | CoverageEligibilityResponse.request | ||||||||||||
Definition | Original request resource reference. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | Reference(CoverageEligibilityRequest) | ||||||||||||
CoverageEligibilityResponse.outcome | |||||||||||||
Element Id | CoverageEligibilityResponse.outcome | ||||||||||||
Definition | Transaction status: error, complete. | ||||||||||||
Control | 0..1 | ||||||||||||
Terminology Binding | RemittanceOutcome (Required) | ||||||||||||
Type | code | ||||||||||||
CoverageEligibilityResponse.disposition | |||||||||||||
Element Id | CoverageEligibilityResponse.disposition | ||||||||||||
Definition | A description of the status of the adjudication. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
CoverageEligibilityResponse.insurer | |||||||||||||
Element Id | CoverageEligibilityResponse.insurer | ||||||||||||
Definition | The Insurer who produced this adjudicated response. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | Reference(Organization) | ||||||||||||
CoverageEligibilityResponse.insurance | |||||||||||||
Element Id | CoverageEligibilityResponse.insurance | ||||||||||||
Definition | The insurer may provide both the details for the requested coverage as well as details for additional coverages known to the insurer. | ||||||||||||
Control | 0..* | ||||||||||||
CoverageEligibilityResponse.insurance.coverage | |||||||||||||
Element Id | CoverageEligibilityResponse.insurance.coverage | ||||||||||||
Definition | A suite of updated or additional Coverages from the Insurer. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | Reference(Coverage) | ||||||||||||
CoverageEligibilityResponse.insurance.contract | |||||||||||||
Element Id | CoverageEligibilityResponse.insurance.contract | ||||||||||||
Definition | The contract resource which may provide more detailed information. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | Reference(Contract) | ||||||||||||
CoverageEligibilityResponse.insurance.inforce | |||||||||||||
Element Id | CoverageEligibilityResponse.insurance.inforce | ||||||||||||
Definition | Flag indicating if the coverage provided is inforce currently if no service date(s) specified or for the whole duration of the service dates. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | boolean | ||||||||||||
CoverageEligibilityResponse.insurance.item | |||||||||||||
Element Id | CoverageEligibilityResponse.insurance.item | ||||||||||||
Definition | Benefits and optionally current balances by Category or Service. | ||||||||||||
Control | 0..* | ||||||||||||
Invariants |
| ||||||||||||
CoverageEligibilityResponse.insurance.item.category | |||||||||||||
Element Id | CoverageEligibilityResponse.insurance.item.category | ||||||||||||
Definition | High-level Dental, Vision, Medical, Pharmacy, Rehab etc. and detailed types of services: Dental: basic, major, ortho; Vision exam, glasses, contacts; etc. | ||||||||||||
Control | 0..1 | ||||||||||||
Terminology Binding | Benefit Category Codes (Example) | ||||||||||||
Type | CodeableConcept | ||||||||||||
CoverageEligibilityResponse.insurance.item.billcode | |||||||||||||
Element Id | CoverageEligibilityResponse.insurance.item.billcode | ||||||||||||
Definition | A code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). | ||||||||||||
Control | 0..1 | ||||||||||||
Terminology Binding | USCLS Codes (Example) | ||||||||||||
Type | CodeableConcept | ||||||||||||
CoverageEligibilityResponse.insurance.item.modifier | |||||||||||||
Element Id | CoverageEligibilityResponse.insurance.item.modifier | ||||||||||||
Definition | Item typification or modifiers codes, eg for 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. | ||||||||||||
Control | 0..* | ||||||||||||
Terminology Binding | Modifier type Codes (Example) | ||||||||||||
Type | CodeableConcept | ||||||||||||
CoverageEligibilityResponse.insurance.item.provider | |||||||||||||
Element Id | CoverageEligibilityResponse.insurance.item.provider | ||||||||||||
Definition | The practitioner who is responsible for the services rendered to the patient. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | Reference(Practitioner | PractitionerRole) | ||||||||||||
CoverageEligibilityResponse.insurance.item.excluded | |||||||||||||
Element Id | CoverageEligibilityResponse.insurance.item.excluded | ||||||||||||
Definition | True if the indicated class of service is excluded from the plan, missing or False indicated the service is included in the coverage. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | boolean | ||||||||||||
CoverageEligibilityResponse.insurance.item.name | |||||||||||||
Element Id | CoverageEligibilityResponse.insurance.item.name | ||||||||||||
Definition | A short name or tag for the benefit, for example MED01, or DENT2. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
CoverageEligibilityResponse.insurance.item.description | |||||||||||||
Element Id | CoverageEligibilityResponse.insurance.item.description | ||||||||||||
Definition | A richer description of the benefit, for example 'DENT2 covers 100% of basic, 50% of major but excludes Ortho, Implants and Cosmetic services'. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
CoverageEligibilityResponse.insurance.item.network | |||||||||||||
Element Id | CoverageEligibilityResponse.insurance.item.network | ||||||||||||
Definition | Network designation. | ||||||||||||
Control | 0..1 | ||||||||||||
Terminology Binding | Network Type Codes (Example) | ||||||||||||
Type | CodeableConcept | ||||||||||||
CoverageEligibilityResponse.insurance.item.unit | |||||||||||||
Element Id | CoverageEligibilityResponse.insurance.item.unit | ||||||||||||
Definition | Unit designation: individual or family. | ||||||||||||
Control | 0..1 | ||||||||||||
Terminology Binding | Unit Type Codes (Example) | ||||||||||||
Type | CodeableConcept | ||||||||||||
CoverageEligibilityResponse.insurance.item.term | |||||||||||||
Element Id | CoverageEligibilityResponse.insurance.item.term | ||||||||||||
Definition | The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'. | ||||||||||||
Control | 0..1 | ||||||||||||
Terminology Binding | Benefit Term Codes (Example) | ||||||||||||
Type | CodeableConcept | ||||||||||||
CoverageEligibilityResponse.insurance.item.benefit | |||||||||||||
Element Id | CoverageEligibilityResponse.insurance.item.benefit | ||||||||||||
Definition | Benefits used to date. | ||||||||||||
Control | 0..* | ||||||||||||
CoverageEligibilityResponse.insurance.item.benefit.type | |||||||||||||
Element Id | CoverageEligibilityResponse.insurance.item.benefit.type | ||||||||||||
Definition | Deductible, visits, benefit amount. | ||||||||||||
Control | 1..1 | ||||||||||||
Terminology Binding | Benefit Type Codes (Example) | ||||||||||||
Type | CodeableConcept | ||||||||||||
CoverageEligibilityResponse.insurance.item.benefit.allowed[x] | |||||||||||||
Element Id | CoverageEligibilityResponse.insurance.item.benefit.allowed[x] | ||||||||||||
Definition | Benefits allowed. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | unsignedInt|string|Money | ||||||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||
CoverageEligibilityResponse.insurance.item.benefit.used[x] | |||||||||||||
Element Id | CoverageEligibilityResponse.insurance.item.benefit.used[x] | ||||||||||||
Definition | Benefits used. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | unsignedInt|Money | ||||||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||
CoverageEligibilityResponse.insurance.item.authorizationRequired | |||||||||||||
Element Id | CoverageEligibilityResponse.insurance.item.authorizationRequired | ||||||||||||
Definition | A boolean flag indicating whether a prior authorization or pre-authorization is required prior to actual service delivery. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | boolean | ||||||||||||
CoverageEligibilityResponse.insurance.item.authorizationSupporting | |||||||||||||
Element Id | CoverageEligibilityResponse.insurance.item.authorizationSupporting | ||||||||||||
Definition | Codes or comments regarding information or actions assciated with the pre-authorization. | ||||||||||||
Control | 0..* | ||||||||||||
Type | CodeableConcept | ||||||||||||
CoverageEligibilityResponse.insurance.item.authorizationUrl | |||||||||||||
Element Id | CoverageEligibilityResponse.insurance.item.authorizationUrl | ||||||||||||
Definition | A descriptive document location. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | uri | ||||||||||||
CoverageEligibilityResponse.preAuthRef | |||||||||||||
Element Id | CoverageEligibilityResponse.preAuthRef | ||||||||||||
Definition | A reference from the Insurer to which these services pertain. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
Requirements | To provide any pre-determination or prior authorization reference. | ||||||||||||
CoverageEligibilityResponse.form | |||||||||||||
Element Id | CoverageEligibilityResponse.form | ||||||||||||
Definition | The form to be used for printing the content. | ||||||||||||
Control | 0..1 | ||||||||||||
Terminology Binding | Forms (Example) | ||||||||||||
Type | CodeableConcept | ||||||||||||
CoverageEligibilityResponse.error | |||||||||||||
Element Id | CoverageEligibilityResponse.error | ||||||||||||
Definition | Mutually exclusive with Services Provided (Item). | ||||||||||||
Control | 0..* | ||||||||||||
CoverageEligibilityResponse.error.code | |||||||||||||
Element Id | CoverageEligibilityResponse.error.code | ||||||||||||
Definition | An error code,from a specified code system, which details why the eligibility check could not be performed. | ||||||||||||
Control | 1..1 | ||||||||||||
Terminology Binding | AdjudicationError (Example) | ||||||||||||
Type | CodeableConcept |