FHIR Extensions Pack
5.2.0-ballot - 5.2.0 Ballot - September 2024) International flag

FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 5.2.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-extensions/ and changes regularly. See the Directory of published versions

Extension: Relative Date Criteria

Official URL: http://hl7.org/fhir/StructureDefinition/relative-date Version: 5.2.0-ballot
Standards status: Deprecated Maturity Level: 3 Computable Name: RelativeDateCriteria
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1598

Specifies that a date is relative to some event. The event happens [Duration] after [Event]. DEPRECATED: This extension has been deprecated in favor of the new relative-time extension.

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

Changes since version 1.0.0:

  • The resource metadata has changed (status, description)
  • The data elements list has changed
  • One or more text definitions, invariants or bindings have changed

    • 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]. DEPRECATED: This extension has been deprecated in favor of the new relative-time extension.

    • 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..1 Extension DEPRECATED Relative Date Criteria
    ... Slices for extension Content/Rules for all slices
    .... extension:targetReference 1..1 Extension Specific event that the date is relative to
    ..... extension 0..0
    ..... url 1..1 uri "targetReference"
    ..... value[x] 1..1 Reference() Value of extension
    .... extension:targetCode 1..1 Extension Kind of event that the date is relative to
    ..... extension 0..0
    ..... url 1..1 uri "targetCode"
    ..... value[x] 1..1 CodeableConcept Value of extension
    .... extension:targetPath 0..1 Extension Relative to which element on the event
    ..... extension 0..0
    ..... url 1..1 uri "targetPath"
    ..... value[x] 1..1 string Value of extension
    .... extension:relationship 1..1 Extension before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
    ..... extension 0..0
    ..... url 1..1 uri "relationship"
    ..... value[x] 1..1 code Value of extension
    Binding: ActionRelationshipType (preferred)
    .... extension:offset 1..1 Extension Duration after the event
    ..... 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/relative-date"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension DEPRECATED Relative Date Criteria
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 4..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:targetReference 1..1 Extension Specific event that the date is relative to
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "targetReference"
    ..... value[x] 1..1 Reference() Value of extension
    .... extension:targetCode 1..1 Extension Kind of event that the date is relative to
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "targetCode"
    ..... value[x] 1..1 CodeableConcept Value of extension
    .... extension:targetPath 0..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
    .... extension:relationship 1..1 Extension before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
    ..... 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 (preferred)
    .... extension:offset 1..1 Extension Duration after the event
    ..... 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/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]. DEPRECATED: This extension has been deprecated in favor of the new relative-time extension.

    • 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..1 Extension DEPRECATED Relative Date Criteria
    ... Slices for extension Content/Rules for all slices
    .... extension:targetReference 1..1 Extension Specific event that the date is relative to
    ..... extension 0..0
    ..... url 1..1 uri "targetReference"
    ..... value[x] 1..1 Reference() Value of extension
    .... extension:targetCode 1..1 Extension Kind of event that the date is relative to
    ..... extension 0..0
    ..... url 1..1 uri "targetCode"
    ..... value[x] 1..1 CodeableConcept Value of extension
    .... extension:targetPath 0..1 Extension Relative to which element on the event
    ..... extension 0..0
    ..... url 1..1 uri "targetPath"
    ..... value[x] 1..1 string Value of extension
    .... extension:relationship 1..1 Extension before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
    ..... extension 0..0
    ..... url 1..1 uri "relationship"
    ..... value[x] 1..1 code Value of extension
    Binding: ActionRelationshipType (preferred)
    .... extension:offset 1..1 Extension Duration after the event
    ..... 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/relative-date"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension DEPRECATED Relative Date Criteria
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 4..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:targetReference 1..1 Extension Specific event that the date is relative to
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "targetReference"
    ..... value[x] 1..1 Reference() Value of extension
    .... extension:targetCode 1..1 Extension Kind of event that the date is relative to
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "targetCode"
    ..... value[x] 1..1 CodeableConcept Value of extension
    .... extension:targetPath 0..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
    .... extension:relationship 1..1 Extension before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
    ..... 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 (preferred)
    .... extension:offset 1..1 Extension Duration after the event
    ..... 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/relative-date"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Terminology Bindings

    PathConformanceValueSetURI
    Extension.extension:relationship.value[x]preferredActionRelationshipType
    http://hl7.org/fhir/ValueSet/action-relationship-type
    from the FHIR Standard

    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)