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

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

Resource Profile: Profile_R3_EligibilityRequest_R5_CoverageEligibilityRequest - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-EligibilityRequest-for-CoverageEligibilityRequest resource profile.

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

0. CoverageEligibilityRequest
Definition

The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.

ShortCoverageEligibilityRequest resource
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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. CoverageEligibilityRequest.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 its 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 its 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. CoverageEligibilityRequest.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
6. CoverageEligibilityRequest.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 managable, 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 CoverageEligibilityRequest.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 8. CoverageEligibilityRequest.extension:serviced
    Slice Nameserviced
    Definition

    STU3: EligibilityRequest.serviced[x] additional types (Period) additional types from child elements (end, start)

    ShortSTU3: Estimated date or dates of Service additional types
    Comments

    Element EligibilityRequest.serviced[x] is mapped to FHIR R5 element CoverageEligibilityRequest.serviced[x] as SourceIsBroaderThanTarget. The mappings for EligibilityRequest.serviced[x] do not cover the following types: Period. The mappings for EligibilityRequest.serviced[x] do not cover the following types based on type expansion: end, start. The target context CoverageEligibilityRequest.serviced[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element CoverageEligibilityRequest.

    Control0..1
    TypeExtension(STU3: Estimated date or dates of Service additional types) (Extension Type: Period)
    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())
    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. CoverageEligibilityRequest.extension:benefitCategory
    Slice NamebenefitCategory
    Definition

    STU3: EligibilityRequest.benefitCategory (new:CodeableConcept)

    ShortSTU3: Type of services covered (new)
    Comments

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

    Control0..1
    TypeExtension(STU3: Type of services covered (new)) (Extension Type: CodeableConcept)
    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())
    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. CoverageEligibilityRequest.extension:benefitSubCategory
    Slice NamebenefitSubCategory
    Definition

    STU3: EligibilityRequest.benefitSubCategory (new:CodeableConcept)

    ShortSTU3: Detailed services covered within the type (new)
    Comments

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

    Control0..1
    TypeExtension(STU3: Detailed services covered within the type (new)) (Extension Type: CodeableConcept)
    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())
    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. CoverageEligibilityRequest.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 managable, 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
    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
    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. CoverageEligibilityRequest.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 codes that mark the resource as not currently valid.

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

    A code specifying the state of the resource instance.

    Typecode
    Is Modifiertrue because This element is labeled 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. CoverageEligibilityRequest.purpose
    Definition

    Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified.

    Shortauth-requirements | benefits | discovery | validation
    Control1..*
    BindingThe codes SHALL be taken from EligibilityRequestPurposehttp://hl7.org/fhir/ValueSet/eligibilityrequest-purpose|5.0.0
    (required to http://hl7.org/fhir/ValueSet/eligibilityrequest-purpose|5.0.0)

    A code specifying the types of information being requested.

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

    To indicate the processing actions requested.

    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. CoverageEligibilityRequest.patient
    Definition

    The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.

    ShortIntended recipient of products and services
    Comments

    1..1.

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

    Required to provide context and coverage validation.

    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. CoverageEligibilityRequest.patient.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 managable, 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 CoverageEligibilityRequest.patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 24. CoverageEligibilityRequest.patient.extension:patient
      Slice Namepatient
      Definition

      STU3: EligibilityRequest.patient additional types from child elements (display, identifier, reference)

      ShortSTU3: The subject of the Products and Services additional types
      Comments

      Element EligibilityRequest.patient is mapped to FHIR R5 element CoverageEligibilityRequest.patient as SourceIsBroaderThanTarget. The mappings for EligibilityRequest.patient do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element EligibilityRequest.patient with unmapped reference targets: Patient. 1..1.

      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())
      26. CoverageEligibilityRequest.patient.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-2, 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()))
      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      28. CoverageEligibilityRequest.created
      Definition

      The date when this resource was created.

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

      Need to record a timestamp for use by both the recipient and the issuer.

      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()))
      30. CoverageEligibilityRequest.insurer
      Definition

      The Insurer who issued the coverage in question and is the recipient of the request.

      ShortCoverage issuer
      Control1..1
      TypeReference(Organization)
      Is Modifierfalse
      Must Supportfalse
      Summarytrue
      Requirements

      Need to identify the recipient.

      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()))
      32. CoverageEligibilityRequest.insurer.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 managable, 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 CoverageEligibilityRequest.insurer.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 34. CoverageEligibilityRequest.insurer.extension:insurer
        Slice Nameinsurer
        Definition

        STU3: EligibilityRequest.insurer additional types from child elements (display, identifier, reference)

        ShortSTU3: Target additional types
        Comments

        Element EligibilityRequest.insurer is mapped to FHIR R5 element CoverageEligibilityRequest.insurer as SourceIsBroaderThanTarget. The mappings for EligibilityRequest.insurer do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element EligibilityRequest.insurer 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())
        36. CoverageEligibilityRequest.insurer.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-2, 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()))
        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. CoverageEligibilityRequest
        2. CoverageEligibilityRequest.meta
        4. CoverageEligibilityRequest.meta.extension
        Control0..*
        SlicingThis element introduces a set of slices on CoverageEligibilityRequest.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 6. CoverageEligibilityRequest.meta.extension:meta
          Slice Namemeta
          Definition

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

          ShortSTU3: meta additional types
          Comments

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

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

            STU3: EligibilityRequest.text additional types (Narrative) additional types from child elements (div, status)

            ShortSTU3: text additional types
            Comments

            Element EligibilityRequest.text is mapped to FHIR R5 element CoverageEligibilityRequest.text as SourceIsBroaderThanTarget. The mappings for EligibilityRequest.text do not cover the following types: Narrative. The mappings for EligibilityRequest.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. 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 in formation is added later.

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

              STU3: EligibilityRequest.serviced[x] additional types (Period) additional types from child elements (end, start)

              ShortSTU3: Estimated date or dates of Service additional types
              Comments

              Element EligibilityRequest.serviced[x] is mapped to FHIR R5 element CoverageEligibilityRequest.serviced[x] as SourceIsBroaderThanTarget. The mappings for EligibilityRequest.serviced[x] do not cover the following types: Period. The mappings for EligibilityRequest.serviced[x] do not cover the following types based on type expansion: end, start. The target context CoverageEligibilityRequest.serviced[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element CoverageEligibilityRequest.

              Control0..1
              TypeExtension(STU3: Estimated date or dates of Service additional types) (Extension Type: Period)
              18. CoverageEligibilityRequest.extension:benefitCategory
              Slice NamebenefitCategory
              Definition

              STU3: EligibilityRequest.benefitCategory (new:CodeableConcept)

              ShortSTU3: Type of services covered (new)
              Comments

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

              Control0..1
              TypeExtension(STU3: Type of services covered (new)) (Extension Type: CodeableConcept)
              20. CoverageEligibilityRequest.extension:benefitSubCategory
              Slice NamebenefitSubCategory
              Definition

              STU3: EligibilityRequest.benefitSubCategory (new:CodeableConcept)

              ShortSTU3: Detailed services covered within the type (new)
              Comments

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

              Control0..1
              TypeExtension(STU3: Detailed services covered within the type (new)) (Extension Type: CodeableConcept)
              22. CoverageEligibilityRequest.identifier
              NoteThis is a business identifier, not a resource identifier (see discussion)
              24. CoverageEligibilityRequest.identifier.extension
              Control0..*
              SlicingThis element introduces a set of slices on CoverageEligibilityRequest.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 26. CoverageEligibilityRequest.identifier.extension:identifier
                Slice Nameidentifier
                Definition

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

                ShortSTU3: Business Identifier additional types
                Comments

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

                Control0..*
                TypeExtension(STU3: Business Identifier additional types) (Extension Type: Identifier)
                28. CoverageEligibilityRequest.patient
                30. CoverageEligibilityRequest.patient.extension
                Control0..*
                SlicingThis element introduces a set of slices on CoverageEligibilityRequest.patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 32. CoverageEligibilityRequest.patient.extension:patient
                  Slice Namepatient
                  Definition

                  STU3: EligibilityRequest.patient additional types from child elements (display, identifier, reference)

                  ShortSTU3: The subject of the Products and Services additional types
                  Comments

                  Element EligibilityRequest.patient is mapped to FHIR R5 element CoverageEligibilityRequest.patient as SourceIsBroaderThanTarget. The mappings for EligibilityRequest.patient do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element EligibilityRequest.patient with unmapped reference targets: Patient. 1..1.

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

                    STU3: EligibilityRequest.enterer additional types from child elements (display, identifier, reference)

                    ShortSTU3: enterer additional types
                    Comments

                    Element EligibilityRequest.enterer is mapped to FHIR R5 element CoverageEligibilityRequest.enterer as SourceIsBroaderThanTarget. The mappings for EligibilityRequest.enterer do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element EligibilityRequest.enterer with unmapped reference targets: Practitioner.

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

                      STU3: EligibilityRequest.provider additional types from child elements (display, identifier, reference)

                      ShortSTU3: Responsible practitioner additional types
                      Comments

                      Element EligibilityRequest.provider is mapped to FHIR R5 element CoverageEligibilityRequest.provider as SourceIsBroaderThanTarget. The mappings for EligibilityRequest.provider do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element EligibilityRequest.provider with unmapped reference targets: Practitioner.

                      Control0..1
                      TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                      46. CoverageEligibilityRequest.provider.extension:organization
                      Slice Nameorganization
                      Definition

                      STU3: EligibilityRequest.organization additional types from child elements (display, identifier, reference)

                      ShortSTU3: Responsible organization additional types
                      Comments

                      Element EligibilityRequest.organization is mapped to FHIR R5 element CoverageEligibilityRequest.provider as RelatedTo. The mappings for EligibilityRequest.organization do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element EligibilityRequest.organization with unmapped reference targets: Organization.

                      Control0..1
                      TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                      48. CoverageEligibilityRequest.insurer
                      50. CoverageEligibilityRequest.insurer.extension
                      Control0..*
                      SlicingThis element introduces a set of slices on CoverageEligibilityRequest.insurer.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 52. CoverageEligibilityRequest.insurer.extension:insurer
                        Slice Nameinsurer
                        Definition

                        STU3: EligibilityRequest.insurer additional types from child elements (display, identifier, reference)

                        ShortSTU3: Target additional types
                        Comments

                        Element EligibilityRequest.insurer is mapped to FHIR R5 element CoverageEligibilityRequest.insurer as SourceIsBroaderThanTarget. The mappings for EligibilityRequest.insurer do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element EligibilityRequest.insurer with unmapped reference targets: Organization.

                        Control0..1
                        TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                        54. CoverageEligibilityRequest.facility
                        56. CoverageEligibilityRequest.facility.extension
                        Control0..*
                        SlicingThis element introduces a set of slices on CoverageEligibilityRequest.facility.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 58. CoverageEligibilityRequest.facility.extension:facility
                          Slice Namefacility
                          Definition

                          STU3: EligibilityRequest.facility additional types from child elements (display, identifier, reference)

                          ShortSTU3: Servicing Facility additional types
                          Comments

                          Element EligibilityRequest.facility is mapped to FHIR R5 element CoverageEligibilityRequest.facility as SourceIsBroaderThanTarget. The mappings for EligibilityRequest.facility do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element EligibilityRequest.facility with unmapped reference targets: Location.

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

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

                          0. CoverageEligibilityRequest
                          Definition

                          The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.

                          ShortCoverageEligibilityRequest resource
                          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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
                          dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
                          dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
                          dom-6: A resource should have narrative for robust management (text.`div`.exists())
                          2. CoverageEligibilityRequest.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

                          Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

                          Control0..1
                          Typeid
                          Is Modifierfalse
                          Must Supportfalse
                          Summarytrue
                          4. CoverageEligibilityRequest.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. CoverageEligibilityRequest.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
                          This element is affected by the following invariants: ele-1
                          Typeid
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          8. CoverageEligibilityRequest.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 CoverageEligibilityRequest.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 10. CoverageEligibilityRequest.meta.extension:meta
                            Slice Namemeta
                            Definition

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

                            ShortSTU3: meta additional types
                            Comments

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

                            Control0..1
                            TypeExtension(STU3: meta additional types) (Extension Type: Meta)
                            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())
                            12. CoverageEligibilityRequest.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. CoverageEligibilityRequest.meta.lastUpdated
                            Definition

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

                            ShortWhen the resource version last changed
                            Comments

                            This element is generally omitted in instances submitted in a PUT or POST. Instead, it is populated in the response instance and when retrieving information using a GET. 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. CoverageEligibilityRequest.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

                            The exact use of the source (and the possible implied Provenance.entity.role and agent.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. The source may correspond to Provenance.entity.what[x] or Provenance.agent.who[x], though it may be a more general or abstract reference.

                            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. CoverageEligibilityRequest.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. CoverageEligibilityRequest.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 AllSecurityLabels .
                            (extensible to http://hl7.org/fhir/ValueSet/security-labels|5.0.0)

                            Security Labels from the Healthcare Privacy and Security Classification System.

                            TypeCoding
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            22. CoverageEligibilityRequest.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|5.0.0)

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

                            TypeCoding
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            24. CoverageEligibilityRequest.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 its 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 its 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. CoverageEligibilityRequest.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 SHALL be taken from AllLanguages
                            (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

                            IETF language tag for a human language

                            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. CoverageEligibilityRequest.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 a 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
                            This element is affected by the following invariants: dom-6
                            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. CoverageEligibilityRequest.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
                            This element is affected by the following invariants: ele-1
                            Typeid
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            32. CoverageEligibilityRequest.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 CoverageEligibilityRequest.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 34. CoverageEligibilityRequest.text.extension:text
                              Slice Nametext
                              Definition

                              STU3: EligibilityRequest.text additional types (Narrative) additional types from child elements (div, status)

                              ShortSTU3: text additional types
                              Comments

                              Element EligibilityRequest.text is mapped to FHIR R5 element CoverageEligibilityRequest.text as SourceIsBroaderThanTarget. The mappings for EligibilityRequest.text do not cover the following types: Narrative. The mappings for EligibilityRequest.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. 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 in formation is added later.

                              Control0..1
                              TypeExtension(STU3: 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. CoverageEligibilityRequest.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|5.0.0)

                              The status of a resource narrative.

                              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. CoverageEligibilityRequest.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. CoverageEligibilityRequest.contained
                              Definition

                              These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

                              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..*
                              This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
                              TypeResource
                              Is Modifierfalse
                              Must Supportfalse
                              Summaryfalse
                              Alternate Namesinline resources, anonymous resources, contained resources
                              42. CoverageEligibilityRequest.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 CoverageEligibilityRequest.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 44. CoverageEligibilityRequest.extension:serviced
                                Slice Nameserviced
                                Definition

                                STU3: EligibilityRequest.serviced[x] additional types (Period) additional types from child elements (end, start)

                                ShortSTU3: Estimated date or dates of Service additional types
                                Comments

                                Element EligibilityRequest.serviced[x] is mapped to FHIR R5 element CoverageEligibilityRequest.serviced[x] as SourceIsBroaderThanTarget. The mappings for EligibilityRequest.serviced[x] do not cover the following types: Period. The mappings for EligibilityRequest.serviced[x] do not cover the following types based on type expansion: end, start. The target context CoverageEligibilityRequest.serviced[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element CoverageEligibilityRequest.

                                Control0..1
                                TypeExtension(STU3: Estimated date or dates of Service additional types) (Extension Type: Period)
                                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())
                                46. CoverageEligibilityRequest.extension:benefitCategory
                                Slice NamebenefitCategory
                                Definition

                                STU3: EligibilityRequest.benefitCategory (new:CodeableConcept)

                                ShortSTU3: Type of services covered (new)
                                Comments

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

                                Control0..1
                                TypeExtension(STU3: Type of services covered (new)) (Extension Type: CodeableConcept)
                                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())
                                48. CoverageEligibilityRequest.extension:benefitSubCategory
                                Slice NamebenefitSubCategory
                                Definition

                                STU3: EligibilityRequest.benefitSubCategory (new:CodeableConcept)

                                ShortSTU3: Detailed services covered within the type (new)
                                Comments

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

                                Control0..1
                                TypeExtension(STU3: Detailed services covered within the type (new)) (Extension Type: CodeableConcept)
                                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())
                                50. CoverageEligibilityRequest.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 managable, 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
                                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
                                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())
                                52. CoverageEligibilityRequest.identifier
                                Definition

                                A unique identifier assigned to this coverage eligiblity request.

                                ShortBusiness Identifier for coverage eligiblity request
                                NoteThis is a business identifier, not a resource identifier (see discussion)
                                Control0..*
                                TypeIdentifier
                                Is Modifierfalse
                                Must Supportfalse
                                Summaryfalse
                                Requirements

                                Allows coverage eligibility requests to be distinguished and referenced.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                54. CoverageEligibilityRequest.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
                                This element is affected by the following invariants: ele-1
                                Typeid
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                56. CoverageEligibilityRequest.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 CoverageEligibilityRequest.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 58. CoverageEligibilityRequest.identifier.extension:identifier
                                  Slice Nameidentifier
                                  Definition

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

                                  ShortSTU3: Business Identifier additional types
                                  Comments

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

                                  Control0..*
                                  TypeExtension(STU3: Business Identifier 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())
                                  60. CoverageEligibilityRequest.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|5.0.0)

                                  Identifies the purpose for this identifier, if known .

                                  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()))
                                  62. CoverageEligibilityRequest.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 IdentifierTypeCodes
                                  (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)

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

                                  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()))
                                  64. CoverageEligibilityRequest.identifier.system
                                  Definition

                                  Establishes the namespace for the value - that is, an absolute 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()))
                                  66. CoverageEligibilityRequest.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 http://hl7.org/fhir/StructureDefinition/rendered-value). 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
                                  This element is affected by the following invariants: ident-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()))
                                  68. CoverageEligibilityRequest.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()))
                                  70. CoverageEligibilityRequest.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()))
                                  72. CoverageEligibilityRequest.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 codes that mark the resource as not currently valid.

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

                                  A code specifying the state of the resource instance.

                                  Typecode
                                  Is Modifiertrue because This element is labeled 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()))
                                  74. CoverageEligibilityRequest.priority
                                  Definition

                                  When the requestor expects the processor to complete processing.

                                  ShortDesired processing priority
                                  Control0..1
                                  BindingFor example codes, see ProcessPriorityCodes
                                  (example to http://hl7.org/fhir/ValueSet/process-priority|5.0.0)

                                  The timeliness with which processing is required: STAT, normal, Deferred.

                                  TypeCodeableConcept
                                  Is Modifierfalse
                                  Must Supportfalse
                                  Summaryfalse
                                  Requirements

                                  Needed to advise the prossesor on the urgency of the request.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  76. CoverageEligibilityRequest.purpose
                                  Definition

                                  Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified.

                                  Shortauth-requirements | benefits | discovery | validation
                                  Control1..*
                                  BindingThe codes SHALL be taken from EligibilityRequestPurpose
                                  (required to http://hl7.org/fhir/ValueSet/eligibilityrequest-purpose|5.0.0)

                                  A code specifying the types of information being requested.

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

                                  To indicate the processing actions requested.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  78. CoverageEligibilityRequest.patient
                                  Definition

                                  The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.

                                  ShortIntended recipient of products and services
                                  Comments

                                  1..1.

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

                                  Required to provide context and coverage validation.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  80. CoverageEligibilityRequest.patient.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
                                  This element is affected by the following invariants: ele-1
                                  Typeid
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  82. CoverageEligibilityRequest.patient.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 CoverageEligibilityRequest.patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 84. CoverageEligibilityRequest.patient.extension:patient
                                    Slice Namepatient
                                    Definition

                                    STU3: EligibilityRequest.patient additional types from child elements (display, identifier, reference)

                                    ShortSTU3: The subject of the Products and Services additional types
                                    Comments

                                    Element EligibilityRequest.patient is mapped to FHIR R5 element CoverageEligibilityRequest.patient as SourceIsBroaderThanTarget. The mappings for EligibilityRequest.patient do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element EligibilityRequest.patient with unmapped reference targets: Patient. 1..1.

                                    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())
                                    86. CoverageEligibilityRequest.patient.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-2, 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()))
                                    88. CoverageEligibilityRequest.patient.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") - must be a resource in resources
                                    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 known RESTful URL) or by resolving the target of the reference.

                                    Control0..1
                                    BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                    (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)

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

                                    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()))
                                    90. CoverageEligibilityRequest.patient.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).

                                    This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

                                    NoteThis is a business identifier, not a resource identifier (see discussion)
                                    Control0..1
                                    This element is affected by the following invariants: ref-2
                                    TypeIdentifier
                                    Is Modifierfalse
                                    Summarytrue
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    92. CoverageEligibilityRequest.patient.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
                                    This element is affected by the following invariants: ref-2
                                    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()))
                                    94. CoverageEligibilityRequest.event
                                    Definition

                                    Information code for an event with a corresponding date or period.

                                    ShortEvent information
                                    Control0..*
                                    TypeBackboneElement
                                    Is Modifierfalse
                                    Must Supportfalse
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    96. CoverageEligibilityRequest.event.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
                                    This element is affected by the following invariants: ele-1
                                    Typestring
                                    Is Modifierfalse
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    Summaryfalse
                                    98. CoverageEligibilityRequest.event.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 managable, 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())
                                    100. CoverageEligibilityRequest.event.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 managable, 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())
                                    102. CoverageEligibilityRequest.event.type
                                    Definition

                                    A coded event such as when a service is expected or a card printed.

                                    ShortSpecific event
                                    Control1..1
                                    BindingFor example codes, see DatesTypeCodes
                                    (example to http://hl7.org/fhir/ValueSet/datestype|5.0.0)
                                    TypeCodeableConcept
                                    Is Modifierfalse
                                    Must Supportfalse
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    104. CoverageEligibilityRequest.event.when[x]
                                    Definition

                                    A date or period in the past or future indicating when the event occurred or is expectd to occur.

                                    ShortOccurance date or period
                                    Control1..1
                                    TypeChoice of: dateTime, Period
                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                    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()))
                                    106. CoverageEligibilityRequest.serviced[x]
                                    Definition

                                    The date or dates when the enclosed suite of services were performed or completed.

                                    ShortEstimated date or dates of service
                                    Control0..1
                                    TypeChoice of: date, Period
                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supportfalse
                                    Summaryfalse
                                    Requirements

                                    Required to provide time context for the request.

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

                                    The date when this resource was created.

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

                                    Need to record a timestamp for use by both the recipient and the issuer.

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

                                    Person who created the request.

                                    ShortAuthor
                                    Control0..1
                                    TypeReference(Practitioner, PractitionerRole)
                                    Is Modifierfalse
                                    Must Supportfalse
                                    Summaryfalse
                                    Requirements

                                    Some jurisdictions require the contact information for personnel completing eligibility requests.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    112. CoverageEligibilityRequest.enterer.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
                                    This element is affected by the following invariants: ele-1
                                    Typeid
                                    Is Modifierfalse
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    Summaryfalse
                                    114. CoverageEligibilityRequest.enterer.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 CoverageEligibilityRequest.enterer.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 116. CoverageEligibilityRequest.enterer.extension:enterer
                                      Slice Nameenterer
                                      Definition

                                      STU3: EligibilityRequest.enterer additional types from child elements (display, identifier, reference)

                                      ShortSTU3: enterer additional types
                                      Comments

                                      Element EligibilityRequest.enterer is mapped to FHIR R5 element CoverageEligibilityRequest.enterer as SourceIsBroaderThanTarget. The mappings for EligibilityRequest.enterer do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element EligibilityRequest.enterer with unmapped reference targets: Practitioner.

                                      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())
                                      118. CoverageEligibilityRequest.enterer.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-2, 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()))
                                      120. CoverageEligibilityRequest.enterer.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") - must be a resource in resources
                                      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 known RESTful URL) or by resolving the target of the reference.

                                      Control0..1
                                      BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                      (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)

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

                                      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()))
                                      122. CoverageEligibilityRequest.enterer.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).

                                      This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

                                      NoteThis is a business identifier, not a resource identifier (see discussion)
                                      Control0..1
                                      This element is affected by the following invariants: ref-2
                                      TypeIdentifier
                                      Is Modifierfalse
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      124. CoverageEligibilityRequest.enterer.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
                                      This element is affected by the following invariants: ref-2
                                      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()))
                                      126. CoverageEligibilityRequest.provider
                                      Definition

                                      The provider which is responsible for the request.

                                      ShortParty responsible for the request
                                      Comments

                                      Typically this field would be 1..1 where this party is accountable for the data content within the claim but is not necessarily the facility, provider group or practitioner who provided the products and services listed within this claim resource. This field is the Billing Provider, for example, a facility, provider group, lab or practitioner.

                                      Control0..1
                                      TypeReference(Practitioner, PractitionerRole, Organization)
                                      Is Modifierfalse
                                      Must Supportfalse
                                      Summaryfalse
                                      Requirements

                                      Needed to identify the requestor.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      128. CoverageEligibilityRequest.provider.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
                                      This element is affected by the following invariants: ele-1
                                      Typeid
                                      Is Modifierfalse
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      Summaryfalse
                                      130. CoverageEligibilityRequest.provider.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 CoverageEligibilityRequest.provider.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 132. CoverageEligibilityRequest.provider.extension:provider
                                        Slice Nameprovider
                                        Definition

                                        STU3: EligibilityRequest.provider additional types from child elements (display, identifier, reference)

                                        ShortSTU3: Responsible practitioner additional types
                                        Comments

                                        Element EligibilityRequest.provider is mapped to FHIR R5 element CoverageEligibilityRequest.provider as SourceIsBroaderThanTarget. The mappings for EligibilityRequest.provider do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element EligibilityRequest.provider with unmapped reference targets: Practitioner.

                                        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())
                                        134. CoverageEligibilityRequest.provider.extension:organization
                                        Slice Nameorganization
                                        Definition

                                        STU3: EligibilityRequest.organization additional types from child elements (display, identifier, reference)

                                        ShortSTU3: Responsible organization additional types
                                        Comments

                                        Element EligibilityRequest.organization is mapped to FHIR R5 element CoverageEligibilityRequest.provider as RelatedTo. The mappings for EligibilityRequest.organization do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element EligibilityRequest.organization 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())
                                        136. CoverageEligibilityRequest.provider.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-2, 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()))
                                        138. CoverageEligibilityRequest.provider.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") - must be a resource in resources
                                        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 known RESTful URL) or by resolving the target of the reference.

                                        Control0..1
                                        BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                        (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)

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

                                        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()))
                                        140. CoverageEligibilityRequest.provider.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).

                                        This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

                                        NoteThis is a business identifier, not a resource identifier (see discussion)
                                        Control0..1
                                        This element is affected by the following invariants: ref-2
                                        TypeIdentifier
                                        Is Modifierfalse
                                        Summarytrue
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        142. CoverageEligibilityRequest.provider.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
                                        This element is affected by the following invariants: ref-2
                                        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()))
                                        144. CoverageEligibilityRequest.insurer
                                        Definition

                                        The Insurer who issued the coverage in question and is the recipient of the request.

                                        ShortCoverage issuer
                                        Control1..1
                                        TypeReference(Organization)
                                        Is Modifierfalse
                                        Must Supportfalse
                                        Summarytrue
                                        Requirements

                                        Need to identify the recipient.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        146. CoverageEligibilityRequest.insurer.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
                                        This element is affected by the following invariants: ele-1
                                        Typeid
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        148. CoverageEligibilityRequest.insurer.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 CoverageEligibilityRequest.insurer.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • value @ url
                                        • 150. CoverageEligibilityRequest.insurer.extension:insurer
                                          Slice Nameinsurer
                                          Definition

                                          STU3: EligibilityRequest.insurer additional types from child elements (display, identifier, reference)

                                          ShortSTU3: Target additional types
                                          Comments

                                          Element EligibilityRequest.insurer is mapped to FHIR R5 element CoverageEligibilityRequest.insurer as SourceIsBroaderThanTarget. The mappings for EligibilityRequest.insurer do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element EligibilityRequest.insurer 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())
                                          152. CoverageEligibilityRequest.insurer.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-2, 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()))
                                          154. CoverageEligibilityRequest.insurer.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") - must be a resource in resources
                                          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 known RESTful URL) or by resolving the target of the reference.

                                          Control0..1
                                          BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                          (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)

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

                                          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()))
                                          156. CoverageEligibilityRequest.insurer.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).

                                          This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

                                          NoteThis is a business identifier, not a resource identifier (see discussion)
                                          Control0..1
                                          This element is affected by the following invariants: ref-2
                                          TypeIdentifier
                                          Is Modifierfalse
                                          Summarytrue
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          158. CoverageEligibilityRequest.insurer.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
                                          This element is affected by the following invariants: ref-2
                                          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()))
                                          160. CoverageEligibilityRequest.facility
                                          Definition

                                          Facility where the services are intended to be provided.

                                          ShortServicing facility
                                          Control0..1
                                          TypeReference(Location)
                                          Is Modifierfalse
                                          Must Supportfalse
                                          Summaryfalse
                                          Requirements

                                          Insurance adjudication can be dependant on where services were delivered.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          162. CoverageEligibilityRequest.facility.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
                                          This element is affected by the following invariants: ele-1
                                          Typeid
                                          Is Modifierfalse
                                          XML FormatIn the XML format, this property is represented as an attribute.
                                          Summaryfalse
                                          164. CoverageEligibilityRequest.facility.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 CoverageEligibilityRequest.facility.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 166. CoverageEligibilityRequest.facility.extension:facility
                                            Slice Namefacility
                                            Definition

                                            STU3: EligibilityRequest.facility additional types from child elements (display, identifier, reference)

                                            ShortSTU3: Servicing Facility additional types
                                            Comments

                                            Element EligibilityRequest.facility is mapped to FHIR R5 element CoverageEligibilityRequest.facility as SourceIsBroaderThanTarget. The mappings for EligibilityRequest.facility do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element EligibilityRequest.facility with unmapped reference targets: Location.

                                            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())
                                            168. CoverageEligibilityRequest.facility.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-2, 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()))
                                            170. CoverageEligibilityRequest.facility.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") - must be a resource in resources
                                            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 known RESTful URL) or by resolving the target of the reference.

                                            Control0..1
                                            BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                            (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)

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

                                            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()))
                                            172. CoverageEligibilityRequest.facility.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).

                                            This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

                                            NoteThis is a business identifier, not a resource identifier (see discussion)
                                            Control0..1
                                            This element is affected by the following invariants: ref-2
                                            TypeIdentifier
                                            Is Modifierfalse
                                            Summarytrue
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            174. CoverageEligibilityRequest.facility.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
                                            This element is affected by the following invariants: ref-2
                                            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()))
                                            176. CoverageEligibilityRequest.supportingInfo
                                            Definition

                                            Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.

                                            ShortSupporting information
                                            Comments

                                            Often there are multiple jurisdiction specific valuesets which are required.

                                            Control0..*
                                            TypeBackboneElement
                                            Is Modifierfalse
                                            Must Supportfalse
                                            Summaryfalse
                                            Requirements

                                            Typically these information codes are required to support the services rendered or the adjudication of the services rendered.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            178. CoverageEligibilityRequest.supportingInfo.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
                                            This element is affected by the following invariants: ele-1
                                            Typestring
                                            Is Modifierfalse
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            Summaryfalse
                                            180. CoverageEligibilityRequest.supportingInfo.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 managable, 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())
                                            182. CoverageEligibilityRequest.supportingInfo.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 managable, 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())
                                            184. CoverageEligibilityRequest.supportingInfo.sequence
                                            Definition

                                            A number to uniquely identify supporting information entries.

                                            ShortInformation instance identifier
                                            Control1..1
                                            TypepositiveInt
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Must Supportfalse
                                            Summaryfalse
                                            Requirements

                                            Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            186. CoverageEligibilityRequest.supportingInfo.information
                                            Definition

                                            Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

                                            ShortData to be provided
                                            Comments

                                            Could be used to provide references to other resources, document. For example could contain a PDF in an Attachment of the Police Report for an Accident.

                                            Control1..1
                                            TypeReference(Resource)
                                            Is Modifierfalse
                                            Must Supportfalse
                                            Summaryfalse
                                            Requirements

                                            To convey the data content to be provided when the information is more than a simple code or period.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            188. CoverageEligibilityRequest.supportingInfo.appliesToAll
                                            Definition

                                            The supporting materials are applicable for all detail items, product/servce categories and specific billing codes.

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

                                            Needed to convey that the information is universal to the request.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            190. CoverageEligibilityRequest.insurance
                                            Definition

                                            Financial instruments for reimbursement for the health care products and services.

                                            ShortPatient insurance information
                                            Comments

                                            All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.

                                            Control0..*
                                            TypeBackboneElement
                                            Is Modifierfalse
                                            Must Supportfalse
                                            Summaryfalse
                                            Requirements

                                            There must be at least one coverage for which eligibility is requested.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            192. CoverageEligibilityRequest.insurance.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
                                            This element is affected by the following invariants: ele-1
                                            Typestring
                                            Is Modifierfalse
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            Summaryfalse
                                            194. CoverageEligibilityRequest.insurance.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 managable, 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())
                                            196. CoverageEligibilityRequest.insurance.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 managable, 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())
                                            198. CoverageEligibilityRequest.insurance.focal
                                            Definition

                                            A flag to indicate that this Coverage is to be used for evaluation of this request when set to true.

                                            ShortApplicable coverage
                                            Comments

                                            A patient may (will) have multiple insurance policies which provide reimburement for healthcare services and products. For example a person may also be covered by their spouse's policy and both appear in the list (and may be from the same insurer). This flag will be set to true for only one of the listed policies and that policy will be used for evaluating this request. Other requests would be created to request evaluation against the other listed policies.

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

                                            To identify which coverage in the list is being used to evaluate this request.

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

                                            Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.

                                            ShortInsurance information
                                            Control1..1
                                            TypeReference(Coverage)
                                            Is Modifierfalse
                                            Must Supportfalse
                                            Summaryfalse
                                            Requirements

                                            Required to allow the adjudicator to locate the correct policy and history within their information system.

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

                                            A business agreement number established between the provider and the insurer for special business processing purposes.

                                            ShortAdditional provider contract number
                                            Control0..1
                                            Typestring
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Must Supportfalse
                                            Summaryfalse
                                            Requirements

                                            Providers may have multiple business arrangements with a given insurer and must supply the specific contract number for adjudication.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            204. CoverageEligibilityRequest.item
                                            Definition

                                            Service categories or billable services for which benefit details and/or an authorization prior to service delivery may be required by the payor.

                                            ShortItem to be evaluated for eligibiity
                                            Control0..*
                                            TypeBackboneElement
                                            Is Modifierfalse
                                            Must Supportfalse
                                            Summaryfalse
                                            Requirements

                                            The items to be processed for the request.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            206. CoverageEligibilityRequest.item.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
                                            This element is affected by the following invariants: ele-1
                                            Typestring
                                            Is Modifierfalse
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            Summaryfalse
                                            208. CoverageEligibilityRequest.item.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 managable, 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())
                                            210. CoverageEligibilityRequest.item.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 managable, 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())
                                            212. CoverageEligibilityRequest.item.supportingInfoSequence
                                            Definition

                                            Exceptions, special conditions and supporting information applicable for this service or product line.

                                            ShortApplicable exception or supporting information
                                            Control0..*
                                            TypepositiveInt
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Must Supportfalse
                                            Summaryfalse
                                            Requirements

                                            Needed to support or inform the consideration for eligibility.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            214. CoverageEligibilityRequest.item.category
                                            Definition

                                            Code to identify the general type of benefits under which products and services are provided.

                                            ShortBenefit classification
                                            Comments

                                            Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.

                                            Control0..1
                                            BindingFor example codes, see BenefitCategoryCodes
                                            (example to http://hl7.org/fhir/ValueSet/ex-benefitcategory|5.0.0)

                                            Benefit categories such as: oral, medical, vision etc.

                                            TypeCodeableConcept
                                            Is Modifierfalse
                                            Must Supportfalse
                                            Summaryfalse
                                            Requirements

                                            Needed to convey the category of service or product for which eligibility is sought.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            216. CoverageEligibilityRequest.item.productOrService
                                            Definition

                                            This contains the product, service, drug or other billing code for the item.

                                            ShortBilling, service, product, or drug code
                                            Comments

                                            Code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI).

                                            Control0..1
                                            BindingFor example codes, see USCLSCodes
                                            (example to http://hl7.org/fhir/ValueSet/service-uscls|5.0.0)

                                            Allowable service and product codes.

                                            TypeCodeableConcept
                                            Is Modifierfalse
                                            Must Supportfalse
                                            Summaryfalse
                                            Requirements

                                            Needed to convey the actual service or product for which eligibility is sought.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            218. CoverageEligibilityRequest.item.modifier
                                            Definition

                                            Item typification or modifiers codes to convey additional context for the product or service.

                                            ShortProduct or service billing modifiers
                                            Comments

                                            For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours.

                                            Control0..*
                                            BindingFor example codes, see ModifierTypeCodes
                                            (example to http://hl7.org/fhir/ValueSet/claim-modifiers|5.0.0)

                                            Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.

                                            TypeCodeableConcept
                                            Is Modifierfalse
                                            Must Supportfalse
                                            Summaryfalse
                                            Requirements

                                            To support provision of the item or to charge an elevated fee.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            220. CoverageEligibilityRequest.item.provider
                                            Definition

                                            The practitioner who is responsible for the product or service to be rendered to the patient.

                                            ShortPerfoming practitioner
                                            Control0..1
                                            TypeReference(Practitioner, PractitionerRole)
                                            Is Modifierfalse
                                            Must Supportfalse
                                            Summaryfalse
                                            Requirements

                                            Needed to support the evaluation of the eligibility.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            222. CoverageEligibilityRequest.item.quantity
                                            Definition

                                            The number of repetitions of a service or product.

                                            ShortCount of products or services
                                            Control0..1
                                            TypeQuantity(SimpleQuantity)
                                            Is Modifierfalse
                                            Must Supportfalse
                                            Summaryfalse
                                            Requirements

                                            Required when the product or service code does not convey the quantity provided.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            224. CoverageEligibilityRequest.item.unitPrice
                                            Definition

                                            The amount charged to the patient by the provider for a single unit.

                                            ShortFee, charge or cost per item
                                            Control0..1
                                            TypeMoney
                                            Is Modifierfalse
                                            Must Supportfalse
                                            Summaryfalse
                                            Requirements

                                            Needed to support the evaluation of the eligibility.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            226. CoverageEligibilityRequest.item.facility
                                            Definition

                                            Facility where the services will be provided.

                                            ShortServicing facility
                                            Control0..1
                                            TypeReference(Location, Organization)
                                            Is Modifierfalse
                                            Must Supportfalse
                                            Summaryfalse
                                            Requirements

                                            Needed to support the evaluation of the eligibility.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            228. CoverageEligibilityRequest.item.diagnosis
                                            Definition

                                            Patient diagnosis for which care is sought.

                                            ShortApplicable diagnosis
                                            Control0..*
                                            TypeBackboneElement
                                            Is Modifierfalse
                                            Must Supportfalse
                                            Summaryfalse
                                            Requirements

                                            Needed to support the evaluation of the eligibility.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            230. CoverageEligibilityRequest.item.diagnosis.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
                                            This element is affected by the following invariants: ele-1
                                            Typestring
                                            Is Modifierfalse
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            Summaryfalse
                                            232. CoverageEligibilityRequest.item.diagnosis.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 managable, 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())
                                            234. CoverageEligibilityRequest.item.diagnosis.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 managable, 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())
                                            236. CoverageEligibilityRequest.item.diagnosis.diagnosis[x]
                                            Definition

                                            The nature of illness or problem in a coded form or as a reference to an external defined Condition.

                                            ShortNature of illness or problem
                                            Control0..1
                                            BindingFor example codes, see ICD10Codes
                                            (example to http://hl7.org/fhir/ValueSet/icd-10|5.0.0)

                                            ICD10 Diagnostic codes.

                                            TypeChoice of: CodeableConcept, Reference(Condition)
                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                            Is Modifierfalse
                                            Must Supportfalse
                                            Summaryfalse
                                            Requirements

                                            Provides health context for the evaluation of the products and/or services.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            238. CoverageEligibilityRequest.item.detail
                                            Definition

                                            The plan/proposal/order describing the proposed service in detail.

                                            ShortProduct or service details
                                            Control0..*
                                            TypeReference(Resource)
                                            Is Modifierfalse
                                            Must Supportfalse
                                            Summaryfalse
                                            Requirements

                                            Needed to provide complex service proposal such as a Device or a plan.

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