US Veterans Health Administration FHIR Map Set Implementation Guide
1.3.1 - 250401 United States of America flag

Publication Build: This will be filled in by the publication tooling

Resource Profile: Debt Portal Invoice

Official URL: http://va.gov/fhir/StructureDefinition/DebtPortalInvoice Version: 1.3.1
Active as of 2025-03-31 Computable Name: DebtPortalInvoice

This StructureDefinition contains the maps for VistA file ACCOUNTS RECEIVABLE (430) to Invoice.

See also the FHIR Shorthand.

Use Case Overview

Use Case: Debt Portal«FHIR Account»DebtPortalAccountsubject«FHIR Invoice»DebtPortalInvoicerecipientsubjectissueraccountlineItem[va-charges].chargeItemReferencelineItem[va-interest].chargeItemReference«FHIR Patient»DebtPortalPatient«FHIR ChargeItem»DebtPortalChargeItemchargessubjectcontextservice[va-rxorig]service[va-rxrefill]service[va-rxpartial]«FHIR ChargeItem»DebtPortalChargeItemremovedpartOf«FHIR ChargeItem»DebtPortalChargeIteminterest«FHIR PaymentReconciliation»DebtPortalPaymentReconciliationextension[PaymentReconciliation.paymentIssuer].valueReferenceextension[PaymentReconciliation.allocation.target].valueReferencePatientPatientOrganizationPatientEncounterOutpatientEncounterInpatientEncounterMedicationDispenseOriginalMedicationDispenseRefillMedicationDispensePartial

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Invoice 0..* Invoice Invoice containing ChargeItems from an Account
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier SΣ 0..* Identifier Business Identifier for item
ele-1: All FHIR elements must have a @value or children
... subject SΣ 0..1 Reference(Patient) Recipient(s) of goods and services
ele-1: All FHIR elements must have a @value or children
... recipient SΣC 0..1 Reference(Debt Portal Patient) Recipient of this invoice
ele-1: All FHIR elements must have a @value or children
dpi-17-1818: If type is PATIENT (#2) then reference Patient based on (430-9 > 340-.01)
... date SΣ 0..1 dateTime Invoice date / posting date
ele-1: All FHIR elements must have a @value or children
... issuer S 0..1 Reference(Organization) Issuing Organization of Invoice
ele-1: All FHIR elements must have a @value or children
... account S 0..1 Reference(Debt Portal Account) Account that is being balanced
ele-1: All FHIR elements must have a @value or children
... Slices for lineItem 0..* BackboneElement Line items of this Invoice
Slice: Unordered, Open by value:$this
ele-1: All FHIR elements must have a @value or children
.... lineItem:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... chargeItem[x] 1..1 Reference to ChargeItem containing details of this line item or an inline billing code
ele-1: All FHIR elements must have a @value or children
...... chargeItemReference Reference(ChargeItem)
...... chargeItemCodeableConcept CodeableConcept
.... lineItem:va-charges 0..1 BackboneElement Line items of this Invoice
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... Slices for chargeItem[x] 1..1 Reference to ChargeItem containing details of this line item or an inline billing code
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
...... chargeItemReference Reference(ChargeItem)
...... chargeItemCodeableConcept CodeableConcept
...... chargeItem[x]:chargeItemReference SC 0..1 Reference(Debt Portal ChargeItem[charges] | Debt Portal ChargeItem[removed]) Reference to ChargeItem containing details of this line item or an inline billing code
ele-1: All FHIR elements must have a @value or children
dpi-17-1834: If INTEGRATED BILLING ACTION - PARENT CHARGE = INTEGRATED BILLING ACTION - IEN then reference ChargeItemcharges based on (null)
dpi-17-2220: If INTEGRATED BILLING ACTION - PARENT CHARGE <> INTEGRATED BILLING ACTION - IEN then reference ChargeItemremoved based on (null)
..... priceComponent 0..* BackboneElement Components of total line item price
ele-1: All FHIR elements must have a @value or children
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: base
...... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
....... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Total Charge
...... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
.... lineItem:va-interest 0..1 BackboneElement Line items of this Invoice
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... Slices for chargeItem[x] 1..1 Reference to ChargeItem containing details of this line item or an inline billing code
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
...... chargeItemReference Reference(ChargeItem)
...... chargeItemCodeableConcept CodeableConcept
...... chargeItem[x]:chargeItemReference S 0..1 Reference(Debt Portal ChargeItem[interest]) Reference to ChargeItem containing details of this line item or an inline billing code
ele-1: All FHIR elements must have a @value or children
..... Slices for priceComponent 0..* BackboneElement Components of total line item price
Slice: Unordered, Open by value:$this
ele-1: All FHIR elements must have a @value or children
...... priceComponent:All Slices Content/Rules for all slices
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... type 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
...... priceComponent:va-marshal-fee-charged 0..1 BackboneElement Components of total line item price
ele-1: All FHIR elements must have a @value or children
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: surcharge
....... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
........ text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Marshal Fee Charged
....... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
...... priceComponent:va-court-cost-charged 0..1 BackboneElement Components of total line item price
ele-1: All FHIR elements must have a @value or children
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: surcharge
....... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
........ text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Court Cost Charged
....... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
...... priceComponent:va-interest-charged 0..1 BackboneElement Components of total line item price
ele-1: All FHIR elements must have a @value or children
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: surcharge
....... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
........ text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Interest Charged
....... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
...... priceComponent:va-admin-charged 0..1 BackboneElement Components of total line item price
ele-1: All FHIR elements must have a @value or children
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: surcharge
....... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
........ text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Administrative Charged
....... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
... Slices for totalPriceComponent 0..* See priceComponent (Invoice) Components of Invoice total
Slice: Unordered, Open by value:$this
ele-1: All FHIR elements must have a @value or children
.... totalPriceComponent:va-orig-amt 0..1 BackboneElement Components of Invoice total
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: informational
..... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Original Amount
..... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
.... totalPriceComponent:va-curr-bal 0..1 BackboneElement Components of Invoice total
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: base
..... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Current Balance
..... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
.... totalPriceComponent:va-amend-amt 0..1 BackboneElement Components of Invoice total
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: base
..... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Amended Amount
..... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
.... totalPriceComponent:va-principal-bal 0..1 BackboneElement Components of Invoice total
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: base
..... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Principal Balance
..... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
.... totalPriceComponent:va-interest-bal 0..1 BackboneElement Components of Invoice total
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Interest Balance
..... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
.... totalPriceComponent:va-admin-cost-bal 0..1 BackboneElement Components of Invoice total
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Administrative Cost Balance
..... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
.... totalPriceComponent:va-marsh-fee 0..1 BackboneElement Components of Invoice total
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Marshal Fee
..... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
.... totalPriceComponent:va-court-cost 0..1 BackboneElement Components of Invoice total
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Court Cost
..... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
.... totalPriceComponent:va-principal-paid 0..1 BackboneElement Components of Invoice total
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: base
..... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Principal Paid
..... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
.... totalPriceComponent:va-interest-paid 0..1 BackboneElement Components of Invoice total
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Interest Paid
..... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
.... totalPriceComponent:va-admin-cost-paid 0..1 BackboneElement Components of Invoice total
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Administrative Cost Paid
..... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
.... totalPriceComponent:va-marsh-fee-paid 0..1 BackboneElement Components of Invoice total
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Marshal Fee Paid
..... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
.... totalPriceComponent:va-court-cost-paid 0..1 BackboneElement Components of Invoice total
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Court Cost Paid
..... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Invoice.statusrequiredARBillStatus
http://va.gov/fhir/ValueSet/ARBillStatus
from this IG
Invoice.lineItem:va-charges.priceComponent.typerequiredPattern: base
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.lineItem:va-interest.priceComponent.typerequiredInvoicePriceComponentType
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.lineItem:va-interest.priceComponent:va-marshal-fee-charged.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.lineItem:va-interest.priceComponent:va-court-cost-charged.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.lineItem:va-interest.priceComponent:va-interest-charged.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.lineItem:va-interest.priceComponent:va-admin-charged.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-orig-amt.typerequiredPattern: informational
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-curr-bal.typerequiredPattern: base
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-amend-amt.typerequiredPattern: base
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-principal-bal.typerequiredPattern: base
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-interest-bal.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-admin-cost-bal.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-marsh-fee.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-court-cost.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-principal-paid.typerequiredPattern: base
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-interest-paid.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-admin-cost-paid.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-marsh-fee-paid.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-court-cost-paid.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorInvoiceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorInvoiceIf 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-4errorInvoiceIf 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-5errorInvoiceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceInvoiceA resource should have narrative for robust management
: text.`div`.exists()
dpi-17-1818warningInvoice.recipientIf type is PATIENT (#2) then reference Patient based on (430-9 > 340-.01)
: true
dpi-17-1834warningInvoice.lineItem:va-charges.chargeItem[x]:chargeItemReferenceIf INTEGRATED BILLING ACTION - PARENT CHARGE = INTEGRATED BILLING ACTION - IEN then reference ChargeItemcharges based on (null)
: true
dpi-17-2220warningInvoice.lineItem:va-charges.chargeItem[x]:chargeItemReferenceIf INTEGRATED BILLING ACTION - PARENT CHARGE <> INTEGRATED BILLING ACTION - IEN then reference ChargeItemremoved based on (null)
: true
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Invoice

NameFlagsCard.TypeDescription & Constraintsdoco
.. Invoice 0..* Invoice Invoice containing ChargeItems from an Account
... identifier S 0..* Identifier Business Identifier for item
... status S 1..1 code draft | issued | balanced | cancelled | entered-in-error
Binding: ARBillStatus FHIR (required): see mapping VF_ARBillStatus

... subject S 0..1 Reference(Patient) Recipient(s) of goods and services
... date S 0..1 dateTime Invoice date / posting date
... issuer S 0..1 Reference(Organization) Issuing Organization of Invoice
... account S 0..1 Reference(Debt Portal Account) Account that is being balanced
... Slices for lineItem 0..* BackboneElement Line items of this Invoice
Slice: Unordered, Open by value:$this
.... lineItem:va-charges 0..1 BackboneElement Line items of this Invoice
..... Slices for chargeItem[x] 1..1 Reference(ChargeItem), CodeableConcept Reference to ChargeItem containing details of this line item or an inline billing code
Slice: Unordered, Open by type:$this
...... chargeItem[x]:chargeItemReference SC 0..1 Reference(Debt Portal ChargeItem[charges] | Debt Portal ChargeItem[removed]) Reference to ChargeItem containing details of this line item or an inline billing code
dpi-17-1834: If INTEGRATED BILLING ACTION - PARENT CHARGE = INTEGRATED BILLING ACTION - IEN then reference ChargeItemcharges based on (null)
dpi-17-2220: If INTEGRATED BILLING ACTION - PARENT CHARGE <> INTEGRATED BILLING ACTION - IEN then reference ChargeItemremoved based on (null)
..... priceComponent
...... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: base
...... code
....... text S 0..1 string Plain text representation of the concept
Required Pattern: Total Charge
...... amount S 0..1 Money Monetary amount associated with this component
.... lineItem:va-interest 0..1 BackboneElement Line items of this Invoice
..... Slices for chargeItem[x] 1..1 Reference(ChargeItem), CodeableConcept Reference to ChargeItem containing details of this line item or an inline billing code
Slice: Unordered, Open by type:$this
...... chargeItem[x]:chargeItemReference S 0..1 Reference(Debt Portal ChargeItem[interest]) Reference to ChargeItem containing details of this line item or an inline billing code
..... Slices for priceComponent 0..* BackboneElement Components of total line item price
Slice: Unordered, Open by value:$this
...... priceComponent:va-marshal-fee-charged 0..1 BackboneElement Components of total line item price
....... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: surcharge
....... code
........ text S 0..1 string Plain text representation of the concept
Required Pattern: Marshal Fee Charged
....... amount S 0..1 Money Monetary amount associated with this component
...... priceComponent:va-court-cost-charged 0..1 BackboneElement Components of total line item price
....... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: surcharge
....... code
........ text S 0..1 string Plain text representation of the concept
Required Pattern: Court Cost Charged
....... amount S 0..1 Money Monetary amount associated with this component
...... priceComponent:va-interest-charged 0..1 BackboneElement Components of total line item price
....... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: surcharge
....... code
........ text S 0..1 string Plain text representation of the concept
Required Pattern: Interest Charged
....... amount S 0..1 Money Monetary amount associated with this component
...... priceComponent:va-admin-charged 0..1 BackboneElement Components of total line item price
....... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: surcharge
....... code
........ text S 0..1 string Plain text representation of the concept
Required Pattern: Administrative Charged
....... amount S 0..1 Money Monetary amount associated with this component
... Slices for totalPriceComponent 0..* Components of Invoice total
Slice: Unordered, Open by value:$this
.... totalPriceComponent:va-orig-amt 0..1 BackboneElement Components of Invoice total
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: informational
..... code
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Original Amount
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-curr-bal 0..1 BackboneElement Components of Invoice total
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: base
..... code
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Current Balance
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-amend-amt 0..1 BackboneElement Components of Invoice total
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: base
..... code
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Amended Amount
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-principal-bal 0..1 BackboneElement Components of Invoice total
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: base
..... code
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Principal Balance
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-interest-bal 0..1 BackboneElement Components of Invoice total
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: surcharge
..... code
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Interest Balance
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-admin-cost-bal 0..1 BackboneElement Components of Invoice total
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: surcharge
..... code
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Administrative Cost Balance
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-marsh-fee 0..1 BackboneElement Components of Invoice total
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: surcharge
..... code
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Marshal Fee
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-court-cost 0..1 BackboneElement Components of Invoice total
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: surcharge
..... code
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Court Cost
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-principal-paid 0..1 BackboneElement Components of Invoice total
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: base
..... code
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Principal Paid
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-interest-paid 0..1 BackboneElement Components of Invoice total
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: surcharge
..... code
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Interest Paid
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-admin-cost-paid 0..1 BackboneElement Components of Invoice total
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: surcharge
..... code
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Administrative Cost Paid
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-marsh-fee-paid 0..1 BackboneElement Components of Invoice total
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: surcharge
..... code
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Marshal Fee Paid
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-court-cost-paid 0..1 BackboneElement Components of Invoice total
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: surcharge
..... code
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Court Cost Paid
..... amount S 0..1 Money Monetary amount associated with this component

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Invoice.statusrequiredARBillStatus
http://va.gov/fhir/ValueSet/ARBillStatus
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dpi-17-1818warningInvoice.recipientIf type is PATIENT (#2) then reference Patient based on (430-9 > 340-.01)
: true
dpi-17-1834warningInvoice.lineItem:va-charges.chargeItem[x]:chargeItemReferenceIf INTEGRATED BILLING ACTION - PARENT CHARGE = INTEGRATED BILLING ACTION - IEN then reference ChargeItemcharges based on (null)
: true
dpi-17-2220warningInvoice.lineItem:va-charges.chargeItem[x]:chargeItemReferenceIf INTEGRATED BILLING ACTION - PARENT CHARGE <> INTEGRATED BILLING ACTION - IEN then reference ChargeItemremoved based on (null)
: true
NameFlagsCard.TypeDescription & Constraintsdoco
.. Invoice 0..* Invoice Invoice containing ChargeItems from an Account
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Business Identifier for item
... status ?!SΣ 1..1 code draft | issued | balanced | cancelled | entered-in-error
Binding: ARBillStatus FHIR (required): see mapping VF_ARBillStatus

... cancelledReason 0..1 string Reason for cancellation of this Invoice
... type Σ 0..1 CodeableConcept Type of Invoice
... subject SΣ 0..1 Reference(Patient) Recipient(s) of goods and services
... recipient SΣC 0..1 Reference(Debt Portal Patient) Recipient of this invoice
dpi-17-1818: If type is PATIENT (#2) then reference Patient based on (430-9 > 340-.01)
... date SΣ 0..1 dateTime Invoice date / posting date
... participant 0..* BackboneElement Participant in creation of this Invoice
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role 0..1 CodeableConcept Type of involvement in creation of this Invoice
.... actor 1..1 Reference(Practitioner | Organization | Patient | PractitionerRole | Device | RelatedPerson) Individual who was involved
... issuer S 0..1 Reference(Organization) Issuing Organization of Invoice
... account S 0..1 Reference(Debt Portal Account) Account that is being balanced
... Slices for lineItem 0..* BackboneElement Line items of this Invoice
Slice: Unordered, Open by value:$this
.... lineItem:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... sequence 0..1 positiveInt Sequence number of line item
..... chargeItem[x] 1..1 Reference to ChargeItem containing details of this line item or an inline billing code
...... chargeItemReference Reference(ChargeItem)
...... chargeItemCodeableConcept CodeableConcept
..... priceComponent 0..* BackboneElement Components of total line item price
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.

...... code 0..1 CodeableConcept Code identifying the specific component
...... factor 0..1 decimal Factor used for calculating this component
...... amount 0..1 Money Monetary amount associated with this component
.... lineItem:va-charges 0..1 BackboneElement Line items of this Invoice
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... sequence 0..1 positiveInt Sequence number of line item
..... Slices for chargeItem[x] 1..1 Reference to ChargeItem containing details of this line item or an inline billing code
Slice: Unordered, Open by type:$this
...... chargeItemReference Reference(ChargeItem)
...... chargeItemCodeableConcept CodeableConcept
...... chargeItem[x]:chargeItemReference SC 0..1 Reference(Debt Portal ChargeItem[charges] | Debt Portal ChargeItem[removed]) Reference to ChargeItem containing details of this line item or an inline billing code
dpi-17-1834: If INTEGRATED BILLING ACTION - PARENT CHARGE = INTEGRATED BILLING ACTION - IEN then reference ChargeItemcharges based on (null)
dpi-17-2220: If INTEGRATED BILLING ACTION - PARENT CHARGE <> INTEGRATED BILLING ACTION - IEN then reference ChargeItemremoved based on (null)
..... priceComponent 0..* BackboneElement Components of total line item price
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: base
...... code 0..1 CodeableConcept Code identifying the specific component
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ 0..* Coding Code defined by a terminology system
....... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Total Charge
...... factor 0..1 decimal Factor used for calculating this component
...... amount S 0..1 Money Monetary amount associated with this component
.... lineItem:va-interest 0..1 BackboneElement Line items of this Invoice
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... sequence 0..1 positiveInt Sequence number of line item
..... Slices for chargeItem[x] 1..1 Reference to ChargeItem containing details of this line item or an inline billing code
Slice: Unordered, Open by type:$this
...... chargeItemReference Reference(ChargeItem)
...... chargeItemCodeableConcept CodeableConcept
...... chargeItem[x]:chargeItemReference S 0..1 Reference(Debt Portal ChargeItem[interest]) Reference to ChargeItem containing details of this line item or an inline billing code
..... Slices for priceComponent 0..* BackboneElement Components of total line item price
Slice: Unordered, Open by value:$this
...... priceComponent:All Slices Content/Rules for all slices
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... type 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.

....... code 0..1 CodeableConcept Code identifying the specific component
....... factor 0..1 decimal Factor used for calculating this component
....... amount 0..1 Money Monetary amount associated with this component
...... priceComponent:va-marshal-fee-charged 0..1 BackboneElement Components of total line item price
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: surcharge
....... code 0..1 CodeableConcept Code identifying the specific component
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding Σ 0..* Coding Code defined by a terminology system
........ text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Marshal Fee Charged
....... factor 0..1 decimal Factor used for calculating this component
....... amount S 0..1 Money Monetary amount associated with this component
...... priceComponent:va-court-cost-charged 0..1 BackboneElement Components of total line item price
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: surcharge
....... code 0..1 CodeableConcept Code identifying the specific component
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding Σ 0..* Coding Code defined by a terminology system
........ text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Court Cost Charged
....... factor 0..1 decimal Factor used for calculating this component
....... amount S 0..1 Money Monetary amount associated with this component
...... priceComponent:va-interest-charged 0..1 BackboneElement Components of total line item price
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: surcharge
....... code 0..1 CodeableConcept Code identifying the specific component
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding Σ 0..* Coding Code defined by a terminology system
........ text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Interest Charged
....... factor 0..1 decimal Factor used for calculating this component
....... amount S 0..1 Money Monetary amount associated with this component
...... priceComponent:va-admin-charged 0..1 BackboneElement Components of total line item price
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: surcharge
....... code 0..1 CodeableConcept Code identifying the specific component
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding Σ 0..* Coding Code defined by a terminology system
........ text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Administrative Charged
....... factor 0..1 decimal Factor used for calculating this component
....... amount S 0..1 Money Monetary amount associated with this component
... Slices for totalPriceComponent 0..* See priceComponent (Invoice) Components of Invoice total
Slice: Unordered, Open by value:$this
.... totalPriceComponent:va-orig-amt 0..1 BackboneElement Components of Invoice total
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: informational
..... code 0..1 CodeableConcept Code identifying the specific component
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Original Amount
..... factor 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-curr-bal 0..1 BackboneElement Components of Invoice total
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: base
..... code 0..1 CodeableConcept Code identifying the specific component
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Current Balance
..... factor 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-amend-amt 0..1 BackboneElement Components of Invoice total
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: base
..... code 0..1 CodeableConcept Code identifying the specific component
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Amended Amount
..... factor 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-principal-bal 0..1 BackboneElement Components of Invoice total
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: base
..... code 0..1 CodeableConcept Code identifying the specific component
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Principal Balance
..... factor 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-interest-bal 0..1 BackboneElement Components of Invoice total
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Interest Balance
..... factor 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-admin-cost-bal 0..1 BackboneElement Components of Invoice total
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Administrative Cost Balance
..... factor 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-marsh-fee 0..1 BackboneElement Components of Invoice total
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Marshal Fee
..... factor 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-court-cost 0..1 BackboneElement Components of Invoice total
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Court Cost
..... factor 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-principal-paid 0..1 BackboneElement Components of Invoice total
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: base
..... code 0..1 CodeableConcept Code identifying the specific component
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Principal Paid
..... factor 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-interest-paid 0..1 BackboneElement Components of Invoice total
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Interest Paid
..... factor 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-admin-cost-paid 0..1 BackboneElement Components of Invoice total
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Administrative Cost Paid
..... factor 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-marsh-fee-paid 0..1 BackboneElement Components of Invoice total
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Marshal Fee Paid
..... factor 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-court-cost-paid 0..1 BackboneElement Components of Invoice total
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Court Cost Paid
..... factor 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component
... totalNet Σ 0..1 Money Net total of this Invoice
... totalGross Σ 0..1 Money Gross total of this Invoice
... paymentTerms 0..1 markdown Payment details
... note 0..* Annotation Comments made about the invoice

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Invoice.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Invoice.statusrequiredARBillStatus
http://va.gov/fhir/ValueSet/ARBillStatus
from this IG
Invoice.lineItem.priceComponent.typerequiredInvoicePriceComponentType
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.lineItem:va-charges.priceComponent.typerequiredPattern: base
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.lineItem:va-interest.priceComponent.typerequiredInvoicePriceComponentType
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.lineItem:va-interest.priceComponent:va-marshal-fee-charged.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.lineItem:va-interest.priceComponent:va-court-cost-charged.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.lineItem:va-interest.priceComponent:va-interest-charged.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.lineItem:va-interest.priceComponent:va-admin-charged.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-orig-amt.typerequiredPattern: informational
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-curr-bal.typerequiredPattern: base
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-amend-amt.typerequiredPattern: base
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-principal-bal.typerequiredPattern: base
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-interest-bal.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-admin-cost-bal.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-marsh-fee.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-court-cost.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-principal-paid.typerequiredPattern: base
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-interest-paid.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-admin-cost-paid.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-marsh-fee-paid.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-court-cost-paid.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorInvoiceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorInvoiceIf 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-4errorInvoiceIf 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-5errorInvoiceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceInvoiceA resource should have narrative for robust management
: text.`div`.exists()
dpi-17-1818warningInvoice.recipientIf type is PATIENT (#2) then reference Patient based on (430-9 > 340-.01)
: true
dpi-17-1834warningInvoice.lineItem:va-charges.chargeItem[x]:chargeItemReferenceIf INTEGRATED BILLING ACTION - PARENT CHARGE = INTEGRATED BILLING ACTION - IEN then reference ChargeItemcharges based on (null)
: true
dpi-17-2220warningInvoice.lineItem:va-charges.chargeItem[x]:chargeItemReferenceIf INTEGRATED BILLING ACTION - PARENT CHARGE <> INTEGRATED BILLING ACTION - IEN then reference ChargeItemremoved based on (null)
: true
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Invoice

Summary

Must-Support: 63 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Invoice.lineItem
  • The element 1 is sliced based on the value of Invoice.lineItem.chargeItem[x]
  • The element 1 is sliced based on the value of Invoice.lineItem.priceComponent
  • The element 1 is sliced based on the value of Invoice.totalPriceComponent

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Invoice 0..* Invoice Invoice containing ChargeItems from an Account
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier SΣ 0..* Identifier Business Identifier for item
ele-1: All FHIR elements must have a @value or children
... subject SΣ 0..1 Reference(Patient) Recipient(s) of goods and services
ele-1: All FHIR elements must have a @value or children
... recipient SΣC 0..1 Reference(Debt Portal Patient) Recipient of this invoice
ele-1: All FHIR elements must have a @value or children
dpi-17-1818: If type is PATIENT (#2) then reference Patient based on (430-9 > 340-.01)
... date SΣ 0..1 dateTime Invoice date / posting date
ele-1: All FHIR elements must have a @value or children
... issuer S 0..1 Reference(Organization) Issuing Organization of Invoice
ele-1: All FHIR elements must have a @value or children
... account S 0..1 Reference(Debt Portal Account) Account that is being balanced
ele-1: All FHIR elements must have a @value or children
... Slices for lineItem 0..* BackboneElement Line items of this Invoice
Slice: Unordered, Open by value:$this
ele-1: All FHIR elements must have a @value or children
.... lineItem:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... chargeItem[x] 1..1 Reference to ChargeItem containing details of this line item or an inline billing code
ele-1: All FHIR elements must have a @value or children
...... chargeItemReference Reference(ChargeItem)
...... chargeItemCodeableConcept CodeableConcept
.... lineItem:va-charges 0..1 BackboneElement Line items of this Invoice
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... Slices for chargeItem[x] 1..1 Reference to ChargeItem containing details of this line item or an inline billing code
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
...... chargeItemReference Reference(ChargeItem)
...... chargeItemCodeableConcept CodeableConcept
...... chargeItem[x]:chargeItemReference SC 0..1 Reference(Debt Portal ChargeItem[charges] | Debt Portal ChargeItem[removed]) Reference to ChargeItem containing details of this line item or an inline billing code
ele-1: All FHIR elements must have a @value or children
dpi-17-1834: If INTEGRATED BILLING ACTION - PARENT CHARGE = INTEGRATED BILLING ACTION - IEN then reference ChargeItemcharges based on (null)
dpi-17-2220: If INTEGRATED BILLING ACTION - PARENT CHARGE <> INTEGRATED BILLING ACTION - IEN then reference ChargeItemremoved based on (null)
..... priceComponent 0..* BackboneElement Components of total line item price
ele-1: All FHIR elements must have a @value or children
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: base
...... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
....... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Total Charge
...... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
.... lineItem:va-interest 0..1 BackboneElement Line items of this Invoice
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... Slices for chargeItem[x] 1..1 Reference to ChargeItem containing details of this line item or an inline billing code
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
...... chargeItemReference Reference(ChargeItem)
...... chargeItemCodeableConcept CodeableConcept
...... chargeItem[x]:chargeItemReference S 0..1 Reference(Debt Portal ChargeItem[interest]) Reference to ChargeItem containing details of this line item or an inline billing code
ele-1: All FHIR elements must have a @value or children
..... Slices for priceComponent 0..* BackboneElement Components of total line item price
Slice: Unordered, Open by value:$this
ele-1: All FHIR elements must have a @value or children
...... priceComponent:All Slices Content/Rules for all slices
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... type 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
...... priceComponent:va-marshal-fee-charged 0..1 BackboneElement Components of total line item price
ele-1: All FHIR elements must have a @value or children
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: surcharge
....... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
........ text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Marshal Fee Charged
....... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
...... priceComponent:va-court-cost-charged 0..1 BackboneElement Components of total line item price
ele-1: All FHIR elements must have a @value or children
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: surcharge
....... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
........ text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Court Cost Charged
....... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
...... priceComponent:va-interest-charged 0..1 BackboneElement Components of total line item price
ele-1: All FHIR elements must have a @value or children
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: surcharge
....... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
........ text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Interest Charged
....... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
...... priceComponent:va-admin-charged 0..1 BackboneElement Components of total line item price
ele-1: All FHIR elements must have a @value or children
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: surcharge
....... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
........ text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Administrative Charged
....... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
... Slices for totalPriceComponent 0..* See priceComponent (Invoice) Components of Invoice total
Slice: Unordered, Open by value:$this
ele-1: All FHIR elements must have a @value or children
.... totalPriceComponent:va-orig-amt 0..1 BackboneElement Components of Invoice total
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: informational
..... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Original Amount
..... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
.... totalPriceComponent:va-curr-bal 0..1 BackboneElement Components of Invoice total
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: base
..... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Current Balance
..... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
.... totalPriceComponent:va-amend-amt 0..1 BackboneElement Components of Invoice total
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: base
..... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Amended Amount
..... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
.... totalPriceComponent:va-principal-bal 0..1 BackboneElement Components of Invoice total
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: base
..... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Principal Balance
..... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
.... totalPriceComponent:va-interest-bal 0..1 BackboneElement Components of Invoice total
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Interest Balance
..... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
.... totalPriceComponent:va-admin-cost-bal 0..1 BackboneElement Components of Invoice total
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Administrative Cost Balance
..... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
.... totalPriceComponent:va-marsh-fee 0..1 BackboneElement Components of Invoice total
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Marshal Fee
..... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
.... totalPriceComponent:va-court-cost 0..1 BackboneElement Components of Invoice total
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Court Cost
..... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
.... totalPriceComponent:va-principal-paid 0..1 BackboneElement Components of Invoice total
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: base
..... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Principal Paid
..... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
.... totalPriceComponent:va-interest-paid 0..1 BackboneElement Components of Invoice total
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Interest Paid
..... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
.... totalPriceComponent:va-admin-cost-paid 0..1 BackboneElement Components of Invoice total
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Administrative Cost Paid
..... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
.... totalPriceComponent:va-marsh-fee-paid 0..1 BackboneElement Components of Invoice total
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Marshal Fee Paid
..... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children
.... totalPriceComponent:va-court-cost-paid 0..1 BackboneElement Components of Invoice total
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


ele-1: All FHIR elements must have a @value or children
Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Court Cost Paid
..... amount S 0..1 Money Monetary amount associated with this component
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Invoice.statusrequiredARBillStatus
http://va.gov/fhir/ValueSet/ARBillStatus
from this IG
Invoice.lineItem:va-charges.priceComponent.typerequiredPattern: base
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.lineItem:va-interest.priceComponent.typerequiredInvoicePriceComponentType
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.lineItem:va-interest.priceComponent:va-marshal-fee-charged.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.lineItem:va-interest.priceComponent:va-court-cost-charged.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.lineItem:va-interest.priceComponent:va-interest-charged.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.lineItem:va-interest.priceComponent:va-admin-charged.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-orig-amt.typerequiredPattern: informational
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-curr-bal.typerequiredPattern: base
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-amend-amt.typerequiredPattern: base
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-principal-bal.typerequiredPattern: base
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-interest-bal.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-admin-cost-bal.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-marsh-fee.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-court-cost.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-principal-paid.typerequiredPattern: base
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-interest-paid.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-admin-cost-paid.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-marsh-fee-paid.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-court-cost-paid.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorInvoiceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorInvoiceIf 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-4errorInvoiceIf 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-5errorInvoiceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceInvoiceA resource should have narrative for robust management
: text.`div`.exists()
dpi-17-1818warningInvoice.recipientIf type is PATIENT (#2) then reference Patient based on (430-9 > 340-.01)
: true
dpi-17-1834warningInvoice.lineItem:va-charges.chargeItem[x]:chargeItemReferenceIf INTEGRATED BILLING ACTION - PARENT CHARGE = INTEGRATED BILLING ACTION - IEN then reference ChargeItemcharges based on (null)
: true
dpi-17-2220warningInvoice.lineItem:va-charges.chargeItem[x]:chargeItemReferenceIf INTEGRATED BILLING ACTION - PARENT CHARGE <> INTEGRATED BILLING ACTION - IEN then reference ChargeItemremoved based on (null)
: true
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Invoice

NameFlagsCard.TypeDescription & Constraintsdoco
.. Invoice 0..* Invoice Invoice containing ChargeItems from an Account
... identifier S 0..* Identifier Business Identifier for item
... status S 1..1 code draft | issued | balanced | cancelled | entered-in-error
Binding: ARBillStatus FHIR (required): see mapping VF_ARBillStatus

... subject S 0..1 Reference(Patient) Recipient(s) of goods and services
... date S 0..1 dateTime Invoice date / posting date
... issuer S 0..1 Reference(Organization) Issuing Organization of Invoice
... account S 0..1 Reference(Debt Portal Account) Account that is being balanced
... Slices for lineItem 0..* BackboneElement Line items of this Invoice
Slice: Unordered, Open by value:$this
.... lineItem:va-charges 0..1 BackboneElement Line items of this Invoice
..... Slices for chargeItem[x] 1..1 Reference(ChargeItem), CodeableConcept Reference to ChargeItem containing details of this line item or an inline billing code
Slice: Unordered, Open by type:$this
...... chargeItem[x]:chargeItemReference SC 0..1 Reference(Debt Portal ChargeItem[charges] | Debt Portal ChargeItem[removed]) Reference to ChargeItem containing details of this line item or an inline billing code
dpi-17-1834: If INTEGRATED BILLING ACTION - PARENT CHARGE = INTEGRATED BILLING ACTION - IEN then reference ChargeItemcharges based on (null)
dpi-17-2220: If INTEGRATED BILLING ACTION - PARENT CHARGE <> INTEGRATED BILLING ACTION - IEN then reference ChargeItemremoved based on (null)
..... priceComponent
...... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: base
...... code
....... text S 0..1 string Plain text representation of the concept
Required Pattern: Total Charge
...... amount S 0..1 Money Monetary amount associated with this component
.... lineItem:va-interest 0..1 BackboneElement Line items of this Invoice
..... Slices for chargeItem[x] 1..1 Reference(ChargeItem), CodeableConcept Reference to ChargeItem containing details of this line item or an inline billing code
Slice: Unordered, Open by type:$this
...... chargeItem[x]:chargeItemReference S 0..1 Reference(Debt Portal ChargeItem[interest]) Reference to ChargeItem containing details of this line item or an inline billing code
..... Slices for priceComponent 0..* BackboneElement Components of total line item price
Slice: Unordered, Open by value:$this
...... priceComponent:va-marshal-fee-charged 0..1 BackboneElement Components of total line item price
....... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: surcharge
....... code
........ text S 0..1 string Plain text representation of the concept
Required Pattern: Marshal Fee Charged
....... amount S 0..1 Money Monetary amount associated with this component
...... priceComponent:va-court-cost-charged 0..1 BackboneElement Components of total line item price
....... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: surcharge
....... code
........ text S 0..1 string Plain text representation of the concept
Required Pattern: Court Cost Charged
....... amount S 0..1 Money Monetary amount associated with this component
...... priceComponent:va-interest-charged 0..1 BackboneElement Components of total line item price
....... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: surcharge
....... code
........ text S 0..1 string Plain text representation of the concept
Required Pattern: Interest Charged
....... amount S 0..1 Money Monetary amount associated with this component
...... priceComponent:va-admin-charged 0..1 BackboneElement Components of total line item price
....... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: surcharge
....... code
........ text S 0..1 string Plain text representation of the concept
Required Pattern: Administrative Charged
....... amount S 0..1 Money Monetary amount associated with this component
... Slices for totalPriceComponent 0..* Components of Invoice total
Slice: Unordered, Open by value:$this
.... totalPriceComponent:va-orig-amt 0..1 BackboneElement Components of Invoice total
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: informational
..... code
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Original Amount
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-curr-bal 0..1 BackboneElement Components of Invoice total
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: base
..... code
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Current Balance
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-amend-amt 0..1 BackboneElement Components of Invoice total
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: base
..... code
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Amended Amount
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-principal-bal 0..1 BackboneElement Components of Invoice total
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: base
..... code
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Principal Balance
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-interest-bal 0..1 BackboneElement Components of Invoice total
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: surcharge
..... code
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Interest Balance
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-admin-cost-bal 0..1 BackboneElement Components of Invoice total
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: surcharge
..... code
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Administrative Cost Balance
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-marsh-fee 0..1 BackboneElement Components of Invoice total
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: surcharge
..... code
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Marshal Fee
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-court-cost 0..1 BackboneElement Components of Invoice total
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: surcharge
..... code
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Court Cost
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-principal-paid 0..1 BackboneElement Components of Invoice total
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: base
..... code
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Principal Paid
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-interest-paid 0..1 BackboneElement Components of Invoice total
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: surcharge
..... code
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Interest Paid
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-admin-cost-paid 0..1 BackboneElement Components of Invoice total
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: surcharge
..... code
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Administrative Cost Paid
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-marsh-fee-paid 0..1 BackboneElement Components of Invoice total
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: surcharge
..... code
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Marshal Fee Paid
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-court-cost-paid 0..1 BackboneElement Components of Invoice total
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Required Pattern: surcharge
..... code
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Court Cost Paid
..... amount S 0..1 Money Monetary amount associated with this component

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Invoice.statusrequiredARBillStatus
http://va.gov/fhir/ValueSet/ARBillStatus
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dpi-17-1818warningInvoice.recipientIf type is PATIENT (#2) then reference Patient based on (430-9 > 340-.01)
: true
dpi-17-1834warningInvoice.lineItem:va-charges.chargeItem[x]:chargeItemReferenceIf INTEGRATED BILLING ACTION - PARENT CHARGE = INTEGRATED BILLING ACTION - IEN then reference ChargeItemcharges based on (null)
: true
dpi-17-2220warningInvoice.lineItem:va-charges.chargeItem[x]:chargeItemReferenceIf INTEGRATED BILLING ACTION - PARENT CHARGE <> INTEGRATED BILLING ACTION - IEN then reference ChargeItemremoved based on (null)
: true

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Invoice 0..* Invoice Invoice containing ChargeItems from an Account
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Business Identifier for item
... status ?!SΣ 1..1 code draft | issued | balanced | cancelled | entered-in-error
Binding: ARBillStatus FHIR (required): see mapping VF_ARBillStatus

... cancelledReason 0..1 string Reason for cancellation of this Invoice
... type Σ 0..1 CodeableConcept Type of Invoice
... subject SΣ 0..1 Reference(Patient) Recipient(s) of goods and services
... recipient SΣC 0..1 Reference(Debt Portal Patient) Recipient of this invoice
dpi-17-1818: If type is PATIENT (#2) then reference Patient based on (430-9 > 340-.01)
... date SΣ 0..1 dateTime Invoice date / posting date
... participant 0..* BackboneElement Participant in creation of this Invoice
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role 0..1 CodeableConcept Type of involvement in creation of this Invoice
.... actor 1..1 Reference(Practitioner | Organization | Patient | PractitionerRole | Device | RelatedPerson) Individual who was involved
... issuer S 0..1 Reference(Organization) Issuing Organization of Invoice
... account S 0..1 Reference(Debt Portal Account) Account that is being balanced
... Slices for lineItem 0..* BackboneElement Line items of this Invoice
Slice: Unordered, Open by value:$this
.... lineItem:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... sequence 0..1 positiveInt Sequence number of line item
..... chargeItem[x] 1..1 Reference to ChargeItem containing details of this line item or an inline billing code
...... chargeItemReference Reference(ChargeItem)
...... chargeItemCodeableConcept CodeableConcept
..... priceComponent 0..* BackboneElement Components of total line item price
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.

...... code 0..1 CodeableConcept Code identifying the specific component
...... factor 0..1 decimal Factor used for calculating this component
...... amount 0..1 Money Monetary amount associated with this component
.... lineItem:va-charges 0..1 BackboneElement Line items of this Invoice
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... sequence 0..1 positiveInt Sequence number of line item
..... Slices for chargeItem[x] 1..1 Reference to ChargeItem containing details of this line item or an inline billing code
Slice: Unordered, Open by type:$this
...... chargeItemReference Reference(ChargeItem)
...... chargeItemCodeableConcept CodeableConcept
...... chargeItem[x]:chargeItemReference SC 0..1 Reference(Debt Portal ChargeItem[charges] | Debt Portal ChargeItem[removed]) Reference to ChargeItem containing details of this line item or an inline billing code
dpi-17-1834: If INTEGRATED BILLING ACTION - PARENT CHARGE = INTEGRATED BILLING ACTION - IEN then reference ChargeItemcharges based on (null)
dpi-17-2220: If INTEGRATED BILLING ACTION - PARENT CHARGE <> INTEGRATED BILLING ACTION - IEN then reference ChargeItemremoved based on (null)
..... priceComponent 0..* BackboneElement Components of total line item price
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: base
...... code 0..1 CodeableConcept Code identifying the specific component
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ 0..* Coding Code defined by a terminology system
....... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Total Charge
...... factor 0..1 decimal Factor used for calculating this component
...... amount S 0..1 Money Monetary amount associated with this component
.... lineItem:va-interest 0..1 BackboneElement Line items of this Invoice
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... sequence 0..1 positiveInt Sequence number of line item
..... Slices for chargeItem[x] 1..1 Reference to ChargeItem containing details of this line item or an inline billing code
Slice: Unordered, Open by type:$this
...... chargeItemReference Reference(ChargeItem)
...... chargeItemCodeableConcept CodeableConcept
...... chargeItem[x]:chargeItemReference S 0..1 Reference(Debt Portal ChargeItem[interest]) Reference to ChargeItem containing details of this line item or an inline billing code
..... Slices for priceComponent 0..* BackboneElement Components of total line item price
Slice: Unordered, Open by value:$this
...... priceComponent:All Slices Content/Rules for all slices
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... type 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.

....... code 0..1 CodeableConcept Code identifying the specific component
....... factor 0..1 decimal Factor used for calculating this component
....... amount 0..1 Money Monetary amount associated with this component
...... priceComponent:va-marshal-fee-charged 0..1 BackboneElement Components of total line item price
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: surcharge
....... code 0..1 CodeableConcept Code identifying the specific component
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding Σ 0..* Coding Code defined by a terminology system
........ text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Marshal Fee Charged
....... factor 0..1 decimal Factor used for calculating this component
....... amount S 0..1 Money Monetary amount associated with this component
...... priceComponent:va-court-cost-charged 0..1 BackboneElement Components of total line item price
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: surcharge
....... code 0..1 CodeableConcept Code identifying the specific component
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding Σ 0..* Coding Code defined by a terminology system
........ text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Court Cost Charged
....... factor 0..1 decimal Factor used for calculating this component
....... amount S 0..1 Money Monetary amount associated with this component
...... priceComponent:va-interest-charged 0..1 BackboneElement Components of total line item price
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: surcharge
....... code 0..1 CodeableConcept Code identifying the specific component
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding Σ 0..* Coding Code defined by a terminology system
........ text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Interest Charged
....... factor 0..1 decimal Factor used for calculating this component
....... amount S 0..1 Money Monetary amount associated with this component
...... priceComponent:va-admin-charged 0..1 BackboneElement Components of total line item price
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: surcharge
....... code 0..1 CodeableConcept Code identifying the specific component
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding Σ 0..* Coding Code defined by a terminology system
........ text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Administrative Charged
....... factor 0..1 decimal Factor used for calculating this component
....... amount S 0..1 Money Monetary amount associated with this component
... Slices for totalPriceComponent 0..* See priceComponent (Invoice) Components of Invoice total
Slice: Unordered, Open by value:$this
.... totalPriceComponent:va-orig-amt 0..1 BackboneElement Components of Invoice total
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: informational
..... code 0..1 CodeableConcept Code identifying the specific component
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Original Amount
..... factor 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-curr-bal 0..1 BackboneElement Components of Invoice total
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: base
..... code 0..1 CodeableConcept Code identifying the specific component
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Current Balance
..... factor 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-amend-amt 0..1 BackboneElement Components of Invoice total
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: base
..... code 0..1 CodeableConcept Code identifying the specific component
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Amended Amount
..... factor 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-principal-bal 0..1 BackboneElement Components of Invoice total
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: base
..... code 0..1 CodeableConcept Code identifying the specific component
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Principal Balance
..... factor 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-interest-bal 0..1 BackboneElement Components of Invoice total
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Interest Balance
..... factor 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-admin-cost-bal 0..1 BackboneElement Components of Invoice total
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Administrative Cost Balance
..... factor 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-marsh-fee 0..1 BackboneElement Components of Invoice total
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Marshal Fee
..... factor 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-court-cost 0..1 BackboneElement Components of Invoice total
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Court Cost
..... factor 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-principal-paid 0..1 BackboneElement Components of Invoice total
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: base
..... code 0..1 CodeableConcept Code identifying the specific component
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Principal Paid
..... factor 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-interest-paid 0..1 BackboneElement Components of Invoice total
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Interest Paid
..... factor 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-admin-cost-paid 0..1 BackboneElement Components of Invoice total
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Administrative Cost Paid
..... factor 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-marsh-fee-paid 0..1 BackboneElement Components of Invoice total
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Marshal Fee Paid
..... factor 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component
.... totalPriceComponent:va-court-cost-paid 0..1 BackboneElement Components of Invoice total
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.


Required Pattern: surcharge
..... code 0..1 CodeableConcept Code identifying the specific component
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Court Cost Paid
..... factor 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component
... totalNet Σ 0..1 Money Net total of this Invoice
... totalGross Σ 0..1 Money Gross total of this Invoice
... paymentTerms 0..1 markdown Payment details
... note 0..* Annotation Comments made about the invoice

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Invoice.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Invoice.statusrequiredARBillStatus
http://va.gov/fhir/ValueSet/ARBillStatus
from this IG
Invoice.lineItem.priceComponent.typerequiredInvoicePriceComponentType
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.lineItem:va-charges.priceComponent.typerequiredPattern: base
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.lineItem:va-interest.priceComponent.typerequiredInvoicePriceComponentType
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.lineItem:va-interest.priceComponent:va-marshal-fee-charged.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.lineItem:va-interest.priceComponent:va-court-cost-charged.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.lineItem:va-interest.priceComponent:va-interest-charged.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.lineItem:va-interest.priceComponent:va-admin-charged.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-orig-amt.typerequiredPattern: informational
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-curr-bal.typerequiredPattern: base
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-amend-amt.typerequiredPattern: base
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-principal-bal.typerequiredPattern: base
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-interest-bal.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-admin-cost-bal.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-marsh-fee.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-court-cost.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-principal-paid.typerequiredPattern: base
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-interest-paid.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-admin-cost-paid.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-marsh-fee-paid.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
Invoice.totalPriceComponent:va-court-cost-paid.typerequiredPattern: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorInvoiceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorInvoiceIf 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-4errorInvoiceIf 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-5errorInvoiceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceInvoiceA resource should have narrative for robust management
: text.`div`.exists()
dpi-17-1818warningInvoice.recipientIf type is PATIENT (#2) then reference Patient based on (430-9 > 340-.01)
: true
dpi-17-1834warningInvoice.lineItem:va-charges.chargeItem[x]:chargeItemReferenceIf INTEGRATED BILLING ACTION - PARENT CHARGE = INTEGRATED BILLING ACTION - IEN then reference ChargeItemcharges based on (null)
: true
dpi-17-2220warningInvoice.lineItem:va-charges.chargeItem[x]:chargeItemReferenceIf INTEGRATED BILLING ACTION - PARENT CHARGE <> INTEGRATED BILLING ACTION - IEN then reference ChargeItemremoved based on (null)
: true
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Invoice

Summary

Must-Support: 63 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Invoice.lineItem
  • The element 1 is sliced based on the value of Invoice.lineItem.chargeItem[x]
  • The element 1 is sliced based on the value of Invoice.lineItem.priceComponent
  • The element 1 is sliced based on the value of Invoice.totalPriceComponent

 

Other representations of profile: CSV, Excel, Schematron