Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Extension: targetPath

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

Summary

Defining URL: http://hl7.org/fhir/StructureDefinition/targetPath

Version: 5.0.0-ballot

Name: targetPath

Title: null

Modifier: This extension is not a modifier extension

Status: draft

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](fhirpath.html#simple) with the additional limitation that .resolve() that is not allowed.

Committee: FHIR Infrastructure Work Group

Status: draft. Extension maintained by: Health Level Seven, Inc. - FHIR Core WG

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.

Comment:

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/targetPath can be used since it is much simpler to implement.

Context of Use: Use on Element ID Reference or Element ID canonical

Summary

Name	Flags	Card.	Type	Description & Constraints
targetPath		0..*	string	URL = http://hl7.org/fhir/StructureDefinition/targetPath targetPath: 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. Use on Element ID Reference or Element ID canonical
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/targetPath targetPath: 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. Use on Element ID Reference or Element ID canonical
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/targetPath"
value[x]	1..1	string	Value of extension
Documentation for this format

XML Template

<!-- targetPath -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/targetPath" >
  <!-- from Element: extension -->
 <valueString value="[string]"/><!-- I 1..1 Value of extension -->
</extension>

JSON Template

{ // targetPath
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/targetPath", // R! 
    "valueString" : "<string>" // I R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
targetPath		0..*	string	URL = http://hl7.org/fhir/StructureDefinition/targetPath targetPath: 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. Use on Element ID Reference or Element ID canonical
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/targetPath targetPath: 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. Use on Element ID Reference or Element ID canonical
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/targetPath"
value[x]	1..1	string	Value of extension
Documentation for this format

XML Template

<!-- targetPath -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/targetPath" >
  <!-- from Element: extension -->
 <valueString value="[string]"/><!-- I 1..1 Value of extension -->
</extension>

JSON Template

{ // targetPath
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/targetPath", // R! 
    "valueString" : "<string>" // I R! Value of extension
  }

Constraints

ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)

Search

No Search Extensions defined for this resource

Examples of this extension

Targetted #3: Provenance/example3