Extensions for Using Data Elements from FHIR DSTU2 in FHIR R4B
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR DSTU2 in FHIR R4B - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R2_Coverage_R4B - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-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.

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

Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdom-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.exists() and ('#'+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(uri) = '#').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())
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.exists() and ('#'+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(uri) = '#').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.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.

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

Control0..1
Typeuri
Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Coverage.extension
Definition

An Extension


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.

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

Control0..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
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())
SlicingThis element introduces a set of slices on Coverage.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. Coverage.extension:group
    Slice Namegroup
    Definition

    DSTU2: Coverage.group (new:string)

    ShortDSTU2: An identifier for the group (new)
    Comments

    Element Coverage.group has a context of Coverage based on following the parent source element upwards and mapping to Coverage. Element Coverage.group has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(DSTU2: An identifier for the group (new)) (Extension Type: string)
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    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.extension:plan
    Slice Nameplan
    Definition

    DSTU2: Coverage.plan (new:string)

    ShortDSTU2: An identifier for the plan (new)
    Comments

    Element Coverage.plan has a context of Coverage based on following the parent source element upwards and mapping to Coverage. Element Coverage.plan has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(DSTU2: An identifier for the plan (new)) (Extension Type: string)
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    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())
    10. Coverage.extension:subPlan
    Slice NamesubPlan
    Definition

    DSTU2: Coverage.subPlan (new:string)

    ShortDSTU2: An identifier for the subsection of the plan (new)
    Comments

    Element Coverage.subPlan has a context of Coverage based on following the parent source element upwards and mapping to Coverage. Element Coverage.subPlan has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(DSTU2: An identifier for the subsection of the plan (new)) (Extension Type: string)
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    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.extension:sequence
    Slice Namesequence
    Definition

    DSTU2: Coverage.sequence (new:positiveInt)

    ShortDSTU2: The plan instance or sequence counter (new)
    Comments

    Element Coverage.sequence has a context of Coverage based on following the parent source element upwards and mapping to Coverage. Element Coverage.sequence has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(DSTU2: The plan instance or sequence counter (new)) (Extension Type: positiveInt)
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    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())
    14. 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).

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

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Must Supportfalse
    Summaryfalse
    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 Namesextensions, user content
    Invariantsele-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())
    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())
    16. Coverage.status
    Definition

    The status of the resource instance.

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

    Control1..1
    BindingThe codes SHALL be taken from FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|4.3.0
    (required to http://hl7.org/fhir/ValueSet/fm-status|4.3.0)

    A code specifying the state of the resource instance.

    Typecode
    Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summarytrue
    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'.

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

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

    ShortPlan beneficiary
    Control1..1
    TypeReference(Patient)
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Requirements

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

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

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

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

    Control1..*
    TypeReference(Organization, Patient, RelatedPerson)
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Requirements

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

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

    An Extension


    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.

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

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-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())
    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())
    SlicingThis 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
    • 24. Coverage.payor.extension:issuer
      Slice Nameissuer
      Definition

      DSTU2: Coverage.issuer additional types from child elements (display, reference)

      ShortDSTU2: An identifier for the plan issuer additional types
      Comments

      Element Coverage.issuer is mapped to FHIR R4B element Coverage.payor as RelatedTo. The mappings for Coverage.issuer do not cover the following types based on type expansion: display, reference. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element Coverage.issuer with unmapped reference targets: Organization.

      Control0..1
      TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
      Is Modifierfalse
      Summaryfalse
      Invariantsele-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())
      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())

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

      0. Coverage
      2. Coverage.meta
      4. Coverage.meta.extension
      Control0..*
      SlicingThis 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
      • 6. Coverage.meta.extension:meta
        Slice Namemeta
        Definition

        DSTU2: Coverage.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, tag, versionId)

        ShortDSTU2: meta additional types
        Comments

        Element Coverage.meta is mapped to FHIR R4B element Coverage.meta as SourceIsBroaderThanTarget. The mappings for Coverage.meta do not cover the following types: Meta. The mappings for Coverage.meta do not cover the following types based on type expansion: lastUpdated, profile, security, tag, versionId.

        Control0..1
        TypeExtension(DSTU2: meta additional types) (Complex Extension)
        8. Coverage.text
        10. Coverage.text.extension
        Control0..*
        SlicingThis element introduces a set of slices on Coverage.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 12. Coverage.text.extension:text
          Slice Nametext
          Definition

          DSTU2: Coverage.text additional types (Narrative) additional types from child elements (div, status)

          ShortDSTU2: text additional types
          Comments

          Element Coverage.text is mapped to FHIR R4B element Coverage.text as SourceIsBroaderThanTarget. The mappings for Coverage.text do not cover the following types: Narrative. The mappings for Coverage.text do not cover the following types based on type expansion: div, status. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

          Control0..1
          TypeExtension(DSTU2: text additional types) (Complex Extension)
          14. Coverage.extension
          Control0..*
          SlicingThis element introduces a set of slices on Coverage.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 16. Coverage.extension:group
            Slice Namegroup
            Definition

            DSTU2: Coverage.group (new:string)

            ShortDSTU2: An identifier for the group (new)
            Comments

            Element Coverage.group has a context of Coverage based on following the parent source element upwards and mapping to Coverage. Element Coverage.group has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

            Control0..1
            TypeExtension(DSTU2: An identifier for the group (new)) (Extension Type: string)
            18. Coverage.extension:plan
            Slice Nameplan
            Definition

            DSTU2: Coverage.plan (new:string)

            ShortDSTU2: An identifier for the plan (new)
            Comments

            Element Coverage.plan has a context of Coverage based on following the parent source element upwards and mapping to Coverage. Element Coverage.plan has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

            Control0..1
            TypeExtension(DSTU2: An identifier for the plan (new)) (Extension Type: string)
            20. Coverage.extension:subPlan
            Slice NamesubPlan
            Definition

            DSTU2: Coverage.subPlan (new:string)

            ShortDSTU2: An identifier for the subsection of the plan (new)
            Comments

            Element Coverage.subPlan has a context of Coverage based on following the parent source element upwards and mapping to Coverage. Element Coverage.subPlan has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

            Control0..1
            TypeExtension(DSTU2: An identifier for the subsection of the plan (new)) (Extension Type: string)
            22. Coverage.extension:sequence
            Slice Namesequence
            Definition

            DSTU2: Coverage.sequence (new:positiveInt)

            ShortDSTU2: The plan instance or sequence counter (new)
            Comments

            Element Coverage.sequence has a context of Coverage based on following the parent source element upwards and mapping to Coverage. Element Coverage.sequence has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

            Control0..1
            TypeExtension(DSTU2: The plan instance or sequence counter (new)) (Extension Type: positiveInt)
            24. Coverage.identifier
            NoteThis is a business identifier, not a resource identifier (see discussion)
            26. Coverage.identifier.extension
            Control0..*
            SlicingThis element introduces a set of slices on Coverage.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 28. Coverage.identifier.extension:bin
              Slice Namebin
              Definition

              DSTU2: Coverage.bin additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

              ShortDSTU2: BIN Number additional types
              Comments

              Element Coverage.bin is mapped to FHIR R4B element Coverage.identifier as RelatedTo. The mappings for Coverage.bin do not cover the following types: Identifier. The mappings for Coverage.bin do not cover the following types based on type expansion: assigner, period, system, type, use, value.

              Control0..1
              TypeExtension(DSTU2: BIN Number additional types) (Extension Type: Identifier)
              30. Coverage.identifier.extension:identifier
              Slice Nameidentifier
              Definition

              DSTU2: Coverage.identifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

              ShortDSTU2: The primary coverage ID additional types
              Comments

              Element Coverage.identifier is mapped to FHIR R4B element Coverage.identifier as SourceIsBroaderThanTarget. The mappings for Coverage.identifier do not cover the following types: Identifier. The mappings for Coverage.identifier do not cover the following types based on type expansion: assigner, period, system, type, use, value.

              Control0..*
              TypeExtension(DSTU2: The primary coverage ID additional types) (Extension Type: Identifier)
              32. Coverage.subscriber
              34. Coverage.subscriber.modifierExtension
              Control0..*
              SlicingThis element introduces a set of slices on Coverage.subscriber.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 36. Coverage.subscriber.modifierExtension:subscriber
                Slice Namesubscriber
                Definition

                DSTU2: Coverage.subscriber additional types from child elements (display, reference)

                ShortDSTU2: Plan holder information additional types
                Comments

                Element Coverage.subscriber is mapped to FHIR R4B element Coverage.subscriber as SourceIsBroaderThanTarget. The mappings for Coverage.subscriber do not cover the following types based on type expansion: display, reference. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element Coverage.subscriber with unmapped reference targets: Patient.

                Control0..1
                TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                38. Coverage.subscriberId
                40. Coverage.subscriberId.extension
                Control0..*
                SlicingThis element introduces a set of slices on Coverage.subscriberId.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 42. Coverage.subscriberId.extension:subscriberId
                  Slice NamesubscriberId
                  Definition

                  DSTU2: Coverage.subscriberId additional types (Identifier) additional types from child elements (assigner, period, type)

                  ShortDSTU2: Subscriber ID additional types
                  Comments

                  Element Coverage.subscriberId is mapped to FHIR R4B element Coverage.subscriberId as SourceIsBroaderThanTarget. The mappings for Coverage.subscriberId do not cover the following types: Identifier. The mappings for Coverage.subscriberId do not cover the following types based on type expansion: assigner, period, type.

                  Control0..1
                  TypeExtension(DSTU2: Subscriber ID additional types) (Extension Type: Identifier)
                  44. Coverage.dependent
                  46. Coverage.dependent.extension
                  Control0..*
                  SlicingThis element introduces a set of slices on Coverage.dependent.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 48. Coverage.dependent.extension:dependent
                    Slice Namedependent
                    Definition

                    DSTU2: Coverage.dependent additional types (positiveInt) additional types from child elements (value)

                    ShortDSTU2: The dependent number additional types
                    Comments

                    Element Coverage.dependent is mapped to FHIR R4B element Coverage.dependent as SourceIsBroaderThanTarget. The mappings for Coverage.dependent do not cover the following types: positiveInt. The mappings for Coverage.dependent do not cover the following types based on type expansion: value.

                    Control0..1
                    TypeExtension(DSTU2: The dependent number additional types) (Extension Type: positiveInt)
                    50. Coverage.period
                    52. Coverage.period.extension
                    Control0..*
                    SlicingThis element introduces a set of slices on Coverage.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 54. Coverage.period.extension:period
                      Slice Nameperiod
                      Definition

                      DSTU2: Coverage.period additional types (Period) additional types from child elements (end, start)

                      ShortDSTU2: period additional types
                      Comments

                      Element Coverage.period is mapped to FHIR R4B element Coverage.period as SourceIsBroaderThanTarget. The mappings for Coverage.period do not cover the following types: Period. The mappings for Coverage.period do not cover the following types based on type expansion: end, start.

                      Control0..1
                      TypeExtension(DSTU2: period additional types) (Extension Type: Period)
                      56. Coverage.payor
                      58. Coverage.payor.extension
                      Control0..*
                      SlicingThis 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
                      • 60. Coverage.payor.extension:issuer
                        Slice Nameissuer
                        Definition

                        DSTU2: Coverage.issuer additional types from child elements (display, reference)

                        ShortDSTU2: An identifier for the plan issuer additional types
                        Comments

                        Element Coverage.issuer is mapped to FHIR R4B element Coverage.payor as RelatedTo. The mappings for Coverage.issuer do not cover the following types based on type expansion: display, reference. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element Coverage.issuer with unmapped reference targets: Organization.

                        Control0..1
                        TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                        62. Coverage.network
                        64. Coverage.network.extension
                        Control0..*
                        SlicingThis element introduces a set of slices on Coverage.network.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 66. Coverage.network.extension:network
                          Slice Namenetwork
                          Definition

                          DSTU2: Coverage.network additional types (Identifier) additional types from child elements (assigner, period, type)

                          ShortDSTU2: network additional types
                          Comments

                          Element Coverage.network is mapped to FHIR R4B element Coverage.network as SourceIsBroaderThanTarget. The mappings for Coverage.network do not cover the following types: Identifier. The mappings for Coverage.network do not cover the following types based on type expansion: assigner, period, type.

                          Control0..1
                          TypeExtension(DSTU2: network additional types) (Extension Type: Identifier)
                          68. Coverage.contract
                          70. Coverage.contract.extension
                          Control0..*
                          SlicingThis element introduces a set of slices on Coverage.contract.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 72. Coverage.contract.extension:contract
                            Slice Namecontract
                            Definition

                            DSTU2: Coverage.contract additional types from child elements (display, reference)

                            ShortDSTU2: contract additional types
                            Comments

                            Element Coverage.contract is mapped to FHIR R4B element Coverage.contract as SourceIsBroaderThanTarget. The mappings for Coverage.contract do not cover the following types based on type expansion: display, reference. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element Coverage.contract with unmapped reference targets: Contract.

                            Control0..*
                            TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))

                            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.

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

                            Control0..*
                            Is Modifierfalse
                            Must Supportfalse
                            Summaryfalse
                            Invariantsdom-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.exists() and ('#'+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(uri) = '#').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.

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

                            Control0..1
                            Typeid
                            Is Modifierfalse
                            Must Supportfalse
                            Summarytrue
                            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.

                            ShortMetadata about the resource
                            Control0..1
                            TypeMeta
                            Is Modifierfalse
                            Must Supportfalse
                            Summarytrue
                            Invariantsele-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.

                            ShortUnique id for inter-element referencing
                            Control0..1
                            Typeid
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            8. Coverage.meta.extension
                            Definition

                            An Extension

                            ShortExtension
                            Control0..*
                            TypeExtension
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-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())
                            SlicingThis 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:meta
                              Slice Namemeta
                              Definition

                              DSTU2: Coverage.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, tag, versionId)

                              ShortDSTU2: meta additional types
                              Comments

                              Element Coverage.meta is mapped to FHIR R4B element Coverage.meta as SourceIsBroaderThanTarget. The mappings for Coverage.meta do not cover the following types: Meta. The mappings for Coverage.meta do not cover the following types based on type expansion: lastUpdated, profile, security, tag, versionId.

                              Control0..1
                              TypeExtension(DSTU2: meta additional types) (Complex Extension)
                              Is Modifierfalse
                              Invariantsele-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.

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

                              Control0..1
                              Typeid
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Invariantsele-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.

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

                              Control0..1
                              Typeinstant
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Invariantsele-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.

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

                              Control0..1
                              Typeuri
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Invariantsele-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.

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

                              Control0..*
                              Typecanonical(StructureDefinition)
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Invariantsele-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.

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

                              Control0..*
                              BindingUnless not suitable, these codes SHALL be taken from All Security Labels
                              (extensible to http://hl7.org/fhir/ValueSet/security-labels|4.3.0)
                              TypeCoding
                              Is Modifierfalse
                              Summarytrue
                              Invariantsele-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.

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

                              Control0..*
                              BindingFor example codes, see CommonTags
                              (example to http://hl7.org/fhir/ValueSet/common-tags|4.3.0)
                              TypeCoding
                              Is Modifierfalse
                              Summarytrue
                              Invariantsele-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.

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

                              Control0..1
                              Typeuri
                              Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
                              Must Supportfalse
                              Summarytrue
                              Invariantsele-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.

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

                              Control0..1
                              BindingThe codes SHOULD be taken from CommonLanguages
                              (preferred to http://hl7.org/fhir/ValueSet/languages|4.3.0)

                              IETF language tag

                              Additional BindingsPurpose
                              AllLanguagesMax Binding
                              Typecode
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Must Supportfalse
                              Summaryfalse
                              Invariantsele-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.

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

                              Control0..1
                              TypeNarrative
                              Is Modifierfalse
                              Must Supportfalse
                              Summaryfalse
                              Alternate Namesnarrative, html, xhtml, display
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              30. Coverage.text.id
                              Definition

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

                              ShortUnique id for inter-element referencing
                              Control0..1
                              Typeid
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              32. Coverage.text.extension
                              Definition

                              An Extension

                              ShortExtension
                              Control0..*
                              TypeExtension
                              Is Modifierfalse
                              Summaryfalse
                              Invariantsele-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())
                              SlicingThis element introduces a set of slices on Coverage.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 34. Coverage.text.extension:text
                                Slice Nametext
                                Definition

                                DSTU2: Coverage.text additional types (Narrative) additional types from child elements (div, status)

                                ShortDSTU2: text additional types
                                Comments

                                Element Coverage.text is mapped to FHIR R4B element Coverage.text as SourceIsBroaderThanTarget. The mappings for Coverage.text do not cover the following types: Narrative. The mappings for Coverage.text do not cover the following types based on type expansion: div, status. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

                                Control0..1
                                TypeExtension(DSTU2: text additional types) (Complex Extension)
                                Is Modifierfalse
                                Invariantsele-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.text.status
                                Definition

                                The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.

                                Shortgenerated | extensions | additional | empty
                                Control1..1
                                BindingThe codes SHALL be taken from NarrativeStatus
                                (required to http://hl7.org/fhir/ValueSet/narrative-status|4.3.0)
                                Typecode
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                38. Coverage.text.div
                                Definition

                                The actual narrative content, a stripped down version of XHTML.

                                ShortLimited xhtml content
                                Comments

                                The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.

                                Control1..1
                                Typexhtml
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes (htmlChecks())
                                txt-2: The narrative SHALL have some non-whitespace content (htmlChecks())
                                40. 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.

                                ShortContained, 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.

                                Control0..*
                                TypeResource
                                Is Modifierfalse
                                Must Supportfalse
                                Summaryfalse
                                Alternate Namesinline resources, anonymous resources, contained resources
                                Invariantsdom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
                                42. Coverage.extension
                                Definition

                                An Extension

                                ShortExtension
                                Control0..*
                                TypeExtension
                                Is Modifierfalse
                                Must Supportfalse
                                Summaryfalse
                                Invariantsele-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())
                                SlicingThis element introduces a set of slices on Coverage.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 44. Coverage.extension:group
                                  Slice Namegroup
                                  Definition

                                  DSTU2: Coverage.group (new:string)

                                  ShortDSTU2: An identifier for the group (new)
                                  Comments

                                  Element Coverage.group has a context of Coverage based on following the parent source element upwards and mapping to Coverage. Element Coverage.group has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

                                  Control0..1
                                  This element is affected by the following invariants: ele-1
                                  TypeExtension(DSTU2: An identifier for the group (new)) (Extension Type: string)
                                  Is Modifierfalse
                                  Must Supportfalse
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  46. Coverage.extension:plan
                                  Slice Nameplan
                                  Definition

                                  DSTU2: Coverage.plan (new:string)

                                  ShortDSTU2: An identifier for the plan (new)
                                  Comments

                                  Element Coverage.plan has a context of Coverage based on following the parent source element upwards and mapping to Coverage. Element Coverage.plan has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

                                  Control0..1
                                  This element is affected by the following invariants: ele-1
                                  TypeExtension(DSTU2: An identifier for the plan (new)) (Extension Type: string)
                                  Is Modifierfalse
                                  Must Supportfalse
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  48. Coverage.extension:subPlan
                                  Slice NamesubPlan
                                  Definition

                                  DSTU2: Coverage.subPlan (new:string)

                                  ShortDSTU2: An identifier for the subsection of the plan (new)
                                  Comments

                                  Element Coverage.subPlan has a context of Coverage based on following the parent source element upwards and mapping to Coverage. Element Coverage.subPlan has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

                                  Control0..1
                                  This element is affected by the following invariants: ele-1
                                  TypeExtension(DSTU2: An identifier for the subsection of the plan (new)) (Extension Type: string)
                                  Is Modifierfalse
                                  Must Supportfalse
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  50. Coverage.extension:sequence
                                  Slice Namesequence
                                  Definition

                                  DSTU2: Coverage.sequence (new:positiveInt)

                                  ShortDSTU2: The plan instance or sequence counter (new)
                                  Comments

                                  Element Coverage.sequence has a context of Coverage based on following the parent source element upwards and mapping to Coverage. Element Coverage.sequence has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

                                  Control0..1
                                  This element is affected by the following invariants: ele-1
                                  TypeExtension(DSTU2: The plan instance or sequence counter (new)) (Extension Type: positiveInt)
                                  Is Modifierfalse
                                  Must Supportfalse
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  52. 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).

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

                                  Control0..*
                                  TypeExtension
                                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                                  Must Supportfalse
                                  Summaryfalse
                                  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 Namesextensions, user content
                                  Invariantsele-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())
                                  54. Coverage.identifier
                                  Definition

                                  A unique identifier assigned to this coverage.

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

                                  NoteThis is a business identifier, not a resource identifier (see discussion)
                                  Control0..*
                                  TypeIdentifier
                                  Is Modifierfalse
                                  Must Supportfalse
                                  Summarytrue
                                  Requirements

                                  Allows coverages to be distinguished and referenced.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  56. Coverage.identifier.id
                                  Definition

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

                                  ShortUnique id for inter-element referencing
                                  Control0..1
                                  Typeid
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  58. Coverage.identifier.extension
                                  Definition

                                  An Extension

                                  ShortExtension
                                  Control0..*
                                  TypeExtension
                                  Is Modifierfalse
                                  Summaryfalse
                                  Invariantsele-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())
                                  SlicingThis element introduces a set of slices on Coverage.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 60. Coverage.identifier.extension:bin
                                    Slice Namebin
                                    Definition

                                    DSTU2: Coverage.bin additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

                                    ShortDSTU2: BIN Number additional types
                                    Comments

                                    Element Coverage.bin is mapped to FHIR R4B element Coverage.identifier as RelatedTo. The mappings for Coverage.bin do not cover the following types: Identifier. The mappings for Coverage.bin do not cover the following types based on type expansion: assigner, period, system, type, use, value.

                                    Control0..1
                                    TypeExtension(DSTU2: BIN Number additional types) (Extension Type: Identifier)
                                    Is Modifierfalse
                                    Summaryfalse
                                    Invariantsele-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())
                                    62. Coverage.identifier.extension:identifier
                                    Slice Nameidentifier
                                    Definition

                                    DSTU2: Coverage.identifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

                                    ShortDSTU2: The primary coverage ID additional types
                                    Comments

                                    Element Coverage.identifier is mapped to FHIR R4B element Coverage.identifier as SourceIsBroaderThanTarget. The mappings for Coverage.identifier do not cover the following types: Identifier. The mappings for Coverage.identifier do not cover the following types based on type expansion: assigner, period, system, type, use, value.

                                    Control0..*
                                    TypeExtension(DSTU2: The primary coverage ID additional types) (Extension Type: Identifier)
                                    Is Modifierfalse
                                    Summaryfalse
                                    Invariantsele-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())
                                    64. Coverage.identifier.use
                                    Definition

                                    The purpose of this identifier.

                                    Shortusual | official | temp | secondary | old (If known)
                                    Comments

                                    Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                    Control0..1
                                    BindingThe codes SHALL be taken from IdentifierUse
                                    (required to http://hl7.org/fhir/ValueSet/identifier-use|4.3.0)
                                    Typecode
                                    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Requirements

                                    Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    66. Coverage.identifier.type
                                    Definition

                                    A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                                    ShortDescription of identifier
                                    Comments

                                    This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                    Control0..1
                                    BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                                    (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.3.0)
                                    TypeCodeableConcept
                                    Is Modifierfalse
                                    Summarytrue
                                    Requirements

                                    Allows users to make use of identifiers when the identifier system is not known.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    68. Coverage.identifier.system
                                    Definition

                                    Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                                    ShortThe namespace for the identifier value
                                    Comments

                                    Identifier.system is always case sensitive.

                                    Control0..1
                                    Typeuri
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Requirements

                                    There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                                    ExampleGeneral: http://www.acme.com/identifiers/patient
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    70. Coverage.identifier.value
                                    Definition

                                    The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                                    ShortThe value that is unique
                                    Comments

                                    If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                                    Control0..1
                                    Typestring
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    ExampleGeneral: 123456
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    72. Coverage.identifier.period
                                    Definition

                                    Time period during which identifier is/was valid for use.

                                    ShortTime period when id is/was valid for use
                                    Control0..1
                                    TypePeriod
                                    Is Modifierfalse
                                    Summarytrue
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    74. Coverage.identifier.assigner
                                    Definition

                                    Organization that issued/manages the identifier.

                                    ShortOrganization that issued id (may be just text)
                                    Comments

                                    The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                                    Control0..1
                                    TypeReference(Organization)
                                    Is Modifierfalse
                                    Summarytrue
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    76. Coverage.status
                                    Definition

                                    The status of the resource instance.

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

                                    Control1..1
                                    BindingThe codes SHALL be taken from FinancialResourceStatusCodes
                                    (required to http://hl7.org/fhir/ValueSet/fm-status|4.3.0)

                                    A code specifying the state of the resource instance.

                                    Typecode
                                    Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supportfalse
                                    Summarytrue
                                    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'.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    78. 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.

                                    ShortCoverage category such as medical or accident
                                    Control0..1
                                    BindingThe codes SHOULD be taken from CoverageTypeAndSelf-PayCodes
                                    (preferred to http://hl7.org/fhir/ValueSet/coverage-type|4.3.0)

                                    The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization.

                                    TypeCodeableConcept
                                    Is Modifierfalse
                                    Must Supportfalse
                                    Summarytrue
                                    Requirements

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

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

                                    The party who 'owns' the insurance policy.

                                    ShortOwner of the policy
                                    Comments

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

                                    Control0..1
                                    TypeReference(Patient, RelatedPerson, Organization)
                                    Is Modifierfalse
                                    Must Supportfalse
                                    Summarytrue
                                    Requirements

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

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    82. 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.

                                    ShortSubscriber to the policy
                                    Comments

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

                                    Control0..1
                                    TypeReference(Patient, RelatedPerson)
                                    Is Modifierfalse
                                    Must Supportfalse
                                    Summarytrue
                                    Requirements

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

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    84. 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.

                                    ShortUnique id for inter-element referencing
                                    Control0..1
                                    Typeid
                                    Is Modifierfalse
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    Summaryfalse
                                    86. 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.

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

                                    Control0..*
                                    TypeExtension
                                    Is Modifierfalse
                                    Summaryfalse
                                    Alternate Namesextensions, user content
                                    Invariantsele-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())
                                    SlicingThis 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
                                    • 88. 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.

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

                                      Control0..1
                                      This element is affected by the following invariants: ref-1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      90. 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).

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

                                      Control0..1
                                      BindingUnless not suitable, these codes SHALL be taken from ResourceType
                                      (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.3.0)
                                      Typeuri
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      92. 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.

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

                                      NoteThis is a business identifier, not a resource identifier (see discussion)
                                      Control0..1
                                      TypeIdentifier
                                      Is Modifierfalse
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      94. Coverage.subscriber.display
                                      Definition

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

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

                                      Control0..1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      96. Coverage.subscriberId
                                      Definition

                                      The insurer assigned ID for the Subscriber.

                                      ShortID assigned to the subscriber
                                      Control0..1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supportfalse
                                      Summarytrue
                                      Requirements

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

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      98. Coverage.subscriberId.id
                                      Definition

                                      unique id for the element within a resource (for internal references)

                                      Shortxml:id (or equivalent in JSON)
                                      Control0..1
                                      Typestring
                                      Is Modifierfalse
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      Summaryfalse
                                      100. Coverage.subscriberId.extension
                                      Definition

                                      An Extension

                                      ShortExtension
                                      Control0..*
                                      TypeExtension
                                      Is Modifierfalse
                                      Summaryfalse
                                      Invariantsele-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())
                                      SlicingThis element introduces a set of slices on Coverage.subscriberId.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 102. Coverage.subscriberId.extension:subscriberId
                                        Slice NamesubscriberId
                                        Definition

                                        DSTU2: Coverage.subscriberId additional types (Identifier) additional types from child elements (assigner, period, type)

                                        ShortDSTU2: Subscriber ID additional types
                                        Comments

                                        Element Coverage.subscriberId is mapped to FHIR R4B element Coverage.subscriberId as SourceIsBroaderThanTarget. The mappings for Coverage.subscriberId do not cover the following types: Identifier. The mappings for Coverage.subscriberId do not cover the following types based on type expansion: assigner, period, type.

                                        Control0..1
                                        This element is affected by the following invariants: ele-1
                                        TypeExtension(DSTU2: Subscriber ID additional types) (Extension Type: Identifier)
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        104. Coverage.subscriberId.value
                                        Definition

                                        The actual value

                                        ShortPrimitive value for string
                                        Control0..1
                                        Typestring
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        Max Length:1048576
                                        106. Coverage.beneficiary
                                        Definition

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

                                        ShortPlan beneficiary
                                        Control1..1
                                        TypeReference(Patient)
                                        Is Modifierfalse
                                        Must Supportfalse
                                        Summarytrue
                                        Requirements

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

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

                                        A unique identifier for a dependent under the coverage.

                                        ShortDependent number
                                        Comments

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

                                        Control0..1
                                        Typestring
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Must Supportfalse
                                        Summarytrue
                                        Requirements

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

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        110. Coverage.dependent.id
                                        Definition

                                        unique id for the element within a resource (for internal references)

                                        Shortxml:id (or equivalent in JSON)
                                        Control0..1
                                        Typestring
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        112. Coverage.dependent.extension
                                        Definition

                                        An Extension

                                        ShortExtension
                                        Control0..*
                                        TypeExtension
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-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())
                                        SlicingThis element introduces a set of slices on Coverage.dependent.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • value @ url
                                        • 114. Coverage.dependent.extension:dependent
                                          Slice Namedependent
                                          Definition

                                          DSTU2: Coverage.dependent additional types (positiveInt) additional types from child elements (value)

                                          ShortDSTU2: The dependent number additional types
                                          Comments

                                          Element Coverage.dependent is mapped to FHIR R4B element Coverage.dependent as SourceIsBroaderThanTarget. The mappings for Coverage.dependent do not cover the following types: positiveInt. The mappings for Coverage.dependent do not cover the following types based on type expansion: value.

                                          Control0..1
                                          This element is affected by the following invariants: ele-1
                                          TypeExtension(DSTU2: The dependent number additional types) (Extension Type: positiveInt)
                                          Is Modifierfalse
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                          116. Coverage.dependent.value
                                          Definition

                                          The actual value

                                          ShortPrimitive value for string
                                          Control0..1
                                          Typestring
                                          Is Modifierfalse
                                          XML FormatIn the XML format, this property is represented as an attribute.
                                          Summaryfalse
                                          Max Length:1048576
                                          118. Coverage.relationship
                                          Definition

                                          The relationship of beneficiary (patient) to the subscriber.

                                          ShortBeneficiary relationship to the subscriber
                                          Comments

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

                                          Control0..1
                                          BindingUnless not suitable, these codes SHALL be taken from SubscriberRelationshipCodes
                                          (extensible to http://hl7.org/fhir/ValueSet/subscriber-relationship|4.3.0)

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

                                          TypeCodeableConcept
                                          Is Modifierfalse
                                          Must Supportfalse
                                          Summaryfalse
                                          Requirements

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

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          120. 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.

                                          ShortCoverage start and end dates
                                          Control0..1
                                          TypePeriod
                                          Is Modifierfalse
                                          Must Supportfalse
                                          Summarytrue
                                          Requirements

                                          Some insurers require the submission of the coverage term.

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

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

                                          ShortUnique id for inter-element referencing
                                          Control0..1
                                          Typeid
                                          Is Modifierfalse
                                          XML FormatIn the XML format, this property is represented as an attribute.
                                          Summaryfalse
                                          124. Coverage.period.extension
                                          Definition

                                          An Extension

                                          ShortExtension
                                          Control0..*
                                          TypeExtension
                                          Is Modifierfalse
                                          Summaryfalse
                                          Invariantsele-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())
                                          SlicingThis element introduces a set of slices on Coverage.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 126. Coverage.period.extension:period
                                            Slice Nameperiod
                                            Definition

                                            DSTU2: Coverage.period additional types (Period) additional types from child elements (end, start)

                                            ShortDSTU2: period additional types
                                            Comments

                                            Element Coverage.period is mapped to FHIR R4B element Coverage.period as SourceIsBroaderThanTarget. The mappings for Coverage.period do not cover the following types: Period. The mappings for Coverage.period do not cover the following types based on type expansion: end, start.

                                            Control0..1
                                            TypeExtension(DSTU2: period additional types) (Extension Type: Period)
                                            Is Modifierfalse
                                            Summaryfalse
                                            Invariantsele-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())
                                            128. Coverage.period.start
                                            Definition

                                            The start of the period. The boundary is inclusive.

                                            ShortStarting time with inclusive boundary
                                            Comments

                                            If the low element is missing, the meaning is that the low boundary is not known.

                                            Control0..1
                                            This element is affected by the following invariants: per-1
                                            TypedateTime
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            130. Coverage.period.end
                                            Definition

                                            The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

                                            ShortEnd time with inclusive boundary, if not ongoing
                                            Comments

                                            The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

                                            Control0..1
                                            This element is affected by the following invariants: per-1
                                            TypedateTime
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            132. Coverage.payor
                                            Definition

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

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

                                            Control1..*
                                            TypeReference(Organization, Patient, RelatedPerson)
                                            Is Modifierfalse
                                            Must Supportfalse
                                            Summarytrue
                                            Requirements

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

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            134. 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.

                                            ShortUnique id for inter-element referencing
                                            Control0..1
                                            Typeid
                                            Is Modifierfalse
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            Summaryfalse
                                            136. Coverage.payor.extension
                                            Definition

                                            An Extension

                                            ShortExtension
                                            Control0..*
                                            TypeExtension
                                            Is Modifierfalse
                                            Summaryfalse
                                            Invariantsele-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())
                                            SlicingThis 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
                                            • 138. Coverage.payor.extension:issuer
                                              Slice Nameissuer
                                              Definition

                                              DSTU2: Coverage.issuer additional types from child elements (display, reference)

                                              ShortDSTU2: An identifier for the plan issuer additional types
                                              Comments

                                              Element Coverage.issuer is mapped to FHIR R4B element Coverage.payor as RelatedTo. The mappings for Coverage.issuer do not cover the following types based on type expansion: display, reference. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element Coverage.issuer with unmapped reference targets: Organization.

                                              Control0..1
                                              TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                              Is Modifierfalse
                                              Summaryfalse
                                              Invariantsele-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())
                                              140. 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.

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

                                              Control0..1
                                              This element is affected by the following invariants: ref-1
                                              Typestring
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              142. 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).

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

                                              Control0..1
                                              BindingUnless not suitable, these codes SHALL be taken from ResourceType
                                              (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.3.0)
                                              Typeuri
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              144. 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.

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

                                              NoteThis is a business identifier, not a resource identifier (see discussion)
                                              Control0..1
                                              TypeIdentifier
                                              Is Modifierfalse
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              146. Coverage.payor.display
                                              Definition

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

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

                                              Control0..1
                                              Typestring
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              148. Coverage.class
                                              Definition

                                              A suite of underwriter specific classifiers.

                                              ShortAdditional coverage classifications
                                              Comments

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

                                              Control0..*
                                              TypeBackboneElement
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summaryfalse
                                              Requirements

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

                                              Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                              150. 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.

                                              ShortUnique id for inter-element referencing
                                              Control0..1
                                              Typestring
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              152. 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.

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

                                              Control0..*
                                              TypeExtension
                                              Is Modifierfalse
                                              Summaryfalse
                                              Alternate Namesextensions, user content
                                              Invariantsele-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())
                                              154. 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).

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

                                              Control0..*
                                              TypeExtension
                                              Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                              Summarytrue
                                              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 Namesextensions, user content, modifiers
                                              Invariantsele-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())
                                              156. 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.

                                              ShortType of class such as 'group' or 'plan'
                                              Control1..1
                                              BindingUnless not suitable, these codes SHALL be taken from CoverageClassCodes
                                              (extensible to http://hl7.org/fhir/ValueSet/coverage-class|4.3.0)

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

                                              TypeCodeableConcept
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summarytrue
                                              Requirements

                                              The insurer issued label for a specific health card value.

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

                                              The alphanumeric string value associated with the insurer issued label.

                                              ShortValue associated with the type
                                              Comments

                                              For example, the Group or Plan number.

                                              Control1..1
                                              Typestring
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Must Supportfalse
                                              Summarytrue
                                              Requirements

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

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

                                              A short description for the class.

                                              ShortHuman readable description of the type and value
                                              Control0..1
                                              Typestring
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Must Supportfalse
                                              Summarytrue
                                              Requirements

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

                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              162. 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.

                                              ShortRelative order of the coverage
                                              Control0..1
                                              TypepositiveInt
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Must Supportfalse
                                              Summarytrue
                                              Requirements

                                              Used in managing the coordination of benefits.

                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              164. 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.

                                              ShortInsurer network
                                              Control0..1
                                              Typestring
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Must Supportfalse
                                              Summarytrue
                                              Requirements

                                              Used in referral for treatment and in claims processing.

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

                                              unique id for the element within a resource (for internal references)

                                              Shortxml:id (or equivalent in JSON)
                                              Control0..1
                                              Typestring
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              168. Coverage.network.extension
                                              Definition

                                              An Extension

                                              ShortExtension
                                              Control0..*
                                              TypeExtension
                                              Is Modifierfalse
                                              Summaryfalse
                                              Invariantsele-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())
                                              SlicingThis element introduces a set of slices on Coverage.network.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                              • value @ url
                                              • 170. Coverage.network.extension:network
                                                Slice Namenetwork
                                                Definition

                                                DSTU2: Coverage.network additional types (Identifier) additional types from child elements (assigner, period, type)

                                                ShortDSTU2: network additional types
                                                Comments

                                                Element Coverage.network is mapped to FHIR R4B element Coverage.network as SourceIsBroaderThanTarget. The mappings for Coverage.network do not cover the following types: Identifier. The mappings for Coverage.network do not cover the following types based on type expansion: assigner, period, type.

                                                Control0..1
                                                This element is affected by the following invariants: ele-1
                                                TypeExtension(DSTU2: network additional types) (Extension Type: Identifier)
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                172. Coverage.network.value
                                                Definition

                                                The actual value

                                                ShortPrimitive value for string
                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                Max Length:1048576
                                                174. 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.

                                                ShortPatient payments for services/products
                                                Comments

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

                                                Control0..*
                                                TypeBackboneElement
                                                Is Modifierfalse
                                                Must Supportfalse
                                                Summaryfalse
                                                Requirements

                                                Required by providers to manage financial transaction with the patient.

                                                Alternate NamesCoPay, Deductible, Exceptions
                                                Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                                176. 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.

                                                ShortUnique id for inter-element referencing
                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                178. 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.

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

                                                Control0..*
                                                TypeExtension
                                                Is Modifierfalse
                                                Summaryfalse
                                                Alternate Namesextensions, user content
                                                Invariantsele-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())
                                                180. 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).

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

                                                Control0..*
                                                TypeExtension
                                                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                Summarytrue
                                                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 Namesextensions, user content, modifiers
                                                Invariantsele-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())
                                                182. Coverage.costToBeneficiary.type
                                                Definition

                                                The category of patient centric costs associated with treatment.

                                                ShortCost category
                                                Comments

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

                                                Control0..1
                                                BindingUnless not suitable, these codes SHALL be taken from CoverageCopayTypeCodes
                                                (extensible to http://hl7.org/fhir/ValueSet/coverage-copay-type|4.3.0)

                                                The types of services to which patient copayments are specified.

                                                TypeCodeableConcept
                                                Is Modifierfalse
                                                Must Supportfalse
                                                Summarytrue
                                                Requirements

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

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

                                                The amount due from the patient for the cost category.

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

                                                Control1..1
                                                TypeChoice of: Quantity(SimpleQuantity), Money
                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                Is Modifierfalse
                                                Must Supportfalse
                                                Summarytrue
                                                Requirements

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

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

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

                                                ShortExceptions for patient payments
                                                Control0..*
                                                TypeBackboneElement
                                                Is Modifierfalse
                                                Must Supportfalse
                                                Summaryfalse
                                                Requirements

                                                Required by providers to manage financial transaction with the patient.

                                                Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                                188. 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.

                                                ShortUnique id for inter-element referencing
                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                190. 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.

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

                                                Control0..*
                                                TypeExtension
                                                Is Modifierfalse
                                                Summaryfalse
                                                Alternate Namesextensions, user content
                                                Invariantsele-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())
                                                192. 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).

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

                                                Control0..*
                                                TypeExtension
                                                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                Summarytrue
                                                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 Namesextensions, user content, modifiers
                                                Invariantsele-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())
                                                194. Coverage.costToBeneficiary.exception.type
                                                Definition

                                                The code for the specific exception.

                                                ShortException category
                                                Control1..1
                                                BindingFor example codes, see ExampleCoverageFinancialExceptionCodes
                                                (example to http://hl7.org/fhir/ValueSet/coverage-financial-exception|4.3.0)

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

                                                TypeCodeableConcept
                                                Is Modifierfalse
                                                Must Supportfalse
                                                Summarytrue
                                                Requirements

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

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

                                                The timeframe during when the exception is in force.

                                                ShortThe effective period of the exception
                                                Control0..1
                                                TypePeriod
                                                Is Modifierfalse
                                                Must Supportfalse
                                                Summarytrue
                                                Requirements

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

                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                198. 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.

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

                                                Control0..1
                                                Typeboolean
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Must Supportfalse
                                                Summaryfalse
                                                Requirements

                                                See definition for when to be used.

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

                                                The policy(s) which constitute this insurance coverage.

                                                ShortContract details
                                                Control0..*
                                                TypeReference(Contract)
                                                Is Modifierfalse
                                                Must Supportfalse
                                                Summaryfalse
                                                Requirements

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

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

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

                                                ShortUnique id for inter-element referencing
                                                Control0..1
                                                Typeid
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                204. Coverage.contract.extension
                                                Definition

                                                An Extension

                                                ShortExtension
                                                Control0..*
                                                TypeExtension
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-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())
                                                SlicingThis element introduces a set of slices on Coverage.contract.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                • value @ url
                                                • 206. Coverage.contract.extension:contract
                                                  Slice Namecontract
                                                  Definition

                                                  DSTU2: Coverage.contract additional types from child elements (display, reference)

                                                  ShortDSTU2: contract additional types
                                                  Comments

                                                  Element Coverage.contract is mapped to FHIR R4B element Coverage.contract as SourceIsBroaderThanTarget. The mappings for Coverage.contract do not cover the following types based on type expansion: display, reference. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element Coverage.contract with unmapped reference targets: Contract.

                                                  Control0..1
                                                  TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-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())
                                                  208. Coverage.contract.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.

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

                                                  Control0..1
                                                  This element is affected by the following invariants: ref-1
                                                  Typestring
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  210. Coverage.contract.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).

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

                                                  Control0..1
                                                  BindingUnless not suitable, these codes SHALL be taken from ResourceType
                                                  (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.3.0)
                                                  Typeuri
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  212. Coverage.contract.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.

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

                                                  NoteThis is a business identifier, not a resource identifier (see discussion)
                                                  Control0..1
                                                  TypeIdentifier
                                                  Is Modifierfalse
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  214. Coverage.contract.display
                                                  Definition

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

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

                                                  Control0..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))