Extensions for Using Data Elements from FHIR R4 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R4 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R4 in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the ext-R4-ExplanationOfBenefit.total extension.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |
| Definition | R4: Optional Extension Element - found in all resources. |
| Short | R4: Adjudication totals (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 | 20..* |
| 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:category | |
| Slice Name | category |
| Definition | R4: |
| Short | R4: Type of adjudication information (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 10..1* |
| Type | Extension |
| Requirements | Needed to convey the type of total provided. Element |
| 6. Extension.extension:category.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 | category |
| 8. Extension.extension:category.value[x] | |
| Definition | A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item. 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 | Type of adjudication informationValue of extension |
| Comments | For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc. |
| Control | 10..1 |
| Binding | For example codes, see For codes, see http://hl7.org/fhir/uv/xver/ValueSet/R4-adjudication-for-R3 (example to http://hl7.org/fhir/uv/xver/ValueSet/R4-adjudication-for-R3)The adjudication codes. |
| 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] |
| 10. Extension.extension:amount | |
| Slice Name | amount |
| Definition | R4: |
| Short | R4: Financial total for the categoryAdditional Content defined by implementations |
| Comments | Element |
| Control | 10..1* |
| Type | Extension |
| Requirements | Needed to convey the total monetary amount. Element |
| 12. Extension.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 |
| 14. Extension.extension:amount.value[x] | |
| Definition | Monetary total amount associated with the category. 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 | Financial total for the categoryValue of extension |
| Control | 10..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] |
| 16. 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.0/StructureDefinition/extension-ExplanationOfBenefit.total |
| 18. 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 | R4: |
| Short | R4: Adjudication totals (new) |
| Comments | Element |
| Control | 0..* |
| Is Modifier | false |
| 2. Extension.extension | |
| Control | 2..* |
| 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:category | |
| Slice Name | category |
| Definition | R4: |
| Short | R4: Type of adjudication information (new) |
| Comments | Element |
| Control | 1..1 |
| Requirements | Needed to convey the type of total provided. Element |
| 6. Extension.extension:category.url | |
| Control | 1..1 |
| Fixed Value | category |
| 8. Extension.extension:category.value[x] | |
| Definition | A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item. |
| Short | Type of adjudication information |
| Comments | For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc. |
| Control | 1..1 |
| Binding | For example codes, see http://hl7.org/fhir/uv/xver/ValueSet/R4-adjudication-for-R3 (example to http://hl7.org/fhir/uv/xver/ValueSet/R4-adjudication-for-R3)The adjudication codes. |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 10. Extension.extension:amount | |
| Slice Name | amount |
| Definition | R4: |
| Short | R4: Financial total for the category |
| Comments | Element |
| Control | 1..1 |
| Requirements | Needed to convey the total monetary amount. Element |
| 12. Extension.extension:amount.url | |
| Control | 1..1 |
| Fixed Value | amount |
| 14. Extension.extension:amount.value[x] | |
| Definition | Monetary total amount associated with the category. |
| Short | Financial total for the category |
| Control | 1..1 |
| Type | Money |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 16. Extension.url | |
| Control | 1..1 |
| Fixed Value | http://hl7.org/fhir/4.0/StructureDefinition/extension-ExplanationOfBenefit.total |
| 18. Extension.value[x] | |
| Control | 0..0 |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |
| Definition | R4: |
| Short | R4: Adjudication totals (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 | 2..* |
| 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:category | |
| Slice Name | category |
| Definition | R4: |
| Short | R4: Type of adjudication information (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension |
| Requirements | Needed to convey the type of total provided. Element |
| 8. Extension.extension:category.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:category.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:category.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 | category |
| 14. Extension.extension:category.value[x] | |
| Definition | A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item. |
| Short | Type of adjudication information |
| Comments | For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc. |
| Control | 1..1 |
| Binding | For example codes, see http://hl7.org/fhir/uv/xver/ValueSet/R4-adjudication-for-R3 (example to http://hl7.org/fhir/uv/xver/ValueSet/R4-adjudication-for-R3)The adjudication codes. |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 16. Extension.extension:amount | |
| Slice Name | amount |
| Definition | R4: |
| Short | R4: Financial total for the category |
| Comments | Element |
| Control | 1..1 |
| Type | Extension |
| Requirements | Needed to convey the total monetary amount. Element |
| 18. Extension.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. |
| 20. Extension.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. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 22. Extension.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 |
| 24. Extension.extension:amount.value[x] | |
| Definition | Monetary total amount associated with the category. |
| Short | Financial total for the category |
| Control | 1..1 |
| Type | Money |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 26. 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.0/StructureDefinition/extension-ExplanationOfBenefit.total |
| 28. 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-r4.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