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
Orders and Observations Work Group | Maturity Level: N/A | Ballot Status: Informative |
eventTiming
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="observation-eventTiming"/> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"> <valueCode value="oo"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"> <valueInteger value="1"/> </extension> <url value="http://hl7.org/fhir/StructureDefinition/observation-eventTiming"/> <name value="eventTiming"/> <title value="Event Timing"/> <status value="draft"/> <date value="2015-03-02"/> <publisher value="Health Level Seven, Inc. - FHIR WG"/> <contact> <telecom> <system value="url"/> <value value="HL7"/> </telecom> </contact> <description value="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")."/> <fhirVersion value="3.0.2"/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM Mapping"/> </mapping> <kind value="complex-type"/> <abstract value="false"/> <contextType value="resource"/> <context value="Observation"/> <type value="Extension"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension"/> <derivation value="constraint"/> <snapshot> <element id="Extension"> <path value="Extension"/> <short value="Approximate time of observation"/> <definition value="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")."/> <min value="0"/> <max value="*"/> <base> <path value="Extension"/> <min value="0"/> <max value="*"/> </base> <condition value="ele-1"/> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() | (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <constraint> <key value="ext-1"/> <severity value="error"/> <human value="Must have either extensions or value[x], not both"/> <expression value="extension.exists() != value.exists()"/> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"/> <source value="Extension"/> </constraint> <mapping> <identity value="rim"/> <map value="effectiveTime"/> </mapping> </element> <element id="Extension.id"> <path value="Extension.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Extension.extension"> <path value="Extension.extension"/> <slicing> <discriminator> <type value="value"/> <path value="url"/> </discriminator> <description value="Extensions are always sliced by (at least) url"/> <rules value="open"/> </slicing> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Extension.extension:code"> <path value="Extension.extension"/> <sliceName value="code"/> <short value="Life events"/> <definition value="Real world event that coincides with the effective time of the observation."/> <comment value="For text only time the `.text` element can be used. (e.g. "right before I walked the dog")."/> <min value="0"/> <max value="1"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> </element> <element id="Extension.extension:code.id"> <path value="Extension.extension.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Extension.extension:code.extension"> <path value="Extension.extension.extension"/> <slicing> <discriminator> <type value="value"/> <path value="url"/> </discriminator> <description value="Extensions are always sliced by (at least) url"/> <rules value="open"/> </slicing> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Extension.extension:code.url"> <path value="Extension.extension.url"/> <representation value="xmlAttr"/> <short value="identifies the meaning of the extension"/> <definition value="Source of the definition for the extension code - a logical name or a URL."/> <comment value="The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension."/> <min value="1"/> <max value="1"/> <base> <path value="Extension.url"/> <min value="1"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <fixedUri value="code"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Extension.extension:code.valueCodeableConcept"> <path value="Extension.extension.valueCodeableConcept"/> <short value="Value of extension"/> <definition value="Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list)."/> <min value="0"/> <max value="1"/> <base> <path value="Extension.value[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="EventCode"/> </extension> <strength value="extensible"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/v3-TimingEvent"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Extension.extension:offset"> <path value="Extension.extension"/> <sliceName value="offset"/> <short value="How close to event"/> <definition value="The 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)."/> <comment value="Avoid nonsensical combinations of code and offset such as an offset = 30 minutes before and a code = after dinner."/> <min value="0"/> <max value="1"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> </element> <element id="Extension.extension:offset.id"> <path value="Extension.extension.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Extension.extension:offset.extension"> <path value="Extension.extension.extension"/> <slicing> <discriminator> <type value="value"/> <path value="url"/> </discriminator> <description value="Extensions are always sliced by (at least) url"/> <rules value="open"/> </slicing> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Extension.extension:offset.url"> <path value="Extension.extension.url"/> <representation value="xmlAttr"/> <short value="identifies the meaning of the extension"/> <definition value="Source of the definition for the extension code - a logical name or a URL."/> <comment value="The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension."/> <min value="1"/> <max value="1"/> <base> <path value="Extension.url"/> <min value="1"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <fixedUri value="offset"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Extension.extension:offset.valueQuantity"> <path value="Extension.extension.valueQuantity"/> <short value="Value of extension"/> <definition value="Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list)."/> <min value="0"/> <max value="1"/> <base> <path value="Extension.value[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Quantity"/> </type> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="OffsetUnit"/> </extension> <strength value="required"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/units-of-time"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Extension.url"> <path value="Extension.url"/> <representation value="xmlAttr"/> <short value="identifies the meaning of the extension"/> <definition value="Source of the definition for the extension code - a logical name or a URL."/> <comment value="The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension."/> <min value="1"/> <max value="1"/> <base> <path value="Extension.url"/> <min value="1"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <fixedUri value="http://hl7.org/fhir/StructureDefinition/observation-eventTiming"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]"/> <short value="Value of extension"/> <definition value="Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list)."/> <min value="0"/> <max value="0"/> <base> <path value="Extension.value[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="base64Binary"/> </type> <type> <code value="boolean"/> </type> <type> <code value="code"/> </type> <type> <code value="date"/> </type> <type> <code value="dateTime"/> </type> <type> <code value="decimal"/> </type> <type> <code value="id"/> </type> <type> <code value="instant"/> </type> <type> <code value="integer"/> </type> <type> <code value="markdown"/> </type> <type> <code value="oid"/> </type> <type> <code value="positiveInt"/> </type> <type> <code value="string"/> </type> <type> <code value="time"/> </type> <type> <code value="unsignedInt"/> </type> <type> <code value="uri"/> </type> <type> <code value="Address"/> </type> <type> <code value="Age"/> </type> <type> <code value="Annotation"/> </type> <type> <code value="Attachment"/> </type> <type> <code value="CodeableConcept"/> </type> <type> <code value="Coding"/> </type> <type> <code value="ContactPoint"/> </type> <type> <code value="Count"/> </type> <type> <code value="Distance"/> </type> <type> <code value="Duration"/> </type> <type> <code value="HumanName"/> </type> <type> <code value="Identifier"/> </type> <type> <code value="Money"/> </type> <type> <code value="Period"/> </type> <type> <code value="Quantity"/> </type> <type> <code value="Range"/> </type> <type> <code value="Ratio"/> </type> <type> <code value="Reference"/> </type> <type> <code value="SampledData"/> </type> <type> <code value="Signature"/> </type> <type> <code value="Timing"/> </type> <type> <code value="Meta"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> </snapshot> <differential> <element id="Extension"> <path value="Extension"/> <short value="Approximate time of observation"/> <definition value="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")."/> <min value="0"/> <max value="*"/> <mapping> <identity value="rim"/> <map value="effectiveTime"/> </mapping> </element> <element id="Extension.extension:code"> <path value="Extension.extension"/> <sliceName value="code"/> <short value="Life events"/> <definition value="Real world event that coincides with the effective time of the observation."/> <comment value="For text only time the `.text` element can be used. (e.g. "right before I walked the dog")."/> <min value="0"/> <max value="1"/> <type> <code value="Extension"/> </type> </element> <element id="Extension.extension:code.extension"> <path value="Extension.extension.extension"/> <max value="0"/> </element> <element id="Extension.extension:code.url"> <path value="Extension.extension.url"/> <type> <code value="uri"/> </type> <fixedUri value="code"/> </element> <element id="Extension.extension:code.valueCodeableConcept"> <path value="Extension.extension.valueCodeableConcept"/> <type> <code value="CodeableConcept"/> </type> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="EventCode"/> </extension> <strength value="extensible"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/v3-TimingEvent"/> </valueSetReference> </binding> </element> <element id="Extension.extension:offset"> <path value="Extension.extension"/> <sliceName value="offset"/> <short value="How close to event"/> <definition value="The 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)."/> <comment value="Avoid nonsensical combinations of code and offset such as an offset = 30 minutes before and a code = after dinner."/> <min value="0"/> <max value="1"/> <type> <code value="Extension"/> </type> </element> <element id="Extension.extension:offset.extension"> <path value="Extension.extension.extension"/> <max value="0"/> </element> <element id="Extension.extension:offset.url"> <path value="Extension.extension.url"/> <type> <code value="uri"/> </type> <fixedUri value="offset"/> </element> <element id="Extension.extension:offset.valueQuantity"> <path value="Extension.extension.valueQuantity"/> <type> <code value="Quantity"/> </type> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="OffsetUnit"/> </extension> <strength value="required"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/units-of-time"/> </valueSetReference> </binding> </element> <element id="Extension.url"> <path value="Extension.url"/> <type> <code value="uri"/> </type> <fixedUri value="http://hl7.org/fhir/StructureDefinition/observation-eventTiming"/> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]"/> <min value="0"/> <max value="0"/> </element> </differential> </StructureDefinition>
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.