Release 4 5 Preview #3
This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Extension: relativeDateTime

FHIR Infrastructure Work Group   Maturity Level : 1 Informative Use 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

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 event that the date/time value is relative to.

. . . targetPath 1..1 string The path to the element that defines the effective period for 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.


doco Documentation for this format

Full Structure

valueUri uri
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
. . . extension I 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension:target I 1..1 Extension Relative to what event
. . . extension . id I 0..0 0..1 string Unique id for inter-element referencing
.... extension 0..0
. . . . url 1..1 uri "target"
. . . . value[x] I 1..1 Reference ( Resource ) Value of extension
. . . extension:targetPath I 1..1 Extension Relative to which element on the event
. . . . id 0..1 string Unique id for inter-element referencing
. . . . extension I 0..0
. . . . url 1..1 uri "targetPath"
. . . . value[x] I 1..1 string Value of extension
. . . extension . id I 0..0 0..1 string Unique id for inter-element referencing
.... extension 0..0
. . . . url 1..1 uri "relationship"
. . . . value[x] I 1..1 code Value of extension
Binding: ActionRelationshipType ( required )
. . . extension:offset I 1..1 Extension How long
. . . . id 0..1 string Unique id for inter-element referencing
. . . . extension I 0..0
. . . . url 1..1 uri "offset"
. . . . value[x] I 1..1 Value of extension
. . . . . valueDuration Duration
. . . . . valueRange Range
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime"
. . . value[x] I 0 .. 0
. . . . valueBase64Binary base64Binary
. . . . valueBoolean boolean
. . . . valueCanonical canonical () (Any)
. . . . valueCode code
. . . . valueDate date
. . . . valueDateTime dateTime
. . . . valueDecimal decimal
. . . . valueId id
. . . . valueInstant instant
. . . . valueInteger integer
. . . . valueMarkdown valueInteger64 markdown integer64
. . . . valueOid valueMarkdown oid markdown
. . . . valueOid oid
.... valuePositiveInt white; #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> white; #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> white; #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> positiveInt white; #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy>
. . . . valueString string
. . . . valueTime time
. . . . valueUnsignedInt #F7F7F7; white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> #F7F7F7; white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> #F7F7F7; white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> unsignedInt #F7F7F7; white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy>
. . . . valueUrl valueUri url uri
. . . . valueUuid valueUrl uuid url
. . . valueAddress . valueUuid Address uuid
. . . . valueAge valueAddress Age Address
. . . . valueAnnotation valueAge Annotation Age
. . . . valueAttachment valueAnnotation Attachment Annotation
. . . . valueCodeableConcept valueAttachment CodeableConcept Attachment
. . . . valueCoding valueCodeableConcept Coding CodeableConcept
. . . . valueContactPoint valueCoding ContactPoint Coding
. . . . valueCount valueContactPoint Count ContactPoint
. . . . valueDistance valueCount Distance Count
. . . . valueDuration valueDistance Duration Distance
. . . . valueHumanName valueDuration HumanName Duration
. . . . valueIdentifier valueHumanName Identifier HumanName
. . . . valueMoney valueIdentifier Money Identifier
. . . . valuePeriod valueMoney Period Money
. . . . valueQuantity valuePeriod Quantity Period
. . . . valueRange valueQuantity Range Quantity
. . . . valueRatio valueRange Ratio Range
. . . valueReference . valueRatio Reference Ratio ()
. . . valueSampledData . valueReference SampledData Reference (Any)
. . . . valueSignature valueSampledData Signature SampledData
. . . . valueTiming valueSignature Timing Signature
. . . . valueContactDetail valueTiming ContactDetail Timing
. . . . valueContributor valueContactDetail Contributor ContactDetail
. . . . valueDataRequirement valueContributor DataRequirement Contributor
. . . . valueExpression valueDataRequirement Expression DataRequirement
. . . . valueParameterDefinition valueExpression ParameterDefinition Expression
. . . . valueRelatedArtifact valueParameterDefinition RelatedArtifact ParameterDefinition
. . . . valueTriggerDefinition valueRelatedArtifact TriggerDefinition RelatedArtifact
. . . . valueUsageContext valueTriggerDefinition UsageContext TriggerDefinition
. . . . valueDosage valueUsageContext Dosage UsageContext
. . . . valueMeta valueDosage Dosage
.... valueMeta Meta

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>

  <valueReference><!-- ?? 1..1 Reference(Resource) Value of extension --></valueReference>

 </extension>
 <extension url="targetPath"> ?? 1..1 Extension  <!-- ?? 1..1 Relative to which element on the event -->
  <

  <valueString value="[string]"/><!-- ?? 1..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 value="[code]"/><!-- ?? 1..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 // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "target", // R! 
        "

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

      },
      { // Relative to which element on the event // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "targetPath", // R! 
        "

        "valueString" : "<string>" // C? R! Value of extension

      },
      { // before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "relationship", // R! 
        "

        "valueCode" : "<code>" // C? R! Value of extension

      },
      { // How long // C? 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 } // C? R! Value of extension
        "valueRange" : { Range }, // C? R! Value of extension

      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime", // R! 
// value[x]: Value of extension. One of these 51:
  }

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 event that the date/time value is relative to.

. . . targetPath 1..1 string The path to the element that defines the effective period for 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.


doco Documentation for this format

Full Structure

valueUri uri
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
. . . extension I 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension:target I 1..1 Extension Relative to what event
. . . extension . id I 0..0 0..1 string Unique id for inter-element referencing
.... extension 0..0
. . . . url 1..1 uri "target"
. . . . value[x] I 1..1 Reference ( Resource ) Value of extension
. . . extension:targetPath I 1..1 Extension Relative to which element on the event
. . . . id 0..1 string Unique id for inter-element referencing
. . . . extension I 0..0
. . . . url 1..1 uri "targetPath"
. . . . value[x] I 1..1 string Value of extension
. . . extension . id I 0..0 0..1 string Unique id for inter-element referencing
.... extension 0..0
. . . . url 1..1 uri "relationship"
. . . . value[x] I 1..1 code Value of extension
Binding: ActionRelationshipType ( required )
. . . extension:offset I 1..1 Extension How long
. . . . id 0..1 string Unique id for inter-element referencing
. . . . extension I 0..0
. . . . url 1..1 uri "offset"
. . . . value[x] I 1..1 Value of extension
. . . . . valueDuration Duration
. . . . . valueRange Range
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime"
. . . value[x] I 0 .. 0
. . . . valueBase64Binary base64Binary
. . . . valueBoolean boolean
. . . . valueCanonical canonical () (Any)
. . . . valueCode code
. . . . valueDate date
. . . . valueDateTime dateTime
. . . . valueDecimal decimal
. . . . valueId id
. . . . valueInstant instant
. . . . valueInteger integer
. . . . valueMarkdown valueInteger64 markdown integer64
. . . . valueOid valueMarkdown oid markdown
. . . . valueOid oid
.... valuePositiveInt white; #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> white; #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> white; #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> positiveInt white; #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy>
. . . . valueString string
. . . . valueTime time
. . . . valueUnsignedInt #F7F7F7; white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> #F7F7F7; white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> #F7F7F7; white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> unsignedInt #F7F7F7; white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy>
. . . . valueUrl valueUri url uri
. . . . valueUuid valueUrl uuid url
. . . valueAddress . valueUuid Address uuid
. . . . valueAge valueAddress Age Address
. . . . valueAnnotation valueAge Annotation Age
. . . . valueAttachment valueAnnotation Attachment Annotation
. . . . valueCodeableConcept valueAttachment CodeableConcept Attachment
. . . . valueCoding valueCodeableConcept Coding CodeableConcept
. . . . valueContactPoint valueCoding ContactPoint Coding
. . . . valueCount valueContactPoint Count ContactPoint
. . . . valueDistance valueCount Distance Count
. . . . valueDuration valueDistance Duration Distance
. . . . valueHumanName valueDuration HumanName Duration
. . . . valueIdentifier valueHumanName Identifier HumanName
. . . . valueMoney valueIdentifier Money Identifier
. . . . valuePeriod valueMoney Period Money
. . . . valueQuantity valuePeriod Quantity Period
. . . . valueRange valueQuantity Range Quantity
. . . . valueRatio valueRange Ratio Range
. . . valueReference . valueRatio Reference Ratio ()
. . . valueSampledData . valueReference SampledData Reference (Any)
. . . . valueSignature valueSampledData Signature SampledData
. . . . valueTiming valueSignature Timing Signature
. . . . valueContactDetail valueTiming ContactDetail Timing
. . . . valueContributor valueContactDetail Contributor ContactDetail
. . . . valueDataRequirement valueContributor DataRequirement Contributor
. . . . valueExpression valueDataRequirement Expression DataRequirement
. . . . valueParameterDefinition valueExpression ParameterDefinition Expression
. . . . valueRelatedArtifact valueParameterDefinition RelatedArtifact ParameterDefinition
. . . . valueTriggerDefinition valueRelatedArtifact TriggerDefinition RelatedArtifact
. . . . valueUsageContext valueTriggerDefinition UsageContext TriggerDefinition
. . . . valueDosage valueUsageContext Dosage UsageContext
. . . . valueMeta valueDosage Dosage
.... valueMeta Meta

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>

  <valueReference><!-- ?? 1..1 Reference(Resource) Value of extension --></valueReference>

 </extension>
 <extension url="targetPath"> ?? 1..1 Extension  <!-- ?? 1..1 Relative to which element on the event -->
  <

  <valueString value="[string]"/><!-- ?? 1..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 value="[code]"/><!-- ?? 1..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 // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "target", // R! 
        "

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

      },
      { // Relative to which element on the event // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "targetPath", // R! 
        "

        "valueString" : "<string>" // C? R! Value of extension

      },
      { // before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "relationship", // R! 
        "

        "valueCode" : "<code>" // C? R! Value of extension

      },
      { // How long // C? 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 } // C? R! Value of extension
        "valueRange" : { Range }, // C? R! Value of extension

      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime", // R! 
// value[x]: Value of extension. One of these 51:
  }

 

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 )