PackagesCanonicalsLogsProblems
    Packages
    hl7.fhir.r5.examples@4.2.0
    http://hl7.org/fhir/StructureDefinition/Invoice
description: Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.
package_name: hl7.fhir.r5.examples
derivation: specialization
name: Invoice
type: Invoice
elements:
  date: {short: Invoice date / posting date, type: dateTime, isSummary: true, index: 6}
  totalNet: {short: Net total of this Invoice, type: Money, isSummary: true, index: 24}
  recipient:
    short: Recipient of this invoice
    refers: ['http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson']
    type: Reference
    isSummary: true
    index: 5
  totalPriceComponent:
    elementReference: ['http://hl7.org/fhir/StructureDefinition/Invoice', elements, lineItem, elements, priceComponent]
    short: Components of Invoice total
    array: true
    isSummary: false
    index: 23
  type: {short: Type of Invoice, type: CodeableConcept, isSummary: true, index: 3}
  totalGross: {short: Gross total of this Invoice, type: Money, isSummary: true, index: 25}
  participant:
    short: Participant in creation of this Invoice
    type: BackboneElement
    array: true
    isSummary: false
    index: 7
    elements:
      role: {short: Type of involvement in creation of this Invoice, type: CodeableConcept, isSummary: false, index: 8}
      actor:
        short: Individual who was involved
        refers: ['http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson']
        type: Reference
        isSummary: false
        index: 9
    required: [actor]
  note: {short: Comments made about the invoice, type: Annotation, array: true, isSummary: false, index: 27}
  account:
    short: Account that is being balanced
    refers: ['http://hl7.org/fhir/StructureDefinition/Account']
    type: Reference
    isSummary: false
    index: 11
  status:
    isModifier: true
    short: draft | issued | balanced | cancelled | entered-in-error
    type: code
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/invoice-status|4.2.0'}
    isModifierReason: This element is labelled 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
    isSummary: true
    index: 1
  lineItem:
    short: Line items of this Invoice
    type: BackboneElement
    array: true
    isSummary: false
    index: 12
    elements:
      sequence: {type: positiveInt, short: Sequence number of line item, isSummary: false, index: 13}
      chargeItem:
        short: Reference to ChargeItem containing details of this line item or an inline billing code
        choices: [chargeItemReference, chargeItemCodeableConcept]
        isSummary: false
        index: 15
      chargeItemReference:
        short: Reference to ChargeItem containing details of this line item or an inline billing code
        refers: ['http://hl7.org/fhir/StructureDefinition/ChargeItem']
        type: Reference
        choiceOf: chargeItem
        isSummary: false
        index: 16
      chargeItemCodeableConcept: {short: Reference to ChargeItem containing details of this line item or an inline billing code, type: CodeableConcept, choiceOf: chargeItem, isSummary: false, index: 17}
      priceComponent:
        short: Components of total line item price
        type: BackboneElement
        array: true
        isSummary: false
        index: 18
        elements:
          type:
            short: base | surcharge | deduction | discount | tax | informational
            type: code
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.2.0'}
            isSummary: false
            index: 19
          code: {short: Code identifying the specific component, type: CodeableConcept, isSummary: false, index: 20}
          factor: {short: Factor used for calculating this component, type: decimal, isSummary: false, index: 21}
          amount: {short: Monetary amount associated with this component, type: Money, isSummary: false, index: 22}
        required: [type]
    required: [chargeItem, chargeItemReference, chargeItemCodeableConcept]
  identifier: {short: Business Identifier for item, type: Identifier, array: true, isSummary: true, index: 0}
  issuer:
    short: Issuing Organization of Invoice
    refers: ['http://hl7.org/fhir/StructureDefinition/Organization']
    type: Reference
    isSummary: false
    index: 10
  cancelledReason: {short: Reason for cancellation of this Invoice, type: string, isSummary: false, index: 2}
  paymentTerms: {short: Payment details, type: markdown, isSummary: false, index: 26}
  subject:
    short: Recipient(s) of goods and services
    refers: ['http://hl7.org/fhir/StructureDefinition/Group', 'http://hl7.org/fhir/StructureDefinition/Patient']
    type: Reference
    isSummary: true
    index: 4
package_version: 4.2.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/Invoice
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 4.2.0
required: [status]