CDC National Healthcare Safety Network (NHSN) Digital Quality Measures (dQM) Content Package IG
1.0.0 - Release 1 United States of America flag

This page is part of the CDC National Healthcare Safety Network (NHSN) Digital Quality Measures (dQM) Content Package IG (v1.0.0: Release) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: AcuteCareHospitalMonthlyReportingCoverage - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 1

Definitions for the ach-monthly-coverage resource profile.

Guidance on how to interpret the contents of this table can be foundhere

0. Coverage
Definition

Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.

Short Insurance or medical plan or a payment agreement
Comments

The Coverage resource contains the insurance card level information, which is customary to provide on claims and other communications between providers and insurers.

Control 0..*
Is Modifier false
Summary false
Invariants dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Coverage.id
Definition

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

Short Logical id of this artifact
Comments

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

Control 10..1
Type idstring
Is Modifier false
Summary true
4. Coverage.implicitRules
Definition

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.

Short A set of rules under which this content was created
Comments

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.

Control 0..1
Type uri
Is Modifier true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Coverage.modifierExtension
Definition

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

Short Extensions that cannot be ignored
Comments

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.

Control 0..*
Type Extension
Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary false
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Names extensions, user content
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. Coverage.status
Definition

The status of the resource instance.

Short active | cancelled | draft | entered-in-error
Comments

This element is labeled as a modifier because the status contains the code entered-in-error that marks the coverage as not currently valid.

Control 1..1
Binding The codes SHALL be taken from FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|4.0.1
(required to http://hl7.org/fhir/ValueSet/fm-status|4.0.1)

A code specifying the state of the resource instance.

Type code
Is Modifier true because This element is labelled 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
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Requirements

Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Coverage.type
Definition

The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.

Short Coverage category such as medical or accident
Control 0..1
Binding Unless not suitable, these codes SHALL be taken from The codes SHOULD be taken from Payer .http://hl7.org/fhir/ValueSet/coverage-type|4.0.1
(extensible to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591)
Type CodeableConcept
Is Modifier false
Must Support true
Summary true
Requirements

The order of application of coverages is dependent on the types of coverage.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Coverage.policyHolder
Definition

The party who 'owns' the insurance policy.

Short Owner of the policy
Comments

For example: may be an individual, corporation or the subscriber's employer.

Control 0..1
Type Reference(Patient, RelatedPerson, Organization)
Is Modifier false
Must Support true
Must Support Types No must-support rules about the choice of types/profiles
Summary true
Requirements

This provides employer information in the case of Worker's Compensation and other policies.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Coverage.policyHolder.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Short Literal reference, Relative, internal or absolute URL
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Control 10..1
This element is affected by the following invariants: ref-1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Coverage.subscriber
Definition

The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.

Short Subscriber to the policy
Comments

May be self or a parent in the case of dependants.

Control 0..1
Type Reference(Patient, RelatedPerson)
Is Modifier false
Must Support true
Must Support Types No must-support rules about the choice of types/profiles
Summary true
Requirements

This is the party who is entitled to the benfits under the policy.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Coverage.subscriber.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Short Literal reference, Relative, internal or absolute URL
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Control 10..1
This element is affected by the following invariants: ref-1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Coverage.subscriberId
Definition

The insurer assigned ID for the Subscriber.

Short ID assigned to the subscriber
Control 0..1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Requirements

The insurer requires this identifier on correspondance and claims (digital and otherwise).

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Coverage.beneficiary
Definition

The party who benefits from the insurance coverage; the patient when products and/or services are provided.

Short Plan beneficiary
Control 1..1
Type Reference(Patient)
Is Modifier false
Summary true
Requirements

This is the party who receives treatment for which the costs are reimbursed under the coverage.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Coverage.beneficiary.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Short Literal reference, Relative, internal or absolute URL
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Control 10..1
This element is affected by the following invariants: ref-1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Coverage.dependent
Definition

A unique identifier for a dependent under the coverage.

Short Dependent number
Comments

Periodically the member number is constructed from the subscriberId and the dependant number.

Control 0..1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Requirements

For some coverages a single identifier is issued to the Subscriber and then a unique dependent number is issued to each beneficiary.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Coverage.relationship
Definition

The relationship of beneficiary (patient) to the subscriber.

Short Beneficiary relationship to the subscriber
Comments

Typically, an individual uses policies which are theirs (relationship='self') before policies owned by others.

Control 0..1
Binding Unless not suitable, these codes SHALL be taken from SubscriberRelationshipCodeshttp://hl7.org/fhir/ValueSet/subscriber-relationship|4.0.1
(extensible to http://hl7.org/fhir/ValueSet/subscriber-relationship|4.0.1)

The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).

Type CodeableConcept
Is Modifier false
Must Support true
Summary false
Requirements

To determine relationship between the patient and the subscriber to determine coordination of benefits.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Coverage.period
Definition

Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.

Short Coverage start and end dates
Control 0..1
Type Period
Is Modifier false
Must Support true
Summary true
Requirements

Some insurers require the submission of the coverage term.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Coverage.payor
Definition

The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.

Short Issuer of the policy
Comments

May provide multiple identifiers such as insurance company identifier or business identifier (BIN number). For selfpay it may provide multiple paying persons and/or organizations.

Control 1..*
Type Reference(Organization, Patient, RelatedPerson)
Is Modifier false
Summary true
Requirements

Need to identify the issuer to target for claim processing and for coordination of benefit processing.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. Coverage.payor.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Short Literal reference, Relative, internal or absolute URL
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Control 10..1
This element is affected by the following invariants: ref-1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. Coverage
2. Coverage.id
Control 1..?
4. Coverage.meta
6. Coverage.meta.extension:link-received-date-extension
Slice Name link-received-date-extension
Control 0..1
Type Extension(Received Date) (Extension Type: dateTime)
8. Coverage.type
Binding Unless not suitable, these codes SHALL be taken from Payer .
(extensible to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591)
Must Support true
10. Coverage.policyHolder
Must Support true
12. Coverage.policyHolder.reference
Control 1..?
Must Support true
14. Coverage.subscriber
Must Support true
16. Coverage.subscriber.reference
Control 1..?
Must Support true
18. Coverage.subscriberId
Must Support true
20. Coverage.beneficiary
22. Coverage.beneficiary.reference
Control 1..?
Must Support true
24. Coverage.dependent
Must Support true
26. Coverage.relationship
Must Support true
28. Coverage.period
Must Support true
30. Coverage.payor
32. Coverage.payor.reference
Control 1..?
Must Support true

Guidance on how to interpret the contents of this table can be foundhere

0. Coverage
Definition

Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.

Short Insurance or medical plan or a payment agreement
Comments

The Coverage resource contains the insurance card level information, which is customary to provide on claims and other communications between providers and insurers.

Control 0..*
Is Modifier false
Summary false
Invariants dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Coverage.id
Definition

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

Short Logical id of this artifact
Comments

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

Control 1..1
Type id
Is Modifier false
Summary true
4. Coverage.meta
Definition

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.

Short Metadata about the resource
Control 0..1
Type Meta
Is Modifier false
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Coverage.meta.id
Definition

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

Short Unique id for inter-element referencing
Control 0..1
Type string
Is Modifier false
XML Format In the XML format, this property is represented as an attribute.
Summary false
8. Coverage.meta.extension
Definition

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.

Short Additional content defined by implementations
Comments

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.

Control 0..*
Type Extension
Is Modifier false
Summary false
Alternate Names extensions, user content
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing This element introduces a set of slices on Coverage.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 10. Coverage.meta.extension:link-received-date-extension
    Slice Name link-received-date-extension
    Definition

    This extension stores the date and time a Resource was received by the processing system (e.g. NHSNLink).

    Short Received Date
    Control 0..1
    Type Extension(Received Date) (Extension Type: dateTime)
    Is Modifier false
    Summary false
    Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. Coverage.meta.versionId
    Definition

    The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

    Short Version specific identifier
    Comments

    The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

    Control 0..1
    Type id
    Is Modifier false
    Primitive Value This primitive element may be present, or absent, or replaced by an extension
    Summary true
    Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. Coverage.meta.lastUpdated
    Definition

    When the resource last changed - e.g. when the version changed.

    Short When the resource version last changed
    Comments

    This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

    Control 0..1
    Type instant
    Is Modifier false
    Primitive Value This primitive element may be present, or absent, or replaced by an extension
    Summary true
    Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. Coverage.meta.source
    Definition

    A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

    Short Identifies where the resource comes from
    Comments

    In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

    This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

    Control 0..1
    Type uri
    Is Modifier false
    Primitive Value This primitive element may be present, or absent, or replaced by an extension
    Summary true
    Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. Coverage.meta.profile
    Definition

    A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

    Short Profiles this resource claims to conform to
    Comments

    It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

    Control 0..*
    Type canonical(StructureDefinition)
    Is Modifier false
    Primitive Value This primitive element may be present, or absent, or replaced by an extension
    Summary true
    Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    20. Coverage.meta.security
    Definition

    Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

    Short Security Labels applied to this resource
    Comments

    The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

    Control 0..*
    Binding Unless not suitable, these codes SHALL be taken from All Security Labels
    (extensible to http://hl7.org/fhir/ValueSet/security-labels|4.0.1)

    Security Labels from the Healthcare Privacy and Security Classification System.

    Type Coding
    Is Modifier false
    Summary true
    Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. Coverage.meta.tag
    Definition

    Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

    Short Tags applied to this resource
    Comments

    The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

    Control 0..*
    Binding For example codes, see CommonTags
    (example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)

    Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

    Type Coding
    Is Modifier false
    Summary true
    Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    24. Coverage.implicitRules
    Definition

    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.

    Short A set of rules under which this content was created
    Comments

    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.

    Control 0..1
    Type uri
    Is Modifier true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
    Primitive Value This primitive element may be present, or absent, or replaced by an extension
    Summary true
    Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    26. Coverage.language
    Definition

    The base language in which the resource is written.

    Short Language of the resource content
    Comments

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

    Control 0..1
    Binding The codes SHOULD be taken from CommonLanguages
    (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

    A human language.

    Additional Bindings Purpose
    AllLanguages Max Binding
    Type code
    Is Modifier false
    Primitive Value This primitive element may be present, or absent, or replaced by an extension
    Summary false
    Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    28. Coverage.text
    Definition

    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.

    Short Text summary of the resource, for human interpretation
    Comments

    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.

    Control 0..1
    Type Narrative
    Is Modifier false
    Summary false
    Alternate Names narrative, html, xhtml, display
    Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    30. Coverage.contained
    Definition

    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.

    Short Contained, inline Resources
    Comments

    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.

    Control 0..*
    Type Resource
    Is Modifier false
    Summary false
    Alternate Names inline resources, anonymous resources, contained resources
    32. Coverage.extension
    Definition

    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.

    Short Additional content defined by implementations
    Comments

    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.

    Control 0..*
    Type Extension
    Is Modifier false
    Summary false
    Alternate Names extensions, user content
    Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    34. Coverage.modifierExtension
    Definition

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

    Short Extensions that cannot be ignored
    Comments

    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.

    Control 0..*
    Type Extension
    Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Summary false
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Names extensions, user content
    Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    36. Coverage.identifier
    Definition

    A unique identifier assigned to this coverage.

    Short Business Identifier for the coverage
    Comments

    The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatenation of the Coverage.SubscriberID and the Coverage.dependant.

    Note This is a business identifier, not a resource identifier (see discussion)
    Control 0..*
    Type Identifier
    Is Modifier false
    Summary true
    Requirements

    Allows coverages to be distinguished and referenced.

    Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    38. Coverage.status
    Definition

    The status of the resource instance.

    Short active | cancelled | draft | entered-in-error
    Comments

    This element is labeled as a modifier because the status contains the code entered-in-error that marks the coverage as not currently valid.

    Control 1..1
    Binding The codes SHALL be taken from FinancialResourceStatusCodes
    (required to http://hl7.org/fhir/ValueSet/fm-status|4.0.1)

    A code specifying the state of the resource instance.

    Type code
    Is Modifier true because This element is labelled 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
    Primitive Value This primitive element may be present, or absent, or replaced by an extension
    Summary true
    Requirements

    Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.

    Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. Coverage.type
    Definition

    The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.

    Short Coverage category such as medical or accident
    Control 0..1
    Binding Unless not suitable, these codes SHALL be taken from Payer .
    (extensible to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591)
    Type CodeableConcept
    Is Modifier false
    Must Support true
    Summary true
    Requirements

    The order of application of coverages is dependent on the types of coverage.

    Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    42. Coverage.policyHolder
    Definition

    The party who 'owns' the insurance policy.

    Short Owner of the policy
    Comments

    For example: may be an individual, corporation or the subscriber's employer.

    Control 0..1
    Type Reference(Patient, RelatedPerson, Organization)
    Is Modifier false
    Must Support true
    Must Support Types No must-support rules about the choice of types/profiles
    Summary true
    Requirements

    This provides employer information in the case of Worker's Compensation and other policies.

    Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    44. Coverage.policyHolder.id
    Definition

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

    Short Unique id for inter-element referencing
    Control 0..1
    Type string
    Is Modifier false
    XML Format In the XML format, this property is represented as an attribute.
    Summary false
    46. Coverage.policyHolder.extension
    Definition

    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.

    Short Additional content defined by implementations
    Comments

    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.

    Control 0..*
    Type Extension
    Is Modifier false
    Summary false
    Alternate Names extensions, user content
    Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    Slicing This element introduces a set of slices on Coverage.policyHolder.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 48. Coverage.policyHolder.reference
      Definition

      A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

      Short Literal reference, Relative, internal or absolute URL
      Comments

      Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

      Control 1..1
      This element is affected by the following invariants: ref-1
      Type string
      Is Modifier false
      Primitive Value This primitive element may be present, or absent, or replaced by an extension
      Must Support true
      Summary true
      Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      50. Coverage.policyHolder.type
      Definition

      The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

      The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

      Short Type the reference refers to (e.g. "Patient")
      Comments

      This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

      Control 0..1
      Binding Unless not suitable, these codes SHALL be taken from ResourceType
      (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

      Aa resource (or, for logical models, the URI of the logical model).

      Type uri
      Is Modifier false
      Primitive Value This primitive element may be present, or absent, or replaced by an extension
      Summary true
      Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      52. Coverage.policyHolder.identifier
      Definition

      An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

      Short Logical reference, when literal reference is not known
      Comments

      When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

      When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

      Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

      Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

      Note This is a business identifier, not a resource identifier (see discussion)
      Control 0..1
      Type Identifier
      Is Modifier false
      Summary true
      Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      54. Coverage.policyHolder.display
      Definition

      Plain text narrative that identifies the resource in addition to the resource reference.

      Short Text alternative for the resource
      Comments

      This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

      Control 0..1
      Type string
      Is Modifier false
      Primitive Value This primitive element may be present, or absent, or replaced by an extension
      Summary true
      Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      56. Coverage.subscriber
      Definition

      The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.

      Short Subscriber to the policy
      Comments

      May be self or a parent in the case of dependants.

      Control 0..1
      Type Reference(Patient, RelatedPerson)
      Is Modifier false
      Must Support true
      Must Support Types No must-support rules about the choice of types/profiles
      Summary true
      Requirements

      This is the party who is entitled to the benfits under the policy.

      Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      58. Coverage.subscriber.id
      Definition

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

      Short Unique id for inter-element referencing
      Control 0..1
      Type string
      Is Modifier false
      XML Format In the XML format, this property is represented as an attribute.
      Summary false
      60. Coverage.subscriber.extension
      Definition

      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.

      Short Additional content defined by implementations
      Comments

      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.

      Control 0..*
      Type Extension
      Is Modifier false
      Summary false
      Alternate Names extensions, user content
      Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      Slicing This element introduces a set of slices on Coverage.subscriber.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 62. Coverage.subscriber.reference
        Definition

        A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

        Short Literal reference, Relative, internal or absolute URL
        Comments

        Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

        Control 1..1
        This element is affected by the following invariants: ref-1
        Type string
        Is Modifier false
        Primitive Value This primitive element may be present, or absent, or replaced by an extension
        Must Support true
        Summary true
        Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        64. Coverage.subscriber.type
        Definition

        The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

        The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

        Short Type the reference refers to (e.g. "Patient")
        Comments

        This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

        Control 0..1
        Binding Unless not suitable, these codes SHALL be taken from ResourceType
        (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

        Aa resource (or, for logical models, the URI of the logical model).

        Type uri
        Is Modifier false
        Primitive Value This primitive element may be present, or absent, or replaced by an extension
        Summary true
        Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        66. Coverage.subscriber.identifier
        Definition

        An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

        Short Logical reference, when literal reference is not known
        Comments

        When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

        When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

        Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

        Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

        Note This is a business identifier, not a resource identifier (see discussion)
        Control 0..1
        Type Identifier
        Is Modifier false
        Summary true
        Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        68. Coverage.subscriber.display
        Definition

        Plain text narrative that identifies the resource in addition to the resource reference.

        Short Text alternative for the resource
        Comments

        This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

        Control 0..1
        Type string
        Is Modifier false
        Primitive Value This primitive element may be present, or absent, or replaced by an extension
        Summary true
        Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        70. Coverage.subscriberId
        Definition

        The insurer assigned ID for the Subscriber.

        Short ID assigned to the subscriber
        Control 0..1
        Type string
        Is Modifier false
        Primitive Value This primitive element may be present, or absent, or replaced by an extension
        Must Support true
        Summary true
        Requirements

        The insurer requires this identifier on correspondance and claims (digital and otherwise).

        Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        72. Coverage.beneficiary
        Definition

        The party who benefits from the insurance coverage; the patient when products and/or services are provided.

        Short Plan beneficiary
        Control 1..1
        Type Reference(Patient)
        Is Modifier false
        Summary true
        Requirements

        This is the party who receives treatment for which the costs are reimbursed under the coverage.

        Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        74. Coverage.beneficiary.id
        Definition

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

        Short Unique id for inter-element referencing
        Control 0..1
        Type string
        Is Modifier false
        XML Format In the XML format, this property is represented as an attribute.
        Summary false
        76. Coverage.beneficiary.extension
        Definition

        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.

        Short Additional content defined by implementations
        Comments

        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.

        Control 0..*
        Type Extension
        Is Modifier false
        Summary false
        Alternate Names extensions, user content
        Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        Slicing This element introduces a set of slices on Coverage.beneficiary.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 78. Coverage.beneficiary.reference
          Definition

          A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

          Short Literal reference, Relative, internal or absolute URL
          Comments

          Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

          Control 1..1
          This element is affected by the following invariants: ref-1
          Type string
          Is Modifier false
          Primitive Value This primitive element may be present, or absent, or replaced by an extension
          Must Support true
          Summary true
          Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          80. Coverage.beneficiary.type
          Definition

          The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

          The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

          Short Type the reference refers to (e.g. "Patient")
          Comments

          This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

          Control 0..1
          Binding Unless not suitable, these codes SHALL be taken from ResourceType
          (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

          Aa resource (or, for logical models, the URI of the logical model).

          Type uri
          Is Modifier false
          Primitive Value This primitive element may be present, or absent, or replaced by an extension
          Summary true
          Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          82. Coverage.beneficiary.identifier
          Definition

          An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

          Short Logical reference, when literal reference is not known
          Comments

          When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

          When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

          Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

          Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

          Note This is a business identifier, not a resource identifier (see discussion)
          Control 0..1
          Type Identifier
          Is Modifier false
          Summary true
          Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          84. Coverage.beneficiary.display
          Definition

          Plain text narrative that identifies the resource in addition to the resource reference.

          Short Text alternative for the resource
          Comments

          This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

          Control 0..1
          Type string
          Is Modifier false
          Primitive Value This primitive element may be present, or absent, or replaced by an extension
          Summary true
          Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          86. Coverage.dependent
          Definition

          A unique identifier for a dependent under the coverage.

          Short Dependent number
          Comments

          Periodically the member number is constructed from the subscriberId and the dependant number.

          Control 0..1
          Type string
          Is Modifier false
          Primitive Value This primitive element may be present, or absent, or replaced by an extension
          Must Support true
          Summary true
          Requirements

          For some coverages a single identifier is issued to the Subscriber and then a unique dependent number is issued to each beneficiary.

          Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          88. Coverage.relationship
          Definition

          The relationship of beneficiary (patient) to the subscriber.

          Short Beneficiary relationship to the subscriber
          Comments

          Typically, an individual uses policies which are theirs (relationship='self') before policies owned by others.

          Control 0..1
          Binding Unless not suitable, these codes SHALL be taken from SubscriberRelationshipCodes
          (extensible to http://hl7.org/fhir/ValueSet/subscriber-relationship|4.0.1)

          The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).

          Type CodeableConcept
          Is Modifier false
          Must Support true
          Summary false
          Requirements

          To determine relationship between the patient and the subscriber to determine coordination of benefits.

          Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          90. Coverage.period
          Definition

          Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.

          Short Coverage start and end dates
          Control 0..1
          Type Period
          Is Modifier false
          Must Support true
          Summary true
          Requirements

          Some insurers require the submission of the coverage term.

          Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          92. Coverage.payor
          Definition

          The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.

          Short Issuer of the policy
          Comments

          May provide multiple identifiers such as insurance company identifier or business identifier (BIN number). For selfpay it may provide multiple paying persons and/or organizations.

          Control 1..*
          Type Reference(Organization, Patient, RelatedPerson)
          Is Modifier false
          Summary true
          Requirements

          Need to identify the issuer to target for claim processing and for coordination of benefit processing.

          Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          94. Coverage.payor.id
          Definition

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

          Short Unique id for inter-element referencing
          Control 0..1
          Type string
          Is Modifier false
          XML Format In the XML format, this property is represented as an attribute.
          Summary false
          96. Coverage.payor.extension
          Definition

          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.

          Short Additional content defined by implementations
          Comments

          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.

          Control 0..*
          Type Extension
          Is Modifier false
          Summary false
          Alternate Names extensions, user content
          Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          Slicing This element introduces a set of slices on Coverage.payor.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 98. Coverage.payor.reference
            Definition

            A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

            Short Literal reference, Relative, internal or absolute URL
            Comments

            Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

            Control 1..1
            This element is affected by the following invariants: ref-1
            Type string
            Is Modifier false
            Primitive Value This primitive element may be present, or absent, or replaced by an extension
            Must Support true
            Summary true
            Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            100. Coverage.payor.type
            Definition

            The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

            The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

            Short Type the reference refers to (e.g. "Patient")
            Comments

            This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

            Control 0..1
            Binding Unless not suitable, these codes SHALL be taken from ResourceType
            (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

            Aa resource (or, for logical models, the URI of the logical model).

            Type uri
            Is Modifier false
            Primitive Value This primitive element may be present, or absent, or replaced by an extension
            Summary true
            Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            102. Coverage.payor.identifier
            Definition

            An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

            Short Logical reference, when literal reference is not known
            Comments

            When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

            When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

            Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

            Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

            Note This is a business identifier, not a resource identifier (see discussion)
            Control 0..1
            Type Identifier
            Is Modifier false
            Summary true
            Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            104. Coverage.payor.display
            Definition

            Plain text narrative that identifies the resource in addition to the resource reference.

            Short Text alternative for the resource
            Comments

            This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

            Control 0..1
            Type string
            Is Modifier false
            Primitive Value This primitive element may be present, or absent, or replaced by an extension
            Summary true
            Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            106. Coverage.class
            Definition

            A suite of underwriter specific classifiers.

            Short Additional coverage classifications
            Comments

            For example may be used to identify a class of coverage or employer group, Policy, Plan.

            Control 0..*
            Type BackboneElement
            Is Modifier false
            Summary false
            Requirements

            The codes provided on the health card which identify or confirm the specific policy for the insurer.

            Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            108. Coverage.class.id
            Definition

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

            Short Unique id for inter-element referencing
            Control 0..1
            Type string
            Is Modifier false
            XML Format In the XML format, this property is represented as an attribute.
            Summary false
            110. Coverage.class.extension
            Definition

            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.

            Short Additional content defined by implementations
            Comments

            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.

            Control 0..*
            Type Extension
            Is Modifier false
            Summary false
            Alternate Names extensions, user content
            Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            112. Coverage.class.modifierExtension
            Definition

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

            Short Extensions that cannot be ignored even if unrecognized
            Comments

            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.

            Control 0..*
            Type Extension
            Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
            Summary true
            Requirements

            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

            Alternate Names extensions, user content, modifiers
            Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            114. Coverage.class.type
            Definition

            The type of classification for which an insurer-specific class label or number and optional name is provided, for example may be used to identify a class of coverage or employer group, Policy, Plan.

            Short Type of class such as 'group' or 'plan'
            Control 1..1
            Binding Unless not suitable, these codes SHALL be taken from CoverageClassCodes
            (extensible to http://hl7.org/fhir/ValueSet/coverage-class|4.0.1)

            The policy classifications, eg. Group, Plan, Class, etc.

            Type CodeableConcept
            Is Modifier false
            Summary true
            Requirements

            The insurer issued label for a specific health card value.

            Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            116. Coverage.class.value
            Definition

            The alphanumeric string value associated with the insurer issued label.

            Short Value associated with the type
            Comments

            For example, the Group or Plan number.

            Control 1..1
            Type string
            Is Modifier false
            Primitive Value This primitive element may be present, or absent, or replaced by an extension
            Summary true
            Requirements

            The insurer issued label and value are necessary to identify the specific policy.

            Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            118. Coverage.class.name
            Definition

            A short description for the class.

            Short Human readable description of the type and value
            Control 0..1
            Type string
            Is Modifier false
            Primitive Value This primitive element may be present, or absent, or replaced by an extension
            Summary true
            Requirements

            Used to provide a meaningful description in correspondence to the patient.

            Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            120. Coverage.order
            Definition

            The order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care.

            Short Relative order of the coverage
            Control 0..1
            Type positiveInt
            Is Modifier false
            Primitive Value This primitive element may be present, or absent, or replaced by an extension
            Summary true
            Requirements

            Used in managing the coordination of benefits.

            Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            122. Coverage.network
            Definition

            The insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply.

            Short Insurer network
            Control 0..1
            Type string
            Is Modifier false
            Primitive Value This primitive element may be present, or absent, or replaced by an extension
            Summary true
            Requirements

            Used in referral for treatment and in claims processing.

            Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            124. Coverage.costToBeneficiary
            Definition

            A suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card.

            Short Patient payments for services/products
            Comments

            For example by knowing the patient visit co-pay, the provider can collect the amount prior to undertaking treatment.

            Control 0..*
            Type BackboneElement
            Is Modifier false
            Summary false
            Requirements

            Required by providers to manage financial transaction with the patient.

            Alternate Names CoPay, Deductible, Exceptions
            Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            126. Coverage.costToBeneficiary.id
            Definition

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

            Short Unique id for inter-element referencing
            Control 0..1
            Type string
            Is Modifier false
            XML Format In the XML format, this property is represented as an attribute.
            Summary false
            128. Coverage.costToBeneficiary.extension
            Definition

            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.

            Short Additional content defined by implementations
            Comments

            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.

            Control 0..*
            Type Extension
            Is Modifier false
            Summary false
            Alternate Names extensions, user content
            Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            130. Coverage.costToBeneficiary.modifierExtension
            Definition

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

            Short Extensions that cannot be ignored even if unrecognized
            Comments

            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.

            Control 0..*
            Type Extension
            Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
            Summary true
            Requirements

            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

            Alternate Names extensions, user content, modifiers
            Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            132. Coverage.costToBeneficiary.type
            Definition

            The category of patient centric costs associated with treatment.

            Short Cost category
            Comments

            For example visit, specialist visits, emergency, inpatient care, etc.

            Control 0..1
            Binding Unless not suitable, these codes SHALL be taken from CoverageCopayTypeCodes
            (extensible to http://hl7.org/fhir/ValueSet/coverage-copay-type|4.0.1)

            The types of services to which patient copayments are specified.

            Type CodeableConcept
            Is Modifier false
            Summary true
            Requirements

            Needed to identify the category associated with the amount for the patient.

            Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            134. Coverage.costToBeneficiary.value[x]
            Definition

            The amount due from the patient for the cost category.

            Short The amount or percentage due from the beneficiary
            Comments

            Amount may be expressed as a percentage of the service/product cost or a fixed amount of currency.

            Control 1..1
            Type Choice of: Quantity(SimpleQuantity), Money
            [x] Note SeeChoice of Data Typesfor further information about how to use [x]
            Is Modifier false
            Summary true
            Requirements

            Needed to identify the amount for the patient associated with the category.

            Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            136. Coverage.costToBeneficiary.exception
            Definition

            A suite of codes indicating exceptions or reductions to patient costs and their effective periods.

            Short Exceptions for patient payments
            Control 0..*
            Type BackboneElement
            Is Modifier false
            Summary false
            Requirements

            Required by providers to manage financial transaction with the patient.

            Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            138. Coverage.costToBeneficiary.exception.id
            Definition

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

            Short Unique id for inter-element referencing
            Control 0..1
            Type string
            Is Modifier false
            XML Format In the XML format, this property is represented as an attribute.
            Summary false
            140. Coverage.costToBeneficiary.exception.extension
            Definition

            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.

            Short Additional content defined by implementations
            Comments

            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.

            Control 0..*
            Type Extension
            Is Modifier false
            Summary false
            Alternate Names extensions, user content
            Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            142. Coverage.costToBeneficiary.exception.modifierExtension
            Definition

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

            Short Extensions that cannot be ignored even if unrecognized
            Comments

            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.

            Control 0..*
            Type Extension
            Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
            Summary true
            Requirements

            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

            Alternate Names extensions, user content, modifiers
            Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            144. Coverage.costToBeneficiary.exception.type
            Definition

            The code for the specific exception.

            Short Exception category
            Control 1..1
            Binding For example codes, see ExampleCoverageFinancialExceptionCodes
            (example to http://hl7.org/fhir/ValueSet/coverage-financial-exception|4.0.1)

            The types of exceptions from the part or full value of financial obligations such as copays.

            Type CodeableConcept
            Is Modifier false
            Summary true
            Requirements

            Needed to identify the exception associated with the amount for the patient.

            Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            146. Coverage.costToBeneficiary.exception.period
            Definition

            The timeframe during when the exception is in force.

            Short The effective period of the exception
            Control 0..1
            Type Period
            Is Modifier false
            Summary true
            Requirements

            Needed to identify the applicable timeframe for the exception for the correct calculation of patient costs.

            Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            148. Coverage.subrogation
            Definition

            When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.

            Short Reimbursement to insurer
            Comments

            Typically, automotive and worker's compensation policies would be flagged with 'subrogation=true' to enable healthcare payors to collect against accident claims.

            Control 0..1
            Type boolean
            Is Modifier false
            Primitive Value This primitive element may be present, or absent, or replaced by an extension
            Summary false
            Requirements

            See definition for when to be used.

            Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            150. Coverage.contract
            Definition

            The policy(s) which constitute this insurance coverage.

            Short Contract details
            Control 0..*
            Type Reference(Contract)
            Is Modifier false
            Summary false
            Requirements

            To reference the legally binding contract between the policy holder and the insurer.

            Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))