0.1.0 - ci-build

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

Resource Profile: ClaimResponseAuthorizationResponseProfile - Detailed Descriptions

Draft as of 2024-09-06

Definitions for the ClaimResponseAuthorizationResponseProfile resource profile.

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

0. ClaimResponse
2. ClaimResponse.id
ShortUnique string for reference purposes
Control1..?
4. ClaimResponse.meta
ShortMetadata about a resource
Control1..?
6. ClaimResponse.meta.profile
Control1..?
8. ClaimResponse.extension
ShortOptional Extensions Element
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
  • 10. ClaimResponse.extension:diagnosisRelatedGroup
    Slice NamediagnosisRelatedGroup
    Control0..1
    TypeExtension(Extension for Diagnosis Related Group) (Extension Type: CodeableConcept)
    12. ClaimResponse.extension:reissueReason
    Slice NamereissueReason
    Control0..1
    TypeExtension(ReissueReason) (Extension Type: CodeableConcept)
    14. ClaimResponse.extension:adjudicationOutcome
    Slice NameadjudicationOutcome
    Control0..1
    TypeExtension(AdjudicationOutcome) (Extension Type: CodeableConcept)
    16. ClaimResponse.extension:transferAuthorizationNumber
    Slice NametransferAuthorizationNumber
    Control0..1
    TypeExtension(TransferAuthorizationNumber) (Extension Type: string)
    18. ClaimResponse.extension:transferAuthorizationPeriod
    Slice NametransferAuthorizationPeriod
    Control0..1
    TypeExtension(TransferAuthorizationPeriod) (Extension Type: Period)
    20. ClaimResponse.extension:transferAuthorizationProvider
    Slice NametransferAuthorizationProvider
    Control0..1
    TypeExtension(TransferAuthorizationProvider) (Extension Type: Reference(SHAPractitioner, SHAOrganization))
    22. ClaimResponse.identifier
    ShortA unique identifier assigned to this claim response.
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control1..1
    24. ClaimResponse.status
    ShortThe status of the resource instance.
    26. ClaimResponse.type
    ShortA finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.
    28. ClaimResponse.subType
    ShortA finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.
    30. ClaimResponse.use
    ShortA code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.
    32. ClaimResponse.patient
    ShortThe 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.
    34. ClaimResponse.created
    ShortThe date this resource was created.
    36. ClaimResponse.insurer
    ShortThe party responsible for authorization, adjudication and reimbursement.
    38. ClaimResponse.requestor
    ShortThe provider which is responsible for the claim, predetermination or preauthorization.
    Control1..?
    40. ClaimResponse.request
    ShortOriginal request resource reference.
    Control1..?
    42. ClaimResponse.outcome
    ShortThe outcome of the claim, predetermination, or preauthorization processing.
    44. ClaimResponse.disposition
    ShortA human readable description of the status of the adjudication.
    46. ClaimResponse.preAuthRef
    ShortReference from the Insurer which is used in later communications which refers to this adjudication.
    48. ClaimResponse.preAuthPeriod
    ShortThe time frame during which this authorization is effective.
    50. ClaimResponse.payeeType
    ShortType of Party to be reimbursed: subscriber, provider, other.
    52. ClaimResponse.item
    ShortA 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.
    54. ClaimResponse.item.extension
    SlicingThis element introduces a set of slices on ClaimResponse.item.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 56. ClaimResponse.item.extension:adjudicationOutcome
      Slice NameadjudicationOutcome
      Control0..1
      TypeExtension(AdjudicationOutcome) (Extension Type: CodeableConcept)
      58. ClaimResponse.item.itemSequence
      ShortA number to uniquely reference the claim detail entry.
      60. ClaimResponse.item.noteNumber
      ShortThe numbers associated with notes below which apply to the adjudication of this item.
      62. ClaimResponse.item.adjudication
      ShortIf 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.
      64. ClaimResponse.item.adjudication.category
      ShortIf 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.
      66. ClaimResponse.item.adjudication.reason
      ShortA code supporting the understanding of the adjudication result and explaining variance from expected amount.
      68. ClaimResponse.item.adjudication.amount
      ShortMonetary amount associated with the category.
      70. ClaimResponse.item.detail
      ShortA claim detail. Either a simple (a product or service) or a 'group' of sub-details which are simple items.
      72. ClaimResponse.item.detail.detailSequence
      ShortA number to uniquely reference the claim detail entry.
      74. ClaimResponse.item.detail.adjudication
      ShortThe adjudication results.
      TypeBackboneElement
      76. ClaimResponse.item.detail.adjudication.category
      ShortA 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.
      78. ClaimResponse.item.detail.adjudication.reason
      ShortA code supporting the understanding of the adjudication result and explaining variance from expected amount.
      80. ClaimResponse.item.detail.adjudication.amount
      ShortMonetary amount associated with the category.
      82. ClaimResponse.item.detail.subDetail
      ShortA sub-detail adjudication of a simple product or service.
      84. ClaimResponse.item.detail.subDetail.subDetailSequence
      ShortA number to uniquely reference the claim sub-detail entry.
      86. ClaimResponse.item.detail.subDetail.noteNumber
      ShortThe numbers associated with notes below which apply to the adjudication of this item.
      88. ClaimResponse.item.detail.subDetail.adjudication
      ShortThe adjudication results.
      Control1..?
      TypeBackboneElement
      90. ClaimResponse.item.detail.subDetail.adjudication.category
      ShortA 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.
      92. ClaimResponse.item.detail.subDetail.adjudication.reason
      ShortA code supporting the understanding of the adjudication result and explaining variance from expected amount.
      94. ClaimResponse.item.detail.subDetail.adjudication.amount
      ShortMonetary amount associated with the category.
      96. ClaimResponse.total
      ShortCategorized monetary totals for the adjudication.
      98. ClaimResponse.total.category
      ShortA 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.
      100. ClaimResponse.total.amount
      ShortMonetary total amount associated with the category.
      102. ClaimResponse.fundsReserve
      ShortA code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.
      104. ClaimResponse.processNote
      ShortA note that describes or explains adjudication results in a human readable form.
      106. ClaimResponse.processNote.number
      ShortA number to uniquely identify a note entry.
      Control1..?
      108. ClaimResponse.processNote.type
      ShortThe business purpose of the note text.
      Control1..?
      110. ClaimResponse.processNote.text
      ShortThe explanation or description associated with the processing.
      112. ClaimResponse.processNote.language
      ShortA code to define the language used in the text of the note.
      114. ClaimResponse.communicationRequest
      ShortRequest for additional supporting or authorizing information.
      Control0..1
      116. ClaimResponse.insurance
      ShortFinancial instruments for reimbursement for the health care products and services specified on the claim.
      118. ClaimResponse.insurance.sequence
      ShortA number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.
      120. ClaimResponse.insurance.focal
      ShortA flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.
      122. ClaimResponse.insurance.coverage
      ShortReference 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.
      124. ClaimResponse.insurance.claimResponse
      ShortThe result of the adjudication of the line items for the Coverage specified. This is used when an insurer is able to not just adjudicate the claim they were sent but also able to detect that they are the processor for the sebsequent claims and can adjudicate them too.
      126. ClaimResponse.error
      ShortErrors encountered during the processing of the adjudication.
      128. ClaimResponse.error.extension
      SlicingThis element introduces a set of slices on ClaimResponse.error.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 130. ClaimResponse.error.extension:errorExtensionExpression
        Slice NameerrorExtensionExpression
        Control0..1
        TypeExtension(ErrorExtensionExpression) (Extension Type: string)
        132. ClaimResponse.error.itemSequence
        ShortThe sequence number of the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.
        134. ClaimResponse.error.detailSequence
        ShortThe 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.
        136. ClaimResponse.error.subDetailSequence
        ShortThe 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.
        138. ClaimResponse.error.code
        ShortAn error code, from a specified code system, which details why the claim could not be adjudicated.

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

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

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

        ShortUnique string for reference purposes Logical id of this artifact
        Comments

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

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

        Control10..*
        Typecanonical(StructureDefinition)
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        8. 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 it's narrative along with other profiles, value sets, etc.

        Control0..1
        Typeuri
        Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        10. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        ShortOptional Extensions ElementAdditional content defined by implementations
        Comments

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

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

          create extension to hold the DRG - Codesystem (AR DRG) and Valueset Required

          ShortExtension for Diagnosis Related Group
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Extension for Diagnosis Related Group) (Extension Type: CodeableConcept)
          Is Modifierfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          14. ClaimResponse.extension:reissueReason
          Slice NamereissueReason
          Definition

          The reason the adjudicator has reissued an authroization or claim response.

          ShortReissueReason
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(ReissueReason) (Extension Type: CodeableConcept)
          Is Modifierfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          16. ClaimResponse.extension:adjudicationOutcome
          Slice NameadjudicationOutcome
          Definition

          A code indicating the outcome of the adjudication such as rejected, partially approved/paid or approved/paid as submitted.

          ShortAdjudicationOutcome
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(AdjudicationOutcome) (Extension Type: CodeableConcept)
          Is Modifierfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          18. ClaimResponse.extension:transferAuthorizationNumber
          Slice NametransferAuthorizationNumber
          Definition

          A number assigned to the transfer authorization.

          ShortTransferAuthorizationNumber
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(TransferAuthorizationNumber) (Extension Type: string)
          Is Modifierfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          20. ClaimResponse.extension:transferAuthorizationPeriod
          Slice NametransferAuthorizationPeriod
          Definition

          A period of time during which the transfer authorization is valid.

          ShortTransferAuthorizationPeriod
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(TransferAuthorizationPeriod) (Extension Type: Period)
          Is Modifierfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          22. ClaimResponse.extension:transferAuthorizationProvider
          Slice NametransferAuthorizationProvider
          Definition

          The provider who is authorized to provide the service.

          ShortTransferAuthorizationProvider
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(TransferAuthorizationProvider) (Extension Type: Reference(SHAPractitioner, SHAOrganization))
          Is Modifierfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          24. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

          ShortExtensions that cannot be ignored
          Comments

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

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

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

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

          A unique identifier assigned to this claim response.

          ShortA unique identifier assigned to this claim response.Business Identifier for a claim response
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control10..1*
          TypeIdentifier
          Is Modifierfalse
          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()))
          28. ClaimResponse.status
          Definition

          The status of the resource instance.

          ShortThe status of the resource instance.active | cancelled | draft | entered-in-error
          Comments

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

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

          A code specifying the state of the resource instance.

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

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

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

          ShortA finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.More 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
          (extensible to http://hl7.org/fhir/ValueSet/claim-type)

          The type or discipline-style of the claim.

          TypeCodeableConcept
          Is Modifierfalse
          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()))
          32. 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.

          ShortA finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.More 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 ExampleClaimSubTypeCodeshttp://hl7.org/fhir/ValueSet/claim-subtype
          (example to http://hl7.org/fhir/ValueSet/claim-subtype)

          A more granular claim typecode.

          TypeCodeableConcept
          Is Modifierfalse
          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()))
          34. ClaimResponse.use
          Definition

          A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.

          ShortA code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.claim | preauthorization | predetermination
          Control1..1
          BindingThe codes SHALL be taken from Usehttp://hl7.org/fhir/ValueSet/claim-use|4.0.1
          (required to http://hl7.org/fhir/ValueSet/claim-use|4.0.1)

          Claim, preauthorization, predetermination.

          Typecode
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          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()))
          36. 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 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.The recipient of the products and services
          Control1..1
          TypeReference(Patient)
          Is Modifierfalse
          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()))
          38. ClaimResponse.created
          Definition

          The date this resource was created.

          ShortThe date this resource was created.Response creation date
          Control1..1
          TypedateTime
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

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

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

          The party responsible for authorization, adjudication and reimbursement.

          ShortThe party responsible for authorization, adjudication and reimbursement.Party responsible for reimbursement
          Control1..1
          TypeReference(Organization)
          Is Modifierfalse
          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()))
          42. ClaimResponse.requestor
          Definition

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

          ShortThe provider which is responsible for the claim, predetermination or preauthorization.Party responsible for the claim
          Comments

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

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

          Original request resource reference.

          ShortOriginal request resource reference.Id of resource triggering adjudication
          Control10..1
          TypeReference(Claim)
          Is Modifierfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          46. ClaimResponse.outcome
          Definition

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

          ShortThe outcome of the claim, predetermination, or preauthorization processing.queued | complete | error | partial
          Comments

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

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

          The result of the claim processing.

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

          To advise the requestor of an overall processing outcome.

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

          A human readable description of the status of the adjudication.

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

          Provided for user display.

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

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

          ShortReference from the Insurer which is used in later communications which refers to this adjudication.Preauthorization 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
          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()))
          52. ClaimResponse.preAuthPeriod
          Definition

          The time frame during which this authorization is effective.

          ShortThe time frame during which this authorization is effective.Preauthorization reference effective period
          Control0..1
          TypePeriod
          Is Modifierfalse
          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()))
          54. ClaimResponse.payeeType
          Definition

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

          ShortType of Party to be reimbursed: subscriber, provider, other.Party to be paid any benefits payable
          Control0..1
          BindingFor example codes, see Claim Payee Type Codeshttp://hl7.org/fhir/ValueSet/payeetype
          (example to http://hl7.org/fhir/ValueSet/payeetype)

          A code for the party to be reimbursed.

          TypeCodeableConcept
          Is Modifierfalse
          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()))
          56. 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.

          ShortA 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.Adjudication for claim line items
          Control0..*
          TypeBackboneElement
          Is Modifierfalse
          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()))
          58. ClaimResponse.item.extension
          Definition

          An Extension


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

          ShortExtensionAdditional content defined by implementations
          Comments

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

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

            A code indicating the outcome of the adjudication such as rejected, partially approved/paid or approved/paid as submitted.

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

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

            ShortExtensions that cannot be ignored even if unrecognized
            Comments

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

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

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

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

            A number to uniquely reference the claim item entries.

            ShortA number to uniquely reference the claim detail entry.Claim item instance identifier
            Control1..1
            TypepositiveInt
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Requirements

            Necessary to 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()))
            66. ClaimResponse.item.noteNumber
            Definition

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

            ShortThe numbers associated with notes below which apply to the adjudication of this item.Applicable note numbers
            Control0..*
            TypepositiveInt
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            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()))
            68. 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.

            ShortIf 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.Adjudication details
            Control1..*
            TypeBackboneElement
            Is Modifierfalse
            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()))
            70. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

            ShortExtensions that cannot be ignored even if unrecognized
            Comments

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

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

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

            Alternate Namesextensions, user content, modifiers
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            72. 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.

            ShortIf 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.Type of adjudication information
            Comments

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

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

            The adjudication codes.

            TypeCodeableConcept
            Is Modifierfalse
            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()))
            74. ClaimResponse.item.adjudication.reason
            Definition

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

            ShortA code supporting the understanding of the adjudication result and explaining variance from expected amount.Explanation of adjudication outcome
            Comments

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

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

            The adjudication reason codes.

            TypeCodeableConcept
            Is Modifierfalse
            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()))
            76. ClaimResponse.item.adjudication.amount
            Definition

            Monetary amount associated with the category.

            ShortMonetary amount associated with the category.
            Comments

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

            Control0..1
            TypeMoney
            Is Modifierfalse
            Summaryfalse
            Requirements

            Most adjuciation categories convey a monetary amount.

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

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

            ShortA claim detail. Either a simple (a product or service) or a 'group' of sub-details which are simple items.Adjudication for claim details
            Control0..*
            TypeBackboneElement
            Is Modifierfalse
            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()))
            80. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

            ShortExtensions that cannot be ignored even if unrecognized
            Comments

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

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

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

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

            A number to uniquely reference the claim detail entry.

            ShortA number to uniquely reference the claim detail entry.Claim detail instance identifier
            Control1..1
            TypepositiveInt
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Requirements

            Necessary to 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()))
            84. ClaimResponse.item.detail.adjudication
            Definition

            The adjudication results.

            ShortThe adjudication results.Detail level adjudication details
            Control1..*
            TypeBackboneElement
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            86. ClaimResponse.item.detail.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

            ShortExtensions that cannot be ignored even if unrecognized
            Comments

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

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

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

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

            ShortA 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.Type of adjudication information
            Comments

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

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

            The adjudication codes.

            TypeCodeableConcept
            Is Modifierfalse
            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()))
            90. ClaimResponse.item.detail.adjudication.reason
            Definition

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

            ShortA code supporting the understanding of the adjudication result and explaining variance from expected amount.Explanation of adjudication outcome
            Comments

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

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

            The adjudication reason codes.

            TypeCodeableConcept
            Is Modifierfalse
            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()))
            92. ClaimResponse.item.detail.adjudication.amount
            Definition

            Monetary amount associated with the category.

            ShortMonetary amount associated with the category.
            Comments

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

            Control0..1
            TypeMoney
            Is Modifierfalse
            Summaryfalse
            Requirements

            Most adjuciation categories convey a monetary amount.

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

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

            ShortA sub-detail adjudication of a simple product or service.Adjudication for claim sub-details
            Control0..*
            TypeBackboneElement
            Is Modifierfalse
            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()))
            96. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

            ShortExtensions that cannot be ignored even if unrecognized
            Comments

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

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

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

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

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

            ShortA number to uniquely reference the claim sub-detail entry.Claim sub-detail instance identifier
            Control1..1
            TypepositiveInt
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Requirements

            Necessary to 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()))
            100. ClaimResponse.item.detail.subDetail.noteNumber
            Definition

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

            ShortThe numbers associated with notes below which apply to the adjudication of this item.Applicable note numbers
            Control0..*
            TypepositiveInt
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            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()))
            102. ClaimResponse.item.detail.subDetail.adjudication
            Definition

            The adjudication results.

            ShortThe adjudication results.Subdetail level adjudication details
            Control10..*
            TypeBackboneElement
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            104. ClaimResponse.item.detail.subDetail.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

            ShortExtensions that cannot be ignored even if unrecognized
            Comments

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

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

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

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

            ShortA 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.Type of adjudication information
            Comments

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

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

            The adjudication codes.

            TypeCodeableConcept
            Is Modifierfalse
            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()))
            108. ClaimResponse.item.detail.subDetail.adjudication.reason
            Definition

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

            ShortA code supporting the understanding of the adjudication result and explaining variance from expected amount.Explanation of adjudication outcome
            Comments

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

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

            The adjudication reason codes.

            TypeCodeableConcept
            Is Modifierfalse
            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()))
            110. ClaimResponse.item.detail.subDetail.adjudication.amount
            Definition

            Monetary amount associated with the category.

            ShortMonetary amount associated with the category.
            Comments

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

            Control0..1
            TypeMoney
            Is Modifierfalse
            Summaryfalse
            Requirements

            Most adjuciation categories convey a monetary amount.

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

            Categorized monetary totals for the adjudication.

            ShortCategorized monetary totals for the adjudication.Adjudication totals
            Comments

            Totals for amounts submitted, co-pays, benefits payable etc.

            Control0..*
            TypeBackboneElement
            Is Modifierfalse
            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()))
            114. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

            ShortExtensions that cannot be ignored even if unrecognized
            Comments

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

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

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

            Alternate Namesextensions, user content, modifiers
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            116. 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.

            ShortA 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.Type of adjudication information
            Comments

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

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

            The adjudication codes.

            TypeCodeableConcept
            Is Modifierfalse
            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()))
            118. ClaimResponse.total.amount
            Definition

            Monetary total amount associated with the category.

            ShortMonetary total amount associated with the category.Financial total for the category
            Control1..1
            TypeMoney
            Is Modifierfalse
            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()))
            120. 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.

            ShortA code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.Funds 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 Funds Reservation Codeshttp://hl7.org/fhir/ValueSet/fundsreserve
            (example to http://hl7.org/fhir/ValueSet/fundsreserve)

            For whom funds are to be reserved: (Patient, Provider, None).

            TypeCodeableConcept
            Is Modifierfalse
            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()))
            122. ClaimResponse.processNote
            Definition

            A note that describes or explains adjudication results in a human readable form.

            ShortA note that describes or explains adjudication results in a human readable form.Note concerning adjudication
            Control0..*
            TypeBackboneElement
            Is Modifierfalse
            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()))
            124. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

            ShortExtensions that cannot be ignored even if unrecognized
            Comments

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

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

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

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

            A number to uniquely identify a note entry.

            ShortA number to uniquely identify a note entry.Note instance identifier
            Control10..1
            TypepositiveInt
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            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()))
            128. ClaimResponse.processNote.type
            Definition

            The business purpose of the note text.

            ShortThe business purpose of the note text.display | print | printoper
            Control10..1
            BindingThe codes SHALL be taken from NoteTypehttp://hl7.org/fhir/ValueSet/note-type|4.0.1
            (required to http://hl7.org/fhir/ValueSet/note-type|4.0.1)

            The presentation types of notes.

            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            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()))
            130. ClaimResponse.processNote.text
            Definition

            The explanation or description associated with the processing.

            ShortThe explanation or description associated with the processing.Note explanatory text
            Control1..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            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()))
            132. ClaimResponse.processNote.language
            Definition

            A code to define the language used in the text of the note.

            ShortA code to define the language used in the text of the note.Language of the text
            Comments

            Only required if the language is different from the resource language.

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

            A human language.

            Additional BindingsPurpose
            AllLanguagesMax Binding
            TypeCodeableConcept
            Is Modifierfalse
            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()))
            134. ClaimResponse.communicationRequest
            Definition

            Request for additional supporting or authorizing information.

            ShortRequest for additional supporting or authorizing information.Request for additional information
            Comments

            For example: professional reports, documents, images, clinical resources, or accident reports.

            Control0..1*
            TypeReference(CommunicationRequest)
            Is Modifierfalse
            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()))
            136. ClaimResponse.insurance
            Definition

            Financial instruments for reimbursement for the health care products and services specified on the claim.

            ShortFinancial instruments for reimbursement for the health care products and services specified on the claim.Patient insurance information
            Comments

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

            Control0..*
            TypeBackboneElement
            Is Modifierfalse
            Summaryfalse
            Requirements

            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()))
            138. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

            ShortExtensions that cannot be ignored even if unrecognized
            Comments

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

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

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

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

            A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.

            ShortA number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.Insurance instance identifier
            Control1..1
            TypepositiveInt
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            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()))
            142. ClaimResponse.insurance.focal
            Definition

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

            ShortA flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.Coverage 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
            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()))
            144. 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.

            ShortReference 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.Insurance information
            Control1..1
            TypeReference(Coverage)
            Is Modifierfalse
            Summaryfalse
            Requirements

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

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

            The result of the adjudication of the line items for the Coverage specified in this insurance.

            ShortThe result of the adjudication of the line items for the Coverage specified. This is used when an insurer is able to not just adjudicate the claim they were sent but also able to detect that they are the processor for the sebsequent claims and can adjudicate them too.Adjudication results
            Comments

            Must not be specified when 'focal=true' for this insurance.

            Control0..1
            TypeReference(ClaimResponse)
            Is Modifierfalse
            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()))
            148. ClaimResponse.error
            Definition

            Errors encountered during the processing of the adjudication.

            ShortErrors encountered during the processing of the adjudication.Processing 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
            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()))
            150. ClaimResponse.error.extension
            Definition

            An Extension


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

            ShortExtensionAdditional content defined by implementations
            Comments

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

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

              ErrorExtensionExpression

              ShortErrorExtensionExpression
              Control0..1
              This element is affected by the following invariants: ele-1
              TypeExtension(ErrorExtensionExpression) (Extension Type: string)
              Is Modifierfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              154. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

              ShortExtensions that cannot be ignored even if unrecognized
              Comments

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

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

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

              Alternate Namesextensions, user content, modifiers
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              156. 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.

              ShortThe sequence number of the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.Item sequence number
              Control0..1
              TypepositiveInt
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              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()))
              158. 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.

              ShortThe 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.Detail sequence number
              Control0..1
              TypepositiveInt
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              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()))
              160. 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.

              ShortThe 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.Subdetail sequence number
              Control0..1
              TypepositiveInt
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              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()))
              162. ClaimResponse.error.code
              Definition

              An error code, from a specified code system, which details why the claim could not be adjudicated.

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

              The adjudication error codes.

              TypeCodeableConcept
              Is Modifierfalse
              Summaryfalse
              Requirements

              Required to convey processing errors.

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

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

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

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

              ShortUnique string for reference purposes
              Comments

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

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

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

              ShortAdditional content defined by implementations
              Comments

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

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

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

                ShortWhen the resource version last changed
                Comments

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

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

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

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

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

                Control1..*
                Typecanonical(StructureDefinition)
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                18. 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 All Security Labels
                (extensible to http://hl7.org/fhir/ValueSet/security-labels)

                Security Labels from the Healthcare Privacy and Security Classification System.

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

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

                TypeCoding
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                22. 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 it's narrative along with other profiles, value sets, etc.

                Control0..1
                Typeuri
                Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                24. 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 SHOULD be taken from CommonLanguages
                (preferred to http://hl7.org/fhir/ValueSet/languages)

                A human language.

                Additional BindingsPurpose
                AllLanguagesMax Binding
                Typecode
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                26. 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 narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

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

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

                ShortContained, inline Resources
                Comments

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

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

                An Extension

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

                  create extension to hold the DRG - Codesystem (AR DRG) and Valueset Required

                  ShortExtension for Diagnosis Related Group
                  Control0..1
                  This element is affected by the following invariants: ele-1
                  TypeExtension(Extension for Diagnosis Related Group) (Extension Type: CodeableConcept)
                  Is Modifierfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  34. ClaimResponse.extension:reissueReason
                  Slice NamereissueReason
                  Definition

                  The reason the adjudicator has reissued an authroization or claim response.

                  ShortReissueReason
                  Control0..1
                  This element is affected by the following invariants: ele-1
                  TypeExtension(ReissueReason) (Extension Type: CodeableConcept)
                  Is Modifierfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  36. ClaimResponse.extension:adjudicationOutcome
                  Slice NameadjudicationOutcome
                  Definition

                  A code indicating the outcome of the adjudication such as rejected, partially approved/paid or approved/paid as submitted.

                  ShortAdjudicationOutcome
                  Control0..1
                  This element is affected by the following invariants: ele-1
                  TypeExtension(AdjudicationOutcome) (Extension Type: CodeableConcept)
                  Is Modifierfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  38. ClaimResponse.extension:transferAuthorizationNumber
                  Slice NametransferAuthorizationNumber
                  Definition

                  A number assigned to the transfer authorization.

                  ShortTransferAuthorizationNumber
                  Control0..1
                  This element is affected by the following invariants: ele-1
                  TypeExtension(TransferAuthorizationNumber) (Extension Type: string)
                  Is Modifierfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  40. ClaimResponse.extension:transferAuthorizationPeriod
                  Slice NametransferAuthorizationPeriod
                  Definition

                  A period of time during which the transfer authorization is valid.

                  ShortTransferAuthorizationPeriod
                  Control0..1
                  This element is affected by the following invariants: ele-1
                  TypeExtension(TransferAuthorizationPeriod) (Extension Type: Period)
                  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())
                  42. ClaimResponse.extension:transferAuthorizationProvider
                  Slice NametransferAuthorizationProvider
                  Definition

                  The provider who is authorized to provide the service.

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

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

                  ShortExtensions that cannot be ignored
                  Comments

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

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

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

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

                  A unique identifier assigned to this claim response.

                  ShortA unique identifier assigned to this claim response.
                  NoteThis is a business identifier, not a resource identifier (see discussion)
                  Control1..1
                  TypeIdentifier
                  Is Modifierfalse
                  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()))
                  48. ClaimResponse.status
                  Definition

                  The status of the resource instance.

                  ShortThe status of the resource instance.
                  Comments

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

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

                  A code specifying the state of the resource instance.

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

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

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

                  ShortA finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.
                  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)

                  The type or discipline-style of the claim.

                  TypeCodeableConcept
                  Is Modifierfalse
                  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()))
                  52. 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.

                  ShortA finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.
                  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)

                  A more granular claim typecode.

                  TypeCodeableConcept
                  Is Modifierfalse
                  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()))
                  54. ClaimResponse.use
                  Definition

                  A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.

                  ShortA code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.
                  Control1..1
                  BindingThe codes SHALL be taken from Use
                  (required to http://hl7.org/fhir/ValueSet/claim-use|4.0.1)

                  Claim, preauthorization, predetermination.

                  Typecode
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  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()))
                  56. 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 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.
                  Control1..1
                  TypeReference(Patient)
                  Is Modifierfalse
                  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()))
                  58. ClaimResponse.created
                  Definition

                  The date this resource was created.

                  ShortThe date this resource was created.
                  Control1..1
                  TypedateTime
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

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

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

                  The party responsible for authorization, adjudication and reimbursement.

                  ShortThe party responsible for authorization, adjudication and reimbursement.
                  Control1..1
                  TypeReference(Organization)
                  Is Modifierfalse
                  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()))
                  62. ClaimResponse.requestor
                  Definition

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

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

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

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

                  Original request resource reference.

                  ShortOriginal request resource reference.
                  Control1..1
                  TypeReference(Claim)
                  Is Modifierfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  66. ClaimResponse.outcome
                  Definition

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

                  ShortThe outcome of the claim, predetermination, or preauthorization processing.
                  Comments

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

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

                  The result of the claim processing.

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

                  To advise the requestor of an overall processing outcome.

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

                  A human readable description of the status of the adjudication.

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

                  Provided for user display.

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

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

                  ShortReference from the Insurer which is used in later communications which refers to this adjudication.
                  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
                  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()))
                  72. ClaimResponse.preAuthPeriod
                  Definition

                  The time frame during which this authorization is effective.

                  ShortThe time frame during which this authorization is effective.
                  Control0..1
                  TypePeriod
                  Is Modifierfalse
                  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()))
                  74. ClaimResponse.payeeType
                  Definition

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

                  ShortType of Party to be reimbursed: subscriber, provider, other.
                  Control0..1
                  BindingFor example codes, see Claim Payee Type Codes
                  (example to http://hl7.org/fhir/ValueSet/payeetype)

                  A code for the party to be reimbursed.

                  TypeCodeableConcept
                  Is Modifierfalse
                  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()))
                  76. 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.

                  ShortA 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.
                  Control0..*
                  TypeBackboneElement
                  Is Modifierfalse
                  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()))
                  78. 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
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  80. ClaimResponse.item.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.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 82. ClaimResponse.item.extension:adjudicationOutcome
                    Slice NameadjudicationOutcome
                    Definition

                    A code indicating the outcome of the adjudication such as rejected, partially approved/paid or approved/paid as submitted.

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

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

                    ShortExtensions that cannot be ignored even if unrecognized
                    Comments

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

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

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

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

                    A number to uniquely reference the claim item entries.

                    ShortA number to uniquely reference the claim detail entry.
                    Control1..1
                    TypepositiveInt
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    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()))
                    88. ClaimResponse.item.noteNumber
                    Definition

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

                    ShortThe numbers associated with notes below which apply to the adjudication of this item.
                    Control0..*
                    TypepositiveInt
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    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()))
                    90. 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.

                    ShortIf 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.
                    Control1..*
                    TypeBackboneElement
                    Is Modifierfalse
                    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()))
                    92. 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
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    94. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    ShortAdditional content defined by implementations
                    Comments

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

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

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

                    ShortExtensions that cannot be ignored even if unrecognized
                    Comments

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

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

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

                    Alternate Namesextensions, user content, modifiers
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    98. 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.

                    ShortIf 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.
                    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)

                    The adjudication codes.

                    TypeCodeableConcept
                    Is Modifierfalse
                    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()))
                    100. ClaimResponse.item.adjudication.reason
                    Definition

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

                    ShortA code supporting the understanding of the adjudication result and explaining variance from expected amount.
                    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)

                    The adjudication reason codes.

                    TypeCodeableConcept
                    Is Modifierfalse
                    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()))
                    102. ClaimResponse.item.adjudication.amount
                    Definition

                    Monetary amount associated with the category.

                    ShortMonetary amount associated with the category.
                    Comments

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

                    Control0..1
                    TypeMoney
                    Is Modifierfalse
                    Summaryfalse
                    Requirements

                    Most adjuciation categories convey a monetary amount.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    104. ClaimResponse.item.adjudication.value
                    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
                    Typedecimal
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    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()))
                    106. ClaimResponse.item.detail
                    Definition

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

                    ShortA claim detail. Either a simple (a product or service) or a 'group' of sub-details which are simple items.
                    Control0..*
                    TypeBackboneElement
                    Is Modifierfalse
                    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()))
                    108. 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
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    110. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    ShortAdditional content defined by implementations
                    Comments

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

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

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

                    ShortExtensions that cannot be ignored even if unrecognized
                    Comments

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

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

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

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

                    A number to uniquely reference the claim detail entry.

                    ShortA number to uniquely reference the claim detail entry.
                    Control1..1
                    TypepositiveInt
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    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()))
                    116. 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
                    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()))
                    118. ClaimResponse.item.detail.adjudication
                    Definition

                    The adjudication results.

                    ShortThe adjudication results.
                    Control1..*
                    TypeBackboneElement
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    120. ClaimResponse.item.detail.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
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    122. ClaimResponse.item.detail.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    ShortAdditional content defined by implementations
                    Comments

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

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

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

                    ShortExtensions that cannot be ignored even if unrecognized
                    Comments

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

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

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

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

                    ShortA 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.
                    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)

                    The adjudication codes.

                    TypeCodeableConcept
                    Is Modifierfalse
                    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()))
                    128. ClaimResponse.item.detail.adjudication.reason
                    Definition

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

                    ShortA code supporting the understanding of the adjudication result and explaining variance from expected amount.
                    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)

                    The adjudication reason codes.

                    TypeCodeableConcept
                    Is Modifierfalse
                    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()))
                    130. ClaimResponse.item.detail.adjudication.amount
                    Definition

                    Monetary amount associated with the category.

                    ShortMonetary amount associated with the category.
                    Comments

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

                    Control0..1
                    TypeMoney
                    Is Modifierfalse
                    Summaryfalse
                    Requirements

                    Most adjuciation categories convey a monetary amount.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    132. ClaimResponse.item.detail.adjudication.value
                    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
                    Typedecimal
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    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()))
                    134. ClaimResponse.item.detail.subDetail
                    Definition

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

                    ShortA sub-detail adjudication of a simple product or service.
                    Control0..*
                    TypeBackboneElement
                    Is Modifierfalse
                    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()))
                    136. 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
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    138. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    ShortAdditional content defined by implementations
                    Comments

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

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

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

                    ShortExtensions that cannot be ignored even if unrecognized
                    Comments

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

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

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

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

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

                    ShortA number to uniquely reference the claim sub-detail entry.
                    Control1..1
                    TypepositiveInt
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    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()))
                    144. ClaimResponse.item.detail.subDetail.noteNumber
                    Definition

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

                    ShortThe numbers associated with notes below which apply to the adjudication of this item.
                    Control0..*
                    TypepositiveInt
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    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()))
                    146. ClaimResponse.item.detail.subDetail.adjudication
                    Definition

                    The adjudication results.

                    ShortThe adjudication results.
                    Control1..*
                    TypeBackboneElement
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    148. ClaimResponse.item.detail.subDetail.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
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    150. ClaimResponse.item.detail.subDetail.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    ShortAdditional content defined by implementations
                    Comments

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

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

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

                    ShortExtensions that cannot be ignored even if unrecognized
                    Comments

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

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

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

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

                    ShortA 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.
                    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)

                    The adjudication codes.

                    TypeCodeableConcept
                    Is Modifierfalse
                    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()))
                    156. ClaimResponse.item.detail.subDetail.adjudication.reason
                    Definition

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

                    ShortA code supporting the understanding of the adjudication result and explaining variance from expected amount.
                    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)

                    The adjudication reason codes.

                    TypeCodeableConcept
                    Is Modifierfalse
                    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()))
                    158. ClaimResponse.item.detail.subDetail.adjudication.amount
                    Definition

                    Monetary amount associated with the category.

                    ShortMonetary amount associated with the category.
                    Comments

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

                    Control0..1
                    TypeMoney
                    Is Modifierfalse
                    Summaryfalse
                    Requirements

                    Most adjuciation categories convey a monetary amount.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    160. ClaimResponse.item.detail.subDetail.adjudication.value
                    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
                    Typedecimal
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    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()))
                    162. ClaimResponse.addItem
                    Definition

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

                    ShortInsurer added line items
                    Control0..*
                    TypeBackboneElement
                    Is Modifierfalse
                    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()))
                    164. 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
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    166. ClaimResponse.addItem.extension
                    Definition

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

                    ShortAdditional content defined by implementations
                    Comments

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

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

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

                    ShortExtensions that cannot be ignored even if unrecognized
                    Comments

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

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

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

                    Alternate Namesextensions, user content, modifiers
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    170. 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
                    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()))
                    172. 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
                    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()))
                    174. 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
                    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()))
                    176. 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
                    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()))
                    178. ClaimResponse.addItem.productOrService
                    Definition

                    When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

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

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

                    Allowable service and product codes.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Summaryfalse
                    Requirements

                    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()))
                    180. 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)

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

                    TypeCodeableConcept
                    Is Modifierfalse
                    Summaryfalse
                    Requirements

                    To support 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()))
                    182. 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)

                    Program specific reason codes.

                    TypeCodeableConcept
                    Is Modifierfalse
                    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()))
                    184. 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
                    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()))
                    186. 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)

                    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
                    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()))
                    188. ClaimResponse.addItem.quantity
                    Definition

                    The number of repetitions of a service or product.

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

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

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    190. 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
                    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()))
                    192. 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
                    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()))
                    194. ClaimResponse.addItem.net
                    Definition

                    The quantity times the unit price for an additional service or product or charge.

                    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
                    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()))
                    196. ClaimResponse.addItem.bodySite
                    Definition

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

                    ShortAnatomical location
                    Comments

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

                    Control0..1
                    BindingFor example codes, see OralSiteCodes
                    (example to http://hl7.org/fhir/ValueSet/tooth)

                    The code for the teeth, quadrant, sextant and arch.

                    TypeCodeableConcept
                    Is Modifierfalse
                    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()))
                    198. ClaimResponse.addItem.subSite
                    Definition

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

                    ShortAnatomical sub-location
                    Control0..*
                    BindingFor example codes, see SurfaceCodes
                    (example to http://hl7.org/fhir/ValueSet/surface)

                    The code for the tooth surface and surface combinations.

                    TypeCodeableConcept
                    Is Modifierfalse
                    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()))
                    200. 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
                    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()))
                    202. ClaimResponse.addItem.adjudication
                    Definition

                    The adjudication results.

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

                    The second-tier service adjudications for payor added services.

                    ShortInsurer added line details
                    Control0..*
                    TypeBackboneElement
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    206. 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
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    208. ClaimResponse.addItem.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    ShortAdditional content defined by implementations
                    Comments

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

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

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

                    ShortExtensions that cannot be ignored even if unrecognized
                    Comments

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

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

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

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

                    When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

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

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

                    Allowable service and product codes.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Summaryfalse
                    Requirements

                    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()))
                    214. 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)

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

                    TypeCodeableConcept
                    Is Modifierfalse
                    Summaryfalse
                    Requirements

                    To support 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()))
                    216. 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
                    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()))
                    218. 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
                    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()))
                    220. 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
                    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()))
                    222. ClaimResponse.addItem.detail.net
                    Definition

                    The quantity times the unit price for an additional service or product or charge.

                    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
                    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()))
                    224. 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
                    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()))
                    226. ClaimResponse.addItem.detail.adjudication
                    Definition

                    The adjudication results.

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

                    The third-tier service adjudications for payor added services.

                    ShortInsurer added line items
                    Control0..*
                    TypeBackboneElement
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    230. 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
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    232. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    ShortAdditional content defined by implementations
                    Comments

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

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

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

                    ShortExtensions that cannot be ignored even if unrecognized
                    Comments

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

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

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

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

                    When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

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

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

                    Allowable service and product codes.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Summaryfalse
                    Requirements

                    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()))
                    238. 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)

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

                    TypeCodeableConcept
                    Is Modifierfalse
                    Summaryfalse
                    Requirements

                    To support 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()))
                    240. 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
                    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()))
                    242. 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
                    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()))
                    244. 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
                    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()))
                    246. ClaimResponse.addItem.detail.subDetail.net
                    Definition

                    The quantity times the unit price for an additional service or product or charge.

                    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
                    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()))
                    248. 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
                    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()))
                    250. ClaimResponse.addItem.detail.subDetail.adjudication
                    Definition

                    The adjudication results.

                    ShortAdded items detail adjudication
                    Control1..*
                    TypeSeettp://hl7.org/fhir/StructureDefinition/ClaimResponse#ClaimResponse.item.adjudication
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    252. 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
                    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()))
                    254. ClaimResponse.total
                    Definition

                    Categorized monetary totals for the adjudication.

                    ShortCategorized monetary totals for the adjudication.
                    Comments

                    Totals for amounts submitted, co-pays, benefits payable etc.

                    Control0..*
                    TypeBackboneElement
                    Is Modifierfalse
                    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()))
                    256. 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
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    258. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    ShortAdditional content defined by implementations
                    Comments

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

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

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

                    ShortExtensions that cannot be ignored even if unrecognized
                    Comments

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

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

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

                    Alternate Namesextensions, user content, modifiers
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    262. 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.

                    ShortA 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.
                    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)

                    The adjudication codes.

                    TypeCodeableConcept
                    Is Modifierfalse
                    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()))
                    264. ClaimResponse.total.amount
                    Definition

                    Monetary total amount associated with the category.

                    ShortMonetary total amount associated with the category.
                    Control1..1
                    TypeMoney
                    Is Modifierfalse
                    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()))
                    266. ClaimResponse.payment
                    Definition

                    Payment details for the adjudication of the claim.

                    ShortPayment Details
                    Control0..1
                    TypeBackboneElement
                    Is Modifierfalse
                    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()))
                    268. 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
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    270. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    ShortAdditional content defined by implementations
                    Comments

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

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

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

                    ShortExtensions that cannot be ignored even if unrecognized
                    Comments

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

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

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

                    Alternate Namesextensions, user content, modifiers
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    274. 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)

                    The type (partial, complete) of the payment.

                    TypeCodeableConcept
                    Is Modifierfalse
                    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()))
                    276. 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
                    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()))
                    278. 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)

                    Payment Adjustment reason codes.

                    TypeCodeableConcept
                    Is Modifierfalse
                    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()))
                    280. 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
                    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()))
                    282. ClaimResponse.payment.amount
                    Definition

                    Benefits payable less any payment adjustment.

                    ShortPayable amount after adjustment
                    Control1..1
                    TypeMoney
                    Is Modifierfalse
                    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()))
                    284. 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
                    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()))
                    286. 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.

                    ShortA code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.
                    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 Funds Reservation Codes
                    (example to http://hl7.org/fhir/ValueSet/fundsreserve)

                    For whom funds are to be reserved: (Patient, Provider, None).

                    TypeCodeableConcept
                    Is Modifierfalse
                    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()))
                    288. 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 Form Codes
                    (example to http://hl7.org/fhir/ValueSet/forms)

                    The forms codes.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Summaryfalse
                    Requirements

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

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    290. 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
                    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()))
                    292. ClaimResponse.processNote
                    Definition

                    A note that describes or explains adjudication results in a human readable form.

                    ShortA note that describes or explains adjudication results in a human readable form.
                    Control0..*
                    TypeBackboneElement
                    Is Modifierfalse
                    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()))
                    294. 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
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    296. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    ShortAdditional content defined by implementations
                    Comments

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

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

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

                    ShortExtensions that cannot be ignored even if unrecognized
                    Comments

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

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

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

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

                    A number to uniquely identify a note entry.

                    ShortA number to uniquely identify a note entry.
                    Control1..1
                    TypepositiveInt
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    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()))
                    302. ClaimResponse.processNote.type
                    Definition

                    The business purpose of the note text.

                    ShortThe business purpose of the note text.
                    Control1..1
                    BindingThe codes SHALL be taken from NoteType
                    (required to http://hl7.org/fhir/ValueSet/note-type|4.0.1)

                    The presentation types of notes.

                    Typecode
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    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()))
                    304. ClaimResponse.processNote.text
                    Definition

                    The explanation or description associated with the processing.

                    ShortThe explanation or description associated with the processing.
                    Control1..1
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    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()))
                    306. ClaimResponse.processNote.language
                    Definition

                    A code to define the language used in the text of the note.

                    ShortA code to define the language used in the text of the note.
                    Comments

                    Only required if the language is different from the resource language.

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

                    A human language.

                    Additional BindingsPurpose
                    AllLanguagesMax Binding
                    TypeCodeableConcept
                    Is Modifierfalse
                    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()))
                    308. ClaimResponse.communicationRequest
                    Definition

                    Request for additional supporting or authorizing information.

                    ShortRequest for additional supporting or authorizing information.
                    Comments

                    For example: professional reports, documents, images, clinical resources, or accident reports.

                    Control0..1
                    TypeReference(CommunicationRequest)
                    Is Modifierfalse
                    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()))
                    310. ClaimResponse.insurance
                    Definition

                    Financial instruments for reimbursement for the health care products and services specified on the claim.

                    ShortFinancial instruments for reimbursement for the health care products and services specified on the claim.
                    Comments

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

                    Control0..*
                    TypeBackboneElement
                    Is Modifierfalse
                    Summaryfalse
                    Requirements

                    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()))
                    312. 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
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    314. ClaimResponse.insurance.extension
                    Definition

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

                    ShortAdditional content defined by implementations
                    Comments

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

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

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

                    ShortExtensions that cannot be ignored even if unrecognized
                    Comments

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

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

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

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

                    A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.

                    ShortA number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.
                    Control1..1
                    TypepositiveInt
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    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()))
                    320. ClaimResponse.insurance.focal
                    Definition

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

                    ShortA flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.
                    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
                    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()))
                    322. 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.

                    ShortReference 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.
                    Control1..1
                    TypeReference(Coverage)
                    Is Modifierfalse
                    Summaryfalse
                    Requirements

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

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    324. 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
                    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()))
                    326. ClaimResponse.insurance.claimResponse
                    Definition

                    The result of the adjudication of the line items for the Coverage specified in this insurance.

                    ShortThe result of the adjudication of the line items for the Coverage specified. This is used when an insurer is able to not just adjudicate the claim they were sent but also able to detect that they are the processor for the sebsequent claims and can adjudicate them too.
                    Comments

                    Must not be specified when 'focal=true' for this insurance.

                    Control0..1
                    TypeReference(ClaimResponse)
                    Is Modifierfalse
                    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()))
                    328. ClaimResponse.error
                    Definition

                    Errors encountered during the processing of the adjudication.

                    ShortErrors encountered during the processing of the adjudication.
                    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
                    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()))
                    330. 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
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    332. ClaimResponse.error.extension
                    Definition

                    An Extension

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

                      ErrorExtensionExpression

                      ShortErrorExtensionExpression
                      Control0..1
                      This element is affected by the following invariants: ele-1
                      TypeExtension(ErrorExtensionExpression) (Extension Type: string)
                      Is Modifierfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      336. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                      ShortExtensions that cannot be ignored even if unrecognized
                      Comments

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

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

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

                      Alternate Namesextensions, user content, modifiers
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      338. 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.

                      ShortThe sequence number of the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.
                      Control0..1
                      TypepositiveInt
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      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()))
                      340. 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.

                      ShortThe 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.
                      Control0..1
                      TypepositiveInt
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      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()))
                      342. 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.

                      ShortThe 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.
                      Control0..1
                      TypepositiveInt
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      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()))
                      344. ClaimResponse.error.code
                      Definition

                      An error code, from a specified code system, which details why the claim could not be adjudicated.

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

                      The adjudication error codes.

                      TypeCodeableConcept
                      Is Modifierfalse
                      Summaryfalse
                      Requirements

                      Required to convey processing errors.

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