This page is part of the FHIR Specification (v4.4.0: R5 Preview #2). 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

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

Summary

Name	Card.	Type	Description & Constraints
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.
offset	1..1	Duration, Range	A duration or range of durations that specifies the offset between the date/time value and the target event. For example, 30-60 minutes before.
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
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
id		0..1	string	Unique id for inter-element referencing
extension	I	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:relationship	I	1..1	Extension	before-start \| before \| before-end \| concurrent-with-start \| concurrent \| concurrent-with-end \| after-start \| after \| after-end
id		0..1	string	Unique id for inter-element referencing
extension	I	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
valueInteger64			integer64
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
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
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
valueMeta			Meta
Documentation for this format

XML Template

<!-- relativeDateTime -->

<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><!--  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	Card.	Type	Description & Constraints
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.
offset	1..1	Duration, Range	A duration or range of durations that specifies the offset between the date/time value and the target event. For example, 30-60 minutes before.
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
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
id		0..1	string	Unique id for inter-element referencing
extension	I	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:relationship	I	1..1	Extension	before-start \| before \| before-end \| concurrent-with-start \| concurrent \| concurrent-with-end \| after-start \| after \| after-end
id		0..1	string	Unique id for inter-element referencing
extension	I	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
valueInteger64			integer64
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
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
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
valueMeta			Meta
Documentation for this format

XML Template

<!-- relativeDateTime -->

<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><!--  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)