0.1.0 - ci-build

kenyaClaimsIG - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: SHACoverageEligibilityResponse - Detailed Descriptions

Draft as of 2024-09-06

Definitions for the SHACoverageEligibilityResponse resource profile.

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

0. CoverageEligibilityResponse
2. CoverageEligibilityResponse.id
ShortA logical identifier for the messageHeader resource.
Control1..?
4. CoverageEligibilityResponse.meta
ShortMetadata about a resource
Control1..?
6. CoverageEligibilityResponse.meta.profile
Control1..?
8. CoverageEligibilityResponse.extension
ShortOptional Extensions Element
SlicingThis element introduces a set of slices on CoverageEligibilityResponse.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 10. CoverageEligibilityResponse.extension:siteEligibility
    Slice NamesiteEligibility
    Control0..*
    TypeExtension(SiteEligibility) (Extension Type: CodeableConcept)
    12. CoverageEligibilityResponse.identifier
    ShortA business unique identifier for the CoverageEligibilityResponse resource.
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control1..1
    14. CoverageEligibilityResponse.status
    ShortFinancial Resource Status Code. Must use the fixed value 'active'
    Pattern Valueactive
    16. CoverageEligibilityResponse.purpose
    ShortEligibilityResponsePurpose
    18. CoverageEligibilityResponse.patient
    ShortIntended recipient of products and services. A reference Patient resource
    TypeReference(SHAPatient)
    20. CoverageEligibilityResponse.serviced[x]
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    SlicingThis element introduces a set of slices on CoverageEligibilityResponse.serviced[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • type @ $this
    • 22. CoverageEligibilityResponse.serviced[x]:servicedDate
      Slice NameservicedDate
      ShortThe date or dates when the enclosed suite of services were performed or completed.
      Control0..1
      Typedate
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      24. CoverageEligibilityResponse.serviced[x]:servicedPeriod
      Slice NameservicedPeriod
      ShortThe period when the enclosed suite of services were performed or completed.
      Control0..1
      TypePeriod
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      26. CoverageEligibilityResponse.created
      ShortCreation date of this CoverageEligibilityRequest
      28. CoverageEligibilityResponse.request
      ShortEligibility request reference. A reference to the CoverageEligibilityRequest message
      TypeReference(SHACoverageEligibilityRequest)
      30. CoverageEligibilityResponse.outcome
      ShortPayer processing outcome.
      32. CoverageEligibilityResponse.disposition
      ShortA human readable description of the status of the adjudication.
      34. CoverageEligibilityResponse.insurer
      ShortCoverage issuer. A reference to the payor organization license issed by the regulator and maintained in the registry. Use the reference.identifier for well know identifiers.
      TypeReference(SHAOrganization)
      36. CoverageEligibilityResponse.insurance
      ShortFinancial instruments for reimbursement for the health care products and services.
      38. CoverageEligibilityResponse.insurance.extension
      SlicingThis element introduces a set of slices on CoverageEligibilityResponse.insurance.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 40. CoverageEligibilityResponse.insurance.extension:siteEligibility
        Slice NamesiteEligibility
        Control0..1
        TypeExtension(SiteEligibility) (Extension Type: CodeableConcept)
        42. CoverageEligibilityResponse.insurance.coverage
        ShortInsurance information. A Reference to the insurance coverage resource
        TypeReference(SHACoverage)
        44. CoverageEligibilityResponse.insurance.inforce
        ShortA flag to indicate if the insurance coverage supplied is expected to be inforce as of the service date supplied or today if no service date supplied.
        Control1..?
        46. CoverageEligibilityResponse.insurance.benefitPeriod
        48. CoverageEligibilityResponse.insurance.benefitPeriod.start
        Shortstart date of the benefits
        Control1..?
        50. CoverageEligibilityResponse.insurance.benefitPeriod.end
        Shortend date of the benefits
        Control1..?
        52. CoverageEligibilityResponse.insurance.item
        54. CoverageEligibilityResponse.insurance.item.category
        ShortBenefit classification. Code to identify the general type of benefits under which products and services are provided. Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.
        56. CoverageEligibilityResponse.insurance.item.excluded
        ShortIndicates whether the benefit is excluded by the policy.
        58. CoverageEligibilityResponse.insurance.item.network
        ShortIn or out of network (Contracted of not contracted)
        Control1..?
        60. CoverageEligibilityResponse.insurance.item.unit
        Control1..?
        62. CoverageEligibilityResponse.insurance.item.term
        Control1..?
        64. CoverageEligibilityResponse.insurance.item.benefit
        ShortTerm for limites such as per day, annual or lifetime
        66. CoverageEligibilityResponse.insurance.item.benefit.allowed[x]
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        SlicingThis element introduces a set of slices on CoverageEligibilityResponse.insurance.item.benefit.allowed[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • type @ $this
        • 68. CoverageEligibilityResponse.insurance.item.benefit.allowed[x]:allowedUnsignedInt
          Slice NameallowedUnsignedInt
          Control0..1
          TypeunsignedInt
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          70. CoverageEligibilityResponse.insurance.item.benefit.allowed[x]:allowedString
          Slice NameallowedString
          Control0..1
          Typestring
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          72. CoverageEligibilityResponse.insurance.item.benefit.allowed[x]:allowedMoney
          Slice NameallowedMoney
          Control0..1
          TypeMoney
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          74. CoverageEligibilityResponse.insurance.item.benefit.used[x]
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          SlicingThis element introduces a set of slices on CoverageEligibilityResponse.insurance.item.benefit.used[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • type @ $this
          • 76. CoverageEligibilityResponse.insurance.item.benefit.used[x]:usedUnsignedInt
            Slice NameusedUnsignedInt
            Control0..1
            TypeunsignedInt
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            78. CoverageEligibilityResponse.insurance.item.benefit.used[x]:usedString
            Slice NameusedString
            Control0..1
            Typestring
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            80. CoverageEligibilityResponse.insurance.item.benefit.used[x]:usedMoney
            Slice NameusedMoney
            Control0..1
            TypeMoney
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            82. CoverageEligibilityResponse.error
            ShortErrors encountered during the processing of the request
            84. CoverageEligibilityResponse.error.extension
            ShortOptional Extensions Element
            SlicingThis element introduces a set of slices on CoverageEligibilityResponse.error.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 86. CoverageEligibilityResponse.error.extension:errorExtensionExpression
              Slice NameerrorExtensionExpression
              Control0..1
              TypeExtension(ErrorExtensionExpression) (Extension Type: string)
              88. CoverageEligibilityResponse.error.code
              ShortAn error code,from a specified code system, which details why the eligibility check could not be performed

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

              0. CoverageEligibilityResponse
              Definition

              This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.

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

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

              ShortA logical identifier for the messageHeader resource.Logical id of this artifact
              Comments

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

              Control10..1
              Typeidstring
              Is Modifierfalse
              Summarytrue
              4. CoverageEligibilityResponse.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 a resourceMetadata about the resource
              Control10..1
              TypeMeta
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              6. CoverageEligibilityResponse.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.

              Control10..*
              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()))
              8. CoverageEligibilityResponse.implicitRules
              Definition

              A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

              ShortA set of rules under which this content was created
              Comments

              Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

              Control0..1
              Typeuri
              Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              10. CoverageEligibilityResponse.extension
              Definition

              An Extension


              May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              ShortOptional Extensions ElementAdditional content defined by implementations
              Comments

              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              SlicingThis element introduces a set of slices on CoverageEligibilityResponse.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 12. CoverageEligibilityResponse.extension:siteEligibility
                Slice NamesiteEligibility
                Definition

                An extension to indicate whether the patient is eligible or not eligible and why

                ShortSiteEligibility
                Control0..*
                This element is affected by the following invariants: ele-1
                TypeExtension(SiteEligibility) (Extension Type: CodeableConcept)
                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())
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                14. CoverageEligibilityResponse.modifierExtension
                Definition

                May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                ShortExtensions that cannot be ignored
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                Summaryfalse
                Requirements

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

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

                A unique identifier assigned to this coverage eligiblity request.

                ShortA business unique identifier for the CoverageEligibilityResponse resource.Business Identifier for coverage eligiblity request
                NoteThis is a business identifier, not a resource identifier (see discussion)
                Control10..1*
                TypeIdentifier
                Is Modifierfalse
                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()))
                18. CoverageEligibilityResponse.status
                Definition

                The status of the resource instance.

                ShortFinancial Resource Status Code. Must use the fixed value 'active'active | 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|4.0.1
                (required to http://hl7.org/fhir/ValueSet/fm-status|4.0.1)

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

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

                ShortEligibilityResponsePurposeauth-requirements | benefits | discovery | validation
                Control1..*
                BindingThe codes SHALL be taken from EligibilityResponsePurposehttp://hl7.org/fhir/ValueSet/eligibilityresponse-purpose|4.0.1
                (required to http://hl7.org/fhir/ValueSet/eligibilityresponse-purpose|4.0.1)

                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
                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()))
                22. CoverageEligibilityResponse.patient
                Definition

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

                ShortIntended recipient of products and services. A reference Patient resource
                Control1..1
                TypeReference(SHAPatient, Patient)
                Is Modifierfalse
                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()))
                24. CoverageEligibilityResponse.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
                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()))
                SlicingThis element introduces a set of slices on CoverageEligibilityResponse.serviced[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                • type @ $this
                • 26. CoverageEligibilityResponse.serviced[x]:servicedDate
                  Slice NameservicedDate
                  Definition

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

                  ShortThe date or dates when the enclosed suite of services were performed or completed.Estimated date or dates of service
                  Control0..1
                  Typedate, 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
                  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()))
                  28. CoverageEligibilityResponse.serviced[x]:servicedPeriod
                  Slice NameservicedPeriod
                  Definition

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

                  ShortThe period when the enclosed suite of services were performed or completed.Estimated date or dates of service
                  Control0..1
                  TypePeriod, date
                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                  Is Modifierfalse
                  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()))
                  30. CoverageEligibilityResponse.created
                  Definition

                  The date this resource was created.

                  ShortCreation date of this CoverageEligibilityRequestResponse creation date
                  Control1..1
                  TypedateTime
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  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()))
                  32. CoverageEligibilityResponse.request
                  Definition

                  Reference to the original request resource.

                  ShortEligibility request reference. A reference to the CoverageEligibilityRequest message
                  Control1..1
                  TypeReference(SHACoverageEligibilityRequest, CoverageEligibilityRequest)
                  Is Modifierfalse
                  Summarytrue
                  Requirements

                  Needed to allow the response to be linked to the request.

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

                  The outcome of the request processing.

                  ShortPayer processing outcome.queued | complete | error | partial
                  Comments

                  The resource may be used to indicate that: the request has been held (queued) for processing; that it has been processed and errors found (error); that no errors were found and that some of the adjudication has been undertaken (partial) or that all of the adjudication has been undertaken (complete).

                  Control1..1
                  BindingThe codes SHALL be taken from ClaimProcessingCodeshttp://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1
                  (required to http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1)

                  The outcome of the processing.

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

                  To advise the requestor of an overall processing outcome.

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

                  A human readable description of the status of the adjudication.

                  ShortA human readable description of the status of the adjudication.Disposition Message
                  Control0..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summaryfalse
                  Requirements

                  Provided for user display.

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

                  The Insurer who issued the coverage in question and is the author of the response.

                  ShortCoverage issuer. A reference to the payor organization license issed by the regulator and maintained in the registry. Use the reference.identifier for well know identifiers.
                  Control1..1
                  TypeReference(SHAOrganization, Organization)
                  Is Modifierfalse
                  Summarytrue
                  Requirements

                  Need to identify the author.

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

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

                  ShortFinancial instruments for reimbursement for the health care products and services.Patient 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
                  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()))
                  42. CoverageEligibilityResponse.insurance.extension
                  Definition

                  An Extension


                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  ShortExtensionAdditional content defined by implementations
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  SlicingThis element introduces a set of slices on CoverageEligibilityResponse.insurance.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 44. CoverageEligibilityResponse.insurance.extension:siteEligibility
                    Slice NamesiteEligibility
                    Definition

                    An extension to indicate whether the patient is eligible or not eligible and why

                    ShortSiteEligibility
                    Control0..1
                    This element is affected by the following invariants: ele-1
                    TypeExtension(SiteEligibility) (Extension Type: CodeableConcept)
                    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())
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    46. CoverageEligibilityResponse.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                    ShortExtensions that cannot be ignored even if unrecognized
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                    Summarytrue
                    Requirements

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

                    Alternate Namesextensions, user content, modifiers
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    48. CoverageEligibilityResponse.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. A Reference to the insurance coverage resource
                    Control1..1
                    TypeReference(SHACoverage, Coverage)
                    Is Modifierfalse
                    Summarytrue
                    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()))
                    50. CoverageEligibilityResponse.insurance.inforce
                    Definition

                    Flag indicating if the coverage provided is inforce currently if no service date(s) specified or for the whole duration of the service dates.

                    ShortA flag to indicate if the insurance coverage supplied is expected to be inforce as of the service date supplied or today if no service date supplied.Coverage inforce indicator
                    Control10..1
                    Typeboolean
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summaryfalse
                    Requirements

                    Needed to convey the answer to the eligibility validation request.

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

                    Errors encountered during the processing of the request.

                    ShortErrors encountered during the processing of the requestProcessing errors
                    Control0..*
                    TypeBackboneElement
                    Is Modifierfalse
                    Summaryfalse
                    Requirements

                    Need to communicate processing issues to the requestor.

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

                    An Extension


                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    ShortOptional Extensions ElementAdditional content defined by implementations
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Alternate Namesextensions, user content
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    SlicingThis element introduces a set of slices on CoverageEligibilityResponse.error.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 56. CoverageEligibilityResponse.error.extension:errorExtensionExpression
                      Slice NameerrorExtensionExpression
                      Definition

                      ErrorExtensionExpression

                      ShortErrorExtensionExpression
                      Control0..1
                      This element is affected by the following invariants: ele-1
                      TypeExtension(ErrorExtensionExpression) (Extension Type: string)
                      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())
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      58. CoverageEligibilityResponse.error.modifierExtension
                      Definition

                      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                      ShortExtensions that cannot be ignored even if unrecognized
                      Comments

                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                      Control0..*
                      TypeExtension
                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                      Summarytrue
                      Requirements

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

                      Alternate Namesextensions, user content, modifiers
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      60. CoverageEligibilityResponse.error.code
                      Definition

                      An error code,from a specified code system, which details why the eligibility check could not be performed.

                      ShortAn error code,from a specified code system, which details why the eligibility check could not be performedError code detailing processing issues
                      Control1..1
                      BindingFor example codes, see Adjudication Error Codeshttp://hl7.org/fhir/ValueSet/adjudication-error
                      (example to http://hl7.org/fhir/ValueSet/adjudication-error)

                      The error codes for adjudication processing.

                      TypeCodeableConcept
                      Is Modifierfalse
                      Summaryfalse
                      Requirements

                      Required to convey processing errors.

                      Invariantsele-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 found here

                      0. CoverageEligibilityResponse
                      Definition

                      This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.

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

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

                      ShortA logical identifier for the messageHeader resource.
                      Comments

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

                      Control1..1
                      Typeid
                      Is Modifierfalse
                      Summarytrue
                      4. CoverageEligibilityResponse.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 a resource
                      Control1..1
                      TypeMeta
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      6. CoverageEligibilityResponse.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
                      Typestring
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      8. CoverageEligibilityResponse.meta.extension
                      Definition

                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                      ShortAdditional content defined by implementations
                      Comments

                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                      Control0..*
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      Alternate Namesextensions, user content
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      SlicingThis element introduces a set of slices on CoverageEligibilityResponse.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 10. CoverageEligibilityResponse.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()))
                        12. CoverageEligibilityResponse.meta.lastUpdated
                        Definition

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

                        ShortWhen the resource version last changed
                        Comments

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

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

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

                        ShortIdentifies where the resource comes from
                        Comments

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

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

                        Control0..1
                        Typeuri
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        16. CoverageEligibilityResponse.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.

                        Control1..*
                        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()))
                        18. CoverageEligibilityResponse.meta.security
                        Definition

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

                        ShortSecurity Labels applied to this resource
                        Comments

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

                        Control0..*
                        BindingUnless not suitable, these codes SHALL be taken from All Security Labels
                        (extensible to http://hl7.org/fhir/ValueSet/security-labels)

                        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()))
                        20. CoverageEligibilityResponse.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)

                        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()))
                        22. CoverageEligibilityResponse.implicitRules
                        Definition

                        A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

                        ShortA set of rules under which this content was created
                        Comments

                        Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

                        Control0..1
                        Typeuri
                        Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        24. CoverageEligibilityResponse.language
                        Definition

                        The base language in which the resource is written.

                        ShortLanguage of the resource content
                        Comments

                        Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

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

                        A human language.

                        Additional BindingsPurpose
                        AllLanguagesMax Binding
                        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()))
                        26. CoverageEligibilityResponse.text
                        Definition

                        A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

                        ShortText summary of the resource, for human interpretation
                        Comments

                        Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

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

                        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

                        ShortContained, inline Resources
                        Comments

                        This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

                        Control0..*
                        TypeResource
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesinline resources, anonymous resources, contained resources
                        30. CoverageEligibilityResponse.extension
                        Definition

                        An Extension

                        ShortOptional Extensions Element
                        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 CoverageEligibilityResponse.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 32. CoverageEligibilityResponse.extension:siteEligibility
                          Slice NamesiteEligibility
                          Definition

                          An extension to indicate whether the patient is eligible or not eligible and why

                          ShortSiteEligibility
                          Control0..*
                          This element is affected by the following invariants: ele-1
                          TypeExtension(SiteEligibility) (Extension Type: CodeableConcept)
                          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())
                          34. CoverageEligibilityResponse.modifierExtension
                          Definition

                          May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                          ShortExtensions that cannot be ignored
                          Comments

                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                          Control0..*
                          TypeExtension
                          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                          Summaryfalse
                          Requirements

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

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

                          A unique identifier assigned to this coverage eligiblity request.

                          ShortA business unique identifier for the CoverageEligibilityResponse resource.
                          NoteThis is a business identifier, not a resource identifier (see discussion)
                          Control1..1
                          TypeIdentifier
                          Is Modifierfalse
                          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()))
                          38. CoverageEligibilityResponse.status
                          Definition

                          The status of the resource instance.

                          ShortFinancial Resource Status Code. Must use the fixed value 'active'
                          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|4.0.1)

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

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

                          ShortEligibilityResponsePurpose
                          Control1..*
                          BindingThe codes SHALL be taken from EligibilityResponsePurpose
                          (required to http://hl7.org/fhir/ValueSet/eligibilityresponse-purpose|4.0.1)

                          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
                          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()))
                          42. CoverageEligibilityResponse.patient
                          Definition

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

                          ShortIntended recipient of products and services. A reference Patient resource
                          Control1..1
                          TypeReference(SHAPatient)
                          Is Modifierfalse
                          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()))
                          44. CoverageEligibilityResponse.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
                          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()))
                          SlicingThis element introduces a set of slices on CoverageEligibilityResponse.serviced[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                          • type @ $this
                          • 46. CoverageEligibilityResponse.serviced[x]:servicedDate
                            Slice NameservicedDate
                            Definition

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

                            ShortThe date or dates when the enclosed suite of services were performed or completed.
                            Control0..1
                            Typedate
                            [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
                            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()))
                            48. CoverageEligibilityResponse.serviced[x]:servicedPeriod
                            Slice NameservicedPeriod
                            Definition

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

                            ShortThe period when the enclosed suite of services were performed or completed.
                            Control0..1
                            TypePeriod
                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                            Is Modifierfalse
                            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()))
                            50. CoverageEligibilityResponse.created
                            Definition

                            The date this resource was created.

                            ShortCreation date of this CoverageEligibilityRequest
                            Control1..1
                            TypedateTime
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            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()))
                            52. CoverageEligibilityResponse.requestor
                            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 responsible for the claim but not necessarily professionally responsible for the provision of the individual products and services listed below.

                            Control0..1
                            TypeReference(Practitioner, PractitionerRole, Organization)
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            54. CoverageEligibilityResponse.request
                            Definition

                            Reference to the original request resource.

                            ShortEligibility request reference. A reference to the CoverageEligibilityRequest message
                            Control1..1
                            TypeReference(SHACoverageEligibilityRequest)
                            Is Modifierfalse
                            Summarytrue
                            Requirements

                            Needed to allow the response to be linked to the request.

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

                            The outcome of the request processing.

                            ShortPayer processing outcome.
                            Comments

                            The resource may be used to indicate that: the request has been held (queued) for processing; that it has been processed and errors found (error); that no errors were found and that some of the adjudication has been undertaken (partial) or that all of the adjudication has been undertaken (complete).

                            Control1..1
                            BindingThe codes SHALL be taken from ClaimProcessingCodes
                            (required to http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1)

                            The outcome of the processing.

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

                            To advise the requestor of an overall processing outcome.

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

                            A human readable description of the status of the adjudication.

                            ShortA human readable description of the status of the adjudication.
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summaryfalse
                            Requirements

                            Provided for user display.

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

                            The Insurer who issued the coverage in question and is the author of the response.

                            ShortCoverage issuer. A reference to the payor organization license issed by the regulator and maintained in the registry. Use the reference.identifier for well know identifiers.
                            Control1..1
                            TypeReference(SHAOrganization)
                            Is Modifierfalse
                            Summarytrue
                            Requirements

                            Need to identify the author.

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

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

                            ShortFinancial instruments for reimbursement for the health care products and services.
                            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
                            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()))
                            64. CoverageEligibilityResponse.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
                            Typestring
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            66. CoverageEligibilityResponse.insurance.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 CoverageEligibilityResponse.insurance.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 68. CoverageEligibilityResponse.insurance.extension:siteEligibility
                              Slice NamesiteEligibility
                              Definition

                              An extension to indicate whether the patient is eligible or not eligible and why

                              ShortSiteEligibility
                              Control0..1
                              This element is affected by the following invariants: ele-1
                              TypeExtension(SiteEligibility) (Extension Type: CodeableConcept)
                              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())
                              70. CoverageEligibilityResponse.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                              Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                              ShortExtensions that cannot be ignored even if unrecognized
                              Comments

                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                              Control0..*
                              TypeExtension
                              Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                              Summarytrue
                              Requirements

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

                              Alternate Namesextensions, user content, modifiers
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              72. CoverageEligibilityResponse.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. A Reference to the insurance coverage resource
                              Control1..1
                              TypeReference(SHACoverage)
                              Is Modifierfalse
                              Summarytrue
                              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()))
                              74. CoverageEligibilityResponse.insurance.inforce
                              Definition

                              Flag indicating if the coverage provided is inforce currently if no service date(s) specified or for the whole duration of the service dates.

                              ShortA flag to indicate if the insurance coverage supplied is expected to be inforce as of the service date supplied or today if no service date supplied.
                              Control1..1
                              Typeboolean
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summaryfalse
                              Requirements

                              Needed to convey the answer to the eligibility validation request.

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

                              The term of the benefits documented in this response.

                              ShortWhen the benefits are applicable
                              Control0..1
                              TypePeriod
                              Is Modifierfalse
                              Summaryfalse
                              Requirements

                              Needed as coverages may be multi-year while benefits tend to be annual therefore a separate expression of the benefit period is needed.

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

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

                              ShortUnique id for inter-element referencing
                              Control0..1
                              Typestring
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              80. CoverageEligibilityResponse.insurance.benefitPeriod.extension
                              Definition

                              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                              ShortAdditional content defined by implementations
                              Comments

                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                              Control0..*
                              TypeExtension
                              Is Modifierfalse
                              Summaryfalse
                              Alternate Namesextensions, user content
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              SlicingThis element introduces a set of slices on CoverageEligibilityResponse.insurance.benefitPeriod.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 82. CoverageEligibilityResponse.insurance.benefitPeriod.start
                                Definition

                                The start of the period. The boundary is inclusive.

                                Shortstart date of the benefits
                                Comments

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

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

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

                                Shortend date of the benefits
                                Comments

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

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

                                Benefits and optionally current balances, and authorization details by category or service.

                                ShortBenefits and authorization details
                                Control0..*
                                TypeBackboneElement
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsces-1: SHALL contain a category or a billcode but not both. (category.exists() xor productOrService.exists())
                                ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                88. CoverageEligibilityResponse.insurance.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
                                Typestring
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                90. CoverageEligibilityResponse.insurance.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                ShortAdditional content defined by implementations
                                Comments

                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                Control0..*
                                TypeExtension
                                Is Modifierfalse
                                Summaryfalse
                                Alternate Namesextensions, user content
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                92. CoverageEligibilityResponse.insurance.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                ShortExtensions that cannot be ignored even if unrecognized
                                Comments

                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                Control0..*
                                TypeExtension
                                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                Summarytrue
                                Requirements

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

                                Alternate Namesextensions, user content, modifiers
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                94. CoverageEligibilityResponse.insurance.item.category
                                Definition

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

                                ShortBenefit classification. Code to identify the general type of benefits under which products and services are provided. Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.
                                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)

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

                                TypeCodeableConcept
                                Is Modifierfalse
                                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()))
                                96. CoverageEligibilityResponse.insurance.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)

                                Allowable service and product codes.

                                TypeCodeableConcept
                                Is Modifierfalse
                                Summaryfalse
                                Requirements

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

                                Alternate NamesDrug Code, Bill Code, Service Code
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                98. CoverageEligibilityResponse.insurance.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)

                                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
                                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()))
                                100. CoverageEligibilityResponse.insurance.item.provider
                                Definition

                                The practitioner who is eligible for the provision of the product or service.

                                ShortPerforming practitioner
                                Control0..1
                                TypeReference(Practitioner, PractitionerRole)
                                Is Modifierfalse
                                Summaryfalse
                                Requirements

                                Needed to convey the eligible provider.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                102. CoverageEligibilityResponse.insurance.item.excluded
                                Definition

                                True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.

                                ShortIndicates whether the benefit is excluded by the policy.
                                Control0..1
                                Typeboolean
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summaryfalse
                                Requirements

                                Needed to identify items that are specifically excluded from the coverage.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                104. CoverageEligibilityResponse.insurance.item.name
                                Definition

                                A short name or tag for the benefit.

                                ShortShort name for the benefit
                                Comments

                                For example: MED01, or DENT2.

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

                                Required to align with other plan names.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                106. CoverageEligibilityResponse.insurance.item.description
                                Definition

                                A richer description of the benefit or services covered.

                                ShortDescription of the benefit or services covered
                                Comments

                                For example 'DENT2 covers 100% of basic, 50% of major but excludes Ortho, Implants and Cosmetic services'.

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

                                Needed for human readable reference.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                108. CoverageEligibilityResponse.insurance.item.network
                                Definition

                                Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.

                                ShortIn or out of network (Contracted of not contracted)
                                Control1..1
                                BindingFor example codes, see NetworkTypeCodes
                                (example to http://hl7.org/fhir/ValueSet/benefit-network)

                                Code to classify in or out of network services.

                                TypeCodeableConcept
                                Is Modifierfalse
                                Summaryfalse
                                Requirements

                                Needed as in or out of network providers are treated differently under the coverage.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                110. CoverageEligibilityResponse.insurance.item.unit
                                Definition

                                Indicates if the benefits apply to an individual or to the family.

                                ShortIndividual or family
                                Control1..1
                                BindingFor example codes, see UnitTypeCodes
                                (example to http://hl7.org/fhir/ValueSet/benefit-unit)

                                Unit covered/serviced - individual or family.

                                TypeCodeableConcept
                                Is Modifierfalse
                                Summaryfalse
                                Requirements

                                Needed for the understanding of the benefits.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                112. CoverageEligibilityResponse.insurance.item.term
                                Definition

                                The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'.

                                ShortAnnual or lifetime
                                Control1..1
                                BindingFor example codes, see BenefitTermCodes
                                (example to http://hl7.org/fhir/ValueSet/benefit-term)

                                Coverage unit - annual, lifetime.

                                TypeCodeableConcept
                                Is Modifierfalse
                                Summaryfalse
                                Requirements

                                Needed for the understanding of the benefits.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                114. CoverageEligibilityResponse.insurance.item.benefit
                                Definition

                                Benefits used to date.

                                ShortTerm for limites such as per day, annual or lifetime
                                Control0..*
                                TypeBackboneElement
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                116. CoverageEligibilityResponse.insurance.item.benefit.id
                                Definition

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

                                ShortUnique id for inter-element referencing
                                Control0..1
                                Typestring
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                118. CoverageEligibilityResponse.insurance.item.benefit.extension
                                Definition

                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                ShortAdditional content defined by implementations
                                Comments

                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                Control0..*
                                TypeExtension
                                Is Modifierfalse
                                Summaryfalse
                                Alternate Namesextensions, user content
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                120. CoverageEligibilityResponse.insurance.item.benefit.modifierExtension
                                Definition

                                May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                ShortExtensions that cannot be ignored even if unrecognized
                                Comments

                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                Control0..*
                                TypeExtension
                                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                Summarytrue
                                Requirements

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

                                Alternate Namesextensions, user content, modifiers
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                122. CoverageEligibilityResponse.insurance.item.benefit.type
                                Definition

                                Classification of benefit being provided.

                                ShortBenefit classification
                                Comments

                                For example: deductible, visits, benefit amount.

                                Control1..1
                                BindingFor example codes, see BenefitTypeCodes
                                (example to http://hl7.org/fhir/ValueSet/benefit-type)

                                Deductable, visits, co-pay, etc.

                                TypeCodeableConcept
                                Is Modifierfalse
                                Summaryfalse
                                Requirements

                                Needed to convey the nature of the benefit.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                124. CoverageEligibilityResponse.insurance.item.benefit.allowed[x]
                                Definition

                                The quantity of the benefit which is permitted under the coverage.

                                ShortBenefits allowed
                                Control0..1
                                TypeChoice of: unsignedInt, string, Money
                                [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
                                Summaryfalse
                                Requirements

                                Needed to convey the benefits offered under the coverage.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                SlicingThis element introduces a set of slices on CoverageEligibilityResponse.insurance.item.benefit.allowed[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                • type @ $this
                                • 126. CoverageEligibilityResponse.insurance.item.benefit.allowed[x]:allowedUnsignedInt
                                  Slice NameallowedUnsignedInt
                                  Definition

                                  The quantity of the benefit which is permitted under the coverage.

                                  ShortBenefits allowed
                                  Control0..1
                                  TypeunsignedInt
                                  [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
                                  Summaryfalse
                                  Requirements

                                  Needed to convey the benefits offered under the coverage.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  128. CoverageEligibilityResponse.insurance.item.benefit.allowed[x]:allowedString
                                  Slice NameallowedString
                                  Definition

                                  The quantity of the benefit which is permitted under the coverage.

                                  ShortBenefits allowed
                                  Control0..1
                                  Typestring
                                  [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
                                  Summaryfalse
                                  Requirements

                                  Needed to convey the benefits offered under the coverage.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  130. CoverageEligibilityResponse.insurance.item.benefit.allowed[x]:allowedMoney
                                  Slice NameallowedMoney
                                  Definition

                                  The quantity of the benefit which is permitted under the coverage.

                                  ShortBenefits allowed
                                  Control0..1
                                  TypeMoney
                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                  Is Modifierfalse
                                  Summaryfalse
                                  Requirements

                                  Needed to convey the benefits offered under the coverage.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  132. CoverageEligibilityResponse.insurance.item.benefit.used[x]
                                  Definition

                                  The quantity of the benefit which have been consumed to date.

                                  ShortBenefits used
                                  Control0..1
                                  TypeChoice of: unsignedInt, string, Money
                                  [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
                                  Summaryfalse
                                  Requirements

                                  Needed to convey the benefits consumed to date.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  SlicingThis element introduces a set of slices on CoverageEligibilityResponse.insurance.item.benefit.used[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                  • type @ $this
                                  • 134. CoverageEligibilityResponse.insurance.item.benefit.used[x]:usedUnsignedInt
                                    Slice NameusedUnsignedInt
                                    Definition

                                    The quantity of the benefit which have been consumed to date.

                                    ShortBenefits used
                                    Control0..1
                                    TypeunsignedInt
                                    [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
                                    Summaryfalse
                                    Requirements

                                    Needed to convey the benefits consumed to date.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    136. CoverageEligibilityResponse.insurance.item.benefit.used[x]:usedString
                                    Slice NameusedString
                                    Definition

                                    The quantity of the benefit which have been consumed to date.

                                    ShortBenefits used
                                    Control0..1
                                    Typestring
                                    [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
                                    Summaryfalse
                                    Requirements

                                    Needed to convey the benefits consumed to date.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    138. CoverageEligibilityResponse.insurance.item.benefit.used[x]:usedMoney
                                    Slice NameusedMoney
                                    Definition

                                    The quantity of the benefit which have been consumed to date.

                                    ShortBenefits used
                                    Control0..1
                                    TypeMoney
                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                    Is Modifierfalse
                                    Summaryfalse
                                    Requirements

                                    Needed to convey the benefits consumed to date.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    140. CoverageEligibilityResponse.insurance.item.authorizationRequired
                                    Definition

                                    A boolean flag indicating whether a preauthorization is required prior to actual service delivery.

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

                                    Needed to convey that preauthorization is required.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    142. CoverageEligibilityResponse.insurance.item.authorizationSupporting
                                    Definition

                                    Codes or comments regarding information or actions associated with the preauthorization.

                                    ShortType of required supporting materials
                                    Control0..*
                                    BindingFor example codes, see CoverageEligibilityResponseAuthSupportCodes
                                    (example to http://hl7.org/fhir/ValueSet/coverageeligibilityresponse-ex-auth-support)

                                    Type of supporting information to provide with a preauthorization.

                                    TypeCodeableConcept
                                    Is Modifierfalse
                                    Summaryfalse
                                    Requirements

                                    Needed to inform the provider of collateral materials or actions needed for preauthorization.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    144. CoverageEligibilityResponse.insurance.item.authorizationUrl
                                    Definition

                                    A web location for obtaining requirements or descriptive information regarding the preauthorization.

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

                                    Needed to enable insurers to advise providers of informative information.

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

                                    A reference from the Insurer to which these services pertain to be used on further communication and as proof that the request occurred.

                                    ShortPreauthorization reference
                                    Control0..1
                                    Typestring
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summaryfalse
                                    Requirements

                                    To provide any preauthorization reference for provider use.

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

                                    A code for the form to be used for printing the content.

                                    ShortPrinted form identifier
                                    Comments

                                    May be needed to identify specific jurisdictional forms.

                                    Control0..1
                                    BindingFor example codes, see Form Codes
                                    (example to http://hl7.org/fhir/ValueSet/forms)

                                    The forms codes.

                                    TypeCodeableConcept
                                    Is Modifierfalse
                                    Summaryfalse
                                    Requirements

                                    Needed to specify the specific form used for producing output for this response.

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

                                    Errors encountered during the processing of the request.

                                    ShortErrors encountered during the processing of the request
                                    Control0..*
                                    TypeBackboneElement
                                    Is Modifierfalse
                                    Summaryfalse
                                    Requirements

                                    Need to communicate processing issues to the requestor.

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

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

                                    ShortUnique id for inter-element referencing
                                    Control0..1
                                    Typestring
                                    Is Modifierfalse
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    Summaryfalse
                                    154. CoverageEligibilityResponse.error.extension
                                    Definition

                                    An Extension

                                    ShortOptional Extensions Element
                                    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 CoverageEligibilityResponse.error.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 156. CoverageEligibilityResponse.error.extension:errorExtensionExpression
                                      Slice NameerrorExtensionExpression
                                      Definition

                                      ErrorExtensionExpression

                                      ShortErrorExtensionExpression
                                      Control0..1
                                      This element is affected by the following invariants: ele-1
                                      TypeExtension(ErrorExtensionExpression) (Extension Type: string)
                                      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())
                                      158. CoverageEligibilityResponse.error.modifierExtension
                                      Definition

                                      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                      ShortExtensions that cannot be ignored even if unrecognized
                                      Comments

                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                      Control0..*
                                      TypeExtension
                                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                      Summarytrue
                                      Requirements

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

                                      Alternate Namesextensions, user content, modifiers
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                      160. CoverageEligibilityResponse.error.code
                                      Definition

                                      An error code,from a specified code system, which details why the eligibility check could not be performed.

                                      ShortAn error code,from a specified code system, which details why the eligibility check could not be performed
                                      Control1..1
                                      BindingFor example codes, see Adjudication Error Codes
                                      (example to http://hl7.org/fhir/ValueSet/adjudication-error)

                                      The error codes for adjudication processing.

                                      TypeCodeableConcept
                                      Is Modifierfalse
                                      Summaryfalse
                                      Requirements

                                      Required to convey processing errors.

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