FHIR Extensions Pack
5.1.0-cibuild - Working Copy International flag

FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This is not an authorized publication; it is the continuous build for version 5.1.0-cibuild. This version is based on the current content of https://github.com/HL7/fhir-extensions/ and changes regularly. See the Directory of published versions

Extension: TargetPath - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 2

Definitions for the targetPath extension.

Guidance on how to interpret the contents of this table can be found here

0. Extension
Definition

icon Changed:

Indicates that the reference has a particular focus in the target resource, a particular element of interest, identified by a FHIRPath statement. The FHIRPath expression is limited to a the simple subset with the additional limitation that .resolve() that is not allowed. This is a more sophisticated mechanism of referring to an element than http://hl7.org/fhir/StructureDefinition/targetElement but does require the system resolving the item to be able to use at least FHIRPath. If the author of the reference has the ability to ensure an id will be present on the target http://hl7.org/fhir/StructureDefinition/targetElement might be more widely useable.

ShortA particular element of interest in the target resource (by limited FHIRPath)
Comments

This extension can be used when the target element has no explicit id associated with it. When there is an id on the telement of interest, the extension http://hl7.org/fhir/StructureDefinition/targetElement can be used since it is much simpler to implement.

Control0..*
2. Extension.extension
Control0..0
4. Extension.url
Fixed Valuehttp://hl7.org/fhir/StructureDefinition/targetPath
6. Extension.value[x]
Control1..?
Typestring, 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, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. Extension
Definition

Indicates that the reference has a particular focus in the target resource, a particular element of interest, identified by a FHIRPath statement. The FHIRPath expression is limited to a the simple subset with the additional limitation that .resolve() that is not allowed. This is a more sophisticated mechanism of referring to an element than http://hl7.org/fhir/StructureDefinition/targetElement but does require the system resolving the item to be able to use at least FHIRPath. If the author of the reference has the ability to ensure an id will be present on the target http://hl7.org/fhir/StructureDefinition/targetElement might be more widely useable.


Optional Extension Element - found in all resources.

ShortA particular element of interest in the target resource (by limited FHIRPath)Optional Extensions Element
Comments

This extension can be used when the target element has no explicit id associated with it. When there is an id on the telement of interest, the extension http://hl7.org/fhir/StructureDefinition/targetElement can be used since it is much simpler to implement.

Control0..*
Is Modifierfalse
Invariantsele-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.

ShortExtensionAdditional 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.

Control0..0*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
4. Extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies 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.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Valuehttp://hl7.org/fhir/StructureDefinition/targetPath
6. Extension.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control10..1
This element is affected by the following invariants: ext-1
Typestring, 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, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-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

0. Extension
Definition

icon Changed:

Indicates that the reference has a particular focus in the target resource, a particular element of interest, identified by a FHIRPath statement. The FHIRPath expression is limited to a the simple subset with the additional limitation that .resolve() that is not allowed. This is a more sophisticated mechanism of referring to an element than http://hl7.org/fhir/StructureDefinition/targetElement but does require the system resolving the item to be able to use at least FHIRPath. If the author of the reference has the ability to ensure an id will be present on the target http://hl7.org/fhir/StructureDefinition/targetElement might be more widely useable.

ShortA particular element of interest in the target resource (by limited FHIRPath)
Comments

This extension can be used when the target element has no explicit id associated with it. When there is an id on the telement of interest, the extension http://hl7.org/fhir/StructureDefinition/targetElement can be used since it is much simpler to implement.

Control0..*
Is Modifierfalse
Invariantsele-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.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typeid
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. Extension.extension
Definition

An Extension

ShortExtension
Control0..0
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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())
SlicingThis element introduces a set of slices on Extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
6. Extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies 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.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Valuehttp://hl7.org/fhir/StructureDefinition/targetPath
8. Extension.value[x]
Definition

icon Changed:

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control1..1
This element is affected by the following invariants: ext-1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))