FHIR Extensions Pack
5.2.0-ballot - 5.2.0 Ballot - September 2024) International flag

FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 5.2.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. 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: Target element

Official URL: http://hl7.org/fhir/StructureDefinition/targetElement Version: 5.2.0-ballot
Standards status: Trial-use Maturity Level: 2 Computable Name: TargetElement
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1634

Indicates that the reference has a particular focus in the target resource, a particular element of interest, identified by its element id. This extension requires that an 'id' property be present on the element to be referenced, but does not require the use of simplified FHIRPath. If the creator of the reference can't ensure an id will be present, the [[[http://hl7.org/fhir/StructureDefinition/targetPath]]] extension can be used instead.

Context of Use

This extension may be used on the following element(s):

Usage info

Usage:

Changes since version 1.0.0:

  • The resource metadata has changed (description)
  • The data elements list has changed
  • One or more text definitions, invariants or bindings have changed

    • Formal Views of Extension Content

    Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

    This structure is derived from Extension

    Summary

    Simple Extension of type uri: Indicates that the reference has a particular focus in the target resource, a particular element of interest, identified by its element id. This extension requires that an 'id' property be present on the element to be referenced, but does not require the use of simplified FHIRPath. If the creator of the reference can't ensure an id will be present, the Target path extension can be used instead.

    Maturity: 2

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension A particular element of interest in the target resource (by id)
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/targetElement"
    ... value[x] 1..1 uri Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension A particular element of interest in the target resource (by id)
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/targetElement"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension of type uri: Indicates that the reference has a particular focus in the target resource, a particular element of interest, identified by its element id. This extension requires that an 'id' property be present on the element to be referenced, but does not require the use of simplified FHIRPath. If the creator of the reference can't ensure an id will be present, the Target path extension can be used instead.

    Maturity: 2

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension A particular element of interest in the target resource (by id)
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/targetElement"
    ... value[x] 1..1 uri Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension A particular element of interest in the target resource (by id)
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/targetElement"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    R4B

    The extension is unchanged in R4B

    R4

    The extension is unchanged in R4

    R3

    The extension is represented a little differently in R3:

    • Remove the extension context canonical
    • Note: Extensions that have been modified for R3 are still draft while real-world experience is collected
    Name Flags Card. Type Description & Constraints doco
    . . Extension 0..* Extension A particular element of interest in the target resource (by id)
    . . . extension 0 .. 0
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/targetElement"
    . . . value[x] 1.. 1 uri Value of extension

    doco Documentation for this format

    Search Parameters for this Extension

    (none found)