Release 5 Draft Ballot

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

Extension: DerivationReference

FHIR Infrastructure Work Group Maturity Level: 0InformativeUse Context: Any

URL for this extension:

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

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

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. DerivationReference0..*ExtensionURL = 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
... reference0..1Reference()References a location within a set of source text from which the discrete information described by this Resource/Element was extracted.

... path0..1stringCorresponds to the element within the resource containing the text.

... offset0..1integerIndicates the starting position (as a count of characters) within the text where the relevant derivation began.


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = 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..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:reference 0..1ExtensionSource reference.
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"reference"
.... value[x] 1..1Reference()Value of extension
... extension:path 0..1ExtensionElement containing text.
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"path"
.... value[x] 1..1stringValue of extension
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"offset"
.... value[x] 1..1integerValue of extension
... extension:length 0..1ExtensionNumber of characters.
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"length"
.... value[x] 1..1integerValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/derivation-reference"
... value[x] 0..0
.... valueBase64Binarybase64Binary
.... valueBooleanboolean
.... valueCanonicalcanonical(Any)
.... valueCodecode
.... valueDatedate
.... valueDateTimedateTime
.... valueDecimaldecimal
.... valueIdid
.... valueInstantinstant
.... valueIntegerinteger
.... valueInteger64integer64
.... valueMarkdownmarkdown
.... valueOidoid
.... valuePositiveIntpositiveInt
.... valueStringstring
.... valueTimetime
.... valueUnsignedIntunsignedInt
.... valueUriuri
.... valueUrlurl
.... valueUuiduuid
.... valueAddressAddress
.... valueAgeAge
.... valueAnnotationAnnotation
.... valueAttachmentAttachment
.... valueCodeableConceptCodeableConcept
.... valueCodeableReferenceCodeableReference
.... valueCodingCoding
.... valueContactPointContactPoint
.... valueCountCount
.... valueDistanceDistance
.... valueDurationDuration
.... valueHumanNameHumanName
.... valueIdentifierIdentifier
.... valueMoneyMoney
.... valuePeriodPeriod
.... valueQuantityQuantity
.... valueRangeRange
.... valueRatioRatio
.... valueRatioRangeRatioRange
.... valueReferenceReference(Any)
.... valueSampledDataSampledData
.... valueSignatureSignature
.... valueTimingTiming
.... valueContactDetailContactDetail
.... valueContributorContributor
.... valueDataRequirementDataRequirement
.... valueExpressionExpression
.... valueParameterDefinitionParameterDefinition
.... valueRelatedArtifactRelatedArtifact
.... valueTriggerDefinitionTriggerDefinition
.... valueUsageContextUsageContext
.... valueDosageDosage
.... valueMetaMeta

doco Documentation for this format

XML Template

<!-- DerivationReference -->doco

<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"> ?? 0..1 Extension  <!-- ?? 0..1 Source reference. -->
  <valueReference><!-- ?? 1..1 Reference Value of extension --></valueReference>
 </extension>
 <extension url="path"> ?? 0..1 Extension  <!-- ?? 0..1 Element containing text. -->
  <valueString value="[string]"/><!-- ?? 1..1 Value of extension -->
 </extension>
 <extension url="offset"> ?? 0..1 Extension  <!-- ?? 0..1 Starting position. -->
  <valueInteger value="[integer]"/><!-- ?? 1..1 Value of extension -->
 </extension>
 <extension url="length"> ?? 0..1 Extension  <!-- ?? 0..1 Number of characters. -->
  <valueInteger value="[integer]"/><!-- ?? 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // DerivationReference
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Source reference. // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "reference", // R! 
        "valueReference" : { Reference } // C? R! Value of extension
      },
      { // Element containing text. // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "path", // R! 
        "valueString" : "<string>" // C? R! Value of extension
      },
      { // Starting position. // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "offset", // R! 
        "valueInteger" : <integer> // C? R! Value of extension
      },
      { // Number of characters. // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "length", // R! 
        "valueInteger" : <integer> // C? R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/derivation-reference", // R! 
// value[x]: Value of extension. One of these 53:
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. DerivationReference0..*ExtensionURL = 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
... reference0..1Reference()References a location within a set of source text from which the discrete information described by this Resource/Element was extracted.

... path0..1stringCorresponds to the element within the resource containing the text.

... offset0..1integerIndicates the starting position (as a count of characters) within the text where the relevant derivation began.


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = 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..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:reference 0..1ExtensionSource reference.
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"reference"
.... value[x] 1..1Reference()Value of extension
... extension:path 0..1ExtensionElement containing text.
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"path"
.... value[x] 1..1stringValue of extension
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"offset"
.... value[x] 1..1integerValue of extension
... extension:length 0..1ExtensionNumber of characters.
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"length"
.... value[x] 1..1integerValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/derivation-reference"
... value[x] 0..0
.... valueBase64Binarybase64Binary
.... valueBooleanboolean
.... valueCanonicalcanonical(Any)
.... valueCodecode
.... valueDatedate
.... valueDateTimedateTime
.... valueDecimaldecimal
.... valueIdid
.... valueInstantinstant
.... valueIntegerinteger
.... valueInteger64integer64
.... valueMarkdownmarkdown
.... valueOidoid
.... valuePositiveIntpositiveInt
.... valueStringstring
.... valueTimetime
.... valueUnsignedIntunsignedInt
.... valueUriuri
.... valueUrlurl
.... valueUuiduuid
.... valueAddressAddress
.... valueAgeAge
.... valueAnnotationAnnotation
.... valueAttachmentAttachment
.... valueCodeableConceptCodeableConcept
.... valueCodeableReferenceCodeableReference
.... valueCodingCoding
.... valueContactPointContactPoint
.... valueCountCount
.... valueDistanceDistance
.... valueDurationDuration
.... valueHumanNameHumanName
.... valueIdentifierIdentifier
.... valueMoneyMoney
.... valuePeriodPeriod
.... valueQuantityQuantity
.... valueRangeRange
.... valueRatioRatio
.... valueRatioRangeRatioRange
.... valueReferenceReference(Any)
.... valueSampledDataSampledData
.... valueSignatureSignature
.... valueTimingTiming
.... valueContactDetailContactDetail
.... valueContributorContributor
.... valueDataRequirementDataRequirement
.... valueExpressionExpression
.... valueParameterDefinitionParameterDefinition
.... valueRelatedArtifactRelatedArtifact
.... valueTriggerDefinitionTriggerDefinition
.... valueUsageContextUsageContext
.... valueDosageDosage
.... valueMetaMeta

doco Documentation for this format

XML Template

<!-- DerivationReference -->doco

<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"> ?? 0..1 Extension  <!-- ?? 0..1 Source reference. -->
  <valueReference><!-- ?? 1..1 Reference Value of extension --></valueReference>
 </extension>
 <extension url="path"> ?? 0..1 Extension  <!-- ?? 0..1 Element containing text. -->
  <valueString value="[string]"/><!-- ?? 1..1 Value of extension -->
 </extension>
 <extension url="offset"> ?? 0..1 Extension  <!-- ?? 0..1 Starting position. -->
  <valueInteger value="[integer]"/><!-- ?? 1..1 Value of extension -->
 </extension>
 <extension url="length"> ?? 0..1 Extension  <!-- ?? 0..1 Number of characters. -->
  <valueInteger value="[integer]"/><!-- ?? 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // DerivationReference
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Source reference. // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "reference", // R! 
        "valueReference" : { Reference } // C? R! Value of extension
      },
      { // Element containing text. // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "path", // R! 
        "valueString" : "<string>" // C? R! Value of extension
      },
      { // Starting position. // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "offset", // R! 
        "valueInteger" : <integer> // C? R! Value of extension
      },
      { // Number of characters. // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "length", // R! 
        "valueInteger" : <integer> // C? R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/derivation-reference", // R! 
// value[x]: Value of extension. One of these 53:
  }

 

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)