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
| Official URL: https://fhir.cambio.se/StructureDefinition/InvoiceSe/v2 | Version: 2.0.0 | |||
| Active as of 2022-09-23 | Computable Name: InvoiceSeV2 | |||
The Invoice resource contains the payment details related to a single patient visit. The profile is based on the Invoice in FHIR STU4 edition.
The Invoice resource returns relevant cost for the patient visit. It contains three extensions to include additional details about the payments.
| Type | Description | 
|---|---|
| Rule | N/A | 
| COS version | Profile version | Required COSMIC version | Date | Description | 
|---|---|---|---|---|
| 3.3.0 | 2.0.0 | R8.3.04 | Oct 2022 | This version uses the latest version of the Payment options extension. | 
| Extension | Data type | ValueSet | Description | 
|---|---|---|---|
| Common-businessStatus | Fixedvalues | InvoiceBusinessStatus | Optional extension element to indicate the status of the payment status of the contact. | 
| Invoice-paymentMethodOption (V2) | Complex | PaymentMethodOptions | Extension which keeps information about payment type and possibility of using it. When compared with the v1, the main difference is, the v2 is a complex extension and it has two sub extensions where one can keep the payment type and the other extension keeps a boolean value to show that payment type is possible or not | 
| Invoice-registeredPaymentMethod | Fixedvalues | Registered_Payment_Method | Extension to indicate the payment method used for making the payment for the visit. | 
| FHIR status | Status in COSMIC | 
|---|---|
| base | patient | 
| surcharge | invoice | 
| discount | reduction | 
| surcharge | other(amount >0) | 
| discount | other(amount <0) | 
| HTTP Method | Description | 
|---|---|
| GET | Search for invoice using patient id and encounter id. | 
| Parameter | Format | Mandatory | Comment | 
|---|---|---|---|
subject | 
      string | true | The subject that the inovice is about (patient) | 
encounter | 
      string | true | Contact id of the visit | 
_profile | 
      string | false | Profile to be used when returning data | 
GET [baseURL]/invoice_search?subject={}&encounter={}&_profile=https://fhir.cambio.se/StructureDefinition/InvoiceSe/v2 (search)Specific error messages for InvoiceSe are listed below.
| Code | Description | Comment | 
|---|---|---|
| 400 | Occurs due to invalid query parameters | E.g. patientId and contactId are not related to the same patient, contact does not exist, contact is not in registered or in booked state, the profile canonical URL is unsupported | 
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | 
|---|---|---|---|---|
![]()  | 
0..* | InvoiceCore | Invoice containing ChargeItems from an Account | |
![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | 
![]() ![]()  | 
1..* | Extension | Extension Slice: Unordered, Open by value:url  | |
![]() ![]() ![]()  | 
1..1 | (Complex) | Extension URL: https://fhir.cambio.se/StructureDefinition/common-businessStatus/v1  | |
![]() ![]() ![]() ![]()  | 
0..0 | |||
![]() ![]() ![]() ![]()  | 
1..1 | uri | "https://fhir.cambio.se/StructureDefinition/common-businessStatus/v1" | |
![]() ![]() ![]() ![]()  | 
0..1 | CodeableConcept | Value of extension Binding: InvoiceBusinessStatus (required)  | |
![]() ![]() ![]()  | 
0..1 | (Complex) | Extension URL: https://fhir.cambio.se/StructureDefinition/invoice-registeredPaymentMethod/v1  | |
![]() ![]() ![]() ![]()  | 
0..0 | |||
![]() ![]() ![]() ![]()  | 
1..1 | uri | "https://fhir.cambio.se/StructureDefinition/invoice-registeredPaymentMethod/v1" | |
![]() ![]() ![]() ![]()  | 
0..1 | Coding | Value of extension Binding: Registered Payment Method (required)  | |
![]() ![]() ![]()  | 
0..* | (Complex) | invoice-paymentMethodOption(Version 2) URL: https://fhir.cambio.se/StructureDefinition/invoice-paymentMethodOption/v2  | |
![]() ![]()  | 
?! | 0..* | Extension | Extensions that cannot be ignored | 
![]() ![]()  | 
?!Σ | 1..1 | code | draft | issued | balanced | cancelled | entered-in-error Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice.  | 
![]() ![]()  | 
Σ | 1..1 | Reference(Patient) | Recipient(s) of goods and services | 
![]() ![]()  | 
0..1 | BackboneElement | Participant in creation of this Invoice | |
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
![]() ![]() ![]()  | 
1..1 | Reference(Device) | Individual who was involved | |
![]() ![]()  | 
0..1 | Reference(OrganizationInvoiceSe) {c} | Issuing Organization of Invoice | |
![]() ![]()  | 
Σ | 1..1 | Money | Net total of this Invoice | 
![]() ![]() ![]()  | 
Σ | 0..1 | code | ISO 4217 Currency Code Binding: Currencies (required): A code indicating the currency, taken from ISO 4217. Fixed Value: SEK  | 
  Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI | 
| Invoice.extension:businessStatus.value[x] | required | InvoiceBusinessStatushttps://fhir.cambio.se/ValueSet/InvoiceBusinessStatus/v1From this IG  | |
| Invoice.extension:registeredPaymentMethod.value[x] | required | RegisteredPaymentMethodhttps://fhir.cambio.se/ValueSet/RegisteredPaymentMethod/v1From this IG  | |
| Invoice.status | required | InvoiceStatushttp://hl7.org/fhir/ValueSet/invoice-status|4.0.1From the FHIR Standard  | |
| Invoice.totalNet.currency | required | Fixed Value: SEKhttp://hl7.org/fhir/ValueSet/currencies|4.0.1From the FHIR Standard  | |
| Invoice.totalGross.currency | required | Fixed Value: SEKhttp://hl7.org/fhir/ValueSet/currencies|4.0.1From the FHIR Standard  | 
| Id | Grade | Path(s) | Details | Requirements | 
| 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()  | |
| 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 InvoiceCore
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | 
|---|---|---|---|---|
![]()  | 
0..* | InvoiceCore | Invoice containing ChargeItems from an Account | |
![]() ![]()  | 
1..* | Extension | Extension Slice: Unordered, Open by value:url  | |
![]() ![]() ![]()  | 
1..1 | (Complex) | Extension URL: https://fhir.cambio.se/StructureDefinition/common-businessStatus/v1  | |
![]() ![]() ![]() ![]()  | 
0..1 | CodeableConcept | Value of extension Binding: InvoiceBusinessStatus (required)  | |
![]() ![]() ![]()  | 
0..1 | (Complex) | Extension URL: https://fhir.cambio.se/StructureDefinition/invoice-registeredPaymentMethod/v1  | |
![]() ![]() ![]() ![]()  | 
0..1 | Coding | Value of extension Binding: Registered Payment Method (required)  | |
![]() ![]() ![]()  | 
0..* | (Complex) | invoice-paymentMethodOption(Version 2) URL: https://fhir.cambio.se/StructureDefinition/invoice-paymentMethodOption/v2  | |
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
1..1 | code | draft | issued | balanced | cancelled | entered-in-error | |
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
1..1 | Reference(Patient) | Recipient(s) of goods and services | |
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..1 | BackboneElement | Participant in creation of this Invoice | |
![]() ![]() ![]()  | 
1..1 | Reference(Device) | Individual who was involved | |
![]() ![]()  | 
0..1 | Reference(OrganizationInvoiceSe) {c} | Issuing Organization of Invoice | |
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
||||
![]() ![]() ![]()  | 
0..0 | |||
![]() ![]() ![]()  | 
1..1 | Reference(ChargeItemSe(Version 2)) {b} | Reference to ChargeItem containing details of this line item or an inline billing code | |
![]() ![]() ![]()  | 
1..* | BackboneElement | Components of total line item price Slice: Unordered, Open by value:code.coding.id  | |
![]() ![]() ![]() ![]()  | 
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]()  | 
||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Coding | Code defined by a terminology system Binding: CostTypes (required)  | |
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | uri | Identity of the terminology system Fixed Value: https://cambio.codes/cs/cost-types  | |
![]() ![]() ![]() ![]() ![]()  | 
||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | code | ISO 4217 Currency Code Fixed Value: SEK  | |
![]() ![]() ![]() ![]()  | 
1..1 | BackboneElement | Base price | |
![]() ![]() ![]() ![]() ![]()  | 
1..1 | code | base | surcharge | deduction | discount | tax | informational Fixed Value: base  | |
![]() ![]() ![]() ![]() ![]()  | 
||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | code | Symbol in syntax defined by the system Binding: CostTypes (required) Fixed Value: PAT  | |
![]() ![]() ![]() ![]()  | 
0..* | BackboneElement | Components of total line item price | |
![]() ![]() ![]() ![]() ![]()  | 
1..1 | code | base | surcharge | deduction | discount | tax | informational Fixed Value: discount  | |
![]() ![]() ![]() ![]() ![]()  | 
||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | code | Symbol in syntax defined by the system Binding: CostTypes (required)  | |
![]() ![]() ![]() ![]()  | 
0..* | BackboneElement | Components of total line item price | |
![]() ![]() ![]() ![]() ![]()  | 
1..1 | code | base | surcharge | deduction | discount | tax | informational Fixed Value: surcharge  | |
![]() ![]() ![]() ![]() ![]()  | 
||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | code | Symbol in syntax defined by the system Binding: CostTypes (required)  | |
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Plain text representation of the concept | |
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
1..1 | Money | Net total of this Invoice | |
![]() ![]() ![]()  | 
0..1 | code | ISO 4217 Currency Code Fixed Value: SEK  | |
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..0 | |||
  Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI | 
| Invoice.extension:businessStatus.value[x] | required | InvoiceBusinessStatushttps://fhir.cambio.se/ValueSet/InvoiceBusinessStatus/v1From this IG  | |
| Invoice.extension:registeredPaymentMethod.value[x] | required | RegisteredPaymentMethodhttps://fhir.cambio.se/ValueSet/RegisteredPaymentMethod/v1From this IG  | |
| Invoice.lineItem.priceComponent.code.coding | required | CostTypeshttps://fhir.cambio.se/ValueSet/CostTypes/v1From this IG  | |
| Invoice.lineItem.priceComponent:basePrice.code.coding.code | required | Fixed Value: PAThttps://fhir.cambio.se/ValueSet/CostTypes/v1From this IG  | |
| Invoice.lineItem.priceComponent:discount.code.coding.code | required | CostTypeshttps://fhir.cambio.se/ValueSet/CostTypes/v1From this IG  | |
| Invoice.lineItem.priceComponent:surcharge.code.coding.code | required | CostTypeshttps://fhir.cambio.se/ValueSet/CostTypes/v1From this IG  | 
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | ||||
|---|---|---|---|---|---|---|---|---|
![]()  | 
0..* | InvoiceCore | Invoice containing ChargeItems from an Account | |||||
![]() ![]()  | 
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]()  | 
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]()  | 
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language. 
  | |||||
![]() ![]()  | 
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  | |||||
![]() ![]()  | 
0..* | Resource | Contained, inline Resources | |||||
![]() ![]()  | 
1..* | Extension | Extension Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
1..1 | (Complex) | Extension URL: https://fhir.cambio.se/StructureDefinition/common-businessStatus/v1  | |||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..0 | |||||||
![]() ![]() ![]() ![]()  | 
1..1 | uri | "https://fhir.cambio.se/StructureDefinition/common-businessStatus/v1" | |||||
![]() ![]() ![]() ![]()  | 
0..1 | CodeableConcept | Value of extension Binding: InvoiceBusinessStatus (required)  | |||||
![]() ![]() ![]()  | 
0..1 | (Complex) | Extension URL: https://fhir.cambio.se/StructureDefinition/invoice-registeredPaymentMethod/v1  | |||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..0 | |||||||
![]() ![]() ![]() ![]()  | 
1..1 | uri | "https://fhir.cambio.se/StructureDefinition/invoice-registeredPaymentMethod/v1" | |||||
![]() ![]() ![]() ![]()  | 
0..1 | Coding | Value of extension Binding: Registered Payment Method (required)  | |||||
![]() ![]() ![]()  | 
0..* | (Complex) | invoice-paymentMethodOption(Version 2) URL: https://fhir.cambio.se/StructureDefinition/invoice-paymentMethodOption/v2  | |||||
![]() ![]()  | 
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]()  | 
?!Σ | 1..1 | code | draft | issued | balanced | cancelled | entered-in-error Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice.  | ||||
![]() ![]()  | 
Σ | 1..1 | Reference(Patient) | Recipient(s) of goods and services | ||||
![]() ![]()  | 
Σ | 0..1 | dateTime | Invoice date / posting date | ||||
![]() ![]()  | 
0..1 | BackboneElement | Participant in creation of this Invoice | |||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | 
0..1 | CodeableConcept | Type of involvement in creation of this Invoice | |||||
![]() ![]() ![]()  | 
1..1 | Reference(Device) | Individual who was involved | |||||
![]() ![]()  | 
0..1 | Reference(OrganizationInvoiceSe) {c} | Issuing Organization of Invoice | |||||
![]() ![]()  | 
0..* | BackboneElement | Line items of this Invoice | |||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | 
1..1 | Reference(ChargeItemSe(Version 2)) {b} | Reference to ChargeItem containing details of this line item or an inline billing code | |||||
![]() ![]() ![]()  | 
1..* | BackboneElement | Components of total line item price Slice: Unordered, Open by value:code.coding.id  | |||||
![]() ![]() ![]() ![]()  | 
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]()  | 
1..1 | code | base | surcharge | deduction | discount | tax | informational Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.  | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | CodeableConcept | Code identifying the specific component | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..* | Coding | Code defined by a terminology system Binding: CostTypes (required)  | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | uri | Identity of the terminology system Fixed Value: https://cambio.codes/cs/cost-types  | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | decimal | Factor used for calculating this component | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | Money | Monetary amount associated with this component | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | ISO 4217 Currency Code Binding: Currencies (required): A code indicating the currency, taken from ISO 4217. Fixed Value: SEK  | ||||
![]() ![]() ![]() ![]()  | 
1..1 | BackboneElement | Base price | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]()  | 
1..1 | code | base | surcharge | deduction | discount | tax | informational Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component. Fixed Value: base  | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | CodeableConcept | Code identifying the specific component | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..* | Coding | Code defined by a terminology system Binding: CostTypes (required)  | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | uri | Identity of the terminology system Fixed Value: https://cambio.codes/cs/cost-types  | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | Symbol in syntax defined by the system Binding: CostTypes (required) Fixed Value: PAT  | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | decimal | Factor used for calculating this component | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | Money | Monetary amount associated with this component | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | ISO 4217 Currency Code Binding: Currencies (required): A code indicating the currency, taken from ISO 4217. Fixed Value: SEK  | ||||
![]() ![]() ![]() ![]()  | 
0..* | BackboneElement | Components of total line item price | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]()  | 
1..1 | code | base | surcharge | deduction | discount | tax | informational Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component. Fixed Value: discount  | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | CodeableConcept | Code identifying the specific component | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..* | Coding | Code defined by a terminology system Binding: CostTypes (required)  | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | uri | Identity of the terminology system Fixed Value: https://cambio.codes/cs/cost-types  | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | Symbol in syntax defined by the system Binding: CostTypes (required)  | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | decimal | Factor used for calculating this component | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | Money | Monetary amount associated with this component | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | ISO 4217 Currency Code Binding: Currencies (required): A code indicating the currency, taken from ISO 4217. Fixed Value: SEK  | ||||
![]() ![]() ![]() ![]()  | 
0..* | BackboneElement | Components of total line item price | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]()  | 
1..1 | code | base | surcharge | deduction | discount | tax | informational Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component. Fixed Value: surcharge  | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | CodeableConcept | Code identifying the specific component | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Coding | Code defined by a terminology system Binding: CostTypes (required)  | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | uri | Identity of the terminology system Fixed Value: https://cambio.codes/cs/cost-types  | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | Symbol in syntax defined by the system Binding: CostTypes (required)  | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | decimal | Factor used for calculating this component | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | Money | Monetary amount associated with this component | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | ISO 4217 Currency Code Binding: Currencies (required): A code indicating the currency, taken from ISO 4217. Fixed Value: SEK  | ||||
![]() ![]()  | 
Σ | 1..1 | Money | Net total of this Invoice | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | code | ISO 4217 Currency Code Binding: Currencies (required): A code indicating the currency, taken from ISO 4217. Fixed Value: SEK  | ||||
  Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Invoice.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard 
  | ||||
| Invoice.extension:businessStatus.value[x] | required | InvoiceBusinessStatushttps://fhir.cambio.se/ValueSet/InvoiceBusinessStatus/v1From this IG  | ||||
| Invoice.extension:registeredPaymentMethod.value[x] | required | RegisteredPaymentMethodhttps://fhir.cambio.se/ValueSet/RegisteredPaymentMethod/v1From this IG  | ||||
| Invoice.status | required | InvoiceStatushttp://hl7.org/fhir/ValueSet/invoice-status|4.0.1From the FHIR Standard  | ||||
| Invoice.lineItem.priceComponent.type | required | InvoicePriceComponentTypehttp://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1From the FHIR Standard  | ||||
| Invoice.lineItem.priceComponent.code.coding | required | CostTypeshttps://fhir.cambio.se/ValueSet/CostTypes/v1From this IG  | ||||
| Invoice.lineItem.priceComponent.amount.currency | required | Fixed Value: SEKhttp://hl7.org/fhir/ValueSet/currencies|4.0.1From the FHIR Standard  | ||||
| Invoice.lineItem.priceComponent:basePrice.type | required | Fixed Value: basehttp://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1From the FHIR Standard  | ||||
| Invoice.lineItem.priceComponent:basePrice.code.coding | required | Fixed Value: PAThttps://fhir.cambio.se/ValueSet/CostTypes/v1From this IG  | ||||
| Invoice.lineItem.priceComponent:basePrice.code.coding.code | required | Fixed Value: PAThttps://fhir.cambio.se/ValueSet/CostTypes/v1From this IG  | ||||
| Invoice.lineItem.priceComponent:basePrice.amount.currency | required | Fixed Value: SEKhttp://hl7.org/fhir/ValueSet/currencies|4.0.1From the FHIR Standard  | ||||
| Invoice.lineItem.priceComponent:discount.type | required | Fixed Value: discounthttp://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1From the FHIR Standard  | ||||
| Invoice.lineItem.priceComponent:discount.code.coding | required | CostTypeshttps://fhir.cambio.se/ValueSet/CostTypes/v1From this IG  | ||||
| Invoice.lineItem.priceComponent:discount.code.coding.code | required | CostTypeshttps://fhir.cambio.se/ValueSet/CostTypes/v1From this IG  | ||||
| Invoice.lineItem.priceComponent:discount.amount.currency | required | Fixed Value: SEKhttp://hl7.org/fhir/ValueSet/currencies|4.0.1From the FHIR Standard  | ||||
| Invoice.lineItem.priceComponent:surcharge.type | required | Fixed Value: surchargehttp://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1From the FHIR Standard  | ||||
| Invoice.lineItem.priceComponent:surcharge.code.coding | required | CostTypeshttps://fhir.cambio.se/ValueSet/CostTypes/v1From this IG  | ||||
| Invoice.lineItem.priceComponent:surcharge.code.coding.code | required | CostTypeshttps://fhir.cambio.se/ValueSet/CostTypes/v1From this IG  | ||||
| Invoice.lineItem.priceComponent:surcharge.amount.currency | required | Fixed Value: SEKhttp://hl7.org/fhir/ValueSet/currencies|4.0.1From the FHIR Standard  | ||||
| Invoice.totalNet.currency | required | Fixed Value: SEKhttp://hl7.org/fhir/ValueSet/currencies|4.0.1From the FHIR Standard  | ||||
| Invoice.totalGross.currency | required | Fixed Value: SEKhttp://hl7.org/fhir/ValueSet/currencies|4.0.1From the FHIR Standard  | 
| Id | Grade | Path(s) | Details | Requirements | 
| 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()  | |
| 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 InvoiceCore
Summary
Mandatory: 4 elements(2 nested mandatory elements)
 Fixed: 8 elements
 Prohibited: 10 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | 
|---|---|---|---|---|
![]()  | 
0..* | InvoiceCore | Invoice containing ChargeItems from an Account | |
![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | 
![]() ![]()  | 
1..* | Extension | Extension Slice: Unordered, Open by value:url  | |
![]() ![]() ![]()  | 
1..1 | (Complex) | Extension URL: https://fhir.cambio.se/StructureDefinition/common-businessStatus/v1  | |
![]() ![]() ![]() ![]()  | 
0..0 | |||
![]() ![]() ![]() ![]()  | 
1..1 | uri | "https://fhir.cambio.se/StructureDefinition/common-businessStatus/v1" | |
![]() ![]() ![]() ![]()  | 
0..1 | CodeableConcept | Value of extension Binding: InvoiceBusinessStatus (required)  | |
![]() ![]() ![]()  | 
0..1 | (Complex) | Extension URL: https://fhir.cambio.se/StructureDefinition/invoice-registeredPaymentMethod/v1  | |
![]() ![]() ![]() ![]()  | 
0..0 | |||
![]() ![]() ![]() ![]()  | 
1..1 | uri | "https://fhir.cambio.se/StructureDefinition/invoice-registeredPaymentMethod/v1" | |
![]() ![]() ![]() ![]()  | 
0..1 | Coding | Value of extension Binding: Registered Payment Method (required)  | |
![]() ![]() ![]()  | 
0..* | (Complex) | invoice-paymentMethodOption(Version 2) URL: https://fhir.cambio.se/StructureDefinition/invoice-paymentMethodOption/v2  | |
![]() ![]()  | 
?! | 0..* | Extension | Extensions that cannot be ignored | 
![]() ![]()  | 
?!Σ | 1..1 | code | draft | issued | balanced | cancelled | entered-in-error Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice.  | 
![]() ![]()  | 
Σ | 1..1 | Reference(Patient) | Recipient(s) of goods and services | 
![]() ![]()  | 
0..1 | BackboneElement | Participant in creation of this Invoice | |
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
![]() ![]() ![]()  | 
1..1 | Reference(Device) | Individual who was involved | |
![]() ![]()  | 
0..1 | Reference(OrganizationInvoiceSe) {c} | Issuing Organization of Invoice | |
![]() ![]()  | 
Σ | 1..1 | Money | Net total of this Invoice | 
![]() ![]() ![]()  | 
Σ | 0..1 | code | ISO 4217 Currency Code Binding: Currencies (required): A code indicating the currency, taken from ISO 4217. Fixed Value: SEK  | 
  Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI | 
| Invoice.extension:businessStatus.value[x] | required | InvoiceBusinessStatushttps://fhir.cambio.se/ValueSet/InvoiceBusinessStatus/v1From this IG  | |
| Invoice.extension:registeredPaymentMethod.value[x] | required | RegisteredPaymentMethodhttps://fhir.cambio.se/ValueSet/RegisteredPaymentMethod/v1From this IG  | |
| Invoice.status | required | InvoiceStatushttp://hl7.org/fhir/ValueSet/invoice-status|4.0.1From the FHIR Standard  | |
| Invoice.totalNet.currency | required | Fixed Value: SEKhttp://hl7.org/fhir/ValueSet/currencies|4.0.1From the FHIR Standard  | |
| Invoice.totalGross.currency | required | Fixed Value: SEKhttp://hl7.org/fhir/ValueSet/currencies|4.0.1From the FHIR Standard  | 
| Id | Grade | Path(s) | Details | Requirements | 
| 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()  | |
| 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 InvoiceCore
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | 
|---|---|---|---|---|
![]()  | 
0..* | InvoiceCore | Invoice containing ChargeItems from an Account | |
![]() ![]()  | 
1..* | Extension | Extension Slice: Unordered, Open by value:url  | |
![]() ![]() ![]()  | 
1..1 | (Complex) | Extension URL: https://fhir.cambio.se/StructureDefinition/common-businessStatus/v1  | |
![]() ![]() ![]() ![]()  | 
0..1 | CodeableConcept | Value of extension Binding: InvoiceBusinessStatus (required)  | |
![]() ![]() ![]()  | 
0..1 | (Complex) | Extension URL: https://fhir.cambio.se/StructureDefinition/invoice-registeredPaymentMethod/v1  | |
![]() ![]() ![]() ![]()  | 
0..1 | Coding | Value of extension Binding: Registered Payment Method (required)  | |
![]() ![]() ![]()  | 
0..* | (Complex) | invoice-paymentMethodOption(Version 2) URL: https://fhir.cambio.se/StructureDefinition/invoice-paymentMethodOption/v2  | |
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
1..1 | code | draft | issued | balanced | cancelled | entered-in-error | |
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
1..1 | Reference(Patient) | Recipient(s) of goods and services | |
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..1 | BackboneElement | Participant in creation of this Invoice | |
![]() ![]() ![]()  | 
1..1 | Reference(Device) | Individual who was involved | |
![]() ![]()  | 
0..1 | Reference(OrganizationInvoiceSe) {c} | Issuing Organization of Invoice | |
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
||||
![]() ![]() ![]()  | 
0..0 | |||
![]() ![]() ![]()  | 
1..1 | Reference(ChargeItemSe(Version 2)) {b} | Reference to ChargeItem containing details of this line item or an inline billing code | |
![]() ![]() ![]()  | 
1..* | BackboneElement | Components of total line item price Slice: Unordered, Open by value:code.coding.id  | |
![]() ![]() ![]() ![]()  | 
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]()  | 
||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Coding | Code defined by a terminology system Binding: CostTypes (required)  | |
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | uri | Identity of the terminology system Fixed Value: https://cambio.codes/cs/cost-types  | |
![]() ![]() ![]() ![]() ![]()  | 
||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | code | ISO 4217 Currency Code Fixed Value: SEK  | |
![]() ![]() ![]() ![]()  | 
1..1 | BackboneElement | Base price | |
![]() ![]() ![]() ![]() ![]()  | 
1..1 | code | base | surcharge | deduction | discount | tax | informational Fixed Value: base  | |
![]() ![]() ![]() ![]() ![]()  | 
||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | code | Symbol in syntax defined by the system Binding: CostTypes (required) Fixed Value: PAT  | |
![]() ![]() ![]() ![]()  | 
0..* | BackboneElement | Components of total line item price | |
![]() ![]() ![]() ![]() ![]()  | 
1..1 | code | base | surcharge | deduction | discount | tax | informational Fixed Value: discount  | |
![]() ![]() ![]() ![]() ![]()  | 
||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | code | Symbol in syntax defined by the system Binding: CostTypes (required)  | |
![]() ![]() ![]() ![]()  | 
0..* | BackboneElement | Components of total line item price | |
![]() ![]() ![]() ![]() ![]()  | 
1..1 | code | base | surcharge | deduction | discount | tax | informational Fixed Value: surcharge  | |
![]() ![]() ![]() ![]() ![]()  | 
||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | code | Symbol in syntax defined by the system Binding: CostTypes (required)  | |
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Plain text representation of the concept | |
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
1..1 | Money | Net total of this Invoice | |
![]() ![]() ![]()  | 
0..1 | code | ISO 4217 Currency Code Fixed Value: SEK  | |
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..0 | |||
  Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI | 
| Invoice.extension:businessStatus.value[x] | required | InvoiceBusinessStatushttps://fhir.cambio.se/ValueSet/InvoiceBusinessStatus/v1From this IG  | |
| Invoice.extension:registeredPaymentMethod.value[x] | required | RegisteredPaymentMethodhttps://fhir.cambio.se/ValueSet/RegisteredPaymentMethod/v1From this IG  | |
| Invoice.lineItem.priceComponent.code.coding | required | CostTypeshttps://fhir.cambio.se/ValueSet/CostTypes/v1From this IG  | |
| Invoice.lineItem.priceComponent:basePrice.code.coding.code | required | Fixed Value: PAThttps://fhir.cambio.se/ValueSet/CostTypes/v1From this IG  | |
| Invoice.lineItem.priceComponent:discount.code.coding.code | required | CostTypeshttps://fhir.cambio.se/ValueSet/CostTypes/v1From this IG  | |
| Invoice.lineItem.priceComponent:surcharge.code.coding.code | required | CostTypeshttps://fhir.cambio.se/ValueSet/CostTypes/v1From this IG  | 
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | ||||
|---|---|---|---|---|---|---|---|---|
![]()  | 
0..* | InvoiceCore | Invoice containing ChargeItems from an Account | |||||
![]() ![]()  | 
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]()  | 
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]()  | 
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language. 
  | |||||
![]() ![]()  | 
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  | |||||
![]() ![]()  | 
0..* | Resource | Contained, inline Resources | |||||
![]() ![]()  | 
1..* | Extension | Extension Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
1..1 | (Complex) | Extension URL: https://fhir.cambio.se/StructureDefinition/common-businessStatus/v1  | |||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..0 | |||||||
![]() ![]() ![]() ![]()  | 
1..1 | uri | "https://fhir.cambio.se/StructureDefinition/common-businessStatus/v1" | |||||
![]() ![]() ![]() ![]()  | 
0..1 | CodeableConcept | Value of extension Binding: InvoiceBusinessStatus (required)  | |||||
![]() ![]() ![]()  | 
0..1 | (Complex) | Extension URL: https://fhir.cambio.se/StructureDefinition/invoice-registeredPaymentMethod/v1  | |||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..0 | |||||||
![]() ![]() ![]() ![]()  | 
1..1 | uri | "https://fhir.cambio.se/StructureDefinition/invoice-registeredPaymentMethod/v1" | |||||
![]() ![]() ![]() ![]()  | 
0..1 | Coding | Value of extension Binding: Registered Payment Method (required)  | |||||
![]() ![]() ![]()  | 
0..* | (Complex) | invoice-paymentMethodOption(Version 2) URL: https://fhir.cambio.se/StructureDefinition/invoice-paymentMethodOption/v2  | |||||
![]() ![]()  | 
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]()  | 
?!Σ | 1..1 | code | draft | issued | balanced | cancelled | entered-in-error Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice.  | ||||
![]() ![]()  | 
Σ | 1..1 | Reference(Patient) | Recipient(s) of goods and services | ||||
![]() ![]()  | 
Σ | 0..1 | dateTime | Invoice date / posting date | ||||
![]() ![]()  | 
0..1 | BackboneElement | Participant in creation of this Invoice | |||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | 
0..1 | CodeableConcept | Type of involvement in creation of this Invoice | |||||
![]() ![]() ![]()  | 
1..1 | Reference(Device) | Individual who was involved | |||||
![]() ![]()  | 
0..1 | Reference(OrganizationInvoiceSe) {c} | Issuing Organization of Invoice | |||||
![]() ![]()  | 
0..* | BackboneElement | Line items of this Invoice | |||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | 
1..1 | Reference(ChargeItemSe(Version 2)) {b} | Reference to ChargeItem containing details of this line item or an inline billing code | |||||
![]() ![]() ![]()  | 
1..* | BackboneElement | Components of total line item price Slice: Unordered, Open by value:code.coding.id  | |||||
![]() ![]() ![]() ![]()  | 
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]()  | 
1..1 | code | base | surcharge | deduction | discount | tax | informational Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.  | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | CodeableConcept | Code identifying the specific component | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..* | Coding | Code defined by a terminology system Binding: CostTypes (required)  | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | uri | Identity of the terminology system Fixed Value: https://cambio.codes/cs/cost-types  | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | decimal | Factor used for calculating this component | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | Money | Monetary amount associated with this component | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | ISO 4217 Currency Code Binding: Currencies (required): A code indicating the currency, taken from ISO 4217. Fixed Value: SEK  | ||||
![]() ![]() ![]() ![]()  | 
1..1 | BackboneElement | Base price | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]()  | 
1..1 | code | base | surcharge | deduction | discount | tax | informational Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component. Fixed Value: base  | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | CodeableConcept | Code identifying the specific component | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..* | Coding | Code defined by a terminology system Binding: CostTypes (required)  | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | uri | Identity of the terminology system Fixed Value: https://cambio.codes/cs/cost-types  | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | Symbol in syntax defined by the system Binding: CostTypes (required) Fixed Value: PAT  | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | decimal | Factor used for calculating this component | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | Money | Monetary amount associated with this component | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | ISO 4217 Currency Code Binding: Currencies (required): A code indicating the currency, taken from ISO 4217. Fixed Value: SEK  | ||||
![]() ![]() ![]() ![]()  | 
0..* | BackboneElement | Components of total line item price | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]()  | 
1..1 | code | base | surcharge | deduction | discount | tax | informational Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component. Fixed Value: discount  | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | CodeableConcept | Code identifying the specific component | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..* | Coding | Code defined by a terminology system Binding: CostTypes (required)  | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | uri | Identity of the terminology system Fixed Value: https://cambio.codes/cs/cost-types  | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | Symbol in syntax defined by the system Binding: CostTypes (required)  | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | decimal | Factor used for calculating this component | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | Money | Monetary amount associated with this component | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | ISO 4217 Currency Code Binding: Currencies (required): A code indicating the currency, taken from ISO 4217. Fixed Value: SEK  | ||||
![]() ![]() ![]() ![]()  | 
0..* | BackboneElement | Components of total line item price | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]()  | 
1..1 | code | base | surcharge | deduction | discount | tax | informational Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component. Fixed Value: surcharge  | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | CodeableConcept | Code identifying the specific component | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Coding | Code defined by a terminology system Binding: CostTypes (required)  | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | uri | Identity of the terminology system Fixed Value: https://cambio.codes/cs/cost-types  | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | Symbol in syntax defined by the system Binding: CostTypes (required)  | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | decimal | Factor used for calculating this component | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | Money | Monetary amount associated with this component | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | ISO 4217 Currency Code Binding: Currencies (required): A code indicating the currency, taken from ISO 4217. Fixed Value: SEK  | ||||
![]() ![]()  | 
Σ | 1..1 | Money | Net total of this Invoice | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | code | ISO 4217 Currency Code Binding: Currencies (required): A code indicating the currency, taken from ISO 4217. Fixed Value: SEK  | ||||
  Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Invoice.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard 
  | ||||
| Invoice.extension:businessStatus.value[x] | required | InvoiceBusinessStatushttps://fhir.cambio.se/ValueSet/InvoiceBusinessStatus/v1From this IG  | ||||
| Invoice.extension:registeredPaymentMethod.value[x] | required | RegisteredPaymentMethodhttps://fhir.cambio.se/ValueSet/RegisteredPaymentMethod/v1From this IG  | ||||
| Invoice.status | required | InvoiceStatushttp://hl7.org/fhir/ValueSet/invoice-status|4.0.1From the FHIR Standard  | ||||
| Invoice.lineItem.priceComponent.type | required | InvoicePriceComponentTypehttp://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1From the FHIR Standard  | ||||
| Invoice.lineItem.priceComponent.code.coding | required | CostTypeshttps://fhir.cambio.se/ValueSet/CostTypes/v1From this IG  | ||||
| Invoice.lineItem.priceComponent.amount.currency | required | Fixed Value: SEKhttp://hl7.org/fhir/ValueSet/currencies|4.0.1From the FHIR Standard  | ||||
| Invoice.lineItem.priceComponent:basePrice.type | required | Fixed Value: basehttp://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1From the FHIR Standard  | ||||
| Invoice.lineItem.priceComponent:basePrice.code.coding | required | Fixed Value: PAThttps://fhir.cambio.se/ValueSet/CostTypes/v1From this IG  | ||||
| Invoice.lineItem.priceComponent:basePrice.code.coding.code | required | Fixed Value: PAThttps://fhir.cambio.se/ValueSet/CostTypes/v1From this IG  | ||||
| Invoice.lineItem.priceComponent:basePrice.amount.currency | required | Fixed Value: SEKhttp://hl7.org/fhir/ValueSet/currencies|4.0.1From the FHIR Standard  | ||||
| Invoice.lineItem.priceComponent:discount.type | required | Fixed Value: discounthttp://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1From the FHIR Standard  | ||||
| Invoice.lineItem.priceComponent:discount.code.coding | required | CostTypeshttps://fhir.cambio.se/ValueSet/CostTypes/v1From this IG  | ||||
| Invoice.lineItem.priceComponent:discount.code.coding.code | required | CostTypeshttps://fhir.cambio.se/ValueSet/CostTypes/v1From this IG  | ||||
| Invoice.lineItem.priceComponent:discount.amount.currency | required | Fixed Value: SEKhttp://hl7.org/fhir/ValueSet/currencies|4.0.1From the FHIR Standard  | ||||
| Invoice.lineItem.priceComponent:surcharge.type | required | Fixed Value: surchargehttp://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1From the FHIR Standard  | ||||
| Invoice.lineItem.priceComponent:surcharge.code.coding | required | CostTypeshttps://fhir.cambio.se/ValueSet/CostTypes/v1From this IG  | ||||
| Invoice.lineItem.priceComponent:surcharge.code.coding.code | required | CostTypeshttps://fhir.cambio.se/ValueSet/CostTypes/v1From this IG  | ||||
| Invoice.lineItem.priceComponent:surcharge.amount.currency | required | Fixed Value: SEKhttp://hl7.org/fhir/ValueSet/currencies|4.0.1From the FHIR Standard  | ||||
| Invoice.totalNet.currency | required | Fixed Value: SEKhttp://hl7.org/fhir/ValueSet/currencies|4.0.1From the FHIR Standard  | ||||
| Invoice.totalGross.currency | required | Fixed Value: SEKhttp://hl7.org/fhir/ValueSet/currencies|4.0.1From the FHIR Standard  | 
| Id | Grade | Path(s) | Details | Requirements | 
| 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()  | |
| 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 InvoiceCore
Summary
Mandatory: 4 elements(2 nested mandatory elements)
 Fixed: 8 elements
 Prohibited: 10 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron