R4 Ballot #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.5.0: R4 Ballot #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

8.32 Resource Invoice - Content

Financial Management Work GroupMaturity Level: 0 Trial Use Compartments: Device, Patient, Practitioner, RelatedPerson

Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.

8.32.1 Scope and Usage

Tracking Financial information is vital in Patient Administration and Finance systems in most Healthcare Organizations. An invoice is a financial document issued by a healthcare provider to a patient or a payer indicating the goods and services (ChargeItems) performed with their quantities and prices.

Example implementations:

  • Any solution that tracks billing information and needs to issue invoices
  • Private Insurance Providers who want to deliver structured information to patients to increase cost transparency
  • Patient apps that want to include information on the amount and reason of the charged costs for the healthcare services a patient received

8.32.2 Boundaries and Relationships

The existing Claim resource is constricted to use cases where Claims are sent to insurances for reimbursement, in a message-like style. It neither references ChargeItems nor Accounts.

Competing invoicing standards such as EDIFACT or X12 are aiming at inter-organisational exchange and do not offer human readable representations or traceable links to services rendered which is a requirement for invoicing towards patients. This resource is used where existing ChargeItems in an Account are collected to create an Invoice to be sent out to Individuals or Organizations in a structured way. The invoice is the hospital’s view, whereas the Claim is the payer’s view on the performed services.

Since the indiviual ChargeItem resources that make the line items of the Invoice do not carry any pricing information, ChargeItemDefinitions will have to be applied to the ChargeItems in order to calculate the price components for the Invoice depending on the context of the ChargeItem

8.32.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Invoice TUDomainResourceInvoice containing ChargeItems from an Account
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierBusiness Identifier for item
... status ?!Σ1..1codedraft | issued | balanced | cancelled | entered-in-error
InvoiceStatus (Required)
... cancelledReason 0..1stringReason for cancellation of this Invoice
... type Σ0..1CodeableConceptType of Invoice
... subject Σ0..1Reference(Patient | Group)Recipient(s) of goods and services
... recipient Σ0..1Reference(Organization | Patient | RelatedPerson)Recipient of this invoice
... date Σ0..1dateTimeInvoice date / posting date
... participant 0..*BackboneElementParticipant in creation of this Invoice
.... role 0..1CodeableConceptType of involevent in creation of this Invoice
.... actor 1..1Reference(Practitioner | Organization | Patient | Device | RelatedPerson)Individual who was involved
... issuer 0..1Reference(Organization)Issuing Organization of Invoice
... account 0..1Reference(Account)Account that is being balanced
... lineItem 0..*BackboneElementLine items of this Invoice
.... sequence 0..1positiveIntSequence number of line item
.... chargeItem[x] 1..1Reference to ChargeItem containing details of this line item or an inline billing code
..... chargeItemReferenceReference(ChargeItem)
..... chargeItemCodeableConceptCodeableConcept
.... priceComponent 0..*BackboneElementComponents of total line item price
..... type 1..1codebase | surcharge | deduction | discount | tax | informational
InvoicePriceComponentType (Required)
..... code 0..1CodeableConceptCode identifying the specific component
..... factor 0..1decimalFactor used for calculating this component
..... amount 0..1MoneyMonetary amount associated with this component
... totalPriceComponent 0..*see priceComponentComponents of Invoice total
... totalNet Σ0..1MoneyNet total of this Invoice
... totalGross Σ0..1MoneyGross total of this Invoice
... paymentTerms 0..1markdownPayment details
... note 0..*AnnotationComments made about the invoice

doco Documentation for this format

UML Diagram (Legend)

Invoice (DomainResource)Identifier of this Invoice, often used for reference in corresponcence about this invoice or for tracking of paymentsidentifier : Identifier [0..*]The current state of the Invoice (this element modifies the meaning of other elements)status : code [1..1] « Codes identifying the lifecycle stage of an Invoice. (Strength=Required)InvoiceStatus! »In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.)cancelledReason : string [0..1]Type of Invoice depending on domain, realm an usage (eg. internal/external, dental, preliminary)type : CodeableConcept [0..1]The individual or set of individuals receiving the goods and services billed in this invoicesubject : Reference [0..1] « Patient|Group »The individual or Organization responsible for balancing of this invoicerecipient : Reference [0..1] « Organization|Patient|RelatedPerson »Date/time(s) of when this Invoice was posteddate : dateTime [0..1]The organizationissuing the Invoiceissuer : Reference [0..1] « Organization »Account which is supposed to be balanced with this Invoiceaccount : Reference [0..1] « Account »Invoice total , taxes excludedtotalNet : Money [0..1]Invoice total, tax includedtotalGross : Money [0..1]Payment details such as banking details, period of payment, deductables, methods of paymentpaymentTerms : markdown [0..1]Comments made about the invoice by the issuer, subject or other participantsnote : Annotation [0..*]ParticipantDescribes the type of involvement (e.g. transcriptionist, creator etc.). If the invoice has been created automatically, the Participant may be a billing engine or another kind of devicerole : CodeableConcept [0..1]The device, practitioner, etc. who performed or participated in the serviceactor : Reference [1..1] « Practitioner|Organization|Patient|Device| RelatedPerson »LineItemSequence in which the items appear on the invoicesequence : positiveInt [0..1]The ChargeItem contains information such as the billing code, date, amount etc. Of no further details are required for the lineItem, inline billing codes can be added using the CodeableConcept data type instead of the ReferencechargeItem[x] : Type [1..1] « Reference(ChargeItem)|CodeableConcept »PriceComponentThis code identifies the type of the componenttype : code [1..1] « Codes indicating the kind of the price component. (Strength=Required)InvoicePriceComponentType! »A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etccode : CodeableConcept [0..1]The factor that has been applied on the base price for calculating this componentfactor : decimal [0..1]The amount calculated for this componentamount : Money [0..1]Indicates who or what performed or participated in the charged serviceparticipant[0..*]The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under developement. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the prices have been calculatedpriceComponent[0..*]Each line item represents one charge for goods ond services rendered. Details such as date, code and amount are found in the referenced ChargeItem resourcelineItem[0..*]The total amount for the Invoice may be calculated as the sum of the line items with surcharges/deductions that apply in certain conditions. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the total price was calculatedtotalPriceComponent[0..*]

XML Template

<Invoice xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business Identifier for item --></identifier>
 <status value="[code]"/><!-- 1..1 draft | issued | balanced | cancelled | entered-in-error -->
 <cancelledReason value="[string]"/><!-- 0..1 Reason for cancellation of this Invoice -->
 <type><!-- 0..1 CodeableConcept Type of Invoice --></type>
 <subject><!-- 0..1 Reference(Patient|Group) Recipient(s) of goods and services --></subject>
 <recipient><!-- 0..1 Reference(Organization|Patient|RelatedPerson) Recipient of this invoice --></recipient>
 <date value="[dateTime]"/><!-- 0..1 Invoice date / posting date -->
 <participant>  <!-- 0..* Participant in creation of this Invoice -->
  <role><!-- 0..1 CodeableConcept Type of involevent in creation of this Invoice --></role>
  <actor><!-- 1..1 Reference(Practitioner|Organization|Patient|Device|
    RelatedPerson) Individual who was involved --></actor>
 </participant>
 <issuer><!-- 0..1 Reference(Organization) Issuing Organization of Invoice --></issuer>
 <account><!-- 0..1 Reference(Account) Account that is being balanced --></account>
 <lineItem>  <!-- 0..* Line items of this Invoice -->
  <sequence value="[positiveInt]"/><!-- 0..1 Sequence number of line item -->
  <chargeItem[x]><!-- 1..1 Reference(ChargeItem)|CodeableConcept Reference to ChargeItem containing details of this line item or an inline billing code --></chargeItem[x]>
  <priceComponent>  <!-- 0..* Components of total line item price -->
   <type value="[code]"/><!-- 1..1 base | surcharge | deduction | discount | tax | informational -->
   <code><!-- 0..1 CodeableConcept Code identifying the specific component --></code>
   <factor value="[decimal]"/><!-- 0..1 Factor used for calculating this component -->
   <amount><!-- 0..1 Money Monetary amount associated with this component --></amount>
  </priceComponent>
 </lineItem>
 <totalPriceComponent><!-- 0..* Content as for Invoice.lineItem.priceComponent Components of Invoice total --></totalPriceComponent>
 <totalNet><!-- 0..1 Money Net total of this Invoice --></totalNet>
 <totalGross><!-- 0..1 Money Gross total of this Invoice --></totalGross>
 <paymentTerms value="[markdown]"/><!-- 0..1 Payment details -->
 <note><!-- 0..* Annotation Comments made about the invoice --></note>
</Invoice>

JSON Template

{doco
  "resourceType" : "Invoice",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifier for item
  "status" : "<code>", // R!  draft | issued | balanced | cancelled | entered-in-error
  "cancelledReason" : "<string>", // Reason for cancellation of this Invoice
  "type" : { CodeableConcept }, // Type of Invoice
  "subject" : { Reference(Patient|Group) }, // Recipient(s) of goods and services
  "recipient" : { Reference(Organization|Patient|RelatedPerson) }, // Recipient of this invoice
  "date" : "<dateTime>", // Invoice date / posting date
  "participant" : [{ // Participant in creation of this Invoice
    "role" : { CodeableConcept }, // Type of involevent in creation of this Invoice
    "actor" : { Reference(Practitioner|Organization|Patient|Device|
    RelatedPerson) } // R!  Individual who was involved
  }],
  "issuer" : { Reference(Organization) }, // Issuing Organization of Invoice
  "account" : { Reference(Account) }, // Account that is being balanced
  "lineItem" : [{ // Line items of this Invoice
    "sequence" : "<positiveInt>", // Sequence number of line item
    // chargeItem[x]: 
      Reference to ChargeItem containing details of this line item or an inline billing code. One of these 2:
    "chargeItemReference" : { Reference(ChargeItem) },
    "chargeItemCodeableConcept" : { CodeableConcept },
    "priceComponent" : [{ // Components of total line item price
      "type" : "<code>", // R!  base | surcharge | deduction | discount | tax | informational
      "code" : { CodeableConcept }, // Code identifying the specific component
      "factor" : <decimal>, // Factor used for calculating this component
      "amount" : { Money } // Monetary amount associated with this component
    }]
  }],
  "totalPriceComponent" : [{ Content as for Invoice.lineItem.priceComponent }], // Components of Invoice total
  "totalNet" : { Money }, // Net total of this Invoice
  "totalGross" : { Money }, // Gross total of this Invoice
  "paymentTerms" : "<markdown>", // Payment details
  "note" : [{ Annotation }] // Comments made about the invoice
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Invoice;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Invoice.identifier [ Identifier ], ... ; # 0..* Business Identifier for item
  fhir:Invoice.status [ code ]; # 1..1 draft | issued | balanced | cancelled | entered-in-error
  fhir:Invoice.cancelledReason [ string ]; # 0..1 Reason for cancellation of this Invoice
  fhir:Invoice.type [ CodeableConcept ]; # 0..1 Type of Invoice
  fhir:Invoice.subject [ Reference(Patient|Group) ]; # 0..1 Recipient(s) of goods and services
  fhir:Invoice.recipient [ Reference(Organization|Patient|RelatedPerson) ]; # 0..1 Recipient of this invoice
  fhir:Invoice.date [ dateTime ]; # 0..1 Invoice date / posting date
  fhir:Invoice.participant [ # 0..* Participant in creation of this Invoice
    fhir:Invoice.participant.role [ CodeableConcept ]; # 0..1 Type of involevent in creation of this Invoice
    fhir:Invoice.participant.actor [ Reference(Practitioner|Organization|Patient|Device|RelatedPerson) ]; # 1..1 Individual who was involved
  ], ...;
  fhir:Invoice.issuer [ Reference(Organization) ]; # 0..1 Issuing Organization of Invoice
  fhir:Invoice.account [ Reference(Account) ]; # 0..1 Account that is being balanced
  fhir:Invoice.lineItem [ # 0..* Line items of this Invoice
    fhir:Invoice.lineItem.sequence [ positiveInt ]; # 0..1 Sequence number of line item
    # Invoice.lineItem.chargeItem[x] : 1..1 Reference to ChargeItem containing details of this line item or an inline billing code. One of these 2
      fhir:Invoice.lineItem.chargeItemReference [ Reference(ChargeItem) ]
      fhir:Invoice.lineItem.chargeItemCodeableConcept [ CodeableConcept ]
    fhir:Invoice.lineItem.priceComponent [ # 0..* Components of total line item price
      fhir:Invoice.lineItem.priceComponent.type [ code ]; # 1..1 base | surcharge | deduction | discount | tax | informational
      fhir:Invoice.lineItem.priceComponent.code [ CodeableConcept ]; # 0..1 Code identifying the specific component
      fhir:Invoice.lineItem.priceComponent.factor [ decimal ]; # 0..1 Factor used for calculating this component
      fhir:Invoice.lineItem.priceComponent.amount [ Money ]; # 0..1 Monetary amount associated with this component
    ], ...;
  ], ...;
  fhir:Invoice.totalPriceComponent [ See Invoice.lineItem.priceComponent ], ... ; # 0..* Components of Invoice total
  fhir:Invoice.totalNet [ Money ]; # 0..1 Net total of this Invoice
  fhir:Invoice.totalGross [ Money ]; # 0..1 Gross total of this Invoice
  fhir:Invoice.paymentTerms [ markdown ]; # 0..1 Payment details
  fhir:Invoice.note [ Annotation ], ... ; # 0..* Comments made about the invoice
]

Changes since R3

This resource did not exist in Release 2

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = Not Mapped)

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Invoice TUDomainResourceInvoice containing ChargeItems from an Account
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierBusiness Identifier for item
... status ?!Σ1..1codedraft | issued | balanced | cancelled | entered-in-error
InvoiceStatus (Required)
... cancelledReason 0..1stringReason for cancellation of this Invoice
... type Σ0..1CodeableConceptType of Invoice
... subject Σ0..1Reference(Patient | Group)Recipient(s) of goods and services
... recipient Σ0..1Reference(Organization | Patient | RelatedPerson)Recipient of this invoice
... date Σ0..1dateTimeInvoice date / posting date
... participant 0..*BackboneElementParticipant in creation of this Invoice
.... role 0..1CodeableConceptType of involevent in creation of this Invoice
.... actor 1..1Reference(Practitioner | Organization | Patient | Device | RelatedPerson)Individual who was involved
... issuer 0..1Reference(Organization)Issuing Organization of Invoice
... account 0..1Reference(Account)Account that is being balanced
... lineItem 0..*BackboneElementLine items of this Invoice
.... sequence 0..1positiveIntSequence number of line item
.... chargeItem[x] 1..1Reference to ChargeItem containing details of this line item or an inline billing code
..... chargeItemReferenceReference(ChargeItem)
..... chargeItemCodeableConceptCodeableConcept
.... priceComponent 0..*BackboneElementComponents of total line item price
..... type 1..1codebase | surcharge | deduction | discount | tax | informational
InvoicePriceComponentType (Required)
..... code 0..1CodeableConceptCode identifying the specific component
..... factor 0..1decimalFactor used for calculating this component
..... amount 0..1MoneyMonetary amount associated with this component
... totalPriceComponent 0..*see priceComponentComponents of Invoice total
... totalNet Σ0..1MoneyNet total of this Invoice
... totalGross Σ0..1MoneyGross total of this Invoice
... paymentTerms 0..1markdownPayment details
... note 0..*AnnotationComments made about the invoice

doco Documentation for this format

UML Diagram (Legend)

Invoice (DomainResource)Identifier of this Invoice, often used for reference in corresponcence about this invoice or for tracking of paymentsidentifier : Identifier [0..*]The current state of the Invoice (this element modifies the meaning of other elements)status : code [1..1] « Codes identifying the lifecycle stage of an Invoice. (Strength=Required)InvoiceStatus! »In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.)cancelledReason : string [0..1]Type of Invoice depending on domain, realm an usage (eg. internal/external, dental, preliminary)type : CodeableConcept [0..1]The individual or set of individuals receiving the goods and services billed in this invoicesubject : Reference [0..1] « Patient|Group »The individual or Organization responsible for balancing of this invoicerecipient : Reference [0..1] « Organization|Patient|RelatedPerson »Date/time(s) of when this Invoice was posteddate : dateTime [0..1]The organizationissuing the Invoiceissuer : Reference [0..1] « Organization »Account which is supposed to be balanced with this Invoiceaccount : Reference [0..1] « Account »Invoice total , taxes excludedtotalNet : Money [0..1]Invoice total, tax includedtotalGross : Money [0..1]Payment details such as banking details, period of payment, deductables, methods of paymentpaymentTerms : markdown [0..1]Comments made about the invoice by the issuer, subject or other participantsnote : Annotation [0..*]ParticipantDescribes the type of involvement (e.g. transcriptionist, creator etc.). If the invoice has been created automatically, the Participant may be a billing engine or another kind of devicerole : CodeableConcept [0..1]The device, practitioner, etc. who performed or participated in the serviceactor : Reference [1..1] « Practitioner|Organization|Patient|Device| RelatedPerson »LineItemSequence in which the items appear on the invoicesequence : positiveInt [0..1]The ChargeItem contains information such as the billing code, date, amount etc. Of no further details are required for the lineItem, inline billing codes can be added using the CodeableConcept data type instead of the ReferencechargeItem[x] : Type [1..1] « Reference(ChargeItem)|CodeableConcept »PriceComponentThis code identifies the type of the componenttype : code [1..1] « Codes indicating the kind of the price component. (Strength=Required)InvoicePriceComponentType! »A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etccode : CodeableConcept [0..1]The factor that has been applied on the base price for calculating this componentfactor : decimal [0..1]The amount calculated for this componentamount : Money [0..1]Indicates who or what performed or participated in the charged serviceparticipant[0..*]The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under developement. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the prices have been calculatedpriceComponent[0..*]Each line item represents one charge for goods ond services rendered. Details such as date, code and amount are found in the referenced ChargeItem resourcelineItem[0..*]The total amount for the Invoice may be calculated as the sum of the line items with surcharges/deductions that apply in certain conditions. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the total price was calculatedtotalPriceComponent[0..*]

XML Template

<Invoice xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business Identifier for item --></identifier>
 <status value="[code]"/><!-- 1..1 draft | issued | balanced | cancelled | entered-in-error -->
 <cancelledReason value="[string]"/><!-- 0..1 Reason for cancellation of this Invoice -->
 <type><!-- 0..1 CodeableConcept Type of Invoice --></type>
 <subject><!-- 0..1 Reference(Patient|Group) Recipient(s) of goods and services --></subject>
 <recipient><!-- 0..1 Reference(Organization|Patient|RelatedPerson) Recipient of this invoice --></recipient>
 <date value="[dateTime]"/><!-- 0..1 Invoice date / posting date -->
 <participant>  <!-- 0..* Participant in creation of this Invoice -->
  <role><!-- 0..1 CodeableConcept Type of involevent in creation of this Invoice --></role>
  <actor><!-- 1..1 Reference(Practitioner|Organization|Patient|Device|
    RelatedPerson) Individual who was involved --></actor>
 </participant>
 <issuer><!-- 0..1 Reference(Organization) Issuing Organization of Invoice --></issuer>
 <account><!-- 0..1 Reference(Account) Account that is being balanced --></account>
 <lineItem>  <!-- 0..* Line items of this Invoice -->
  <sequence value="[positiveInt]"/><!-- 0..1 Sequence number of line item -->
  <chargeItem[x]><!-- 1..1 Reference(ChargeItem)|CodeableConcept Reference to ChargeItem containing details of this line item or an inline billing code --></chargeItem[x]>
  <priceComponent>  <!-- 0..* Components of total line item price -->
   <type value="[code]"/><!-- 1..1 base | surcharge | deduction | discount | tax | informational -->
   <code><!-- 0..1 CodeableConcept Code identifying the specific component --></code>
   <factor value="[decimal]"/><!-- 0..1 Factor used for calculating this component -->
   <amount><!-- 0..1 Money Monetary amount associated with this component --></amount>
  </priceComponent>
 </lineItem>
 <totalPriceComponent><!-- 0..* Content as for Invoice.lineItem.priceComponent Components of Invoice total --></totalPriceComponent>
 <totalNet><!-- 0..1 Money Net total of this Invoice --></totalNet>
 <totalGross><!-- 0..1 Money Gross total of this Invoice --></totalGross>
 <paymentTerms value="[markdown]"/><!-- 0..1 Payment details -->
 <note><!-- 0..* Annotation Comments made about the invoice --></note>
</Invoice>

JSON Template

{doco
  "resourceType" : "Invoice",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifier for item
  "status" : "<code>", // R!  draft | issued | balanced | cancelled | entered-in-error
  "cancelledReason" : "<string>", // Reason for cancellation of this Invoice
  "type" : { CodeableConcept }, // Type of Invoice
  "subject" : { Reference(Patient|Group) }, // Recipient(s) of goods and services
  "recipient" : { Reference(Organization|Patient|RelatedPerson) }, // Recipient of this invoice
  "date" : "<dateTime>", // Invoice date / posting date
  "participant" : [{ // Participant in creation of this Invoice
    "role" : { CodeableConcept }, // Type of involevent in creation of this Invoice
    "actor" : { Reference(Practitioner|Organization|Patient|Device|
    RelatedPerson) } // R!  Individual who was involved
  }],
  "issuer" : { Reference(Organization) }, // Issuing Organization of Invoice
  "account" : { Reference(Account) }, // Account that is being balanced
  "lineItem" : [{ // Line items of this Invoice
    "sequence" : "<positiveInt>", // Sequence number of line item
    // chargeItem[x]: 
      Reference to ChargeItem containing details of this line item or an inline billing code. One of these 2:
    "chargeItemReference" : { Reference(ChargeItem) },
    "chargeItemCodeableConcept" : { CodeableConcept },
    "priceComponent" : [{ // Components of total line item price
      "type" : "<code>", // R!  base | surcharge | deduction | discount | tax | informational
      "code" : { CodeableConcept }, // Code identifying the specific component
      "factor" : <decimal>, // Factor used for calculating this component
      "amount" : { Money } // Monetary amount associated with this component
    }]
  }],
  "totalPriceComponent" : [{ Content as for Invoice.lineItem.priceComponent }], // Components of Invoice total
  "totalNet" : { Money }, // Net total of this Invoice
  "totalGross" : { Money }, // Gross total of this Invoice
  "paymentTerms" : "<markdown>", // Payment details
  "note" : [{ Annotation }] // Comments made about the invoice
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Invoice;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Invoice.identifier [ Identifier ], ... ; # 0..* Business Identifier for item
  fhir:Invoice.status [ code ]; # 1..1 draft | issued | balanced | cancelled | entered-in-error
  fhir:Invoice.cancelledReason [ string ]; # 0..1 Reason for cancellation of this Invoice
  fhir:Invoice.type [ CodeableConcept ]; # 0..1 Type of Invoice
  fhir:Invoice.subject [ Reference(Patient|Group) ]; # 0..1 Recipient(s) of goods and services
  fhir:Invoice.recipient [ Reference(Organization|Patient|RelatedPerson) ]; # 0..1 Recipient of this invoice
  fhir:Invoice.date [ dateTime ]; # 0..1 Invoice date / posting date
  fhir:Invoice.participant [ # 0..* Participant in creation of this Invoice
    fhir:Invoice.participant.role [ CodeableConcept ]; # 0..1 Type of involevent in creation of this Invoice
    fhir:Invoice.participant.actor [ Reference(Practitioner|Organization|Patient|Device|RelatedPerson) ]; # 1..1 Individual who was involved
  ], ...;
  fhir:Invoice.issuer [ Reference(Organization) ]; # 0..1 Issuing Organization of Invoice
  fhir:Invoice.account [ Reference(Account) ]; # 0..1 Account that is being balanced
  fhir:Invoice.lineItem [ # 0..* Line items of this Invoice
    fhir:Invoice.lineItem.sequence [ positiveInt ]; # 0..1 Sequence number of line item
    # Invoice.lineItem.chargeItem[x] : 1..1 Reference to ChargeItem containing details of this line item or an inline billing code. One of these 2
      fhir:Invoice.lineItem.chargeItemReference [ Reference(ChargeItem) ]
      fhir:Invoice.lineItem.chargeItemCodeableConcept [ CodeableConcept ]
    fhir:Invoice.lineItem.priceComponent [ # 0..* Components of total line item price
      fhir:Invoice.lineItem.priceComponent.type [ code ]; # 1..1 base | surcharge | deduction | discount | tax | informational
      fhir:Invoice.lineItem.priceComponent.code [ CodeableConcept ]; # 0..1 Code identifying the specific component
      fhir:Invoice.lineItem.priceComponent.factor [ decimal ]; # 0..1 Factor used for calculating this component
      fhir:Invoice.lineItem.priceComponent.amount [ Money ]; # 0..1 Monetary amount associated with this component
    ], ...;
  ], ...;
  fhir:Invoice.totalPriceComponent [ See Invoice.lineItem.priceComponent ], ... ; # 0..* Components of Invoice total
  fhir:Invoice.totalNet [ Money ]; # 0..1 Net total of this Invoice
  fhir:Invoice.totalGross [ Money ]; # 0..1 Gross total of this Invoice
  fhir:Invoice.paymentTerms [ markdown ]; # 0..1 Payment details
  fhir:Invoice.note [ Annotation ], ... ; # 0..* Comments made about the invoice
]

Changes since Release 3

This resource did not exist in Release 2

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = Not Mapped)

 

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis

8.32.3.1 Terminology Bindings

PathDefinitionTypeReference
Invoice.status Codes identifying the lifecycle stage of an Invoice.RequiredInvoiceStatus
Invoice.lineItem.priceComponent.type Codes indicating the kind of the price component.RequiredInvoicePriceComponentType

8.32.4 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
accountreferenceAccount that is being balancedInvoice.account
(Account)
datedateInvoice date / posting dateInvoice.date
identifiertokenBusiness Identifier for itemInvoice.identifier
issuerreferenceIssuing Organization of InvoiceInvoice.issuer
(Organization)
participantreferenceIndividual who was involvedInvoice.participant.actor
(Practitioner, Organization, Device, Patient, RelatedPerson)
participant-roletokenType of involevent in creation of this InvoiceInvoice.participant.role
patientreferenceRecipient(s) of goods and servicesInvoice.subject.where(resolve() is Patient)
(Patient)
recipientreferenceRecipient of this invoiceInvoice.recipient
(Organization, Patient, RelatedPerson)
statustokendraft | issued | balanced | cancelled | entered-in-errorInvoice.status
subjectreferenceRecipient(s) of goods and servicesInvoice.subject
(Group, Patient)
totalgrossquantityGross total of this InvoiceInvoice.totalGross
totalnetquantityNet total of this InvoiceInvoice.totalNet
typetokenType of InvoiceInvoice.type