Personal Health Device Implementation Guide
3.0.0-ballot - STU 3 Ballot Global (Whole world)

Personal Health Device Implementation Guide, published by HL7 International / Devices. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/phd/ and changes regularly. See the Directory of published versions

Resource Profile: PhdCoincidentTimeStampObservation

Official URL: http://hl7.org/fhir/uv/phd/StructureDefinition/PhdCoincidentTimeStampObservation Version: 3.0.0-ballot
Standards status: Trial-use Maturity Level: 2 * Computable Name: PhdCoincidentTimeStampObservation
Other Identifiers: OID:2.16.840.1.113883.4.642.40.73.42.6

Observations containing a coincident timestamp.

The Coincident Timestamp Observation Profile is used to compare the timelines of the PHD with the timeline of the PHG. The primary elements are the Observation.effectiveDateTime, which has the time of the PHG at the moment of generating the observation, and the Observation.valueDateTime, Observation.valueString, or Observation.valueQuantity, which has the corresponding time of the PHD. The valueDateTime is used when the PHD reports a time-of-day clock with a UTC offset, valueString is used when it reports local time without an offset, and valueQuantity is used when the PHD uses a tick counter (relative time). The PHG reports its current time at the time it reads the (current) time of the PHD.

In remote patient monitoring, data can arrive from any location on the planet. Given that PHDs can be unsynchronized, have time clocks set by the user, default factory times, or no time clock at all, providing accurate timestamps in the Observation resources is a challenge. The Coincident Timestamp Observation provides a mechanism to report the PHD clock status and links it to the timeline of the PHG.

The status of the PHD clock is conveyed by this observation: the clock type (code), the PHD's current time (value[x]), the synchronization method (component), and, when the PHD clock is unsynchronized, a time fault (dataAbsentReason = unknown). This information is preserved and made available to consumers whenever the PHD provides it; it is not required of PHDs that do not report timestamp-status information. The PHG clock is not reported separately because a conformant PHG is required to be externally synchronized to UTC, and to report its local offset when it is known; its status is its current time in effectiveDateTime, which is omitted only when the PHD is better synchronized than the PHG.

For more details on the interpretation of the Coincident Timestamp, see the notes section below.

A PHD Observation may reference a Coincident Timestamp Observation if the measurement reported from the PHD contains a timestamp and is from the current timeline of the PHD and needed correction. It will not reference a Coincident Timestamp Observation if the measurement reported from the PHD contains no timestamp or is from an older timeline after which a time adjustment occurred.

A Coincident Timestamp Observation is created for every connection between PHG and PHD, so data duplication is not an issue. Therefore, the conditional create identifier element is not used in this profile.

If a PHD has its time clock altered during a connection, a new Coincident Timestamp Observation is generated, and all data sent after the adjustment will reference the new Coincident Timestamp Observation.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* Observation Measurements and simple assertions
Constraints: obs-6, obs-7, obs-10, obs-11, obs-12, phd-local-time-string-required, phd-local-time-string-only, phd-local-time-format
Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Observation.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Observation.contained 0..* Resource Contained, inline Resources
Observation.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
Observation.status This element is a modifier element. This element is included in summaries. 1..1 code registered | in-process | specimen-in-process | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | unknown | cannot-be-obtained
Binding: ObservationStatus (required): Codes providing the status of an observation.
Required Pattern: final (extensions allowed)
Observation.code This element is included in summaries. C 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCObsOrBoth (example): Codes identifying names of simple observations.
Observation.code.Slices for coding This element is included in summaries. 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
Observation.code.Slices for coding.coding:MDCType This element is included in summaries. 1..1 Coding The type of time clock used by the PHD
Binding: MDC Clock Types (required): MDC codes for PHD clock types
Observation.subject This element is included in summaries. 1..1 Reference(PhdDevice) Reference to the PHD device for which the coincident timestamp measurement is reported
Observation.subject.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
Observation.effective[x] This element is included in summaries. 0..1 The current time of the PHG at the current time of the PHD. Absent if PHD is better synchronized
Observation.effective[x].effectiveDateTime dateTime
Observation.effective[x].effectivePeriod Period
Observation.effective[x].effectiveTiming Timing
Observation.effective[x].effectiveInstant instant
Observation.value[x] This element is included in summaries. C 0..1 The current time of the PHD as a wallclock time (dateTime or local-time string), relative time (Quantity), or if a time fault a dataAbsentReason
Observation.value[x].valueQuantity Quantity
Observation.value[x].valueString string
Observation.value[x].valueDateTime dateTime
Observation.dataAbsentReason C 0..1 CodeableConcept Why the result value is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.dataAbsentReason.Slices for coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
Observation.dataAbsentReason.Slices for coding.coding:TimeFault This element is included in summaries. 0..1 Coding Time Fault: The PHD has a time fault

Required Pattern:
{
  "system" : "http://terminology.hl7.org/CodeSystem/data-absent-reason",
  "code" : "unknown"
}
Observation.device 1..1 Reference(PhgDevice) A reference to the device that generates the measurements or the device settings for the device
Observation.device.reference This element is included in summaries. C 1..1 string Reference to the PHG device responsible for the coincident timestamp measurement
Observation.Slices for component This element is included in summaries. C 0..* BackboneElement Component results
Slice: Unordered, Open by value:code
Observation.Slices for component.component:All Slices Content/Rules for all slices
Observation.Slices for component.component:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
Observation.Slices for component.component:All Slices.code This element is included in summaries. C 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCObsOrBoth (example): Codes identifying names of simple observations.
Observation.Slices for component.component:clockSyncMethod This element is included in summaries. C 0..1 BackboneElement Clock Synchronization Method: The method used to synchronize the clock.
Observation.Slices for component.component:clockSyncMethod.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
Observation.Slices for component.component:clockSyncMethod.code This element is included in summaries. C 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCObsOrBoth (example): Codes identifying names of simple observations.
Required Pattern:
{
  "coding" : [
    {
      "system" : "urn:iso:std:iso:11073:10101",
      "code" : "68220"
    }
  ]
}
Observation.Slices for component.component:clockSyncMethod.Slices for value[x] This element is included in summaries. C 0..1 Actual component result
Slice: Unordered, Closed by type:$this
Slicing Note: Other type slices that contain no new information are not shown in this view
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueQuantity Quantity
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueCodeableConcept CodeableConcept
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueString string
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueBoolean boolean
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueInteger integer
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueRange Range
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueRatio Ratio
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueSampledData SampledData
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueTime time
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueDateTime dateTime
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valuePeriod Period
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueAttachment Attachment
Observation.Slices for component.component:clockSyncMethod.Slices for value[x] Content/Rules for all slices
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].value[x]:valueCodeableConcept This element is included in summaries. C 0..1 CodeableConcept The clock synchronization method last used by the PHD/PHG to synchronize the clock of the PHD
Binding: MDC Time Synchronization Methods (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source Documentation
Observation.status Base required Observation Status 📍6.0.0-snapshot1 FHIR Std.

Codes providing the status of an observation.

Observation.code Base example LOINC codes with Observation or Both 📍6.0.0-snapshot1 FHIR Std.

Codes identifying names of simple observations.

Observation.code.coding:MDCType Base required MDC Clock Types 📦3.0.0-ballot This IG

MDC codes for PHD clock types

Observation.dataAbsentReason Base extensible Data Absent Reason 📍6.0.0-snapshot1 FHIR Std.

Codes specifying why the result ( Observation.value[x] ) is missing.

Observation.component.​code Base example LOINC codes with Observation or Both 📍6.0.0-snapshot1 FHIR Std.

Codes identifying names of simple observations.

Observation.component:clockSyncMethod.​code Base example LOINC codes with Observation or Both 📍6.0.0-snapshot1 FHIR Std.

Codes identifying names of simple observations.

Observation.component:clockSyncMethod.​value[x]:valueCodeableConcept Base extensible MDC Time Synchronization Methods 📦3.0.0-ballot This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
obs-6 error Observation Observation.dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.component.code is the same as Observation.code, then Observation.value SHALL NOT be present (the Observation.component.value[x] holds the value). value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
obs-10 error Observation Observation.component.dataAbsentReason SHALL only be present if Observation.component.value[x] is not present component.empty() or component.where(dataAbsentReason.exists()).all(value.empty())
obs-11 error Observation if organizer exists and organizer = true, then value[x], dataAbsentReason and component SHALL NOT be present (organizer.exists() and organizer.allTrue()) implies (value.empty() and dataAbsentReason.empty() and component.empty())
obs-12 warning Observation All observations SHOULD have a performer performer.exists()
phd-local-time-format error Observation A local-time string SHALL use the format YYYY-MM-DDThh:mm:ss with optional fractional seconds and no time-zone offset. value.ofType(string).empty() or value.ofType(string).matches('^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?$')
phd-local-time-string-only error Observation A string value SHALL only be used for an absolute-time PHD clock without a time-zone offset. value.ofType(string).exists() implies code.coding.where(system = 'urn:iso:std:iso:11073:10101' and code = '67975').exists()
phd-local-time-string-required error Observation An absolute-time PHD clock value SHALL be represented as a string because it has no time-zone offset. (code.coding.where(system = 'urn:iso:std:iso:11073:10101' and code = '67975').exists() and value.exists()) implies value.ofType(string).exists()

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* Observation Measurements and simple assertions
Constraints: phd-local-time-string-required, phd-local-time-string-only, phd-local-time-format
Observation.status 1..1 code registered | in-process | specimen-in-process | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | unknown | cannot-be-obtained
Required Pattern: final (extensions allowed)
Observation.code
Observation.code.Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
Observation.code.Slices for coding.coding:MDCType 1..1 Coding The type of time clock used by the PHD
Binding: MDC Clock Types (required): MDC codes for PHD clock types
Observation.subject 1..1 Reference(PhdDevice) Reference to the PHD device for which the coincident timestamp measurement is reported
Observation.subject.reference 1..1 string Literal reference, Relative, internal or absolute URL
Observation.effective[x] 0..1 dateTime, Period, Timing, instant The current time of the PHG at the current time of the PHD. Absent if PHD is better synchronized
Observation.value[x] 0..1 The current time of the PHD as a wallclock time (dateTime or local-time string), relative time (Quantity), or if a time fault a dataAbsentReason
Observation.value[x].valueQuantity Quantity
Observation.value[x].valueString string
Observation.value[x].valueDateTime dateTime
Observation.dataAbsentReason
Observation.dataAbsentReason.Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
Observation.dataAbsentReason.Slices for coding.coding:TimeFault 0..1 Coding Time Fault: The PHD has a time fault
Required Pattern:
{
  "system" : "http://terminology.hl7.org/CodeSystem/data-absent-reason",
  "code" : "unknown"
}
Observation.specimen 0..0 No specimen in PHD. The coincident timestamp is not associated with a specimen.
Observation.device 1..1 Reference(PhgDevice) A reference to the device that generates the measurements or the device settings for the device
Observation.device.reference 1..1 string Reference to the PHG device responsible for the coincident timestamp measurement
Observation.hasMember 0..0 No reference to a group observation in PHD. The coincident timestamp is not part of a group observation.
Observation.derivedFrom 0..0 No reference to a source observation in PHD. The coincident timestamp is not derived from another observation.
Observation.Slices for component 0..* BackboneElement Component results
Slice: Unordered, Open by value:code
Observation.Slices for component.component:clockSyncMethod 0..1 BackboneElement Clock Synchronization Method: The method used to synchronize the clock.
Observation.Slices for component.component:clockSyncMethod.code 1..1 CodeableConcept Type of component observation (code / type)
Required Pattern:
{
  "coding" : [
    {
      "system" : "urn:iso:std:iso:11073:10101",
      "code" : "68220"
    }
  ]
}
Observation.Slices for component.component:clockSyncMethod.Slices for value[x] 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period, Attachment Actual component result
Slice: Unordered, Open by type:$this
Slicing Note: Other type slices that contain no new information are not shown in this view
Observation.Slices for component.component:clockSyncMethod.Slices for value[x] Content/Rules for all slices
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].value[x]:valueCodeableConcept 0..1 CodeableConcept The clock synchronization method last used by the PHD/PHG to synchronize the clock of the PHD
Binding: MDC Time Synchronization Methods (extensible)
Observation.Slices for component.component:clockSyncMethod.dataAbsentReason 0..0 Why the component result value is missing

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source Documentation
Observation.code.coding:MDCType Base required MDC Clock Types 📦3.0.0-ballot This IG

MDC codes for PHD clock types

Observation.component:clockSyncMethod.​value[x]:valueCodeableConcept Base extensible MDC Time Synchronization Methods 📦3.0.0-ballot This IG

Constraints

Id Grade Path(s) Description Expression
phd-local-time-format error Observation A local-time string SHALL use the format YYYY-MM-DDThh:mm:ss with optional fractional seconds and no time-zone offset. value.ofType(string).empty() or value.ofType(string).matches('^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?$')
phd-local-time-string-only error Observation A string value SHALL only be used for an absolute-time PHD clock without a time-zone offset. value.ofType(string).exists() implies code.coding.where(system = 'urn:iso:std:iso:11073:10101' and code = '67975').exists()
phd-local-time-string-required error Observation An absolute-time PHD clock value SHALL be represented as a string because it has no time-zone offset. (code.coding.where(system = 'urn:iso:std:iso:11073:10101' and code = '67975').exists() and value.exists()) implies value.ofType(string).exists()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* Observation Measurements and simple assertions
Constraints: obs-6, obs-7, obs-10, obs-11, obs-12, phd-local-time-string-required, phd-local-time-string-only, phd-local-time-format
Observation.id This element is included in summaries. 0..1 id Logical id of this artifact
Observation.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Observation.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Observation.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Observation.contained 0..* Resource Contained, inline Resources
Observation.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Observation.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
Observation.identifier This element is included in summaries. 0..* Identifier Business Identifier for observation
Observation.basedOn This element is included in summaries. 0..* Reference(CarePlan | DeviceRequest | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
Observation.triggeredBy 0..* BackboneElement Triggering observation(s)
Observation.triggeredBy.id 0..1 string Unique id for inter-element referencing
Observation.triggeredBy.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Observation.triggeredBy.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
Observation.triggeredBy.observation This element is included in summaries. 1..1 Reference(Observation) Triggering observation
Observation.triggeredBy.type This element is included in summaries. 1..1 code reflex | repeat | re-run
Binding: TriggeredBytype (required): The type of TriggeredBy Observation.
Observation.triggeredBy.reason 0..1 string Reason that the observation was triggered
Observation.partOf This element is included in summaries. 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
Observation.status This element is a modifier element. This element is included in summaries. 1..1 code registered | in-process | specimen-in-process | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | unknown | cannot-be-obtained
Binding: ObservationStatus (required): Codes providing the status of an observation.
Required Pattern: final (extensions allowed)
Observation.statusReason 0..1 CodeableConcept Reason for current status
Binding: ObservationStatusReason (example): Codes identifying the reason for the current state of an observation.
Observation.category 0..* CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
Observation.code This element is included in summaries. C 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCObsOrBoth (example): Codes identifying names of simple observations.
Observation.code.id 0..1 string Unique id for inter-element referencing
Observation.code.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Observation.code.Slices for coding This element is included in summaries. 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
Observation.code.Slices for coding.coding:MDCType This element is included in summaries. 1..1 Coding The type of time clock used by the PHD
Binding: MDC Clock Types (required): MDC codes for PHD clock types
Observation.code.text This element is included in summaries. 0..1 string Plain text representation of the concept
Observation.subject This element is included in summaries. 1..1 Reference(PhdDevice) Reference to the PHD device for which the coincident timestamp measurement is reported
Observation.subject.id 0..1 string Unique id for inter-element referencing
Observation.subject.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Observation.subject.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
Observation.subject.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Observation.subject.identifier This element is included in summaries. C 0..1 Identifier Logical reference, when literal reference is not known
Observation.subject.display This element is included in summaries. C 0..1 string Text alternative for the resource
Observation.organizer This element is included in summaries. C 0..1 boolean This observation organizes/groups a set of sub-observations
Observation.encounter This element is included in summaries. 0..1 Reference(Encounter) Healthcare event during which this observation is made. If you need to place the observation within one or more episodes of care, use the workflow-episodeOfCare extension
Observation.effective[x] This element is included in summaries. 0..1 The current time of the PHG at the current time of the PHD. Absent if PHD is better synchronized
Observation.effective[x].effectiveDateTime dateTime
Observation.effective[x].effectivePeriod Period
Observation.effective[x].effectiveTiming Timing
Observation.effective[x].effectiveInstant instant
Observation.issued This element is included in summaries. 0..1 instant Date/Time this version was made available
Observation.performer This element is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson | HealthcareService | Group) Who is responsible for the observation
Observation.value[x] This element is included in summaries. C 0..1 The current time of the PHD as a wallclock time (dateTime or local-time string), relative time (Quantity), or if a time fault a dataAbsentReason
Observation.value[x].valueQuantity Quantity
Observation.value[x].valueString string
Observation.value[x].valueDateTime dateTime
Observation.dataAbsentReason C 0..1 CodeableConcept Why the result value is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.dataAbsentReason.id 0..1 string Unique id for inter-element referencing
Observation.dataAbsentReason.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Observation.dataAbsentReason.Slices for coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
Observation.dataAbsentReason.Slices for coding.coding:TimeFault This element is included in summaries. 0..1 Coding Time Fault: The PHD has a time fault

Required Pattern:
{
  "system" : "http://terminology.hl7.org/CodeSystem/data-absent-reason",
  "code" : "unknown"
}
Observation.dataAbsentReason.text This element is included in summaries. 0..1 string Plain text representation of the concept
Observation.interpretation 0..* CodeableConcept High, low, normal, etc
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
Observation.context 0..* CodeableReference(Resource) Context for understanding the observation
Binding: ObservationContextCodes (example): Codes identifying contextual factors that affect interpretation of observations.
Observation.note 0..* Annotation Comments about the observation
Observation.bodySite 0..1 CodeableConcept DEPRECATED: Observed body part
Observation.bodyStructure 0..* CodeableReference(BodyStructure) Observed body structure
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body Structures
Observation.method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (example): Methods for simple observations.
Observation.device 1..1 Reference(PhgDevice) A reference to the device that generates the measurements or the device settings for the device
Observation.device.id 0..1 string Unique id for inter-element referencing
Observation.device.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Observation.device.reference This element is included in summaries. C 1..1 string Reference to the PHG device responsible for the coincident timestamp measurement
Observation.device.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Observation.device.identifier This element is included in summaries. C 0..1 Identifier Logical reference, when literal reference is not known
Observation.device.display This element is included in summaries. C 0..1 string Text alternative for the resource
Observation.supportingDevice 0..* CodeableReference(Device) Device supporting generation of the measurement
Binding: DeviceType (example): Type of device supporting the generation of the measurement.
Observation.referenceRange C 0..* BackboneElement Provides guide for interpretation
Constraints: obs-3
Observation.referenceRange.id 0..1 string Unique id for inter-element referencing
Observation.referenceRange.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Observation.referenceRange.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
Observation.referenceRange.low C 0..1 Quantity Low Range, if relevant
Constraints: obs-13
Observation.referenceRange.high C 0..1 Quantity High Range, if relevant
Constraints: obs-14
Observation.referenceRange.normalValue 0..1 CodeableConcept Normal value, if relevant
Binding: ObservationReferenceRangeNormalValueCodes (example): Codes identifying the normal value of the observation.
Observation.referenceRange.type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
Observation.referenceRange.appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
Observation.referenceRange.age 0..1 Range Applicable age range, if relevant
Observation.referenceRange.text C 0..1 markdown Text based reference range in an observation
Observation.Slices for component This element is included in summaries. C 0..* BackboneElement Component results
Slice: Unordered, Open by value:code
Observation.Slices for component.component:All Slices Content/Rules for all slices
Observation.Slices for component.component:All Slices.id 0..1 string Unique id for inter-element referencing
Observation.Slices for component.component:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Observation.Slices for component.component:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
Observation.Slices for component.component:All Slices.code This element is included in summaries. C 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCObsOrBoth (example): Codes identifying names of simple observations.
Observation.Slices for component.component:All Slices.value[x] This element is included in summaries. C 0..1 Actual component result
Observation.Slices for component.component:All Slices.value[x].valueQuantity Quantity
Observation.Slices for component.component:All Slices.value[x].valueCodeableConcept CodeableConcept
Observation.Slices for component.component:All Slices.value[x].valueString string
Observation.Slices for component.component:All Slices.value[x].valueBoolean boolean
Observation.Slices for component.component:All Slices.value[x].valueInteger integer
Observation.Slices for component.component:All Slices.value[x].valueRange Range
Observation.Slices for component.component:All Slices.value[x].valueRatio Ratio
Observation.Slices for component.component:All Slices.value[x].valueSampledData SampledData
Observation.Slices for component.component:All Slices.value[x].valueTime time
Observation.Slices for component.component:All Slices.value[x].valueDateTime dateTime
Observation.Slices for component.component:All Slices.value[x].valuePeriod Period
Observation.Slices for component.component:All Slices.value[x].valueAttachment Attachment
Observation.Slices for component.component:All Slices.dataAbsentReason C 0..1 CodeableConcept Why the component result value is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.Slices for component.component:All Slices.interpretation 0..* CodeableConcept High, low, normal, etc
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
Observation.Slices for component.component:All Slices.referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result value
Observation.Slices for component.component:clockSyncMethod This element is included in summaries. C 0..1 BackboneElement Clock Synchronization Method: The method used to synchronize the clock.
Observation.Slices for component.component:clockSyncMethod.id 0..1 string Unique id for inter-element referencing
Observation.Slices for component.component:clockSyncMethod.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Observation.Slices for component.component:clockSyncMethod.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
Observation.Slices for component.component:clockSyncMethod.code This element is included in summaries. C 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCObsOrBoth (example): Codes identifying names of simple observations.
Required Pattern:
{
  "coding" : [
    {
      "system" : "urn:iso:std:iso:11073:10101",
      "code" : "68220"
    }
  ]
}
Observation.Slices for component.component:clockSyncMethod.Slices for value[x] This element is included in summaries. C 0..1 Actual component result
Slice: Unordered, Closed by type:$this
Slicing Note: Other type slices that contain no new information are not shown in this view
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueQuantity Quantity
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueCodeableConcept CodeableConcept
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueString string
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueBoolean boolean
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueInteger integer
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueRange Range
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueRatio Ratio
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueSampledData SampledData
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueTime time
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueDateTime dateTime
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valuePeriod Period
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueAttachment Attachment
Observation.Slices for component.component:clockSyncMethod.Slices for value[x] Content/Rules for all slices
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].value[x]:valueCodeableConcept This element is included in summaries. C 0..1 CodeableConcept The clock synchronization method last used by the PHD/PHG to synchronize the clock of the PHD
Binding: MDC Time Synchronization Methods (extensible)
Observation.Slices for component.component:clockSyncMethod.interpretation 0..* CodeableConcept High, low, normal, etc
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
Observation.Slices for component.component:clockSyncMethod.referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result value

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source Documentation
Observation.language Base required All Languages 📍6.0.0-snapshot1 FHIR Std.

IETF language tag for a human language

Observation.triggeredBy.​type Base required triggered Bytype 📍6.0.0-snapshot1 FHIR Std.

The type of TriggeredBy Observation.

Observation.status Base required Observation Status 📍6.0.0-snapshot1 FHIR Std.

Codes providing the status of an observation.

Observation.statusReason Base example Observation Status Reason 📍6.0.0-snapshot1 FHIR Std.

Codes identifying the reason for the current state of an observation.

Observation.category Base preferred Observation Category Codes 📍6.0.0-snapshot1 FHIR Std.

Codes for high level observation categories.

Observation.code Base example LOINC codes with Observation or Both 📍6.0.0-snapshot1 FHIR Std.

Codes identifying names of simple observations.

Observation.code.coding:MDCType Base required MDC Clock Types 📦3.0.0-ballot This IG

MDC codes for PHD clock types

Observation.subject.​type Base extensible Resource Types 📍6.0.0-snapshot1 FHIR Std.

Aa resource (or, for logical models, the URI of the logical model).

Observation.dataAbsentReason Base extensible Data Absent Reason 📍6.0.0-snapshot1 FHIR Std.

Codes specifying why the result ( Observation.value[x] ) is missing.

Observation.interpretation Base extensible Observation Interpretation Codes 📍6.0.0-snapshot1 FHIR Std.

Codes identifying interpretations of observations.

Observation.context Base example Observation Context Codes 📍6.0.0-snapshot1 FHIR Std.

Codes identifying contextual factors that affect interpretation of observations.

Observation.bodyStructure Base example SNOMED CT Body Structures 📍6.0.0-snapshot1 FHIR Std.

SNOMED CT Body Structures

Observation.method Base example Observation Methods 📍6.0.0-snapshot1 FHIR Std.

Methods for simple observations.

Observation.device.type Base extensible Resource Types 📍6.0.0-snapshot1 FHIR Std.

Aa resource (or, for logical models, the URI of the logical model).

Observation.supportingDevice Base example Device Type 📍6.0.0-snapshot1 FHIR Std.

Type of device supporting the generation of the measurement.

Observation.referenceRange.​normalValue Base example Observation Reference Range Normal Value Codes 📍6.0.0-snapshot1 FHIR Std.

Codes identifying the normal value of the observation.

Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📍6.0.0-snapshot1 FHIR Std.

Code for the meaning of a reference range.

Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📍6.0.0-snapshot1 FHIR Std.

Codes identifying the population the reference range applies to.

Observation.component.​code Base example LOINC codes with Observation or Both 📍6.0.0-snapshot1 FHIR Std.

Codes identifying names of simple observations.

Observation.component.​dataAbsentReason Base extensible Data Absent Reason 📍6.0.0-snapshot1 FHIR Std.

Codes specifying why the result ( Observation.value[x] ) is missing.

Observation.component.​interpretation Base extensible Observation Interpretation Codes 📍6.0.0-snapshot1 FHIR Std.

Codes identifying interpretations of observations.

Observation.component:clockSyncMethod.​code Base example LOINC codes with Observation or Both 📍6.0.0-snapshot1 FHIR Std.

Codes identifying names of simple observations.

Observation.component:clockSyncMethod.​value[x]:valueCodeableConcept Base extensible MDC Time Synchronization Methods 📦3.0.0-ballot This IG
Observation.component:clockSyncMethod.​interpretation Base extensible Observation Interpretation Codes 📍6.0.0-snapshot1 FHIR Std.

Codes identifying interpretations of observations.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
obs-6 error Observation Observation.dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.component.code is the same as Observation.code, then Observation.value SHALL NOT be present (the Observation.component.value[x] holds the value). value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
obs-10 error Observation Observation.component.dataAbsentReason SHALL only be present if Observation.component.value[x] is not present component.empty() or component.where(dataAbsentReason.exists()).all(value.empty())
obs-11 error Observation if organizer exists and organizer = true, then value[x], dataAbsentReason and component SHALL NOT be present (organizer.exists() and organizer.allTrue()) implies (value.empty() and dataAbsentReason.empty() and component.empty())
obs-12 warning Observation All observations SHOULD have a performer performer.exists()
obs-13 error Observation.referenceRange.low If low.comparator exists, it must be '>=' or '>'. comparator.exists() implies (comparator = '>=' or comparator = '>')
obs-14 error Observation.referenceRange.high If high.comparator exists, it must be '<=' or '<'. comparator.exists() implies (comparator = '<=' or comparator = '<')
phd-local-time-format error Observation A local-time string SHALL use the format YYYY-MM-DDThh:mm:ss with optional fractional seconds and no time-zone offset. value.ofType(string).empty() or value.ofType(string).matches('^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?$')
phd-local-time-string-only error Observation A string value SHALL only be used for an absolute-time PHD clock without a time-zone offset. value.ofType(string).exists() implies code.coding.where(system = 'urn:iso:std:iso:11073:10101' and code = '67975').exists()
phd-local-time-string-required error Observation An absolute-time PHD clock value SHALL be represented as a string because it has no time-zone offset. (code.coding.where(system = 'urn:iso:std:iso:11073:10101' and code = '67975').exists() and value.exists()) implies value.ofType(string).exists()

This structure is derived from Observation

Summary

Mandatory: 6 elements
Prohibited: 5 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Observation.code.coding
  • The element 1 is sliced based on the value of Observation.dataAbsentReason.coding
  • The element 1 is sliced based on the value of Observation.component
  • The element 1 is sliced based on the value of Observation.component.value[x]

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* Observation Measurements and simple assertions
Constraints: obs-6, obs-7, obs-10, obs-11, obs-12, phd-local-time-string-required, phd-local-time-string-only, phd-local-time-format
Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Observation.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Observation.contained 0..* Resource Contained, inline Resources
Observation.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
Observation.status This element is a modifier element. This element is included in summaries. 1..1 code registered | in-process | specimen-in-process | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | unknown | cannot-be-obtained
Binding: ObservationStatus (required): Codes providing the status of an observation.
Required Pattern: final (extensions allowed)
Observation.code This element is included in summaries. C 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCObsOrBoth (example): Codes identifying names of simple observations.
Observation.code.Slices for coding This element is included in summaries. 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
Observation.code.Slices for coding.coding:MDCType This element is included in summaries. 1..1 Coding The type of time clock used by the PHD
Binding: MDC Clock Types (required): MDC codes for PHD clock types
Observation.subject This element is included in summaries. 1..1 Reference(PhdDevice) Reference to the PHD device for which the coincident timestamp measurement is reported
Observation.subject.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
Observation.effective[x] This element is included in summaries. 0..1 The current time of the PHG at the current time of the PHD. Absent if PHD is better synchronized
Observation.effective[x].effectiveDateTime dateTime
Observation.effective[x].effectivePeriod Period
Observation.effective[x].effectiveTiming Timing
Observation.effective[x].effectiveInstant instant
Observation.value[x] This element is included in summaries. C 0..1 The current time of the PHD as a wallclock time (dateTime or local-time string), relative time (Quantity), or if a time fault a dataAbsentReason
Observation.value[x].valueQuantity Quantity
Observation.value[x].valueString string
Observation.value[x].valueDateTime dateTime
Observation.dataAbsentReason C 0..1 CodeableConcept Why the result value is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.dataAbsentReason.Slices for coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
Observation.dataAbsentReason.Slices for coding.coding:TimeFault This element is included in summaries. 0..1 Coding Time Fault: The PHD has a time fault

Required Pattern:
{
  "system" : "http://terminology.hl7.org/CodeSystem/data-absent-reason",
  "code" : "unknown"
}
Observation.device 1..1 Reference(PhgDevice) A reference to the device that generates the measurements or the device settings for the device
Observation.device.reference This element is included in summaries. C 1..1 string Reference to the PHG device responsible for the coincident timestamp measurement
Observation.Slices for component This element is included in summaries. C 0..* BackboneElement Component results
Slice: Unordered, Open by value:code
Observation.Slices for component.component:All Slices Content/Rules for all slices
Observation.Slices for component.component:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
Observation.Slices for component.component:All Slices.code This element is included in summaries. C 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCObsOrBoth (example): Codes identifying names of simple observations.
Observation.Slices for component.component:clockSyncMethod This element is included in summaries. C 0..1 BackboneElement Clock Synchronization Method: The method used to synchronize the clock.
Observation.Slices for component.component:clockSyncMethod.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
Observation.Slices for component.component:clockSyncMethod.code This element is included in summaries. C 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCObsOrBoth (example): Codes identifying names of simple observations.
Required Pattern:
{
  "coding" : [
    {
      "system" : "urn:iso:std:iso:11073:10101",
      "code" : "68220"
    }
  ]
}
Observation.Slices for component.component:clockSyncMethod.Slices for value[x] This element is included in summaries. C 0..1 Actual component result
Slice: Unordered, Closed by type:$this
Slicing Note: Other type slices that contain no new information are not shown in this view
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueQuantity Quantity
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueCodeableConcept CodeableConcept
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueString string
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueBoolean boolean
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueInteger integer
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueRange Range
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueRatio Ratio
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueSampledData SampledData
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueTime time
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueDateTime dateTime
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valuePeriod Period
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueAttachment Attachment
Observation.Slices for component.component:clockSyncMethod.Slices for value[x] Content/Rules for all slices
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].value[x]:valueCodeableConcept This element is included in summaries. C 0..1 CodeableConcept The clock synchronization method last used by the PHD/PHG to synchronize the clock of the PHD
Binding: MDC Time Synchronization Methods (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source Documentation
Observation.status Base required Observation Status 📍6.0.0-snapshot1 FHIR Std.

Codes providing the status of an observation.

Observation.code Base example LOINC codes with Observation or Both 📍6.0.0-snapshot1 FHIR Std.

Codes identifying names of simple observations.

Observation.code.coding:MDCType Base required MDC Clock Types 📦3.0.0-ballot This IG

MDC codes for PHD clock types

Observation.dataAbsentReason Base extensible Data Absent Reason 📍6.0.0-snapshot1 FHIR Std.

Codes specifying why the result ( Observation.value[x] ) is missing.

Observation.component.​code Base example LOINC codes with Observation or Both 📍6.0.0-snapshot1 FHIR Std.

Codes identifying names of simple observations.

Observation.component:clockSyncMethod.​code Base example LOINC codes with Observation or Both 📍6.0.0-snapshot1 FHIR Std.

Codes identifying names of simple observations.

Observation.component:clockSyncMethod.​value[x]:valueCodeableConcept Base extensible MDC Time Synchronization Methods 📦3.0.0-ballot This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
obs-6 error Observation Observation.dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.component.code is the same as Observation.code, then Observation.value SHALL NOT be present (the Observation.component.value[x] holds the value). value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
obs-10 error Observation Observation.component.dataAbsentReason SHALL only be present if Observation.component.value[x] is not present component.empty() or component.where(dataAbsentReason.exists()).all(value.empty())
obs-11 error Observation if organizer exists and organizer = true, then value[x], dataAbsentReason and component SHALL NOT be present (organizer.exists() and organizer.allTrue()) implies (value.empty() and dataAbsentReason.empty() and component.empty())
obs-12 warning Observation All observations SHOULD have a performer performer.exists()
phd-local-time-format error Observation A local-time string SHALL use the format YYYY-MM-DDThh:mm:ss with optional fractional seconds and no time-zone offset. value.ofType(string).empty() or value.ofType(string).matches('^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?$')
phd-local-time-string-only error Observation A string value SHALL only be used for an absolute-time PHD clock without a time-zone offset. value.ofType(string).exists() implies code.coding.where(system = 'urn:iso:std:iso:11073:10101' and code = '67975').exists()
phd-local-time-string-required error Observation An absolute-time PHD clock value SHALL be represented as a string because it has no time-zone offset. (code.coding.where(system = 'urn:iso:std:iso:11073:10101' and code = '67975').exists() and value.exists()) implies value.ofType(string).exists()

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* Observation Measurements and simple assertions
Constraints: phd-local-time-string-required, phd-local-time-string-only, phd-local-time-format
Observation.status 1..1 code registered | in-process | specimen-in-process | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | unknown | cannot-be-obtained
Required Pattern: final (extensions allowed)
Observation.code
Observation.code.Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
Observation.code.Slices for coding.coding:MDCType 1..1 Coding The type of time clock used by the PHD
Binding: MDC Clock Types (required): MDC codes for PHD clock types
Observation.subject 1..1 Reference(PhdDevice) Reference to the PHD device for which the coincident timestamp measurement is reported
Observation.subject.reference 1..1 string Literal reference, Relative, internal or absolute URL
Observation.focus 0..0 No focus in PHD. The coincident timestamp is not associated with a focus.
Observation.effective[x] 0..1 dateTime, Period, Timing, instant The current time of the PHG at the current time of the PHD. Absent if PHD is better synchronized
Observation.value[x] 0..1 The current time of the PHD as a wallclock time (dateTime or local-time string), relative time (Quantity), or if a time fault a dataAbsentReason
Observation.value[x].valueQuantity Quantity
Observation.value[x].valueString string
Observation.value[x].valueDateTime dateTime
Observation.dataAbsentReason
Observation.dataAbsentReason.Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
Observation.dataAbsentReason.Slices for coding.coding:TimeFault 0..1 Coding Time Fault: The PHD has a time fault
Required Pattern:
{
  "system" : "http://terminology.hl7.org/CodeSystem/data-absent-reason",
  "code" : "unknown"
}
Observation.specimen 0..0 No specimen in PHD. The coincident timestamp is not associated with a specimen.
Observation.device 1..1 Reference(PhgDevice) A reference to the device that generates the measurements or the device settings for the device
Observation.device.reference 1..1 string Reference to the PHG device responsible for the coincident timestamp measurement
Observation.hasMember 0..0 No reference to a group observation in PHD. The coincident timestamp is not part of a group observation.
Observation.derivedFrom 0..0 No reference to a source observation in PHD. The coincident timestamp is not derived from another observation.
Observation.Slices for component 0..* BackboneElement Component results
Slice: Unordered, Open by value:code
Observation.Slices for component.component:clockSyncMethod 0..1 BackboneElement Clock Synchronization Method: The method used to synchronize the clock.
Observation.Slices for component.component:clockSyncMethod.code 1..1 CodeableConcept Type of component observation (code / type)
Required Pattern:
{
  "coding" : [
    {
      "system" : "urn:iso:std:iso:11073:10101",
      "code" : "68220"
    }
  ]
}
Observation.Slices for component.component:clockSyncMethod.Slices for value[x] 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period, Attachment Actual component result
Slice: Unordered, Open by type:$this
Slicing Note: Other type slices that contain no new information are not shown in this view
Observation.Slices for component.component:clockSyncMethod.Slices for value[x] Content/Rules for all slices
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].value[x]:valueCodeableConcept 0..1 CodeableConcept The clock synchronization method last used by the PHD/PHG to synchronize the clock of the PHD
Binding: MDC Time Synchronization Methods (extensible)
Observation.Slices for component.component:clockSyncMethod.dataAbsentReason 0..0 Why the component result value is missing

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source Documentation
Observation.code.coding:MDCType Base required MDC Clock Types 📦3.0.0-ballot This IG

MDC codes for PHD clock types

Observation.component:clockSyncMethod.​value[x]:valueCodeableConcept Base extensible MDC Time Synchronization Methods 📦3.0.0-ballot This IG

Constraints

Id Grade Path(s) Description Expression
phd-local-time-format error Observation A local-time string SHALL use the format YYYY-MM-DDThh:mm:ss with optional fractional seconds and no time-zone offset. value.ofType(string).empty() or value.ofType(string).matches('^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?$')
phd-local-time-string-only error Observation A string value SHALL only be used for an absolute-time PHD clock without a time-zone offset. value.ofType(string).exists() implies code.coding.where(system = 'urn:iso:std:iso:11073:10101' and code = '67975').exists()
phd-local-time-string-required error Observation An absolute-time PHD clock value SHALL be represented as a string because it has no time-zone offset. (code.coding.where(system = 'urn:iso:std:iso:11073:10101' and code = '67975').exists() and value.exists()) implies value.ofType(string).exists()

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* Observation Measurements and simple assertions
Constraints: obs-6, obs-7, obs-10, obs-11, obs-12, phd-local-time-string-required, phd-local-time-string-only, phd-local-time-format
Observation.id This element is included in summaries. 0..1 id Logical id of this artifact
Observation.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Observation.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Observation.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Observation.contained 0..* Resource Contained, inline Resources
Observation.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Observation.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
Observation.identifier This element is included in summaries. 0..* Identifier Business Identifier for observation
Observation.basedOn This element is included in summaries. 0..* Reference(CarePlan | DeviceRequest | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
Observation.triggeredBy 0..* BackboneElement Triggering observation(s)
Observation.triggeredBy.id 0..1 string Unique id for inter-element referencing
Observation.triggeredBy.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Observation.triggeredBy.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
Observation.triggeredBy.observation This element is included in summaries. 1..1 Reference(Observation) Triggering observation
Observation.triggeredBy.type This element is included in summaries. 1..1 code reflex | repeat | re-run
Binding: TriggeredBytype (required): The type of TriggeredBy Observation.
Observation.triggeredBy.reason 0..1 string Reason that the observation was triggered
Observation.partOf This element is included in summaries. 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
Observation.status This element is a modifier element. This element is included in summaries. 1..1 code registered | in-process | specimen-in-process | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | unknown | cannot-be-obtained
Binding: ObservationStatus (required): Codes providing the status of an observation.
Required Pattern: final (extensions allowed)
Observation.statusReason 0..1 CodeableConcept Reason for current status
Binding: ObservationStatusReason (example): Codes identifying the reason for the current state of an observation.
Observation.category 0..* CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
Observation.code This element is included in summaries. C 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCObsOrBoth (example): Codes identifying names of simple observations.
Observation.code.id 0..1 string Unique id for inter-element referencing
Observation.code.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Observation.code.Slices for coding This element is included in summaries. 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
Observation.code.Slices for coding.coding:MDCType This element is included in summaries. 1..1 Coding The type of time clock used by the PHD
Binding: MDC Clock Types (required): MDC codes for PHD clock types
Observation.code.text This element is included in summaries. 0..1 string Plain text representation of the concept
Observation.subject This element is included in summaries. 1..1 Reference(PhdDevice) Reference to the PHD device for which the coincident timestamp measurement is reported
Observation.subject.id 0..1 string Unique id for inter-element referencing
Observation.subject.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Observation.subject.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
Observation.subject.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Observation.subject.identifier This element is included in summaries. C 0..1 Identifier Logical reference, when literal reference is not known
Observation.subject.display This element is included in summaries. C 0..1 string Text alternative for the resource
Observation.organizer This element is included in summaries. C 0..1 boolean This observation organizes/groups a set of sub-observations
Observation.encounter This element is included in summaries. 0..1 Reference(Encounter) Healthcare event during which this observation is made. If you need to place the observation within one or more episodes of care, use the workflow-episodeOfCare extension
Observation.effective[x] This element is included in summaries. 0..1 The current time of the PHG at the current time of the PHD. Absent if PHD is better synchronized
Observation.effective[x].effectiveDateTime dateTime
Observation.effective[x].effectivePeriod Period
Observation.effective[x].effectiveTiming Timing
Observation.effective[x].effectiveInstant instant
Observation.issued This element is included in summaries. 0..1 instant Date/Time this version was made available
Observation.performer This element is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson | HealthcareService | Group) Who is responsible for the observation
Observation.value[x] This element is included in summaries. C 0..1 The current time of the PHD as a wallclock time (dateTime or local-time string), relative time (Quantity), or if a time fault a dataAbsentReason
Observation.value[x].valueQuantity Quantity
Observation.value[x].valueString string
Observation.value[x].valueDateTime dateTime
Observation.dataAbsentReason C 0..1 CodeableConcept Why the result value is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.dataAbsentReason.id 0..1 string Unique id for inter-element referencing
Observation.dataAbsentReason.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Observation.dataAbsentReason.Slices for coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
Observation.dataAbsentReason.Slices for coding.coding:TimeFault This element is included in summaries. 0..1 Coding Time Fault: The PHD has a time fault

Required Pattern:
{
  "system" : "http://terminology.hl7.org/CodeSystem/data-absent-reason",
  "code" : "unknown"
}
Observation.dataAbsentReason.text This element is included in summaries. 0..1 string Plain text representation of the concept
Observation.interpretation 0..* CodeableConcept High, low, normal, etc
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
Observation.context 0..* CodeableReference(Resource) Context for understanding the observation
Binding: ObservationContextCodes (example): Codes identifying contextual factors that affect interpretation of observations.
Observation.note 0..* Annotation Comments about the observation
Observation.bodySite 0..1 CodeableConcept DEPRECATED: Observed body part
Observation.bodyStructure 0..* CodeableReference(BodyStructure) Observed body structure
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body Structures
Observation.method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (example): Methods for simple observations.
Observation.device 1..1 Reference(PhgDevice) A reference to the device that generates the measurements or the device settings for the device
Observation.device.id 0..1 string Unique id for inter-element referencing
Observation.device.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Observation.device.reference This element is included in summaries. C 1..1 string Reference to the PHG device responsible for the coincident timestamp measurement
Observation.device.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Observation.device.identifier This element is included in summaries. C 0..1 Identifier Logical reference, when literal reference is not known
Observation.device.display This element is included in summaries. C 0..1 string Text alternative for the resource
Observation.supportingDevice 0..* CodeableReference(Device) Device supporting generation of the measurement
Binding: DeviceType (example): Type of device supporting the generation of the measurement.
Observation.referenceRange C 0..* BackboneElement Provides guide for interpretation
Constraints: obs-3
Observation.referenceRange.id 0..1 string Unique id for inter-element referencing
Observation.referenceRange.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Observation.referenceRange.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
Observation.referenceRange.low C 0..1 Quantity Low Range, if relevant
Constraints: obs-13
Observation.referenceRange.high C 0..1 Quantity High Range, if relevant
Constraints: obs-14
Observation.referenceRange.normalValue 0..1 CodeableConcept Normal value, if relevant
Binding: ObservationReferenceRangeNormalValueCodes (example): Codes identifying the normal value of the observation.
Observation.referenceRange.type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
Observation.referenceRange.appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
Observation.referenceRange.age 0..1 Range Applicable age range, if relevant
Observation.referenceRange.text C 0..1 markdown Text based reference range in an observation
Observation.Slices for component This element is included in summaries. C 0..* BackboneElement Component results
Slice: Unordered, Open by value:code
Observation.Slices for component.component:All Slices Content/Rules for all slices
Observation.Slices for component.component:All Slices.id 0..1 string Unique id for inter-element referencing
Observation.Slices for component.component:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Observation.Slices for component.component:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
Observation.Slices for component.component:All Slices.code This element is included in summaries. C 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCObsOrBoth (example): Codes identifying names of simple observations.
Observation.Slices for component.component:All Slices.value[x] This element is included in summaries. C 0..1 Actual component result
Observation.Slices for component.component:All Slices.value[x].valueQuantity Quantity
Observation.Slices for component.component:All Slices.value[x].valueCodeableConcept CodeableConcept
Observation.Slices for component.component:All Slices.value[x].valueString string
Observation.Slices for component.component:All Slices.value[x].valueBoolean boolean
Observation.Slices for component.component:All Slices.value[x].valueInteger integer
Observation.Slices for component.component:All Slices.value[x].valueRange Range
Observation.Slices for component.component:All Slices.value[x].valueRatio Ratio
Observation.Slices for component.component:All Slices.value[x].valueSampledData SampledData
Observation.Slices for component.component:All Slices.value[x].valueTime time
Observation.Slices for component.component:All Slices.value[x].valueDateTime dateTime
Observation.Slices for component.component:All Slices.value[x].valuePeriod Period
Observation.Slices for component.component:All Slices.value[x].valueAttachment Attachment
Observation.Slices for component.component:All Slices.dataAbsentReason C 0..1 CodeableConcept Why the component result value is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.Slices for component.component:All Slices.interpretation 0..* CodeableConcept High, low, normal, etc
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
Observation.Slices for component.component:All Slices.referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result value
Observation.Slices for component.component:clockSyncMethod This element is included in summaries. C 0..1 BackboneElement Clock Synchronization Method: The method used to synchronize the clock.
Observation.Slices for component.component:clockSyncMethod.id 0..1 string Unique id for inter-element referencing
Observation.Slices for component.component:clockSyncMethod.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Observation.Slices for component.component:clockSyncMethod.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
Observation.Slices for component.component:clockSyncMethod.code This element is included in summaries. C 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCObsOrBoth (example): Codes identifying names of simple observations.
Required Pattern:
{
  "coding" : [
    {
      "system" : "urn:iso:std:iso:11073:10101",
      "code" : "68220"
    }
  ]
}
Observation.Slices for component.component:clockSyncMethod.Slices for value[x] This element is included in summaries. C 0..1 Actual component result
Slice: Unordered, Closed by type:$this
Slicing Note: Other type slices that contain no new information are not shown in this view
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueQuantity Quantity
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueCodeableConcept CodeableConcept
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueString string
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueBoolean boolean
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueInteger integer
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueRange Range
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueRatio Ratio
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueSampledData SampledData
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueTime time
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueDateTime dateTime
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valuePeriod Period
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].valueAttachment Attachment
Observation.Slices for component.component:clockSyncMethod.Slices for value[x] Content/Rules for all slices
Observation.Slices for component.component:clockSyncMethod.Slices for value[x].value[x]:valueCodeableConcept This element is included in summaries. C 0..1 CodeableConcept The clock synchronization method last used by the PHD/PHG to synchronize the clock of the PHD
Binding: MDC Time Synchronization Methods (extensible)
Observation.Slices for component.component:clockSyncMethod.interpretation 0..* CodeableConcept High, low, normal, etc
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
Observation.Slices for component.component:clockSyncMethod.referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result value

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source Documentation
Observation.language Base required All Languages 📍6.0.0-snapshot1 FHIR Std.

IETF language tag for a human language

Observation.triggeredBy.​type Base required triggered Bytype 📍6.0.0-snapshot1 FHIR Std.

The type of TriggeredBy Observation.

Observation.status Base required Observation Status 📍6.0.0-snapshot1 FHIR Std.

Codes providing the status of an observation.

Observation.statusReason Base example Observation Status Reason 📍6.0.0-snapshot1 FHIR Std.

Codes identifying the reason for the current state of an observation.

Observation.category Base preferred Observation Category Codes 📍6.0.0-snapshot1 FHIR Std.

Codes for high level observation categories.

Observation.code Base example LOINC codes with Observation or Both 📍6.0.0-snapshot1 FHIR Std.

Codes identifying names of simple observations.

Observation.code.coding:MDCType Base required MDC Clock Types 📦3.0.0-ballot This IG

MDC codes for PHD clock types

Observation.subject.​type Base extensible Resource Types 📍6.0.0-snapshot1 FHIR Std.

Aa resource (or, for logical models, the URI of the logical model).

Observation.dataAbsentReason Base extensible Data Absent Reason 📍6.0.0-snapshot1 FHIR Std.

Codes specifying why the result ( Observation.value[x] ) is missing.

Observation.interpretation Base extensible Observation Interpretation Codes 📍6.0.0-snapshot1 FHIR Std.

Codes identifying interpretations of observations.

Observation.context Base example Observation Context Codes 📍6.0.0-snapshot1 FHIR Std.

Codes identifying contextual factors that affect interpretation of observations.

Observation.bodyStructure Base example SNOMED CT Body Structures 📍6.0.0-snapshot1 FHIR Std.

SNOMED CT Body Structures

Observation.method Base example Observation Methods 📍6.0.0-snapshot1 FHIR Std.

Methods for simple observations.

Observation.device.type Base extensible Resource Types 📍6.0.0-snapshot1 FHIR Std.

Aa resource (or, for logical models, the URI of the logical model).

Observation.supportingDevice Base example Device Type 📍6.0.0-snapshot1 FHIR Std.

Type of device supporting the generation of the measurement.

Observation.referenceRange.​normalValue Base example Observation Reference Range Normal Value Codes 📍6.0.0-snapshot1 FHIR Std.

Codes identifying the normal value of the observation.

Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📍6.0.0-snapshot1 FHIR Std.

Code for the meaning of a reference range.

Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📍6.0.0-snapshot1 FHIR Std.

Codes identifying the population the reference range applies to.

Observation.component.​code Base example LOINC codes with Observation or Both 📍6.0.0-snapshot1 FHIR Std.

Codes identifying names of simple observations.

Observation.component.​dataAbsentReason Base extensible Data Absent Reason 📍6.0.0-snapshot1 FHIR Std.

Codes specifying why the result ( Observation.value[x] ) is missing.

Observation.component.​interpretation Base extensible Observation Interpretation Codes 📍6.0.0-snapshot1 FHIR Std.

Codes identifying interpretations of observations.

Observation.component:clockSyncMethod.​code Base example LOINC codes with Observation or Both 📍6.0.0-snapshot1 FHIR Std.

Codes identifying names of simple observations.

Observation.component:clockSyncMethod.​value[x]:valueCodeableConcept Base extensible MDC Time Synchronization Methods 📦3.0.0-ballot This IG
Observation.component:clockSyncMethod.​interpretation Base extensible Observation Interpretation Codes 📍6.0.0-snapshot1 FHIR Std.

Codes identifying interpretations of observations.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
obs-6 error Observation Observation.dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.component.code is the same as Observation.code, then Observation.value SHALL NOT be present (the Observation.component.value[x] holds the value). value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
obs-10 error Observation Observation.component.dataAbsentReason SHALL only be present if Observation.component.value[x] is not present component.empty() or component.where(dataAbsentReason.exists()).all(value.empty())
obs-11 error Observation if organizer exists and organizer = true, then value[x], dataAbsentReason and component SHALL NOT be present (organizer.exists() and organizer.allTrue()) implies (value.empty() and dataAbsentReason.empty() and component.empty())
obs-12 warning Observation All observations SHOULD have a performer performer.exists()
obs-13 error Observation.referenceRange.low If low.comparator exists, it must be '>=' or '>'. comparator.exists() implies (comparator = '>=' or comparator = '>')
obs-14 error Observation.referenceRange.high If high.comparator exists, it must be '<=' or '<'. comparator.exists() implies (comparator = '<=' or comparator = '<')
phd-local-time-format error Observation A local-time string SHALL use the format YYYY-MM-DDThh:mm:ss with optional fractional seconds and no time-zone offset. value.ofType(string).empty() or value.ofType(string).matches('^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?$')
phd-local-time-string-only error Observation A string value SHALL only be used for an absolute-time PHD clock without a time-zone offset. value.ofType(string).exists() implies code.coding.where(system = 'urn:iso:std:iso:11073:10101' and code = '67975').exists()
phd-local-time-string-required error Observation An absolute-time PHD clock value SHALL be represented as a string because it has no time-zone offset. (code.coding.where(system = 'urn:iso:std:iso:11073:10101' and code = '67975').exists() and value.exists()) implies value.ofType(string).exists()

This structure is derived from Observation

Summary

Mandatory: 6 elements
Prohibited: 5 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Observation.code.coding
  • The element 1 is sliced based on the value of Observation.dataAbsentReason.coding
  • The element 1 is sliced based on the value of Observation.component
  • The element 1 is sliced based on the value of Observation.component.value[x]

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Further notes on elements and the use of the PhdCoincidentTimeObservation resource:

Code

The code element is used to report the type of time clock used by the PHD. The PHG obtains the type of time clock and its current setting by inspecting the PHD's measurement timestamp and the PHD's clock. The ACOM clock types are mapped as follows:

ACOM clock type Observation.code.coding
Wall Clock with DST and Time Zone offset Mdc#68225
Wall Clock without DST and Time Zone offset Mdc#67975
Time counter Mdc#67983

PHG Current Time → Observation.effectiveDateTime

The PHG is required to have the capability to report local time and offset to UTC. The PHG records its current time in the Observation.effectiveDateTime element regardless of the type of time clock used by the PHD unless the PHD has superior time synchronization than the PHG. In that case, the Observation.effective[x] element is not populated.

PHD Current Time → Observation.value[x]

If the PHD uses a wall clock and provides an offset to UTC, the current time of the PHD is reported in an Observation.valueDateTime element using the offset reported by the PHD. If the PHD reports local time without an offset (MDC_ATTR_TIME_ABS, code 67975), the current time is reported in Observation.valueString using the format YYYY-MM-DDThh:mm:ss with optional fractional seconds and no time-zone suffix.

If the PHD uses a time counter, the current tick time is reported in an Observation.valueQuantity element scaled to microseconds or milliseconds as appropriate for the resolution of the counter.

Mapping Tick Counters

PHDs may also use tick counters of a specified resolution that report a tick count or relative time. GHS supports resolutions of 1 second to 100 microseconds. With relative times, there is no check for which device is better synchronized. The PHG must always map the value to UTC plus offset. The PHD's current time is reported in the Observation.valueQuantity element scaled to the tick counter's resolution. This time provides the anchor time allowing the PHG to map the relative times reported in measurements to its own timeline in UTC plus offset format.

A relative timestamp value in a measurement is mapped to UTC plus offset by taking the difference between the measurement timestamp and the synchronization point's relative time. That difference is added to the synchronization point's UTC time plus offset.

For measurements derived from ECG waveform data, such as PQ, QT, or RR intervals, the derived Observation should reference the source ECG waveform Observation using Observation.derivedFrom. Calculate these intervals from the ECG waveform's original sampling timeline. The Coincident Timestamp relates that timeline to UTC for correlation and auditing; it does not replace the sampling timeline used for ECG waveform analysis.

PHD synchronization method → Observation.component.valueCodeableConcept

The PHD synchronization method is reported in the Observation.component.valueCodeableConcept element. The code is a code from the MDC Time Synchronization Methods value set. The synchronization method is present in the timestamps supported by GHS and ACOM.

If the PHD has a time fault, the Observation.value[x] element is absent, and an Observation.dataAbsentReason.coding.code element is present with the code "unknown". A time fault is reported when the PHD reports its clock is unsynchronized and when a PHD measurement indicates an unsynchronized clock.

Together, the code, value[x], synchronization-method component, and dataAbsentReason elements convey the status of the PHD clock (its type, current time, synchronization method, and whether it is faulted). These elements are populated when the PHD provides the corresponding timestamp-status information and are otherwise omitted; PHDs that do not report such information are not required to provide it. The PHG clock has no separate status representation because a conformant PHG is required to be externally synchronized to UTC.

Timestamp Mapping Execution Models

For the general timestamp-mapping guidance, see The Observation Model Timestamp.

There are two supported execution models. A PHG that has sufficient clock and source-timeline information may map timestamps and generate the Coincident Timestamp Observation itself. Alternatively, timestamp and clock-status information may be preserved and propagated through intermediary systems. The first system with both a trustworthy UTC-referenced clock and sufficient information about the source timeline may then perform the mapping and generate the Coincident Timestamp Observation. This distributed processing model is an additional supported architecture; it does not redefine the PHG. Intermediaries must preserve the information needed to perform and explain the mapping.

flowchart LR
  PHD["PHD<br/>measurement timestamp and clock information"]
  PHG["PHG with sufficient clock and<br/>source-timeline information"]
  Relay["Intermediary system or systems<br/>preserve timestamp and clock status"]
  UTC["First system with UTC reference<br/>and source-timeline information"]
  FHIR["FHIR resources"]

  PHD -->|PHD data and source-time information| PHG
  PHG -->|mapping and Coincident Timestamp| FHIR
  PHD -->|PHD data and source-time information| Relay
  Relay -->|preserved timestamp and clock information| UTC
  UTC -->|mapping and Coincident Timestamp| FHIR

Device

The Observation.device element is a reference to the Device resource representing the PHG that generated the coincident timestamp.

Logic to Report Coincident Timestamps

The PHG may use the following logic to report Coincident Timestamps and adjust PHD observation timestamps, assuming the PHD and PHG are in close proximity and share the same UTC time zone and DST offset:

Case 1: PHD Does Not Report Timestamps in Measurements

  • No Coincident Timestamp Observation is created for the measurement.
  • The PHG uses the time of reception as the measurement timestamp.

Case 2: PHD Measurement Reports a Timestamp Not from Its Current Timeline

  • The PHG reports its current time in the Coincident Timestamp Observation.effectiveDateTime element.
  • The Coincident Timestamp Observation.value[x] element is left empty.
  • The Coincident Timestamp dataAbsentReason is set to unknown.
  • If the PHD measurement timestamp contains a UTC or local time and reports being externally synchronized:
    • The PHG reports the PHD measurement timestamps, correcting only for time zone and DST offset as needed.
  • Otherwise:
    • If the PHD measurement timestamp reports a tick counter (relative time) or indicates it is not externally synchronized:
      • The PHG cannot produce a meaningful timestamp for the measurement.
      • The PHG either reports an observation without an effective[x] element or chooses not to report the observation.

Case 3: PHD Measurement Reports a Timestamp from Its Current Timeline

  • If the PHD measurement timestamp contains a UTC or local time and reports being externally synchronized:
    • If the PHG is better synchronized than the PHD:
      • The PHG's current time is reported in the Observation.effectiveDateTime element.
      • The PHD's current time is reported in Observation.valueDateTime when it includes a UTC offset or Observation.valueString when it is local time without an offset.
      • The PHG adjusts the measurement timestamps from the PHD's current timeline by the difference.
    • If the PHD is better synchronized than the PHG:
      • The PHG's current time is not reported, leaving the Observation.effectiveDateTime element empty.
      • The PHD's current time is reported in Observation.valueDateTime when it includes a UTC offset or Observation.valueString when it is local time without an offset.
      • The PHG reports the PHD measurement timestamps, correcting for time zone and DST offset as needed.
  • Otherwise:
    • If the PHD observation contains a tick counter (relative time) or is not externally synchronized:
      • The PHG's current time is reported in the Observation.effectiveDateTime element.
      • The PHD's corresponding time is reported in the Observation.valueDateTime, Observation.valueString, or Observation.valueQuantity element.
      • The PHG maps the PHD measurement timestamp to its own timeline using the Coincident Timestamp as an anchor point.

Example

Suppose the PHG reads the current time of the PHD and finds it is six minutes behind its own time. If the PHG is better synchronized to NTP, it will add six minutes to all timestamps reported by the PHD on its current timeline.