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

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

Resource Profile: Profile_R5_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.

Control10..*
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:kind
    Slice Namekind
    Definition

    R5: Coverage.kind (new:code)

    ShortR5: insurance | self-pay | other (new)
    Comments

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

    Control1..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: insurance | self-pay | other (new)) (Extension Type: code)
    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:paymentBy
    Slice NamepaymentBy
    Definition

    R5: Coverage.paymentBy (new:BackboneElement)

    ShortR5: Self-pay parties and responsibility (new)
    Comments

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

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: Self-pay parties and responsibility (new)) (Complex Extension)
    Is Modifierfalse
    Must Supportfalse
    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())
    10. Coverage.extension:insurancePlan
    Slice NameinsurancePlan
    Definition

    R5: Coverage.insurancePlan (new:Reference(InsurancePlan))

    ShortR5: Insurance plan details (new)
    Comments

    Element Coverage.insurancePlan has a context of Coverage based on following the parent source element upwards and mapping to Coverage. Element Coverage.insurancePlan 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(R5: Insurance plan details (new)) (Extension Type: Reference(Cross-version Profile for R5.InsurancePlan for use in FHIR R4B, InsurancePlan))
    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.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())
    14. 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()))
    16. 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()))
    18. 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()))

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

    0. Coverage
    2. Coverage.extension
    Control1..*
    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
    • 4. Coverage.extension:kind
      Slice Namekind
      Definition

      R5: Coverage.kind (new:code)

      ShortR5: insurance | self-pay | other (new)
      Comments

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

      Control1..1
      TypeExtension(R5: insurance | self-pay | other (new)) (Extension Type: code)
      6. Coverage.extension:paymentBy
      Slice NamepaymentBy
      Definition

      R5: Coverage.paymentBy (new:BackboneElement)

      ShortR5: Self-pay parties and responsibility (new)
      Comments

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

      Control0..*
      TypeExtension(R5: Self-pay parties and responsibility (new)) (Complex Extension)
      8. Coverage.extension:insurancePlan
      Slice NameinsurancePlan
      Definition

      R5: Coverage.insurancePlan (new:Reference(InsurancePlan))

      ShortR5: Insurance plan details (new)
      Comments

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

      Control0..1
      TypeExtension(R5: Insurance plan details (new)) (Extension Type: Reference(Cross-version Profile for R5.InsurancePlan for use in FHIR R4B, InsurancePlan))
      10. Coverage.subscriberId
      12. 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
      • 14. Coverage.subscriberId.extension:subscriberId
        Slice NamesubscriberId
        Definition

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

        ShortR5: subscriberId 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..*
        TypeExtension(R5: subscriberId additional types) (Extension Type: Identifier)
        16. Coverage.class
        18. Coverage.class.value
        20. Coverage.class.value.extension
        Control0..*
        SlicingThis element introduces a set of slices on Coverage.class.value.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 22. Coverage.class.value.extension:value
          Slice Namevalue
          Definition

          R5: Coverage.class.value additional types (Identifier) additional types from child elements (assigner, period, type)

          ShortR5: value additional types
          Comments

          Element Coverage.class.value is mapped to FHIR R4B element Coverage.class.value as SourceIsBroaderThanTarget. The mappings for Coverage.class.value do not cover the following types: Identifier. The mappings for Coverage.class.value do not cover the following types based on type expansion: assigner, period, type. For example, the Group or Plan number.

          Control0..1
          TypeExtension(R5: value additional types) (Extension Type: Identifier)
          24. Coverage.costToBeneficiary
          26. Coverage.costToBeneficiary.extension
          Control0..*
          SlicingThis element introduces a set of slices on Coverage.costToBeneficiary.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 28. Coverage.costToBeneficiary.extension:category
            Slice Namecategory
            Definition

            R5: Coverage.costToBeneficiary.category (new:CodeableConcept)

            ShortR5: Benefit classification (new)
            Comments

            Element Coverage.costToBeneficiary.category has a context of Coverage.costToBeneficiary based on following the parent source element upwards and mapping to Coverage. Element Coverage.costToBeneficiary.category has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.

            Control0..1
            TypeExtension(R5: Benefit classification (new)) (Extension Type: CodeableConcept)
            30. Coverage.costToBeneficiary.extension:network
            Slice Namenetwork
            Definition

            R5: Coverage.costToBeneficiary.network (new:CodeableConcept)

            ShortR5: In or out of network (new)
            Comments

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

            Control0..1
            TypeExtension(R5: In or out of network (new)) (Extension Type: CodeableConcept)
            32. Coverage.costToBeneficiary.extension:unit
            Slice Nameunit
            Definition

            R5: Coverage.costToBeneficiary.unit (new:CodeableConcept)

            ShortR5: Individual or family (new)
            Comments

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

            Control0..1
            TypeExtension(R5: Individual or family (new)) (Extension Type: CodeableConcept)
            34. Coverage.costToBeneficiary.extension:term
            Slice Nameterm
            Definition

            R5: Coverage.costToBeneficiary.term (new:CodeableConcept)

            ShortR5: Annual or lifetime (new)
            Comments

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

            Control0..1
            TypeExtension(R5: Annual or lifetime (new)) (Extension Type: CodeableConcept)

            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.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()))
            8. 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()))
            10. 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()))
            12. 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))
            14. Coverage.extension
            Definition

            An Extension

            ShortExtension
            Control1..*
            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
            • 16. Coverage.extension:kind
              Slice Namekind
              Definition

              R5: Coverage.kind (new:code)

              ShortR5: insurance | self-pay | other (new)
              Comments

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

              Control1..1
              This element is affected by the following invariants: ele-1
              TypeExtension(R5: insurance | self-pay | other (new)) (Extension Type: code)
              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())
              18. Coverage.extension:paymentBy
              Slice NamepaymentBy
              Definition

              R5: Coverage.paymentBy (new:BackboneElement)

              ShortR5: Self-pay parties and responsibility (new)
              Comments

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

              Control0..*
              This element is affected by the following invariants: ele-1
              TypeExtension(R5: Self-pay parties and responsibility (new)) (Complex Extension)
              Is Modifierfalse
              Must Supportfalse
              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())
              20. Coverage.extension:insurancePlan
              Slice NameinsurancePlan
              Definition

              R5: Coverage.insurancePlan (new:Reference(InsurancePlan))

              ShortR5: Insurance plan details (new)
              Comments

              Element Coverage.insurancePlan has a context of Coverage based on following the parent source element upwards and mapping to Coverage. Element Coverage.insurancePlan 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(R5: Insurance plan details (new)) (Extension Type: Reference(Cross-version Profile for R5.InsurancePlan for use in FHIR R4B, InsurancePlan))
              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())
              22. 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())
              24. 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()))
              26. 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()))
              28. 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()))
              30. 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()))
              32. 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()))
              34. 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()))
              36. 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
              38. 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
              • 40. Coverage.subscriberId.extension:subscriberId
                Slice NamesubscriberId
                Definition

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

                ShortR5: subscriberId 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..*
                This element is affected by the following invariants: ele-1
                TypeExtension(R5: subscriberId 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())
                42. 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
                44. 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()))
                46. 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()))
                48. 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()))
                50. 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()))
                52. 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()))
                54. 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)
                56. 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
                58. 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())
                60. 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())
                62. 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()))
                64. 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()))
                66. Coverage.class.value.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
                68. Coverage.class.value.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.class.value.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 70. Coverage.class.value.extension:value
                  Slice Namevalue
                  Definition

                  R5: Coverage.class.value additional types (Identifier) additional types from child elements (assigner, period, type)

                  ShortR5: value additional types
                  Comments

                  Element Coverage.class.value is mapped to FHIR R4B element Coverage.class.value as SourceIsBroaderThanTarget. The mappings for Coverage.class.value do not cover the following types: Identifier. The mappings for Coverage.class.value do not cover the following types based on type expansion: assigner, period, type. For example, the Group or Plan number.

                  Control0..1
                  This element is affected by the following invariants: ele-1
                  TypeExtension(R5: value 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())
                  72. Coverage.class.value.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
                  74. 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()))
                  76. 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()))
                  78. 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()))
                  80. 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)
                  82. 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
                  84. Coverage.costToBeneficiary.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.costToBeneficiary.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 86. Coverage.costToBeneficiary.extension:category
                    Slice Namecategory
                    Definition

                    R5: Coverage.costToBeneficiary.category (new:CodeableConcept)

                    ShortR5: Benefit classification (new)
                    Comments

                    Element Coverage.costToBeneficiary.category has a context of Coverage.costToBeneficiary based on following the parent source element upwards and mapping to Coverage. Element Coverage.costToBeneficiary.category has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.

                    Control0..1
                    This element is affected by the following invariants: ele-1
                    TypeExtension(R5: Benefit classification (new)) (Extension Type: CodeableConcept)
                    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())
                    88. Coverage.costToBeneficiary.extension:network
                    Slice Namenetwork
                    Definition

                    R5: Coverage.costToBeneficiary.network (new:CodeableConcept)

                    ShortR5: In or out of network (new)
                    Comments

                    Element Coverage.costToBeneficiary.network has a context of Coverage.costToBeneficiary based on following the parent source element upwards and mapping to Coverage. Element Coverage.costToBeneficiary.network 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(R5: In or out of network (new)) (Extension Type: CodeableConcept)
                    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())
                    90. Coverage.costToBeneficiary.extension:unit
                    Slice Nameunit
                    Definition

                    R5: Coverage.costToBeneficiary.unit (new:CodeableConcept)

                    ShortR5: Individual or family (new)
                    Comments

                    Element Coverage.costToBeneficiary.unit has a context of Coverage.costToBeneficiary based on following the parent source element upwards and mapping to Coverage. Element Coverage.costToBeneficiary.unit 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(R5: Individual or family (new)) (Extension Type: CodeableConcept)
                    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())
                    92. Coverage.costToBeneficiary.extension:term
                    Slice Nameterm
                    Definition

                    R5: Coverage.costToBeneficiary.term (new:CodeableConcept)

                    ShortR5: Annual or lifetime (new)
                    Comments

                    Element Coverage.costToBeneficiary.term has a context of Coverage.costToBeneficiary based on following the parent source element upwards and mapping to Coverage. Element Coverage.costToBeneficiary.term 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(R5: Annual or lifetime (new)) (Extension Type: CodeableConcept)
                    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())
                    94. 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())
                    96. 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()))
                    98. 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()))
                    100. 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)
                    102. 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
                    104. 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())
                    106. 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())
                    108. 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()))
                    110. 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()))
                    112. 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()))
                    114. 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()))