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-Coverage.costToBeneficiary 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: Patient payments for services/products (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:type | |
| Slice Name | type |
| Definition | R4: |
| Short | R4: Cost category (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Needed to identify the category associated with the amount for the patient. Element |
| 6. Extension.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 |
| 8. Extension.extension:type.value[x] | |
| Definition | The category of patient centric costs associated with treatment. 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 | Cost categoryValue of extension |
| Comments | For example visit, specialist visits, emergency, inpatient care, etc. |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from For codes, see R4CoverageCopayTypeForR3 (0.1.0) (extensible to http://hl7.org/fhir/uv/xver/ValueSet/R4-coverage-copay-type-for-R3|0.1.0)The types of services to which patient copayments are specified. |
| 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:value | |
| Slice Name | value |
| Definition | R4: |
| Short | R4: The amount or percentage due from the beneficiary (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 10..1* |
| Type | Extension |
| Requirements | Needed to identify the amount for the patient associated with the category. Element |
| 12. Extension.extension:value.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 | value |
| 14. Extension.extension:value.value[x] | |
| Definition | The amount due from the patient for the cost 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 | The amount or percentage due from the beneficiaryValue of extension |
| Comments | Amount may be expressed as a percentage of the service/product cost or a fixed amount of currency. |
| Control | 10..1 |
| Type | Choice of: Quantity(SimpleQuantity), 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, 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.extension:exception | |
| Slice Name | exception |
| Definition | R4: |
| Short | R4: Exceptions for patient payments (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..* |
| Type | Extension |
| Requirements | Required by providers to manage financial transaction with the patient. Element |
| 18. Extension.extension:exception.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:exception.extension:type | |
| Slice Name | type |
| Definition | R4: |
| Short | R4: Exception category (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 10..1* |
| Type | Extension |
| Requirements | Needed to identify the exception associated with the amount for the patient. Element |
| 22. Extension.extension:exception.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:exception.extension:type.value[x] | |
| Definition | The code for the specific exception. 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 | Exception categoryValue of extension |
| Control | 10..1 |
| Binding | For example codes, see For codes, see R4CoverageFinancialExceptionForR3 (0.1.0) (example to http://hl7.org/fhir/uv/xver/ValueSet/R4-coverage-financial-exception-for-R3|0.1.0)The types of exceptions from the part or full value of financial obligations such as copays. |
| 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] |
| 26. Extension.extension:exception.extension:period | |
| Slice Name | period |
| Definition | R4: |
| Short | R4: The effective period of the exception (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Needed to identify the applicable timeframe for the exception for the correct calculation of patient costs. Element |
| 28. Extension.extension:exception.extension:period.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 | period |
| 30. Extension.extension:exception.extension:period.value[x] | |
| Definition | The timeframe during when the exception is in force. 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 | The effective period of the exceptionValue of extension |
| Control | 0..1 |
| Type | Period, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, 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] |
| 32. Extension.extension:exception.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 | exception |
| 34. Extension.extension:exception.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 |
| 36. 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-Coverage.costToBeneficiary |
| 38. 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: Patient payments for services/products (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:type | |
| Slice Name | type |
| Definition | R4: |
| Short | R4: Cost category (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Needed to identify the category associated with the amount for the patient. Element |
| 6. Extension.extension:type.url | |
| Control | 1..1 |
| Fixed Value | type |
| 8. Extension.extension:type.value[x] | |
| Definition | The category of patient centric costs associated with treatment. |
| Short | Cost category |
| Comments | For example visit, specialist visits, emergency, inpatient care, etc. |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from R4CoverageCopayTypeForR3 (0.1.0) (extensible to http://hl7.org/fhir/uv/xver/ValueSet/R4-coverage-copay-type-for-R3|0.1.0)The types of services to which patient copayments are specified. |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 10. Extension.extension:value | |
| Slice Name | value |
| Definition | R4: |
| Short | R4: The amount or percentage due from the beneficiary (new) |
| Comments | Element |
| Control | 1..1 |
| Requirements | Needed to identify the amount for the patient associated with the category. Element |
| 12. Extension.extension:value.url | |
| Control | 1..1 |
| Fixed Value | value |
| 14. Extension.extension:value.value[x] | |
| Definition | The amount due from the patient for the cost category. |
| Short | The amount or percentage due from the beneficiary |
| Comments | Amount may be expressed as a percentage of the service/product cost or a fixed amount of currency. |
| Control | 1..1 |
| Type | Choice of: Quantity(SimpleQuantity), Money |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 16. Extension.extension:exception | |
| Slice Name | exception |
| Definition | R4: |
| Short | R4: Exceptions for patient payments (new) |
| Comments | Element |
| Control | 0..* |
| Requirements | Required by providers to manage financial transaction with the patient. Element |
| 18. Extension.extension:exception.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:exception.extension:type | |
| Slice Name | type |
| Definition | R4: |
| Short | R4: Exception category (new) |
| Comments | Element |
| Control | 1..1 |
| Requirements | Needed to identify the exception associated with the amount for the patient. Element |
| 22. Extension.extension:exception.extension:type.url | |
| Control | 1..1 |
| Fixed Value | type |
| 24. Extension.extension:exception.extension:type.value[x] | |
| Definition | The code for the specific exception. |
| Short | Exception category |
| Control | 1..1 |
| Binding | For example codes, see R4CoverageFinancialExceptionForR3 (0.1.0) (example to http://hl7.org/fhir/uv/xver/ValueSet/R4-coverage-financial-exception-for-R3|0.1.0)The types of exceptions from the part or full value of financial obligations such as copays. |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 26. Extension.extension:exception.extension:period | |
| Slice Name | period |
| Definition | R4: |
| Short | R4: The effective period of the exception (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Needed to identify the applicable timeframe for the exception for the correct calculation of patient costs. Element |
| 28. Extension.extension:exception.extension:period.url | |
| Control | 1..1 |
| Fixed Value | period |
| 30. Extension.extension:exception.extension:period.value[x] | |
| Definition | The timeframe during when the exception is in force. |
| Short | The effective period of the exception |
| Control | 0..1 |
| Type | Period |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 32. Extension.extension:exception.url | |
| Control | 1..1 |
| Fixed Value | exception |
| 34. Extension.extension:exception.value[x] | |
| Control | 0..0 |
| 36. Extension.url | |
| Control | 1..1 |
| Fixed Value | http://hl7.org/fhir/4.0/StructureDefinition/extension-Coverage.costToBeneficiary |
| 38. 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: Patient payments for services/products (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:type | |
| Slice Name | type |
| Definition | R4: |
| Short | R4: Cost category (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Needed to identify the category associated with the amount for the patient. Element |
| 8. Extension.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. |
| 10. Extension.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. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 12. Extension.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 |
| 14. Extension.extension:type.value[x] | |
| Definition | The category of patient centric costs associated with treatment. |
| Short | Cost category |
| Comments | For example visit, specialist visits, emergency, inpatient care, etc. |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from R4CoverageCopayTypeForR3 (0.1.0) (extensible to http://hl7.org/fhir/uv/xver/ValueSet/R4-coverage-copay-type-for-R3|0.1.0)The types of services to which patient copayments are specified. |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 16. Extension.extension:value | |
| Slice Name | value |
| Definition | R4: |
| Short | R4: The amount or percentage due from the beneficiary (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension |
| Requirements | Needed to identify the amount for the patient associated with the category. Element |
| 18. Extension.extension:value.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:value.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:value.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 | value |
| 24. Extension.extension:value.value[x] | |
| Definition | The amount due from the patient for the cost category. |
| Short | The amount or percentage due from the beneficiary |
| Comments | Amount may be expressed as a percentage of the service/product cost or a fixed amount of currency. |
| Control | 1..1 |
| Type | Choice of: Quantity(SimpleQuantity), Money |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 26. Extension.extension:exception | |
| Slice Name | exception |
| Definition | R4: |
| Short | R4: Exceptions for patient payments (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension |
| Requirements | Required by providers to manage financial transaction with the patient. Element |
| 28. Extension.extension:exception.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:exception.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:exception.extension:type | |
| Slice Name | type |
| Definition | R4: |
| Short | R4: Exception category (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension |
| Requirements | Needed to identify the exception associated with the amount for the patient. Element |
| 34. Extension.extension:exception.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:exception.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:exception.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:exception.extension:type.value[x] | |
| Definition | The code for the specific exception. |
| Short | Exception category |
| Control | 1..1 |
| Binding | For example codes, see R4CoverageFinancialExceptionForR3 (0.1.0) (example to http://hl7.org/fhir/uv/xver/ValueSet/R4-coverage-financial-exception-for-R3|0.1.0)The types of exceptions from the part or full value of financial obligations such as copays. |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 42. Extension.extension:exception.extension:period | |
| Slice Name | period |
| Definition | R4: |
| Short | R4: The effective period of the exception (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Needed to identify the applicable timeframe for the exception for the correct calculation of patient costs. Element |
| 44. Extension.extension:exception.extension:period.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:exception.extension:period.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:exception.extension:period.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 | period |
| 50. Extension.extension:exception.extension:period.value[x] | |
| Definition | The timeframe during when the exception is in force. |
| Short | The effective period of the exception |
| Control | 0..1 |
| Type | Period |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 52. Extension.extension:exception.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 | exception |
| 54. Extension.extension:exception.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 |
| 56. 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-Coverage.costToBeneficiary |
| 58. 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