This
page
is
part
of
the
FHIR
Specification
(v3.3.0:
(v3.5.0:
R4
Ballot
2).
#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
R3
R2
Financial
Management
Work
Group
|
Maturity Level : 2 | Trial Use | Compartments : Patient , RelatedPerson |
Financial instrument which may be used to reimburse or pay for health care products and services.
The
Coverage
resource
is
intended
to
provide
the
high
level
high-level
identifiers
and
descriptors
of
an
insurance
plan
plan,
typically
the
information
which
would
appear
on
an
insurance
card,
which
may
be
used
to
pay
for,
pay,
in
part
or
in
whole,
for
the
provision
of
health
care
products
and
services.
This resource may also be used to register 'SelfPay' where an individual or organization other than an insurer is taking responsibility for payment for a portion of the health care costs. Selfpay should not be confused with being a guarantor of the patient's account.
This
resource
is
referenced
by
Account
,
Claim
,
ClaimResponse
,
DeviceRequest
CoverageEligibilityRequest
,
EligibilityRequest
CoverageEligibilityResponse
,
EligibilityResponse
DeviceRequest
,
EnrollmentRequest
,
ExplanationOfBenefit
,
MedicationRequest
,
ServiceRequest
and
ServiceRequest
Task
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
TU | DomainResource |
Insurance
or
medical
plan
or
a
payment
agreement
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
The
primary
coverage
ID
|
|
?! Σ | 0..1 | code |
active
|
cancelled
|
draft
|
entered-in-error
Financial Resource Status Codes ( Required ) |
|
Σ | 0..1 | CodeableConcept |
Type
of
coverage
such
as
medical
or
accident
Coverage Type and Self-Pay Codes ( Preferred ) |
|
Σ | 0..1 | Reference ( Patient | RelatedPerson | Organization ) | Owner of the policy |
|
Σ | 0..1 | Reference ( Patient | RelatedPerson ) | Subscriber to the policy |
|
Σ | 0..1 | string | ID assigned to the Subscriber |
|
Σ | 0..1 | Reference ( Patient ) | Plan Beneficiary |
|
Σ | 0..1 | string | Dependent number |
|
0..1 | CodeableConcept |
Beneficiary
relationship
to
the
Subscriber
Policyholder Relationship Codes ( Example ) |
|
|
Σ | 0..1 | Period | Coverage start and end dates |
|
Σ | 0..* | Reference ( Organization | Patient | RelatedPerson ) |
Identifier
for
the
plan
or
agreement
issuer
|
|
0..* | BackboneElement |
Additional
coverage
classifications
|
|
|
Σ | 1..1 | Coding |
Type
of
class
such
as
'group'
or
'plan'
Coverage Class Codes ( Extensible ) |
|
Σ | 1..1 | string | The tag or value under the classification |
|
Σ | 0..1 | string | Display text for an identifier for the group |
|
Σ | 0..1 | positiveInt | Relative order of the coverage |
|
Σ | 0..1 | string | Insurer network |
|
0..* | BackboneElement |
Patient
payments
for
services/products
|
|
|
Σ | 0..1 | Coding |
The
type
of
service
or
product
Coverage Copay Type Codes ( Extensible ) |
|
Σ | 1..1 | Quantity | The amount or percentage of the copayment |
|
0..* | Reference ( Contract ) |
Contract
details
|
|
Documentation
for
this
format
|
||||
UML Diagram ( Legend )
XML Template
<Coverage xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
<</identifier><identifier><!-- 0..* Identifier The primary coverage ID --></identifier> <status value="[code]"/><!-- 0..1 active | cancelled | draft | entered-in-error --> <type><!-- 0..1 CodeableConcept Type of coverage such as medical or accident --></type> <policyHolder><!-- 0..1 Reference(Patient|RelatedPerson|Organization) Owner of the policy --></policyHolder> <subscriber><!-- 0..1 Reference(Patient|RelatedPerson) Subscriber to the policy --></subscriber> <subscriberId value="[string]"/><!-- 0..1 ID assigned to the Subscriber --><</beneficiary><beneficiary><!-- 0..1 Reference(Patient) Plan Beneficiary --></beneficiary> <dependent value="[string]"/><!-- 0..1 Dependent number --> <relationship><!-- 0..1 CodeableConcept Beneficiary relationship to the Subscriber --></relationship> <period><!-- 0..1 Period Coverage start and end dates --></period> <payor><!-- 0..* Reference(Organization|Patient|RelatedPerson) Identifier for the plan or agreement issuer --></payor> <class> <!-- 0..* Additional coverage classifications --> <type><!-- 1..1 Coding Type of class such as 'group' or 'plan' --></type><<value value="[string]"/><!-- 1..1 The tag or value under the classification --> <name value="[string]"/><!-- 0..1 Display text for an identifier for the group --> </class><<order value="[positiveInt]"/><!-- 0..1 Relative order of the coverage --> <network value="[string]"/><!-- 0..1 Insurer network --> <copay> <!-- 0..* Patient payments for services/products --><</type> <</value><type><!-- 0..1 Coding The type of service or product --></type> <value><!-- 1..1 Quantity The amount or percentage of the copayment --></value> </copay> <contract><!-- 0..* Reference(Contract) Contract details --></contract> </Coverage>
JSON Template
{
"resourceType" : "Coverage",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"identifier" : [{ Identifier }], // The primary coverage ID
"status" : "<code>", // active | cancelled | draft | entered-in-error
"type" : { CodeableConcept }, // Type of coverage such as medical or accident
"policyHolder" : { Reference(Patient|RelatedPerson|Organization) }, // Owner of the policy
"subscriber" : { Reference(Patient|RelatedPerson) }, // Subscriber to the policy
"subscriberId" : "<string>", // ID assigned to the Subscriber
"
"beneficiary" : { Reference(Patient) }, // Plan Beneficiary
"dependent" : "<string>", // Dependent number
"relationship" : { CodeableConcept }, // Beneficiary relationship to the Subscriber
"period" : { Period }, // Coverage start and end dates
"payor" : [{ Reference(Organization|Patient|RelatedPerson) }], // Identifier for the plan or agreement issuer
"class" : [{ // Additional coverage classifications
"type" : { Coding }, // R! Type of class such as 'group' or 'plan'
"
"value" : "<string>", // R! The tag or value under the classification
"name" : "<string>" // Display text for an identifier for the group
}],
"
"order" : "<positiveInt>", // Relative order of the coverage
"network" : "<string>", // Insurer network
"copay" : [{ // Patient payments for services/products
"
"
"type" : { Coding }, // The type of service or product
"value" : { Quantity } // R! The amount or percentage of the copayment
}],
"contract" : [{ Reference(Contract) }] // Contract details
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:Coverage; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension
fhir:fhir:Coverage.identifier [ Identifier ], ... ; # 0..* The primary coverage ID fhir:Coverage.status [ code ]; # 0..1 active | cancelled | draft | entered-in-error fhir:Coverage.type [ CodeableConcept ]; # 0..1 Type of coverage such as medical or accident fhir:Coverage.policyHolder [ Reference(Patient|RelatedPerson|Organization) ]; # 0..1 Owner of the policy fhir:Coverage.subscriber [ Reference(Patient|RelatedPerson) ]; # 0..1 Subscriber to the policy fhir:Coverage.subscriberId [ string ]; # 0..1 ID assigned to the Subscriberfhir:fhir:Coverage.beneficiary [ Reference(Patient) ]; # 0..1 Plan Beneficiary fhir:Coverage.dependent [ string ]; # 0..1 Dependent number fhir:Coverage.relationship [ CodeableConcept ]; # 0..1 Beneficiary relationship to the Subscriber fhir:Coverage.period [ Period ]; # 0..1 Coverage start and end dates fhir:Coverage.payor [ Reference(Organization|Patient|RelatedPerson) ], ... ; # 0..* Identifier for the plan or agreement issuer fhir:Coverage.class [ # 0..* Additional coverage classifications fhir:Coverage.class.type [ Coding ]; # 1..1 Type of class such as 'group' or 'plan'fhir:fhir:Coverage.class.value [ string ]; # 1..1 The tag or value under the classification fhir:Coverage.class.name [ string ]; # 0..1 Display text for an identifier for the group ], ...;fhir:fhir:Coverage.order [ positiveInt ]; # 0..1 Relative order of the coverage fhir:Coverage.network [ string ]; # 0..1 Insurer network fhir:Coverage.copay [ # 0..* Patient payments for services/productsfhir: fhir:fhir:Coverage.copay.type [ Coding ]; # 0..1 The type of service or product fhir:Coverage.copay.value [ Quantity ]; # 1..1 The amount or percentage of the copayment ], ...; fhir:Coverage.contract [ Reference(Contract) ], ... ; # 0..* Contract details ]
Changes since R3
| Coverage | |
| Coverage.class |
|
| Coverage.class.type |
|
| Coverage.class.value |
|
| Coverage.class.name |
|
| Coverage.copay |
|
| Coverage.copay.type |
|
| Coverage.copay.value |
|
| Coverage.grouping |
|
| Coverage.sequence |
|
See the Full Difference for further information
This analysis is available as XML or JSON .
See R3 <--> R4 Conversion Maps (status = 4 tests of which 4 fail to execute .)
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
TU | DomainResource |
Insurance
or
medical
plan
or
a
payment
agreement
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
The
primary
coverage
ID
|
|
?! Σ | 0..1 | code |
active
|
cancelled
|
draft
|
entered-in-error
Financial Resource Status Codes ( Required ) |
|
Σ | 0..1 | CodeableConcept |
Type
of
coverage
such
as
medical
or
accident
Coverage Type and Self-Pay Codes ( Preferred ) |
|
Σ | 0..1 | Reference ( Patient | RelatedPerson | Organization ) | Owner of the policy |
|
Σ | 0..1 | Reference ( Patient | RelatedPerson ) | Subscriber to the policy |
|
Σ | 0..1 | string | ID assigned to the Subscriber |
|
Σ | 0..1 | Reference ( Patient ) | Plan Beneficiary |
|
Σ | 0..1 | string | Dependent number |
|
0..1 | CodeableConcept |
Beneficiary
relationship
to
the
Subscriber
Policyholder Relationship Codes ( Example ) |
|
|
Σ | 0..1 | Period | Coverage start and end dates |
|
Σ | 0..* | Reference ( Organization | Patient | RelatedPerson ) |
Identifier
for
the
plan
or
agreement
issuer
|
|
0..* | BackboneElement |
Additional
coverage
classifications
|
|
|
Σ | 1..1 | Coding |
Type
of
class
such
as
'group'
or
'plan'
Coverage Class Codes ( Extensible ) |
|
Σ | 1..1 | string | The tag or value under the classification |
|
Σ | 0..1 | string | Display text for an identifier for the group |
|
Σ | 0..1 | positiveInt | Relative order of the coverage |
|
Σ | 0..1 | string | Insurer network |
|
0..* | BackboneElement |
Patient
payments
for
services/products
|
|
|
Σ | 0..1 | Coding |
The
type
of
service
or
product
Coverage Copay Type Codes ( Extensible ) |
|
Σ | 1..1 | Quantity | The amount or percentage of the copayment |
|
0..* | Reference ( Contract ) |
Contract
details
|
|
Documentation
for
this
format
|
||||
XML Template
<Coverage xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
<</identifier><identifier><!-- 0..* Identifier The primary coverage ID --></identifier> <status value="[code]"/><!-- 0..1 active | cancelled | draft | entered-in-error --> <type><!-- 0..1 CodeableConcept Type of coverage such as medical or accident --></type> <policyHolder><!-- 0..1 Reference(Patient|RelatedPerson|Organization) Owner of the policy --></policyHolder> <subscriber><!-- 0..1 Reference(Patient|RelatedPerson) Subscriber to the policy --></subscriber> <subscriberId value="[string]"/><!-- 0..1 ID assigned to the Subscriber --><</beneficiary><beneficiary><!-- 0..1 Reference(Patient) Plan Beneficiary --></beneficiary> <dependent value="[string]"/><!-- 0..1 Dependent number --> <relationship><!-- 0..1 CodeableConcept Beneficiary relationship to the Subscriber --></relationship> <period><!-- 0..1 Period Coverage start and end dates --></period> <payor><!-- 0..* Reference(Organization|Patient|RelatedPerson) Identifier for the plan or agreement issuer --></payor> <class> <!-- 0..* Additional coverage classifications --> <type><!-- 1..1 Coding Type of class such as 'group' or 'plan' --></type><<value value="[string]"/><!-- 1..1 The tag or value under the classification --> <name value="[string]"/><!-- 0..1 Display text for an identifier for the group --> </class><<order value="[positiveInt]"/><!-- 0..1 Relative order of the coverage --> <network value="[string]"/><!-- 0..1 Insurer network --> <copay> <!-- 0..* Patient payments for services/products --><</type> <</value><type><!-- 0..1 Coding The type of service or product --></type> <value><!-- 1..1 Quantity The amount or percentage of the copayment --></value> </copay> <contract><!-- 0..* Reference(Contract) Contract details --></contract> </Coverage>
JSON Template
{
"resourceType" : "Coverage",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"identifier" : [{ Identifier }], // The primary coverage ID
"status" : "<code>", // active | cancelled | draft | entered-in-error
"type" : { CodeableConcept }, // Type of coverage such as medical or accident
"policyHolder" : { Reference(Patient|RelatedPerson|Organization) }, // Owner of the policy
"subscriber" : { Reference(Patient|RelatedPerson) }, // Subscriber to the policy
"subscriberId" : "<string>", // ID assigned to the Subscriber
"
"beneficiary" : { Reference(Patient) }, // Plan Beneficiary
"dependent" : "<string>", // Dependent number
"relationship" : { CodeableConcept }, // Beneficiary relationship to the Subscriber
"period" : { Period }, // Coverage start and end dates
"payor" : [{ Reference(Organization|Patient|RelatedPerson) }], // Identifier for the plan or agreement issuer
"class" : [{ // Additional coverage classifications
"type" : { Coding }, // R! Type of class such as 'group' or 'plan'
"
"value" : "<string>", // R! The tag or value under the classification
"name" : "<string>" // Display text for an identifier for the group
}],
"
"order" : "<positiveInt>", // Relative order of the coverage
"network" : "<string>", // Insurer network
"copay" : [{ // Patient payments for services/products
"
"
"type" : { Coding }, // The type of service or product
"value" : { Quantity } // R! The amount or percentage of the copayment
}],
"contract" : [{ Reference(Contract) }] // Contract details
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:Coverage; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension
fhir:fhir:Coverage.identifier [ Identifier ], ... ; # 0..* The primary coverage ID fhir:Coverage.status [ code ]; # 0..1 active | cancelled | draft | entered-in-error fhir:Coverage.type [ CodeableConcept ]; # 0..1 Type of coverage such as medical or accident fhir:Coverage.policyHolder [ Reference(Patient|RelatedPerson|Organization) ]; # 0..1 Owner of the policy fhir:Coverage.subscriber [ Reference(Patient|RelatedPerson) ]; # 0..1 Subscriber to the policy fhir:Coverage.subscriberId [ string ]; # 0..1 ID assigned to the Subscriberfhir:fhir:Coverage.beneficiary [ Reference(Patient) ]; # 0..1 Plan Beneficiary fhir:Coverage.dependent [ string ]; # 0..1 Dependent number fhir:Coverage.relationship [ CodeableConcept ]; # 0..1 Beneficiary relationship to the Subscriber fhir:Coverage.period [ Period ]; # 0..1 Coverage start and end dates fhir:Coverage.payor [ Reference(Organization|Patient|RelatedPerson) ], ... ; # 0..* Identifier for the plan or agreement issuer fhir:Coverage.class [ # 0..* Additional coverage classifications fhir:Coverage.class.type [ Coding ]; # 1..1 Type of class such as 'group' or 'plan'fhir:fhir:Coverage.class.value [ string ]; # 1..1 The tag or value under the classification fhir:Coverage.class.name [ string ]; # 0..1 Display text for an identifier for the group ], ...;fhir:fhir:Coverage.order [ positiveInt ]; # 0..1 Relative order of the coverage fhir:Coverage.network [ string ]; # 0..1 Insurer network fhir:Coverage.copay [ # 0..* Patient payments for services/productsfhir: fhir:fhir:Coverage.copay.type [ Coding ]; # 0..1 The type of service or product fhir:Coverage.copay.value [ Quantity ]; # 1..1 The amount or percentage of the copayment ], ...; fhir:Coverage.contract [ Reference(Contract) ], ... ; # 0..* Contract details ]
Changes
since
DSTU2
Release
3
| Coverage | |
| Coverage.class |
|
| Coverage.class.type |
|
| Coverage.class.value |
|
| Coverage.class.name |
|
| Coverage.copay |
|
| Coverage.copay.type |
|
| Coverage.copay.value |
|
| Coverage.grouping |
|
| Coverage.sequence |
|
See the Full Difference for further information
This analysis is available as XML or JSON .
See R3 <--> R4 Conversion Maps (status = 4 tests of which 4 fail to execute .)
Alternate
See
the
Profiles
&
Extensions
and
the
alternate
definitions:
Master
Definition
XML
+
JSON
,
XML
Schema
/
Schematron
+
JSON
Schema
,
ShEx
(for
Turtle
)
+
see
the
extensions
&
the
dependency
analysis
| Path | Definition | Type | Reference |
|---|---|---|---|
| Coverage.status | A code specifying the state of the resource instance. | Required |
|
| Coverage.type | The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization. | Preferred |
|
| Coverage.relationship | The relationship between the Policyholder and the Beneficiary (insured/covered party/patient). | Example |
|
| Coverage.class.type | The policy classifications, eg. Group, Plan, Class, etc. | Extensible |
|
| Coverage.copay.type | The tytpes of services to which patient copayments are specified. | Extensible |
|
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
| Name | Type | Description | Expression | In Common |
| beneficiary | reference | Covered party |
Coverage.beneficiary
( Patient ) |
|
| dependent | string | Dependent number | Coverage.dependent | |
| identifier | token | The primary identifier of the insured and the coverage | Coverage.identifier | |
| patient | reference | Retrieve coverages for a patient |
Coverage.beneficiary
( Patient ) |
|
| payor | reference | The identity of the insurer or party paying for services |
Coverage.payor
( Organization , Patient , RelatedPerson ) |
|
| policy-holder | reference | Reference to the policyholder |
Coverage.policyHolder
( Organization , Patient , RelatedPerson ) |
|
| status | token | The status of the Coverage | Coverage.status | |
| subscriber | reference | Reference to the subscriber |
Coverage.subscriber
( Patient , RelatedPerson ) |
|
| type | token | The kind of coverage (health plan, auto, Workers Compensation) | Coverage.type |