Extensions for Using Data Elements from FHIR R4B in FHIR R5 - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/4.3/StructureDefinition/profile-Invoice | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R4B_Invoice_R5 | ||
This cross-version profile allows R4B Invoice content to be represented via FHIR R5 Invoice resources.
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..* | Invoice(5.0.0) | Invoice containing ChargeItems from an Account | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
?!Σ | 1..1 | code | draft | issued | balanced | cancelled | entered-in-error Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice. |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Invoice.status | Base | required | Invoice Status | 📍5.0.0 | FHIR Std. |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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.modifierExtension, Invoice.status | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Invoice.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Invoice
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Invoice(5.0.0) | 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: AllLanguages (required): IETF language tag for 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 | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
Σ | 0..* | Identifier | Business Identifier for item | ||||
![]() ![]() |
?!Σ | 1..1 | code | draft | issued | balanced | cancelled | entered-in-error Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice. | ||||
![]() ![]() |
0..1 | string | Reason for cancellation of this Invoice | |||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Type of Invoice | ||||
![]() ![]() |
Σ | 0..1 | Reference(Patient | Group) | Recipient(s) of goods and services | ||||
![]() ![]() |
Σ | 0..1 | Reference(Organization | Patient | RelatedPerson) | Recipient of this invoice | ||||
![]() ![]() |
0..1 | dateTime | DEPRICATED | |||||
![]() ![]() |
Σ | 0..1 | dateTime | When posted | ||||
![]() ![]() |
Σ | 0..1 | Billing date or period | |||||
![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() |
0..* | BackboneElement | Participant in creation of this Invoice | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Type of involvement in creation of this Invoice | |||||
![]() ![]() ![]() |
1..1 | Reference(Practitioner | Organization | Patient | PractitionerRole | Device | RelatedPerson) | Individual who was involved | |||||
![]() ![]() |
0..1 | Reference(Organization) | Issuing Organization of Invoice | |||||
![]() ![]() |
0..1 | Reference(Account) | Account that is being balanced | |||||
![]() ![]() |
0..* | BackboneElement | Line items of this Invoice | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..1 | positiveInt | Sequence number of line item | |||||
![]() ![]() ![]() |
0..1 | Service data or period | ||||||
![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
1..1 | Reference to ChargeItem containing details of this line item or an inline billing code | ||||||
![]() ![]() ![]() ![]() |
Reference(ChargeItem) | |||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() |
0..* | MonetaryComponent | Components of total line item price | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | R4B: base | surcharge | deduction | discount | tax | informational (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Invoice.lineItem.priceComponent.type Binding: R4BInvoicePriceComponentTypeForR5 (0.1.0) (required): Codes indicating the kind of the price component. Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | R4B: Code identifying the specific component (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Invoice.lineItem.priceComponent.code Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | R4B: Factor used for calculating this component (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Invoice.lineItem.priceComponent.factor Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Money | R4B: Monetary amount associated with this component (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Invoice.lineItem.priceComponent.amount Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | base | surcharge | deduction | discount | tax | informational Binding: PriceComponentType (required): The purpose for which an extended contact detail should be used. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc. Binding Description: (example): Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Factor used for calculating this component | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Money | Explicit value amount to be used | ||||
![]() ![]() |
0..* | MonetaryComponent | Components of Invoice total | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | R4B: totalPriceComponent additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Invoice.lineItem.priceComponent Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 1..1 | code | base | surcharge | deduction | discount | tax | informational Binding: PriceComponentType (required): The purpose for which an extended contact detail should be used. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc. Binding Description: (example): Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc. | ||||
![]() ![]() ![]() |
Σ | 0..1 | decimal | Factor used for calculating this component | ||||
![]() ![]() ![]() |
Σ | 0..1 | Money | Explicit value amount to be used | ||||
![]() ![]() |
Σ | 0..1 | Money | Net total of this Invoice | ||||
![]() ![]() |
Σ | 0..1 | Money | Gross total of this Invoice | ||||
![]() ![]() |
0..1 | markdown | Payment details | |||||
![]() ![]() |
0..* | Annotation | Comments made about the invoice | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Invoice.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Invoice.status | Base | required | Invoice Status | 📍5.0.0 | FHIR Std. |
| Invoice.lineItem.priceComponent.type | Base | required | Price Component Type | 📍5.0.0 | FHIR Std. |
| Invoice.lineItem.priceComponent.code | Base | example | Not State | Unknown | |
| Invoice.totalPriceComponent.type | Base | required | Price Component Type | 📍5.0.0 | FHIR Std. |
| Invoice.totalPriceComponent.code | Base | example | Not State | Unknown |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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.modifierExtension, Invoice.identifier, Invoice.status, Invoice.cancelledReason, Invoice.type, Invoice.subject, Invoice.recipient, Invoice.date, Invoice.creation, Invoice.period[x], 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.modifierExtension, Invoice.lineItem.sequence, Invoice.lineItem.serviced[x], Invoice.lineItem.chargeItem[x], Invoice.lineItem.priceComponent, Invoice.lineItem.priceComponent.extension, Invoice.lineItem.priceComponent.extension:type, Invoice.lineItem.priceComponent.extension:code, Invoice.lineItem.priceComponent.extension:factor, Invoice.lineItem.priceComponent.extension:amount, Invoice.lineItem.priceComponent.type, Invoice.lineItem.priceComponent.code, Invoice.lineItem.priceComponent.factor, Invoice.lineItem.priceComponent.amount, Invoice.totalPriceComponent, Invoice.totalPriceComponent.extension, Invoice.totalPriceComponent.extension:totalPriceComponent, Invoice.totalPriceComponent.type, Invoice.totalPriceComponent.code, Invoice.totalPriceComponent.factor, Invoice.totalPriceComponent.amount, 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.modifierExtension, Invoice.participant.extension, Invoice.participant.modifierExtension, Invoice.lineItem.extension, Invoice.lineItem.modifierExtension, Invoice.lineItem.priceComponent.extension, Invoice.lineItem.priceComponent.extension:type, Invoice.lineItem.priceComponent.extension:code, Invoice.lineItem.priceComponent.extension:factor, Invoice.lineItem.priceComponent.extension:amount, Invoice.totalPriceComponent.extension, Invoice.totalPriceComponent.extension:totalPriceComponent | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Invoice
Summary
Mandatory: 0 element(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Invoice(5.0.0) | Invoice containing ChargeItems from an Account | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
?!Σ | 1..1 | code | draft | issued | balanced | cancelled | entered-in-error Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice. |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Invoice.status | Base | required | Invoice Status | 📍5.0.0 | FHIR Std. |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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.modifierExtension, Invoice.status | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Invoice.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Invoice
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Invoice(5.0.0) | 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: AllLanguages (required): IETF language tag for 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 | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
Σ | 0..* | Identifier | Business Identifier for item | ||||
![]() ![]() |
?!Σ | 1..1 | code | draft | issued | balanced | cancelled | entered-in-error Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice. | ||||
![]() ![]() |
0..1 | string | Reason for cancellation of this Invoice | |||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Type of Invoice | ||||
![]() ![]() |
Σ | 0..1 | Reference(Patient | Group) | Recipient(s) of goods and services | ||||
![]() ![]() |
Σ | 0..1 | Reference(Organization | Patient | RelatedPerson) | Recipient of this invoice | ||||
![]() ![]() |
0..1 | dateTime | DEPRICATED | |||||
![]() ![]() |
Σ | 0..1 | dateTime | When posted | ||||
![]() ![]() |
Σ | 0..1 | Billing date or period | |||||
![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() |
0..* | BackboneElement | Participant in creation of this Invoice | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Type of involvement in creation of this Invoice | |||||
![]() ![]() ![]() |
1..1 | Reference(Practitioner | Organization | Patient | PractitionerRole | Device | RelatedPerson) | Individual who was involved | |||||
![]() ![]() |
0..1 | Reference(Organization) | Issuing Organization of Invoice | |||||
![]() ![]() |
0..1 | Reference(Account) | Account that is being balanced | |||||
![]() ![]() |
0..* | BackboneElement | Line items of this Invoice | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..1 | positiveInt | Sequence number of line item | |||||
![]() ![]() ![]() |
0..1 | Service data or period | ||||||
![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
1..1 | Reference to ChargeItem containing details of this line item or an inline billing code | ||||||
![]() ![]() ![]() ![]() |
Reference(ChargeItem) | |||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() |
0..* | MonetaryComponent | Components of total line item price | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | R4B: base | surcharge | deduction | discount | tax | informational (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Invoice.lineItem.priceComponent.type Binding: R4BInvoicePriceComponentTypeForR5 (0.1.0) (required): Codes indicating the kind of the price component. Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | R4B: Code identifying the specific component (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Invoice.lineItem.priceComponent.code Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | R4B: Factor used for calculating this component (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Invoice.lineItem.priceComponent.factor Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Money | R4B: Monetary amount associated with this component (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Invoice.lineItem.priceComponent.amount Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | base | surcharge | deduction | discount | tax | informational Binding: PriceComponentType (required): The purpose for which an extended contact detail should be used. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc. Binding Description: (example): Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Factor used for calculating this component | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Money | Explicit value amount to be used | ||||
![]() ![]() |
0..* | MonetaryComponent | Components of Invoice total | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | R4B: totalPriceComponent additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Invoice.lineItem.priceComponent Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 1..1 | code | base | surcharge | deduction | discount | tax | informational Binding: PriceComponentType (required): The purpose for which an extended contact detail should be used. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc. Binding Description: (example): Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc. | ||||
![]() ![]() ![]() |
Σ | 0..1 | decimal | Factor used for calculating this component | ||||
![]() ![]() ![]() |
Σ | 0..1 | Money | Explicit value amount to be used | ||||
![]() ![]() |
Σ | 0..1 | Money | Net total of this Invoice | ||||
![]() ![]() |
Σ | 0..1 | Money | Gross total of this Invoice | ||||
![]() ![]() |
0..1 | markdown | Payment details | |||||
![]() ![]() |
0..* | Annotation | Comments made about the invoice | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Invoice.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Invoice.status | Base | required | Invoice Status | 📍5.0.0 | FHIR Std. |
| Invoice.lineItem.priceComponent.type | Base | required | Price Component Type | 📍5.0.0 | FHIR Std. |
| Invoice.lineItem.priceComponent.code | Base | example | Not State | Unknown | |
| Invoice.totalPriceComponent.type | Base | required | Price Component Type | 📍5.0.0 | FHIR Std. |
| Invoice.totalPriceComponent.code | Base | example | Not State | Unknown |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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.modifierExtension, Invoice.identifier, Invoice.status, Invoice.cancelledReason, Invoice.type, Invoice.subject, Invoice.recipient, Invoice.date, Invoice.creation, Invoice.period[x], 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.modifierExtension, Invoice.lineItem.sequence, Invoice.lineItem.serviced[x], Invoice.lineItem.chargeItem[x], Invoice.lineItem.priceComponent, Invoice.lineItem.priceComponent.extension, Invoice.lineItem.priceComponent.extension:type, Invoice.lineItem.priceComponent.extension:code, Invoice.lineItem.priceComponent.extension:factor, Invoice.lineItem.priceComponent.extension:amount, Invoice.lineItem.priceComponent.type, Invoice.lineItem.priceComponent.code, Invoice.lineItem.priceComponent.factor, Invoice.lineItem.priceComponent.amount, Invoice.totalPriceComponent, Invoice.totalPriceComponent.extension, Invoice.totalPriceComponent.extension:totalPriceComponent, Invoice.totalPriceComponent.type, Invoice.totalPriceComponent.code, Invoice.totalPriceComponent.factor, Invoice.totalPriceComponent.amount, 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.modifierExtension, Invoice.participant.extension, Invoice.participant.modifierExtension, Invoice.lineItem.extension, Invoice.lineItem.modifierExtension, Invoice.lineItem.priceComponent.extension, Invoice.lineItem.priceComponent.extension:type, Invoice.lineItem.priceComponent.extension:code, Invoice.lineItem.priceComponent.extension:factor, Invoice.lineItem.priceComponent.extension:amount, Invoice.totalPriceComponent.extension, Invoice.totalPriceComponent.extension:totalPriceComponent | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Invoice
Summary
Mandatory: 0 element(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron