1.0.0 - release

CambioOpenServicesIG - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: InvoiceSe(version 1) [Deprecated]

Official URL: https://fhir.cambio.se/StructureDefinition/InvoiceSe Version: 1.0.0
Retired as of 2023-02-23 Computable Name: InvoiceSeV1

Introduction

Please note that this version of the Invoice profile is deprecated and the recommended profile to use is InvoiceSe(version 2).

The Invoice resource contains the payment details related to a single patient visit. The profile is based on the Invoice in FHIR STU4 edition.

Specific Rules and Limitations

Type Description
Rule N/A

Versions

COS version Profile version Required COSMIC version Date Description
N/A 1.0.0 N/A Nov 2021 Deprecated version, latest version is Invoice(version 2).

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

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..* InvoiceCore Invoice containing ChargeItems from an Account
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:businessStatus 1..1 (Complex) Extension
URL: https://fhir.cambio.se/StructureDefinition/common-businessStatus/v1
..... extension 0..0
..... url 1..1 uri "https://fhir.cambio.se/StructureDefinition/common-businessStatus/v1"
..... value[x] 0..1 CodeableConcept Value of extension
Binding: InvoiceBusinessStatus (required)
.... extension:registeredPaymentMethod 0..1 (Complex) Extension
URL: https://fhir.cambio.se/StructureDefinition/invoice-registeredPaymentMethod/v1
..... extension 0..0
..... url 1..1 uri "https://fhir.cambio.se/StructureDefinition/invoice-registeredPaymentMethod/v1"
..... value[x] 0..1 Coding Value of extension
Binding: Registered Payment Method (required)
.... extension:paymentMethodOption 0..* Coding Extension
URL: https://fhir.cambio.se/StructureDefinition/invoice-paymentMethodOption/v1
Binding: PaymentMethodOptions (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... subject Σ 1..1 Reference(Patient) Recipient(s) of goods and services
... issuer 0..1 Reference(OrganizationInvoiceSe) {c} Issuing Organization of Invoice
... totalNet Σ 1..1 Money Net total of this Invoice

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Invoice.extension:businessStatus.value[x]requiredInvoiceBusinessStatus
https://fhir.cambio.se/ValueSet/InvoiceBusinessStatus/v1
From this IG
Invoice.extension:registeredPaymentMethod.value[x]requiredRegisteredPaymentMethod
https://fhir.cambio.se/ValueSet/RegisteredPaymentMethod/v1
From this IG
Invoice.statusrequiredInvoiceStatus
http://hl7.org/fhir/ValueSet/invoice-status|4.0.1
From the FHIR Standard
Invoice.totalGross.currencyrequiredFixed Value: SEK
http://hl7.org/fhir/ValueSet/currencies|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorInvoiceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorInvoiceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorInvoiceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorInvoiceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceInvoiceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from InvoiceCore

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* InvoiceCore Invoice containing ChargeItems from an Account
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:businessStatus 1..1 (Complex) Extension
URL: https://fhir.cambio.se/StructureDefinition/common-businessStatus/v1
..... value[x] 0..1 CodeableConcept Value of extension
Binding: InvoiceBusinessStatus (required)
.... extension:registeredPaymentMethod 0..1 (Complex) Extension
URL: https://fhir.cambio.se/StructureDefinition/invoice-registeredPaymentMethod/v1
..... value[x] 0..1 Coding Value of extension
Binding: Registered Payment Method (required)
.... extension:paymentMethodOption 0..* Coding Extension
URL: https://fhir.cambio.se/StructureDefinition/invoice-paymentMethodOption/v1
Binding: PaymentMethodOptions (required)
... identifier 0..0
... status 1..1 code draft | issued | balanced | cancelled | entered-in-error
... type 0..0
... subject 1..1 Reference(Patient) Recipient(s) of goods and services
... recipient 0..0
... participant 0..0
... issuer 0..1 Reference(OrganizationInvoiceSe) {c} Issuing Organization of Invoice
... account 0..0
... lineItem
.... sequence 0..0
.... chargeItem[x] 1..1 Reference(ChargeItemSe(version 1) [Deprecated]) {b} Reference to ChargeItem containing details of this line item or an inline billing code
.... Slices for priceComponent 1..* BackboneElement Components of total line item price
Slice: Unordered, Open by value:code.coding.id
..... priceComponent:All Slices Content/Rules for all slices
...... code
....... coding 0..* Coding Code defined by a terminology system
Binding: CostTypes (required)
........ system 0..1 uri Identity of the terminology system
Fixed Value: https://cambio.codes/cs/cost-types
...... amount
....... currency 0..1 code ISO 4217 Currency Code
Fixed Value: SEK
..... priceComponent:basePrice 1..1 BackboneElement Base price
...... type 1..1 code base | surcharge | deduction | discount | tax | informational
Fixed Value: base
..... priceComponent:discount 0..* BackboneElement Components of total line item price
...... type 1..1 code base | surcharge | deduction | discount | tax | informational
Fixed Value: discount
..... priceComponent:surcharge 0..* BackboneElement Components of total line item price
...... type 1..1 code base | surcharge | deduction | discount | tax | informational
Fixed Value: surcharge
...... code
....... coding 0..1 Coding Code defined by a terminology system
....... text 0..1 string Plain text representation of the concept
... totalPriceComponent 0..0
... totalNet 1..1 Money Net total of this Invoice
... totalGross 0..0
... paymentTerms 0..0
... note 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Invoice.extension:businessStatus.value[x]requiredInvoiceBusinessStatus
https://fhir.cambio.se/ValueSet/InvoiceBusinessStatus/v1
From this IG
Invoice.extension:registeredPaymentMethod.value[x]requiredRegisteredPaymentMethod
https://fhir.cambio.se/ValueSet/RegisteredPaymentMethod/v1
From this IG
Invoice.lineItem.priceComponent.code.codingrequiredCostTypes
https://fhir.cambio.se/ValueSet/CostTypes/v1
From this IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* InvoiceCore 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
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:businessStatus 1..1 (Complex) Extension
URL: https://fhir.cambio.se/StructureDefinition/common-businessStatus/v1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "https://fhir.cambio.se/StructureDefinition/common-businessStatus/v1"
..... value[x] 0..1 CodeableConcept Value of extension
Binding: InvoiceBusinessStatus (required)
.... extension:registeredPaymentMethod 0..1 (Complex) Extension
URL: https://fhir.cambio.se/StructureDefinition/invoice-registeredPaymentMethod/v1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "https://fhir.cambio.se/StructureDefinition/invoice-registeredPaymentMethod/v1"
..... value[x] 0..1 Coding Value of extension
Binding: Registered Payment Method (required)
.... extension:paymentMethodOption 0..* Coding Extension
URL: https://fhir.cambio.se/StructureDefinition/invoice-paymentMethodOption/v1
Binding: PaymentMethodOptions (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code draft | issued | balanced | cancelled | entered-in-error
Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice.
... subject Σ 1..1 Reference(Patient) Recipient(s) of goods and services
... date Σ 0..1 dateTime Invoice date / posting date
... issuer 0..1 Reference(OrganizationInvoiceSe) {c} Issuing Organization of Invoice
... lineItem 0..* 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
.... chargeItem[x] 1..1 Reference(ChargeItemSe(version 1) [Deprecated]) {b} Reference to ChargeItem containing details of this line item or an inline billing code
.... Slices for priceComponent 1..* BackboneElement Components of total line item price
Slice: Unordered, Open by value:code.coding.id
..... 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
....... 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
Binding: CostTypes (required)
........ 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 Σ 0..1 uri Identity of the terminology system
Fixed Value: https://cambio.codes/cs/cost-types
........ version Σ 0..1 string Version of the system - if relevant
........ code Σ 0..1 code Symbol in syntax defined by the system
........ display Σ 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
...... factor 0..1 decimal Factor used for calculating this component
...... amount 0..1 Money Monetary amount associated with this 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
....... value Σ 0..1 decimal Numerical value (with implicit precision)
....... currency Σ 0..1 code ISO 4217 Currency Code
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.
Fixed Value: SEK
..... priceComponent:basePrice 1..1 BackboneElement Base 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.
Fixed Value: 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
Binding: CostTypes (required)
........ 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 Σ 0..1 uri Identity of the terminology system
Fixed Value: https://cambio.codes/cs/cost-types
........ version Σ 0..1 string Version of the system - if relevant
........ code Σ 0..1 code Symbol in syntax defined by the system
........ display Σ 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
...... factor 0..1 decimal Factor used for calculating this component
...... amount 0..1 Money Monetary amount associated with this 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
....... value Σ 0..1 decimal Numerical value (with implicit precision)
....... currency Σ 0..1 code ISO 4217 Currency Code
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.
Fixed Value: SEK
..... priceComponent:discount 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.
Fixed Value: discount
...... 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
Binding: CostTypes (required)
........ 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 Σ 0..1 uri Identity of the terminology system
Fixed Value: https://cambio.codes/cs/cost-types
........ version Σ 0..1 string Version of the system - if relevant
........ code Σ 0..1 code Symbol in syntax defined by the system
........ display Σ 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
...... factor 0..1 decimal Factor used for calculating this component
...... amount 0..1 Money Monetary amount associated with this 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
....... value Σ 0..1 decimal Numerical value (with implicit precision)
....... currency Σ 0..1 code ISO 4217 Currency Code
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.
Fixed Value: SEK
..... priceComponent:surcharge 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.
Fixed Value: 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..1 Coding Code defined by a terminology system
Binding: CostTypes (required)
........ 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 Σ 0..1 uri Identity of the terminology system
Fixed Value: https://cambio.codes/cs/cost-types
........ version Σ 0..1 string Version of the system - if relevant
........ code Σ 0..1 code Symbol in syntax defined by the system
........ display Σ 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
...... factor 0..1 decimal Factor used for calculating this component
...... amount 0..1 Money Monetary amount associated with this 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
....... value Σ 0..1 decimal Numerical value (with implicit precision)
....... currency Σ 0..1 code ISO 4217 Currency Code
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.
Fixed Value: SEK
... totalNet Σ 1..1 Money Net total of this Invoice

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Invoice.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Invoice.extension:businessStatus.value[x]requiredInvoiceBusinessStatus
https://fhir.cambio.se/ValueSet/InvoiceBusinessStatus/v1
From this IG
Invoice.extension:registeredPaymentMethod.value[x]requiredRegisteredPaymentMethod
https://fhir.cambio.se/ValueSet/RegisteredPaymentMethod/v1
From this IG
Invoice.statusrequiredInvoiceStatus
http://hl7.org/fhir/ValueSet/invoice-status|4.0.1
From the FHIR Standard
Invoice.lineItem.priceComponent.typerequiredInvoicePriceComponentType
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
From the FHIR Standard
Invoice.lineItem.priceComponent.code.codingrequiredCostTypes
https://fhir.cambio.se/ValueSet/CostTypes/v1
From this IG
Invoice.lineItem.priceComponent.amount.currencyrequiredFixed Value: SEK
http://hl7.org/fhir/ValueSet/currencies|4.0.1
From the FHIR Standard
Invoice.lineItem.priceComponent:basePrice.typerequiredFixed Value: base
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
From the FHIR Standard
Invoice.lineItem.priceComponent:basePrice.code.codingrequiredCostTypes
https://fhir.cambio.se/ValueSet/CostTypes/v1
From this IG
Invoice.lineItem.priceComponent:basePrice.amount.currencyrequiredFixed Value: SEK
http://hl7.org/fhir/ValueSet/currencies|4.0.1
From the FHIR Standard
Invoice.lineItem.priceComponent:discount.typerequiredFixed Value: discount
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
From the FHIR Standard
Invoice.lineItem.priceComponent:discount.code.codingrequiredCostTypes
https://fhir.cambio.se/ValueSet/CostTypes/v1
From this IG
Invoice.lineItem.priceComponent:discount.amount.currencyrequiredFixed Value: SEK
http://hl7.org/fhir/ValueSet/currencies|4.0.1
From the FHIR Standard
Invoice.lineItem.priceComponent:surcharge.typerequiredFixed Value: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
From the FHIR Standard
Invoice.lineItem.priceComponent:surcharge.code.codingrequiredCostTypes
https://fhir.cambio.se/ValueSet/CostTypes/v1
From this IG
Invoice.lineItem.priceComponent:surcharge.amount.currencyrequiredFixed Value: SEK
http://hl7.org/fhir/ValueSet/currencies|4.0.1
From the FHIR Standard
Invoice.totalGross.currencyrequiredFixed Value: SEK
http://hl7.org/fhir/ValueSet/currencies|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorInvoiceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorInvoiceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorInvoiceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorInvoiceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceInvoiceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from InvoiceCore

Summary

Mandatory: 4 elements(2 nested mandatory elements)
Fixed: 6 elements
Prohibited: 11 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.priceComponent

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* InvoiceCore Invoice containing ChargeItems from an Account
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:businessStatus 1..1 (Complex) Extension
URL: https://fhir.cambio.se/StructureDefinition/common-businessStatus/v1
..... extension 0..0
..... url 1..1 uri "https://fhir.cambio.se/StructureDefinition/common-businessStatus/v1"
..... value[x] 0..1 CodeableConcept Value of extension
Binding: InvoiceBusinessStatus (required)
.... extension:registeredPaymentMethod 0..1 (Complex) Extension
URL: https://fhir.cambio.se/StructureDefinition/invoice-registeredPaymentMethod/v1
..... extension 0..0
..... url 1..1 uri "https://fhir.cambio.se/StructureDefinition/invoice-registeredPaymentMethod/v1"
..... value[x] 0..1 Coding Value of extension
Binding: Registered Payment Method (required)
.... extension:paymentMethodOption 0..* Coding Extension
URL: https://fhir.cambio.se/StructureDefinition/invoice-paymentMethodOption/v1
Binding: PaymentMethodOptions (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... subject Σ 1..1 Reference(Patient) Recipient(s) of goods and services
... issuer 0..1 Reference(OrganizationInvoiceSe) {c} Issuing Organization of Invoice
... totalNet Σ 1..1 Money Net total of this Invoice

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Invoice.extension:businessStatus.value[x]requiredInvoiceBusinessStatus
https://fhir.cambio.se/ValueSet/InvoiceBusinessStatus/v1
From this IG
Invoice.extension:registeredPaymentMethod.value[x]requiredRegisteredPaymentMethod
https://fhir.cambio.se/ValueSet/RegisteredPaymentMethod/v1
From this IG
Invoice.statusrequiredInvoiceStatus
http://hl7.org/fhir/ValueSet/invoice-status|4.0.1
From the FHIR Standard
Invoice.totalGross.currencyrequiredFixed Value: SEK
http://hl7.org/fhir/ValueSet/currencies|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorInvoiceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorInvoiceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorInvoiceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorInvoiceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceInvoiceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from InvoiceCore

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* InvoiceCore Invoice containing ChargeItems from an Account
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:businessStatus 1..1 (Complex) Extension
URL: https://fhir.cambio.se/StructureDefinition/common-businessStatus/v1
..... value[x] 0..1 CodeableConcept Value of extension
Binding: InvoiceBusinessStatus (required)
.... extension:registeredPaymentMethod 0..1 (Complex) Extension
URL: https://fhir.cambio.se/StructureDefinition/invoice-registeredPaymentMethod/v1
..... value[x] 0..1 Coding Value of extension
Binding: Registered Payment Method (required)
.... extension:paymentMethodOption 0..* Coding Extension
URL: https://fhir.cambio.se/StructureDefinition/invoice-paymentMethodOption/v1
Binding: PaymentMethodOptions (required)
... identifier 0..0
... status 1..1 code draft | issued | balanced | cancelled | entered-in-error
... type 0..0
... subject 1..1 Reference(Patient) Recipient(s) of goods and services
... recipient 0..0
... participant 0..0
... issuer 0..1 Reference(OrganizationInvoiceSe) {c} Issuing Organization of Invoice
... account 0..0
... lineItem
.... sequence 0..0
.... chargeItem[x] 1..1 Reference(ChargeItemSe(version 1) [Deprecated]) {b} Reference to ChargeItem containing details of this line item or an inline billing code
.... Slices for priceComponent 1..* BackboneElement Components of total line item price
Slice: Unordered, Open by value:code.coding.id
..... priceComponent:All Slices Content/Rules for all slices
...... code
....... coding 0..* Coding Code defined by a terminology system
Binding: CostTypes (required)
........ system 0..1 uri Identity of the terminology system
Fixed Value: https://cambio.codes/cs/cost-types
...... amount
....... currency 0..1 code ISO 4217 Currency Code
Fixed Value: SEK
..... priceComponent:basePrice 1..1 BackboneElement Base price
...... type 1..1 code base | surcharge | deduction | discount | tax | informational
Fixed Value: base
..... priceComponent:discount 0..* BackboneElement Components of total line item price
...... type 1..1 code base | surcharge | deduction | discount | tax | informational
Fixed Value: discount
..... priceComponent:surcharge 0..* BackboneElement Components of total line item price
...... type 1..1 code base | surcharge | deduction | discount | tax | informational
Fixed Value: surcharge
...... code
....... coding 0..1 Coding Code defined by a terminology system
....... text 0..1 string Plain text representation of the concept
... totalPriceComponent 0..0
... totalNet 1..1 Money Net total of this Invoice
... totalGross 0..0
... paymentTerms 0..0
... note 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Invoice.extension:businessStatus.value[x]requiredInvoiceBusinessStatus
https://fhir.cambio.se/ValueSet/InvoiceBusinessStatus/v1
From this IG
Invoice.extension:registeredPaymentMethod.value[x]requiredRegisteredPaymentMethod
https://fhir.cambio.se/ValueSet/RegisteredPaymentMethod/v1
From this IG
Invoice.lineItem.priceComponent.code.codingrequiredCostTypes
https://fhir.cambio.se/ValueSet/CostTypes/v1
From this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* InvoiceCore 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
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:businessStatus 1..1 (Complex) Extension
URL: https://fhir.cambio.se/StructureDefinition/common-businessStatus/v1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "https://fhir.cambio.se/StructureDefinition/common-businessStatus/v1"
..... value[x] 0..1 CodeableConcept Value of extension
Binding: InvoiceBusinessStatus (required)
.... extension:registeredPaymentMethod 0..1 (Complex) Extension
URL: https://fhir.cambio.se/StructureDefinition/invoice-registeredPaymentMethod/v1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "https://fhir.cambio.se/StructureDefinition/invoice-registeredPaymentMethod/v1"
..... value[x] 0..1 Coding Value of extension
Binding: Registered Payment Method (required)
.... extension:paymentMethodOption 0..* Coding Extension
URL: https://fhir.cambio.se/StructureDefinition/invoice-paymentMethodOption/v1
Binding: PaymentMethodOptions (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code draft | issued | balanced | cancelled | entered-in-error
Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice.
... subject Σ 1..1 Reference(Patient) Recipient(s) of goods and services
... date Σ 0..1 dateTime Invoice date / posting date
... issuer 0..1 Reference(OrganizationInvoiceSe) {c} Issuing Organization of Invoice
... lineItem 0..* 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
.... chargeItem[x] 1..1 Reference(ChargeItemSe(version 1) [Deprecated]) {b} Reference to ChargeItem containing details of this line item or an inline billing code
.... Slices for priceComponent 1..* BackboneElement Components of total line item price
Slice: Unordered, Open by value:code.coding.id
..... 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
....... 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
Binding: CostTypes (required)
........ 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 Σ 0..1 uri Identity of the terminology system
Fixed Value: https://cambio.codes/cs/cost-types
........ version Σ 0..1 string Version of the system - if relevant
........ code Σ 0..1 code Symbol in syntax defined by the system
........ display Σ 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
...... factor 0..1 decimal Factor used for calculating this component
...... amount 0..1 Money Monetary amount associated with this 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
....... value Σ 0..1 decimal Numerical value (with implicit precision)
....... currency Σ 0..1 code ISO 4217 Currency Code
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.
Fixed Value: SEK
..... priceComponent:basePrice 1..1 BackboneElement Base 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.
Fixed Value: 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
Binding: CostTypes (required)
........ 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 Σ 0..1 uri Identity of the terminology system
Fixed Value: https://cambio.codes/cs/cost-types
........ version Σ 0..1 string Version of the system - if relevant
........ code Σ 0..1 code Symbol in syntax defined by the system
........ display Σ 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
...... factor 0..1 decimal Factor used for calculating this component
...... amount 0..1 Money Monetary amount associated with this 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
....... value Σ 0..1 decimal Numerical value (with implicit precision)
....... currency Σ 0..1 code ISO 4217 Currency Code
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.
Fixed Value: SEK
..... priceComponent:discount 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.
Fixed Value: discount
...... 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
Binding: CostTypes (required)
........ 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 Σ 0..1 uri Identity of the terminology system
Fixed Value: https://cambio.codes/cs/cost-types
........ version Σ 0..1 string Version of the system - if relevant
........ code Σ 0..1 code Symbol in syntax defined by the system
........ display Σ 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
...... factor 0..1 decimal Factor used for calculating this component
...... amount 0..1 Money Monetary amount associated with this 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
....... value Σ 0..1 decimal Numerical value (with implicit precision)
....... currency Σ 0..1 code ISO 4217 Currency Code
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.
Fixed Value: SEK
..... priceComponent:surcharge 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.
Fixed Value: 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..1 Coding Code defined by a terminology system
Binding: CostTypes (required)
........ 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 Σ 0..1 uri Identity of the terminology system
Fixed Value: https://cambio.codes/cs/cost-types
........ version Σ 0..1 string Version of the system - if relevant
........ code Σ 0..1 code Symbol in syntax defined by the system
........ display Σ 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
...... factor 0..1 decimal Factor used for calculating this component
...... amount 0..1 Money Monetary amount associated with this 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
....... value Σ 0..1 decimal Numerical value (with implicit precision)
....... currency Σ 0..1 code ISO 4217 Currency Code
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.
Fixed Value: SEK
... totalNet Σ 1..1 Money Net total of this Invoice

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Invoice.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Invoice.extension:businessStatus.value[x]requiredInvoiceBusinessStatus
https://fhir.cambio.se/ValueSet/InvoiceBusinessStatus/v1
From this IG
Invoice.extension:registeredPaymentMethod.value[x]requiredRegisteredPaymentMethod
https://fhir.cambio.se/ValueSet/RegisteredPaymentMethod/v1
From this IG
Invoice.statusrequiredInvoiceStatus
http://hl7.org/fhir/ValueSet/invoice-status|4.0.1
From the FHIR Standard
Invoice.lineItem.priceComponent.typerequiredInvoicePriceComponentType
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
From the FHIR Standard
Invoice.lineItem.priceComponent.code.codingrequiredCostTypes
https://fhir.cambio.se/ValueSet/CostTypes/v1
From this IG
Invoice.lineItem.priceComponent.amount.currencyrequiredFixed Value: SEK
http://hl7.org/fhir/ValueSet/currencies|4.0.1
From the FHIR Standard
Invoice.lineItem.priceComponent:basePrice.typerequiredFixed Value: base
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
From the FHIR Standard
Invoice.lineItem.priceComponent:basePrice.code.codingrequiredCostTypes
https://fhir.cambio.se/ValueSet/CostTypes/v1
From this IG
Invoice.lineItem.priceComponent:basePrice.amount.currencyrequiredFixed Value: SEK
http://hl7.org/fhir/ValueSet/currencies|4.0.1
From the FHIR Standard
Invoice.lineItem.priceComponent:discount.typerequiredFixed Value: discount
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
From the FHIR Standard
Invoice.lineItem.priceComponent:discount.code.codingrequiredCostTypes
https://fhir.cambio.se/ValueSet/CostTypes/v1
From this IG
Invoice.lineItem.priceComponent:discount.amount.currencyrequiredFixed Value: SEK
http://hl7.org/fhir/ValueSet/currencies|4.0.1
From the FHIR Standard
Invoice.lineItem.priceComponent:surcharge.typerequiredFixed Value: surcharge
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
From the FHIR Standard
Invoice.lineItem.priceComponent:surcharge.code.codingrequiredCostTypes
https://fhir.cambio.se/ValueSet/CostTypes/v1
From this IG
Invoice.lineItem.priceComponent:surcharge.amount.currencyrequiredFixed Value: SEK
http://hl7.org/fhir/ValueSet/currencies|4.0.1
From the FHIR Standard
Invoice.totalGross.currencyrequiredFixed Value: SEK
http://hl7.org/fhir/ValueSet/currencies|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorInvoiceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorInvoiceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorInvoiceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorInvoiceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceInvoiceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from InvoiceCore

Summary

Mandatory: 4 elements(2 nested mandatory elements)
Fixed: 6 elements
Prohibited: 11 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.priceComponent

 

Other representations of profile: CSV, Excel, Schematron