Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). 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: targetElement

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

Summary

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

Version: 5.0.0-ballot

Name: targetElement

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 it's element id.

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 it's element id.

Comment:

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 telement of interest, the extension http://hl7.org/fhir/StructureDefinition/targetPath can be used.

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

Summary

Name	Flags	Card.	Type	Description & Constraints
targetElement		0..*	uri	URL = http://hl7.org/fhir/StructureDefinition/targetElement targetElement: Indicates that the reference has a particular focus in the target resource, a particular element of interest, identified by it's element id. 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/targetElement targetElement: Indicates that the reference has a particular focus in the target resource, a particular element of interest, identified by it's element id. Use on Element ID Reference or Element ID canonical
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/targetElement"
value[x]	1..1	uri	Value of extension
Documentation for this format

XML Template

<!-- targetElement -->

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

JSON Template

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

Summary

Name	Flags	Card.	Type	Description & Constraints
targetElement		0..*	uri	URL = http://hl7.org/fhir/StructureDefinition/targetElement targetElement: Indicates that the reference has a particular focus in the target resource, a particular element of interest, identified by it's element id. 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/targetElement targetElement: Indicates that the reference has a particular focus in the target resource, a particular element of interest, identified by it's element id. Use on Element ID Reference or Element ID canonical
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/targetElement"
value[x]	1..1	uri	Value of extension
Documentation for this format

XML Template

<!-- targetElement -->

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

JSON Template

{ // targetElement
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/targetElement", // R! 
    "valueUri" : "<uri>" // 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