Extensions for Using Data Elements from FHIR R4B in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R4B in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R4B in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the ext-R4B-Invoice.lineItem extension.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |
| Definition | R4B: Optional Extension Element - found in all resources. |
| Short | R4B: Line items of this Invoice (new)Optional Extensions Element |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| 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())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()) |
| 2. Extension.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. 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 | 10..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. Extension.extension:sequence | |
| Slice Name | sequence |
| Definition | R4B: |
| Short | R4B: Sequence number of line item (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 6. Extension.extension:sequence.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | sequence |
| 8. Extension.extension:sequence.value[x] | |
| Definition | Sequence in which the items appear on the invoice. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Sequence number of line itemValue of extension |
| Control | 0..1 |
| Type | positiveInt, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. Extension.extension:chargeItem | |
| Slice Name | chargeItem |
| Definition | R4B: |
| Short | R4B: Reference to ChargeItem containing details of this line item or an inline billing code (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 10..1* |
| Type | Extension |
| Requirements | Element |
| 12. Extension.extension:chargeItem.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | chargeItem |
| 14. Extension.extension:chargeItem.value[x] | |
| Definition | The ChargeItem contains information such as the billing code, date, amount etc. If no further details are required for the lineItem, inline billing codes can be added using the CodeableConcept data type instead of the Reference. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Reference to ChargeItem containing details of this line item or an inline billing codeValue of extension |
| Control | 10..1 |
| Type | Choice of: Reference(Cross-version Profile for R4B.ChargeItem for use in FHIR STU3, ChargeItem), CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 16. Extension.extension:priceComponent | |
| Slice Name | priceComponent |
| Definition | R4B: |
| Short | R4B: Components of total line item price (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..* |
| Type | Extension |
| Requirements | Element |
| 18. Extension.extension:priceComponent.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. 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 | 10..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 20. Extension.extension:priceComponent.extension:type | |
| Slice Name | type |
| Definition | R4B: |
| Short | R4B: base | surcharge | deduction | discount | tax | informational (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 10..1* |
| Type | Extension |
| Requirements | Element |
| 22. Extension.extension:priceComponent.extension:type.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | type |
| 24. Extension.extension:priceComponent.extension:type.value[x] | |
| Definition | This code identifies the type of the component. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | base | surcharge | deduction | discount | tax | informationalValue of extension |
| Control | 10..1 |
| Binding | The codes SHALL be taken from For codes, see R4BInvoicePriceComponentTypeForR3 (0.1.0) (required to http://hl7.org/fhir/uv/xver/ValueSet/R4B-invoice-priceComponentType-for-R3|0.1.0)Codes indicating the kind of the price component. |
| Type | code, date, dateTime, Meta, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. Extension.extension:priceComponent.extension:code | |
| Slice Name | code |
| Definition | R4B: |
| Short | R4B: Code identifying the specific component (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 28. Extension.extension:priceComponent.extension:code.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | code |
| 30. Extension.extension:priceComponent.extension:code.value[x] | |
| Definition | A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Code identifying the specific componentValue of extension |
| Control | 0..1 |
| Type | CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 32. Extension.extension:priceComponent.extension:factor | |
| Slice Name | factor |
| Definition | R4B: |
| Short | R4B: Factor used for calculating this component (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 34. Extension.extension:priceComponent.extension:factor.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | factor |
| 36. Extension.extension:priceComponent.extension:factor.value[x] | |
| Definition | The factor that has been applied on the base price for calculating this component. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Factor used for calculating this componentValue of extension |
| Comments | 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 | decimal, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 38. Extension.extension:priceComponent.extension:amount | |
| Slice Name | amount |
| Definition | R4B: |
| Short | R4B: Monetary amount associated with this component (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 40. Extension.extension:priceComponent.extension:amount.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | amount |
| 42. Extension.extension:priceComponent.extension:amount.value[x] | |
| Definition | The amount calculated for this component. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Monetary amount associated with this componentValue of extension |
| Comments | 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 | Money, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 44. Extension.extension:priceComponent.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | priceComponent |
| 46. Extension.extension:priceComponent.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Value of extension |
| Control | 0..01 |
| Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 48. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | http://hl7.org/fhir/4.3/StructureDefinition/extension-Invoice.lineItem |
| 50. Extension.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Value of extension |
| Control | 0..01 |
| Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |
| Definition | R4B: |
| Short | R4B: Line items of this Invoice (new) |
| Comments | Element |
| Control | 0..* |
| Is Modifier | false |
| 2. Extension.extension | |
| Control | 1..* |
| Slicing | This element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. Extension.extension:sequence | |
| Slice Name | sequence |
| Definition | R4B: |
| Short | R4B: Sequence number of line item (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 6. Extension.extension:sequence.url | |
| Control | 1..1 |
| Fixed Value | sequence |
| 8. Extension.extension:sequence.value[x] | |
| Definition | Sequence in which the items appear on the invoice. |
| Short | Sequence number of line item |
| Control | 0..1 |
| Type | positiveInt |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. Extension.extension:chargeItem | |
| Slice Name | chargeItem |
| Definition | R4B: |
| Short | R4B: Reference to ChargeItem containing details of this line item or an inline billing code (new) |
| Comments | Element |
| Control | 1..1 |
| Requirements | Element |
| 12. Extension.extension:chargeItem.url | |
| Control | 1..1 |
| Fixed Value | chargeItem |
| 14. Extension.extension:chargeItem.value[x] | |
| Definition | The ChargeItem contains information such as the billing code, date, amount etc. If no further details are required for the lineItem, inline billing codes can be added using the CodeableConcept data type instead of the Reference. |
| Short | Reference to ChargeItem containing details of this line item or an inline billing code |
| Control | 1..1 |
| Type | Choice of: Reference(Cross-version Profile for R4B.ChargeItem for use in FHIR STU3, ChargeItem), CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 16. Extension.extension:priceComponent | |
| Slice Name | priceComponent |
| Definition | R4B: |
| Short | R4B: Components of total line item price (new) |
| Comments | Element |
| Control | 0..* |
| Requirements | Element |
| 18. Extension.extension:priceComponent.extension | |
| Control | 1..* |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 20. Extension.extension:priceComponent.extension:type | |
| Slice Name | type |
| Definition | R4B: |
| Short | R4B: base | surcharge | deduction | discount | tax | informational (new) |
| Comments | Element |
| Control | 1..1 |
| Requirements | Element |
| 22. Extension.extension:priceComponent.extension:type.url | |
| Control | 1..1 |
| Fixed Value | type |
| 24. Extension.extension:priceComponent.extension:type.value[x] | |
| Definition | This code identifies the type of the component. |
| Short | base | surcharge | deduction | discount | tax | informational |
| Control | 1..1 |
| Binding | The codes SHALL be taken from R4BInvoicePriceComponentTypeForR3 (0.1.0) (required to http://hl7.org/fhir/uv/xver/ValueSet/R4B-invoice-priceComponentType-for-R3|0.1.0)Codes indicating the kind of the price component. |
| Type | code |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. Extension.extension:priceComponent.extension:code | |
| Slice Name | code |
| Definition | R4B: |
| Short | R4B: Code identifying the specific component (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 28. Extension.extension:priceComponent.extension:code.url | |
| Control | 1..1 |
| Fixed Value | code |
| 30. Extension.extension:priceComponent.extension:code.value[x] | |
| Definition | A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc. |
| Short | Code identifying the specific component |
| Control | 0..1 |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 32. Extension.extension:priceComponent.extension:factor | |
| Slice Name | factor |
| Definition | R4B: |
| Short | R4B: Factor used for calculating this component (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 34. Extension.extension:priceComponent.extension:factor.url | |
| Control | 1..1 |
| Fixed Value | factor |
| 36. Extension.extension:priceComponent.extension:factor.value[x] | |
| Definition | The factor that has been applied on the base price for calculating this component. |
| Short | Factor used for calculating this component |
| Comments | 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 | decimal |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 38. Extension.extension:priceComponent.extension:amount | |
| Slice Name | amount |
| Definition | R4B: |
| Short | R4B: Monetary amount associated with this component (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 40. Extension.extension:priceComponent.extension:amount.url | |
| Control | 1..1 |
| Fixed Value | amount |
| 42. Extension.extension:priceComponent.extension:amount.value[x] | |
| Definition | The amount calculated for this component. |
| Short | Monetary amount associated with this component |
| Comments | 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 | Money |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 44. Extension.extension:priceComponent.url | |
| Control | 1..1 |
| Fixed Value | priceComponent |
| 46. Extension.extension:priceComponent.value[x] | |
| Control | 0..0 |
| 48. Extension.url | |
| Control | 1..1 |
| Fixed Value | http://hl7.org/fhir/4.3/StructureDefinition/extension-Invoice.lineItem |
| 50. Extension.value[x] | |
| Control | 0..0 |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |
| Definition | R4B: |
| Short | R4B: Line items of this Invoice (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| 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()) |
| 2. Extension.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 4. Extension.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 1..* |
| Type | Extension |
| Slicing | This element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. Extension.extension:sequence | |
| Slice Name | sequence |
| Definition | R4B: |
| Short | R4B: Sequence number of line item (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 8. Extension.extension:sequence.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 10. Extension.extension:sequence.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 | Additional 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 Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 12. Extension.extension:sequence.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | sequence |
| 14. Extension.extension:sequence.value[x] | |
| Definition | Sequence in which the items appear on the invoice. |
| Short | Sequence number of line item |
| Control | 0..1 |
| Type | positiveInt |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. Extension.extension:chargeItem | |
| Slice Name | chargeItem |
| Definition | R4B: |
| Short | R4B: Reference to ChargeItem containing details of this line item or an inline billing code (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension |
| Requirements | Element |
| 18. Extension.extension:chargeItem.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 20. Extension.extension:chargeItem.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 | Additional 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 Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 22. Extension.extension:chargeItem.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | chargeItem |
| 24. Extension.extension:chargeItem.value[x] | |
| Definition | The ChargeItem contains information such as the billing code, date, amount etc. If no further details are required for the lineItem, inline billing codes can be added using the CodeableConcept data type instead of the Reference. |
| Short | Reference to ChargeItem containing details of this line item or an inline billing code |
| Control | 1..1 |
| Type | Choice of: Reference(Cross-version Profile for R4B.ChargeItem for use in FHIR STU3, ChargeItem), CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 26. Extension.extension:priceComponent | |
| Slice Name | priceComponent |
| Definition | R4B: |
| Short | R4B: Components of total line item price (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension |
| Requirements | Element |
| 28. Extension.extension:priceComponent.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 30. Extension.extension:priceComponent.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 1..* |
| Type | Extension |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 32. Extension.extension:priceComponent.extension:type | |
| Slice Name | type |
| Definition | R4B: |
| Short | R4B: base | surcharge | deduction | discount | tax | informational (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension |
| Requirements | Element |
| 34. Extension.extension:priceComponent.extension:type.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 36. Extension.extension:priceComponent.extension:type.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 | Additional 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 Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 38. Extension.extension:priceComponent.extension:type.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | type |
| 40. Extension.extension:priceComponent.extension:type.value[x] | |
| Definition | This code identifies the type of the component. |
| Short | base | surcharge | deduction | discount | tax | informational |
| Control | 1..1 |
| Binding | The codes SHALL be taken from R4BInvoicePriceComponentTypeForR3 (0.1.0) (required to http://hl7.org/fhir/uv/xver/ValueSet/R4B-invoice-priceComponentType-for-R3|0.1.0)Codes indicating the kind of the price component. |
| Type | code |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 42. Extension.extension:priceComponent.extension:code | |
| Slice Name | code |
| Definition | R4B: |
| Short | R4B: Code identifying the specific component (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 44. Extension.extension:priceComponent.extension:code.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 46. Extension.extension:priceComponent.extension:code.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 | Additional 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 Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 48. Extension.extension:priceComponent.extension:code.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | code |
| 50. Extension.extension:priceComponent.extension:code.value[x] | |
| Definition | A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc. |
| Short | Code identifying the specific component |
| Control | 0..1 |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 52. Extension.extension:priceComponent.extension:factor | |
| Slice Name | factor |
| Definition | R4B: |
| Short | R4B: Factor used for calculating this component (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 54. Extension.extension:priceComponent.extension:factor.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 56. Extension.extension:priceComponent.extension:factor.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 | Additional 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 Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 58. Extension.extension:priceComponent.extension:factor.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | factor |
| 60. Extension.extension:priceComponent.extension:factor.value[x] | |
| Definition | The factor that has been applied on the base price for calculating this component. |
| Short | Factor used for calculating this component |
| Comments | 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 | decimal |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 62. Extension.extension:priceComponent.extension:amount | |
| Slice Name | amount |
| Definition | R4B: |
| Short | R4B: Monetary amount associated with this component (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 64. Extension.extension:priceComponent.extension:amount.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 66. Extension.extension:priceComponent.extension:amount.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 | Additional 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 Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 68. Extension.extension:priceComponent.extension:amount.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | amount |
| 70. Extension.extension:priceComponent.extension:amount.value[x] | |
| Definition | The amount calculated for this component. |
| Short | Monetary amount associated with this component |
| Comments | 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 | Money |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 72. Extension.extension:priceComponent.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | priceComponent |
| 74. Extension.extension:priceComponent.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Value of extension |
| Control | 0..0 |
| Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 76. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | http://hl7.org/fhir/4.3/StructureDefinition/extension-Invoice.lineItem |
| 78. Extension.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Value of extension |
| Control | 0..0 |
| Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r4b.r3#0.1.0 based on FHIR 3.0.2. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change