Healthcare Financial Services IG Edition 1
0.3.0 - ci-build Saudi Arabia flag

Healthcare Financial Services IG Edition 1 - Local Development build (v0.3.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: NphiesCoverageEligibilityResponse - Detailed Descriptions

Draft as of 2025-06-23

Definitions for the eligibility-response resource profile.

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

0. CoverageEligibilityResponse
InvariantsBV-00539: CoverageEligibilityResponse.status SHALL use the fixed value 'active'. (status.exists() implies status = 'active')
ksa-purpose-unique-code: Purpose code values must be unique. (purpose.exists() implies purpose.isDistinct())
BV-00310: CoverageEligibilityResponse.disposition SHALL have maximum length of 250 English characters and 125 Arabic characters. (disposition.exists() implies disposition.length() <= 250)
BV-00315: CoverageEligibilityResponse.preAuthRef SHALL have maximum length of 40 characters. (preAuthRef.exists() implies preAuthRef.length() <= 40)
BV-00503: CoverageEligibiltyResponse.extension.siteEligibility SHALL be provided when CoverageEligibiltyResponse.outcome='complete'. (outcome.exists() implies (outcome = 'complete' implies extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').exists()))
BV-00535: The CoverageEligibiltyResponse.extension.siteEligibility value SHALL not be 'eligible' if for every array entry of CoverageEligibiltyResponse.insurance the related CoverageEligibilityResponse.insurance.inforce value is 'false'. (iif( (insurance.where(inforce = true).count() = 0) and (extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').count()=1), iif((extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').value.ofType(CodeableConcept).coding.first().code='eligible') ,false,true), true))
BV-00536: The CoverageEligibilityResponse.error SHALL be provided when CoverageEligibilityResponse.outcome= 'error'. (outcome.exists() implies (outcome = 'error' implies error.exists()))
BV-00559: The CoverageEligibiltyResponse.extension.siteEligibility value SHALL be 'eligible' if at least in one array entry of CoverageEligibiltyResponse.insurance the related CoverageEligibilityResponse.insurance.siteEligibility is 'eligible'. (iif( insurance.extension.exists(), iif( (insurance.extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').value.ofType(CodeableConcept).coding.where(code='eligible').count() > 0), iif( extension.exists(), (extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').value.ofType(CodeableConcept).coding.where(code='eligible').count() > 0), true), false), true))
BV-00561: The CoverageEligibiltyResponse.extension.siteEligibility value SHALL not be 'eligible' if for every array entry of CoverageEligibiltyResponse.insurance the related CoverageEligibilityResponse.insurance.siteEligibility is not 'eligible'. (iif( (extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').count() = 1), iif(extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').first().value.ofType(CodeableConcept).coding.first().code='eligible', iif(insurance.extension.exists(),insurance.extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').select(value.ofType(CodeableConcept).coding.select(code='eligible').count()>0),false),false), true))
2. CoverageEligibilityResponse.id
Control1..?
Max Length:64
4. CoverageEligibilityResponse.meta
Control1..?
6. CoverageEligibilityResponse.meta.profile
Control1..?
Typecanonical(DP_canonical)(StructureDefinition)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. CoverageEligibilityResponse.extension
SlicingThis element introduces a set of slices on CoverageEligibilityResponse.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 10. CoverageEligibilityResponse.extension:siteEligibility
    Slice NamesiteEligibility
    Control0..1
    TypeExtension(Site Eligibility) (Extension Type: CodeableConcept(DP_CodeableConcept))
    Must Supporttrue
    12. CoverageEligibilityResponse.identifier
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control1..1
    TypeIdentifier(DP_Identifier_A)
    14. CoverageEligibilityResponse.identifier.type
    BindingThe codes SHALL be taken from Identifier Type Codes
    (required to http://hl7.org/fhir/ValueSet/identifier-type)
    16. CoverageEligibilityResponse.status
    Pattern Valueactive
    18. CoverageEligibilityResponse.purpose
    BindingThe codes SHALL be taken from EligibilityResponsePurpose
    (required to http://hl7.org/fhir/ValueSet/eligibilityresponse-purpose)
    Typecode(DP_code)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    20. CoverageEligibilityResponse.patient
    TypeReference(DP_Reference_1or2a)(Nphies Patient)
    22. CoverageEligibilityResponse.patient.identifier
    NoteThis is a business identifier, not a resource identifier (see discussion)
    24. CoverageEligibilityResponse.patient.identifier.type
    BindingThe codes SHALL be taken from Patient Identifier Type
    (required to http://nphies.sa/terminology/ValueSet/patient-identifier-type)
    26. CoverageEligibilityResponse.serviced[x]
    Control1..?
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    SlicingThis element introduces a set of slices on CoverageEligibilityResponse.serviced[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • type @ $this
    • 28. CoverageEligibilityResponse.serviced[x]:servicedDate
      Slice NameservicedDate
      Control0..1
      Typedate(DP_date)
      [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
      Must Supporttrue
      30. CoverageEligibilityResponse.serviced[x]:servicedPeriod
      Slice NameservicedPeriod
      Control0..1
      TypePeriod(DP_Period_2)
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Must Supporttrue
      32. CoverageEligibilityResponse.created
      TypedateTime(DP_dateTime)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      34. CoverageEligibilityResponse.request
      TypeReference(DP_Reference_1or3a)(Nphies CoverageEligibilityRequest)
      36. CoverageEligibilityResponse.outcome
      Typecode(DP_code)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      38. CoverageEligibilityResponse.disposition
      Must Supporttrue
      Max Length:250
      40. CoverageEligibilityResponse.insurer
      TypeReference(DP_Reference_1or2a)(Nphies Insurer Organization)
      42. CoverageEligibilityResponse.insurer.identifier
      NoteThis is a business identifier, not a resource identifier (see discussion)
      44. CoverageEligibilityResponse.insurer.identifier.type
      BindingThe codes SHALL be taken from Organization Identifier
      (required to http://nphies.sa/terminology/ValueSet/organization-identifier-type)
      46. CoverageEligibilityResponse.insurance
      Must Supporttrue
      48. CoverageEligibilityResponse.insurance.extension
      SlicingThis element introduces a set of slices on CoverageEligibilityResponse.insurance.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 50. CoverageEligibilityResponse.insurance.extension:siteEligibility
        Slice NamesiteEligibility
        Control0..1
        TypeExtension(Site Eligibility) (Extension Type: CodeableConcept(DP_CodeableConcept))
        Must Supporttrue
        52. CoverageEligibilityResponse.insurance.coverage
        TypeReference(DP_Reference_1or2a)(Nphies Coverage)
        54. CoverageEligibilityResponse.insurance.coverage.identifier
        NoteThis is a business identifier, not a resource identifier (see discussion)
        56. CoverageEligibilityResponse.insurance.coverage.identifier.type
        BindingThe codes SHALL be taken from Identifier Type Codes
        (required to http://hl7.org/fhir/ValueSet/identifier-type)
        58. CoverageEligibilityResponse.insurance.inforce
        Control1..?
        60. CoverageEligibilityResponse.insurance.benefitPeriod
        TypePeriod(DP_Period_2)
        Must Supporttrue
        62. CoverageEligibilityResponse.insurance.item
        Must Supporttrue
        InvariantsBV-00311: CoverageEligibilityResponse.insurance.item.name SHALL have maximum length of 100 English characters and 50 Arabic characters. (name.exists() implies name.length() <= 100)
        BV-00312: CoverageEligibilityResponse.insurance.item.benefit.allowedString SHALL have maximum length of 60 characters. (name.exists() implies name.length() <= 60)
        64. CoverageEligibilityResponse.insurance.item.category
        BindingThe codes SHALL be taken from Benefit Category
        (required to http://nphies.sa/terminology/ValueSet/benefit-category)
        TypeCodeableConcept(DP_CodeableConcept)
        Must Supporttrue
        66. CoverageEligibilityResponse.insurance.item.excluded
        Must Supporttrue
        68. CoverageEligibilityResponse.insurance.item.name
        Must Supporttrue
        Max Length:100
        70. CoverageEligibilityResponse.insurance.item.description
        Must Supporttrue
        Max Length:250
        72. CoverageEligibilityResponse.insurance.item.network
        Control1..?
        BindingThe codes SHALL be taken from NetworkTypeCodes
        (required to http://hl7.org/fhir/ValueSet/benefit-network)
        TypeCodeableConcept(DP_CodeableConcept)
        74. CoverageEligibilityResponse.insurance.item.unit
        Control1..?
        BindingThe codes SHALL be taken from UnitTypeCodes
        (required to http://hl7.org/fhir/ValueSet/benefit-unit)
        TypeCodeableConcept(DP_CodeableConcept)
        76. CoverageEligibilityResponse.insurance.item.term
        Control1..?
        BindingThe codes SHALL be taken from BenefitTermCodes
        (required to http://hl7.org/fhir/ValueSet/benefit-term)
        TypeCodeableConcept(DP_CodeableConcept)
        78. CoverageEligibilityResponse.insurance.item.benefit
        Must Supporttrue
        InvariantsBV-00313: CoverageEligibilityResponse.insurance.item.benefit.allowedString SHALL have maximum length of 60 characters. (allowed.ofType(string).exists() implies allowed.ofType(string).length() <= 60)
        BV-00314: CoverageEligibilityResponse.insurance.item.benefit.usedString SHALL have maximum length of 60 characters. (used.ofType(string).exists() implies used.ofType(string).length() <= 60)
        80. CoverageEligibilityResponse.insurance.item.benefit.type
        BindingThe codes SHALL be taken from Benefit Type
        (required to http://nphies.sa/terminology/ValueSet/benefit-type)
        TypeCodeableConcept(DP_CodeableConcept)
        82. CoverageEligibilityResponse.insurance.item.benefit.allowed[x]
        Control1..?
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        SlicingThis element introduces a set of slices on CoverageEligibilityResponse.insurance.item.benefit.allowed[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • type @ $this
        • 84. CoverageEligibilityResponse.insurance.item.benefit.allowed[x]:allowedUnsignedInt
          Slice NameallowedUnsignedInt
          Control0..1
          TypeunsignedInt(DP_unsignedInt)
          [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
          Must Supporttrue
          86. CoverageEligibilityResponse.insurance.item.benefit.allowed[x]:allowedString
          Slice NameallowedString
          Control0..1
          Typestring
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Max Length:60
          88. CoverageEligibilityResponse.insurance.item.benefit.allowed[x]:allowedMoney
          Slice NameallowedMoney
          Control0..1
          TypeMoney(DP_Money_SAR)
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Must Supporttrue
          InvariantsBV-00084: CoverageEligibilityResponse.insurance.item.benefit.allowedMoney.currency SHALL be SAR (currency.exists() implies currency ='SAR')
          90. CoverageEligibilityResponse.insurance.item.benefit.used[x]
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Must Supporttrue
          SlicingThis element introduces a set of slices on CoverageEligibilityResponse.insurance.item.benefit.used[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • type @ $this
          • 92. CoverageEligibilityResponse.insurance.item.benefit.used[x]:usedUnsignedInt
            Slice NameusedUnsignedInt
            Control0..1
            TypeunsignedInt(DP_unsignedInt)
            [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
            Must Supporttrue
            94. CoverageEligibilityResponse.insurance.item.benefit.used[x]:usedString
            Slice NameusedString
            Control0..1
            Typestring
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Max Length:60
            96. CoverageEligibilityResponse.insurance.item.benefit.used[x]:usedMoney
            Slice NameusedMoney
            Control0..1
            TypeMoney(DP_Money_SAR)
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Must Supporttrue
            InvariantsBV-00085: CoverageEligibilityResponse.insurance.item.benefit.used.currency SHALL be SAR (currency.exists() implies currency ='SAR')
            98. CoverageEligibilityResponse.error
            Must Supporttrue
            100. CoverageEligibilityResponse.error.extension
            SlicingThis element introduces a set of slices on CoverageEligibilityResponse.error.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 102. CoverageEligibilityResponse.error.extension:expression
              Slice Nameexpression
              Control0..1
              TypeExtension(Error Expression) (Extension Type: string)
              Must Supporttrue
              104. CoverageEligibilityResponse.error.code
              BindingThe codes SHALL be taken from Adjudication Error Codes
              (required to http://nphies.sa/terminology/ValueSet/adjudication-error)
              TypeCodeableConcept(DP_CodeableConcept)

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

              0. CoverageEligibilityResponse
              Definition

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

              ShortCoverageEligibilityResponse resource
              Control0..*
              Is Modifierfalse
              Summaryfalse
              Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
              dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
              dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
              dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
              dom-6: A resource should have narrative for robust management (text.`div`.exists())
              BV-00539: CoverageEligibilityResponse.status SHALL use the fixed value 'active'. (status.exists() implies status = 'active')
              ksa-purpose-unique-code: Purpose code values must be unique. (purpose.exists() implies purpose.isDistinct())
              BV-00310: CoverageEligibilityResponse.disposition SHALL have maximum length of 250 English characters and 125 Arabic characters. (disposition.exists() implies disposition.length() <= 250)
              BV-00315: CoverageEligibilityResponse.preAuthRef SHALL have maximum length of 40 characters. (preAuthRef.exists() implies preAuthRef.length() <= 40)
              BV-00503: CoverageEligibiltyResponse.extension.siteEligibility SHALL be provided when CoverageEligibiltyResponse.outcome='complete'. (outcome.exists() implies (outcome = 'complete' implies extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').exists()))
              BV-00535: The CoverageEligibiltyResponse.extension.siteEligibility value SHALL not be 'eligible' if for every array entry of CoverageEligibiltyResponse.insurance the related CoverageEligibilityResponse.insurance.inforce value is 'false'. (iif( (insurance.where(inforce = true).count() = 0) and (extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').count()=1), iif((extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').value.ofType(CodeableConcept).coding.first().code='eligible') ,false,true), true))
              BV-00536: The CoverageEligibilityResponse.error SHALL be provided when CoverageEligibilityResponse.outcome= 'error'. (outcome.exists() implies (outcome = 'error' implies error.exists()))
              BV-00559: The CoverageEligibiltyResponse.extension.siteEligibility value SHALL be 'eligible' if at least in one array entry of CoverageEligibiltyResponse.insurance the related CoverageEligibilityResponse.insurance.siteEligibility is 'eligible'. (iif( insurance.extension.exists(), iif( (insurance.extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').value.ofType(CodeableConcept).coding.where(code='eligible').count() > 0), iif( extension.exists(), (extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').value.ofType(CodeableConcept).coding.where(code='eligible').count() > 0), true), false), true))
              BV-00561: The CoverageEligibiltyResponse.extension.siteEligibility value SHALL not be 'eligible' if for every array entry of CoverageEligibiltyResponse.insurance the related CoverageEligibilityResponse.insurance.siteEligibility is not 'eligible'. (iif( (extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').count() = 1), iif(extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').first().value.ofType(CodeableConcept).coding.first().code='eligible', iif(insurance.extension.exists(),insurance.extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').select(value.ofType(CodeableConcept).coding.select(code='eligible').count()>0),false),false), true))
              2. CoverageEligibilityResponse.id
              Definition

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

              ShortLogical id of this artifact
              Comments

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

              Control10..1
              Typeidstring
              Is Modifierfalse
              Summarytrue
              Max Length:64
              4. CoverageEligibilityResponse.meta
              Definition

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

              ShortMetadata about the resource
              Control10..1
              TypeMeta
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              6. CoverageEligibilityResponse.meta.profile
              Definition

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


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

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

              ShortA set of rules under which this content was created
              Comments

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

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

              An Extension


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

              ShortExtensionAdditional content defined by implementations
              Comments

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

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

                Code to indicate whether the patient is eligible or not eligible and why.

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

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

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

                ShortExtensions that cannot be ignored
                Comments

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

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

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

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

                A unique identifier assigned to this coverage eligiblity request.

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

                Allows coverage eligibility requests to be distinguished and referenced.

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

                The purpose of this identifier.

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

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

                Control0..1
                BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
                (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                Identifies the purpose for this identifier, if known .

                Typecode
                Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Requirements

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

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

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

                ShortDescription of identifier
                Comments

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

                Control0..1
                BindingThe codes SHALL be taken from Unless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type
                (required to http://hl7.org/fhir/ValueSet/identifier-type)
                TypeCodeableConcept
                Is Modifierfalse
                Must Supporttrue
                Summarytrue
                Requirements

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

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

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

                ShortThe namespace for the identifier value
                Comments

                Identifier.system is always case sensitive.

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

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

                Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                24. CoverageEligibilityResponse.identifier.value
                Definition

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

                ShortThe value that is unique
                Comments

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

                Control10..1
                Typestring
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Max Length:50
                Example<br/><b>General</b>:123456
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                26. CoverageEligibilityResponse.status
                Definition

                The status of the resource instance.

                Shortactive | cancelled | draft | entered-in-error
                Comments

                This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

                Control1..1
                BindingThe codes SHALL be taken from FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|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()))
                28. CoverageEligibilityResponse.purpose
                Definition

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

                Shortauth-requirements | benefits | discovery | validation
                Control1..*
                BindingThe codes SHALL be taken from EligibilityResponsePurposehttp://hl7.org/fhir/ValueSet/eligibilityresponse-purpose|4.0.1
                (required to http://hl7.org/fhir/ValueSet/eligibilityresponse-purpose)
                Typecode(DP_code)
                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()))
                30. CoverageEligibilityResponse.patient
                Definition

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

                ShortIntended recipient of products and services
                Control1..1
                TypeReference(DP_Reference_1or2a)(Nphies Patient, 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()))
                32. CoverageEligibilityResponse.patient.reference
                Definition

                A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                ShortLiteral reference, Relative, internal or absolute URL
                Comments

                Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                Control0..1
                This element is affected by the following invariants: ref-1
                Typestring
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supporttrue
                Summarytrue
                Max Length:250
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                34. CoverageEligibilityResponse.patient.identifier
                Definition

                An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                ShortLogical reference, when literal reference is not known
                Comments

                When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                NoteThis is a business identifier, not a resource identifier (see discussion)
                Control0..1
                TypeIdentifier
                Is Modifierfalse
                Must Supporttrue
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                36. CoverageEligibilityResponse.patient.identifier.use
                Definition

                The purpose of this identifier.

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

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

                Control0..1
                BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
                (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                Identifies the purpose for this identifier, if known .

                Typecode
                Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Requirements

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

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

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

                ShortDescription of identifier
                Comments

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

                Control10..1
                BindingThe codes SHALL be taken from Unless not suitable, these codes SHALL be taken from Patient Identifier Typehttp://hl7.org/fhir/ValueSet/identifier-type
                (required to http://nphies.sa/terminology/ValueSet/patient-identifier-type)
                TypeCodeableConcept(DP_CodeableConcept)
                Is Modifierfalse
                Summarytrue
                Requirements

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

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

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

                ShortThe namespace for the identifier value
                Comments

                Identifier.system is always case sensitive.

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

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

                Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                42. CoverageEligibilityResponse.patient.identifier.value
                Definition

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

                ShortThe value that is unique
                Comments

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

                Control10..1
                Typestring
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Max Length:50
                Example<br/><b>General</b>:123456
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                44. CoverageEligibilityResponse.patient.display
                Definition

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

                ShortText alternative for the resource
                Comments

                This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                Control0..1
                Typestring
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Max Length:200
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                46. CoverageEligibilityResponse.serviced[x]
                Definition

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

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

                Required to provide time context for the request.

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

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

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

                  Required to provide time context for the request.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  50. CoverageEligibilityResponse.serviced[x]:servicedPeriod
                  Slice NameservicedPeriod
                  Definition

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

                  ShortEstimated date or dates of service
                  Control0..1
                  TypePeriod(DP_Period_2), date
                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                  Is Modifierfalse
                  Must Supporttrue
                  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. CoverageEligibilityResponse.created
                  Definition

                  The date this resource was created.

                  ShortResponse creation date
                  Control1..1
                  TypedateTime(DP_dateTime)
                  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()))
                  54. CoverageEligibilityResponse.request
                  Definition

                  Reference to the original request resource.

                  ShortEligibility request reference
                  Control1..1
                  TypeReference(DP_Reference_1or3a)(Nphies CoverageEligibilityRequest, CoverageEligibilityRequest)
                  Is Modifierfalse
                  Summarytrue
                  Requirements

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

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

                  The outcome of the request processing.

                  Shortqueued | complete | error | partial
                  Comments

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

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

                  The outcome of the processing.

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

                  To advise the requestor of an overall processing outcome.

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

                  A human readable description of the status of the adjudication.

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

                  Provided for user display.

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

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

                  ShortCoverage issuer
                  Control1..1
                  TypeReference(DP_Reference_1or2a)(Nphies Insurer Organization, Organization)
                  Is Modifierfalse
                  Summarytrue
                  Requirements

                  Need to identify the author.

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

                  A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                  ShortLiteral reference, Relative, internal or absolute URL
                  Comments

                  Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                  Control0..1
                  This element is affected by the following invariants: ref-1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supporttrue
                  Summarytrue
                  Max Length:250
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  64. CoverageEligibilityResponse.insurer.identifier
                  Definition

                  An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                  ShortLogical reference, when literal reference is not known
                  Comments

                  When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                  When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                  Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                  Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                  NoteThis is a business identifier, not a resource identifier (see discussion)
                  Control0..1
                  TypeIdentifier
                  Is Modifierfalse
                  Must Supporttrue
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  66. CoverageEligibilityResponse.insurer.identifier.use
                  Definition

                  The purpose of this identifier.

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

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

                  Control0..1
                  BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
                  (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                  Identifies the purpose for this identifier, if known .

                  Typecode
                  Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

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

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

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

                  ShortDescription of identifier
                  Comments

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

                  Control10..1
                  BindingThe codes SHALL be taken from Unless not suitable, these codes SHALL be taken from Organization Identifierhttp://hl7.org/fhir/ValueSet/identifier-type
                  (required to http://nphies.sa/terminology/ValueSet/organization-identifier-type)
                  TypeCodeableConcept(DP_CodeableConcept)
                  Is Modifierfalse
                  Summarytrue
                  Requirements

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

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

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

                  ShortThe namespace for the identifier value
                  Comments

                  Identifier.system is always case sensitive.

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

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

                  Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  72. CoverageEligibilityResponse.insurer.identifier.value
                  Definition

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

                  ShortThe value that is unique
                  Comments

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

                  Control10..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Max Length:50
                  Example<br/><b>General</b>:123456
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  74. CoverageEligibilityResponse.insurer.display
                  Definition

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

                  ShortText alternative for the resource
                  Comments

                  This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

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

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

                  ShortPatient insurance information
                  Comments

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

                  Control0..*
                  TypeBackboneElement
                  Is Modifierfalse
                  Must Supporttrue
                  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()))
                  78. CoverageEligibilityResponse.insurance.extension
                  Definition

                  An Extension


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

                  ShortExtensionAdditional content defined by implementations
                  Comments

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

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

                    Code to indicate whether the patient is eligible or not eligible and why.

                    ShortSite Eligibility
                    Control0..1
                    This element is affected by the following invariants: ele-1
                    TypeExtension(Site Eligibility) (Extension Type: CodeableConcept(DP_CodeableConcept))
                    Is Modifierfalse
                    Must Supporttrue
                    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())
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    82. CoverageEligibilityResponse.insurance.modifierExtension
                    Definition

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

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

                    ShortExtensions that cannot be ignored even if unrecognized
                    Comments

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

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

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

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

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

                    ShortInsurance information
                    Control1..1
                    TypeReference(DP_Reference_1or2a)(Nphies Coverage, Coverage)
                    Is Modifierfalse
                    Summarytrue
                    Requirements

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

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

                    A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                    ShortLiteral reference, Relative, internal or absolute URL
                    Comments

                    Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                    Control0..1
                    This element is affected by the following invariants: ref-1
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supporttrue
                    Summarytrue
                    Max Length:250
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    88. CoverageEligibilityResponse.insurance.coverage.identifier
                    Definition

                    An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                    ShortLogical reference, when literal reference is not known
                    Comments

                    When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                    When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                    Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                    Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                    NoteThis is a business identifier, not a resource identifier (see discussion)
                    Control0..1
                    TypeIdentifier
                    Is Modifierfalse
                    Must Supporttrue
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    90. CoverageEligibilityResponse.insurance.coverage.identifier.use
                    Definition

                    The purpose of this identifier.

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

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

                    Control0..1
                    BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
                    (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                    Identifies the purpose for this identifier, if known .

                    Typecode
                    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Requirements

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

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

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

                    ShortDescription of identifier
                    Comments

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

                    Control10..1
                    BindingThe codes SHALL be taken from Unless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type
                    (required to http://hl7.org/fhir/ValueSet/identifier-type)
                    TypeCodeableConcept(DP_CodeableConcept)
                    Is Modifierfalse
                    Summarytrue
                    Requirements

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

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

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

                    ShortThe namespace for the identifier value
                    Comments

                    Identifier.system is always case sensitive.

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

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

                    Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    96. CoverageEligibilityResponse.insurance.coverage.identifier.value
                    Definition

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

                    ShortThe value that is unique
                    Comments

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

                    Control10..1
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Max Length:50
                    Example<br/><b>General</b>:123456
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    98. CoverageEligibilityResponse.insurance.coverage.display
                    Definition

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

                    ShortText alternative for the resource
                    Comments

                    This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

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

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

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

                    Needed to convey the answer to the eligibility validation request.

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

                    The term of the benefits documented in this response.

                    ShortWhen the benefits are applicable
                    Control0..1
                    TypePeriod(DP_Period_2)
                    Is Modifierfalse
                    Must Supporttrue
                    Summaryfalse
                    Requirements

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

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

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

                    ShortBenefits and authorization details
                    Control0..*
                    TypeBackboneElement
                    Is Modifierfalse
                    Must Supporttrue
                    Summaryfalse
                    Invariantsces-1: SHALL contain a category or a billcode but not both. (category.exists() xor productOrService.exists())
                    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    BV-00311: CoverageEligibilityResponse.insurance.item.name SHALL have maximum length of 100 English characters and 50 Arabic characters. (name.exists() implies name.length() <= 100)
                    BV-00312: CoverageEligibilityResponse.insurance.item.benefit.allowedString SHALL have maximum length of 60 characters. (name.exists() implies name.length() <= 60)
                    ces-1: SHALL contain a category or a billcode but not both. (category.exists() xor productOrService.exists())
                    106. CoverageEligibilityResponse.insurance.item.modifierExtension
                    Definition

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

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

                    ShortExtensions that cannot be ignored even if unrecognized
                    Comments

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

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

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

                    Alternate Namesextensions, user content, modifiers
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    108. CoverageEligibilityResponse.insurance.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
                    BindingThe codes SHALL be taken from For example codes, see Benefit Categoryhttp://hl7.org/fhir/ValueSet/ex-benefitcategory
                    (required to http://nphies.sa/terminology/ValueSet/benefit-category)
                    TypeCodeableConcept(DP_CodeableConcept)
                    Is Modifierfalse
                    Must Supporttrue
                    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()))
                    110. CoverageEligibilityResponse.insurance.item.excluded
                    Definition

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

                    ShortExcluded from the plan
                    Control0..1
                    Typeboolean
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supporttrue
                    Summaryfalse
                    Requirements

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

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

                    A short name or tag for the benefit.

                    ShortShort name for the benefit
                    Comments

                    For example: MED01, or DENT2.

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

                    Required to align with other plan names.

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

                    A richer description of the benefit or services covered.

                    ShortDescription of the benefit or services covered
                    Comments

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

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

                    Needed for human readable reference.

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

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

                    ShortIn or out of network
                    Control10..1
                    BindingThe codes SHALL be taken from For example codes, see NetworkTypeCodeshttp://hl7.org/fhir/ValueSet/benefit-network
                    (required to http://hl7.org/fhir/ValueSet/benefit-network)
                    TypeCodeableConcept(DP_CodeableConcept)
                    Is Modifierfalse
                    Summaryfalse
                    Requirements

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

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

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

                    ShortIndividual or family
                    Control10..1
                    BindingThe codes SHALL be taken from For example codes, see UnitTypeCodeshttp://hl7.org/fhir/ValueSet/benefit-unit
                    (required to http://hl7.org/fhir/ValueSet/benefit-unit)
                    TypeCodeableConcept(DP_CodeableConcept)
                    Is Modifierfalse
                    Summaryfalse
                    Requirements

                    Needed for the understanding of the benefits.

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

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

                    ShortAnnual or lifetime
                    Control10..1
                    BindingThe codes SHALL be taken from For example codes, see BenefitTermCodeshttp://hl7.org/fhir/ValueSet/benefit-term
                    (required to http://hl7.org/fhir/ValueSet/benefit-term)
                    TypeCodeableConcept(DP_CodeableConcept)
                    Is Modifierfalse
                    Summaryfalse
                    Requirements

                    Needed for the understanding of the benefits.

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

                    Benefits used to date.

                    ShortBenefit Summary
                    Control0..*
                    TypeBackboneElement
                    Is Modifierfalse
                    Must Supporttrue
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    BV-00313: CoverageEligibilityResponse.insurance.item.benefit.allowedString SHALL have maximum length of 60 characters. (allowed.ofType(string).exists() implies allowed.ofType(string).length() <= 60)
                    BV-00314: CoverageEligibilityResponse.insurance.item.benefit.usedString SHALL have maximum length of 60 characters. (used.ofType(string).exists() implies used.ofType(string).length() <= 60)
                    124. CoverageEligibilityResponse.insurance.item.benefit.modifierExtension
                    Definition

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

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

                    ShortExtensions that cannot be ignored even if unrecognized
                    Comments

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

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

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

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

                    Classification of benefit being provided.

                    ShortBenefit classification
                    Comments

                    For example: deductible, visits, benefit amount.

                    Control1..1
                    BindingThe codes SHALL be taken from For example codes, see Benefit Typehttp://hl7.org/fhir/ValueSet/benefit-type
                    (required to http://nphies.sa/terminology/ValueSet/benefit-type)
                    TypeCodeableConcept(DP_CodeableConcept)
                    Is Modifierfalse
                    Summaryfalse
                    Requirements

                    Needed to convey the nature of the benefit.

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

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

                    ShortBenefits allowed
                    Control10..1
                    TypeChoice of: unsignedInt, string, Money
                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summaryfalse
                    Requirements

                    Needed to convey the benefits offered under the coverage.

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

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

                      ShortBenefits allowed
                      Control0..1
                      TypeunsignedInt(DP_unsignedInt), Money, string
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supporttrue
                      Summaryfalse
                      Requirements

                      Needed to convey the benefits offered under the coverage.

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

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

                      ShortBenefits allowed
                      Control0..1
                      Typestring, Money, unsignedInt
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supporttrue
                      Summaryfalse
                      Requirements

                      Needed to convey the benefits offered under the coverage.

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

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

                      ShortBenefits allowed
                      Control0..1
                      TypeMoney(DP_Money_SAR), string, unsignedInt
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Is Modifierfalse
                      Must Supporttrue
                      Summaryfalse
                      Requirements

                      Needed to convey the benefits offered under the coverage.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      BV-00084: CoverageEligibilityResponse.insurance.item.benefit.allowedMoney.currency SHALL be SAR (currency.exists() implies currency ='SAR')
                      136. CoverageEligibilityResponse.insurance.item.benefit.used[x]
                      Definition

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

                      ShortBenefits used
                      Control0..1
                      TypeChoice of: unsignedInt, string, Money
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supporttrue
                      Must Support TypesNo must-support rules about the choice of types/profiles
                      Summaryfalse
                      Requirements

                      Needed to convey the benefits consumed to date.

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

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

                        ShortBenefits used
                        Control0..1
                        TypeunsignedInt(DP_unsignedInt), Money, string
                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        Summaryfalse
                        Requirements

                        Needed to convey the benefits consumed to date.

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

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

                        ShortBenefits used
                        Control0..1
                        Typestring, Money, unsignedInt
                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        Summaryfalse
                        Requirements

                        Needed to convey the benefits consumed to date.

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

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

                        ShortBenefits used
                        Control0..1
                        TypeMoney(DP_Money_SAR), string, unsignedInt
                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                        Is Modifierfalse
                        Must Supporttrue
                        Summaryfalse
                        Requirements

                        Needed to convey the benefits consumed to date.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        BV-00085: CoverageEligibilityResponse.insurance.item.benefit.used.currency SHALL be SAR (currency.exists() implies currency ='SAR')
                        144. CoverageEligibilityResponse.error
                        Definition

                        Errors encountered during the processing of the request.

                        ShortProcessing errors
                        Control0..*
                        TypeBackboneElement
                        Is Modifierfalse
                        Must Supporttrue
                        Summaryfalse
                        Requirements

                        Need to communicate processing issues to the requestor.

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

                        An Extension


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

                        ShortExtensionAdditional content defined by implementations
                        Comments

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

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

                          Expression for error location as part of error reporting to indicate the location of error.

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

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

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

                          ShortExtensions that cannot be ignored even if unrecognized
                          Comments

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

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

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

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

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

                          ShortError code detailing processing issues
                          Control1..1
                          BindingThe codes SHALL be taken from For example codes, see Adjudication Error Codeshttp://hl7.org/fhir/ValueSet/adjudication-error
                          (required to http://nphies.sa/terminology/ValueSet/adjudication-error)
                          TypeCodeableConcept(DP_CodeableConcept)
                          Is Modifierfalse
                          Summaryfalse
                          Requirements

                          Required to convey processing errors.

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

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

                          0. CoverageEligibilityResponse
                          Definition

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

                          ShortCoverageEligibilityResponse resource
                          Control0..*
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                          dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
                          dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
                          dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
                          dom-6: A resource should have narrative for robust management (text.`div`.exists())
                          BV-00539: CoverageEligibilityResponse.status SHALL use the fixed value 'active'. (status.exists() implies status = 'active')
                          ksa-purpose-unique-code: Purpose code values must be unique. (purpose.exists() implies purpose.isDistinct())
                          BV-00310: CoverageEligibilityResponse.disposition SHALL have maximum length of 250 English characters and 125 Arabic characters. (disposition.exists() implies disposition.length() <= 250)
                          BV-00315: CoverageEligibilityResponse.preAuthRef SHALL have maximum length of 40 characters. (preAuthRef.exists() implies preAuthRef.length() <= 40)
                          BV-00503: CoverageEligibiltyResponse.extension.siteEligibility SHALL be provided when CoverageEligibiltyResponse.outcome='complete'. (outcome.exists() implies (outcome = 'complete' implies extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').exists()))
                          BV-00535: The CoverageEligibiltyResponse.extension.siteEligibility value SHALL not be 'eligible' if for every array entry of CoverageEligibiltyResponse.insurance the related CoverageEligibilityResponse.insurance.inforce value is 'false'. (iif( (insurance.where(inforce = true).count() = 0) and (extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').count()=1), iif((extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').value.ofType(CodeableConcept).coding.first().code='eligible') ,false,true), true))
                          BV-00536: The CoverageEligibilityResponse.error SHALL be provided when CoverageEligibilityResponse.outcome= 'error'. (outcome.exists() implies (outcome = 'error' implies error.exists()))
                          BV-00559: The CoverageEligibiltyResponse.extension.siteEligibility value SHALL be 'eligible' if at least in one array entry of CoverageEligibiltyResponse.insurance the related CoverageEligibilityResponse.insurance.siteEligibility is 'eligible'. (iif( insurance.extension.exists(), iif( (insurance.extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').value.ofType(CodeableConcept).coding.where(code='eligible').count() > 0), iif( extension.exists(), (extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').value.ofType(CodeableConcept).coding.where(code='eligible').count() > 0), true), false), true))
                          BV-00561: The CoverageEligibiltyResponse.extension.siteEligibility value SHALL not be 'eligible' if for every array entry of CoverageEligibiltyResponse.insurance the related CoverageEligibilityResponse.insurance.siteEligibility is not 'eligible'. (iif( (extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').count() = 1), iif(extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').first().value.ofType(CodeableConcept).coding.first().code='eligible', iif(insurance.extension.exists(),insurance.extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').select(value.ofType(CodeableConcept).coding.select(code='eligible').count()>0),false),false), true))
                          2. CoverageEligibilityResponse.id
                          Definition

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

                          ShortLogical id of this artifact
                          Comments

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

                          Control1..1
                          Typeid
                          Is Modifierfalse
                          Summarytrue
                          Max Length:64
                          4. CoverageEligibilityResponse.meta
                          Definition

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

                          ShortMetadata about the resource
                          Control1..1
                          TypeMeta
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          6. CoverageEligibilityResponse.meta.id
                          Definition

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

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

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

                          ShortAdditional content defined by implementations
                          Comments

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

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

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

                            ShortVersion specific identifier
                            Comments

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

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

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

                            ShortWhen the resource version last changed
                            Comments

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

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

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

                            ShortIdentifies where the resource comes from
                            Comments

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

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

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

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

                            ShortProfiles this resource claims to conform to
                            Comments

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

                            Control1..*
                            Typecanonical(DP_canonical)(StructureDefinition)
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            18. CoverageEligibilityResponse.meta.security
                            Definition

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

                            ShortSecurity Labels applied to this resource
                            Comments

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

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

                            Security Labels from the Healthcare Privacy and Security Classification System.

                            TypeCoding
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            20. CoverageEligibilityResponse.meta.tag
                            Definition

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

                            ShortTags applied to this resource
                            Comments

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

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

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

                            TypeCoding
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            22. CoverageEligibilityResponse.implicitRules
                            Definition

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

                            ShortA set of rules under which this content was created
                            Comments

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

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

                            The base language in which the resource is written.

                            ShortLanguage of the resource content
                            Comments

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

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

                            A human language.

                            Additional BindingsPurpose
                            AllLanguagesMax Binding
                            Typecode
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            26. CoverageEligibilityResponse.text
                            Definition

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

                            ShortText summary of the resource, for human interpretation
                            Comments

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

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

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

                            ShortContained, inline Resources
                            Comments

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

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

                            An Extension

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

                              Code to indicate whether the patient is eligible or not eligible and why.

                              ShortSite Eligibility
                              Control0..1
                              This element is affected by the following invariants: ele-1
                              TypeExtension(Site Eligibility) (Extension Type: CodeableConcept(DP_CodeableConcept))
                              Is Modifierfalse
                              Must Supporttrue
                              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())
                              34. CoverageEligibilityResponse.modifierExtension
                              Definition

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

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

                              ShortExtensions that cannot be ignored
                              Comments

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

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

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

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

                              A unique identifier assigned to this coverage eligiblity request.

                              ShortBusiness Identifier for coverage eligiblity request
                              NoteThis is a business identifier, not a resource identifier (see discussion)
                              Control1..1
                              TypeIdentifier(DP_Identifier_A)
                              Is Modifierfalse
                              Summaryfalse
                              Requirements

                              Allows coverage eligibility requests to be distinguished and referenced.

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

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

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

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

                              ShortAdditional content defined by implementations
                              Comments

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

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

                                The purpose of this identifier.

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

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

                                Control0..1
                                BindingThe codes SHALL be taken from IdentifierUse
                                (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                                Identifies the purpose for this identifier, if known .

                                Typecode
                                Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Requirements

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

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

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

                                ShortDescription of identifier
                                Comments

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

                                Control0..1
                                BindingThe codes SHALL be taken from Identifier Type Codes
                                (required to http://hl7.org/fhir/ValueSet/identifier-type)
                                TypeCodeableConcept
                                Is Modifierfalse
                                Must Supporttrue
                                Summarytrue
                                Requirements

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

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

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

                                ShortThe namespace for the identifier value
                                Comments

                                Identifier.system is always case sensitive.

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

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

                                Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                48. CoverageEligibilityResponse.identifier.value
                                Definition

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

                                ShortThe value that is unique
                                Comments

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

                                Control1..1
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Max Length:50
                                Example<br/><b>General</b>:123456
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                50. CoverageEligibilityResponse.identifier.period
                                Definition

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

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

                                Organization that issued/manages the identifier.

                                ShortOrganization that issued id (may be just text)
                                Comments

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

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

                                The status of the resource instance.

                                Shortactive | cancelled | draft | entered-in-error
                                Comments

                                This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

                                Control1..1
                                BindingThe codes SHALL be taken from FinancialResourceStatusCodes
                                (required to http://hl7.org/fhir/ValueSet/fm-status|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()))
                                56. CoverageEligibilityResponse.purpose
                                Definition

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

                                Shortauth-requirements | benefits | discovery | validation
                                Control1..*
                                BindingThe codes SHALL be taken from EligibilityResponsePurpose
                                (required to http://hl7.org/fhir/ValueSet/eligibilityresponse-purpose)
                                Typecode(DP_code)
                                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()))
                                58. CoverageEligibilityResponse.patient
                                Definition

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

                                ShortIntended recipient of products and services
                                Control1..1
                                TypeReference(DP_Reference_1or2a)(Nphies 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()))
                                60. CoverageEligibilityResponse.patient.id
                                Definition

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

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

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

                                ShortAdditional content defined by implementations
                                Comments

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

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

                                  A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                  ShortLiteral reference, Relative, internal or absolute URL
                                  Comments

                                  Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                  Control0..1
                                  This element is affected by the following invariants: ref-1
                                  Typestring
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Must Supporttrue
                                  Summarytrue
                                  Max Length:250
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  66. CoverageEligibilityResponse.patient.type
                                  Definition

                                  The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                  The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                  ShortType the reference refers to (e.g. "Patient")
                                  Comments

                                  This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

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

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

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

                                  An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                  ShortLogical reference, when literal reference is not known
                                  Comments

                                  When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                  When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                  Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                  Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

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

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

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

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

                                  ShortAdditional content defined by implementations
                                  Comments

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

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

                                    The purpose of this identifier.

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

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

                                    Control0..1
                                    BindingThe codes SHALL be taken from IdentifierUse
                                    (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                                    Identifies the purpose for this identifier, if known .

                                    Typecode
                                    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Requirements

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

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

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

                                    ShortDescription of identifier
                                    Comments

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

                                    Control1..1
                                    BindingThe codes SHALL be taken from Patient Identifier Type
                                    (required to http://nphies.sa/terminology/ValueSet/patient-identifier-type)
                                    TypeCodeableConcept(DP_CodeableConcept)
                                    Is Modifierfalse
                                    Summarytrue
                                    Requirements

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

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

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

                                    ShortThe namespace for the identifier value
                                    Comments

                                    Identifier.system is always case sensitive.

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

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

                                    Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    80. CoverageEligibilityResponse.patient.identifier.value
                                    Definition

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

                                    ShortThe value that is unique
                                    Comments

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

                                    Control1..1
                                    Typestring
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Max Length:50
                                    Example<br/><b>General</b>:123456
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    82. CoverageEligibilityResponse.patient.identifier.period
                                    Definition

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

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

                                    Organization that issued/manages the identifier.

                                    ShortOrganization that issued id (may be just text)
                                    Comments

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

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

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

                                    ShortText alternative for the resource
                                    Comments

                                    This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                    Control0..1
                                    Typestring
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Max Length:200
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    88. CoverageEligibilityResponse.serviced[x]
                                    Definition

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

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

                                    Required to provide time context for the request.

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

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

                                      ShortEstimated date or dates of service
                                      Control0..1
                                      Typedate(DP_date)
                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supporttrue
                                      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()))
                                      92. CoverageEligibilityResponse.serviced[x]:servicedPeriod
                                      Slice NameservicedPeriod
                                      Definition

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

                                      ShortEstimated date or dates of service
                                      Control0..1
                                      TypePeriod(DP_Period_2)
                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                      Is Modifierfalse
                                      Must Supporttrue
                                      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()))
                                      94. CoverageEligibilityResponse.created
                                      Definition

                                      The date this resource was created.

                                      ShortResponse creation date
                                      Control1..1
                                      TypedateTime(DP_dateTime)
                                      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()))
                                      96. CoverageEligibilityResponse.requestor
                                      Definition

                                      The provider which is responsible for the request.

                                      ShortParty responsible for the request
                                      Comments

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

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

                                      Reference to the original request resource.

                                      ShortEligibility request reference
                                      Control1..1
                                      TypeReference(DP_Reference_1or3a)(Nphies CoverageEligibilityRequest)
                                      Is Modifierfalse
                                      Summarytrue
                                      Requirements

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

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

                                      The outcome of the request processing.

                                      Shortqueued | complete | error | partial
                                      Comments

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

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

                                      The outcome of the processing.

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

                                      To advise the requestor of an overall processing outcome.

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

                                      A human readable description of the status of the adjudication.

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

                                      Provided for user display.

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

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

                                      ShortCoverage issuer
                                      Control1..1
                                      TypeReference(DP_Reference_1or2a)(Nphies Insurer Organization)
                                      Is Modifierfalse
                                      Summarytrue
                                      Requirements

                                      Need to identify the author.

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

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

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

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

                                      ShortAdditional content defined by implementations
                                      Comments

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

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

                                        A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                        ShortLiteral reference, Relative, internal or absolute URL
                                        Comments

                                        Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                        Control0..1
                                        This element is affected by the following invariants: ref-1
                                        Typestring
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Must Supporttrue
                                        Summarytrue
                                        Max Length:250
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        112. CoverageEligibilityResponse.insurer.type
                                        Definition

                                        The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                        The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                        ShortType the reference refers to (e.g. "Patient")
                                        Comments

                                        This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

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

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

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

                                        An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                        ShortLogical reference, when literal reference is not known
                                        Comments

                                        When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                        When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                        Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                        Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

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

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

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

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

                                        ShortAdditional content defined by implementations
                                        Comments

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

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

                                          The purpose of this identifier.

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

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

                                          Control0..1
                                          BindingThe codes SHALL be taken from IdentifierUse
                                          (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                                          Identifies the purpose for this identifier, if known .

                                          Typecode
                                          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summarytrue
                                          Requirements

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

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

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

                                          ShortDescription of identifier
                                          Comments

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

                                          Control1..1
                                          BindingThe codes SHALL be taken from Organization Identifier
                                          (required to http://nphies.sa/terminology/ValueSet/organization-identifier-type)
                                          TypeCodeableConcept(DP_CodeableConcept)
                                          Is Modifierfalse
                                          Summarytrue
                                          Requirements

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

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

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

                                          ShortThe namespace for the identifier value
                                          Comments

                                          Identifier.system is always case sensitive.

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

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

                                          Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          126. CoverageEligibilityResponse.insurer.identifier.value
                                          Definition

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

                                          ShortThe value that is unique
                                          Comments

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

                                          Control1..1
                                          Typestring
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summarytrue
                                          Max Length:50
                                          Example<br/><b>General</b>:123456
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          128. CoverageEligibilityResponse.insurer.identifier.period
                                          Definition

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

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

                                          Organization that issued/manages the identifier.

                                          ShortOrganization that issued id (may be just text)
                                          Comments

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

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

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

                                          ShortText alternative for the resource
                                          Comments

                                          This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

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

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

                                          ShortPatient insurance information
                                          Comments

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

                                          Control0..*
                                          TypeBackboneElement
                                          Is Modifierfalse
                                          Must Supporttrue
                                          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()))
                                          136. CoverageEligibilityResponse.insurance.id
                                          Definition

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

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

                                          An Extension

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

                                            Code to indicate whether the patient is eligible or not eligible and why.

                                            ShortSite Eligibility
                                            Control0..1
                                            This element is affected by the following invariants: ele-1
                                            TypeExtension(Site Eligibility) (Extension Type: CodeableConcept(DP_CodeableConcept))
                                            Is Modifierfalse
                                            Must Supporttrue
                                            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())
                                            142. CoverageEligibilityResponse.insurance.modifierExtension
                                            Definition

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

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

                                            ShortExtensions that cannot be ignored even if unrecognized
                                            Comments

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

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

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

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

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

                                            ShortInsurance information
                                            Control1..1
                                            TypeReference(DP_Reference_1or2a)(Nphies Coverage)
                                            Is Modifierfalse
                                            Summarytrue
                                            Requirements

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

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            146. CoverageEligibilityResponse.insurance.coverage.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
                                            148. CoverageEligibilityResponse.insurance.coverage.extension
                                            Definition

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

                                            ShortAdditional content defined by implementations
                                            Comments

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

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

                                              A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                              ShortLiteral reference, Relative, internal or absolute URL
                                              Comments

                                              Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                              Control0..1
                                              This element is affected by the following invariants: ref-1
                                              Typestring
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Must Supporttrue
                                              Summarytrue
                                              Max Length:250
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              152. CoverageEligibilityResponse.insurance.coverage.type
                                              Definition

                                              The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                              The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                              ShortType the reference refers to (e.g. "Patient")
                                              Comments

                                              This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

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

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

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

                                              An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                              ShortLogical reference, when literal reference is not known
                                              Comments

                                              When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                              When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                              Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                              Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                              NoteThis is a business identifier, not a resource identifier (see discussion)
                                              Control0..1
                                              TypeIdentifier
                                              Is Modifierfalse
                                              Must Supporttrue
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              156. CoverageEligibilityResponse.insurance.coverage.identifier.id
                                              Definition

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

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

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

                                              ShortAdditional content defined by implementations
                                              Comments

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

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

                                                The purpose of this identifier.

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

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

                                                Control0..1
                                                BindingThe codes SHALL be taken from IdentifierUse
                                                (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                                                Identifies the purpose for this identifier, if known .

                                                Typecode
                                                Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summarytrue
                                                Requirements

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

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

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

                                                ShortDescription of identifier
                                                Comments

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

                                                Control1..1
                                                BindingThe codes SHALL be taken from Identifier Type Codes
                                                (required to http://hl7.org/fhir/ValueSet/identifier-type)
                                                TypeCodeableConcept(DP_CodeableConcept)
                                                Is Modifierfalse
                                                Summarytrue
                                                Requirements

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

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

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

                                                ShortThe namespace for the identifier value
                                                Comments

                                                Identifier.system is always case sensitive.

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

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

                                                Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                166. CoverageEligibilityResponse.insurance.coverage.identifier.value
                                                Definition

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

                                                ShortThe value that is unique
                                                Comments

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

                                                Control1..1
                                                Typestring
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summarytrue
                                                Max Length:50
                                                Example<br/><b>General</b>:123456
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                168. CoverageEligibilityResponse.insurance.coverage.identifier.period
                                                Definition

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

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

                                                Organization that issued/manages the identifier.

                                                ShortOrganization that issued id (may be just text)
                                                Comments

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

                                                Control0..1
                                                TypeReference(Organization)
                                                Is Modifierfalse
                                                Summarytrue
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                172. CoverageEligibilityResponse.insurance.coverage.display
                                                Definition

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

                                                ShortText alternative for the resource
                                                Comments

                                                This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

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

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

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

                                                Needed to convey the answer to the eligibility validation request.

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

                                                The term of the benefits documented in this response.

                                                ShortWhen the benefits are applicable
                                                Control0..1
                                                TypePeriod(DP_Period_2)
                                                Is Modifierfalse
                                                Must Supporttrue
                                                Summaryfalse
                                                Requirements

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

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

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

                                                ShortBenefits and authorization details
                                                Control0..*
                                                TypeBackboneElement
                                                Is Modifierfalse
                                                Must Supporttrue
                                                Summaryfalse
                                                Invariantsces-1: SHALL contain a category or a billcode but not both. (category.exists() xor productOrService.exists())
                                                ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                BV-00311: CoverageEligibilityResponse.insurance.item.name SHALL have maximum length of 100 English characters and 50 Arabic characters. (name.exists() implies name.length() <= 100)
                                                BV-00312: CoverageEligibilityResponse.insurance.item.benefit.allowedString SHALL have maximum length of 60 characters. (name.exists() implies name.length() <= 60)
                                                180. CoverageEligibilityResponse.insurance.item.id
                                                Definition

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

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

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

                                                ShortAdditional content defined by implementations
                                                Comments

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

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

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

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

                                                ShortExtensions that cannot be ignored even if unrecognized
                                                Comments

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

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

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

                                                Alternate Namesextensions, user content, modifiers
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                186. CoverageEligibilityResponse.insurance.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
                                                BindingThe codes SHALL be taken from Benefit Category
                                                (required to http://nphies.sa/terminology/ValueSet/benefit-category)
                                                TypeCodeableConcept(DP_CodeableConcept)
                                                Is Modifierfalse
                                                Must Supporttrue
                                                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()))
                                                188. CoverageEligibilityResponse.insurance.item.productOrService
                                                Definition

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

                                                ShortBilling, service, product, or drug code
                                                Comments

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

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

                                                Allowable service and product codes.

                                                TypeCodeableConcept
                                                Is Modifierfalse
                                                Summaryfalse
                                                Requirements

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

                                                Alternate NamesDrug Code, Bill Code, Service Code
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                190. CoverageEligibilityResponse.insurance.item.modifier
                                                Definition

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

                                                ShortProduct or service billing modifiers
                                                Comments

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

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

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

                                                TypeCodeableConcept
                                                Is Modifierfalse
                                                Summaryfalse
                                                Requirements

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

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

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

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

                                                Needed to convey the eligible provider.

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

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

                                                ShortExcluded from the plan
                                                Control0..1
                                                Typeboolean
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Must Supporttrue
                                                Summaryfalse
                                                Requirements

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

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

                                                A short name or tag for the benefit.

                                                ShortShort name for the benefit
                                                Comments

                                                For example: MED01, or DENT2.

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

                                                Required to align with other plan names.

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

                                                A richer description of the benefit or services covered.

                                                ShortDescription of the benefit or services covered
                                                Comments

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

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

                                                Needed for human readable reference.

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

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

                                                ShortIn or out of network
                                                Control1..1
                                                BindingThe codes SHALL be taken from NetworkTypeCodes
                                                (required to http://hl7.org/fhir/ValueSet/benefit-network)
                                                TypeCodeableConcept(DP_CodeableConcept)
                                                Is Modifierfalse
                                                Summaryfalse
                                                Requirements

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

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

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

                                                ShortIndividual or family
                                                Control1..1
                                                BindingThe codes SHALL be taken from UnitTypeCodes
                                                (required to http://hl7.org/fhir/ValueSet/benefit-unit)
                                                TypeCodeableConcept(DP_CodeableConcept)
                                                Is Modifierfalse
                                                Summaryfalse
                                                Requirements

                                                Needed for the understanding of the benefits.

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

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

                                                ShortAnnual or lifetime
                                                Control1..1
                                                BindingThe codes SHALL be taken from BenefitTermCodes
                                                (required to http://hl7.org/fhir/ValueSet/benefit-term)
                                                TypeCodeableConcept(DP_CodeableConcept)
                                                Is Modifierfalse
                                                Summaryfalse
                                                Requirements

                                                Needed for the understanding of the benefits.

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

                                                Benefits used to date.

                                                ShortBenefit Summary
                                                Control0..*
                                                TypeBackboneElement
                                                Is Modifierfalse
                                                Must Supporttrue
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                BV-00313: CoverageEligibilityResponse.insurance.item.benefit.allowedString SHALL have maximum length of 60 characters. (allowed.ofType(string).exists() implies allowed.ofType(string).length() <= 60)
                                                BV-00314: CoverageEligibilityResponse.insurance.item.benefit.usedString SHALL have maximum length of 60 characters. (used.ofType(string).exists() implies used.ofType(string).length() <= 60)
                                                208. CoverageEligibilityResponse.insurance.item.benefit.id
                                                Definition

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

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

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

                                                ShortAdditional content defined by implementations
                                                Comments

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

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

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

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

                                                ShortExtensions that cannot be ignored even if unrecognized
                                                Comments

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

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

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

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

                                                Classification of benefit being provided.

                                                ShortBenefit classification
                                                Comments

                                                For example: deductible, visits, benefit amount.

                                                Control1..1
                                                BindingThe codes SHALL be taken from Benefit Type
                                                (required to http://nphies.sa/terminology/ValueSet/benefit-type)
                                                TypeCodeableConcept(DP_CodeableConcept)
                                                Is Modifierfalse
                                                Summaryfalse
                                                Requirements

                                                Needed to convey the nature of the benefit.

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

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

                                                ShortBenefits allowed
                                                Control1..1
                                                TypeChoice of: unsignedInt, string, Money
                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Requirements

                                                Needed to convey the benefits offered under the coverage.

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

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

                                                  ShortBenefits allowed
                                                  Control0..1
                                                  TypeunsignedInt(DP_unsignedInt)
                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Must Supporttrue
                                                  Summaryfalse
                                                  Requirements

                                                  Needed to convey the benefits offered under the coverage.

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

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

                                                  ShortBenefits allowed
                                                  Control0..1
                                                  Typestring
                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Must Supporttrue
                                                  Summaryfalse
                                                  Requirements

                                                  Needed to convey the benefits offered under the coverage.

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

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

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

                                                  Needed to convey the benefits offered under the coverage.

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  BV-00084: CoverageEligibilityResponse.insurance.item.benefit.allowedMoney.currency SHALL be SAR (currency.exists() implies currency ='SAR')
                                                  224. CoverageEligibilityResponse.insurance.item.benefit.used[x]
                                                  Definition

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

                                                  ShortBenefits used
                                                  Control0..1
                                                  TypeChoice of: unsignedInt, string, Money
                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Must Supporttrue
                                                  Must Support TypesNo must-support rules about the choice of types/profiles
                                                  Summaryfalse
                                                  Requirements

                                                  Needed to convey the benefits consumed to date.

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

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

                                                    ShortBenefits used
                                                    Control0..1
                                                    TypeunsignedInt(DP_unsignedInt)
                                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Must Supporttrue
                                                    Summaryfalse
                                                    Requirements

                                                    Needed to convey the benefits consumed to date.

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

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

                                                    ShortBenefits used
                                                    Control0..1
                                                    Typestring
                                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Must Supporttrue
                                                    Summaryfalse
                                                    Requirements

                                                    Needed to convey the benefits consumed to date.

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

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

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

                                                    Needed to convey the benefits consumed to date.

                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    BV-00085: CoverageEligibilityResponse.insurance.item.benefit.used.currency SHALL be SAR (currency.exists() implies currency ='SAR')
                                                    232. CoverageEligibilityResponse.insurance.item.authorizationRequired
                                                    Definition

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

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

                                                    Needed to convey that preauthorization is required.

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

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

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

                                                    Type of supporting information to provide with a preauthorization.

                                                    TypeCodeableConcept
                                                    Is Modifierfalse
                                                    Summaryfalse
                                                    Requirements

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

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

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

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

                                                    Needed to enable insurers to advise providers of informative information.

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

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

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

                                                    To provide any preauthorization reference for provider use.

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

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

                                                    ShortPrinted form identifier
                                                    Comments

                                                    May be needed to identify specific jurisdictional forms.

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

                                                    The forms codes.

                                                    TypeCodeableConcept
                                                    Is Modifierfalse
                                                    Summaryfalse
                                                    Requirements

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

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

                                                    Errors encountered during the processing of the request.

                                                    ShortProcessing errors
                                                    Control0..*
                                                    TypeBackboneElement
                                                    Is Modifierfalse
                                                    Must Supporttrue
                                                    Summaryfalse
                                                    Requirements

                                                    Need to communicate processing issues to the requestor.

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

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

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

                                                    An Extension

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

                                                      Expression for error location as part of error reporting to indicate the location of error.

                                                      ShortError Expression
                                                      Control0..1
                                                      This element is affected by the following invariants: ele-1
                                                      TypeExtension(Error Expression) (Extension Type: string)
                                                      Is Modifierfalse
                                                      Must Supporttrue
                                                      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())
                                                      250. CoverageEligibilityResponse.error.modifierExtension
                                                      Definition

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

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

                                                      ShortExtensions that cannot be ignored even if unrecognized
                                                      Comments

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

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

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

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

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

                                                      ShortError code detailing processing issues
                                                      Control1..1
                                                      BindingThe codes SHALL be taken from Adjudication Error Codes
                                                      (required to http://nphies.sa/terminology/ValueSet/adjudication-error)
                                                      TypeCodeableConcept(DP_CodeableConcept)
                                                      Is Modifierfalse
                                                      Summaryfalse
                                                      Requirements

                                                      Required to convey processing errors.

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