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: InvoiceCore

Official URL: https://fhir.cambio.se/StructureDefinition/InvoiceCore Version: 1.0.0
Active as of 2024-01-17 Computable Name: InvoiceCore

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* Invoice Invoice containing ChargeItems from an Account
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code draft | issued | balanced | cancelled | entered-in-error
Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Invoice.statusrequiredInvoiceStatus
http://hl7.org/fhir/ValueSet/invoice-status|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 Invoice

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* Invoice Invoice containing ChargeItems from an Account
... lineItem
.... chargeItem[x] 1..1 Reference(ChargeItem) Reference to ChargeItem containing details of this line item or an inline billing code

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* Invoice Invoice containing ChargeItems from an Account
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for item
... status ?!Σ 1..1 code draft | issued | balanced | cancelled | entered-in-error
Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice.
... cancelledReason 0..1 string Reason for cancellation of this Invoice
... type Σ 0..1 CodeableConcept Type of Invoice
... subject Σ 0..1 Reference(Patient | Group) Recipient(s) of goods and services
... recipient Σ 0..1 Reference(Organization | Patient | RelatedPerson) Recipient of this invoice
... date Σ 0..1 dateTime Invoice date / posting date
... participant 0..* BackboneElement Participant in creation of this Invoice
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role 0..1 CodeableConcept Type of involvement in creation of this Invoice
.... actor 1..1 Reference(Practitioner | Organization | Patient | PractitionerRole | Device | RelatedPerson) Individual who was involved
... issuer 0..1 Reference(Organization) Issuing Organization of Invoice
... account 0..1 Reference(Account) Account that is being balanced
... 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
.... sequence 0..1 positiveInt Sequence number of line item
.... chargeItem[x] 1..1 Reference(ChargeItem) Reference to ChargeItem containing details of this line item or an inline billing code
.... priceComponent 0..* BackboneElement Components of total line item price
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.
..... code 0..1 CodeableConcept Code identifying the specific component
..... factor 0..1 decimal Factor used for calculating this component
..... amount 0..1 Money Monetary amount associated with this component
... totalPriceComponent 0..* See priceComponent (Invoice) Components of Invoice total
... totalNet Σ 0..1 Money Net total of this Invoice
... totalGross Σ 0..1 Money Gross total of this Invoice
... paymentTerms 0..1 markdown Payment details
... note 0..* Annotation Comments made about the invoice

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Invoice.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
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

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 Invoice

Summary

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* Invoice Invoice containing ChargeItems from an Account
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code draft | issued | balanced | cancelled | entered-in-error
Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Invoice.statusrequiredInvoiceStatus
http://hl7.org/fhir/ValueSet/invoice-status|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 Invoice

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* Invoice Invoice containing ChargeItems from an Account
... lineItem
.... chargeItem[x] 1..1 Reference(ChargeItem) Reference to ChargeItem containing details of this line item or an inline billing code

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* Invoice Invoice containing ChargeItems from an Account
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for item
... status ?!Σ 1..1 code draft | issued | balanced | cancelled | entered-in-error
Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice.
... cancelledReason 0..1 string Reason for cancellation of this Invoice
... type Σ 0..1 CodeableConcept Type of Invoice
... subject Σ 0..1 Reference(Patient | Group) Recipient(s) of goods and services
... recipient Σ 0..1 Reference(Organization | Patient | RelatedPerson) Recipient of this invoice
... date Σ 0..1 dateTime Invoice date / posting date
... participant 0..* BackboneElement Participant in creation of this Invoice
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role 0..1 CodeableConcept Type of involvement in creation of this Invoice
.... actor 1..1 Reference(Practitioner | Organization | Patient | PractitionerRole | Device | RelatedPerson) Individual who was involved
... issuer 0..1 Reference(Organization) Issuing Organization of Invoice
... account 0..1 Reference(Account) Account that is being balanced
... 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
.... sequence 0..1 positiveInt Sequence number of line item
.... chargeItem[x] 1..1 Reference(ChargeItem) Reference to ChargeItem containing details of this line item or an inline billing code
.... priceComponent 0..* BackboneElement Components of total line item price
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.
..... code 0..1 CodeableConcept Code identifying the specific component
..... factor 0..1 decimal Factor used for calculating this component
..... amount 0..1 Money Monetary amount associated with this component
... totalPriceComponent 0..* See priceComponent (Invoice) Components of Invoice total
... totalNet Σ 0..1 Money Net total of this Invoice
... totalGross Σ 0..1 Money Gross total of this Invoice
... paymentTerms 0..1 markdown Payment details
... note 0..* Annotation Comments made about the invoice

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Invoice.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
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

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 Invoice

Summary

 

Other representations of profile: CSV, Excel, Schematron