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

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

Resource Profile: Profile_R3_ClaimResponse_R5 - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-ClaimResponse resource profile.

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

0. ClaimResponse
Definition

This resource provides the adjudication details from the processing of a Claim resource.

ShortResponse to a claim predetermination or preauthorization
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate NamesRemittance Advice
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. ClaimResponse.implicitRules
Definition

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

ShortA set of rules under which this content was created
Comments

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

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

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

ShortContained, inline Resources
Comments

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

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
6. ClaimResponse.extension
Definition

An Extension


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

ShortExtensionAdditional content defined by implementations
Comments

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

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

    STU3: ClaimResponse.unallocDeductable (new:Money)

    ShortSTU3: Unallocated deductible (new)
    Comments

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

    Control0..1
    TypeExtension(STU3: Unallocated deductible (new)) (Extension Type: Money)
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. ClaimResponse.modifierExtension
    Definition

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

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

    ShortExtensions that cannot be ignored
    Comments

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

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

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

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

    The status of the resource instance.

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

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

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

    A code specifying the state of the resource instance.

    Typecode
    Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summarytrue
    Requirements

    Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.

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

    A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.

    ShortMore granular claim type
    Comments

    This may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type.

    Control1..1
    BindingUnless not suitable, these codes SHALL be taken from ClaimTypeCodeshttp://hl7.org/fhir/ValueSet/claim-type|5.0.0
    (extensible to http://hl7.org/fhir/ValueSet/claim-type|5.0.0)

    The type or discipline-style of the claim.

    TypeCodeableConcept
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Requirements

    Some jurisdictions need a finer grained claim type for routing and adjudication.

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

    A code to indicate whether the nature of the request is: Claim - A request to an Insurer to adjudicate the supplied charges for health care goods and services under the identified policy and to pay the determined Benefit amount, if any; Preauthorization - A request to an Insurer to adjudicate the supplied proposed future charges for health care goods and services under the identified policy and to approve the services and provide the expected benefit amounts and potentially to reserve funds to pay the benefits when Claims for the indicated services are later submitted; or, Pre-determination - A request to an Insurer to adjudicate the supplied 'what if' charges for health care goods and services under the identified policy and report back what the Benefit payable would be had the services actually been provided.

    Shortclaim | preauthorization | predetermination
    Control1..1
    BindingThe codes SHALL be taken from Use .http://hl7.org/fhir/ValueSet/claim-use|5.0.0
    (required to http://hl7.org/fhir/ValueSet/claim-use|5.0.0)

    Claim, preauthorization, predetermination.

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

    This element is required to understand the nature of the request for adjudication.

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

    The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for facast reimbursement is sought.

    ShortThe recipient of the products and services
    Control1..1
    TypeReference(Patient)
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Requirements

    The patient must be supplied to the insurer so that confirmation of coverage and service hstory may be considered as part of the authorization and/or adjudiction.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    20. ClaimResponse.patient.extension
    Definition

    An Extension


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

    ShortExtensionAdditional content defined by implementations
    Comments

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

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

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

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

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

      Control0..1
      TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      24. ClaimResponse.patient.reference
      Definition

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

      ShortLiteral reference, Relative, internal or absolute URL
      Comments

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

      Control0..1
      This element is affected by the following invariants: ref-2, ref-1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      26. ClaimResponse.created
      Definition

      The date this resource was created.

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

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

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

      The outcome of the claim, predetermination, or preauthorization processing.

      Shortqueued | complete | error | partial
      Comments

      The resource may be used to indicate that the Claim/Preauthorization/Pre-determination has been received but processing has not begun (queued); that it has been processed and one or more errors have been detected (error); no errors were detected and some of the adjudication processing has been performed (partial); or all of the adjudication processing has completed without errors (complete).

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

      The result of the claim processing.

      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      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()))
      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      30. ClaimResponse.outcome.extension
      Definition

      An Extension


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

      ShortExtensionAdditional content defined by implementations
      Comments

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

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

        STU3: ClaimResponse.outcome additional types (CodeableConcept) additional types from child elements (coding)

        ShortSTU3: complete | error | partial additional types
        Comments

        Element ClaimResponse.outcome is mapped to FHIR R5 element ClaimResponse.outcome as RelatedTo. The mappings for ClaimResponse.outcome do not cover the following types: CodeableConcept. The mappings for ClaimResponse.outcome do not cover the following types based on type expansion: coding.

        Control0..1
        TypeExtension(STU3: complete | error | partial additional types) (Extension Type: CodeableConcept)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

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

        0. ClaimResponse
        2. ClaimResponse.meta
        4. ClaimResponse.meta.extension
        Control0..*
        SlicingThis element introduces a set of slices on ClaimResponse.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 6. ClaimResponse.meta.extension:meta
          Slice Namemeta
          Definition

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

          ShortSTU3: meta additional types
          Comments

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

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

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

            ShortSTU3: text additional types
            Comments

            Element ClaimResponse.text is mapped to FHIR R5 element ClaimResponse.text as SourceIsBroaderThanTarget. The mappings for ClaimResponse.text do not cover the following types: Narrative. The mappings for ClaimResponse.text do not cover the following types based on type expansion: div, status. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

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

              STU3: ClaimResponse.unallocDeductable (new:Money)

              ShortSTU3: Unallocated deductible (new)
              Comments

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

              Control0..1
              TypeExtension(STU3: Unallocated deductible (new)) (Extension Type: Money)
              18. ClaimResponse.identifier
              NoteThis is a business identifier, not a resource identifier (see discussion)
              20. ClaimResponse.identifier.extension
              Control0..*
              SlicingThis element introduces a set of slices on ClaimResponse.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 22. ClaimResponse.identifier.extension:identifier
                Slice Nameidentifier
                Definition

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

                ShortSTU3: Response number additional types
                Comments

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

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

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

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

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

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

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

                    ShortSTU3: Insurance issuing organization additional types
                    Comments

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

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

                      STU3: ClaimResponse.requestProvider additional types from child elements (display, identifier, reference)

                      ShortSTU3: Responsible practitioner additional types
                      Comments

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

                      Control0..1
                      TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                      42. ClaimResponse.requestor.extension:requestOrganization
                      Slice NamerequestOrganization
                      Definition

                      STU3: ClaimResponse.requestOrganization additional types from child elements (display, identifier, reference)

                      ShortSTU3: Responsible organization additional types
                      Comments

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

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

                        STU3: ClaimResponse.request additional types from child elements (display, identifier, reference)

                        ShortSTU3: request additional types
                        Comments

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

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

                          STU3: ClaimResponse.outcome additional types (CodeableConcept) additional types from child elements (coding)

                          ShortSTU3: complete | error | partial additional types
                          Comments

                          Element ClaimResponse.outcome is mapped to FHIR R5 element ClaimResponse.outcome as RelatedTo. The mappings for ClaimResponse.outcome do not cover the following types: CodeableConcept. The mappings for ClaimResponse.outcome do not cover the following types based on type expansion: coding.

                          Control0..1
                          TypeExtension(STU3: complete | error | partial additional types) (Extension Type: CodeableConcept)
                          56. ClaimResponse.item
                          58. ClaimResponse.item.adjudication
                          60. ClaimResponse.item.adjudication.quantity
                          62. ClaimResponse.item.adjudication.quantity.extension
                          Control0..*
                          SlicingThis element introduces a set of slices on ClaimResponse.item.adjudication.quantity.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 64. ClaimResponse.item.adjudication.quantity.extension:value
                            Slice Namevalue
                            Definition

                            STU3: ClaimResponse.item.adjudication.value additional types (decimal) additional types from child elements (value)

                            ShortSTU3: value additional types
                            Comments

                            Element ClaimResponse.item.adjudication.value is mapped to FHIR R5 element ClaimResponse.item.adjudication.quantity as SourceIsBroaderThanTarget. The mappings for ClaimResponse.item.adjudication.value do not cover the following types: decimal. The mappings for ClaimResponse.item.adjudication.value do not cover the following types based on type expansion: value.

                            Control0..1
                            TypeExtension(STU3: value additional types) (Extension Type: decimal)
                            66. ClaimResponse.addItem
                            68. ClaimResponse.addItem.extension
                            Control0..*
                            SlicingThis element introduces a set of slices on ClaimResponse.addItem.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 70. ClaimResponse.addItem.extension:revenue
                              Slice Namerevenue
                              Definition

                              STU3: ClaimResponse.addItem.revenue (new:CodeableConcept)

                              ShortSTU3: Revenue or cost center code (new)
                              Comments

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

                              Control0..1
                              TypeExtension(STU3: Revenue or cost center code (new)) (Extension Type: CodeableConcept)
                              72. ClaimResponse.addItem.extension:category
                              Slice Namecategory
                              Definition

                              STU3: ClaimResponse.addItem.category (new:CodeableConcept)

                              ShortSTU3: Type of service or product (new)
                              Comments

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

                              Control0..1
                              TypeExtension(STU3: Type of service or product (new)) (Extension Type: CodeableConcept)
                              74. ClaimResponse.addItem.extension:fee
                              Slice Namefee
                              Definition

                              STU3: ClaimResponse.addItem.fee (new:Money)

                              ShortSTU3: Professional fee or Product charge (new)
                              Comments

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

                              Control0..1
                              TypeExtension(STU3: Professional fee or Product charge (new)) (Extension Type: Money)
                              76. ClaimResponse.addItem.detail
                              78. ClaimResponse.addItem.detail.extension
                              Control0..*
                              SlicingThis element introduces a set of slices on ClaimResponse.addItem.detail.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 80. ClaimResponse.addItem.detail.extension:revenue
                                Slice Namerevenue
                                Definition

                                STU3: ClaimResponse.addItem.detail.revenue (new:CodeableConcept)

                                ShortSTU3: Revenue or cost center code (new)
                                Comments

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

                                Control0..1
                                TypeExtension(STU3: Revenue or cost center code (new)) (Extension Type: CodeableConcept)
                                82. ClaimResponse.addItem.detail.extension:category
                                Slice Namecategory
                                Definition

                                STU3: ClaimResponse.addItem.detail.category (new:CodeableConcept)

                                ShortSTU3: Type of service or product (new)
                                Comments

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

                                Control0..1
                                TypeExtension(STU3: Type of service or product (new)) (Extension Type: CodeableConcept)
                                84. ClaimResponse.addItem.detail.extension:fee
                                Slice Namefee
                                Definition

                                STU3: ClaimResponse.addItem.detail.fee (new:Money)

                                ShortSTU3: Professional fee or Product charge (new)
                                Comments

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

                                Control0..1
                                TypeExtension(STU3: Professional fee or Product charge (new)) (Extension Type: Money)
                                86. ClaimResponse.payment
                                88. ClaimResponse.payment.identifier
                                NoteThis is a business identifier, not a resource identifier (see discussion)
                                90. ClaimResponse.payment.identifier.extension
                                Control0..*
                                SlicingThis element introduces a set of slices on ClaimResponse.payment.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 92. ClaimResponse.payment.identifier.extension:identifier
                                  Slice Nameidentifier
                                  Definition

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

                                  ShortSTU3: Identifier of the payment instrument additional types
                                  Comments

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

                                  Control0..1
                                  TypeExtension(STU3: Identifier of the payment instrument additional types) (Extension Type: Identifier)
                                  94. ClaimResponse.processNote
                                  96. ClaimResponse.processNote.type
                                  98. ClaimResponse.processNote.type.extension
                                  Control0..*
                                  SlicingThis element introduces a set of slices on ClaimResponse.processNote.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 100. ClaimResponse.processNote.type.extension:type
                                    Slice Nametype
                                    Definition

                                    STU3: ClaimResponse.processNote.type

                                    ShortSTU3: display | print | printoper
                                    Comments

                                    Element ClaimResponse.processNote.type is mapped to FHIR R5 element ClaimResponse.processNote.type as RelatedTo.

                                    Control0..1
                                    TypeExtension(STU3: display | print | printoper) (Extension Type: CodeableConcept)
                                    102. ClaimResponse.communicationRequest
                                    104. ClaimResponse.communicationRequest.extension
                                    Control0..*
                                    SlicingThis element introduces a set of slices on ClaimResponse.communicationRequest.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 106. ClaimResponse.communicationRequest.extension:communicationRequest
                                      Slice NamecommunicationRequest
                                      Definition

                                      STU3: ClaimResponse.communicationRequest additional types from child elements (display, identifier, reference)

                                      ShortSTU3: communicationRequest additional types
                                      Comments

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

                                      Control0..*
                                      TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                      108. ClaimResponse.insurance
                                      110. ClaimResponse.insurance.extension
                                      Control0..*
                                      SlicingThis element introduces a set of slices on ClaimResponse.insurance.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 112. ClaimResponse.insurance.extension:preAuthRef
                                        Slice NamepreAuthRef
                                        Definition

                                        STU3: ClaimResponse.insurance.preAuthRef (new:string)

                                        ShortSTU3: Pre-Authorization/Determination Reference (new)
                                        Comments

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

                                        Control0..*
                                        TypeExtension(STU3: Pre-Authorization/Determination Reference (new)) (Extension Type: string)
                                        114. ClaimResponse.insurance.coverage
                                        116. ClaimResponse.insurance.coverage.extension
                                        Control0..*
                                        SlicingThis element introduces a set of slices on ClaimResponse.insurance.coverage.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • value @ url
                                        • 118. ClaimResponse.insurance.coverage.extension:coverage
                                          Slice Namecoverage
                                          Definition

                                          STU3: ClaimResponse.insurance.coverage additional types from child elements (display, identifier, reference)

                                          ShortSTU3: coverage additional types
                                          Comments

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

                                          Control0..1
                                          TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                          120. ClaimResponse.insurance.claimResponse
                                          122. ClaimResponse.insurance.claimResponse.extension
                                          Control0..*
                                          SlicingThis element introduces a set of slices on ClaimResponse.insurance.claimResponse.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 124. ClaimResponse.insurance.claimResponse.extension:claimResponse
                                            Slice NameclaimResponse
                                            Definition

                                            STU3: ClaimResponse.insurance.claimResponse additional types from child elements (display, identifier, reference)

                                            ShortSTU3: claimResponse additional types
                                            Comments

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

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

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

                                            0. ClaimResponse
                                            Definition

                                            This resource provides the adjudication details from the processing of a Claim resource.

                                            ShortResponse to a claim predetermination or preauthorization
                                            Control0..*
                                            Is Modifierfalse
                                            Must Supportfalse
                                            Summaryfalse
                                            Alternate NamesRemittance Advice
                                            Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                                            dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
                                            dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
                                            dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
                                            dom-6: A resource should have narrative for robust management (text.`div`.exists())
                                            2. ClaimResponse.id
                                            Definition

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

                                            ShortLogical id of this artifact
                                            Comments

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

                                            Control0..1
                                            Typeid
                                            Is Modifierfalse
                                            Must Supportfalse
                                            Summarytrue
                                            4. ClaimResponse.meta
                                            Definition

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

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

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

                                            ShortUnique id for inter-element referencing
                                            Control0..1
                                            This element is affected by the following invariants: ele-1
                                            Typeid
                                            Is Modifierfalse
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            Summaryfalse
                                            8. ClaimResponse.meta.extension
                                            Definition

                                            An Extension

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

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

                                              ShortSTU3: meta additional types
                                              Comments

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

                                              Control0..1
                                              TypeExtension(STU3: meta additional types) (Extension Type: Meta)
                                              Is Modifierfalse
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              12. ClaimResponse.meta.versionId
                                              Definition

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

                                              ShortVersion specific identifier
                                              Comments

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

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

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

                                              ShortWhen the resource version last changed
                                              Comments

                                              This element is generally omitted in instances submitted in a PUT or POST. Instead, it is populated in the response instance and when retrieving information using a GET. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

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

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

                                              ShortIdentifies where the resource comes from
                                              Comments

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

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

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

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

                                              ShortProfiles this resource claims to conform to
                                              Comments

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

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

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

                                              ShortSecurity Labels applied to this resource
                                              Comments

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

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

                                              Security Labels from the Healthcare Privacy and Security Classification System.

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

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

                                              ShortTags applied to this resource
                                              Comments

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

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

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

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

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

                                              ShortA set of rules under which this content was created
                                              Comments

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

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

                                              The base language in which the resource is written.

                                              ShortLanguage of the resource content
                                              Comments

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

                                              Control0..1
                                              BindingThe codes SHALL be taken from AllLanguages
                                              (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

                                              IETF language tag for a human language

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

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

                                              ShortText summary of the resource, for human interpretation
                                              Comments

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

                                              Control0..1
                                              This element is affected by the following invariants: dom-6
                                              TypeNarrative
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summaryfalse
                                              Alternate Namesnarrative, html, xhtml, display
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              30. ClaimResponse.text.id
                                              Definition

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

                                              ShortUnique id for inter-element referencing
                                              Control0..1
                                              This element is affected by the following invariants: ele-1
                                              Typeid
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              32. ClaimResponse.text.extension
                                              Definition

                                              An Extension

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

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

                                                ShortSTU3: text additional types
                                                Comments

                                                Element ClaimResponse.text is mapped to FHIR R5 element ClaimResponse.text as SourceIsBroaderThanTarget. The mappings for ClaimResponse.text do not cover the following types: Narrative. The mappings for ClaimResponse.text do not cover the following types based on type expansion: div, status. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

                                                Control0..1
                                                TypeExtension(STU3: text additional types) (Complex Extension)
                                                Is Modifierfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                36. ClaimResponse.text.status
                                                Definition

                                                The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.

                                                Shortgenerated | extensions | additional | empty
                                                Control1..1
                                                BindingThe codes SHALL be taken from NarrativeStatus
                                                (required to http://hl7.org/fhir/ValueSet/narrative-status|5.0.0)

                                                The status of a resource narrative.

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

                                                The actual narrative content, a stripped down version of XHTML.

                                                ShortLimited xhtml content
                                                Comments

                                                The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.

                                                Control1..1
                                                Typexhtml
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes (htmlChecks())
                                                txt-2: The narrative SHALL have some non-whitespace content (htmlChecks())
                                                40. ClaimResponse.contained
                                                Definition

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

                                                ShortContained, inline Resources
                                                Comments

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

                                                Control0..*
                                                This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
                                                TypeResource
                                                Is Modifierfalse
                                                Must Supportfalse
                                                Summaryfalse
                                                Alternate Namesinline resources, anonymous resources, contained resources
                                                42. ClaimResponse.extension
                                                Definition

                                                An Extension

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

                                                  STU3: ClaimResponse.unallocDeductable (new:Money)

                                                  ShortSTU3: Unallocated deductible (new)
                                                  Comments

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

                                                  Control0..1
                                                  TypeExtension(STU3: Unallocated deductible (new)) (Extension Type: Money)
                                                  Is Modifierfalse
                                                  Must Supportfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  46. ClaimResponse.modifierExtension
                                                  Definition

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

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

                                                  ShortExtensions that cannot be ignored
                                                  Comments

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

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

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

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

                                                  A unique identifier assigned to this claim response.

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

                                                  Allows claim responses to be distinguished and referenced.

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

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

                                                  ShortUnique id for inter-element referencing
                                                  Control0..1
                                                  This element is affected by the following invariants: ele-1
                                                  Typeid
                                                  Is Modifierfalse
                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                  Summaryfalse
                                                  52. ClaimResponse.identifier.extension
                                                  Definition

                                                  An Extension

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

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

                                                    ShortSTU3: Response number additional types
                                                    Comments

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

                                                    Control0..*
                                                    TypeExtension(STU3: Response number additional types) (Extension Type: Identifier)
                                                    Is Modifierfalse
                                                    Summaryfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                    56. ClaimResponse.identifier.use
                                                    Definition

                                                    The purpose of this identifier.

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

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

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

                                                    Identifies the purpose for this identifier, if known .

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

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

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

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

                                                    ShortDescription of identifier
                                                    Comments

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

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

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

                                                    TypeCodeableConcept
                                                    Is Modifierfalse
                                                    Summarytrue
                                                    Requirements

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

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

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

                                                    ShortThe namespace for the identifier value
                                                    Comments

                                                    Identifier.system is always case sensitive.

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

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

                                                    ExampleGeneral: http://www.acme.com/identifiers/patient
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    62. ClaimResponse.identifier.value
                                                    Definition

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

                                                    ShortThe value that is unique
                                                    Comments

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

                                                    Control0..1
                                                    This element is affected by the following invariants: ident-1
                                                    Typestring
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    ExampleGeneral: 123456
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    64. ClaimResponse.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()))
                                                    66. ClaimResponse.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()))
                                                    68. ClaimResponse.traceNumber
                                                    Definition

                                                    Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

                                                    ShortNumber for tracking
                                                    Control0..*
                                                    TypeIdentifier
                                                    Is Modifierfalse
                                                    Must Supportfalse
                                                    Summaryfalse
                                                    Requirements

                                                    Allows partners to uniquely identify components for tracking.

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

                                                    The status of the resource instance.

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

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

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

                                                    A code specifying the state of the resource instance.

                                                    Typecode
                                                    Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Must Supportfalse
                                                    Summarytrue
                                                    Requirements

                                                    Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.

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

                                                    A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.

                                                    ShortMore granular claim type
                                                    Comments

                                                    This may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type.

                                                    Control1..1
                                                    BindingUnless not suitable, these codes SHALL be taken from ClaimTypeCodes
                                                    (extensible to http://hl7.org/fhir/ValueSet/claim-type|5.0.0)

                                                    The type or discipline-style of the claim.

                                                    TypeCodeableConcept
                                                    Is Modifierfalse
                                                    Must Supportfalse
                                                    Summarytrue
                                                    Requirements

                                                    Some jurisdictions need a finer grained claim type for routing and adjudication.

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

                                                    A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.

                                                    ShortMore granular claim type
                                                    Comments

                                                    This may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type.

                                                    Control0..1
                                                    BindingFor example codes, see ExampleClaimSubTypeCodes
                                                    (example to http://hl7.org/fhir/ValueSet/claim-subtype|5.0.0)

                                                    A more granular claim typecode.

                                                    TypeCodeableConcept
                                                    Is Modifierfalse
                                                    Must Supportfalse
                                                    Summaryfalse
                                                    Requirements

                                                    Some jurisdictions need a finer grained claim type for routing and adjudication.

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

                                                    A code to indicate whether the nature of the request is: Claim - A request to an Insurer to adjudicate the supplied charges for health care goods and services under the identified policy and to pay the determined Benefit amount, if any; Preauthorization - A request to an Insurer to adjudicate the supplied proposed future charges for health care goods and services under the identified policy and to approve the services and provide the expected benefit amounts and potentially to reserve funds to pay the benefits when Claims for the indicated services are later submitted; or, Pre-determination - A request to an Insurer to adjudicate the supplied 'what if' charges for health care goods and services under the identified policy and report back what the Benefit payable would be had the services actually been provided.

                                                    Shortclaim | preauthorization | predetermination
                                                    Control1..1
                                                    BindingThe codes SHALL be taken from Use .
                                                    (required to http://hl7.org/fhir/ValueSet/claim-use|5.0.0)

                                                    Claim, preauthorization, predetermination.

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

                                                    This element is required to understand the nature of the request for adjudication.

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

                                                    The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for facast reimbursement is sought.

                                                    ShortThe recipient of the products and services
                                                    Control1..1
                                                    TypeReference(Patient)
                                                    Is Modifierfalse
                                                    Must Supportfalse
                                                    Summarytrue
                                                    Requirements

                                                    The patient must be supplied to the insurer so that confirmation of coverage and service hstory may be considered as part of the authorization and/or adjudiction.

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

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

                                                    ShortUnique id for inter-element referencing
                                                    Control0..1
                                                    This element is affected by the following invariants: ele-1
                                                    Typeid
                                                    Is Modifierfalse
                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                    Summaryfalse
                                                    82. ClaimResponse.patient.extension
                                                    Definition

                                                    An Extension

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

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

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

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

                                                      Control0..1
                                                      TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                      Is Modifierfalse
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                      86. ClaimResponse.patient.reference
                                                      Definition

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

                                                      ShortLiteral reference, Relative, internal or absolute URL
                                                      Comments

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

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

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

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

                                                      ShortType the reference refers to (e.g. "Patient") - must be a resource in resources
                                                      Comments

                                                      This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.

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

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

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

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

                                                      ShortLogical reference, when literal reference is not known
                                                      Comments

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

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

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

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

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

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

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

                                                      ShortText alternative for the resource
                                                      Comments

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

                                                      Control0..1
                                                      This element is affected by the following invariants: ref-2
                                                      Typestring
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      94. ClaimResponse.created
                                                      Definition

                                                      The date this resource was created.

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

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

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

                                                      The party responsible for authorization, adjudication and reimbursement.

                                                      ShortParty responsible for reimbursement
                                                      Control0..1
                                                      TypeReference(Organization)
                                                      Is Modifierfalse
                                                      Must Supportfalse
                                                      Summarytrue
                                                      Requirements

                                                      To be a valid claim, preauthorization or predetermination there must be a party who is responsible for adjudicating the contents against a policy which provides benefits for the patient.

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

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

                                                      ShortUnique id for inter-element referencing
                                                      Control0..1
                                                      This element is affected by the following invariants: ele-1
                                                      Typeid
                                                      Is Modifierfalse
                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                      Summaryfalse
                                                      100. ClaimResponse.insurer.extension
                                                      Definition

                                                      An Extension

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

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

                                                        ShortSTU3: Insurance issuing organization additional types
                                                        Comments

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

                                                        Control0..1
                                                        TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                        Is Modifierfalse
                                                        Summaryfalse
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                        104. ClaimResponse.insurer.reference
                                                        Definition

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

                                                        ShortLiteral reference, Relative, internal or absolute URL
                                                        Comments

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

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

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

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

                                                        ShortType the reference refers to (e.g. "Patient") - must be a resource in resources
                                                        Comments

                                                        This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.

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

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

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

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

                                                        ShortLogical reference, when literal reference is not known
                                                        Comments

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

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

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

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

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

                                                        NoteThis is a business identifier, not a resource identifier (see discussion)
                                                        Control0..1
                                                        This element is affected by the following invariants: ref-2
                                                        TypeIdentifier
                                                        Is Modifierfalse
                                                        Summarytrue
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        110. ClaimResponse.insurer.display
                                                        Definition

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

                                                        ShortText alternative for the resource
                                                        Comments

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

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

                                                        The provider which is responsible for the claim, predetermination or preauthorization.

                                                        ShortParty responsible for the claim
                                                        Comments

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

                                                        Control0..1
                                                        TypeReference(Practitioner, PractitionerRole, Organization)
                                                        Is Modifierfalse
                                                        Must Supportfalse
                                                        Summaryfalse
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        114. ClaimResponse.requestor.id
                                                        Definition

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

                                                        ShortUnique id for inter-element referencing
                                                        Control0..1
                                                        This element is affected by the following invariants: ele-1
                                                        Typeid
                                                        Is Modifierfalse
                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                        Summaryfalse
                                                        116. ClaimResponse.requestor.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 ClaimResponse.requestor.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                        • value @ url
                                                        • 118. ClaimResponse.requestor.extension:requestProvider
                                                          Slice NamerequestProvider
                                                          Definition

                                                          STU3: ClaimResponse.requestProvider additional types from child elements (display, identifier, reference)

                                                          ShortSTU3: Responsible practitioner additional types
                                                          Comments

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

                                                          Control0..1
                                                          TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                          Is Modifierfalse
                                                          Summaryfalse
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                          120. ClaimResponse.requestor.extension:requestOrganization
                                                          Slice NamerequestOrganization
                                                          Definition

                                                          STU3: ClaimResponse.requestOrganization additional types from child elements (display, identifier, reference)

                                                          ShortSTU3: Responsible organization additional types
                                                          Comments

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

                                                          Control0..1
                                                          TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                          Is Modifierfalse
                                                          Summaryfalse
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                          122. ClaimResponse.requestor.reference
                                                          Definition

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

                                                          ShortLiteral reference, Relative, internal or absolute URL
                                                          Comments

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

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

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

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

                                                          ShortType the reference refers to (e.g. "Patient") - must be a resource in resources
                                                          Comments

                                                          This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.

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

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

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

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

                                                          ShortLogical reference, when literal reference is not known
                                                          Comments

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

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

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

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

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

                                                          NoteThis is a business identifier, not a resource identifier (see discussion)
                                                          Control0..1
                                                          This element is affected by the following invariants: ref-2
                                                          TypeIdentifier
                                                          Is Modifierfalse
                                                          Summarytrue
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          128. ClaimResponse.requestor.display
                                                          Definition

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

                                                          ShortText alternative for the resource
                                                          Comments

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

                                                          Control0..1
                                                          This element is affected by the following invariants: ref-2
                                                          Typestring
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Summarytrue
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          130. ClaimResponse.request
                                                          Definition

                                                          Original request resource reference.

                                                          ShortId of resource triggering adjudication
                                                          Control0..1
                                                          TypeReference(Claim)
                                                          Is Modifierfalse
                                                          Must Supportfalse
                                                          Summarytrue
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          132. ClaimResponse.request.id
                                                          Definition

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

                                                          ShortUnique id for inter-element referencing
                                                          Control0..1
                                                          This element is affected by the following invariants: ele-1
                                                          Typeid
                                                          Is Modifierfalse
                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                          Summaryfalse
                                                          134. ClaimResponse.request.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 ClaimResponse.request.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                          • value @ url
                                                          • 136. ClaimResponse.request.extension:request
                                                            Slice Namerequest
                                                            Definition

                                                            STU3: ClaimResponse.request additional types from child elements (display, identifier, reference)

                                                            ShortSTU3: request additional types
                                                            Comments

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

                                                            Control0..1
                                                            TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                            Is Modifierfalse
                                                            Summaryfalse
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                            138. ClaimResponse.request.reference
                                                            Definition

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

                                                            ShortLiteral reference, Relative, internal or absolute URL
                                                            Comments

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

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

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

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

                                                            ShortType the reference refers to (e.g. "Patient") - must be a resource in resources
                                                            Comments

                                                            This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.

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

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

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

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

                                                            ShortLogical reference, when literal reference is not known
                                                            Comments

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

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

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

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

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

                                                            NoteThis is a business identifier, not a resource identifier (see discussion)
                                                            Control0..1
                                                            This element is affected by the following invariants: ref-2
                                                            TypeIdentifier
                                                            Is Modifierfalse
                                                            Summarytrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            144. ClaimResponse.request.display
                                                            Definition

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

                                                            ShortText alternative for the resource
                                                            Comments

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

                                                            Control0..1
                                                            This element is affected by the following invariants: ref-2
                                                            Typestring
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Summarytrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            146. ClaimResponse.outcome
                                                            Definition

                                                            The outcome of the claim, predetermination, or preauthorization processing.

                                                            Shortqueued | complete | error | partial
                                                            Comments

                                                            The resource may be used to indicate that the Claim/Preauthorization/Pre-determination has been received but processing has not begun (queued); that it has been processed and one or more errors have been detected (error); no errors were detected and some of the adjudication processing has been performed (partial); or all of the adjudication processing has completed without errors (complete).

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

                                                            The result of the claim processing.

                                                            Typecode
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Must Supportfalse
                                                            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()))
                                                            148. ClaimResponse.outcome.id
                                                            Definition

                                                            unique id for the element within a resource (for internal references)

                                                            Shortxml:id (or equivalent in JSON)
                                                            Control0..1
                                                            Typestring
                                                            Is Modifierfalse
                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                            Summaryfalse
                                                            150. ClaimResponse.outcome.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 ClaimResponse.outcome.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                            • value @ url
                                                            • 152. ClaimResponse.outcome.extension:outcome
                                                              Slice Nameoutcome
                                                              Definition

                                                              STU3: ClaimResponse.outcome additional types (CodeableConcept) additional types from child elements (coding)

                                                              ShortSTU3: complete | error | partial additional types
                                                              Comments

                                                              Element ClaimResponse.outcome is mapped to FHIR R5 element ClaimResponse.outcome as RelatedTo. The mappings for ClaimResponse.outcome do not cover the following types: CodeableConcept. The mappings for ClaimResponse.outcome do not cover the following types based on type expansion: coding.

                                                              Control0..1
                                                              TypeExtension(STU3: complete | error | partial additional types) (Extension Type: CodeableConcept)
                                                              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())
                                                              154. ClaimResponse.outcome.value
                                                              Definition

                                                              Primitive value for code

                                                              ShortPrimitive value for code
                                                              Control0..1
                                                              Typecode
                                                              Is Modifierfalse
                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                              Summaryfalse
                                                              156. ClaimResponse.decision
                                                              Definition

                                                              The result of the claim, predetermination, or preauthorization adjudication.

                                                              ShortResult of the adjudication
                                                              Comments

                                                              The element is used to indicate the current state of the adjudication overall for the claim resource, for example: the request has been held (pended) for adjudication processing, for manual review or other reasons; that it has been processed and will be paid, or the outstanding paid, as submitted (approved); that no amount will be paid (denied); or that some amount between zero and the submitted amount will be paid (partial).

                                                              Control0..1
                                                              BindingFor example codes, see ClaimAdjudicationDecisionsCodes
                                                              (example to http://hl7.org/fhir/ValueSet/claim-decision|5.0.0)

                                                              The overall result of the claim adjudication.

                                                              TypeCodeableConcept
                                                              Is Modifierfalse
                                                              Must Supportfalse
                                                              Summarytrue
                                                              Requirements

                                                              To advise the requestor of the result of the adjudication process.

                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              158. ClaimResponse.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 Supportfalse
                                                              Summaryfalse
                                                              Requirements

                                                              Provided for user display.

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

                                                              Reference from the Insurer which is used in later communications which refers to this adjudication.

                                                              ShortPreauthorization reference
                                                              Comments

                                                              This value is only present on preauthorization adjudications.

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

                                                              On subsequent claims, the insurer may require the provider to quote this value.

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

                                                              The time frame during which this authorization is effective.

                                                              ShortPreauthorization reference effective period
                                                              Control0..1
                                                              TypePeriod
                                                              Is Modifierfalse
                                                              Must Supportfalse
                                                              Summaryfalse
                                                              Requirements

                                                              To convey to the provider when the authorized products and services must be supplied for the authorized adjudication to apply.

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

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

                                                              ShortEvent information
                                                              Control0..*
                                                              TypeBackboneElement
                                                              Is Modifierfalse
                                                              Must Supportfalse
                                                              Summaryfalse
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              166. ClaimResponse.event.id
                                                              Definition

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

                                                              ShortUnique id for inter-element referencing
                                                              Control0..1
                                                              This element is affected by the following invariants: ele-1
                                                              Typestring
                                                              Is Modifierfalse
                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                              Summaryfalse
                                                              168. ClaimResponse.event.extension
                                                              Definition

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

                                                              ShortAdditional content defined by implementations
                                                              Comments

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

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

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

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

                                                              ShortExtensions that cannot be ignored even if unrecognized
                                                              Comments

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

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

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

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

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

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

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

                                                              ShortOccurance date or period
                                                              Control1..1
                                                              TypeChoice of: dateTime, Period
                                                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Must Supportfalse
                                                              Summaryfalse
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              176. ClaimResponse.payeeType
                                                              Definition

                                                              Type of Party to be reimbursed: subscriber, provider, other.

                                                              ShortParty to be paid any benefits payable
                                                              Control0..1
                                                              BindingFor example codes, see ClaimPayeeTypeCodes
                                                              (example to http://hl7.org/fhir/ValueSet/payeetype|5.0.0)

                                                              A code for the party to be reimbursed.

                                                              TypeCodeableConcept
                                                              Is Modifierfalse
                                                              Must Supportfalse
                                                              Summaryfalse
                                                              Requirements

                                                              Need to know who should receive payment with the most common situations being the Provider (assignment of benefits) or the Subscriber.

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

                                                              Healthcare encounters related to this claim.

                                                              ShortEncounters associated with the listed treatments
                                                              Comments

                                                              This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.

                                                              Control0..*
                                                              TypeReference(Encounter)
                                                              Is Modifierfalse
                                                              Must Supportfalse
                                                              Summaryfalse
                                                              Requirements

                                                              Used in some jurisdictions to link clinical events to claim items.

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

                                                              A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system.

                                                              ShortPackage billing code
                                                              Comments

                                                              For example DRG (Diagnosis Related Group) or a bundled billing code. A patient may have a diagnosis of a Myocardial Infarction and a DRG for HeartAttack would be assigned. The Claim item (and possible subsequent claims) would refer to the DRG for those line items that were for services related to the heart attack event.

                                                              Control0..1
                                                              BindingFor example codes, see ExampleDiagnosisRelatedGroupCodes
                                                              (example to http://hl7.org/fhir/ValueSet/ex-diagnosisrelatedgroup|5.0.0)
                                                              TypeCodeableConcept
                                                              Is Modifierfalse
                                                              Must Supportfalse
                                                              Summaryfalse
                                                              Requirements

                                                              Required to relate the current diagnosis to a package billing code that is then referenced on the individual claim items which are specific to the health condition covered by the package code.

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

                                                              A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.

                                                              ShortAdjudication for claim line items
                                                              Control0..*
                                                              TypeBackboneElement
                                                              Is Modifierfalse
                                                              Must Supportfalse
                                                              Summaryfalse
                                                              Requirements

                                                              The adjudication for items provided on the claim.

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

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

                                                              ShortUnique id for inter-element referencing
                                                              Control0..1
                                                              This element is affected by the following invariants: ele-1
                                                              Typestring
                                                              Is Modifierfalse
                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                              Summaryfalse
                                                              186. ClaimResponse.item.extension
                                                              Definition

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

                                                              ShortAdditional content defined by implementations
                                                              Comments

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

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

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

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

                                                              ShortExtensions that cannot be ignored even if unrecognized
                                                              Comments

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

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

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

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

                                                              A number to uniquely reference the claim item entries.

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

                                                              Necessary to provide a mechanism to link the adjudication result to the submitted claim item.

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

                                                              Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

                                                              ShortNumber for tracking
                                                              Control0..*
                                                              TypeIdentifier
                                                              Is Modifierfalse
                                                              Must Supportfalse
                                                              Summaryfalse
                                                              Requirements

                                                              Allows partners to uniquely identify components for tracking.

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

                                                              The numbers associated with notes below which apply to the adjudication of this item.

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

                                                              Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.

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

                                                              The high-level results of the adjudication if adjudication has been performed.

                                                              ShortAdjudication results
                                                              Control0..1
                                                              TypeBackboneElement
                                                              Is Modifierfalse
                                                              Must Supportfalse
                                                              Summaryfalse
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              198. ClaimResponse.item.reviewOutcome.id
                                                              Definition

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

                                                              ShortUnique id for inter-element referencing
                                                              Control0..1
                                                              This element is affected by the following invariants: ele-1
                                                              Typestring
                                                              Is Modifierfalse
                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                              Summaryfalse
                                                              200. ClaimResponse.item.reviewOutcome.extension
                                                              Definition

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

                                                              ShortAdditional content defined by implementations
                                                              Comments

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

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

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

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

                                                              ShortExtensions that cannot be ignored even if unrecognized
                                                              Comments

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

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

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

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

                                                              The result of the claim, predetermination, or preauthorization adjudication.

                                                              ShortResult of the adjudication
                                                              Comments

                                                              The element is used to indicate the current state of the adjudication overall for the claim resource, for example: the request has been held (pended) for adjudication processing, for manual review or other reasons; that it has been processed and will be paid, or the outstanding paid, as submitted (approved); that no amount will be paid (denied); or that some amount between zero and the submitted amount will be paid (partial).

                                                              Control0..1
                                                              BindingFor example codes, see ClaimAdjudicationDecisionsCodes
                                                              (example to http://hl7.org/fhir/ValueSet/claim-decision|5.0.0)
                                                              TypeCodeableConcept
                                                              Is Modifierfalse
                                                              Must Supportfalse
                                                              Summaryfalse
                                                              Requirements

                                                              To advise the requestor of the result of the adjudication process.

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

                                                              The reasons for the result of the claim, predetermination, or preauthorization adjudication.

                                                              ShortReason for result of the adjudication
                                                              Control0..*
                                                              BindingFor example codes, see ClaimAdjudicationDecisionReasonCodes
                                                              (example to http://hl7.org/fhir/ValueSet/claim-decision-reason|5.0.0)
                                                              TypeCodeableConcept
                                                              Is Modifierfalse
                                                              Must Supportfalse
                                                              Summaryfalse
                                                              Requirements

                                                              To advise the requestor of the contributors to the result of the adjudication process.

                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              208. ClaimResponse.item.reviewOutcome.preAuthRef
                                                              Definition

                                                              Reference from the Insurer which is used in later communications which refers to this adjudication.

                                                              ShortPreauthorization reference
                                                              Comments

                                                              This value is only present on preauthorization adjudications.

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

                                                              On subsequent claims, the insurer may require the provider to quote this value.

                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              210. ClaimResponse.item.reviewOutcome.preAuthPeriod
                                                              Definition

                                                              The time frame during which this authorization is effective.

                                                              ShortPreauthorization reference effective period
                                                              Control0..1
                                                              TypePeriod
                                                              Is Modifierfalse
                                                              Must Supportfalse
                                                              Summaryfalse
                                                              Requirements

                                                              To convey to the provider when the authorized products and services must be supplied for the authorized adjudication to apply.

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

                                                              If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.

                                                              ShortAdjudication details
                                                              Control0..*
                                                              TypeBackboneElement
                                                              Is Modifierfalse
                                                              Must Supportfalse
                                                              Summaryfalse
                                                              Requirements

                                                              The adjudication results conveys the insurer's assessment of the item provided in the claim under the terms of the patient's insurance coverage.

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

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

                                                              ShortUnique id for inter-element referencing
                                                              Control0..1
                                                              This element is affected by the following invariants: ele-1
                                                              Typestring
                                                              Is Modifierfalse
                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                              Summaryfalse
                                                              216. ClaimResponse.item.adjudication.extension
                                                              Definition

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

                                                              ShortAdditional content defined by implementations
                                                              Comments

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

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

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

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

                                                              ShortExtensions that cannot be ignored even if unrecognized
                                                              Comments

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

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

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

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

                                                              A code to indicate the information type of this adjudication record. Information types may include the value submitted, maximum values or percentages allowed or payable under the plan, amounts that: the patient is responsible for in aggregate or pertaining to this item; amounts paid by other coverages; and, the benefit payable for this item.

                                                              ShortType of adjudication information
                                                              Comments

                                                              For example codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

                                                              Control1..1
                                                              BindingFor example codes, see AdjudicationValueCodes .
                                                              (example to http://hl7.org/fhir/ValueSet/adjudication|5.0.0)

                                                              The adjudication codes.

                                                              TypeCodeableConcept
                                                              Is Modifierfalse
                                                              Must Supportfalse
                                                              Summaryfalse
                                                              Requirements

                                                              Needed to enable understanding of the context of the other information in the adjudication.

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

                                                              A code supporting the understanding of the adjudication result and explaining variance from expected amount.

                                                              ShortExplanation of adjudication outcome
                                                              Comments

                                                              For example may indicate that the funds for this benefit type have been exhausted.

                                                              Control0..1
                                                              BindingFor example codes, see AdjudicationReasonCodes
                                                              (example to http://hl7.org/fhir/ValueSet/adjudication-reason|5.0.0)

                                                              The adjudication reason codes.

                                                              TypeCodeableConcept
                                                              Is Modifierfalse
                                                              Must Supportfalse
                                                              Summaryfalse
                                                              Requirements

                                                              To support understanding of variance from adjudication expectations.

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

                                                              Monetary amount associated with the category.

                                                              ShortMonetary amount
                                                              Comments

                                                              For example: amount submitted, eligible amount, co-payment, and benefit payable.

                                                              Control0..1
                                                              TypeMoney
                                                              Is Modifierfalse
                                                              Must Supportfalse
                                                              Summaryfalse
                                                              Requirements

                                                              Most adjudication categories convey a monetary amount.

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

                                                              A non-monetary value associated with the category. Mutually exclusive to the amount element above.

                                                              ShortNon-monetary value
                                                              Comments

                                                              For example: eligible percentage or co-payment percentage.

                                                              Control0..1
                                                              TypeQuantity
                                                              Is Modifierfalse
                                                              Must Supportfalse
                                                              Summaryfalse
                                                              Requirements

                                                              Some adjudication categories convey a percentage or a fixed value.

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

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

                                                              ShortUnique id for inter-element referencing
                                                              Control0..1
                                                              This element is affected by the following invariants: ele-1
                                                              Typeid
                                                              Is Modifierfalse
                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                              Summaryfalse
                                                              230. ClaimResponse.item.adjudication.quantity.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 ClaimResponse.item.adjudication.quantity.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                              • value @ url
                                                              • 232. ClaimResponse.item.adjudication.quantity.extension:value
                                                                Slice Namevalue
                                                                Definition

                                                                STU3: ClaimResponse.item.adjudication.value additional types (decimal) additional types from child elements (value)

                                                                ShortSTU3: value additional types
                                                                Comments

                                                                Element ClaimResponse.item.adjudication.value is mapped to FHIR R5 element ClaimResponse.item.adjudication.quantity as SourceIsBroaderThanTarget. The mappings for ClaimResponse.item.adjudication.value do not cover the following types: decimal. The mappings for ClaimResponse.item.adjudication.value do not cover the following types based on type expansion: value.

                                                                Control0..1
                                                                TypeExtension(STU3: value additional types) (Extension Type: decimal)
                                                                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())
                                                                234. ClaimResponse.item.adjudication.quantity.value
                                                                Definition

                                                                The value of the measured amount. The value includes an implicit precision in the presentation of the value.

                                                                ShortNumerical value (with implicit precision)
                                                                Comments

                                                                The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

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

                                                                Precision is handled implicitly in almost all cases of measurement.

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

                                                                How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

                                                                Short< | <= | >= | > | ad - how to understand the value
                                                                Control0..1
                                                                BindingThe codes SHALL be taken from QuantityComparator
                                                                (required to http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0)

                                                                How the Quantity should be understood and represented.

                                                                Typecode
                                                                Is Modifiertrue because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Summarytrue
                                                                Requirements

                                                                Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

                                                                Meaning if MissingIf there is no comparator, then there is no modification of the value
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                238. ClaimResponse.item.adjudication.quantity.unit
                                                                Definition

                                                                A human-readable form of the unit.

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

                                                                There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

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

                                                                The identification of the system that provides the coded form of the unit.

                                                                ShortSystem that defines coded unit form
                                                                Control0..1
                                                                This element is affected by the following invariants: qty-3
                                                                Typeuri
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Summarytrue
                                                                Requirements

                                                                Need to know the system that defines the coded form of the unit.

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

                                                                A computer processable form of the unit in some unit representation system.

                                                                ShortCoded form of the unit
                                                                Comments

                                                                The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

                                                                Control0..1
                                                                This element is affected by the following invariants: qty-3
                                                                Typecode
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Summarytrue
                                                                Requirements

                                                                Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

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

                                                                A claim detail. Either a simple (a product or service) or a 'group' of sub-details which are simple items.

                                                                ShortAdjudication for claim details
                                                                Control0..*
                                                                TypeBackboneElement
                                                                Is Modifierfalse
                                                                Must Supportfalse
                                                                Summaryfalse
                                                                Requirements

                                                                The adjudication for details provided on the claim.

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

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

                                                                ShortUnique id for inter-element referencing
                                                                Control0..1
                                                                This element is affected by the following invariants: ele-1
                                                                Typestring
                                                                Is Modifierfalse
                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                Summaryfalse
                                                                248. ClaimResponse.item.detail.extension
                                                                Definition

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

                                                                ShortAdditional content defined by implementations
                                                                Comments

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

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

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

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

                                                                ShortExtensions that cannot be ignored even if unrecognized
                                                                Comments

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

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

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

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

                                                                A number to uniquely reference the claim detail entry.

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

                                                                Necessary to provide a mechanism to link the adjudication result to the submitted claim detail.

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

                                                                Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

                                                                ShortNumber for tracking
                                                                Control0..*
                                                                TypeIdentifier
                                                                Is Modifierfalse
                                                                Must Supportfalse
                                                                Summaryfalse
                                                                Requirements

                                                                Allows partners to uniquely identify components for tracking.

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

                                                                The numbers associated with notes below which apply to the adjudication of this item.

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

                                                                Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.

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

                                                                The high-level results of the adjudication if adjudication has been performed.

                                                                ShortDetail level adjudication results
                                                                Control0..1
                                                                TypeSeettp://hl7.org/fhir/StructureDefinition/ClaimResponse#ClaimResponse.item.reviewOutcome
                                                                Is Modifierfalse
                                                                Must Supportfalse
                                                                Summaryfalse
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                260. ClaimResponse.item.detail.adjudication
                                                                Definition

                                                                The adjudication results.

                                                                ShortDetail level adjudication details
                                                                Control0..*
                                                                TypeSeettp://hl7.org/fhir/StructureDefinition/ClaimResponse#ClaimResponse.item.adjudication
                                                                Is Modifierfalse
                                                                Must Supportfalse
                                                                Summaryfalse
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                262. ClaimResponse.item.detail.subDetail
                                                                Definition

                                                                A sub-detail adjudication of a simple product or service.

                                                                ShortAdjudication for claim sub-details
                                                                Control0..*
                                                                TypeBackboneElement
                                                                Is Modifierfalse
                                                                Must Supportfalse
                                                                Summaryfalse
                                                                Requirements

                                                                The adjudication for sub-details provided on the claim.

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

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

                                                                ShortUnique id for inter-element referencing
                                                                Control0..1
                                                                This element is affected by the following invariants: ele-1
                                                                Typestring
                                                                Is Modifierfalse
                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                Summaryfalse
                                                                266. ClaimResponse.item.detail.subDetail.extension
                                                                Definition

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

                                                                ShortAdditional content defined by implementations
                                                                Comments

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

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

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

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

                                                                ShortExtensions that cannot be ignored even if unrecognized
                                                                Comments

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

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

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

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

                                                                A number to uniquely reference the claim sub-detail entry.

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

                                                                Necessary to provide a mechanism to link the adjudication result to the submitted claim sub-detail.

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

                                                                Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

                                                                ShortNumber for tracking
                                                                Control0..*
                                                                TypeIdentifier
                                                                Is Modifierfalse
                                                                Must Supportfalse
                                                                Summaryfalse
                                                                Requirements

                                                                Allows partners to uniquely identify components for tracking.

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

                                                                The numbers associated with notes below which apply to the adjudication of this item.

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

                                                                Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.

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

                                                                The high-level results of the adjudication if adjudication has been performed.

                                                                ShortSubdetail level adjudication results
                                                                Control0..1
                                                                TypeSeettp://hl7.org/fhir/StructureDefinition/ClaimResponse#ClaimResponse.item.reviewOutcome
                                                                Is Modifierfalse
                                                                Must Supportfalse
                                                                Summaryfalse
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                278. ClaimResponse.item.detail.subDetail.adjudication
                                                                Definition

                                                                The adjudication results.

                                                                ShortSubdetail level adjudication details
                                                                Control0..*
                                                                TypeSeettp://hl7.org/fhir/StructureDefinition/ClaimResponse#ClaimResponse.item.adjudication
                                                                Is Modifierfalse
                                                                Must Supportfalse
                                                                Summaryfalse
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                280. ClaimResponse.addItem
                                                                Definition

                                                                The first-tier service adjudications for payor added product or service lines.

                                                                ShortInsurer added line items
                                                                Control0..*
                                                                TypeBackboneElement
                                                                Is Modifierfalse
                                                                Must Supportfalse
                                                                Summaryfalse
                                                                Requirements

                                                                Insurers may redefine the provided product or service or may package and/or decompose groups of products and services. The addItems allows the insurer to provide their line item list with linkage to the submitted items/details/sub-details. In a preauthorization the insurer may use the addItem structure to provide additional information on authorized products and services.

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

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

                                                                ShortUnique id for inter-element referencing
                                                                Control0..1
                                                                This element is affected by the following invariants: ele-1
                                                                Typestring
                                                                Is Modifierfalse
                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                Summaryfalse
                                                                284. ClaimResponse.addItem.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 ClaimResponse.addItem.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                • value @ url
                                                                • 286. ClaimResponse.addItem.extension:revenue
                                                                  Slice Namerevenue
                                                                  Definition

                                                                  STU3: ClaimResponse.addItem.revenue (new:CodeableConcept)

                                                                  ShortSTU3: Revenue or cost center code (new)
                                                                  Comments

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

                                                                  Control0..1
                                                                  TypeExtension(STU3: Revenue or cost center code (new)) (Extension Type: CodeableConcept)
                                                                  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())
                                                                  288. ClaimResponse.addItem.extension:category
                                                                  Slice Namecategory
                                                                  Definition

                                                                  STU3: ClaimResponse.addItem.category (new:CodeableConcept)

                                                                  ShortSTU3: Type of service or product (new)
                                                                  Comments

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

                                                                  Control0..1
                                                                  TypeExtension(STU3: Type of service or product (new)) (Extension Type: CodeableConcept)
                                                                  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())
                                                                  290. ClaimResponse.addItem.extension:fee
                                                                  Slice Namefee
                                                                  Definition

                                                                  STU3: ClaimResponse.addItem.fee (new:Money)

                                                                  ShortSTU3: Professional fee or Product charge (new)
                                                                  Comments

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

                                                                  Control0..1
                                                                  TypeExtension(STU3: Professional fee or Product charge (new)) (Extension Type: Money)
                                                                  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())
                                                                  292. ClaimResponse.addItem.modifierExtension
                                                                  Definition

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

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

                                                                  ShortExtensions that cannot be ignored even if unrecognized
                                                                  Comments

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

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

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

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

                                                                  Claim items which this service line is intended to replace.

                                                                  ShortItem sequence number
                                                                  Control0..*
                                                                  TypepositiveInt
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Must Supportfalse
                                                                  Summaryfalse
                                                                  Requirements

                                                                  Provides references to the claim items.

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

                                                                  The sequence number of the details within the claim item which this line is intended to replace.

                                                                  ShortDetail sequence number
                                                                  Control0..*
                                                                  TypepositiveInt
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Must Supportfalse
                                                                  Summaryfalse
                                                                  Requirements

                                                                  Provides references to the claim details within the claim item.

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

                                                                  The sequence number of the sub-details within the details within the claim item which this line is intended to replace.

                                                                  ShortSubdetail sequence number
                                                                  Control0..*
                                                                  TypepositiveInt
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Must Supportfalse
                                                                  Summaryfalse
                                                                  Requirements

                                                                  Provides references to the claim sub-details within the claim detail.

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

                                                                  Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

                                                                  ShortNumber for tracking
                                                                  Control0..*
                                                                  TypeIdentifier
                                                                  Is Modifierfalse
                                                                  Must Supportfalse
                                                                  Summaryfalse
                                                                  Requirements

                                                                  Allows partners to uniquely identify components for tracking.

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

                                                                  The providers who are authorized for the services rendered to the patient.

                                                                  ShortAuthorized providers
                                                                  Control0..*
                                                                  TypeReference(Practitioner, PractitionerRole, Organization)
                                                                  Is Modifierfalse
                                                                  Must Supportfalse
                                                                  Summaryfalse
                                                                  Requirements

                                                                  Insurer may provide authorization specifically to a restricted set of providers rather than an open authorization.

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

                                                                  The type of revenue or cost center providing the product and/or service.

                                                                  ShortRevenue or cost center code
                                                                  Control0..1
                                                                  BindingFor example codes, see ExampleRevenueCenterCodes
                                                                  (example to http://hl7.org/fhir/ValueSet/ex-revenue-center|5.0.0)

                                                                  Codes for the revenue or cost centers supplying the service and/or products.

                                                                  TypeCodeableConcept
                                                                  Is Modifierfalse
                                                                  Must Supportfalse
                                                                  Summaryfalse
                                                                  Requirements

                                                                  Needed in the processing of institutional claims.

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

                                                                  When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.

                                                                  ShortBilling, service, product, or drug code
                                                                  Comments

                                                                  If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.

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

                                                                  Allowable service and product codes.

                                                                  TypeCodeableConcept
                                                                  Is Modifierfalse
                                                                  Must Supportfalse
                                                                  Summaryfalse
                                                                  Requirements

                                                                  Necessary to state what was provided or done.

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

                                                                  This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.

                                                                  ShortEnd of a range of codes
                                                                  Control0..1
                                                                  BindingFor example codes, see USCLSCodes
                                                                  (example to http://hl7.org/fhir/ValueSet/service-uscls|5.0.0)
                                                                  TypeCodeableConcept
                                                                  Is Modifierfalse
                                                                  Must Supportfalse
                                                                  Summaryfalse
                                                                  Alternate NamesEnd of a range of Drug Code; Bill Code; Service Cod
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  310. ClaimResponse.addItem.request
                                                                  Definition

                                                                  Request or Referral for Goods or Service to be rendered.

                                                                  ShortRequest or Referral for Service
                                                                  Control0..*
                                                                  TypeReference(DeviceRequest, MedicationRequest, NutritionOrder, ServiceRequest, SupplyRequest, VisionPrescription)
                                                                  Is Modifierfalse
                                                                  Must Supportfalse
                                                                  Summaryfalse
                                                                  Requirements

                                                                  May identify the service to be provided or provider authorization for the service.

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

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

                                                                  ShortService/Product 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 outside of office hours.

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

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

                                                                  TypeCodeableConcept
                                                                  Is Modifierfalse
                                                                  Must Supportfalse
                                                                  Summaryfalse
                                                                  Requirements

                                                                  To support inclusion of the item for adjudication or to charge an elevated fee.

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

                                                                  Identifies the program under which this may be recovered.

                                                                  ShortProgram the product or service is provided under
                                                                  Comments

                                                                  For example: Neonatal program, child dental program or drug users recovery program.

                                                                  Control0..*
                                                                  BindingFor example codes, see ExampleProgramReasonCodes
                                                                  (example to http://hl7.org/fhir/ValueSet/ex-program-code|5.0.0)

                                                                  Program specific reason codes.

                                                                  TypeCodeableConcept
                                                                  Is Modifierfalse
                                                                  Must Supportfalse
                                                                  Summaryfalse
                                                                  Requirements

                                                                  Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  316. ClaimResponse.addItem.serviced[x]
                                                                  Definition

                                                                  The date or dates when the service or product was supplied, performed or completed.

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

                                                                  Needed to determine whether the service or product was provided during the term of the insurance coverage.

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  318. ClaimResponse.addItem.location[x]
                                                                  Definition

                                                                  Where the product or service was provided.

                                                                  ShortPlace of service or where product was supplied
                                                                  Control0..1
                                                                  BindingFor example codes, see ExampleServicePlaceCodes
                                                                  (example to http://hl7.org/fhir/ValueSet/service-place|5.0.0)

                                                                  Place of service: pharmacy, school, prison, etc.

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

                                                                  The location can alter whether the item was acceptable for insurance purposes or impact the determination of the benefit amount.

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

                                                                  The number of repetitions of a service or product.

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

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

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

                                                                  If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

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

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

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

                                                                  A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

                                                                  ShortPrice scaling factor
                                                                  Comments

                                                                  To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).

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

                                                                  When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.

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

                                                                  The total of taxes applicable for this product or service.

                                                                  ShortTotal tax
                                                                  Control0..1
                                                                  TypeMoney
                                                                  Is Modifierfalse
                                                                  Must Supportfalse
                                                                  Summaryfalse
                                                                  Requirements

                                                                  Required when taxes are not embedded in the unit price or provided as a separate service.

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

                                                                  The total amount claimed for the group (if a grouper) or the addItem. Net = unit price * quantity * factor.

                                                                  ShortTotal item cost
                                                                  Comments

                                                                  For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.

                                                                  Control0..1
                                                                  TypeMoney
                                                                  Is Modifierfalse
                                                                  Must Supportfalse
                                                                  Summaryfalse
                                                                  Requirements

                                                                  Provides the total amount claimed for the group (if a grouper) or the line item.

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

                                                                  Physical location where the service is performed or applies.

                                                                  ShortAnatomical location
                                                                  Control0..*
                                                                  TypeBackboneElement
                                                                  Is Modifierfalse
                                                                  Must Supportfalse
                                                                  Summaryfalse
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  332. ClaimResponse.addItem.bodySite.id
                                                                  Definition

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

                                                                  ShortUnique id for inter-element referencing
                                                                  Control0..1
                                                                  This element is affected by the following invariants: ele-1
                                                                  Typestring
                                                                  Is Modifierfalse
                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                  Summaryfalse
                                                                  334. ClaimResponse.addItem.bodySite.extension
                                                                  Definition

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

                                                                  ShortAdditional content defined by implementations
                                                                  Comments

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

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

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

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

                                                                  ShortExtensions that cannot be ignored even if unrecognized
                                                                  Comments

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

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

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

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

                                                                  Physical service site on the patient (limb, tooth, etc.).

                                                                  ShortLocation
                                                                  Comments

                                                                  For example: Providing a tooth code allows an insurer to identify a provider performing a filling on a tooth that was previously removed.

                                                                  Control1..*
                                                                  BindingFor example codes, see OralSiteCodes
                                                                  (example to http://hl7.org/fhir/ValueSet/tooth|5.0.0)
                                                                  TypeCodeableReference(BodyStructure)
                                                                  Is Modifierfalse
                                                                  Must Supportfalse
                                                                  Summaryfalse
                                                                  Requirements

                                                                  Allows insurer to validate specific procedures.

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  340. ClaimResponse.addItem.bodySite.subSite
                                                                  Definition

                                                                  A region or surface of the bodySite, e.g. limb region or tooth surface(s).

                                                                  ShortSub-location
                                                                  Control0..*
                                                                  BindingFor example codes, see SurfaceCodes
                                                                  (example to http://hl7.org/fhir/ValueSet/surface|5.0.0)
                                                                  TypeCodeableConcept
                                                                  Is Modifierfalse
                                                                  Must Supportfalse
                                                                  Summaryfalse
                                                                  Requirements

                                                                  Allows insurer to validate specific procedures.

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

                                                                  The numbers associated with notes below which apply to the adjudication of this item.

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

                                                                  Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.

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

                                                                  The high-level results of the adjudication if adjudication has been performed.

                                                                  ShortAdded items adjudication results
                                                                  Control0..1
                                                                  TypeSeettp://hl7.org/fhir/StructureDefinition/ClaimResponse#ClaimResponse.item.reviewOutcome
                                                                  Is Modifierfalse
                                                                  Must Supportfalse
                                                                  Summaryfalse
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  346. ClaimResponse.addItem.adjudication
                                                                  Definition

                                                                  The adjudication results.

                                                                  ShortAdded items adjudication
                                                                  Control0..*
                                                                  TypeSeettp://hl7.org/fhir/StructureDefinition/ClaimResponse#ClaimResponse.item.adjudication
                                                                  Is Modifierfalse
                                                                  Must Supportfalse
                                                                  Summaryfalse
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  348. ClaimResponse.addItem.detail
                                                                  Definition

                                                                  The second-tier service adjudications for payor added services.

                                                                  ShortInsurer added line details
                                                                  Control0..*
                                                                  TypeBackboneElement
                                                                  Is Modifierfalse
                                                                  Must Supportfalse
                                                                  Summaryfalse
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  350. ClaimResponse.addItem.detail.id
                                                                  Definition

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

                                                                  ShortUnique id for inter-element referencing
                                                                  Control0..1
                                                                  This element is affected by the following invariants: ele-1
                                                                  Typestring
                                                                  Is Modifierfalse
                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                  Summaryfalse
                                                                  352. ClaimResponse.addItem.detail.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 ClaimResponse.addItem.detail.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                  • value @ url
                                                                  • 354. ClaimResponse.addItem.detail.extension:revenue
                                                                    Slice Namerevenue
                                                                    Definition

                                                                    STU3: ClaimResponse.addItem.detail.revenue (new:CodeableConcept)

                                                                    ShortSTU3: Revenue or cost center code (new)
                                                                    Comments

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

                                                                    Control0..1
                                                                    TypeExtension(STU3: Revenue or cost center code (new)) (Extension Type: CodeableConcept)
                                                                    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())
                                                                    356. ClaimResponse.addItem.detail.extension:category
                                                                    Slice Namecategory
                                                                    Definition

                                                                    STU3: ClaimResponse.addItem.detail.category (new:CodeableConcept)

                                                                    ShortSTU3: Type of service or product (new)
                                                                    Comments

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

                                                                    Control0..1
                                                                    TypeExtension(STU3: Type of service or product (new)) (Extension Type: CodeableConcept)
                                                                    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())
                                                                    358. ClaimResponse.addItem.detail.extension:fee
                                                                    Slice Namefee
                                                                    Definition

                                                                    STU3: ClaimResponse.addItem.detail.fee (new:Money)

                                                                    ShortSTU3: Professional fee or Product charge (new)
                                                                    Comments

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

                                                                    Control0..1
                                                                    TypeExtension(STU3: Professional fee or Product charge (new)) (Extension Type: Money)
                                                                    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())
                                                                    360. ClaimResponse.addItem.detail.modifierExtension
                                                                    Definition

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

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

                                                                    ShortExtensions that cannot be ignored even if unrecognized
                                                                    Comments

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

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

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

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

                                                                    Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

                                                                    ShortNumber for tracking
                                                                    Control0..*
                                                                    TypeIdentifier
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summaryfalse
                                                                    Requirements

                                                                    Allows partners to uniquely identify components for tracking.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    364. ClaimResponse.addItem.detail.revenue
                                                                    Definition

                                                                    The type of revenue or cost center providing the product and/or service.

                                                                    ShortRevenue or cost center code
                                                                    Control0..1
                                                                    BindingFor example codes, see ExampleRevenueCenterCodes
                                                                    (example to http://hl7.org/fhir/ValueSet/ex-revenue-center|5.0.0)

                                                                    Codes for the revenue or cost centers supplying the service and/or products.

                                                                    TypeCodeableConcept
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summaryfalse
                                                                    Requirements

                                                                    Needed in the processing of institutional claims.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    366. ClaimResponse.addItem.detail.productOrService
                                                                    Definition

                                                                    When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.

                                                                    ShortBilling, service, product, or drug code
                                                                    Comments

                                                                    If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.

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

                                                                    Allowable service and product codes.

                                                                    TypeCodeableConcept
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summaryfalse
                                                                    Requirements

                                                                    Necessary to state what was provided or done.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    368. ClaimResponse.addItem.detail.productOrServiceEnd
                                                                    Definition

                                                                    This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.

                                                                    ShortEnd of a range of codes
                                                                    Control0..1
                                                                    BindingFor example codes, see USCLSCodes
                                                                    (example to http://hl7.org/fhir/ValueSet/service-uscls|5.0.0)
                                                                    TypeCodeableConcept
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summaryfalse
                                                                    Alternate NamesEnd of a range of Drug Code; Bill Code; Service Cod
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    370. ClaimResponse.addItem.detail.modifier
                                                                    Definition

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

                                                                    ShortService/Product 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 outside of office hours.

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

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

                                                                    TypeCodeableConcept
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summaryfalse
                                                                    Requirements

                                                                    To support inclusion of the item for adjudication or to charge an elevated fee.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    372. ClaimResponse.addItem.detail.quantity
                                                                    Definition

                                                                    The number of repetitions of a service or product.

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

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

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    374. ClaimResponse.addItem.detail.unitPrice
                                                                    Definition

                                                                    If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

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

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

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    376. ClaimResponse.addItem.detail.factor
                                                                    Definition

                                                                    A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

                                                                    ShortPrice scaling factor
                                                                    Comments

                                                                    To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).

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

                                                                    When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    378. ClaimResponse.addItem.detail.tax
                                                                    Definition

                                                                    The total of taxes applicable for this product or service.

                                                                    ShortTotal tax
                                                                    Control0..1
                                                                    TypeMoney
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summaryfalse
                                                                    Requirements

                                                                    Required when taxes are not embedded in the unit price or provided as a separate service.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    380. ClaimResponse.addItem.detail.net
                                                                    Definition

                                                                    The total amount claimed for the group (if a grouper) or the addItem.detail. Net = unit price * quantity * factor.

                                                                    ShortTotal item cost
                                                                    Comments

                                                                    For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.

                                                                    Control0..1
                                                                    TypeMoney
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summaryfalse
                                                                    Requirements

                                                                    Provides the total amount claimed for the group (if a grouper) or the line item.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    382. ClaimResponse.addItem.detail.noteNumber
                                                                    Definition

                                                                    The numbers associated with notes below which apply to the adjudication of this item.

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

                                                                    Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    384. ClaimResponse.addItem.detail.reviewOutcome
                                                                    Definition

                                                                    The high-level results of the adjudication if adjudication has been performed.

                                                                    ShortAdded items detail level adjudication results
                                                                    Control0..1
                                                                    TypeSeettp://hl7.org/fhir/StructureDefinition/ClaimResponse#ClaimResponse.item.reviewOutcome
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summaryfalse
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    386. ClaimResponse.addItem.detail.adjudication
                                                                    Definition

                                                                    The adjudication results.

                                                                    ShortAdded items detail adjudication
                                                                    Control0..*
                                                                    TypeSeettp://hl7.org/fhir/StructureDefinition/ClaimResponse#ClaimResponse.item.adjudication
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summaryfalse
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    388. ClaimResponse.addItem.detail.subDetail
                                                                    Definition

                                                                    The third-tier service adjudications for payor added services.

                                                                    ShortInsurer added line items
                                                                    Control0..*
                                                                    TypeBackboneElement
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summaryfalse
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    390. ClaimResponse.addItem.detail.subDetail.id
                                                                    Definition

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

                                                                    ShortUnique id for inter-element referencing
                                                                    Control0..1
                                                                    This element is affected by the following invariants: ele-1
                                                                    Typestring
                                                                    Is Modifierfalse
                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                    Summaryfalse
                                                                    392. ClaimResponse.addItem.detail.subDetail.extension
                                                                    Definition

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

                                                                    ShortAdditional content defined by implementations
                                                                    Comments

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

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

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

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

                                                                    ShortExtensions that cannot be ignored even if unrecognized
                                                                    Comments

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

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

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

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

                                                                    Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

                                                                    ShortNumber for tracking
                                                                    Control0..*
                                                                    TypeIdentifier
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summaryfalse
                                                                    Requirements

                                                                    Allows partners to uniquely identify components for tracking.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    398. ClaimResponse.addItem.detail.subDetail.revenue
                                                                    Definition

                                                                    The type of revenue or cost center providing the product and/or service.

                                                                    ShortRevenue or cost center code
                                                                    Control0..1
                                                                    BindingFor example codes, see ExampleRevenueCenterCodes
                                                                    (example to http://hl7.org/fhir/ValueSet/ex-revenue-center|5.0.0)

                                                                    Codes for the revenue or cost centers supplying the service and/or products.

                                                                    TypeCodeableConcept
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summaryfalse
                                                                    Requirements

                                                                    Needed in the processing of institutional claims.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    400. ClaimResponse.addItem.detail.subDetail.productOrService
                                                                    Definition

                                                                    When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.

                                                                    ShortBilling, service, product, or drug code
                                                                    Comments

                                                                    If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.

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

                                                                    Allowable service and product codes.

                                                                    TypeCodeableConcept
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summaryfalse
                                                                    Requirements

                                                                    Necessary to state what was provided or done.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    402. ClaimResponse.addItem.detail.subDetail.productOrServiceEnd
                                                                    Definition

                                                                    This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.

                                                                    ShortEnd of a range of codes
                                                                    Control0..1
                                                                    BindingFor example codes, see USCLSCodes
                                                                    (example to http://hl7.org/fhir/ValueSet/service-uscls|5.0.0)
                                                                    TypeCodeableConcept
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summaryfalse
                                                                    Alternate NamesEnd of a range of Drug Code; Bill Code; Service Cod
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    404. ClaimResponse.addItem.detail.subDetail.modifier
                                                                    Definition

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

                                                                    ShortService/Product 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 outside of office hours.

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

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

                                                                    TypeCodeableConcept
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summaryfalse
                                                                    Requirements

                                                                    To support inclusion of the item for adjudication or to charge an elevated fee.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    406. ClaimResponse.addItem.detail.subDetail.quantity
                                                                    Definition

                                                                    The number of repetitions of a service or product.

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

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

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    408. ClaimResponse.addItem.detail.subDetail.unitPrice
                                                                    Definition

                                                                    If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

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

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

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    410. ClaimResponse.addItem.detail.subDetail.factor
                                                                    Definition

                                                                    A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

                                                                    ShortPrice scaling factor
                                                                    Comments

                                                                    To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).

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

                                                                    When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    412. ClaimResponse.addItem.detail.subDetail.tax
                                                                    Definition

                                                                    The total of taxes applicable for this product or service.

                                                                    ShortTotal tax
                                                                    Control0..1
                                                                    TypeMoney
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summaryfalse
                                                                    Requirements

                                                                    Required when taxes are not embedded in the unit price or provided as a separate service.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    414. ClaimResponse.addItem.detail.subDetail.net
                                                                    Definition

                                                                    The total amount claimed for the addItem.detail.subDetail. Net = unit price * quantity * factor.

                                                                    ShortTotal item cost
                                                                    Comments

                                                                    For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.

                                                                    Control0..1
                                                                    TypeMoney
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summaryfalse
                                                                    Requirements

                                                                    Provides the total amount claimed for the group (if a grouper) or the line item.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    416. ClaimResponse.addItem.detail.subDetail.noteNumber
                                                                    Definition

                                                                    The numbers associated with notes below which apply to the adjudication of this item.

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

                                                                    Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    418. ClaimResponse.addItem.detail.subDetail.reviewOutcome
                                                                    Definition

                                                                    The high-level results of the adjudication if adjudication has been performed.

                                                                    ShortAdded items subdetail level adjudication results
                                                                    Control0..1
                                                                    TypeSeettp://hl7.org/fhir/StructureDefinition/ClaimResponse#ClaimResponse.item.reviewOutcome
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summaryfalse
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    420. ClaimResponse.addItem.detail.subDetail.adjudication
                                                                    Definition

                                                                    The adjudication results.

                                                                    ShortAdded items subdetail adjudication
                                                                    Control0..*
                                                                    TypeSeettp://hl7.org/fhir/StructureDefinition/ClaimResponse#ClaimResponse.item.adjudication
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summaryfalse
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    422. ClaimResponse.adjudication
                                                                    Definition

                                                                    The adjudication results which are presented at the header level rather than at the line-item or add-item levels.

                                                                    ShortHeader-level adjudication
                                                                    Control0..*
                                                                    TypeSeettp://hl7.org/fhir/StructureDefinition/ClaimResponse#ClaimResponse.item.adjudication
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summaryfalse
                                                                    Requirements

                                                                    Some insurers will receive line-items but provide the adjudication only at a summary or header-level.

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

                                                                    Categorized monetary totals for the adjudication.

                                                                    ShortAdjudication totals
                                                                    Comments

                                                                    Totals for amounts submitted, co-pays, benefits payable etc.

                                                                    Control0..*
                                                                    TypeBackboneElement
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summarytrue
                                                                    Requirements

                                                                    To provide the requestor with financial totals by category for the adjudication.

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

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

                                                                    ShortUnique id for inter-element referencing
                                                                    Control0..1
                                                                    This element is affected by the following invariants: ele-1
                                                                    Typestring
                                                                    Is Modifierfalse
                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                    Summaryfalse
                                                                    428. ClaimResponse.total.extension
                                                                    Definition

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

                                                                    ShortAdditional content defined by implementations
                                                                    Comments

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

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

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

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

                                                                    ShortExtensions that cannot be ignored even if unrecognized
                                                                    Comments

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

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

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

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

                                                                    A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

                                                                    ShortType of adjudication information
                                                                    Comments

                                                                    For example codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

                                                                    Control1..1
                                                                    BindingFor example codes, see AdjudicationValueCodes .
                                                                    (example to http://hl7.org/fhir/ValueSet/adjudication|5.0.0)

                                                                    The adjudication codes.

                                                                    TypeCodeableConcept
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summarytrue
                                                                    Requirements

                                                                    Needed to convey the type of total provided.

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

                                                                    Monetary total amount associated with the category.

                                                                    ShortFinancial total for the category
                                                                    Control1..1
                                                                    TypeMoney
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summarytrue
                                                                    Requirements

                                                                    Needed to convey the total monetary amount.

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

                                                                    Payment details for the adjudication of the claim.

                                                                    ShortPayment Details
                                                                    Control0..1
                                                                    TypeBackboneElement
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summaryfalse
                                                                    Requirements

                                                                    Needed to convey references to the financial instrument that has been used if payment has been made.

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

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

                                                                    ShortUnique id for inter-element referencing
                                                                    Control0..1
                                                                    This element is affected by the following invariants: ele-1
                                                                    Typestring
                                                                    Is Modifierfalse
                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                    Summaryfalse
                                                                    440. ClaimResponse.payment.extension
                                                                    Definition

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

                                                                    ShortAdditional content defined by implementations
                                                                    Comments

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

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

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

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

                                                                    ShortExtensions that cannot be ignored even if unrecognized
                                                                    Comments

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

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

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

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

                                                                    Whether this represents partial or complete payment of the benefits payable.

                                                                    ShortPartial or complete payment
                                                                    Control1..1
                                                                    BindingFor example codes, see ExamplePaymentTypeCodes
                                                                    (example to http://hl7.org/fhir/ValueSet/ex-paymenttype|5.0.0)

                                                                    The type (partial, complete) of the payment.

                                                                    TypeCodeableConcept
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summaryfalse
                                                                    Requirements

                                                                    To advise the requestor when the insurer believes all payments to have been completed.

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

                                                                    Total amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication.

                                                                    ShortPayment adjustment for non-claim issues
                                                                    Comments

                                                                    Insurers will deduct amounts owing from the provider (adjustment), such as a prior overpayment, from the amount owing to the provider (benefits payable) when payment is made to the provider.

                                                                    Control0..1
                                                                    TypeMoney
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summaryfalse
                                                                    Requirements

                                                                    To advise the requestor of adjustments applied to the payment.

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

                                                                    Reason for the payment adjustment.

                                                                    ShortExplanation for the adjustment
                                                                    Control0..1
                                                                    BindingFor example codes, see PaymentAdjustmentReasonCodes
                                                                    (example to http://hl7.org/fhir/ValueSet/payment-adjustment-reason|5.0.0)

                                                                    Payment Adjustment reason codes.

                                                                    TypeCodeableConcept
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summaryfalse
                                                                    Requirements

                                                                    Needed to clarify the monetary adjustment.

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

                                                                    Estimated date the payment will be issued or the actual issue date of payment.

                                                                    ShortExpected date of payment
                                                                    Control0..1
                                                                    Typedate
                                                                    Is Modifierfalse
                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                    Must Supportfalse
                                                                    Summaryfalse
                                                                    Requirements

                                                                    To advise the payee when payment can be expected.

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

                                                                    Benefits payable less any payment adjustment.

                                                                    ShortPayable amount after adjustment
                                                                    Control1..1
                                                                    TypeMoney
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summaryfalse
                                                                    Requirements

                                                                    Needed to provide the actual payment amount.

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

                                                                    Issuer's unique identifier for the payment instrument.

                                                                    ShortBusiness identifier for the payment
                                                                    Comments

                                                                    For example: EFT number or check number.

                                                                    NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                    Control0..1
                                                                    TypeIdentifier
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summaryfalse
                                                                    Requirements

                                                                    Enable the receiver to reconcile when payment received.

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

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

                                                                    ShortUnique id for inter-element referencing
                                                                    Control0..1
                                                                    This element is affected by the following invariants: ele-1
                                                                    Typeid
                                                                    Is Modifierfalse
                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                    Summaryfalse
                                                                    458. ClaimResponse.payment.identifier.extension
                                                                    Definition

                                                                    An Extension

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

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

                                                                      ShortSTU3: Identifier of the payment instrument additional types
                                                                      Comments

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

                                                                      Control0..1
                                                                      TypeExtension(STU3: Identifier of the payment instrument additional types) (Extension Type: Identifier)
                                                                      Is Modifierfalse
                                                                      Summaryfalse
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                      462. ClaimResponse.payment.identifier.use
                                                                      Definition

                                                                      The purpose of this identifier.

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

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

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

                                                                      Identifies the purpose for this identifier, if known .

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

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

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

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

                                                                      ShortDescription of identifier
                                                                      Comments

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

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

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

                                                                      TypeCodeableConcept
                                                                      Is Modifierfalse
                                                                      Summarytrue
                                                                      Requirements

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

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

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

                                                                      ShortThe namespace for the identifier value
                                                                      Comments

                                                                      Identifier.system is always case sensitive.

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

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

                                                                      ExampleGeneral: http://www.acme.com/identifiers/patient
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      468. ClaimResponse.payment.identifier.value
                                                                      Definition

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

                                                                      ShortThe value that is unique
                                                                      Comments

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

                                                                      Control0..1
                                                                      This element is affected by the following invariants: ident-1
                                                                      Typestring
                                                                      Is Modifierfalse
                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                      Summarytrue
                                                                      ExampleGeneral: 123456
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      470. ClaimResponse.payment.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()))
                                                                      472. ClaimResponse.payment.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()))
                                                                      474. ClaimResponse.fundsReserve
                                                                      Definition

                                                                      A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.

                                                                      ShortFunds reserved status
                                                                      Comments

                                                                      Fund would be release by a future claim quoting the preAuthRef of this response. Examples of values include: provider, patient, none.

                                                                      Control0..1
                                                                      BindingFor example codes, see FundsReservationCodes
                                                                      (example to http://hl7.org/fhir/ValueSet/fundsreserve|5.0.0)

                                                                      For whom funds are to be reserved: (Patient, Provider, None).

                                                                      TypeCodeableConcept
                                                                      Is Modifierfalse
                                                                      Must Supportfalse
                                                                      Summaryfalse
                                                                      Requirements

                                                                      Needed to advise the submitting provider on whether the rquest for reservation of funds has been honored.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      476. ClaimResponse.formCode
                                                                      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 FormCodes
                                                                      (example to http://hl7.org/fhir/ValueSet/forms|5.0.0)

                                                                      The forms codes.

                                                                      TypeCodeableConcept
                                                                      Is Modifierfalse
                                                                      Must Supportfalse
                                                                      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()))
                                                                      478. ClaimResponse.form
                                                                      Definition

                                                                      The actual form, by reference or inclusion, for printing the content or an EOB.

                                                                      ShortPrinted reference or actual form
                                                                      Comments

                                                                      Needed to permit insurers to include the actual form.

                                                                      Control0..1
                                                                      TypeAttachment
                                                                      Is Modifierfalse
                                                                      Must Supportfalse
                                                                      Summaryfalse
                                                                      Requirements

                                                                      Needed to include 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()))
                                                                      480. ClaimResponse.processNote
                                                                      Definition

                                                                      A note that describes or explains adjudication results in a human readable form.

                                                                      ShortNote concerning adjudication
                                                                      Control0..*
                                                                      TypeBackboneElement
                                                                      Is Modifierfalse
                                                                      Must Supportfalse
                                                                      Summaryfalse
                                                                      Requirements

                                                                      Provides the insurer specific textual explanations associated with the processing.

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

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

                                                                      ShortUnique id for inter-element referencing
                                                                      Control0..1
                                                                      This element is affected by the following invariants: ele-1
                                                                      Typestring
                                                                      Is Modifierfalse
                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                      Summaryfalse
                                                                      484. ClaimResponse.processNote.extension
                                                                      Definition

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

                                                                      ShortAdditional content defined by implementations
                                                                      Comments

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

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

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

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

                                                                      ShortExtensions that cannot be ignored even if unrecognized
                                                                      Comments

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

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

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

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

                                                                      A number to uniquely identify a note entry.

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

                                                                      Necessary to provide a mechanism to link from adjudications.

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

                                                                      The business purpose of the note text.

                                                                      ShortNote purpose
                                                                      Control0..1
                                                                      BindingUnless not suitable, these codes SHALL be taken from NoteType
                                                                      (extensible to http://hl7.org/fhir/ValueSet/note-type|5.0.0)

                                                                      The presentation types of notes.

                                                                      TypeCodeableConcept
                                                                      Is Modifierfalse
                                                                      Must Supportfalse
                                                                      Summaryfalse
                                                                      Requirements

                                                                      To convey the expectation for when the text is used.

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

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

                                                                      ShortUnique id for inter-element referencing
                                                                      Control0..1
                                                                      This element is affected by the following invariants: ele-1
                                                                      Typeid
                                                                      Is Modifierfalse
                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                      Summaryfalse
                                                                      494. ClaimResponse.processNote.type.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 ClaimResponse.processNote.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                      • value @ url
                                                                      • 496. ClaimResponse.processNote.type.extension:type
                                                                        Slice Nametype
                                                                        Definition

                                                                        STU3: ClaimResponse.processNote.type

                                                                        ShortSTU3: display | print | printoper
                                                                        Comments

                                                                        Element ClaimResponse.processNote.type is mapped to FHIR R5 element ClaimResponse.processNote.type as RelatedTo.

                                                                        Control0..1
                                                                        TypeExtension(STU3: display | print | printoper) (Extension Type: CodeableConcept)
                                                                        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())
                                                                        498. ClaimResponse.processNote.type.coding
                                                                        Definition

                                                                        A reference to a code defined by a terminology system.

                                                                        ShortCode defined by a terminology system
                                                                        Comments

                                                                        Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                        Control0..*
                                                                        TypeCoding
                                                                        Is Modifierfalse
                                                                        Summarytrue
                                                                        Requirements

                                                                        Allows for alternative encodings within a code system, and translations to other code systems.

                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        500. ClaimResponse.processNote.type.text
                                                                        Definition

                                                                        A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                        ShortPlain text representation of the concept
                                                                        Comments

                                                                        Very often the text is the same as a displayName of one of the codings.

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

                                                                        The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

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

                                                                        The explanation or description associated with the processing.

                                                                        ShortNote explanatory text
                                                                        Control1..1
                                                                        Typestring
                                                                        Is Modifierfalse
                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                        Must Supportfalse
                                                                        Summaryfalse
                                                                        Requirements

                                                                        Required to provide human readable explanation.

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

                                                                        A code to define the language used in the text of the note.

                                                                        ShortLanguage of the text
                                                                        Comments

                                                                        Only required if the language is different from the resource language.

                                                                        Control0..1
                                                                        BindingThe codes SHALL be taken from AllLanguages
                                                                        (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

                                                                        IETF language tag for a human language

                                                                        TypeCodeableConcept
                                                                        Is Modifierfalse
                                                                        Must Supportfalse
                                                                        Summaryfalse
                                                                        Requirements

                                                                        Note text may vary from the resource defined language.

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

                                                                        Request for additional supporting or authorizing information.

                                                                        ShortRequest for additional information
                                                                        Comments

                                                                        For example: professional reports, documents, images, clinical resources, or accident reports.

                                                                        Control0..*
                                                                        TypeReference(CommunicationRequest)
                                                                        Is Modifierfalse
                                                                        Must Supportfalse
                                                                        Summaryfalse
                                                                        Requirements

                                                                        Need to communicate insurer request for additional information required to support the adjudication.

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

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

                                                                        ShortUnique id for inter-element referencing
                                                                        Control0..1
                                                                        This element is affected by the following invariants: ele-1
                                                                        Typeid
                                                                        Is Modifierfalse
                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                        Summaryfalse
                                                                        510. ClaimResponse.communicationRequest.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 ClaimResponse.communicationRequest.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                        • value @ url
                                                                        • 512. ClaimResponse.communicationRequest.extension:communicationRequest
                                                                          Slice NamecommunicationRequest
                                                                          Definition

                                                                          STU3: ClaimResponse.communicationRequest additional types from child elements (display, identifier, reference)

                                                                          ShortSTU3: communicationRequest additional types
                                                                          Comments

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

                                                                          Control0..1
                                                                          TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                                          Is Modifierfalse
                                                                          Summaryfalse
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                          514. ClaimResponse.communicationRequest.reference
                                                                          Definition

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

                                                                          ShortLiteral reference, Relative, internal or absolute URL
                                                                          Comments

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

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

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

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

                                                                          ShortType the reference refers to (e.g. "Patient") - must be a resource in resources
                                                                          Comments

                                                                          This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.

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

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

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

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

                                                                          ShortLogical reference, when literal reference is not known
                                                                          Comments

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

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

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

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

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

                                                                          NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                          Control0..1
                                                                          This element is affected by the following invariants: ref-2
                                                                          TypeIdentifier
                                                                          Is Modifierfalse
                                                                          Summarytrue
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          520. ClaimResponse.communicationRequest.display
                                                                          Definition

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

                                                                          ShortText alternative for the resource
                                                                          Comments

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

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

                                                                          Financial instruments for reimbursement for the health care products and services specified on the claim.

                                                                          ShortPatient insurance information
                                                                          Comments

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

                                                                          Control0..*
                                                                          TypeBackboneElement
                                                                          Is Modifierfalse
                                                                          Must Supportfalse
                                                                          Summaryfalse
                                                                          Requirements

                                                                          At least one insurer is required for a claim to be a claim.

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

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

                                                                          ShortUnique id for inter-element referencing
                                                                          Control0..1
                                                                          This element is affected by the following invariants: ele-1
                                                                          Typestring
                                                                          Is Modifierfalse
                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                          Summaryfalse
                                                                          526. ClaimResponse.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 ClaimResponse.insurance.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                          • value @ url
                                                                          • 528. ClaimResponse.insurance.extension:preAuthRef
                                                                            Slice NamepreAuthRef
                                                                            Definition

                                                                            STU3: ClaimResponse.insurance.preAuthRef (new:string)

                                                                            ShortSTU3: Pre-Authorization/Determination Reference (new)
                                                                            Comments

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

                                                                            Control0..*
                                                                            TypeExtension(STU3: Pre-Authorization/Determination Reference (new)) (Extension Type: string)
                                                                            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())
                                                                            530. ClaimResponse.insurance.modifierExtension
                                                                            Definition

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

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

                                                                            ShortExtensions that cannot be ignored even if unrecognized
                                                                            Comments

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

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

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

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

                                                                            A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.

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

                                                                            To maintain order of the coverages.

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

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

                                                                            ShortCoverage to be used for adjudication
                                                                            Comments

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

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

                                                                            To identify which coverage in the list is being used to adjudicate this claim.

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

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

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

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

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

                                                                              STU3: ClaimResponse.insurance.coverage additional types from child elements (display, identifier, reference)

                                                                              ShortSTU3: coverage additional types
                                                                              Comments

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

                                                                              Control0..1
                                                                              TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                                              Is Modifierfalse
                                                                              Summaryfalse
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                              544. ClaimResponse.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-2, ref-1
                                                                              Typestring
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Summarytrue
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              546. ClaimResponse.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") - must be a resource in resources
                                                                              Comments

                                                                              This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.

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

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

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

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

                                                                              NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                              Control0..1
                                                                              This element is affected by the following invariants: ref-2
                                                                              TypeIdentifier
                                                                              Is Modifierfalse
                                                                              Summarytrue
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              550. ClaimResponse.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
                                                                              This element is affected by the following invariants: ref-2
                                                                              Typestring
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Summarytrue
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              552. ClaimResponse.insurance.businessArrangement
                                                                              Definition

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

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

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

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

                                                                              The result of the adjudication of the line items for the Coverage specified in this insurance.

                                                                              ShortAdjudication results
                                                                              Comments

                                                                              Must not be specified when 'focal=true' for this insurance.

                                                                              Control0..1
                                                                              TypeReference(ClaimResponse)
                                                                              Is Modifierfalse
                                                                              Must Supportfalse
                                                                              Summaryfalse
                                                                              Requirements

                                                                              An insurer need the adjudication results from prior insurers to determine the outstanding balance remaining by item for the items in the curent claim.

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

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

                                                                              ShortUnique id for inter-element referencing
                                                                              Control0..1
                                                                              This element is affected by the following invariants: ele-1
                                                                              Typeid
                                                                              Is Modifierfalse
                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                              Summaryfalse
                                                                              558. ClaimResponse.insurance.claimResponse.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 ClaimResponse.insurance.claimResponse.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                              • value @ url
                                                                              • 560. ClaimResponse.insurance.claimResponse.extension:claimResponse
                                                                                Slice NameclaimResponse
                                                                                Definition

                                                                                STU3: ClaimResponse.insurance.claimResponse additional types from child elements (display, identifier, reference)

                                                                                ShortSTU3: claimResponse additional types
                                                                                Comments

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

                                                                                Control0..1
                                                                                TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                                                Is Modifierfalse
                                                                                Summaryfalse
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                562. ClaimResponse.insurance.claimResponse.reference
                                                                                Definition

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

                                                                                ShortLiteral reference, Relative, internal or absolute URL
                                                                                Comments

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

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

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

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

                                                                                ShortType the reference refers to (e.g. "Patient") - must be a resource in resources
                                                                                Comments

                                                                                This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.

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

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

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

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

                                                                                ShortLogical reference, when literal reference is not known
                                                                                Comments

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

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

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

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

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

                                                                                NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                                Control0..1
                                                                                This element is affected by the following invariants: ref-2
                                                                                TypeIdentifier
                                                                                Is Modifierfalse
                                                                                Summarytrue
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                568. ClaimResponse.insurance.claimResponse.display
                                                                                Definition

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

                                                                                ShortText alternative for the resource
                                                                                Comments

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

                                                                                Control0..1
                                                                                This element is affected by the following invariants: ref-2
                                                                                Typestring
                                                                                Is Modifierfalse
                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                Summarytrue
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                570. ClaimResponse.error
                                                                                Definition

                                                                                Errors encountered during the processing of the adjudication.

                                                                                ShortProcessing errors
                                                                                Comments

                                                                                If the request contains errors then an error element should be provided and no adjudication related sections (item, addItem, or payment) should be present.

                                                                                Control0..*
                                                                                TypeBackboneElement
                                                                                Is Modifierfalse
                                                                                Must Supportfalse
                                                                                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()))
                                                                                572. ClaimResponse.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
                                                                                This element is affected by the following invariants: ele-1
                                                                                Typestring
                                                                                Is Modifierfalse
                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                Summaryfalse
                                                                                574. ClaimResponse.error.extension
                                                                                Definition

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

                                                                                ShortAdditional content defined by implementations
                                                                                Comments

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

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

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

                                                                                ShortExtensions that cannot be ignored even if unrecognized
                                                                                Comments

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

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

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

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

                                                                                The sequence number of the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.

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

                                                                                Provides references to the claim items.

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

                                                                                The sequence number of the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.

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

                                                                                Provides references to the claim details within the claim item.

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

                                                                                The sequence number of the sub-detail within the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.

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

                                                                                Provides references to the claim sub-details within the claim detail.

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

                                                                                An error code, from a specified code system, which details why the claim could not be adjudicated.

                                                                                ShortError code detailing processing issues
                                                                                Control1..1
                                                                                BindingFor example codes, see AdjudicationErrorCodes
                                                                                (example to http://hl7.org/fhir/ValueSet/adjudication-error|5.0.0)

                                                                                The adjudication error codes.

                                                                                TypeCodeableConcept
                                                                                Is Modifierfalse
                                                                                Must Supportfalse
                                                                                Summarytrue
                                                                                Requirements

                                                                                Required to convey processing errors.

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

                                                                                A simple subset of FHIRPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised.

                                                                                ShortFHIRPath of element(s) related to issue
                                                                                Comments

                                                                                The root of the FHIRPath is the resource or bundle that generated OperationOutcome. Each FHIRPath SHALL resolve to a single node.

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

                                                                                Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.

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