FHIR Extensions Pack
5.1.0 - 5.1.0 (April 2024) International flag

This page is part of the FHIR Core Extensions Registry (v5.1.0: Release 5.1) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Extension: Target path

Official URL: http://hl7.org/fhir/StructureDefinition/targetPath Version: 5.1.0
Standards status: Trial-use Maturity Level: 2 Computable Name: TargetPath
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1670

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.

Context of Use

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

  • Element ID Reference
  • Element ID canonical

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 string: 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.

    Maturity: 2

    This structure is derived from Extension

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

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

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension of type string: 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.

    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 limited FHIRPath)
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/targetPath"
    ... value[x] 1..1 string 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 limited FHIRPath)
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/targetPath"

    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()

    Search Parameters for this Extension

    (none found)