Release 4B 5 Ballot

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0-ballot: R5 Ballot - STU 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 . Page versions: R4B R4

Extension: relativeDateTime

FHIR Infrastructure Work Group   Maturity Level : 1 Informative Use Context : Any

URL for this extension: http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime Summary

Defining URL: http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime
Version: 5.0.0-ballot
Name: relativeDateTime
Title: null
Modifier: This extension is not a modifier extension
Status: draft
Definition: A date/time value that is determined based on a duration offset from a target event.
Committee: FHIR Infrastructure Work Group

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

A date/time value that is determined based on a duration offset from a target event.

Context of Use: Use on Element ID Element

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . relativeDateTime 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime
relativeDateTime: A date/time value that is determined based on a duration offset from a target event.


Use on Element ID Element
. . . target 1..1 Reference ( Resource ) The Relative to what event that the date/time value is relative to.

. . . targetPath 1..1 string The path Relative to the which element that defines the effective period for on the event that the date/time value is relative to.

. . . relationship 1..1 code The relationship to the effective period of the target event that the date/time value is relative to. before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end

Binding: ActionRelationshipType ( required )

doco Documentation for this format

Full Structure

valueBase64Binary base64Binary valueBoolean boolean valueCanonical canonical (Any) valueCode code valueDate date valueDateTime dateTime valueDecimal decimal valueId id valueInstant instant valueInteger integer valueMarkdown markdown valueOid oid valuePositiveInt positiveInt valueString string valueTime time valueUnsignedInt unsignedInt valueUri uri valueUrl url valueUuid uuid valueAddress Address valueAge Age valueAnnotation Annotation valueAttachment Attachment valueCodeableConcept CodeableConcept valueCodeableReference CodeableReference valueCoding Coding valueContactPoint ContactPoint valueCount Count valueDistance Distance valueDuration Duration valueHumanName HumanName valueIdentifier Identifier valueMoney Money valuePeriod Period valueQuantity Quantity valueRange Range valueRatio Ratio valueRatioRange RatioRange valueReference Reference (Any) valueSampledData SampledData valueSignature Signature valueTiming Timing valueContactDetail ContactDetail valueContributor Contributor valueDataRequirement DataRequirement valueExpression Expression valueParameterDefinition ParameterDefinition valueRelatedArtifact RelatedArtifact valueTriggerDefinition TriggerDefinition valueUsageContext UsageContext valueDosage Dosage
Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime
relativeDateTime: A date/time value that is determined based on a duration offset from a target event.


Use on Element ID Element
. . . Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension:target 1..1 Extension Relative to what event
. . . . id 0..1 id Unique id for inter-element referencing
. . . . extension 0..0
. . . . url 1..1 uri "target"
. . . . value[x] 1..1 Reference ( Resource ) Value of extension
. . . extension:targetPath 1..1 Extension Relative to which element on the event
. . . . id 0..1 id Unique id for inter-element referencing
. . . . extension 0..0
. . . . url 1..1 uri "targetPath"
. . . . value[x] 1..1 string Value of extension
. . . . id 0..1 id Unique id for inter-element referencing
. . . . extension 0..0
. . . . url 1..1 uri "relationship"
. . . . value[x] 1..1 code Value of extension
Binding: ActionRelationshipType ( required )
. . . extension:offset 1..1 Extension How long
. . . . id 0..1 id Unique id for inter-element referencing
. . . . extension 0..0
. . . . url 1..1 uri "offset"
. . . . value[x] 1..1 Value of extension
. . . . . valueDuration Duration
. . . . . valueRange Range
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime"
. . . value[x] 0 .. 0

doco Documentation for this format

XML Template 

<!-- relativeDateTime -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <
  <</valueReference>

 <extension url="target"> I 1..1 Extension  <!-- I 1..1 Relative to what event -->
  <valueReference><!-- I 1..1 Reference(Resource) Value of extension --></valueReference>

 </extension>
 <
  <

 <extension url="targetPath"> I 1..1 Extension  <!-- I 1..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 How long -->
  <value[x]><!-- I 1..1 Duration|Range 

      Value of extension --></value[x]>
 </extension>
</extension>

JSON Template 

{ // relativeDateTime
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { //  

      { // Relative to what event // I R! 

        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "target", // R! 
        "

        "valueReference" : { Reference(Resource) } // I R! Value of extension

      },
      { //  

      { // Relative to which element on the event // I R! 

        // 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

      },
      { //  

      { // How long // 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! Relative to what event
    "extension" : { Extension }, // I R! Relative 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! How long
    "url" : "http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime" // R! 
  // value[x]: Value of extension: Prohibited
  }

Summary

Name Flags Card. Type Description & Constraints doco
. . relativeDateTime 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime
relativeDateTime: A date/time value that is determined based on a duration offset from a target event.


Use on Element ID Element
. . . target 1..1 Reference ( Resource ) The Relative to what event that the date/time value is relative to.

. . . targetPath 1..1 string The path Relative to the which element that defines the effective period for on the event that the date/time value is relative to.

. . . relationship 1..1 code The relationship to the effective period of the target event that the date/time value is relative to. before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end

Binding: ActionRelationshipType ( required )

doco Documentation for this format

Full Structure

valueBase64Binary base64Binary valueBoolean boolean valueCanonical canonical (Any) valueCode code valueDate date valueDateTime dateTime valueDecimal decimal valueId id valueInstant instant valueInteger integer valueMarkdown markdown valueOid oid valuePositiveInt positiveInt valueString string valueTime time valueUnsignedInt unsignedInt valueUri uri valueUrl url valueUuid uuid valueAddress Address valueAge Age valueAnnotation Annotation valueAttachment Attachment valueCodeableConcept CodeableConcept valueCodeableReference CodeableReference valueCoding Coding valueContactPoint ContactPoint valueCount Count valueDistance Distance valueDuration Duration valueHumanName HumanName valueIdentifier Identifier valueMoney Money valuePeriod Period valueQuantity Quantity valueRange Range valueRatio Ratio valueRatioRange RatioRange valueReference Reference (Any) valueSampledData SampledData valueSignature Signature valueTiming Timing valueContactDetail ContactDetail valueContributor Contributor valueDataRequirement DataRequirement valueExpression Expression valueParameterDefinition ParameterDefinition valueRelatedArtifact RelatedArtifact valueTriggerDefinition TriggerDefinition valueUsageContext UsageContext valueDosage Dosage
Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime
relativeDateTime: A date/time value that is determined based on a duration offset from a target event.


Use on Element ID Element
. . . Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension:target 1..1 Extension Relative to what event
. . . . id 0..1 id Unique id for inter-element referencing
. . . . extension 0..0
. . . . url 1..1 uri "target"
. . . . value[x] 1..1 Reference ( Resource ) Value of extension
. . . extension:targetPath 1..1 Extension Relative to which element on the event
. . . . id 0..1 id Unique id for inter-element referencing
. . . . extension 0..0
. . . . url 1..1 uri "targetPath"
. . . . value[x] 1..1 string Value of extension
. . . . id 0..1 id Unique id for inter-element referencing
. . . . extension 0..0
. . . . url 1..1 uri "relationship"
. . . . value[x] 1..1 code Value of extension
Binding: ActionRelationshipType ( required )
. . . extension:offset 1..1 Extension How long
. . . . id 0..1 id Unique id for inter-element referencing
. . . . extension 0..0
. . . . url 1..1 uri "offset"
. . . . value[x] 1..1 Value of extension
. . . . . valueDuration Duration
. . . . . valueRange Range
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime"
. . . value[x] 0 .. 0

doco Documentation for this format

XML Template 

<!-- relativeDateTime -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <
  <</valueReference>

 <extension url="target"> I 1..1 Extension  <!-- I 1..1 Relative to what event -->
  <valueReference><!-- I 1..1 Reference(Resource) Value of extension --></valueReference>

 </extension>
 <
  <

 <extension url="targetPath"> I 1..1 Extension  <!-- I 1..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 How long -->
  <value[x]><!-- I 1..1 Duration|Range 

      Value of extension --></value[x]>
 </extension>
</extension>

JSON Template 

{ // relativeDateTime
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { //  

      { // Relative to what event // I R! 

        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "target", // R! 
        "

        "valueReference" : { Reference(Resource) } // I R! Value of extension

      },
      { //  

      { // Relative to which element on the event // I R! 

        // 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

      },
      { //  

      { // How long // 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! Relative to what event
    "extension" : { Extension }, // I R! Relative 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! How long
    "url" : "http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime" // R! 
  // value[x]: Value of extension: Prohibited
  }

 

Constraints

  • ele-1 : All FHIR elements must have a @value or children unless an empty Parameters resource (xpath: @value|f:*|h:div|self::f:Parameters @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.