FHIR Extensions Pack
1.0.0 - Working Copy International flag

This page is part of the FHIR Core Extensions Registry (v1.0.0: Releases) based on FHIR v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Extension: Relative Date Criteria

Official URL: http://hl7.org/fhir/StructureDefinition/relative-date Version: 1.0.0
Standards status: Trial-use Maturity Level: 3 Computable Name: RelativeDateCriteria

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

Context of Use

This extension may be used on the following element(s):

  • Element ID date
  • Element ID dateTime

Usage info

Usage:

  • This Extension is not used by any profiles in this Implementation Guide

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

Summary

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

  • targetReference: Reference: The specific event that the date(time) is relative to - e.g. an Encounter, an Observation, a Procedure, etc.
  • targetCode: CodeableConcept: The generic type of event that the date(time) is relative to.
  • targetPath: string: The path to the element of the target that specifies the anchoring date or timeframe for the relative date.
  • relationship: code: Defines the relationship between the event and the date.
  • offset: Duration, Range: The duration or range of durations relative to the event that the date(time) will happen.

Maturity: 3

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionRelative Date Criteria
... extension:targetReference 1..1ExtensionSpecific event that the date is relative to
.... extension 0..0
.... url 1..1uri"targetReference"
.... value[x] 1..1Reference()Value of extension
... extension:targetCode 1..1ExtensionKind of event that the date is relative to
.... extension 0..0
.... url 1..1uri"targetCode"
.... value[x] 1..1CodeableConceptValue of extension
... extension:targetPath 0..1ExtensionRelative to which element on the event
.... extension 0..0
.... url 1..1uri"targetPath"
.... value[x] 1..1stringValue of extension
.... extension 0..0
.... url 1..1uri"relationship"
.... value[x] 1..1codeValue of extension
Binding: ActionRelationshipType (preferred)
... extension:offset 1..1ExtensionDuration after the event
.... 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
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionRelative Date Criteria
... id 0..1idUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:targetReference 1..1ExtensionSpecific event that the date is relative to
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"targetReference"
.... value[x] 1..1Reference()Value of extension
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"targetCode"
.... value[x] 1..1CodeableConceptValue 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
... extension:relationship 1..1Extensionbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
.... 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"

doco Documentation for this format

This structure is derived from Extension

Summary

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

  • targetReference: Reference: The specific event that the date(time) is relative to - e.g. an Encounter, an Observation, a Procedure, etc.
  • targetCode: CodeableConcept: The generic type of event that the date(time) is relative to.
  • targetPath: string: The path to the element of the target that specifies the anchoring date or timeframe for the relative date.
  • relationship: code: Defines the relationship between the event and the date.
  • offset: Duration, Range: The duration or range of durations relative to the event that the date(time) will happen.

Maturity: 3

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionRelative Date Criteria
... extension:targetReference 1..1ExtensionSpecific event that the date is relative to
.... extension 0..0
.... url 1..1uri"targetReference"
.... value[x] 1..1Reference()Value of extension
... extension:targetCode 1..1ExtensionKind of event that the date is relative to
.... extension 0..0
.... url 1..1uri"targetCode"
.... value[x] 1..1CodeableConceptValue of extension
... extension:targetPath 0..1ExtensionRelative to which element on the event
.... extension 0..0
.... url 1..1uri"targetPath"
.... value[x] 1..1stringValue of extension
.... extension 0..0
.... url 1..1uri"relationship"
.... value[x] 1..1codeValue of extension
Binding: ActionRelationshipType (preferred)
... extension:offset 1..1ExtensionDuration after the event
.... 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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionRelative Date Criteria
... id 0..1idUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:targetReference 1..1ExtensionSpecific event that the date is relative to
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"targetReference"
.... value[x] 1..1Reference()Value of extension
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"targetCode"
.... value[x] 1..1CodeableConceptValue 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
... extension:relationship 1..1Extensionbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
.... 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"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.extension:relationship.value[x]preferredActionRelationshipType

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Search Parameters for this Extension

(none found)