FHIR CI-Build

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

Extension: RelativeDateCriteria

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

Summary

Defining URL:http://hl7.org/fhir/StructureDefinition/relative-date
Version:5.0.0-cibuild
Name:RelativeDateCriteria
Title:Relative Date Criteria
Modifier:This extension is not a modifier extension
Status:draft
Definition:Specifies that a date is relative to some event. The event happens [Duration] after [Event].
Committee:FHIR Infrastructure Work Group

Status: draft. Extension maintained by: Health Level Seven International (FHIR Infrastructure)

Specifies that a date is relative to some event. The event happens [Duration] after [Event].

Comment:

This extension is used when a precise date is not known, but rather, the date will be relative to some future event (e.g. Do this 2 weeks after an operation).

Context of Use: Use on Element ID date or Element ID dateTime

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelativeDateCriteria0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/relative-date
RelativeDateCriteria: Specifies that a date is relative to some event. The event happens [Duration] after [Event].


Use on Element ID date or Element ID dateTime
... target1..1CodeableReference()Event that the date is relative to

... targetPath0..1stringRelative to which element on the event

... relationship1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end

Binding: ActionRelationshipType (preferred)

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/relative-date
RelativeDateCriteria: Specifies that a date is relative to some event. The event happens [Duration] after [Event].


Use on Element ID date or Element ID dateTime
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:target 1..1ExtensionEvent that the date is relative to
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"target"
.... value[x] 1..1CodeableReference()Value of extension
... extension:targetPath 0..1ExtensionRelative to which element on the event
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"targetPath"
.... value[x] 1..1stringValue of extension
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"relationship"
.... value[x] 1..1codeValue of extension
Binding: ActionRelationshipType (preferred)
... extension:offset 1..1ExtensionDuration after the event
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"offset"
.... value[x] 1..1Value of extension
..... valueDurationDuration
..... valueRangeRange
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/relative-date"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- RelativeDateCriteria -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/relative-date" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="target"> I 1..1 Extension  <!-- I 1..1 Event that the date is relative to -->
  <valueCodeableReference><!-- I 1..1 CodeableReference 
      Value of extension --></valueCodeableReference>
 </extension>
 <extension url="targetPath"> I 0..1 Extension  <!-- I 0..1 Relative to which element on the event -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="relationship"> I 1..1 Extension  <!-- I 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end -->
  <valueCode value="[code]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="offset"> I 1..1 Extension  <!-- I 1..1 Duration after the event -->
  <value[x]><!-- I 1..1 Duration|Range 
      Value of extension --></value[x]>
 </extension>
</extension>

JSON Template

{ // RelativeDateCriteria
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Event that the date is relative to // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "target", // R! 
        "valueCodeableReference" : { CodeableReference } // I R! Value of extension
      },
      { // Relative to which element on the event // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "targetPath", // R! 
        "valueString" : "<string>" // I R! Value of extension
      },
      { // before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "relationship", // R! 
        "valueCode" : "<code>" // I R! Value of extension
      },
      { // Duration after the event // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "offset", // R! 
// value[x]: Value of extension. One of these 2:
        "valueDuration" : { Duration }, // I R! Value of extension
        "valueRange" : { Range }, // I R! Value of extension
      },
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // I R! Event that the date is relative to
    "extension" : { Extension }, // IRelative to which element on the event
    "extension" : { Extension }, // I R! before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
    "extension" : { Extension }, // I R! Duration after the event
    "url" : "http://hl7.org/fhir/StructureDefinition/relative-date" // R! 
  // value[x]: Value of extension: Prohibited
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelativeDateCriteria0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/relative-date
RelativeDateCriteria: Specifies that a date is relative to some event. The event happens [Duration] after [Event].


Use on Element ID date or Element ID dateTime
... target1..1CodeableReference()Event that the date is relative to

... targetPath0..1stringRelative to which element on the event

... relationship1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end

Binding: ActionRelationshipType (preferred)

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/relative-date
RelativeDateCriteria: Specifies that a date is relative to some event. The event happens [Duration] after [Event].


Use on Element ID date or Element ID dateTime
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:target 1..1ExtensionEvent that the date is relative to
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"target"
.... value[x] 1..1CodeableReference()Value of extension
... extension:targetPath 0..1ExtensionRelative to which element on the event
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"targetPath"
.... value[x] 1..1stringValue of extension
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"relationship"
.... value[x] 1..1codeValue of extension
Binding: ActionRelationshipType (preferred)
... extension:offset 1..1ExtensionDuration after the event
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"offset"
.... value[x] 1..1Value of extension
..... valueDurationDuration
..... valueRangeRange
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/relative-date"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- RelativeDateCriteria -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/relative-date" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="target"> I 1..1 Extension  <!-- I 1..1 Event that the date is relative to -->
  <valueCodeableReference><!-- I 1..1 CodeableReference 
      Value of extension --></valueCodeableReference>
 </extension>
 <extension url="targetPath"> I 0..1 Extension  <!-- I 0..1 Relative to which element on the event -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="relationship"> I 1..1 Extension  <!-- I 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end -->
  <valueCode value="[code]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="offset"> I 1..1 Extension  <!-- I 1..1 Duration after the event -->
  <value[x]><!-- I 1..1 Duration|Range 
      Value of extension --></value[x]>
 </extension>
</extension>

JSON Template

{ // RelativeDateCriteria
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Event that the date is relative to // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "target", // R! 
        "valueCodeableReference" : { CodeableReference } // I R! Value of extension
      },
      { // Relative to which element on the event // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "targetPath", // R! 
        "valueString" : "<string>" // I R! Value of extension
      },
      { // before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "relationship", // R! 
        "valueCode" : "<code>" // I R! Value of extension
      },
      { // Duration after the event // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "offset", // R! 
// value[x]: Value of extension. One of these 2:
        "valueDuration" : { Duration }, // I R! Value of extension
        "valueRange" : { Range }, // I R! Value of extension
      },
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // I R! Event that the date is relative to
    "extension" : { Extension }, // IRelative to which element on the event
    "extension" : { Extension }, // I R! before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
    "extension" : { Extension }, // I R! Duration after the event
    "url" : "http://hl7.org/fhir/StructureDefinition/relative-date" // 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')]))
  • 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.