Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the ext-R5-GraphDefinition.lin.compartment extension.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |
| Definition | R5: Optional Extension Element - found in all resources. |
| Short | R5: Compartment Consistency Rules (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 | 30..* |
| 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:use | |
| Slice Name | use |
| Definition | R5: |
| Short | R5: where | requires (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 10..1* |
| Type | Extension |
| Requirements | Element |
| 6. Extension.extension:use.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 | use |
| 8. Extension.extension:use.value[x] | |
| Definition | Defines how the compartment rule is used - whether it it is used to test whether resources are subject to the rule, or whether it is a rule that must be followed. 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 | where | requiresValue of extension |
| Comments | All conditional rules are evaluated; if they are true, then the rules are evaluated. |
| Control | 10..1 |
| Binding | The codes SHALL be taken from For codes, see R5GraphCompartmentUseForR3 (0.1.0) (required to http://hl7.org/fhir/uv/xver/ValueSet/R5-graph-compartment-use-for-R3|0.1.0) |
| 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 |
| 10. Extension.extension:rule | |
| Slice Name | rule |
| Definition | R5: |
| Short | R5: identical | matching | different | custom (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 10..1* |
| Type | Extension |
| Requirements | Element |
| 12. Extension.extension:rule.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 | rule |
| 14. Extension.extension:rule.value[x] | |
| Definition | identical | matching | different | no-rule | custom. 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 | identical | matching | different | customValue of extension |
| Control | 10..1 |
| Binding | The codes SHALL be taken from For codes, see GraphCompartmentRule (required to http://hl7.org/fhir/ValueSet/graph-compartment-rule|3.0.2) |
| 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 |
| 16. Extension.extension:code | |
| Slice Name | code |
| Definition | R5: |
| Short | R5: Patient | Encounter | RelatedPerson | Practitioner | Device | EpisodeOfCare (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 10..1* |
| Type | Extension |
| Requirements | Element |
| 18. Extension.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 |
| 20. Extension.extension:code.value[x] | |
| Definition | Identifies the compartment. 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 | Patient | Encounter | RelatedPerson | Practitioner | Device | EpisodeOfCareValue of extension |
| Control | 10..1 |
| Binding | The codes SHALL be taken from For codes, see R5CompartmentTypeForR3 (0.1.0) (required to http://hl7.org/fhir/uv/xver/ValueSet/R5-compartment-type-for-R3|0.1.0) |
| 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 |
| 22. Extension.extension:expression | |
| Slice Name | expression |
| Definition | R5: |
| Short | R5: Custom rule, as a FHIRPath expression (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 24. Extension.extension:expression.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 | expression |
| 26. Extension.extension:expression.value[x] | |
| Definition | Custom rule, as a FHIRPath expression. 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 | Custom rule, as a FHIRPath expressionValue of extension |
| Control | 0..1 |
| Type | string, date, dateTime, Meta, code, 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 |
| 28. Extension.extension:description | |
| Slice Name | description |
| Definition | R5: |
| Short | R5: Documentation for FHIRPath expression (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 30. Extension.extension:description.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 | description |
| 32. Extension.extension:description.value[x] | |
| Definition | Documentation for FHIRPath expression. 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 | Documentation for FHIRPath expressionValue of extension |
| Control | 0..1 |
| Type | string, date, dateTime, Meta, code, 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 |
| 34. 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/5.0/StructureDefinition/extension-GraphDefinition.link.compartment |
| 36. 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 | R5: |
| Short | R5: Compartment Consistency Rules (new) |
| Comments | Element |
| Control | 0..* |
| Is Modifier | false |
| 2. Extension.extension | |
| Control | 3..* |
| 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:use | |
| Slice Name | use |
| Definition | R5: |
| Short | R5: where | requires (new) |
| Comments | Element |
| Control | 1..1 |
| Requirements | Element |
| 6. Extension.extension:use.url | |
| Control | 1..1 |
| Fixed Value | use |
| 8. Extension.extension:use.value[x] | |
| Definition | Defines how the compartment rule is used - whether it it is used to test whether resources are subject to the rule, or whether it is a rule that must be followed. |
| Short | where | requires |
| Comments | All conditional rules are evaluated; if they are true, then the rules are evaluated. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from R5GraphCompartmentUseForR3 (0.1.0) (required to http://hl7.org/fhir/uv/xver/ValueSet/R5-graph-compartment-use-for-R3|0.1.0) |
| 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 |
| 10. Extension.extension:rule | |
| Slice Name | rule |
| Definition | R5: |
| Short | R5: identical | matching | different | custom (new) |
| Comments | Element |
| Control | 1..1 |
| Requirements | Element |
| 12. Extension.extension:rule.url | |
| Control | 1..1 |
| Fixed Value | rule |
| 14. Extension.extension:rule.value[x] | |
| Definition | identical | matching | different | no-rule | custom. |
| Short | identical | matching | different | custom |
| Control | 1..1 |
| Binding | The codes SHALL be taken from GraphCompartmentRule (required to http://hl7.org/fhir/ValueSet/graph-compartment-rule|3.0.2) |
| 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 |
| 16. Extension.extension:code | |
| Slice Name | code |
| Definition | R5: |
| Short | R5: Patient | Encounter | RelatedPerson | Practitioner | Device | EpisodeOfCare (new) |
| Comments | Element |
| Control | 1..1 |
| Requirements | Element |
| 18. Extension.extension:code.url | |
| Control | 1..1 |
| Fixed Value | code |
| 20. Extension.extension:code.value[x] | |
| Definition | Identifies the compartment. |
| Short | Patient | Encounter | RelatedPerson | Practitioner | Device | EpisodeOfCare |
| Control | 1..1 |
| Binding | The codes SHALL be taken from R5CompartmentTypeForR3 (0.1.0) (required to http://hl7.org/fhir/uv/xver/ValueSet/R5-compartment-type-for-R3|0.1.0) |
| 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 |
| 22. Extension.extension:expression | |
| Slice Name | expression |
| Definition | R5: |
| Short | R5: Custom rule, as a FHIRPath expression (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 24. Extension.extension:expression.url | |
| Control | 1..1 |
| Fixed Value | expression |
| 26. Extension.extension:expression.value[x] | |
| Definition | Custom rule, as a FHIRPath expression. |
| Short | Custom rule, as a FHIRPath expression |
| Control | 0..1 |
| Type | string |
| [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 |
| 28. Extension.extension:description | |
| Slice Name | description |
| Definition | R5: |
| Short | R5: Documentation for FHIRPath expression (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 30. Extension.extension:description.url | |
| Control | 1..1 |
| Fixed Value | description |
| 32. Extension.extension:description.value[x] | |
| Definition | Documentation for FHIRPath expression. |
| Short | Documentation for FHIRPath expression |
| Control | 0..1 |
| Type | string |
| [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 |
| 34. Extension.url | |
| Control | 1..1 |
| Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-GraphDefinition.link.compartment |
| 36. Extension.value[x] | |
| Control | 0..0 |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |
| Definition | R5: |
| Short | R5: Compartment Consistency Rules (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 | 3..* |
| 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:use | |
| Slice Name | use |
| Definition | R5: |
| Short | R5: where | requires (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension |
| Requirements | Element |
| 8. Extension.extension:use.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:use.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:use.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 | use |
| 14. Extension.extension:use.value[x] | |
| Definition | Defines how the compartment rule is used - whether it it is used to test whether resources are subject to the rule, or whether it is a rule that must be followed. |
| Short | where | requires |
| Comments | All conditional rules are evaluated; if they are true, then the rules are evaluated. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from R5GraphCompartmentUseForR3 (0.1.0) (required to http://hl7.org/fhir/uv/xver/ValueSet/R5-graph-compartment-use-for-R3|0.1.0) |
| 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 |
| 16. Extension.extension:rule | |
| Slice Name | rule |
| Definition | R5: |
| Short | R5: identical | matching | different | custom (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension |
| Requirements | Element |
| 18. Extension.extension:rule.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:rule.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:rule.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 | rule |
| 24. Extension.extension:rule.value[x] | |
| Definition | identical | matching | different | no-rule | custom. |
| Short | identical | matching | different | custom |
| Control | 1..1 |
| Binding | The codes SHALL be taken from GraphCompartmentRule (required to http://hl7.org/fhir/ValueSet/graph-compartment-rule|3.0.2) |
| 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:code | |
| Slice Name | code |
| Definition | R5: |
| Short | R5: Patient | Encounter | RelatedPerson | Practitioner | Device | EpisodeOfCare (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension |
| Requirements | Element |
| 28. Extension.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. |
| 30. Extension.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. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 32. Extension.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 |
| 34. Extension.extension:code.value[x] | |
| Definition | Identifies the compartment. |
| Short | Patient | Encounter | RelatedPerson | Practitioner | Device | EpisodeOfCare |
| Control | 1..1 |
| Binding | The codes SHALL be taken from R5CompartmentTypeForR3 (0.1.0) (required to http://hl7.org/fhir/uv/xver/ValueSet/R5-compartment-type-for-R3|0.1.0) |
| 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 |
| 36. Extension.extension:expression | |
| Slice Name | expression |
| Definition | R5: |
| Short | R5: Custom rule, as a FHIRPath expression (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 38. Extension.extension:expression.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. |
| 40. Extension.extension:expression.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: |
| 42. Extension.extension:expression.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 | expression |
| 44. Extension.extension:expression.value[x] | |
| Definition | Custom rule, as a FHIRPath expression. |
| Short | Custom rule, as a FHIRPath expression |
| Control | 0..1 |
| Type | string |
| [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 |
| 46. Extension.extension:description | |
| Slice Name | description |
| Definition | R5: |
| Short | R5: Documentation for FHIRPath expression (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 48. Extension.extension:description.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. |
| 50. Extension.extension:description.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: |
| 52. Extension.extension:description.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 | description |
| 54. Extension.extension:description.value[x] | |
| Definition | Documentation for FHIRPath expression. |
| Short | Documentation for FHIRPath expression |
| Control | 0..1 |
| Type | string |
| [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 |
| 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/5.0/StructureDefinition/extension-GraphDefinition.link.compartment |
| 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-r5.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