FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Extension: eventTiming

Orders and Observations Work Group Maturity Level: 1InformativeUse Context: Any

URL for this extension: 

http://hl7.org/fhir/StructureDefinition/observation-eventTiming

Status: draft. Extension maintained by: Health Level Seven, Inc. - FHIR WG

Regular life events the observation is tied to. This is useful for recording imprecise or "fuzzy" times when the observation occurred. For example, a blood glucose measurement "after breakfast". It is interpreted as relative to the effectiveTime element or the issued element if effectiveTime is absent. For example the blood glucose measurement could be reported that same day ("today after breakfast") or some other day ("yesterday after breakfast").

Context of Use: Use on element: Observation

usage info: insert a list of places where this extension is used

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/observation-eventTiming
eventTiming: Regular life events the observation is tied to. This is useful for recording imprecise or "fuzzy" times when the observation occurred. For example, a blood glucose measurement "after breakfast". It is interpreted as relative to the `effectiveTime` element or the `issued` element if `effectiveTime` is absent. For example the blood glucose measurement could be reported that same day ("today after breakfast") or some other day ("yesterday after breakfast").
Use on element: Observation
... code0..1CodeableConceptReal world event that coincides with the effective time of the observation.
... offset0..1QuantityThe duration of time before or after the event in `code`. If the observation occurred *before* the event, a negative decimal is used. (for example 30 minutes before = -30 m) If the observation occurred *after* the event a positive decimal is used.(for example 2 hrs after = 2 h).

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/observation-eventTiming
eventTiming: Regular life events the observation is tied to. This is useful for recording imprecise or "fuzzy" times when the observation occurred. For example, a blood glucose measurement "after breakfast". It is interpreted as relative to the `effectiveTime` element or the `issued` element if `effectiveTime` is absent. For example the blood glucose measurement could be reported that same day ("today after breakfast") or some other day ("yesterday after breakfast").
Use on element: Observation
... extension 0..1ExtensionLife events
.... url 1..1uri"code"
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: v3 Code System TimingEvent (extensible)
... extension 0..1ExtensionHow close to event
.... url 1..1uri"offset"
.... valueQuantity 0..1QuantityValue of extension
Binding: UnitsOfTime (required)
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/observation-eventTiming"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- eventTiming -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/observation-eventTiming" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="code"> 0..1 Extension  <!-- 0..1 Life events -->
  <valueCodeableConcept><!-- 0..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="offset"> 0..1 Extension  <!-- 0..1 How close to event -->
  <valueQuantity><!-- 0..1 Quantity Value of extension --></valueQuantity>
 </extension>
</extension>

JSON Template

{ // eventTiming
    "extension" : [ //  sliced by value:url  in the specified orderOpen
      { // Life events //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "code", // R! 
        "valueCodeableConcept" : { CodeableConcept } //Value of extension
      },
      { // How close to event //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "offset", // R! 
        "valueQuantity" : { Quantity } //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/observation-eventTiming", // R! 
// value[x]: Value of extension. One of these 38:
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/observation-eventTiming
eventTiming: Regular life events the observation is tied to. This is useful for recording imprecise or "fuzzy" times when the observation occurred. For example, a blood glucose measurement "after breakfast". It is interpreted as relative to the `effectiveTime` element or the `issued` element if `effectiveTime` is absent. For example the blood glucose measurement could be reported that same day ("today after breakfast") or some other day ("yesterday after breakfast").
Use on element: Observation
... code0..1CodeableConceptReal world event that coincides with the effective time of the observation.
... offset0..1QuantityThe duration of time before or after the event in `code`. If the observation occurred *before* the event, a negative decimal is used. (for example 30 minutes before = -30 m) If the observation occurred *after* the event a positive decimal is used.(for example 2 hrs after = 2 h).

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/observation-eventTiming
eventTiming: Regular life events the observation is tied to. This is useful for recording imprecise or "fuzzy" times when the observation occurred. For example, a blood glucose measurement "after breakfast". It is interpreted as relative to the `effectiveTime` element or the `issued` element if `effectiveTime` is absent. For example the blood glucose measurement could be reported that same day ("today after breakfast") or some other day ("yesterday after breakfast").
Use on element: Observation
... extension 0..1ExtensionLife events
.... url 1..1uri"code"
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: v3 Code System TimingEvent (extensible)
... extension 0..1ExtensionHow close to event
.... url 1..1uri"offset"
.... valueQuantity 0..1QuantityValue of extension
Binding: UnitsOfTime (required)
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/observation-eventTiming"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- eventTiming -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/observation-eventTiming" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="code"> 0..1 Extension  <!-- 0..1 Life events -->
  <valueCodeableConcept><!-- 0..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="offset"> 0..1 Extension  <!-- 0..1 How close to event -->
  <valueQuantity><!-- 0..1 Quantity Value of extension --></valueQuantity>
 </extension>
</extension>

JSON Template

{ // eventTiming
    "extension" : [ //  sliced by value:url  in the specified orderOpen
      { // Life events //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "code", // R! 
        "valueCodeableConcept" : { CodeableConcept } //Value of extension
      },
      { // How close to event //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "offset", // R! 
        "valueQuantity" : { Quantity } //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/observation-eventTiming", // R! 
// value[x]: Value of extension. One of these 38:
  }

 

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