Profile_R4B_Invoice_R3 - Definitions - Extensions for Using Data Elements from FHIR R4B in FHIR STU3 v0.1.0

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

Resource Profile: Profile_R4B_Invoice_R3 - Detailed Descriptions

Page standards status: Trial-use

Maturity Level: 0

Definitions for the profile-Invoice resource profile.

Key Elements Table
Differential Elements Table
Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. Basic
Definition	Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.
Short	Resource for non-supported content
Control	0..*
Alternate Names	Z-resource, Extension-resource, Custom-resource
Invariants	dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (`contained.text.empty()`) dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (`contained.where(('#'+id in %resource.descendants().reference).not()).empty()`) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty()) dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
2. Basic.implicitRules
Definition	A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Short	A set of rules under which this content was created
Comments	Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
Control	0..1
Type	uri
Is Modifier	true because No Modifier Reason provideed in previous versions of FHIR
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
4. Basic.extension
Definition	An Extension May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short	ExtensionAdditional Content defined by implementations
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..*
Type	Extension
Alternate Names	extensions, user content
Slicing	This element introduces a set of slices on `Basic.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
6. Basic.extension:cancelledReason
Slice Name	cancelledReason
Definition	R4B: `Invoice.cancelledReason` (new:string)
Short	R4B: Reason for cancellation of this Invoice (new)
Comments	Element `Invoice.cancelledReason` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.cancelledReason` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Derived Profiles may choose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled.
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R4B: Reason for cancellation of this Invoice (new)) (Extension Type: string)
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() \| (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
8. Basic.extension:type
Slice Name	type
Definition	R4B: `Invoice.type` (new:CodeableConcept)
Short	R4B: Type of Invoice (new)
Comments	Element `Invoice.type` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.type` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R4B: Type of Invoice (new)) (Extension Type: CodeableConcept)
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() \| (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
10. Basic.extension:recipient
Slice Name	recipient
Definition	R4B: `Invoice.recipient` (new:Reference(Organization,Patient,RelatedPerson))
Short	R4B: Recipient of this invoice (new)
Comments	Element `Invoice.recipient` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.recipient` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R4B: Recipient of this invoice (new)) (Extension Type: Reference(Cross-version Profile for R4B.Organization for use in FHIR STU3, Organization, Cross-version Profile for R4B.Patient for use in FHIR STU3, Patient, Cross-version Profile for R4B.RelatedPerson for use in FHIR STU3, RelatedPerson))
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() \| (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
12. Basic.extension:date
Slice Name	date
Definition	R4B: `Invoice.date` (new:dateTime)
Short	R4B: Invoice date / posting date (new)
Comments	Element `Invoice.date` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.date` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). The list of types may be constrained as appropriate for the type of charge item.
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R4B: Invoice date / posting date (new)) (Extension Type: dateTime)
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() \| (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
14. Basic.extension:participant
Slice Name	participant
Definition	R4B: `Invoice.participant` (new:BackboneElement)
Short	R4B: Participant in creation of this Invoice (new)
Comments	Element `Invoice.participant` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.participant` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R4B: Participant in creation of this Invoice (new)) (Complex Extension)
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() \| (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
16. Basic.extension:issuer
Slice Name	issuer
Definition	R4B: `Invoice.issuer` (new:Reference(Organization))
Short	R4B: Issuing Organization of Invoice (new)
Comments	Element `Invoice.issuer` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.issuer` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Practitioners and Devices can be associated with multiple organizations. It has to be made clear, on behalf of which Organization the services have been rendered.
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R4B: Issuing Organization of Invoice (new)) (Extension Type: Reference(Cross-version Profile for R4B.Organization for use in FHIR STU3, Organization))
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() \| (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
18. Basic.extension:account
Slice Name	account
Definition	R4B: `Invoice.account` (new:Reference(Account))
Short	R4B: Account that is being balanced (new)
Comments	Element `Invoice.account` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.account` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Systems posting the ChargeItems might not always be able to determine, which accounts the Items need to be places into. It is up to the potprocessing Financial System to apply internal rules to decide based on the Encounter/EpisodeOfCare/Patient/Coverage context and the type of ChargeItem, which Account is appropriate.
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R4B: Account that is being balanced (new)) (Extension Type: Reference(Cross-version Profile for R4B.Account for use in FHIR STU3, Account))
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() \| (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
20. Basic.extension:lineItem
Slice Name	lineItem
Definition	R4B: `Invoice.lineItem` (new:BackboneElement)
Short	R4B: Line items of this Invoice (new)
Comments	Element `Invoice.lineItem` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.lineItem` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R4B: Line items of this Invoice (new)) (Complex Extension)
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() \| (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
22. Basic.extension:priceComponent
Slice Name	priceComponent
Definition	R4B: `Invoice.lineItem.priceComponent` (new:BackboneElement)
Short	R4B: Components of total line item price (new)
Comments	Element `Invoice.lineItem.priceComponent` is part of an existing definition because parent element `Invoice.lineItem` requires a cross-version extension. Element `Invoice.lineItem.priceComponent` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.lineItem.priceComponent` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R4B: Components of total line item price (new)) (Complex Extension)
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() \| (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
24. Basic.extension:totalPriceComponent
Slice Name	totalPriceComponent
Definition	R4B: `Invoice.totalPriceComponent` (new:Invoice.lineItem.priceComponent)
Short	R4B: Components of Invoice total (new)
Comments	Element `Invoice.totalPriceComponent` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.totalPriceComponent` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R4B: Components of total line item price (new)) (Complex Extension)
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() \| (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
26. Basic.extension:totalNet
Slice Name	totalNet
Definition	R4B: `Invoice.totalNet` (new:Money)
Short	R4B: Net total of this Invoice (new)
Comments	Element `Invoice.totalNet` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.totalNet` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overridden.
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R4B: Net total of this Invoice (new)) (Extension Type: Money)
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() \| (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
28. Basic.extension:totalGross
Slice Name	totalGross
Definition	R4B: `Invoice.totalGross` (new:Money)
Short	R4B: Gross total of this Invoice (new)
Comments	Element `Invoice.totalGross` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.totalGross` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overridden.
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R4B: Gross total of this Invoice (new)) (Extension Type: Money)
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() \| (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
30. Basic.extension:paymentTerms
Slice Name	paymentTerms
Definition	R4B: `Invoice.paymentTerms` (new:markdown)
Short	R4B: Payment details (new)
Comments	Element `Invoice.paymentTerms` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.paymentTerms` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Derived Profiles may chose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled.
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R4B: Payment details (new)) (Extension Type: markdown)
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() \| (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
32. Basic.extension:note
Slice Name	note
Definition	R4B: `Invoice.note` (new:Annotation)
Short	R4B: Comments made about the invoice (new)
Comments	Element `Invoice.note` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.note` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R4B: Comments made about the invoice (new)) (Extension Type: Annotation)
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() \| (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
34. Basic.modifierExtension
Definition	An Extension May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Short	ExtensionExtensions that cannot be ignored
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..*
Type	Extension
Is Modifier	true because No Modifier Reason provideed in previous versions of FHIR
Alternate Names	extensions, user content
Slicing	This element introduces a set of slices on `Basic.modifierExtension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
36. Basic.modifierExtension:status
Slice Name	status
Definition	R4B: `Invoice.status` (new:code)
Short	R4B: draft \| issued \| balanced \| cancelled \| entered-in-error (new)
Comments	Element `Invoice.status` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.status` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
Control	1..1 This element is affected by the following invariants: ele-1
Type	Extension(R4B: draft \| issued \| balanced \| cancelled \| entered-in-error (new)) (Extension Type: code)
Is Modifier	true because No Modifier Reason provideed in previous versions of FHIR
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() \| (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
38. Basic.code
Definition	Identifies the 'type' of resource - equivalent to the resource name for other resources.
Short	Kind of Resource
Comments	Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code. This element is labeled as a modifier because the it defines the meaning of the resource and cannot be ignored.
Control	1..1
Binding	For example codes, see Basic Resource Typeshttp://hl7.org/fhir/ValueSet/basic-resource-type\|3.0.2 (example to `http://hl7.org/fhir/ValueSet/basic-resource-type\|3.0.2`) Codes for identifying types of resources not yet defined by FHIR
Type	CodeableConcept
Is Modifier	true because No Modifier Reason provideed in previous versions of FHIR
Summary	true
Requirements	Must be able to distinguish different types of Basic resources.

Guidance on how to interpret the contents of this table can be foundhere

0. Basic
2. Basic.extension
Control	0..*
Slicing	This element introduces a set of slices on `Basic.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
4. Basic.extension:cancelledReason
Slice Name	cancelledReason
Definition	R4B: `Invoice.cancelledReason` (new:string)
Short	R4B: Reason for cancellation of this Invoice (new)
Comments	Element `Invoice.cancelledReason` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.cancelledReason` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Derived Profiles may choose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled.
Control	0..1
Type	Extension(R4B: Reason for cancellation of this Invoice (new)) (Extension Type: string)
6. Basic.extension:type
Slice Name	type
Definition	R4B: `Invoice.type` (new:CodeableConcept)
Short	R4B: Type of Invoice (new)
Comments	Element `Invoice.type` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.type` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
Control	0..1
Type	Extension(R4B: Type of Invoice (new)) (Extension Type: CodeableConcept)
8. Basic.extension:recipient
Slice Name	recipient
Definition	R4B: `Invoice.recipient` (new:Reference(Organization,Patient,RelatedPerson))
Short	R4B: Recipient of this invoice (new)
Comments	Element `Invoice.recipient` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.recipient` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
Control	0..1
Type	Extension(R4B: Recipient of this invoice (new)) (Extension Type: Reference(Cross-version Profile for R4B.Organization for use in FHIR STU3, Organization, Cross-version Profile for R4B.Patient for use in FHIR STU3, Patient, Cross-version Profile for R4B.RelatedPerson for use in FHIR STU3, RelatedPerson))
10. Basic.extension:date
Slice Name	date
Definition	R4B: `Invoice.date` (new:dateTime)
Short	R4B: Invoice date / posting date (new)
Comments	Element `Invoice.date` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.date` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). The list of types may be constrained as appropriate for the type of charge item.
Control	0..1
Type	Extension(R4B: Invoice date / posting date (new)) (Extension Type: dateTime)
12. Basic.extension:participant
Slice Name	participant
Definition	R4B: `Invoice.participant` (new:BackboneElement)
Short	R4B: Participant in creation of this Invoice (new)
Comments	Element `Invoice.participant` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.participant` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
Control	0..*
Type	Extension(R4B: Participant in creation of this Invoice (new)) (Complex Extension)
14. Basic.extension:issuer
Slice Name	issuer
Definition	R4B: `Invoice.issuer` (new:Reference(Organization))
Short	R4B: Issuing Organization of Invoice (new)
Comments	Element `Invoice.issuer` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.issuer` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Practitioners and Devices can be associated with multiple organizations. It has to be made clear, on behalf of which Organization the services have been rendered.
Control	0..1
Type	Extension(R4B: Issuing Organization of Invoice (new)) (Extension Type: Reference(Cross-version Profile for R4B.Organization for use in FHIR STU3, Organization))
16. Basic.extension:account
Slice Name	account
Definition	R4B: `Invoice.account` (new:Reference(Account))
Short	R4B: Account that is being balanced (new)
Comments	Element `Invoice.account` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.account` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Systems posting the ChargeItems might not always be able to determine, which accounts the Items need to be places into. It is up to the potprocessing Financial System to apply internal rules to decide based on the Encounter/EpisodeOfCare/Patient/Coverage context and the type of ChargeItem, which Account is appropriate.
Control	0..1
Type	Extension(R4B: Account that is being balanced (new)) (Extension Type: Reference(Cross-version Profile for R4B.Account for use in FHIR STU3, Account))
18. Basic.extension:lineItem
Slice Name	lineItem
Definition	R4B: `Invoice.lineItem` (new:BackboneElement)
Short	R4B: Line items of this Invoice (new)
Comments	Element `Invoice.lineItem` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.lineItem` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
Control	0..*
Type	Extension(R4B: Line items of this Invoice (new)) (Complex Extension)
20. Basic.extension:priceComponent
Slice Name	priceComponent
Definition	R4B: `Invoice.lineItem.priceComponent` (new:BackboneElement)
Short	R4B: Components of total line item price (new)
Comments	Element `Invoice.lineItem.priceComponent` is part of an existing definition because parent element `Invoice.lineItem` requires a cross-version extension. Element `Invoice.lineItem.priceComponent` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.lineItem.priceComponent` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
Control	0..*
Type	Extension(R4B: Components of total line item price (new)) (Complex Extension)
22. Basic.extension:totalPriceComponent
Slice Name	totalPriceComponent
Definition	R4B: `Invoice.totalPriceComponent` (new:Invoice.lineItem.priceComponent)
Short	R4B: Components of Invoice total (new)
Comments	Element `Invoice.totalPriceComponent` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.totalPriceComponent` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
Control	0..*
Type	Extension(R4B: Components of total line item price (new)) (Complex Extension)
24. Basic.extension:totalNet
Slice Name	totalNet
Definition	R4B: `Invoice.totalNet` (new:Money)
Short	R4B: Net total of this Invoice (new)
Comments	Element `Invoice.totalNet` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.totalNet` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overridden.
Control	0..1
Type	Extension(R4B: Net total of this Invoice (new)) (Extension Type: Money)
26. Basic.extension:totalGross
Slice Name	totalGross
Definition	R4B: `Invoice.totalGross` (new:Money)
Short	R4B: Gross total of this Invoice (new)
Comments	Element `Invoice.totalGross` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.totalGross` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overridden.
Control	0..1
Type	Extension(R4B: Gross total of this Invoice (new)) (Extension Type: Money)
28. Basic.extension:paymentTerms
Slice Name	paymentTerms
Definition	R4B: `Invoice.paymentTerms` (new:markdown)
Short	R4B: Payment details (new)
Comments	Element `Invoice.paymentTerms` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.paymentTerms` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Derived Profiles may chose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled.
Control	0..1
Type	Extension(R4B: Payment details (new)) (Extension Type: markdown)
30. Basic.extension:note
Slice Name	note
Definition	R4B: `Invoice.note` (new:Annotation)
Short	R4B: Comments made about the invoice (new)
Comments	Element `Invoice.note` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.note` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
Control	0..*
Type	Extension(R4B: Comments made about the invoice (new)) (Extension Type: Annotation)
32. Basic.modifierExtension
Control	0..*
Slicing	This element introduces a set of slices on `Basic.modifierExtension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
34. Basic.modifierExtension:status
Slice Name	status
Definition	R4B: `Invoice.status` (new:code)
Short	R4B: draft \| issued \| balanced \| cancelled \| entered-in-error (new)
Comments	Element `Invoice.status` is not mapped to FHIR STU3, since FHIR R4B `Invoice` is not mapped. Element `Invoice.status` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
Control	1..1
Type	Extension(R4B: draft \| issued \| balanced \| cancelled \| entered-in-error (new)) (Extension Type: code)

Guidance on how to interpret the contents of this table can be foundhere

0. Basic

Definition

Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.

Short Resource for non-supported content

Control 0..*

Alternate Names Z-resource, Extension-resource, Custom-resource

Invariants dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())

2. Basic.id

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Short Logical id of this artifact

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Control 0..1

Type

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

4. Basic.meta

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Short Metadata about the resource

Control 0..1

Type

Meta

Summary true

6. Basic.implicitRules

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Short A set of rules under which this content was created

Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Control 0..1

Type

uri

Is Modifier true because No Modifier Reason provideed in previous versions of FHIR

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

8. Basic.language

Definition

The base language in which the resource is written.

Short Language of the resource content

Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control 0..1

Binding

Unless not suitable, these codes SHALL be taken from Common Languages
(extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)

A human language.

Additional Bindings

Purpose

Primitive Value This primitive element may be present, or absent, or replaced by an extension

10. Basic.text

Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Short Text summary of the resource, for human interpretation

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

Control 0..1
This element is affected by the following invariants: dom-1

Type

Narrative

Alternate Names narrative, html, xhtml, display

12. Basic.contained

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Short Contained, inline Resources

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

Control 0..*

Type

Resource

Alternate Names inline resources, anonymous resources, contained resources

14. Basic.extension

Definition

An Extension

Short Extension

Control 0..*

Type

Extension

Slicing

This element introduces a set of slices on Basic.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

16. Basic.extension:cancelledReason

Slice Name cancelledReason

Definition

R4B: Invoice.cancelledReason (new:string)

Short R4B: Reason for cancellation of this Invoice (new)

Comments

Element Invoice.cancelledReason is not mapped to FHIR STU3, since FHIR R4B Invoice is not mapped. Element Invoice.cancelledReason has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Derived Profiles may choose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R4B: Reason for cancellation of this Invoice (new)) (Extension Type: string)

Is Modifier false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

18. Basic.extension:type

Slice Name type

Definition

R4B: Invoice.type (new:CodeableConcept)

Short R4B: Type of Invoice (new)

Comments

Element Invoice.type is not mapped to FHIR STU3, since FHIR R4B Invoice is not mapped. Element Invoice.type has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R4B: Type of Invoice (new)) (Extension Type: CodeableConcept)

Is Modifier false

20. Basic.extension:recipient

Slice Name recipient

Definition

R4B: Invoice.recipient (new:Reference(Organization,Patient,RelatedPerson))

Short R4B: Recipient of this invoice (new)

Comments

Element Invoice.recipient is not mapped to FHIR STU3, since FHIR R4B Invoice is not mapped. Element Invoice.recipient has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R4B: Recipient of this invoice (new)) (Extension Type: Reference(Cross-version Profile for R4B.Organization for use in FHIR STU3, Organization, Cross-version Profile for R4B.Patient for use in FHIR STU3, Patient, Cross-version Profile for R4B.RelatedPerson for use in FHIR STU3, RelatedPerson))

Is Modifier false

22. Basic.extension:date

Slice Name date

Definition

R4B: Invoice.date (new:dateTime)

Short R4B: Invoice date / posting date (new)

Comments

Element Invoice.date is not mapped to FHIR STU3, since FHIR R4B Invoice is not mapped. Element Invoice.date has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). The list of types may be constrained as appropriate for the type of charge item.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R4B: Invoice date / posting date (new)) (Extension Type: dateTime)

Is Modifier false

24. Basic.extension:participant

Slice Name participant

Definition

R4B: Invoice.participant (new:BackboneElement)

Short R4B: Participant in creation of this Invoice (new)

Comments

Element Invoice.participant is not mapped to FHIR STU3, since FHIR R4B Invoice is not mapped. Element Invoice.participant has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R4B: Participant in creation of this Invoice (new)) (Complex Extension)

Is Modifier false

26. Basic.extension:issuer

Slice Name issuer

Definition

R4B: Invoice.issuer (new:Reference(Organization))

Short R4B: Issuing Organization of Invoice (new)

Comments

Element Invoice.issuer is not mapped to FHIR STU3, since FHIR R4B Invoice is not mapped. Element Invoice.issuer has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Practitioners and Devices can be associated with multiple organizations. It has to be made clear, on behalf of which Organization the services have been rendered.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R4B: Issuing Organization of Invoice (new)) (Extension Type: Reference(Cross-version Profile for R4B.Organization for use in FHIR STU3, Organization))

Is Modifier false

28. Basic.extension:account

Slice Name account

Definition

R4B: Invoice.account (new:Reference(Account))

Short R4B: Account that is being balanced (new)

Comments

Element Invoice.account is not mapped to FHIR STU3, since FHIR R4B Invoice is not mapped. Element Invoice.account has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Systems posting the ChargeItems might not always be able to determine, which accounts the Items need to be places into. It is up to the potprocessing Financial System to apply internal rules to decide based on the Encounter/EpisodeOfCare/Patient/Coverage context and the type of ChargeItem, which Account is appropriate.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R4B: Account that is being balanced (new)) (Extension Type: Reference(Cross-version Profile for R4B.Account for use in FHIR STU3, Account))

Is Modifier false

30. Basic.extension:lineItem

Slice Name lineItem

Definition

R4B: Invoice.lineItem (new:BackboneElement)

Short R4B: Line items of this Invoice (new)

Comments

Element Invoice.lineItem is not mapped to FHIR STU3, since FHIR R4B Invoice is not mapped. Element Invoice.lineItem has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R4B: Line items of this Invoice (new)) (Complex Extension)

Is Modifier false

32. Basic.extension:priceComponent

Slice Name priceComponent

Definition

R4B: Invoice.lineItem.priceComponent (new:BackboneElement)

Short R4B: Components of total line item price (new)

Comments

Element Invoice.lineItem.priceComponent is part of an existing definition because parent element Invoice.lineItem requires a cross-version extension. Element Invoice.lineItem.priceComponent is not mapped to FHIR STU3, since FHIR R4B Invoice is not mapped. Element Invoice.lineItem.priceComponent has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R4B: Components of total line item price (new)) (Complex Extension)

Is Modifier false

34. Basic.extension:totalPriceComponent

Slice Name totalPriceComponent

Definition

R4B: Invoice.totalPriceComponent (new:Invoice.lineItem.priceComponent)

Short R4B: Components of Invoice total (new)

Comments

Element Invoice.totalPriceComponent is not mapped to FHIR STU3, since FHIR R4B Invoice is not mapped. Element Invoice.totalPriceComponent has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R4B: Components of total line item price (new)) (Complex Extension)

Is Modifier false

36. Basic.extension:totalNet

Slice Name totalNet

Definition

R4B: Invoice.totalNet (new:Money)

Short R4B: Net total of this Invoice (new)

Comments

Element Invoice.totalNet is not mapped to FHIR STU3, since FHIR R4B Invoice is not mapped. Element Invoice.totalNet has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overridden.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R4B: Net total of this Invoice (new)) (Extension Type: Money)

Is Modifier false

38. Basic.extension:totalGross

Slice Name totalGross

Definition

R4B: Invoice.totalGross (new:Money)

Short R4B: Gross total of this Invoice (new)

Comments

Element Invoice.totalGross is not mapped to FHIR STU3, since FHIR R4B Invoice is not mapped. Element Invoice.totalGross has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overridden.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R4B: Gross total of this Invoice (new)) (Extension Type: Money)

Is Modifier false

40. Basic.extension:paymentTerms

Slice Name paymentTerms

Definition

R4B: Invoice.paymentTerms (new:markdown)

Short R4B: Payment details (new)

Comments

Element Invoice.paymentTerms is not mapped to FHIR STU3, since FHIR R4B Invoice is not mapped. Element Invoice.paymentTerms has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Derived Profiles may chose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R4B: Payment details (new)) (Extension Type: markdown)

Is Modifier false

42. Basic.extension:note

Slice Name note

Definition

R4B: Invoice.note (new:Annotation)

Short R4B: Comments made about the invoice (new)

Comments

Element Invoice.note is not mapped to FHIR STU3, since FHIR R4B Invoice is not mapped. Element Invoice.note has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R4B: Comments made about the invoice (new)) (Extension Type: Annotation)

Is Modifier false

44. Basic.modifierExtension

Definition

An Extension

Short Extension

Control 0..*

Type

Extension

Is Modifier true because No Modifier Reason provideed in previous versions of FHIR

Slicing

This element introduces a set of slices on Basic.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

46. Basic.modifierExtension:status

Slice Name status

Definition

R4B: Invoice.status (new:code)

Short R4B: draft | issued | balanced | cancelled | entered-in-error (new)

Comments

Element Invoice.status is not mapped to FHIR STU3, since FHIR R4B Invoice is not mapped. Element Invoice.status has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

Control 1..1
This element is affected by the following invariants: ele-1

Type Extension(R4B: draft | issued | balanced | cancelled | entered-in-error (new)) (Extension Type: code)

Is Modifier true because No Modifier Reason provideed in previous versions of FHIR

48. Basic.identifier

Definition

Identifier assigned to the resource for business purposes, outside the context of FHIR.

Short Business identifier

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..*

Type

Identifier

Summary true

50. Basic.code

Definition

Identifies the 'type' of resource - equivalent to the resource name for other resources.

Short Kind of Resource

Comments

Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code.

This element is labeled as a modifier because the it defines the meaning of the resource and cannot be ignored.

Control 1..1

Binding

For example codes, see Basic Resource Types
(example to http://hl7.org/fhir/ValueSet/basic-resource-type|3.0.2)

Codes for identifying types of resources not yet defined by FHIR

Type

CodeableConcept

Is Modifier true because No Modifier Reason provideed in previous versions of FHIR

Summary true

Requirements

Must be able to distinguish different types of Basic resources.

52. Basic.subject

Definition

Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource.

Short Identifies the focus of this resource

Comments

Optional as not all potential resources will have subjects. Resources associated with multiple subjects can handle this via extension.

Control 0..1

Type Reference(Resource)

Summary true

Requirements

Needed for partitioning the resource by Patient.

54. Basic.created

Definition

Identifies when the resource was first created.

Short When created

Control 0..1

Type

date

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Allows ordering resource instances by time.

56. Basic.author

Definition

Indicates who was responsible for creating the resource instance.

Short Who created

Control 0..1

Type Reference(Practitioner, Patient, RelatedPerson)

Summary true

Requirements

Needed for partitioning the resource.