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: DerivationReference

FHIR Infrastructure Work Group

Maturity Level: 0

Informative

Use Context: Any

Summary

Defining URL: http://hl7.org/fhir/StructureDefinition/derivation-reference

Version: 5.0.0-ballot

Name: DerivationReference

Title: Derivation Reference

Modifier: This extension is not a modifier extension

Status: draft

Definition: References a location within a set of source text from which the discrete information described by this Resource/Element was extracted.

Committee: FHIR Infrastructure Work Group

Status: draft. Extension maintained by: HL7

References a location within a set of source text from which the discrete information described by this Resource/Element was extracted.

Context of Use: Use on Element ID Resource or Element ID Element

Summary

Name	Card.	Type	Description & Constraints
DerivationReference	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/derivation-reference DerivationReference: References a location within a set of source text from which the discrete information described by this Resource/Element was extracted. Use on Element ID Resource or Element ID Element
reference	0..1	Reference()	Source reference.
path	0..1	string	Element containing text.
offset	0..1	integer	Starting position.
length	0..1	integer	Number of characters.
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/derivation-reference DerivationReference: References a location within a set of source text from which the discrete information described by this Resource/Element was extracted. Use on Element ID Resource or Element ID Element
Slices for extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:reference	0..1	Extension	Source reference.
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"reference"
value[x]	1..1	Reference()	Value of extension
extension:path	0..1	Extension	Element containing text.
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"path"
value[x]	1..1	string	Value of extension
extension:offset	0..1	Extension	Starting position.
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"offset"
value[x]	1..1	integer	Value of extension
extension:length	0..1	Extension	Number of characters.
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"length"
value[x]	1..1	integer	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/derivation-reference"
value[x]	0..0
Documentation for this format

XML Template

<!-- DerivationReference -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/derivation-reference" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="reference"> I 0..1 Extension  <!-- I 0..1 Source reference. -->
  <valueReference><!-- I 1..1 Reference Value of extension --></valueReference>
 </extension>
 <extension url="path"> I 0..1 Extension  <!-- I 0..1 Element containing text. -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="offset"> I 0..1 Extension  <!-- I 0..1 Starting position. -->
  <valueInteger value="[integer]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="length"> I 0..1 Extension  <!-- I 0..1 Number of characters. -->
  <valueInteger value="[integer]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // DerivationReference
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Source reference. // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "reference", // R! 
        "valueReference" : { Reference } // I R! Value of extension
      },
      { // Element containing text. // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "path", // R! 
        "valueString" : "<string>" // I R! Value of extension
      },
      { // Starting position. // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "offset", // R! 
        "valueInteger" : <integer> // I R! Value of extension
      },
      { // Number of characters. // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "length", // R! 
        "valueInteger" : <integer> // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // ISource reference.
    "extension" : { Extension }, // IElement containing text.
    "extension" : { Extension }, // IStarting position.
    "extension" : { Extension }, // INumber of characters.
    "url" : "http://hl7.org/fhir/StructureDefinition/derivation-reference" // R! 
  // value[x]: Value of extension: Prohibited
  }

Summary

Name	Card.	Type	Description & Constraints
DerivationReference	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/derivation-reference DerivationReference: References a location within a set of source text from which the discrete information described by this Resource/Element was extracted. Use on Element ID Resource or Element ID Element
reference	0..1	Reference()	Source reference.
path	0..1	string	Element containing text.
offset	0..1	integer	Starting position.
length	0..1	integer	Number of characters.
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/derivation-reference DerivationReference: References a location within a set of source text from which the discrete information described by this Resource/Element was extracted. Use on Element ID Resource or Element ID Element
Slices for extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:reference	0..1	Extension	Source reference.
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"reference"
value[x]	1..1	Reference()	Value of extension
extension:path	0..1	Extension	Element containing text.
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"path"
value[x]	1..1	string	Value of extension
extension:offset	0..1	Extension	Starting position.
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"offset"
value[x]	1..1	integer	Value of extension
extension:length	0..1	Extension	Number of characters.
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"length"
value[x]	1..1	integer	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/derivation-reference"
value[x]	0..0
Documentation for this format

XML Template

<!-- DerivationReference -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/derivation-reference" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="reference"> I 0..1 Extension  <!-- I 0..1 Source reference. -->
  <valueReference><!-- I 1..1 Reference Value of extension --></valueReference>
 </extension>
 <extension url="path"> I 0..1 Extension  <!-- I 0..1 Element containing text. -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="offset"> I 0..1 Extension  <!-- I 0..1 Starting position. -->
  <valueInteger value="[integer]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="length"> I 0..1 Extension  <!-- I 0..1 Number of characters. -->
  <valueInteger value="[integer]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // DerivationReference
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Source reference. // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "reference", // R! 
        "valueReference" : { Reference } // I R! Value of extension
      },
      { // Element containing text. // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "path", // R! 
        "valueString" : "<string>" // I R! Value of extension
      },
      { // Starting position. // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "offset", // R! 
        "valueInteger" : <integer> // I R! Value of extension
      },
      { // Number of characters. // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "length", // R! 
        "valueInteger" : <integer> // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // ISource reference.
    "extension" : { Extension }, // IElement containing text.
    "extension" : { Extension }, // IStarting position.
    "extension" : { Extension }, // INumber of characters.
    "url" : "http://hl7.org/fhir/StructureDefinition/derivation-reference" // R! 
  // value[x]: Value of extension: Prohibited
  }

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')]))
der-1: Cannot have length if offset is missing. (xpath: todo-remove-this-line-when-build-process-allows-that)
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.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.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
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.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
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.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
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.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
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

No examples found.