PackagesCanonicalsLogsProblems
    Packages
    hl7.fhir.core@1.8.0
    http://hl7.org/fhir/StructureDefinition/ClaimResponse
description: Base StructureDefinition for ClaimResponse Resource
package_name: hl7.fhir.core
derivation: specialization
name: ClaimResponse
type: ClaimResponse
elements:
  requestOrganization:
    short: Responsible organization
    refers: ['http://hl7.org/fhir/StructureDefinition/Organization']
    type: Reference
    index: 5
  payeeType: {type: CodeableConcept, short: Party to be paid any benefits payable, index: 9}
  insurance:
    short: Insurance or medical plan
    type: BackboneElement
    array: true
    index: 66
    elements:
      sequence: {type: positiveInt, short: Service instance identifier, index: 67}
      focal: {type: boolean, short: Is the focal Coverage, index: 68}
      coverage:
        short: Insurance information
        refers: ['http://hl7.org/fhir/StructureDefinition/Coverage']
        type: Reference
        index: 69
      businessArrangement: {type: string, short: Business agreement, index: 70}
      preAuthRef: {short: Pre-Authorization/Determination Reference, type: string, array: true, index: 71}
      claimResponse:
        short: Adjudication results
        refers: ['http://hl7.org/fhir/StructureDefinition/ClaimResponse']
        type: Reference
        index: 72
    required: [coverage, focal, sequence]
  request:
    short: Id of resource triggering adjudication
    refers: ['http://hl7.org/fhir/StructureDefinition/Claim']
    type: Reference
    index: 6
  requestProvider:
    short: Responsible practitioner
    refers: ['http://hl7.org/fhir/StructureDefinition/Practitioner']
    type: Reference
    index: 4
  payment:
    type: BackboneElement
    short: Payment details, if paid
    index: 51
    elements:
      type: {type: CodeableConcept, short: Partial or Complete, index: 52}
      adjustment: {type: Money, short: Payment adjustment for non-Claim issues, index: 53}
      adjustmentReason: {type: CodeableConcept, short: Reason for Payment adjustment, index: 54}
      date: {type: date, short: Expected data of Payment, index: 55}
      amount: {type: Money, short: Payment amount, index: 56}
      identifier: {type: Identifier, short: Payment identifier, index: 57}
  item:
    type: BackboneElement
    short: Line items
    array: true
    index: 10
    elements:
      sequenceLinkId: {type: positiveInt, short: Service instance, index: 11}
      noteNumber: {type: positiveInt, short: List of note numbers which apply, array: true, index: 12}
      adjudication:
        type: BackboneElement
        short: Adjudication details
        array: true
        index: 13
        elements:
          category: {type: CodeableConcept, short: 'Adjudication category such as co-pay, eligible, benefit, etc.', index: 14}
          reason: {type: CodeableConcept, short: Adjudication reason, index: 15}
          amount: {type: Money, short: Monetary amount, index: 16}
          value: {type: decimal, short: Non-monetary value, index: 17}
        required: [category]
      detail:
        type: BackboneElement
        short: Detail line items
        array: true
        index: 18
        elements:
          sequenceLinkId: {type: positiveInt, short: Service instance, index: 19}
          noteNumber: {type: positiveInt, short: List of note numbers which apply, array: true, index: 20}
          adjudication:
            short: Detail adjudication
            elementReference: ['http://hl7.org/fhir/StructureDefinition/ClaimResponse', elements, item, elements, adjudication]
            array: true
            index: 21
          subDetail:
            type: BackboneElement
            short: Subdetail line items
            array: true
            index: 22
            elements:
              sequenceLinkId: {type: positiveInt, short: Service instance, index: 23}
              noteNumber: {type: positiveInt, short: List of note numbers which apply, array: true, index: 24}
              adjudication:
                short: Subdetail adjudication
                elementReference: ['http://hl7.org/fhir/StructureDefinition/ClaimResponse', elements, item, elements, adjudication]
                array: true
                index: 25
            required: [sequenceLinkId]
        required: [sequenceLinkId]
    required: [sequenceLinkId]
  created: {type: dateTime, short: Creation date, index: 2}
  outcome: {type: CodeableConcept, short: complete | error | partial, index: 7}
  totalBenefit: {type: Money, short: Total benefit payable for the Claim, index: 50}
  unallocDeductable: {type: Money, short: Unallocated deductible, index: 49}
  disposition: {type: string, short: Disposition Message, index: 8}
  communicationRequest:
    type: Reference
    short: Request for additional information
    refers: ['http://hl7.org/fhir/StructureDefinition/CommunicationRequest']
    array: true
    index: 65
  note:
    type: BackboneElement
    short: Processing notes
    array: true
    index: 60
    elements:
      number: {type: positiveInt, short: Note Number for this note, index: 61}
      type: {type: CodeableConcept, short: display | print | printoper, index: 62}
      text: {type: string, short: Note explanatory text, index: 63}
      language: {type: CodeableConcept, short: Language, index: 64}
  insurer:
    type: Reference
    short: Insurer
    refers: ['http://hl7.org/fhir/StructureDefinition/Organization']
    index: 3
  status: {isModifier: true, short: active | cancelled | draft | entered-in-error, type: code, isSummary: true, index: 1}
  identifier: {type: Identifier, short: Response  number, array: true, index: 0}
  reserved: {type: Coding, short: Funds reserved status, index: 58}
  error:
    type: BackboneElement
    short: Processing errors
    array: true
    index: 43
    elements:
      sequenceLinkId: {type: positiveInt, short: Item sequence number, index: 44}
      detailSequenceLinkId: {type: positiveInt, short: Detail sequence number, index: 45}
      subdetailSequenceLinkId: {type: positiveInt, short: Subdetail sequence number, index: 46}
      code: {type: CodeableConcept, short: Error code detailing processing issues, index: 47}
    required: [code]
  form: {short: Printed Form Identifier, type: CodeableConcept, index: 59}
  totalCost: {type: Money, short: Total Cost of service from the Claim, index: 48}
  addItem:
    type: BackboneElement
    short: Insurer added line items
    array: true
    index: 26
    elements:
      category: {type: CodeableConcept, short: Type of service or product, index: 29}
      fee: {type: Money, short: Professional fee or Product charge, index: 32}
      service: {type: CodeableConcept, short: 'Group, Service or Product', index: 30}
      modifier: {short: Service/Product billing modifiers, type: CodeableConcept, array: true, index: 31}
      revenue: {type: CodeableConcept, short: Revenue or cost center code, index: 28}
      adjudication:
        short: Added items adjudication
        elementReference: ['http://hl7.org/fhir/StructureDefinition/ClaimResponse', elements, item, elements, adjudication]
        array: true
        index: 34
      sequenceLinkId: {type: positiveInt, short: Service instances, array: true, index: 27}
      noteNumber: {type: positiveInt, short: List of note numbers which apply, array: true, index: 33}
      detail:
        type: BackboneElement
        short: Added items details
        array: true
        index: 35
        elements:
          revenue: {type: CodeableConcept, short: Revenue or cost center code, index: 36}
          category: {type: CodeableConcept, short: Type of service or product, index: 37}
          service: {type: CodeableConcept, short: Service or Product, index: 38}
          modifier: {short: Service/Product billing modifiers, type: CodeableConcept, array: true, index: 39}
          fee: {type: Money, short: Professional fee or Product charge, index: 40}
          noteNumber: {type: positiveInt, short: List of note numbers which apply, array: true, index: 41}
          adjudication:
            short: Added items detail adjudication
            elementReference: ['http://hl7.org/fhir/StructureDefinition/ClaimResponse', elements, item, elements, adjudication]
            array: true
            index: 42
package_version: 1.8.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/ClaimResponse
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: null