FHIR General Extensions IG
0.1.0 - Working Copy
FHIR General Extensions IG
0.1.0 - Working Copy
This page is part of the FHIR Core Extensions Registry (v0.1.0: Releases Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions 
| Page standards status: Trial-use | Maturity Level: 1 |
Definitions for the targetElement extension.
Guidance on how to interpret the contents of this table can be found here.
| 1. Extension | |
| Definition | Indicates that the reference has a particular focus in the target resource, a particular element of interest, identified by it's element id. Optional Extension Element - found in all resources. |
| Comments | This behaves similar to a '#' element on a URL, but is more wide-open than how '#' is used in Reference.reference where it is limited to pointing only to contained resources (and where the contained resource must be of the appropriate resource type for the reference). This extension allows referring to any Element (not necessarily a resource) within the target resource provided that it has a populated 'id' element. When there is no id on the element of interest, the extension http://hl7.org/fhir/StructureDefinition/targetPath can be used. |
| 2. Extension.extension | |
| Control | 0..0* |
| 3. Extension.url | |
| Fixed Value | http://hl7.org/fhir/StructureDefinition/targetElement |
| 4. Extension.value[x] | |
| Control | 10..1 |
| Type | Choice of: , date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
Guidance on how to interpret the contents of this table can be found here.
| 1. Extension | |
| Definition | Indicates that the reference has a particular focus in the target resource, a particular element of interest, identified by it's element id. Optional Extension Element - found in all resources. |
| Control | 0..* |
| Comments | This behaves similar to a '#' element on a URL, but is more wide-open than how '#' is used in Reference.reference where it is limited to pointing only to contained resources (and where the contained resource must be of the appropriate resource type for the reference). This extension allows referring to any Element (not necessarily a resource) within the target resource provided that it has a populated 'id' element. When there is no id on the element of interest, the extension http://hl7.org/fhir/StructureDefinition/targetPath can be used. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 0..0* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, user content |
| 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. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 3. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 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. |
| Fixed Value | http://hl7.org/fhir/StructureDefinition/targetElement |
| 4. Extension.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Control | 10..1 This element is affected by the following invariants: ext-1 |
| Type | Choice of: uri, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Summary | false |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here.
| 1. Extension | |
| Definition | Indicates that the reference has a particular focus in the target resource, a particular element of interest, identified by it's element id. |
| Control | 0..* |
| Comments | This behaves similar to a '#' element on a URL, but is more wide-open than how '#' is used in Reference.reference where it is limited to pointing only to contained resources (and where the contained resource must be of the appropriate resource type for the reference). This extension allows referring to any Element (not necessarily a resource) within the target resource provided that it has a populated 'id' element. When there is no id on the element of interest, the extension http://hl7.org/fhir/StructureDefinition/targetPath can be used. |
| 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. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 3. Extension.extension | |
| Definition | An Extension |
| Control | 0..0 |
| Type | Extension |
| Summary | false |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 4. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 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. |
| Fixed Value | http://hl7.org/fhir/StructureDefinition/targetElement |
| 5. Extension.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Control | 1..1 This element is affected by the following invariants: ext-1 |
| Type | uri |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Summary | false |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
IG © 2022+ HL7 International / FHIR Infrastructure. Package hl7.fhir.uv.extensions#0.1.0 based on FHIR 5.0.0. Generated 2023-03-04
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change