Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R5_Invoice_R4

Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-Invoice Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R5_Invoice_R4

This cross-version profile allows R5 Invoice content to be represented via FHIR R4 Invoice resources.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* Invoice(4.0.1) Invoice containing ChargeItems from an Account
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:creation 0..1 dateTime R5: When posted (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Invoice.creation
Constraints: ext-1
.... extension:period 0..1 date, Period R5: Billing date or period (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Invoice.period
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Invoice.status Base required InvoiceStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Invoice If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Invoice If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Invoice If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Invoice If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Invoice A resource should have narrative for robust management text.`div`.exists()
ele-1 error Invoice.implicitRules, Invoice.extension, Invoice.extension:creation, Invoice.extension:period, Invoice.modifierExtension, Invoice.status All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Invoice.extension, Invoice.extension:creation, Invoice.extension:period, Invoice.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Invoice

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* Invoice(4.0.1) Invoice containing ChargeItems from an Account
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:creation 0..1 dateTime R5: When posted (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Invoice.creation
.... extension:period 0..1 date, Period R5: Billing date or period (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Invoice.period
... lineItem
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:serviced 0..1 date, Period R5: Service data or period (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Invoice.lineItem.serviced

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* Invoice(4.0.1) Invoice containing ChargeItems from an Account
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:creation 0..1 dateTime R5: When posted (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Invoice.creation
Constraints: ext-1
.... extension:period 0..1 date, Period R5: Billing date or period (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Invoice.period
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:serviced 0..1 date, Period R5: Service data or period (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Invoice.lineItem.serviced
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... sequence 0..1 positiveInt Sequence number of line item
.... chargeItem[x] 1..1 Reference to ChargeItem containing details of this line item or an inline billing code
..... chargeItemReference Reference(ChargeItem)
..... chargeItemCodeableConcept CodeableConcept
.... priceComponent 0..* BackboneElement Components of total line item price
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... 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

Path Status Usage ValueSet Version Source
Invoice.language Base preferred Common Languages . 📍4.0.1 tx.fhir.org
Invoice.status Base required InvoiceStatus 📍4.0.1 FHIR Std.
Invoice.lineItem.priceComponent.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Invoice If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Invoice If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Invoice If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Invoice If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Invoice A resource should have narrative for robust management text.`div`.exists()
ele-1 error Invoice.meta, Invoice.implicitRules, Invoice.language, Invoice.text, Invoice.extension, Invoice.extension:creation, Invoice.extension:period, Invoice.modifierExtension, Invoice.identifier, Invoice.status, Invoice.cancelledReason, Invoice.type, Invoice.subject, Invoice.recipient, Invoice.date, Invoice.participant, Invoice.participant.extension, Invoice.participant.modifierExtension, Invoice.participant.role, Invoice.participant.actor, Invoice.issuer, Invoice.account, Invoice.lineItem, Invoice.lineItem.extension, Invoice.lineItem.extension:serviced, Invoice.lineItem.modifierExtension, Invoice.lineItem.sequence, Invoice.lineItem.chargeItem[x], Invoice.lineItem.priceComponent, Invoice.lineItem.priceComponent.extension, Invoice.lineItem.priceComponent.modifierExtension, Invoice.lineItem.priceComponent.type, Invoice.lineItem.priceComponent.code, Invoice.lineItem.priceComponent.factor, Invoice.lineItem.priceComponent.amount, Invoice.totalPriceComponent, Invoice.totalNet, Invoice.totalGross, Invoice.paymentTerms, Invoice.note All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Invoice.extension, Invoice.extension:creation, Invoice.extension:period, Invoice.modifierExtension, Invoice.participant.extension, Invoice.participant.modifierExtension, Invoice.lineItem.extension, Invoice.lineItem.extension:serviced, Invoice.lineItem.modifierExtension, Invoice.lineItem.priceComponent.extension, Invoice.lineItem.priceComponent.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* Invoice(4.0.1) Invoice containing ChargeItems from an Account
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:creation 0..1 dateTime R5: When posted (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Invoice.creation
Constraints: ext-1
.... extension:period 0..1 date, Period R5: Billing date or period (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Invoice.period
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Invoice.status Base required InvoiceStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Invoice If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Invoice If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Invoice If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Invoice If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Invoice A resource should have narrative for robust management text.`div`.exists()
ele-1 error Invoice.implicitRules, Invoice.extension, Invoice.extension:creation, Invoice.extension:period, Invoice.modifierExtension, Invoice.status All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Invoice.extension, Invoice.extension:creation, Invoice.extension:period, Invoice.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Invoice

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* Invoice(4.0.1) Invoice containing ChargeItems from an Account
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:creation 0..1 dateTime R5: When posted (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Invoice.creation
.... extension:period 0..1 date, Period R5: Billing date or period (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Invoice.period
... lineItem
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:serviced 0..1 date, Period R5: Service data or period (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Invoice.lineItem.serviced

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* Invoice(4.0.1) Invoice containing ChargeItems from an Account
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:creation 0..1 dateTime R5: When posted (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Invoice.creation
Constraints: ext-1
.... extension:period 0..1 date, Period R5: Billing date or period (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Invoice.period
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:serviced 0..1 date, Period R5: Service data or period (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Invoice.lineItem.serviced
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... sequence 0..1 positiveInt Sequence number of line item
.... chargeItem[x] 1..1 Reference to ChargeItem containing details of this line item or an inline billing code
..... chargeItemReference Reference(ChargeItem)
..... chargeItemCodeableConcept CodeableConcept
.... priceComponent 0..* BackboneElement Components of total line item price
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... 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

Path Status Usage ValueSet Version Source
Invoice.language Base preferred Common Languages . 📍4.0.1 tx.fhir.org
Invoice.status Base required InvoiceStatus 📍4.0.1 FHIR Std.
Invoice.lineItem.priceComponent.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Invoice If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Invoice If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Invoice If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Invoice If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Invoice A resource should have narrative for robust management text.`div`.exists()
ele-1 error Invoice.meta, Invoice.implicitRules, Invoice.language, Invoice.text, Invoice.extension, Invoice.extension:creation, Invoice.extension:period, Invoice.modifierExtension, Invoice.identifier, Invoice.status, Invoice.cancelledReason, Invoice.type, Invoice.subject, Invoice.recipient, Invoice.date, Invoice.participant, Invoice.participant.extension, Invoice.participant.modifierExtension, Invoice.participant.role, Invoice.participant.actor, Invoice.issuer, Invoice.account, Invoice.lineItem, Invoice.lineItem.extension, Invoice.lineItem.extension:serviced, Invoice.lineItem.modifierExtension, Invoice.lineItem.sequence, Invoice.lineItem.chargeItem[x], Invoice.lineItem.priceComponent, Invoice.lineItem.priceComponent.extension, Invoice.lineItem.priceComponent.modifierExtension, Invoice.lineItem.priceComponent.type, Invoice.lineItem.priceComponent.code, Invoice.lineItem.priceComponent.factor, Invoice.lineItem.priceComponent.amount, Invoice.totalPriceComponent, Invoice.totalNet, Invoice.totalGross, Invoice.paymentTerms, Invoice.note All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Invoice.extension, Invoice.extension:creation, Invoice.extension:period, Invoice.modifierExtension, Invoice.participant.extension, Invoice.participant.modifierExtension, Invoice.lineItem.extension, Invoice.lineItem.extension:serviced, Invoice.lineItem.modifierExtension, Invoice.lineItem.priceComponent.extension, Invoice.lineItem.priceComponent.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron