US Veterans Health Administration FHIR Map Set Implementation Guide
1.10.0 - 251101 United States of America flag

US Veterans Health Administration FHIR Map Set Implementation Guide - Downloaded Version 1.10.0 See the Directory of published versions

Resource Profile: Debt Portal Invoice

Official URL: http://va.gov/fhir/StructureDefinition/DebtPortalInvoice Version: 1.10.0
Active as of 2025-11-04 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«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].valueReferencePatientPatientOrganizationPatientEncounterVisitEncounterPTFEncounterMedicationDispenseOriginalMedicationDispenseRefillMedicationDispensePartial

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* Invoice(4.0.1) Invoice containing ChargeItems from an Account
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Business Identifier for item
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:alternate-codes S 0..1 (Complex) Alternate code/original text for this code
URL: http://hl7.org/fhir/StructureDefinition/alternate-codes
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-codes"
...... value[x] 1..1 CodeableConcept Value of extension
....... coding SΣ 0..* Coding Code defined by a terminology system
........ system SΣ 0..1 uri Identity of the terminology system
Required Pattern: http://va.gov/terminology/vistaDefinedTerms/430.3
........ code SΣ 0..1 code Symbol in syntax defined by the system
........ display SΣ 0..1 string Representation defined by the system
... 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
Constraints: dpi-17-1818
... 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:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... chargeItem[x] 1..1 Reference to ChargeItem containing details of this line item or an inline billing code
...... chargeItemReference Reference(ChargeItem)
...... chargeItemCodeableConcept CodeableConcept
.... lineItem:va-charges S 0..1 BackboneElement Line items of this Invoice
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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
Constraints: dpi-17-1834, dpi-17-2220
..... priceComponent 0..* BackboneElement Components of total line item price
...... 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
....... 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 S 0..1 BackboneElement Line items of this Invoice
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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
....... 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.
...... priceComponent:va-marshal-fee-charged 0..1 BackboneElement Components of total line item price
....... 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
........ 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
....... 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
........ 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
....... 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
........ 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
....... 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
........ 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..* See priceComponent (Invoice) Components of Invoice total
Slice: Unordered, Open by value:$this
.... totalPriceComponent:All Slices Content/Rules for all slices
..... 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.
.... totalPriceComponent:va-orig-amt S 0..1 BackboneElement Components of Invoice total
..... 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
...... 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 S 0..1 BackboneElement Components of Invoice total
..... 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
...... 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 S 0..1 BackboneElement Components of Invoice total
..... 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
...... 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 S 0..1 BackboneElement Components of Invoice total
..... 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
...... 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 S 0..1 BackboneElement Components of Invoice total
..... 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
...... 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 S 0..1 BackboneElement Components of Invoice total
..... 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
...... 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 S 0..1 BackboneElement Components of Invoice total
..... 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
...... 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 S 0..1 BackboneElement Components of Invoice total
..... 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
...... 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 S 0..1 BackboneElement Components of Invoice total
..... 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
...... 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 S 0..1 BackboneElement Components of Invoice total
..... 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
...... 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 S 0..1 BackboneElement Components of Invoice total
..... 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
...... 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 S 0..1 BackboneElement Components of Invoice total
..... 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
...... 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 S 0..1 BackboneElement Components of Invoice total
..... 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
...... 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

Path Status Usage ValueSet Version Source
Invoice.status Base required ARBillStatus FHIR 📦1.10.0 This IG
Invoice.lineItem:va-charges.​priceComponent.type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.lineItem:va-interest.​priceComponent.type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.lineItem:va-interest.​priceComponent:va-marshal-fee-charged.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.lineItem:va-interest.​priceComponent:va-court-cost-charged.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.lineItem:va-interest.​priceComponent:va-interest-charged.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.lineItem:va-interest.​priceComponent:va-admin-charged.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-orig-amt.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-curr-bal.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-amend-amt.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-principal-bal.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-interest-bal.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-admin-cost-bal.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-marsh-fee.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-court-cost.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-principal-paid.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-interest-paid.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-admin-cost-paid.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-marsh-fee-paid.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-court-cost-paid.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Invoice If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Invoice If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Invoice If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Invoice If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Invoice A resource should have narrative for robust management text.`div`.exists()
dpi-17-1818 best practice Invoice.recipient If type is PATIENT (#2) then reference Patient based on (430-9 > 340-.01) true
dpi-17-1834 best practice Invoice.lineItem:va-charges.chargeItem[x]:chargeItemReference If INTEGRATED BILLING ACTION - PARENT CHARGE = INTEGRATED BILLING ACTION - IEN then reference ChargeItemcharges based on (null) true
dpi-17-2220 best practice Invoice.lineItem:va-charges.chargeItem[x]:chargeItemReference If INTEGRATED BILLING ACTION - PARENT CHARGE <> INTEGRATED BILLING ACTION - IEN then reference ChargeItemremoved based on (null) true
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Invoice

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* Invoice(4.0.1) 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
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:alternate-codes S 0..1 (Complex) Alternate code/original text for this code
URL: http://hl7.org/fhir/StructureDefinition/alternate-codes
...... value[x]
....... coding S 0..* Coding Code defined by a terminology system
........ system S 0..1 uri Identity of the terminology system
Required Pattern: http://va.gov/terminology/vistaDefinedTerms/430.3
........ code S 0..1 code Symbol in syntax defined by the system
........ display S 0..1 string Representation defined by the system
... 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 S 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
Constraints: dpi-17-1834, dpi-17-2220
..... 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 S 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 S 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 S 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 S 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 S 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 S 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 S 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 S 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 S 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 S 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 S 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 S 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 S 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 S 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)

Path Status Usage ValueSet Version Source
Invoice.status Base required ARBillStatus FHIR 📦1.10.0 This IG

Constraints

Id Grade Path(s) Description Expression
dpi-17-1818 best practice Invoice.recipient If type is PATIENT (#2) then reference Patient based on (430-9 > 340-.01) true
dpi-17-1834 best practice Invoice.lineItem:va-charges.chargeItem[x]:chargeItemReference If INTEGRATED BILLING ACTION - PARENT CHARGE = INTEGRATED BILLING ACTION - IEN then reference ChargeItemcharges based on (null) true
dpi-17-2220 best practice Invoice.lineItem:va-charges.chargeItem[x]:chargeItemReference If INTEGRATED BILLING ACTION - PARENT CHARGE <> INTEGRATED BILLING ACTION - IEN then reference ChargeItemremoved based on (null) true
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* Invoice(4.0.1) 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:alternate-codes S 0..1 (Complex) Alternate code/original text for this code
URL: http://hl7.org/fhir/StructureDefinition/alternate-codes
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-codes"
...... value[x] 1..1 CodeableConcept Value of extension
....... 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 SΣ 0..* Coding Code defined by a terminology system
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ system SΣ 0..1 uri Identity of the terminology system
Required Pattern: http://va.gov/terminology/vistaDefinedTerms/430.3
........ version Σ 0..1 string Version of the system - if relevant
........ code SΣ 0..1 code Symbol in syntax defined by the system
........ display SΣ 0..1 string Representation defined by the system
........ userSelected Σ 0..1 boolean If this coding was chosen directly by the user
....... text Σ 0..1 string Plain text representation of the concept
.... value 0..1 string Primitive value for code
... 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
Constraints: dpi-17-1818
... 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 S 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
Constraints: dpi-17-1834, dpi-17-2220
..... 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 S 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: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
.... totalPriceComponent:va-orig-amt S 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 S 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 S 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 S 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 S 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 S 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 S 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 S 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 S 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 S 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 S 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 S 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 S 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

Path Status Usage ValueSet Version Source
Invoice.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Invoice.status Base required ARBillStatus FHIR 📦1.10.0 This IG
Invoice.lineItem.priceComponent.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.lineItem:va-charges.​priceComponent.type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.lineItem:va-interest.​priceComponent.type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.lineItem:va-interest.​priceComponent:va-marshal-fee-charged.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.lineItem:va-interest.​priceComponent:va-court-cost-charged.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.lineItem:va-interest.​priceComponent:va-interest-charged.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.lineItem:va-interest.​priceComponent:va-admin-charged.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-orig-amt.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-curr-bal.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-amend-amt.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-principal-bal.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-interest-bal.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-admin-cost-bal.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-marsh-fee.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-court-cost.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-principal-paid.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-interest-paid.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-admin-cost-paid.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-marsh-fee-paid.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-court-cost-paid.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Invoice If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Invoice If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Invoice If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Invoice If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Invoice A resource should have narrative for robust management text.`div`.exists()
dpi-17-1818 best practice Invoice.recipient If type is PATIENT (#2) then reference Patient based on (430-9 > 340-.01) true
dpi-17-1834 best practice Invoice.lineItem:va-charges.chargeItem[x]:chargeItemReference If INTEGRATED BILLING ACTION - PARENT CHARGE = INTEGRATED BILLING ACTION - IEN then reference ChargeItemcharges based on (null) true
dpi-17-2220 best practice Invoice.lineItem:va-charges.chargeItem[x]:chargeItemReference If INTEGRATED BILLING ACTION - PARENT CHARGE <> INTEGRATED BILLING ACTION - IEN then reference ChargeItemremoved based on (null) true
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Invoice

Summary

Must-Support: 83 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

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 & Constraints    Filter: Filtersdoco
.. Invoice 0..* Invoice(4.0.1) Invoice containing ChargeItems from an Account
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Business Identifier for item
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:alternate-codes S 0..1 (Complex) Alternate code/original text for this code
URL: http://hl7.org/fhir/StructureDefinition/alternate-codes
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-codes"
...... value[x] 1..1 CodeableConcept Value of extension
....... coding SΣ 0..* Coding Code defined by a terminology system
........ system SΣ 0..1 uri Identity of the terminology system
Required Pattern: http://va.gov/terminology/vistaDefinedTerms/430.3
........ code SΣ 0..1 code Symbol in syntax defined by the system
........ display SΣ 0..1 string Representation defined by the system
... 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
Constraints: dpi-17-1818
... 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:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... chargeItem[x] 1..1 Reference to ChargeItem containing details of this line item or an inline billing code
...... chargeItemReference Reference(ChargeItem)
...... chargeItemCodeableConcept CodeableConcept
.... lineItem:va-charges S 0..1 BackboneElement Line items of this Invoice
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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
Constraints: dpi-17-1834, dpi-17-2220
..... priceComponent 0..* BackboneElement Components of total line item price
...... 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
....... 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 S 0..1 BackboneElement Line items of this Invoice
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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
....... 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.
...... priceComponent:va-marshal-fee-charged 0..1 BackboneElement Components of total line item price
....... 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
........ 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
....... 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
........ 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
....... 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
........ 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
....... 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
........ 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..* See priceComponent (Invoice) Components of Invoice total
Slice: Unordered, Open by value:$this
.... totalPriceComponent:All Slices Content/Rules for all slices
..... 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.
.... totalPriceComponent:va-orig-amt S 0..1 BackboneElement Components of Invoice total
..... 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
...... 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 S 0..1 BackboneElement Components of Invoice total
..... 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
...... 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 S 0..1 BackboneElement Components of Invoice total
..... 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
...... 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 S 0..1 BackboneElement Components of Invoice total
..... 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
...... 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 S 0..1 BackboneElement Components of Invoice total
..... 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
...... 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 S 0..1 BackboneElement Components of Invoice total
..... 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
...... 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 S 0..1 BackboneElement Components of Invoice total
..... 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
...... 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 S 0..1 BackboneElement Components of Invoice total
..... 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
...... 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 S 0..1 BackboneElement Components of Invoice total
..... 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
...... 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 S 0..1 BackboneElement Components of Invoice total
..... 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
...... 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 S 0..1 BackboneElement Components of Invoice total
..... 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
...... 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 S 0..1 BackboneElement Components of Invoice total
..... 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
...... 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 S 0..1 BackboneElement Components of Invoice total
..... 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
...... 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

Path Status Usage ValueSet Version Source
Invoice.status Base required ARBillStatus FHIR 📦1.10.0 This IG
Invoice.lineItem:va-charges.​priceComponent.type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.lineItem:va-interest.​priceComponent.type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.lineItem:va-interest.​priceComponent:va-marshal-fee-charged.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.lineItem:va-interest.​priceComponent:va-court-cost-charged.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.lineItem:va-interest.​priceComponent:va-interest-charged.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.lineItem:va-interest.​priceComponent:va-admin-charged.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-orig-amt.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-curr-bal.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-amend-amt.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-principal-bal.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-interest-bal.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-admin-cost-bal.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-marsh-fee.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-court-cost.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-principal-paid.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-interest-paid.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-admin-cost-paid.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-marsh-fee-paid.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-court-cost-paid.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Invoice If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Invoice If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Invoice If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Invoice If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Invoice A resource should have narrative for robust management text.`div`.exists()
dpi-17-1818 best practice Invoice.recipient If type is PATIENT (#2) then reference Patient based on (430-9 > 340-.01) true
dpi-17-1834 best practice Invoice.lineItem:va-charges.chargeItem[x]:chargeItemReference If INTEGRATED BILLING ACTION - PARENT CHARGE = INTEGRATED BILLING ACTION - IEN then reference ChargeItemcharges based on (null) true
dpi-17-2220 best practice Invoice.lineItem:va-charges.chargeItem[x]:chargeItemReference If INTEGRATED BILLING ACTION - PARENT CHARGE <> INTEGRATED BILLING ACTION - IEN then reference ChargeItemremoved based on (null) true
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Invoice

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* Invoice(4.0.1) 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
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:alternate-codes S 0..1 (Complex) Alternate code/original text for this code
URL: http://hl7.org/fhir/StructureDefinition/alternate-codes
...... value[x]
....... coding S 0..* Coding Code defined by a terminology system
........ system S 0..1 uri Identity of the terminology system
Required Pattern: http://va.gov/terminology/vistaDefinedTerms/430.3
........ code S 0..1 code Symbol in syntax defined by the system
........ display S 0..1 string Representation defined by the system
... 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 S 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
Constraints: dpi-17-1834, dpi-17-2220
..... 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 S 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 S 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 S 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 S 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 S 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 S 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 S 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 S 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 S 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 S 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 S 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 S 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 S 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 S 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)

Path Status Usage ValueSet Version Source
Invoice.status Base required ARBillStatus FHIR 📦1.10.0 This IG

Constraints

Id Grade Path(s) Description Expression
dpi-17-1818 best practice Invoice.recipient If type is PATIENT (#2) then reference Patient based on (430-9 > 340-.01) true
dpi-17-1834 best practice Invoice.lineItem:va-charges.chargeItem[x]:chargeItemReference If INTEGRATED BILLING ACTION - PARENT CHARGE = INTEGRATED BILLING ACTION - IEN then reference ChargeItemcharges based on (null) true
dpi-17-2220 best practice Invoice.lineItem:va-charges.chargeItem[x]:chargeItemReference If INTEGRATED BILLING ACTION - PARENT CHARGE <> INTEGRATED BILLING ACTION - IEN then reference ChargeItemremoved based on (null) true

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* Invoice(4.0.1) 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:alternate-codes S 0..1 (Complex) Alternate code/original text for this code
URL: http://hl7.org/fhir/StructureDefinition/alternate-codes
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-codes"
...... value[x] 1..1 CodeableConcept Value of extension
....... 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 SΣ 0..* Coding Code defined by a terminology system
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ system SΣ 0..1 uri Identity of the terminology system
Required Pattern: http://va.gov/terminology/vistaDefinedTerms/430.3
........ version Σ 0..1 string Version of the system - if relevant
........ code SΣ 0..1 code Symbol in syntax defined by the system
........ display SΣ 0..1 string Representation defined by the system
........ userSelected Σ 0..1 boolean If this coding was chosen directly by the user
....... text Σ 0..1 string Plain text representation of the concept
.... value 0..1 string Primitive value for code
... 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
Constraints: dpi-17-1818
... 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 S 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
Constraints: dpi-17-1834, dpi-17-2220
..... 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 S 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: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
.... totalPriceComponent:va-orig-amt S 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 S 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 S 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 S 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 S 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 S 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 S 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 S 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 S 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 S 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 S 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 S 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 S 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

Path Status Usage ValueSet Version Source
Invoice.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Invoice.status Base required ARBillStatus FHIR 📦1.10.0 This IG
Invoice.lineItem.priceComponent.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.lineItem:va-charges.​priceComponent.type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.lineItem:va-interest.​priceComponent.type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.lineItem:va-interest.​priceComponent:va-marshal-fee-charged.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.lineItem:va-interest.​priceComponent:va-court-cost-charged.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.lineItem:va-interest.​priceComponent:va-interest-charged.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.lineItem:va-interest.​priceComponent:va-admin-charged.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-orig-amt.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-curr-bal.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-amend-amt.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-principal-bal.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-interest-bal.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-admin-cost-bal.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-marsh-fee.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-court-cost.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-principal-paid.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-interest-paid.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-admin-cost-paid.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-marsh-fee-paid.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.totalPriceComponent:va-court-cost-paid.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Invoice If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Invoice If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Invoice If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Invoice If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Invoice A resource should have narrative for robust management text.`div`.exists()
dpi-17-1818 best practice Invoice.recipient If type is PATIENT (#2) then reference Patient based on (430-9 > 340-.01) true
dpi-17-1834 best practice Invoice.lineItem:va-charges.chargeItem[x]:chargeItemReference If INTEGRATED BILLING ACTION - PARENT CHARGE = INTEGRATED BILLING ACTION - IEN then reference ChargeItemcharges based on (null) true
dpi-17-2220 best practice Invoice.lineItem:va-charges.chargeItem[x]:chargeItemReference If INTEGRATED BILLING ACTION - PARENT CHARGE <> INTEGRATED BILLING ACTION - IEN then reference ChargeItemremoved based on (null) true
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Invoice

Summary

Must-Support: 83 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

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