Current Build

Extension: relativeDateTime

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

URL for this extension:

http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. relativeDateTime0..1ExtensionURL = 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
... target1..1Reference()The event that the date/time value is relative to.

... targetPath1..1stringThe path to the element that defines the effective period for the event that the date/time value is relative to.

... relationship1..1codeThe relationship to the effective period of the target event that the date/time value is relative to.

... offset1..1Duration, RangeA duration or range of durations that specifies the offset between the date/time value and the target event. For example, 30-60 minutes before.


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = 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
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... target 1..1ExtensionRelative to what event
.... extension 0..0
.... url 1..1uri"target"
.... value[x] (Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
..... valueReference 0..1Reference(Resource)Value of extension
... targetPath 1..1ExtensionRelative to which element on the event
.... extension 0..0
.... url 1..1uri"targetPath"
.... value[x] (Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
..... valueString 0..1stringValue of extension
... relationship 1..1Extensionbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
.... extension 0..0
.... url 1..1uri"relationship"
.... value[x] (Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
..... valueCode 0..1codeValue of extension
Binding: ActionRelationshipType (required)
... offset 1..1ExtensionHow long
.... extension 0..0
.... url 1..1uri"offset"
.... value[x] 1..1Value of extension
..... valueDurationDuration
..... valueRangeRange
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime"
... value[x] 0..0
.... valueBase64Binarybase64Binary
.... valueBooleanboolean
.... valueCanonicalcanonical()
.... valueCodecode
.... valueDatedate
.... valueDateTimedateTime
.... valueDecimaldecimal
.... valueIdid
.... valueInstantinstant
.... valueIntegerinteger
.... valueMarkdownmarkdown
.... valueOidoid
.... valuePositiveIntpositiveInt
.... valueStringstring
.... valueTimetime
.... valueUnsignedIntunsignedInt
.... valueUriuri
.... valueUrlurl
.... valueUuiduuid
.... valueAddressAddress
.... valueAgeAge
.... valueAnnotationAnnotation
.... valueAttachmentAttachment
.... valueCodeableConceptCodeableConcept
.... valueCodingCoding
.... valueContactPointContactPoint
.... valueCountCount
.... valueDistanceDistance
.... valueDurationDuration
.... valueHumanNameHumanName
.... valueIdentifierIdentifier
.... valueMoneyMoney
.... valuePeriodPeriod
.... valueQuantityQuantity
.... valueRangeRange
.... valueRatioRatio
.... valueReferenceReference()
.... valueSampledDataSampledData
.... valueSignatureSignature
.... valueTimingTiming
.... valueContactDetailContactDetail
.... valueContributorContributor
.... valueDataRequirementDataRequirement
.... valueExpressionExpression
.... valueParameterDefinitionParameterDefinition
.... valueRelatedArtifactRelatedArtifact
.... valueTriggerDefinitionTriggerDefinition
.... valueUsageContextUsageContext
.... valueDosageDosage
.... valueMetaMeta

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-->
 <extension url="target"> 1..1 Extension  <!-- 1..1 Relative to what event -->
  <-- valueReference sliced by type:$this  in the specified orderClosed-->
  <valueReference><!-- 0..1 Reference(Resource) Value of extension --></valueReference>
 </extension>
 <extension url="targetPath"> 1..1 Extension  <!-- 1..1 Relative to which element on the event -->
  <-- valueString sliced by type:$this  in the specified orderClosed-->
  <valueString value="[string]"/><!-- 0..1 Value of extension -->
 </extension>
 <extension url="relationship"> 1..1 Extension  <!-- 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end -->
  <-- valueCode sliced by type:$this  in the specified orderClosed-->
  <valueCode value="[code]"/><!-- 0..1 Value of extension -->
 </extension>
 <extension url="offset"> 1..1 Extension  <!-- 1..1 How long -->
  <value[x]><!-- 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 // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "target", // R! 
        "valueReference" : [ //  sliced by type:$this  in the specified order, Closed ]
        "valueReference" : { Reference(Resource) } //Value of extension
      },
      { // Relative to which element on the event // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "targetPath", // R! 
        "valueString" : [ //  sliced by type:$this  in the specified order, Closed ]
        "valueString" : "<string>" //Value of extension
      },
      { // before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "relationship", // R! 
        "valueCode" : [ //  sliced by type:$this  in the specified order, Closed ]
        "valueCode" : "<code>" //Value of extension
      },
      { // How long // 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 } // R! Value of extension
        "valueRange" : { Range }, // R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime", // R! 
// value[x]: Value of extension. One of these 50:
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. relativeDateTime0..1ExtensionURL = 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
... target1..1Reference()The event that the date/time value is relative to.

... targetPath1..1stringThe path to the element that defines the effective period for the event that the date/time value is relative to.

... relationship1..1codeThe relationship to the effective period of the target event that the date/time value is relative to.

... offset1..1Duration, RangeA duration or range of durations that specifies the offset between the date/time value and the target event. For example, 30-60 minutes before.


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = 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
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... target 1..1ExtensionRelative to what event
.... extension 0..0
.... url 1..1uri"target"
.... value[x] (Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
..... valueReference 0..1Reference(Resource)Value of extension
... targetPath 1..1ExtensionRelative to which element on the event
.... extension 0..0
.... url 1..1uri"targetPath"
.... value[x] (Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
..... valueString 0..1stringValue of extension
... relationship 1..1Extensionbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
.... extension 0..0
.... url 1..1uri"relationship"
.... value[x] (Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
..... valueCode 0..1codeValue of extension
Binding: ActionRelationshipType (required)
... offset 1..1ExtensionHow long
.... extension 0..0
.... url 1..1uri"offset"
.... value[x] 1..1Value of extension
..... valueDurationDuration
..... valueRangeRange
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime"
... value[x] 0..0
.... valueBase64Binarybase64Binary
.... valueBooleanboolean
.... valueCanonicalcanonical()
.... valueCodecode
.... valueDatedate
.... valueDateTimedateTime
.... valueDecimaldecimal
.... valueIdid
.... valueInstantinstant
.... valueIntegerinteger
.... valueMarkdownmarkdown
.... valueOidoid
.... valuePositiveIntpositiveInt
.... valueStringstring
.... valueTimetime
.... valueUnsignedIntunsignedInt
.... valueUriuri
.... valueUrlurl
.... valueUuiduuid
.... valueAddressAddress
.... valueAgeAge
.... valueAnnotationAnnotation
.... valueAttachmentAttachment
.... valueCodeableConceptCodeableConcept
.... valueCodingCoding
.... valueContactPointContactPoint
.... valueCountCount
.... valueDistanceDistance
.... valueDurationDuration
.... valueHumanNameHumanName
.... valueIdentifierIdentifier
.... valueMoneyMoney
.... valuePeriodPeriod
.... valueQuantityQuantity
.... valueRangeRange
.... valueRatioRatio
.... valueReferenceReference()
.... valueSampledDataSampledData
.... valueSignatureSignature
.... valueTimingTiming
.... valueContactDetailContactDetail
.... valueContributorContributor
.... valueDataRequirementDataRequirement
.... valueExpressionExpression
.... valueParameterDefinitionParameterDefinition
.... valueRelatedArtifactRelatedArtifact
.... valueTriggerDefinitionTriggerDefinition
.... valueUsageContextUsageContext
.... valueDosageDosage
.... valueMetaMeta

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-->
 <extension url="target"> 1..1 Extension  <!-- 1..1 Relative to what event -->
  <-- valueReference sliced by type:$this  in the specified orderClosed-->
  <valueReference><!-- 0..1 Reference(Resource) Value of extension --></valueReference>
 </extension>
 <extension url="targetPath"> 1..1 Extension  <!-- 1..1 Relative to which element on the event -->
  <-- valueString sliced by type:$this  in the specified orderClosed-->
  <valueString value="[string]"/><!-- 0..1 Value of extension -->
 </extension>
 <extension url="relationship"> 1..1 Extension  <!-- 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end -->
  <-- valueCode sliced by type:$this  in the specified orderClosed-->
  <valueCode value="[code]"/><!-- 0..1 Value of extension -->
 </extension>
 <extension url="offset"> 1..1 Extension  <!-- 1..1 How long -->
  <value[x]><!-- 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 // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "target", // R! 
        "valueReference" : [ //  sliced by type:$this  in the specified order, Closed ]
        "valueReference" : { Reference(Resource) } //Value of extension
      },
      { // Relative to which element on the event // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "targetPath", // R! 
        "valueString" : [ //  sliced by type:$this  in the specified order, Closed ]
        "valueString" : "<string>" //Value of extension
      },
      { // before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "relationship", // R! 
        "valueCode" : [ //  sliced by type:$this  in the specified order, Closed ]
        "valueCode" : "<code>" //Value of extension
      },
      { // How long // 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 } // R! Value of extension
        "valueRange" : { Range }, // R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime", // R! 
// value[x]: Value of extension. One of these 50:
  }

 

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')]))