This page is part of the FHIR Specification (v1.4.0:
STU
3 Ballot 3). The current version which supercedes this version is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
. For a full list of available versions, see the
Directory of published versions
.
Page
versions:
. Page versions:
R3
R2
This resource is marked as a draft .
|
|
Compartments
|
This resource provides eligibility and plan details from the processing of an Eligibility resource.
This
resource
has
not
yet
undergone
proper
review
by
FM.
At
this
time,
it
is
to
be
considered
as
a
draft.
This resource has not yet undergone proper review by FM. At this time, it is to be considered as a draft.
The
EligibilityResponse
resource
provides
eligibility
and
plan
details
from
the
processing
of
an
Eligibility
resource.
It
combines
key
information
from
a
payor
as
to
whether
a
Coverage
is
in-force,
and
optionally
the
nature
of
the
Policy
details.
Todo
The EligibilityResponse resource provides eligibility and plan details from the processing of an Eligibility resource. It combines key information from a payor as to whether a Coverage is in-force, and optionally the nature of the Policy details.
Todo
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
Σ | DomainResource |
|
|
|
Σ | 0..* | Identifier |
|
|
Σ | 0..1 | Claim reference | |
![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() | Reference ( EligibilityRequest ) | |||
|
Σ | 0..1 | code |
RemittanceOutcome |
|
Σ | 0..1 | string |
|
|
Σ | 0..1 | Coding |
|
|
Σ | 0..1 | Coding |
|
|
Σ | 0..1 | dateTime |
|
|
Σ | 0..1 | Insurer | |
![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() | Reference ( Organization ) | |||
|
Σ | 0..1 | Responsible practitioner | |
![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() | Reference ( Practitioner ) | |||
|
|
0..1 | Responsible organization | |
![]() ![]() ![]() | Identifier | |||
|
Reference ( Organization ) | |||
| Σ | 0..1 | boolean | Coverage inforce |
![]() ![]() |
Σ | 0..1 |
Reference
(
|
|
| Σ | 0..1 | Coding |
Printed Form Identifier
Form Codes ( Required ) |
![]() ![]() | Σ | 0..* | BackboneElement | Benefits by Category |
![]() ![]() ![]() | Σ | 1..1 | Coding |
Benefit Category
Benefit Category Codes ( Example ) |
![]() ![]() ![]() | Σ | 0..1 | Coding |
Benefit SubCategory
Benefit SubCategory Codes ( Example ) |
![]() ![]() ![]() | Σ | 0..1 | Coding |
In or out of network
Network Type Codes ( Example ) |
![]() ![]() ![]() | Σ | 0..1 | Coding |
Individual or family
Unit Type Codes ( Example ) |
![]() ![]() ![]() | Σ | 0..1 | Coding |
Annual or lifetime
Benefit Term Codes ( Example ) |
![]() ![]() ![]() | Σ | 0..* | BackboneElement | Benefit Summary |
![]() ![]() ![]() ![]() | Σ | 1..1 | Coding |
Deductable, visits, benefit amount
Benefit Type Codes ( Example ) |
![]() ![]() ![]() ![]() | Σ | 0..1 | Benefits allowed | |
![]() ![]() ![]() ![]() ![]() | unsignedInt | |||
![]() ![]() ![]() ![]() ![]() | Money | |||
![]() ![]() ![]() ![]() | Σ | 0..1 | Benefits used | |
![]() ![]() ![]() ![]() ![]() | unsignedInt | |||
![]() ![]() ![]() ![]() ![]() | Money | |||
![]() ![]() | Σ | 0..* | BackboneElement | Processing errors |
![]() ![]() ![]() | Σ | 1..1 | Coding |
Error code detailing processing issues
Adjudication Error Codes ( Required ) |
Documentation for this format
|
||||
UML
Diagram
UML Diagram
XML
Template
XML Template
<EligibilityResponse xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Business Identifier --></identifier>
<</request><request[x]><!-- 0..1 Identifier|Reference(EligibilityRequest) Claim reference --></request[x]> <outcome value="[code]"/><!-- 0..1 complete | error --> <disposition value="[string]"/><!-- 0..1 Disposition Message --> <ruleset><!-- 0..1 Coding Resource version --></ruleset> <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset> <created value="[dateTime]"/><!-- 0..1 Creation date --><</organization> <</requestProvider> <</requestOrganization><organization[x]><!-- 0..1 Identifier|Reference(Organization) Insurer --></organization[x]> <requestProvider[x]><!-- 0..1 Identifier|Reference(Practitioner) Responsible practitioner --></requestProvider[x]> <requestOrganization[x]><!-- 0..1 Identifier|Reference(Organization) Responsible organization --></requestOrganization[x]> <inforce value="[boolean]"/><!-- 0..1 Coverage inforce --> <contract><!-- 0..1 Reference(Contract) Contract details --></contract> <form><!-- 0..1 Coding Printed Form Identifier --></form> <benefitBalance> <!-- 0..* Benefits by Category --> <category><!-- 1..1 Coding Benefit Category --></category> <subCategory><!-- 0..1 Coding Benefit SubCategory --></subCategory> <network><!-- 0..1 Coding In or out of network --></network> <unit><!-- 0..1 Coding Individual or family --></unit> <term><!-- 0..1 Coding Annual or lifetime --></term> <financial> <!-- 0..* Benefit Summary --> <type><!-- 1..1 Coding Deductable, visits, benefit amount --></type> <benefit[x]><!-- 0..1 unsignedInt|Quantity(Money) Benefits allowed --></benefit[x]> <benefitUsed[x]><!-- 0..1 unsignedInt|Quantity(Money) Benefits used --></benefitUsed[x]> </financial> </benefitBalance> <error> <!-- 0..* Processing errors --> <code><!-- 1..1 Coding Error code detailing processing issues --></code> </error> </EligibilityResponse>
JSON
Template
JSON Template
{
"resourceType" : "EligibilityResponse",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Business Identifier
"
// request[x]: Claim reference. One of these 2:
"requestIdentifier" : { Identifier },
"requestReference" : { Reference(EligibilityRequest) },
"outcome" : "<code>", // complete | error
"disposition" : "<string>", // Disposition Message
"ruleset" : { Coding }, // Resource version
"originalRuleset" : { Coding }, // Original version
"created" : "<dateTime>", // Creation date
"
"
"
// organization[x]: Insurer. One of these 2:
"organizationIdentifier" : { Identifier },
"organizationReference" : { Reference(Organization) },
// requestProvider[x]: Responsible practitioner. One of these 2:
"requestProviderIdentifier" : { Identifier },
"requestProviderReference" : { Reference(Practitioner) },
// requestOrganization[x]: Responsible organization. One of these 2:
"requestOrganizationIdentifier" : { Identifier },
"requestOrganizationReference" : { Reference(Organization) },
"inforce" : <boolean>, // Coverage inforce
"contract" : { Reference(Contract) }, // Contract details
"form" : { Coding }, // Printed Form Identifier
"benefitBalance" : [{ // Benefits by Category
"category" : { Coding }, // R! Benefit Category
"subCategory" : { Coding }, // Benefit SubCategory
"network" : { Coding }, // In or out of network
"unit" : { Coding }, // Individual or family
"term" : { Coding }, // Annual or lifetime
"financial" : [{ // Benefit Summary
"type" : { Coding }, // R! Deductable, visits, benefit amount
// benefit[x]: Benefits allowed. One of these 2:
"benefitUnsignedInt" : "<unsignedInt>",
"benefitQuantity" : { Quantity(Money) },
// benefitUsed[x]: Benefits used. One of these 2:
"benefitUsedUnsignedInt" : "<unsignedInt>"
"benefitUsedQuantity" : { Quantity(Money) }
}]
}],
"error" : [{ // Processing errors
"code" : { Coding } // R! Error code detailing processing issues
}]
}
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
Σ | DomainResource |
|
|
|
Σ | 0..* | Identifier |
|
|
Σ | 0..1 | Claim reference | |
![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() | Reference ( EligibilityRequest ) | |||
|
Σ | 0..1 | code |
RemittanceOutcome |
|
Σ | 0..1 | string |
|
|
Σ | 0..1 | Coding |
|
|
Σ | 0..1 | Coding |
|
|
Σ | 0..1 | dateTime |
|
|
Σ | 0..1 | Insurer | |
![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() | Reference ( Organization ) | |||
|
Σ | 0..1 | Responsible practitioner | |
![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() | Reference ( Practitioner ) | |||
|
|
0..1 | Responsible organization | |
![]() ![]() ![]() | Identifier | |||
|
Reference ( Organization ) | |||
| Σ | 0..1 | boolean | Coverage inforce |
![]() ![]() |
Σ | 0..1 |
Reference
(
|
|
| Σ | 0..1 | Coding |
Printed Form Identifier
Form Codes ( Required ) |
![]() ![]() | Σ | 0..* | BackboneElement | Benefits by Category |
![]() ![]() ![]() | Σ | 1..1 | Coding |
Benefit Category
Benefit Category Codes ( Example ) |
![]() ![]() ![]() | Σ | 0..1 | Coding |
Benefit SubCategory
Benefit SubCategory Codes ( Example ) |
![]() ![]() ![]() | Σ | 0..1 | Coding |
In or out of network
Network Type Codes ( Example ) |
![]() ![]() ![]() | Σ | 0..1 | Coding |
Individual or family
Unit Type Codes ( Example ) |
![]() ![]() ![]() | Σ | 0..1 | Coding |
Annual or lifetime
Benefit Term Codes ( Example ) |
![]() ![]() ![]() | Σ | 0..* | BackboneElement | Benefit Summary |
![]() ![]() ![]() ![]() | Σ | 1..1 | Coding |
Deductable, visits, benefit amount
Benefit Type Codes ( Example ) |
![]() ![]() ![]() ![]() | Σ | 0..1 | Benefits allowed | |
![]() ![]() ![]() ![]() ![]() | unsignedInt | |||
![]() ![]() ![]() ![]() ![]() | Money | |||
![]() ![]() ![]() ![]() | Σ | 0..1 | Benefits used | |
![]() ![]() ![]() ![]() ![]() | unsignedInt | |||
![]() ![]() ![]() ![]() ![]() | Money | |||
![]() ![]() | Σ | 0..* | BackboneElement | Processing errors |
![]() ![]() ![]() | Σ | 1..1 | Coding |
Error code detailing processing issues
Adjudication Error Codes ( Required ) |
Documentation for this format
|
||||
XML
Template
XML Template
<EligibilityResponse xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Business Identifier --></identifier>
<</request><request[x]><!-- 0..1 Identifier|Reference(EligibilityRequest) Claim reference --></request[x]> <outcome value="[code]"/><!-- 0..1 complete | error --> <disposition value="[string]"/><!-- 0..1 Disposition Message --> <ruleset><!-- 0..1 Coding Resource version --></ruleset> <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset> <created value="[dateTime]"/><!-- 0..1 Creation date --><</organization> <</requestProvider> <</requestOrganization><organization[x]><!-- 0..1 Identifier|Reference(Organization) Insurer --></organization[x]> <requestProvider[x]><!-- 0..1 Identifier|Reference(Practitioner) Responsible practitioner --></requestProvider[x]> <requestOrganization[x]><!-- 0..1 Identifier|Reference(Organization) Responsible organization --></requestOrganization[x]> <inforce value="[boolean]"/><!-- 0..1 Coverage inforce --> <contract><!-- 0..1 Reference(Contract) Contract details --></contract> <form><!-- 0..1 Coding Printed Form Identifier --></form> <benefitBalance> <!-- 0..* Benefits by Category --> <category><!-- 1..1 Coding Benefit Category --></category> <subCategory><!-- 0..1 Coding Benefit SubCategory --></subCategory> <network><!-- 0..1 Coding In or out of network --></network> <unit><!-- 0..1 Coding Individual or family --></unit> <term><!-- 0..1 Coding Annual or lifetime --></term> <financial> <!-- 0..* Benefit Summary --> <type><!-- 1..1 Coding Deductable, visits, benefit amount --></type> <benefit[x]><!-- 0..1 unsignedInt|Quantity(Money) Benefits allowed --></benefit[x]> <benefitUsed[x]><!-- 0..1 unsignedInt|Quantity(Money) Benefits used --></benefitUsed[x]> </financial> </benefitBalance> <error> <!-- 0..* Processing errors --> <code><!-- 1..1 Coding Error code detailing processing issues --></code> </error> </EligibilityResponse>
JSON
Template
JSON Template
{
"resourceType" : "EligibilityResponse",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Business Identifier
"
// request[x]: Claim reference. One of these 2:
"requestIdentifier" : { Identifier },
"requestReference" : { Reference(EligibilityRequest) },
"outcome" : "<code>", // complete | error
"disposition" : "<string>", // Disposition Message
"ruleset" : { Coding }, // Resource version
"originalRuleset" : { Coding }, // Original version
"created" : "<dateTime>", // Creation date
"
"
"
// organization[x]: Insurer. One of these 2:
"organizationIdentifier" : { Identifier },
"organizationReference" : { Reference(Organization) },
// requestProvider[x]: Responsible practitioner. One of these 2:
"requestProviderIdentifier" : { Identifier },
"requestProviderReference" : { Reference(Practitioner) },
// requestOrganization[x]: Responsible organization. One of these 2:
"requestOrganizationIdentifier" : { Identifier },
"requestOrganizationReference" : { Reference(Organization) },
"inforce" : <boolean>, // Coverage inforce
"contract" : { Reference(Contract) }, // Contract details
"form" : { Coding }, // Printed Form Identifier
"benefitBalance" : [{ // Benefits by Category
"category" : { Coding }, // R! Benefit Category
"subCategory" : { Coding }, // Benefit SubCategory
"network" : { Coding }, // In or out of network
"unit" : { Coding }, // Individual or family
"term" : { Coding }, // Annual or lifetime
"financial" : [{ // Benefit Summary
"type" : { Coding }, // R! Deductable, visits, benefit amount
// benefit[x]: Benefits allowed. One of these 2:
"benefitUnsignedInt" : "<unsignedInt>",
"benefitQuantity" : { Quantity(Money) },
// benefitUsed[x]: Benefits used. One of these 2:
"benefitUsedUnsignedInt" : "<unsignedInt>"
"benefitUsedQuantity" : { Quantity(Money) }
}]
}],
"error" : [{ // Processing errors
"code" : { Coding } // R! Error code detailing processing issues
}]
}
Alternate
definitions:
Alternate definitions:
Schema
/
Schematron
,
Resource
Profile
(
, Resource Profile (
XML
,
,
JSON
),
),
Questionnaire
| Path | Definition | Type | Reference |
|---|---|---|---|
|
|
|
Required | RemittanceOutcome |
|
EligibilityResponse.ruleset
|
|
Example |
|
| EligibilityResponse.form | The forms codes. | Required | Form Codes |
| EligibilityResponse.benefitBalance.category | Benefit categories such as: oral, medical, vision etc. | Example | Benefit Category Codes |
| EligibilityResponse.benefitBalance.subCategory | Benefit subcategories such as: oral-basic, major, glasses | Example | Benefit SubCategory Codes |
| EligibilityResponse.benefitBalance.network | Code to classify in or out of network services | Example | Network Type Codes |
| EligibilityResponse.benefitBalance.unit | Unit covered/serviced - individual or family | Example | Unit Type Codes |
| EligibilityResponse.benefitBalance.term | Coverage unit - annual, lifetime | Example | Benefit Term Codes |
| EligibilityResponse.benefitBalance.financial.type | Deductable, visits, co-pay, etc. | Example | Benefit Type Codes |
| EligibilityResponse.error.code | The error codes for adjudication processing. | Required | Adjudication Error Codes |
Search parameters for this resource. The
common parameters
also apply. See
Searching
for
more
information
about
searching
in
REST,
messaging,
and
services.
for more information about searching in REST, messaging, and services.
| Name | Type | Description | Paths |
| created | date | The creation date | EligibilityResponse.created |
| disposition | string | The contents of the disposition message | EligibilityResponse.disposition |
| identifier | token |
|
EligibilityResponse.identifier |
| organizationidentifier | token | The organization which generated this resource | EligibilityResponse.organizationIdentifier |
| organizationreference | reference | The organization which generated this resource |
EligibilityResponse.organizationReference
|
| outcome |
token
|
The processing outcome | EligibilityResponse.outcome |
| requestidentifier |
token
|
The EligibilityRequest reference | EligibilityResponse.requestIdentifier |
| requestorganizationidentifier |
token
|
The EligibilityRequest organization | EligibilityResponse.requestOrganizationIdentifier |
| requestorganizationreference |
reference
|
The EligibilityRequest organization |
EligibilityResponse.requestOrganizationReference
( Organization |
| requestprovideridentifier | token | The EligibilityRequest provider | EligibilityResponse.requestProviderIdentifier |
| requestproviderreference | reference | The EligibilityRequest provider |
EligibilityResponse.requestProviderReference
( Practitioner |
| requestreference | reference | The EligibilityRequest reference |
EligibilityResponse.requestReference
( EligibilityRequest ) |