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: SHACoverageEligibilityRequest - Detailed Descriptions

Draft as of 2024-09-06

Definitions for the SHACoverageEligibilityRequest resource profile.

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

0. CoverageEligibilityRequest
2. CoverageEligibilityRequest.id
ShortItem
Control1..?
4. CoverageEligibilityRequest.meta
ShortMetadata about a resource
Control1..?
6. CoverageEligibilityRequest.meta.profile
Control1..?
8. CoverageEligibilityRequest.extension
ShortOptional Extensions Element
SlicingThis element introduces a set of slices on CoverageEligibilityRequest.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 10. CoverageEligibilityRequest.extension:transfer
    Slice Nametransfer
    Control0..1
    TypeExtension(Transfer) (Extension Type: boolean)
    12. CoverageEligibilityRequest.extension:referrer
    Slice Namereferrer
    Control0..1
    TypeExtension(Referrer) (Extension Type: Reference(Practitioner, Organization))
    14. CoverageEligibilityRequest.identifier
    ShortA business unique identifier for the CoverageEligibilityRequest. This Identifier will be utilized in the CoverageEligibilityResponse prepared by the payer to reference and link the Request with the Response.
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control1..1
    16. CoverageEligibilityRequest.status
    ShortFinancial Resource Status Code
    Pattern Valueactive
    18. CoverageEligibilityRequest.priority
    ShortDesired processing priority. A coding element defining the system and code of the priority.
    Control1..?
    Pattern Value{
      "coding" : [{
        "code" : "normal"
      }]
    }
    20. CoverageEligibilityRequest.purpose
    ShortEligibilityRequestPurpose
    22. CoverageEligibilityRequest.patient
    ShortThe party who is the beneficiary of the supplied coverage and for whom eligibility is sought. A reference to the Patient element within the bundle. SHA Patient
    TypeReference(SHAPatient)
    24. CoverageEligibilityRequest.serviced[x]
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    SlicingThis element introduces a set of slices on CoverageEligibilityRequest.serviced[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • type @ $this
    • 26. CoverageEligibilityRequest.serviced[x]:servicedDate
      Slice NameservicedDate
      ShortThe date or dates when the enclosed suite of services were performed or completed. Choice element: Either date or Period required
      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
      28. CoverageEligibilityRequest.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]
      30. CoverageEligibilityRequest.created
      ShortCreation date of this CoverageEligibilityRequest
      32. CoverageEligibilityRequest.provider
      ShortParty responsible for the request. A reference to the healthcare provider license issed by the regulator and maintained in the Health Worker Registry. Use the reference.identifier for well know identifiers.
      Control1..?
      34. CoverageEligibilityRequest.insurer
      ShortCoverage issuer. A reference to the payor organization license issed by the regulator and maintained in the Facility Registry.
      36. CoverageEligibilityRequest.facility
      ShortServicing Facility. reference to the provider organization resource
      38. CoverageEligibilityRequest.insurance
      ShortAn element to include the insurance coverage of the member in case it is known by the provider at the time of preparing the eligiblity request.
      Control1..?
      40. CoverageEligibilityRequest.insurance.coverage
      ShortInsurance information. A Reference to the insurance coverage resource
      TypeReference(SHACoverage)

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

      0. CoverageEligibilityRequest
      Definition

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

      ShortCoverageEligibilityRequest resource
      Control0..*
      Is Modifierfalse
      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. CoverageEligibilityRequest.id
      Definition

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

      ShortItemLogical 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. CoverageEligibilityRequest.meta
      Definition

      The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

      ShortMetadata about 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. CoverageEligibilityRequest.meta.profile
      Definition

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

      ShortProfiles this resource claims to conform to
      Comments

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

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

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

      ShortA set of rules under which this content was created
      Comments

      Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of 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. CoverageEligibilityRequest.extension
      Definition

      An Extension


      May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and 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 CoverageEligibilityRequest.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 12. CoverageEligibilityRequest.extension:transfer
        Slice Nametransfer
        Definition

        Transfer

        ShortTransfer
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(Transfer) (Extension Type: boolean)
        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. CoverageEligibilityRequest.extension:referrer
        Slice Namereferrer
        Definition

        Referrer

        ShortReferrer
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(Referrer) (Extension Type: Reference(Practitioner, Organization))
        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())
        16. CoverageEligibilityRequest.modifierExtension
        Definition

        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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())
        18. CoverageEligibilityRequest.identifier
        Definition

        A unique identifier assigned to this coverage eligiblity request.

        ShortA business unique identifier for the CoverageEligibilityRequest. This Identifier will be utilized in the CoverageEligibilityResponse prepared by the payer to reference and link the Request with the Response.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()))
        20. CoverageEligibilityRequest.status
        Definition

        The status of the resource instance.

        ShortFinancial Resource Status Codeactive | 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()))
        22. CoverageEligibilityRequest.priority
        Definition

        When the requestor expects the processor to complete processing.

        ShortDesired processing priority. A coding element defining the system and code of the priority.
        Control10..1
        BindingFor example codes, see ProcessPriorityCodeshttp://hl7.org/fhir/ValueSet/process-priority
        (example to http://hl7.org/fhir/ValueSet/process-priority)

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

        TypeCodeableConcept
        Is Modifierfalse
        Summaryfalse
        Requirements

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

        Pattern Value{
          "coding" : [{
            "code" : "normal"
          }]
        }
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        24. CoverageEligibilityRequest.purpose
        Definition

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

        ShortEligibilityRequestPurposeauth-requirements | benefits | discovery | validation
        Control1..*
        BindingThe codes SHALL be taken from EligibilityRequestPurposehttp://hl7.org/fhir/ValueSet/eligibilityrequest-purpose|4.0.1
        (required to http://hl7.org/fhir/ValueSet/eligibilityrequest-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()))
        26. CoverageEligibilityRequest.patient
        Definition

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

        ShortThe party who is the beneficiary of the supplied coverage and for whom eligibility is sought. A reference to the Patient element within the bundle. SHA PatientIntended recipient of products and services
        Comments

        1..1.

        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()))
        28. CoverageEligibilityRequest.serviced[x]
        Definition

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

        ShortEstimated date or dates of service
        Control0..1
        TypeChoice of: date, Period
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        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 CoverageEligibilityRequest.serviced[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
        • type @ $this
        • 30. CoverageEligibilityRequest.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. Choice element: Either date or Period requiredEstimated 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()))
          32. CoverageEligibilityRequest.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()))
          34. CoverageEligibilityRequest.created
          Definition

          The date when 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()))
          36. CoverageEligibilityRequest.provider
          Definition

          The provider which is responsible for the request.

          ShortParty responsible for the request. A reference to the healthcare provider license issed by the regulator and maintained in the Health Worker Registry. Use the reference.identifier for well know identifiers.
          Comments

          Typically this field would be 1..1 where this party is responsible for the eligibility request but not necessarily professionally responsible for the provision of the individual products and services listed below.

          Control10..1
          TypeReference(Practitioner, PractitionerRole, Organization)
          Is Modifierfalse
          Summaryfalse
          Requirements

          Needed to identify the requestor.

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

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

          ShortCoverage issuer. A reference to the payor organization license issed by the regulator and maintained in the Facility Registry.
          Control1..1
          TypeReference(Organization)
          Is Modifierfalse
          Summarytrue
          Requirements

          Need to identify the recipient.

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

          Facility where the services are intended to be provided.

          ShortServicing Facility. reference to the provider organization resourceServicing facility
          Control0..1
          TypeReference(Location)
          Is Modifierfalse
          Summaryfalse
          Requirements

          Insurance adjudication can be dependant on where services were delivered.

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

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

          ShortAn element to include the insurance coverage of the member in case it is known by the provider at the time of preparing the eligiblity request.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.

          Control10..*
          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()))
          44. CoverageEligibilityRequest.insurance.modifierExtension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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())
          46. CoverageEligibilityRequest.insurance.coverage
          Definition

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

          ShortInsurance information. A Reference to the insurance coverage resource
          Control1..1
          TypeReference(SHACoverage, Coverage)
          Is Modifierfalse
          Summaryfalse
          Requirements

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

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

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

          0. CoverageEligibilityRequest
          Definition

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

          ShortCoverageEligibilityRequest resource
          Control0..*
          Is Modifierfalse
          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. CoverageEligibilityRequest.id
          Definition

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

          ShortItem
          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. CoverageEligibilityRequest.meta
          Definition

          The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

          ShortMetadata about 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. CoverageEligibilityRequest.meta.id
          Definition

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

          ShortUnique id for inter-element referencing
          Control0..1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          8. CoverageEligibilityRequest.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 CoverageEligibilityRequest.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 10. CoverageEligibilityRequest.meta.versionId
            Definition

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

            ShortVersion specific identifier
            Comments

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

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

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

            ShortIdentifies where the resource comes from
            Comments

            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. CoverageEligibilityRequest.meta.profile
            Definition

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

            ShortProfiles this resource claims to conform to
            Comments

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

            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. CoverageEligibilityRequest.meta.security
            Definition

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

            ShortSecurity Labels applied to this resource
            Comments

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

            Control0..*
            BindingUnless not suitable, these codes SHALL be taken from 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. CoverageEligibilityRequest.meta.tag
            Definition

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

            ShortTags applied to this resource
            Comments

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

            Control0..*
            BindingFor example codes, see CommonTags
            (example to http://hl7.org/fhir/ValueSet/common-tags)

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

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

            ShortA set of rules under which this content was created
            Comments

            Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of 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. CoverageEligibilityRequest.language
            Definition

            The base language in which the resource is written.

            ShortLanguage of the resource content
            Comments

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

            Control0..1
            BindingThe codes 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. CoverageEligibilityRequest.text
            Definition

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

            ShortText summary of the resource, for human interpretation
            Comments

            Contained resources do not have 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. CoverageEligibilityRequest.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. CoverageEligibilityRequest.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 CoverageEligibilityRequest.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 32. CoverageEligibilityRequest.extension:transfer
              Slice Nametransfer
              Definition

              Transfer

              ShortTransfer
              Control0..1
              This element is affected by the following invariants: ele-1
              TypeExtension(Transfer) (Extension Type: boolean)
              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. CoverageEligibilityRequest.extension:referrer
              Slice Namereferrer
              Definition

              Referrer

              ShortReferrer
              Control0..1
              This element is affected by the following invariants: ele-1
              TypeExtension(Referrer) (Extension Type: Reference(Practitioner, Organization))
              Is Modifierfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              36. CoverageEligibilityRequest.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())
              38. CoverageEligibilityRequest.identifier
              Definition

              A unique identifier assigned to this coverage eligiblity request.

              ShortA business unique identifier for the CoverageEligibilityRequest. This Identifier will be utilized in the CoverageEligibilityResponse prepared by the payer to reference and link the Request with the Response.
              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()))
              40. CoverageEligibilityRequest.status
              Definition

              The status of the resource instance.

              ShortFinancial Resource Status Code
              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()))
              42. CoverageEligibilityRequest.priority
              Definition

              When the requestor expects the processor to complete processing.

              ShortDesired processing priority. A coding element defining the system and code of the priority.
              Control1..1
              BindingFor example codes, see ProcessPriorityCodes
              (example to http://hl7.org/fhir/ValueSet/process-priority)

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

              TypeCodeableConcept
              Is Modifierfalse
              Summaryfalse
              Requirements

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

              Pattern Value{
                "coding" : [{
                  "code" : "normal"
                }]
              }
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              44. CoverageEligibilityRequest.purpose
              Definition

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

              ShortEligibilityRequestPurpose
              Control1..*
              BindingThe codes SHALL be taken from EligibilityRequestPurpose
              (required to http://hl7.org/fhir/ValueSet/eligibilityrequest-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()))
              46. CoverageEligibilityRequest.patient
              Definition

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

              ShortThe party who is the beneficiary of the supplied coverage and for whom eligibility is sought. A reference to the Patient element within the bundle. SHA Patient
              Comments

              1..1.

              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()))
              48. CoverageEligibilityRequest.serviced[x]
              Definition

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

              ShortEstimated date or dates of service
              Control0..1
              TypeChoice of: date, Period
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              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 CoverageEligibilityRequest.serviced[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
              • type @ $this
              • 50. CoverageEligibilityRequest.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. Choice element: Either date or Period required
                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()))
                52. CoverageEligibilityRequest.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()))
                54. CoverageEligibilityRequest.created
                Definition

                The date when 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()))
                56. CoverageEligibilityRequest.enterer
                Definition

                Person who created the request.

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

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

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

                The provider which is responsible for the request.

                ShortParty responsible for the request. A reference to the healthcare provider license issed by the regulator and maintained in the Health Worker Registry. Use the reference.identifier for well know identifiers.
                Comments

                Typically this field would be 1..1 where this party is responsible for the eligibility request but not necessarily professionally responsible for the provision of the individual products and services listed below.

                Control1..1
                TypeReference(Practitioner, PractitionerRole, Organization)
                Is Modifierfalse
                Summaryfalse
                Requirements

                Needed to identify the requestor.

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

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

                ShortCoverage issuer. A reference to the payor organization license issed by the regulator and maintained in the Facility Registry.
                Control1..1
                TypeReference(Organization)
                Is Modifierfalse
                Summarytrue
                Requirements

                Need to identify the recipient.

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

                Facility where the services are intended to be provided.

                ShortServicing Facility. reference to the provider organization resource
                Control0..1
                TypeReference(Location)
                Is Modifierfalse
                Summaryfalse
                Requirements

                Insurance adjudication can be dependant on where services were delivered.

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

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

                ShortSupporting information
                Comments

                Often there are multiple jurisdiction specific valuesets which are required.

                Control0..*
                TypeBackboneElement
                Is Modifierfalse
                Summaryfalse
                Requirements

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

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

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

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

                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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())
                70. CoverageEligibilityRequest.supportingInfo.modifierExtension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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. CoverageEligibilityRequest.supportingInfo.sequence
                Definition

                A number to uniquely identify supporting information entries.

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

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

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

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

                ShortData to be provided
                Comments

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

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

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

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

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

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

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

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

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

                ShortAn element to include the insurance coverage of the member in case it is known by the provider at the time of preparing the eligiblity request.
                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.

                Control1..*
                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()))
                80. CoverageEligibilityRequest.insurance.id
                Definition

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

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

                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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())
                84. CoverageEligibilityRequest.insurance.modifierExtension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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())
                86. CoverageEligibilityRequest.insurance.focal
                Definition

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

                ShortApplicable coverage
                Comments

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

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

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

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

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

                ShortInsurance information. A Reference to the insurance coverage resource
                Control1..1
                TypeReference(SHACoverage)
                Is Modifierfalse
                Summaryfalse
                Requirements

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

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

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

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

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

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

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

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

                The items to be processed for the request.

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

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

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

                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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())
                98. CoverageEligibilityRequest.item.modifierExtension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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())
                100. CoverageEligibilityRequest.item.supportingInfoSequence
                Definition

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

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

                Needed to support or inform the consideration for eligibility.

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

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

                ShortBenefit classification
                Comments

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

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

                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()))
                104. CoverageEligibilityRequest.item.productOrService
                Definition

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

                ShortBilling, service, product, or drug code
                Comments

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

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

                Allowable service and product codes.

                TypeCodeableConcept
                Is Modifierfalse
                Summaryfalse
                Requirements

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

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

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

                ShortProduct or service billing modifiers
                Comments

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

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

                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()))
                108. CoverageEligibilityRequest.item.provider
                Definition

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

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

                Needed to support the evaluation of the eligibility.

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

                The number of repetitions of a service or product.

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

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

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

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

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

                Needed to support the evaluation of the eligibility.

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

                Facility where the services will be provided.

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

                Needed to support the evaluation of the eligibility.

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

                Patient diagnosis for which care is sought.

                ShortApplicable diagnosis
                Control0..*
                TypeBackboneElement
                Is Modifierfalse
                Summaryfalse
                Requirements

                Needed to support the evaluation of the eligibility.

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

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

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

                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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())
                122. CoverageEligibilityRequest.item.diagnosis.modifierExtension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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())
                124. CoverageEligibilityRequest.item.diagnosis.diagnosis[x]
                Definition

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

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

                ICD10 Diagnostic codes.

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

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

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

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

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

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

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