Personal Health Device Implementation Guide
3.0.0-draft - STU 3 - R6 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-draft 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: PhdNumericObservation - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 1

Definitions for the PhdNumericObservation resource profile

Guidance on how to interpret the contents of this table can be foundhere

0. Observation
Definition

The PhdNumericObservation reports PHD measurements that contain one of either a Basic-Nu-Observed-Value, Simple-Nu_observed-Value, or Nu_observed-Value attribute.


Measurements and simple assertions made about a patient, device or other subject.

ShortSimple Numeric measurementMeasurements and simple assertions
Comments

Used for non-compound numeric observations from Personal Health Devices.


Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.

Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate NamesVital Sign, Measurement, Result, Test Performed, Observable
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
obs-6: Observation.dataAbsentReason SHALL only be present if Observation.value[x] is not present (dataAbsentReason.empty() or value.empty())
obs-7: 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: 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: 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: All observations SHOULD have a performer (performer.exists())
2. Observation.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. For DomainResources, if more than one implicitRules policy applies, additional policies may be conveyed using the additionalImplicitRules extension.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Observation.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an additional resource.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
6. Observation.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control10..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Observation.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 8. Observation.extension:GatewayDevice
    Slice NameGatewayDevice
    Definition

    Linked device acting as a communication/data collector, translator or controller.

    ShortDevice Gateway
    Control1..1
    TypeExtension(Device Gateway) (Extension Type: CodeableReference(Device))
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. Observation.extension:GatewayDevice.extension
    Definition

    An Extension


    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    ShortExtensionAdditional content defined by implementations
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..0*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on Observation.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 12. Observation.extension:GatewayDevice.url
      Definition

      Source of the definition for the extension code - a logical name or a URL.

      Shortidentifies the meaning of the extension
      Comments

      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

      Control1..1
      Typeuri
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      Fixed Valuehttp://hl7.org/fhir/StructureDefinition/device-gateway
      14. Observation.extension:CoincidentTimeStamp
      Slice NameCoincidentTimeStamp
      Definition

      Reference to a coincident timestamp observation that relates the gateway timeline to the PHD timeline

      ShortCoincident Timestamp Reference
      Control0..1
      TypeExtension(Coincident Timestamp Reference) (Extension Type: Reference(PhdCoincidentTimeStampObservation))
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      16. Observation.extension:Accuracy
      Slice NameAccuracy
      Definition

      The accuracy of a measurable quantity.

      ShortNumeric Accuracy
      Control0..1
      TypeExtension(Numeric Accuracy) (Extension Type: Quantity)
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      18. Observation.extension:Confidence95
      Slice NameConfidence95
      Definition

      The Confidence 95 range of a measurable quantity.

      ShortConfidence95
      Control0..1
      TypeExtension(Confidence 95 range) (Extension Type: Range)
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      20. Observation.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
      Must Supportfalse
      Summarytrue
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      SlicingThis element introduces a set of slices on Observation.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 22. Observation.identifier
        Definition

        A unique identifier assigned to this observation.

        ShortBusiness Identifier for observation
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control0..*
        TypeIdentifier
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Requirements

        Allows observations to be distinguished and referenced.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        SlicingThis element introduces a set of slices on Observation.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ system
        • 24. Observation.identifier:conditionalCreate
          Slice NameconditionalCreate
          Definition

          An identifier created from a combination of the measurement parameters like sensor timestamp, type code, unit code, patient and device identifier.


          A unique identifier assigned to this observation.

          ShortUnique identifier of this measurement for a given patient and deviceBusiness Identifier for observation
          Comments

          This value is used in the conditional create to prevent data duplication. PHDs will often re-send already sent data for a variety of reasons. This element is recommended unless the observation contains no timestamp or is a measurement containing a timestamp that is real time. By real time the timestamp reported by the PHD must be later than the current time reported by the PHD before any measurements are received. There might be other means to ascertain whether the data is real time. Temporarily stored data from IEEE 11073-10206 compliant devices, which are required to be deleted the data after sending, can be considered real time. An example of this are temporarily stored observations from a device implementing the Bluetooth SIG GHS profile or implementing another Bluetooth SIG medical sensor device profile.

          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..1*
          TypeIdentifier
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Requirements

          Allows observations to be distinguished in a selective enough manner to prevent resource duplication.


          Allows observations to be distinguished and referenced.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          26. Observation.identifier:conditionalCreate.use
          Definition

          The purpose of this identifier.

          Shortusual | official | temp | secondary | old (If known)
          Comments

          Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

          Control0..1
          BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|6.0.0-ballot5
          (required to http://hl7.org/fhir/ValueSet/identifier-use|6.0.0-ballot5)

          Identifies the purpose for this identifier, if known .

          Typecode
          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          28. Observation.identifier:conditionalCreate.type
          Definition

          A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

          ShortDescription of identifier
          Comments

          This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

          Control0..01
          BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type|6.0.0-ballot5
          (extensible to http://hl7.org/fhir/ValueSet/identifier-type|6.0.0-ballot5)

          A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

          TypeCodeableConcept
          Is Modifierfalse
          Summarytrue
          Requirements

          Allows users to make use of identifiers when the identifier system is not known.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          30. Observation.identifier:conditionalCreate.system
          Definition

          Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

          ShortThe namespace for the identifier value
          Comments

          Identifier.system is always case sensitive. The FHIR specification, terminology.hl7.org and HL7 affiliates (for identifiers specific to their jurisdiction) define identifier systems that SHALL be used for certain types of identifiers. Specific rules can be found here.

          Control10..1
          Typeuri
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

          Pattern Valuehttp://hl7.org/fhir/uv/phd/StructureDefinition/PhdBaseObservation
          ExampleGeneral: http://www.acme.com/identifiers/patient
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          32. Observation.identifier:conditionalCreate.value
          Definition

          The portion of the identifier typically relevant to the user and which is unique within the context of the system.

          ShortThe value that is unique
          Comments

          If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processor to be confident that non-case-sensitive processing is safe.

          Control10..1
          This element is affected by the following invariants: ident-1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          ExampleGeneral: 123456
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          34. Observation.status
          Definition

          The status of the result value. Either 'final' or 'preliminary'


          The status of the result value.

          Shortregistered | in-process | specimen-in-process | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | unknown | cannot-be-obtained
          Comments

          The value shall be set to 'final' unless a Measurement-Status attribute indicates that the measurement is preliminary. In that case this field shall be set to 'preliminary'


          This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

          Control1..1
          BindingThe codes SHALL be taken from ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|6.0.0-ballot5
          (required to http://hl7.org/fhir/ValueSet/observation-status|6.0.0-ballot5)

          Codes providing the status of an observation.

          Typecode
          Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summarytrue
          Requirements

          Need to track the status of individual results. Some results are finalized before the whole report is finalized.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          36. Observation.category
          Definition

          A code that classifies the general type of observation being made.

          ShortClassification of type of observation
          Comments

          In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set.

          Control10..*
          BindingThe codes SHOULD be taken from ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category|6.0.0-ballot5
          (preferred to http://hl7.org/fhir/ValueSet/observation-category|6.0.0-ballot5)

          Codes for high level observation categories.

          TypeCodeableConcept
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Requirements

          Used for filtering what observations are retrieved and displayed.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          SlicingThis element introduces a set of slices on Observation.category. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ $this
          • 38. Observation.category:PHD-Observation
            Slice NamePHD-Observation
            Definition

            A code that classifies the general type of observation being made.

            ShortPHD observation categoryClassification of type of observation
            Comments

            The category enables identifying observations generated by PHDs.


            In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set.

            Control10..1*
            BindingThe codes SHOULD be taken from ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category|6.0.0-ballot5
            (preferred to http://hl7.org/fhir/ValueSet/observation-category|6.0.0-ballot5)

            Codes for high level observation categories.

            TypeCodeableConcept
            Is Modifierfalse
            Must Supportfalse
            Summaryfalse
            Requirements

            Used for filtering what observations are retrieved and displayed.

            Pattern Value{
              "coding" : [{
                "system" : "http://hl7.org/fhir/uv/phd/CodeSystem/PhdObservationCategories",
                "code" : "phd"
              }]
            }
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            40. Observation.code
            Definition

            Describes what was observed. Sometimes this is called the observation "name".

            ShortType of observation (code / type)
            Comments

            All code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. All codings in Observation.code are expected to be sufficiently precise to allow a user with the code and value to be able to understand the value - though not all codes will necessarily convey the same level of detail. Codings in Observation.category SHOULD be concepts that are too broad to be able to understand the meaning of the Observation.value without also having an Observation.code.

            See Interoperability Issues using code value pairs in FHIR for additional information.

            Control1..1
            This element is affected by the following invariants: obs-7
            BindingUnless not suitable, these codes SHALL be taken from For example codes, see MDC Non-Object codeshttp://hl7.org/fhir/ValueSet/observation-codes-observationorboth|6.0.0-ballot5
            (extensible to http://hl7.org/fhir/uv/phd/ValueSet/MDCnotObject)

            IEEE 11073-10101 Nomenclature codes for PHD measurements


            Codes identifying names of simple observations.

            TypeCodeableConcept
            Is Modifierfalse
            Must Supportfalse
            Summarytrue
            Requirements

            Knowing what kind of observation is being made is essential to understanding the observation.

            Alternate NamesName
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            mdc-1: A published MDC Code is preferred but private MDC codes are allowed as well. (coding.exists() and coding.where(system = 'urn:iso:std:iso:11073:10101').exists())
            42. Observation.subject
            Definition

            The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the focus element or the code itself specifies the actual focus of the observation.

            ShortReference to the patient or the PhdDevice that is the subject of the observationWho and/or what the observation is about
            Comments

            One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all).

            Control10..1
            TypeReference(Patient, PhdDevice, Patient, Group, Device, Location, Organization, Procedure, Practitioner, Medication, Substance, BiologicallyDerivedProduct, NutritionProduct)
            Is Modifierfalse
            Must Supportfalse
            Summarytrue
            Requirements

            Observations have no value if you don't know who or what they're about.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            44. Observation.focus
            Definition

            The actual focus of an observation when it is not the subject of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. As another use case,

            a caregiver (RelatedPerson) has back strain and is unable to provide ADL support to a patient (Subject).

            ShortWhat the observation is about, when it is not about the subject of record
            Comments

            Examples demonstrating the use of subject and focus in an Observation:

            • A parent is trained to change their child's tracheostomy tube. The child is the subject, and the parent is the focus.

            • A fetal heart rate recorded in a mother's record. The mother is the subject, and the fetus is the focus.

            • Features of a body structure, such as a tumor. The patient is the subject, and the specific body structure is the focus.

            • Metrics captured from a medical device. The patient-attached device is the subject, the specific device metric is the focus, and the observing device itself is referenced in .device.

            Control0..*
            TypeReference(Resource)
            Is Modifiertrue because This element is labeled as a modifier because it changes who is the target of the observation. See the use cases in the definition.
            Must Supportfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            46. Observation.effective[x]
            Definition

            The time or time-period the observed value is asserted as being true. This can be a dateTime or a period. The value is based on the timestamp sent by the PHD or the time of reception by the PHG if the PHD sent no timestamp.


            The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.

            ShortClinically relevant time/time-period for observation
            Comments

            At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the Timing datatype which allow the measurement to be tied to regular life events.

            Control10..1
            TypeChoice of: dateTime, Period, Timing, instant
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supportfalse
            Summarytrue
            Requirements

            Knowing when an observation was deemed true is important to its relevance as well as determining trends.

            Alternate NamesOccurrence
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            SlicingThis element introduces a set of slices on Observation.effective[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
            • type @ $this
            • 48. Observation.effective[x]:effectiveDateTime
              Slice NameeffectiveDateTime
              Definition

              The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.

              ShortClinically relevant time/time-period for observation
              Comments

              At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the Timing datatype which allow the measurement to be tied to regular life events.

              Control0..1
              TypedateTime, Period, Timing, instant
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supportfalse
              Summarytrue
              Requirements

              Knowing when an observation was deemed true is important to its relevance as well as determining trends.

              Alternate NamesOccurrence
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              50. Observation.effective[x]:effectivePeriod
              Slice NameeffectivePeriod
              Definition

              The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.

              ShortClinically relevant time/time-period for observation
              Comments

              At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the Timing datatype which allow the measurement to be tied to regular life events.

              Control0..1
              TypePeriod, dateTime, Timing, instant
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Is Modifierfalse
              Must Supportfalse
              Summarytrue
              Requirements

              Knowing when an observation was deemed true is important to its relevance as well as determining trends.

              Alternate NamesOccurrence
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              52. Observation.value[x]
              Definition

              The information determined as a result of making the observation, if the information has a simple value.

              ShortActual result
              Comments
              • An observation may have:
                1. a single value here
                2. both a value and a set of related or component values
                3. only a set of related or component values.
              • If a value is present, the datatype for this element should be determined by the code.
              • CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the code defines a coded value.
              • Attachment is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the proof in this image), the binary file may be directly represented using DocumentReference and referenced by derivedFrom.
              • For additional guidance, see the Notes section below.
              • See Interoperability Issues using code value pairs in FHIR for additional information.
              Control0..1
              This element is affected by the following invariants: obs-7, obs-6, obs-11
              TypeQuantity, dateTime, boolean, string, SampledData, Period, Ratio, Attachment, integer, time, Range, CodeableConcept
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Is Modifierfalse
              Must Supportfalse
              Summarytrue
              Requirements

              An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              unit-system-code-coherent: system and code SHALL be coherent: UCUM system uses UCUM code, MDC system uses MDC code ((system = 'http://unitsofmeasure.org' implies code.memberOf('http://hl7.org/fhir/ValueSet/ucum-units')) and (system = 'urn:iso:std:iso:11073:10101' implies code.memberOf('http://hl7.org/fhir/uv/phd/ValueSet/MDCValueSet')))
              phd-dim-code: If system is MDC, code must be a partition-4 dimension code (262144-327679) (system != 'urn:iso:std:iso:11073:10101' or (code.toInteger() >= 262144 and code.toInteger() <= 327679))
              54. Observation.value[x].value
              Definition

              The decoded FLOAT or SFLOAT value from a PHD Observation.


              The value of the measured amount. The value includes an implicit precision in the presentation of the value.

              ShortNumerical value (with implicit precision)
              Comments

              The implicit precision in the value shall be honored. The MDER encoding used in the above attributes provides this precision. The translating software shall honor that precision when generating this value. This element shall be present unless there is an error reported in the Measurement-Status attribute or the MDER encoding represents one of the special FLOAT values. In that case there is a dataAbsentReason element and the valueQuantity element is not present. Note that not all measurement status values are errors resulting in no measurement being reported here; for example the preliminary or verified status.


              The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

              Control10..1
              Typedecimal
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              Precision is handled implicitly in almost all cases of measurement.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              56. Observation.value[x].comparator
              Definition

              How the value should be understood and represented - whether the actual value is greater than, less than, or approximately equal to the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

              Short< | <= | >= | > | ~ | ad - how to understand the value
              Control0..1
              BindingThe codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|6.0.0-ballot5
              (required to http://hl7.org/fhir/ValueSet/quantity-comparator|6.0.0-ballot5)

              How the Quantity should be understood and represented.

              Typecode
              Is Modifiertrue because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

              Meaning if MissingIf there is no comparator, then there is no modification of the value
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              58. Observation.value[x].unit
              Definition

              A human-readable form of the unit.

              ShortUnit representation
              Control0..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              60. Observation.value[x].system
              Definition

              The identification of the system that provides the coded form of the unit.

              ShortThe code system for the units of this measurement (UCUM or MDC).System that defines coded unit form
              Comments

              The unit code needs to be translated from the 11073-10101 code from the device. This can be represented as either a UCUM code or an MDC code system. UCUM is preferred but MDC codes are also supported.

              Control10..1
              This element is affected by the following invariants: qty-3
              Typeuri
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              Need to know the system that defines the coded form of the unit.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              system-is-mdc-or-ucum: system SHALL be either the MDC or UCUM URI ($this = 'urn:iso:std:iso:11073:10101' or $this = 'http://unitsofmeasure.org')
              62. Observation.value[x].code
              Definition

              A computer processable form of the unit in some unit representation system.

              ShortThe UCUM or MDC code for the units of this measurement.Coded form of the unit
              Comments

              The unit code needs to be translated from the 11073-10101 code from the device. This translation means that the reporting of units is not future proof.


              The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

              Control10..1
              This element is affected by the following invariants: qty-3
              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              64. Observation.dataAbsentReason
              Definition

              Provides a reason why the expected value in the element Observation.valueQuantity is missing. In this case this could also be 'not-a-number', 'positive-infinity', 'negative-infinity' or 'error'.


              Provides a reason why the expected value in the element Observation.value[x] is missing.

              ShortThis element is populated for numeric observations when a special FLOAT value is reported that is not a real number.Why the result value is missing
              Comments

              The values in the http://terminology.hl7.org/CodeSystem/data-absent-reason system do not provide a code that matches the 'not at this resolution' and 'reserved'. In those cases one uses the generic 'error' code. If both a special FLOAT value and a Measurement-Status indicating invalid, not available, or measurement ongoing are received, the Measurement-Status mapping takes precedence.


              Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory".

              The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed.

              Control0..1
              This element is affected by the following invariants: obs-6, obs-11
              BindingUnless not suitable, these codes SHALL be taken from DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason|6.0.0-ballot5
              (extensible to http://hl7.org/fhir/ValueSet/data-absent-reason|6.0.0-ballot5)

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

              TypeCodeableConcept
              Is Modifierfalse
              Must Supportfalse
              Summaryfalse
              Requirements

              For many results it is necessary to handle exceptional values in measurements.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              66. Observation.device
              Definition

              A reference to the device that generates the measurements or the device settings for the device.

              ShortA reference to the device that generates the measurements or the device settings for the device
              Comments

              This field will reference the PHD Device.


              Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.

              Control10..1
              TypeReference(PhdDevice, Device, DeviceMetric)
              Is Modifierfalse
              Must Supportfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              68. Observation.device.reference
              Definition

              Reference to the device-related resources that describe the sensor device taking the measurement. This element will point to a Device resource following the Phd Device Profile.


              A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

              ShortReference to the device responsible for the measurementLiteral reference, Relative, internal or absolute URL
              Comments

              This reference points to the Device resource containing information about the sensor device that took the measurement.


              Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

              Control10..1
              This element is affected by the following invariants: ref-2, ref-1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              70. Observation.component
              Definition

              Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.

              ShortComponent results
              Comments

              For a discussion on the ways Observations can be assembled in groups together see Notes below.

              Control0..*
              This element is affected by the following invariants: obs-7, obs-11, obs-10
              TypeBackboneElement
              Is Modifierfalse
              Must Supportfalse
              Summarytrue
              Requirements

              Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, reference range, dataAbsentReason, and interpretation can differ between the components and are not inherited; these should be provided if appropriate.

              Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
              SlicingThis element introduces a set of slices on Observation.component. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ code
              • 72. Observation.component.modifierExtension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                ShortExtensions that cannot be ignored even if unrecognized
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                Summarytrue
                Requirements

                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                Alternate Namesextensions, user content, modifiers
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                SlicingThis element introduces a set of slices on Observation.component.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 74. Observation.component.code
                  Definition

                  Describes what was observed. Sometimes this is called the observation "code".

                  ShortType of component observation (code / type)
                  Comments

                  All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

                  Control1..1
                  This element is affected by the following invariants: obs-7
                  BindingFor example codes, see LOINCObsOrBothhttp://hl7.org/fhir/ValueSet/observation-codes-observationorboth|6.0.0-ballot5
                  (example to http://hl7.org/fhir/ValueSet/observation-codes-observationorboth|6.0.0-ballot5)

                  Codes identifying names of simple observations.

                  TypeCodeableConcept
                  Is Modifierfalse
                  Must Supportfalse
                  Summarytrue
                  Requirements

                  Knowing what kind of observation is being made is essential to understanding the observation.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  76. Observation.component:supplementalTypesComponent
                  Slice NamesupplementalTypesComponent
                  Definition

                  For each code contained in the Supplemental-Types attribute, a separate component is generated. The component is not generated if the attribute is absent or empty. The component shall be generated otherwise.


                  Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.

                  ShortSupplemental Type: A further description of the measurement type.Component results
                  Comments

                  A PHD may send a Supplemental-Types attribute as part of the measurement. This attribute consists of a set of MDC nomenclature codes. Each code describes an aspect of the measurement, such as MDC_MODALITY_SPOT in the pulse oximeter which indicates that the provided measurement is a stable average.


                  For a discussion on the ways Observations can be assembled in groups together see Notes below.

                  Control0..*
                  This element is affected by the following invariants: obs-7, obs-11, obs-10
                  TypeBackboneElement
                  Is Modifierfalse
                  Must Supportfalse
                  Summarytrue
                  Requirements

                  Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, reference range, dataAbsentReason, and interpretation can differ between the components and are not inherited; these should be provided if appropriate.

                  Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
                  78. Observation.component:supplementalTypesComponent.modifierExtension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                  ShortExtensions that cannot be ignored even if unrecognized
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                  Control0..*
                  TypeExtension
                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                  Summarytrue
                  Requirements

                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                  Alternate Namesextensions, user content, modifiers
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  SlicingThis element introduces a set of slices on Observation.component.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 80. Observation.component:supplementalTypesComponent.code
                    Definition

                    68193 is the 32-bit nomenclature code indicating a 'Supplemental-Types' value


                    Describes what was observed. Sometimes this is called the observation "code".

                    ShortSupplemental-Types code (68193)Type of component observation (code / type)
                    Comments

                    All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

                    Control1..1
                    This element is affected by the following invariants: obs-7
                    BindingFor example codes, see LOINCObsOrBothhttp://hl7.org/fhir/ValueSet/observation-codes-observationorboth|6.0.0-ballot5
                    (example to http://hl7.org/fhir/ValueSet/observation-codes-observationorboth|6.0.0-ballot5)

                    Codes identifying names of simple observations.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Must Supportfalse
                    Summarytrue
                    Requirements

                    Knowing what kind of observation is being made is essential to understanding the observation.

                    Pattern Value{
                      "coding" : [{
                        "system" : "urn:iso:std:iso:11073:10101",
                        "code" : "68193"
                      }]
                    }
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    82. Observation.component:supplementalTypesComponent.dataAbsentReason
                    Definition

                    Provides a reason why the expected value in the element Observation.component.value[x] is missing.

                    ShortWhy the component result value is missing
                    Comments

                    "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done".

                    The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values.

                    Control0..01
                    This element is affected by the following invariants: obs-10
                    BindingUnless not suitable, these codes SHALL be taken from DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason|6.0.0-ballot5
                    (extensible to http://hl7.org/fhir/ValueSet/data-absent-reason|6.0.0-ballot5)

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

                    TypeCodeableConcept
                    Is Modifierfalse
                    Must Supportfalse
                    Summaryfalse
                    Requirements

                    For many results it is necessary to handle exceptional values in measurements.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

                    Guidance on how to interpret the contents of this table can be foundhere

                    0. Observation
                    Definition

                    The PhdNumericObservation reports PHD measurements that contain one of either a Basic-Nu-Observed-Value, Simple-Nu_observed-Value, or Nu_observed-Value attribute.

                    ShortSimple Numeric measurement
                    Comments

                    Used for non-compound numeric observations from Personal Health Devices.

                    2. Observation.extension:Accuracy
                    Slice NameAccuracy
                    Control0..1
                    TypeExtension(Numeric Accuracy) (Extension Type: Quantity)
                    4. Observation.extension:Confidence95
                    Slice NameConfidence95
                    Control0..1
                    TypeExtension(Confidence 95 range) (Extension Type: Range)
                    6. Observation.value[x]
                    TypeQuantity, dateTime, boolean, string, SampledData, Period, Ratio, Attachment, integer, time, Range, CodeableConcept
                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                    Invariantsunit-system-code-coherent: system and code SHALL be coherent: UCUM system uses UCUM code, MDC system uses MDC code ((system = 'http://unitsofmeasure.org' implies code.memberOf('http://hl7.org/fhir/ValueSet/ucum-units')) and (system = 'urn:iso:std:iso:11073:10101' implies code.memberOf('http://hl7.org/fhir/uv/phd/ValueSet/MDCValueSet')))
                    phd-dim-code: If system is MDC, code must be a partition-4 dimension code (262144-327679) (system != 'urn:iso:std:iso:11073:10101' or (code.toInteger() >= 262144 and code.toInteger() <= 327679))
                    8. Observation.value[x].value
                    Definition

                    The decoded FLOAT or SFLOAT value from a PHD Observation.

                    Comments

                    The implicit precision in the value shall be honored. The MDER encoding used in the above attributes provides this precision. The translating software shall honor that precision when generating this value. This element shall be present unless there is an error reported in the Measurement-Status attribute or the MDER encoding represents one of the special FLOAT values. In that case there is a dataAbsentReason element and the valueQuantity element is not present. Note that not all measurement status values are errors resulting in no measurement being reported here; for example the preliminary or verified status.

                    Control1..?
                    10. Observation.value[x].unit
                    12. Observation.value[x].system
                    ShortThe code system for the units of this measurement (UCUM or MDC).
                    Comments

                    The unit code needs to be translated from the 11073-10101 code from the device. This can be represented as either a UCUM code or an MDC code system. UCUM is preferred but MDC codes are also supported.

                    Control1..?
                    Invariantssystem-is-mdc-or-ucum: system SHALL be either the MDC or UCUM URI ($this = 'urn:iso:std:iso:11073:10101' or $this = 'http://unitsofmeasure.org')
                    14. Observation.value[x].code
                    ShortThe UCUM or MDC code for the units of this measurement.
                    Comments

                    The unit code needs to be translated from the 11073-10101 code from the device. This translation means that the reporting of units is not future proof.

                    Control1..?
                    16. Observation.dataAbsentReason
                    Definition

                    Provides a reason why the expected value in the element Observation.valueQuantity is missing. In this case this could also be 'not-a-number', 'positive-infinity', 'negative-infinity' or 'error'.

                    ShortThis element is populated for numeric observations when a special FLOAT value is reported that is not a real number.
                    Comments

                    The values in the http://terminology.hl7.org/CodeSystem/data-absent-reason system do not provide a code that matches the 'not at this resolution' and 'reserved'. In those cases one uses the generic 'error' code. If both a special FLOAT value and a Measurement-Status indicating invalid, not available, or measurement ongoing are received, the Measurement-Status mapping takes precedence.

                    Guidance on how to interpret the contents of this table can be foundhere

                    0. Observation
                    Definition

                    The PhdNumericObservation reports PHD measurements that contain one of either a Basic-Nu-Observed-Value, Simple-Nu_observed-Value, or Nu_observed-Value attribute.

                    ShortSimple Numeric measurement
                    Comments

                    Used for non-compound numeric observations from Personal Health Devices.

                    Control0..*
                    Is Modifierfalse
                    Must Supportfalse
                    Summaryfalse
                    Alternate NamesVital Sign, Measurement, Result, Test Performed, Observable
                    Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                    dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
                    dom-6: A resource should have narrative for robust management (text.`div`.exists())
                    obs-6: Observation.dataAbsentReason SHALL only be present if Observation.value[x] is not present (dataAbsentReason.empty() or value.empty())
                    obs-7: 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: 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: 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: All observations SHOULD have a performer (performer.exists())
                    2. Observation.id
                    Definition

                    The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

                    ShortLogical id of this artifact
                    Comments

                    Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resource id depends on the given use case.

                    Control0..1
                    Typeid
                    Is Modifierfalse
                    Must Supportfalse
                    Summarytrue
                    4. Observation.meta
                    Definition

                    The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

                    ShortMetadata about the resource
                    Control0..1
                    TypeMeta
                    Is Modifierfalse
                    Must Supportfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    6. Observation.meta.id
                    Definition

                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                    ShortUnique id for inter-element referencing
                    Control0..1
                    This element is affected by the following invariants: ele-1
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    8. Observation.meta.extension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    ShortAdditional content defined by implementations
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Alternate Namesextensions, user content
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    SlicingThis element introduces a set of slices on Observation.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 10. Observation.meta.versionId
                      Definition

                      The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

                      ShortVersion specific identifier
                      Comments

                      The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

                      Control0..1
                      Typeid
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      12. Observation.meta.lastUpdated
                      Definition

                      When the resource last changed - e.g. when the version changed.

                      ShortWhen the resource version last changed
                      Comments

                      This element is generally omitted in instances submitted in a PUT or POST. Instead, it might be populated by the server when data is received or assigned when crafting the instance when constructing a response. The server / resource manager sets this value; what a client provides can be irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

                      Note that there are scenarios where changes in a resource do not trigger a change in the lastUpdated value and there are scenarios where changes in lastUpdated are made even though there are no visible changes in the resource. Unless specified otherwise, this element MAY be out of sync with changes in either direction. For example:

                      • If a system uses mapping tables to generate resources (e.g., a facade server), updates to those tables might not be reflected in lastUpdated but do result in a difference of retrieved resource content.

                      • If a system generates resources from internal data (e.g., a facade server), the system's internal lastUpdated value might be changed due to changes that are not visible on FHIR resources (e.g., extended data has been changed).

                      • If a system updates an element that a particular client does not have access to (e.g., prevented by privacy rules), the lastUpdated value might be changed even though there are no visible changes in resource content.

                      Note to server implementers: updating lastUpdated too frequently is generally preferred over missing updates. It is better for client to retrieve records too frequently rather than missing updates.

                      Control0..1
                      Typeinstant
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      14. Observation.meta.source
                      Definition

                      A uri that identifies the data source of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another server, document, message, database, etc. It can also refer to portions of a structure, such as a section, segment, row, etc.

                      ShortIdentifies where the resource comes from
                      Comments

                      The exact use of the source (and the possible implied Provenance.entity.role and agent.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. The source may correspond to Provenance.entity.what[x] or Provenance.agent.who[x], though it may be a more general or abstract reference.

                      This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

                      Control0..1
                      Typeuri
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      16. Observation.meta.profile
                      Definition

                      A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

                      ShortProfiles this resource claims to conform to
                      Comments

                      It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

                      Control0..*
                      Typecanonical(StructureDefinition)
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      18. Observation.meta.security
                      Definition

                      Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

                      ShortSecurity Labels applied to this resource
                      Comments

                      The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

                      Control0..*
                      BindingUnless not suitable, these codes SHALL be taken from AllSecurityLabels
                      (extensible to http://hl7.org/fhir/ValueSet/security-labels|6.0.0-ballot5)

                      Security Labels from the Healthcare Privacy and Security Classification System.

                      TypeCoding
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      SlicingThis element introduces a set of slices on Observation.meta.security. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ $this
                      • 20. Observation.meta.security:PhdHtest
                        Slice NamePhdHtest
                        Definition

                        Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

                        ShortSecurity value set to HTEST when measurement status indicates demo or test data
                        Comments

                        The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

                        Control0..1
                        BindingUnless not suitable, these codes SHALL be taken from AllSecurityLabels
                        (extensible to http://hl7.org/fhir/ValueSet/security-labels|6.0.0-ballot5)

                        Security Labels from the Healthcare Privacy and Security Classification System.

                        TypeCoding
                        Is Modifierfalse
                        Summarytrue
                        Pattern Value{
                          "system" : "http://terminology.hl7.org/CodeSystem/v3-ActReason",
                          "code" : "HTEST"
                        }
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        22. Observation.meta.tag
                        Definition

                        Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

                        ShortTags applied to this resource
                        Comments

                        The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

                        Control0..*
                        BindingFor example codes, see CommonTags
                        (example to http://hl7.org/fhir/ValueSet/common-tags|6.0.0-ballot5)

                        Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

                        TypeCoding
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        24. Observation.implicitRules
                        Definition

                        A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. For DomainResources, if more than one implicitRules policy applies, additional policies may be conveyed using the additionalImplicitRules extension.

                        ShortA set of rules under which this content was created
                        Comments

                        Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

                        Control0..1
                        Typeuri
                        Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        26. Observation.language
                        Definition

                        The base language in which the resource is written.

                        ShortLanguage of the resource content
                        Comments

                        Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

                        Control0..1
                        BindingThe codes SHALL be taken from AllLanguages
                        (required to http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot5)

                        IETF language tag for a human language

                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        28. Observation.text
                        Definition

                        A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

                        ShortText summary of the resource, for human interpretation
                        Comments

                        Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

                        Control0..1
                        This element is affected by the following invariants: dom-6
                        TypeNarrative
                        Is Modifierfalse
                        Must Supportfalse
                        Summaryfalse
                        Alternate Namesnarrative, html, xhtml, display
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        30. Observation.contained
                        Definition

                        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

                        ShortContained, inline Resources
                        Comments

                        This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an additional resource.

                        Control0..*
                        This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
                        TypeResource
                        Is Modifierfalse
                        Must Supportfalse
                        Summaryfalse
                        Alternate Namesinline resources, anonymous resources, contained resources
                        32. Observation.extension
                        Definition

                        An Extension

                        ShortExtension
                        Control1..*
                        TypeExtension
                        Is Modifierfalse
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        SlicingThis element introduces a set of slices on Observation.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 34. Observation.extension:GatewayDevice
                          Slice NameGatewayDevice
                          Definition

                          Linked device acting as a communication/data collector, translator or controller.

                          ShortDevice Gateway
                          Control1..1
                          TypeExtension(Device Gateway) (Extension Type: CodeableReference(Device))
                          Is Modifierfalse
                          Must Supportfalse
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          36. Observation.extension:GatewayDevice.id
                          Definition

                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                          ShortUnique id for inter-element referencing
                          Control0..1
                          This element is affected by the following invariants: ele-1
                          Typeid
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          38. Observation.extension:GatewayDevice.extension
                          Definition

                          An Extension

                          ShortExtension
                          Control0..0
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          SlicingThis element introduces a set of slices on Observation.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 40. Observation.extension:GatewayDevice.url
                            Definition

                            Source of the definition for the extension code - a logical name or a URL.

                            Shortidentifies the meaning of the extension
                            Comments

                            The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                            Control1..1
                            Typeuri
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            Fixed Valuehttp://hl7.org/fhir/StructureDefinition/device-gateway
                            42. Observation.extension:GatewayDevice.value[x]
                            Definition

                            Reference to the PHG Device that received the measurement from the PHD.

                            ShortReference to the PHG Device
                            Control0..1
                            This element is affected by the following invariants: ext-1
                            BindingFor example codes, see DeviceType
                            (example to http://hl7.org/fhir/ValueSet/device-type)
                            TypeCodeableReference(PhgDevice)
                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            44. Observation.extension:CoincidentTimeStamp
                            Slice NameCoincidentTimeStamp
                            Definition

                            Reference to a coincident timestamp observation that relates the gateway timeline to the PHD timeline

                            ShortCoincident Timestamp Reference
                            Control0..1
                            TypeExtension(Coincident Timestamp Reference) (Extension Type: Reference(PhdCoincidentTimeStampObservation))
                            Is Modifierfalse
                            Must Supportfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            46. Observation.extension:Accuracy
                            Slice NameAccuracy
                            Definition

                            The accuracy of a measurable quantity.

                            ShortNumeric Accuracy
                            Control0..1
                            TypeExtension(Numeric Accuracy) (Extension Type: Quantity)
                            Is Modifierfalse
                            Must Supportfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            48. Observation.extension:Confidence95
                            Slice NameConfidence95
                            Definition

                            The Confidence 95 range of a measurable quantity.

                            ShortConfidence95
                            Control0..1
                            TypeExtension(Confidence 95 range) (Extension Type: Range)
                            Is Modifierfalse
                            Must Supportfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            50. Observation.modifierExtension
                            Definition

                            May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                            ShortExtensions that cannot be ignored
                            Comments

                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                            Control0..*
                            TypeExtension
                            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                            Must Supportfalse
                            Summarytrue
                            Requirements

                            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                            Alternate Namesextensions, user content
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            SlicingThis element introduces a set of slices on Observation.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 52. Observation.identifier
                              Definition

                              A unique identifier assigned to this observation.

                              ShortBusiness Identifier for observation
                              NoteThis is a business identifier, not a resource identifier (see discussion)
                              Control0..*
                              TypeIdentifier
                              Is Modifierfalse
                              Must Supportfalse
                              Summarytrue
                              Requirements

                              Allows observations to be distinguished and referenced.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              SlicingThis element introduces a set of slices on Observation.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ system
                              • 54. Observation.identifier:conditionalCreate
                                Slice NameconditionalCreate
                                Definition

                                An identifier created from a combination of the measurement parameters like sensor timestamp, type code, unit code, patient and device identifier.

                                ShortUnique identifier of this measurement for a given patient and device
                                Comments

                                This value is used in the conditional create to prevent data duplication. PHDs will often re-send already sent data for a variety of reasons. This element is recommended unless the observation contains no timestamp or is a measurement containing a timestamp that is real time. By real time the timestamp reported by the PHD must be later than the current time reported by the PHD before any measurements are received. There might be other means to ascertain whether the data is real time. Temporarily stored data from IEEE 11073-10206 compliant devices, which are required to be deleted the data after sending, can be considered real time. An example of this are temporarily stored observations from a device implementing the Bluetooth SIG GHS profile or implementing another Bluetooth SIG medical sensor device profile.

                                NoteThis is a business identifier, not a resource identifier (see discussion)
                                Control0..1
                                TypeIdentifier
                                Is Modifierfalse
                                Must Supportfalse
                                Summarytrue
                                Requirements

                                Allows observations to be distinguished in a selective enough manner to prevent resource duplication.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                56. Observation.identifier:conditionalCreate.id
                                Definition

                                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                ShortUnique id for inter-element referencing
                                Control0..1
                                This element is affected by the following invariants: ele-1
                                Typestring
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                58. Observation.identifier:conditionalCreate.extension
                                Definition

                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                ShortAdditional content defined by implementations
                                Comments

                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                Control0..*
                                TypeExtension
                                Is Modifierfalse
                                Summaryfalse
                                Alternate Namesextensions, user content
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                SlicingThis element introduces a set of slices on Observation.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 60. Observation.identifier:conditionalCreate.use
                                  Definition

                                  The purpose of this identifier.

                                  Shortusual | official | temp | secondary | old (If known)
                                  Comments

                                  Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                  Control0..1
                                  BindingThe codes SHALL be taken from IdentifierUse
                                  (required to http://hl7.org/fhir/ValueSet/identifier-use|6.0.0-ballot5)

                                  Identifies the purpose for this identifier, if known .

                                  Typecode
                                  Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Requirements

                                  Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  62. Observation.identifier:conditionalCreate.type
                                  Definition

                                  A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                                  ShortDescription of identifier
                                  Comments

                                  This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                  Control0..0
                                  BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodes
                                  (extensible to http://hl7.org/fhir/ValueSet/identifier-type|6.0.0-ballot5)

                                  A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                                  TypeCodeableConcept
                                  Is Modifierfalse
                                  Summarytrue
                                  Requirements

                                  Allows users to make use of identifiers when the identifier system is not known.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  64. Observation.identifier:conditionalCreate.system
                                  Definition

                                  Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

                                  ShortThe namespace for the identifier value
                                  Comments

                                  Identifier.system is always case sensitive. The FHIR specification, terminology.hl7.org and HL7 affiliates (for identifiers specific to their jurisdiction) define identifier systems that SHALL be used for certain types of identifiers. Specific rules can be found here.

                                  Control1..1
                                  Typeuri
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Requirements

                                  There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                                  Pattern Valuehttp://hl7.org/fhir/uv/phd/StructureDefinition/PhdBaseObservation
                                  ExampleGeneral: http://www.acme.com/identifiers/patient
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  66. Observation.identifier:conditionalCreate.value
                                  Definition

                                  The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                                  ShortThe value that is unique
                                  Comments

                                  If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processor to be confident that non-case-sensitive processing is safe.

                                  Control1..1
                                  This element is affected by the following invariants: ident-1
                                  Typestring
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  ExampleGeneral: 123456
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  68. Observation.identifier:conditionalCreate.period
                                  Definition

                                  Time period during which identifier is/was valid for use.

                                  ShortTime period when id is/was valid for use
                                  Control0..1
                                  TypePeriod
                                  Is Modifierfalse
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  70. Observation.identifier:conditionalCreate.assigner
                                  Definition

                                  Organization that issued/manages the identifier.

                                  ShortOrganization that issued id (may be just text)
                                  Comments

                                  The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                                  Control0..1
                                  TypeReference(Organization)
                                  Is Modifierfalse
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  72. Observation.basedOn
                                  Definition

                                  A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.

                                  ShortFulfills plan, proposal or order
                                  Control0..*
                                  TypeReference(CarePlan, DeviceRequest, MedicationRequest, NutritionOrder, ServiceRequest)
                                  Is Modifierfalse
                                  Must Supportfalse
                                  Summarytrue
                                  Requirements

                                  Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.

                                  Alternate NamesFulfills
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  74. Observation.triggeredBy
                                  Definition

                                  Identifies the observation(s) that triggered the performance of this observation.

                                  ShortTriggering observation(s)
                                  Control0..*
                                  TypeBackboneElement
                                  Is Modifierfalse
                                  Must Supportfalse
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
                                  76. Observation.triggeredBy.id
                                  Definition

                                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                  ShortUnique id for inter-element referencing
                                  Control0..1
                                  This element is affected by the following invariants: ele-1
                                  Typestring
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  78. Observation.triggeredBy.extension
                                  Definition

                                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                  ShortAdditional content defined by implementations
                                  Comments

                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                  Control0..*
                                  TypeExtension
                                  Is Modifierfalse
                                  Summaryfalse
                                  Alternate Namesextensions, user content
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  SlicingThis element introduces a set of slices on Observation.triggeredBy.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 80. Observation.triggeredBy.modifierExtension
                                    Definition

                                    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                    ShortExtensions that cannot be ignored even if unrecognized
                                    Comments

                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                    Control0..*
                                    TypeExtension
                                    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                    Summarytrue
                                    Requirements

                                    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                    Alternate Namesextensions, user content, modifiers
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    SlicingThis element introduces a set of slices on Observation.triggeredBy.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 82. Observation.triggeredBy.observation
                                      Definition

                                      Reference to the triggering observation.

                                      ShortTriggering observation
                                      Control1..1
                                      TypeReference(Observation)
                                      Is Modifierfalse
                                      Must Supportfalse
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      84. Observation.triggeredBy.type
                                      Definition

                                      The type of trigger. Reflex | Repeat | Re-run.

                                      Shortreflex | repeat | re-run
                                      Control1..1
                                      BindingThe codes SHALL be taken from TriggeredBytype
                                      (required to http://hl7.org/fhir/ValueSet/observation-triggeredbytype|6.0.0-ballot5)

                                      The type of TriggeredBy Observation.

                                      Typecode
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supportfalse
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      86. Observation.triggeredBy.reason
                                      Definition

                                      Provides the reason why this observation was performed as a result of the observation(s) referenced.

                                      ShortReason that the observation was triggered
                                      Control0..1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supportfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      88. Observation.partOf
                                      Definition

                                      A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

                                      ShortPart of referenced event
                                      Comments

                                      To link an Observation to an Encounter use encounter. See the Notes below for guidance on referencing another Observation.

                                      Control0..*
                                      TypeReference(MedicationAdministration, MedicationDispense, MedicationStatement, Procedure, Immunization, ImagingStudy)
                                      Is Modifierfalse
                                      Must Supportfalse
                                      Summarytrue
                                      Alternate NamesContainer
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      90. Observation.status
                                      Definition

                                      The status of the result value. Either 'final' or 'preliminary'

                                      Shortregistered | in-process | specimen-in-process | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | unknown | cannot-be-obtained
                                      Comments

                                      The value shall be set to 'final' unless a Measurement-Status attribute indicates that the measurement is preliminary. In that case this field shall be set to 'preliminary'

                                      Control1..1
                                      BindingThe codes SHALL be taken from ObservationStatus
                                      (required to http://hl7.org/fhir/ValueSet/observation-status|6.0.0-ballot5)

                                      Codes providing the status of an observation.

                                      Typecode
                                      Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supportfalse
                                      Summarytrue
                                      Requirements

                                      Need to track the status of individual results. Some results are finalized before the whole report is finalized.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      92. Observation.statusReason
                                      Definition

                                      Captures the reason for the current state of the Observation.

                                      ShortReason for current status
                                      Comments

                                      This is generally only used for "exception" statuses such as "not-done", "suspended" or "cancelled".

                                      Control0..1
                                      BindingFor example codes, see ObservationStatusReason
                                      (example to http://hl7.org/fhir/ValueSet/observation-status-reason|6.0.0-ballot5)

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

                                      TypeCodeableConcept
                                      Is Modifierfalse
                                      Must Supportfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      94. Observation.category
                                      Definition

                                      A code that classifies the general type of observation being made.

                                      ShortClassification of type of observation
                                      Comments

                                      In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set.

                                      Control1..*
                                      BindingThe codes SHOULD be taken from ObservationCategoryCodes
                                      (preferred to http://hl7.org/fhir/ValueSet/observation-category|6.0.0-ballot5)

                                      Codes for high level observation categories.

                                      TypeCodeableConcept
                                      Is Modifierfalse
                                      Must Supportfalse
                                      Summaryfalse
                                      Requirements

                                      Used for filtering what observations are retrieved and displayed.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      SlicingThis element introduces a set of slices on Observation.category. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ $this
                                      • 96. Observation.category:PHD-Observation
                                        Slice NamePHD-Observation
                                        Definition

                                        A code that classifies the general type of observation being made.

                                        ShortPHD observation category
                                        Comments

                                        The category enables identifying observations generated by PHDs.

                                        Control1..1
                                        BindingThe codes SHOULD be taken from ObservationCategoryCodes
                                        (preferred to http://hl7.org/fhir/ValueSet/observation-category|6.0.0-ballot5)

                                        Codes for high level observation categories.

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Must Supportfalse
                                        Summaryfalse
                                        Requirements

                                        Used for filtering what observations are retrieved and displayed.

                                        Pattern Value{
                                          "coding" : [{
                                            "system" : "http://hl7.org/fhir/uv/phd/CodeSystem/PhdObservationCategories",
                                            "code" : "phd"
                                          }]
                                        }
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        98. Observation.code
                                        Definition

                                        Describes what was observed. Sometimes this is called the observation "name".

                                        ShortType of observation (code / type)
                                        Comments

                                        All code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. All codings in Observation.code are expected to be sufficiently precise to allow a user with the code and value to be able to understand the value - though not all codes will necessarily convey the same level of detail. Codings in Observation.category SHOULD be concepts that are too broad to be able to understand the meaning of the Observation.value without also having an Observation.code.

                                        See Interoperability Issues using code value pairs in FHIR for additional information.

                                        Control1..1
                                        This element is affected by the following invariants: obs-7
                                        BindingUnless not suitable, these codes SHALL be taken from MDC Non-Object codes
                                        (extensible to http://hl7.org/fhir/uv/phd/ValueSet/MDCnotObject)

                                        IEEE 11073-10101 Nomenclature codes for PHD measurements

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Must Supportfalse
                                        Summarytrue
                                        Requirements

                                        Knowing what kind of observation is being made is essential to understanding the observation.

                                        Alternate NamesName
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        mdc-1: A published MDC Code is preferred but private MDC codes are allowed as well. (coding.exists() and coding.where(system = 'urn:iso:std:iso:11073:10101').exists())
                                        100. Observation.code.id
                                        Definition

                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                        ShortUnique id for inter-element referencing
                                        Control0..1
                                        This element is affected by the following invariants: ele-1
                                        Typestring
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        102. Observation.code.extension
                                        Definition

                                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                        ShortAdditional content defined by implementations
                                        Comments

                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                        Control0..*
                                        TypeExtension
                                        Is Modifierfalse
                                        Summaryfalse
                                        Alternate Namesextensions, user content
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        SlicingThis element introduces a set of slices on Observation.code.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • value @ url
                                        • 104. Observation.code.coding
                                          Definition

                                          A reference to a code defined by a terminology system.

                                          ShortCode defined by a terminology system
                                          Comments

                                          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                          Control0..*
                                          TypeCoding
                                          Is Modifierfalse
                                          Summarytrue
                                          Requirements

                                          Allows for alternative encodings within a code system, and translations to other code systems.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          106. Observation.code.coding.id
                                          Definition

                                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                          ShortUnique id for inter-element referencing
                                          Control0..1
                                          This element is affected by the following invariants: ele-1
                                          Typestring
                                          Is Modifierfalse
                                          XML FormatIn the XML format, this property is represented as an attribute.
                                          Summaryfalse
                                          108. Observation.code.coding.extension
                                          Definition

                                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                          ShortAdditional content defined by implementations
                                          Comments

                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                          Control0..*
                                          TypeExtension
                                          Is Modifierfalse
                                          Summaryfalse
                                          Alternate Namesextensions, user content
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          SlicingThis element introduces a set of slices on Observation.code.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 110. Observation.code.coding.system
                                            Definition

                                            The identification of the code system that defines the meaning of the symbol in the code.

                                            ShortIdentity of the terminology system
                                            Comments

                                            The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.

                                            Control0..1
                                            Typeuri
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Requirements

                                            Need to be unambiguous about the source of the definition of the symbol.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            112. Observation.code.coding.version
                                            Definition

                                            The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                            ShortVersion of the system - if relevant
                                            Comments

                                            Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                            NoteThis is a business version Id, not a resource version Id (see discussion)
                                            Control0..1
                                            Typestring
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            114. Observation.code.coding.code
                                            Definition

                                            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                            ShortSymbol in syntax defined by the system
                                            Control0..1
                                            This element is affected by the following invariants: cod-1
                                            Typecode
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Requirements

                                            Need to refer to a particular code in the system.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            116. Observation.code.coding.display
                                            Definition

                                            A representation of the meaning of the code in the system, following the rules of the system.

                                            ShortRepresentation defined by the system
                                            Control0..1
                                            This element is affected by the following invariants: cod-1
                                            Typestring
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Requirements

                                            Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            118. Observation.code.coding.userSelected
                                            Definition

                                            Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                            ShortIf this coding was chosen directly by the user
                                            Comments

                                            Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                            Control0..1
                                            Typeboolean
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Requirements

                                            This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            120. Observation.code.text
                                            Definition

                                            A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                            ShortPlain text representation of the concept
                                            Comments

                                            Very often the text is the same as a displayName of one of the codings.

                                            Control0..1
                                            Typestring
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Requirements

                                            The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            122. Observation.subject
                                            Definition

                                            The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the focus element or the code itself specifies the actual focus of the observation.

                                            ShortReference to the patient or the PhdDevice that is the subject of the observation
                                            Comments

                                            One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all).

                                            Control1..1
                                            TypeReference(Patient, PhdDevice)
                                            Is Modifierfalse
                                            Must Supportfalse
                                            Summarytrue
                                            Requirements

                                            Observations have no value if you don't know who or what they're about.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            124. Observation.focus
                                            Definition

                                            The actual focus of an observation when it is not the subject of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. As another use case,

                                            a caregiver (RelatedPerson) has back strain and is unable to provide ADL support to a patient (Subject).

                                            ShortWhat the observation is about, when it is not about the subject of record
                                            Comments

                                            Examples demonstrating the use of subject and focus in an Observation:

                                            • A parent is trained to change their child's tracheostomy tube. The child is the subject, and the parent is the focus.

                                            • A fetal heart rate recorded in a mother's record. The mother is the subject, and the fetus is the focus.

                                            • Features of a body structure, such as a tumor. The patient is the subject, and the specific body structure is the focus.

                                            • Metrics captured from a medical device. The patient-attached device is the subject, the specific device metric is the focus, and the observing device itself is referenced in .device.

                                            Control0..*
                                            TypeReference(Resource)
                                            Is Modifiertrue because This element is labeled as a modifier because it changes who is the target of the observation. See the use cases in the definition.
                                            Must Supportfalse
                                            Summarytrue
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            126. Observation.organizer
                                            Definition

                                            This observation serves as an organizer or grouper for a set of (one or more) sub-observations.

                                            ShortThis observation organizes/groups a set of sub-observations
                                            Comments

                                            An observation that is an organizer/grouper does not have a value (or dataAbsentReason) of its own - all values are included in the sub-observations. The sub-observations are linked using hasMember element references (in some instances there may be no hasMember references, as it is possible that the organizer/grouper observation may be created first, and the sub-observations are not created until a later time). An organizer/grouper observation also does not contain any components.

                                            Control0..1
                                            This element is affected by the following invariants: obs-11
                                            Typeboolean
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Must Supportfalse
                                            Summarytrue
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            128. Observation.encounter
                                            Definition

                                            The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

                                            ShortHealthcare 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
                                            Comments

                                            This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).

                                            Control0..1
                                            TypeReference(Encounter)
                                            Is Modifierfalse
                                            Must Supportfalse
                                            Summarytrue
                                            Requirements

                                            For some observations it may be important to know the link between an observation and a particular encounter.

                                            Alternate NamesContext
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            130. Observation.effective[x]
                                            Definition

                                            The time or time-period the observed value is asserted as being true. This can be a dateTime or a period. The value is based on the timestamp sent by the PHD or the time of reception by the PHG if the PHD sent no timestamp.

                                            ShortClinically relevant time/time-period for observation
                                            Comments

                                            At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the Timing datatype which allow the measurement to be tied to regular life events.

                                            Control1..1
                                            TypeChoice of: dateTime, Period
                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Must Supportfalse
                                            Summarytrue
                                            Requirements

                                            Knowing when an observation was deemed true is important to its relevance as well as determining trends.

                                            Alternate NamesOccurrence
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            SlicingThis element introduces a set of slices on Observation.effective[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                            • type @ $this
                                            • 132. Observation.effective[x]:effectiveDateTime
                                              Slice NameeffectiveDateTime
                                              Definition

                                              The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.

                                              ShortClinically relevant time/time-period for observation
                                              Comments

                                              At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the Timing datatype which allow the measurement to be tied to regular life events.

                                              Control0..1
                                              TypedateTime
                                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Must Supportfalse
                                              Summarytrue
                                              Requirements

                                              Knowing when an observation was deemed true is important to its relevance as well as determining trends.

                                              Alternate NamesOccurrence
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              134. Observation.effective[x]:effectivePeriod
                                              Slice NameeffectivePeriod
                                              Definition

                                              The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.

                                              ShortClinically relevant time/time-period for observation
                                              Comments

                                              At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the Timing datatype which allow the measurement to be tied to regular life events.

                                              Control0..1
                                              TypePeriod
                                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summarytrue
                                              Requirements

                                              Knowing when an observation was deemed true is important to its relevance as well as determining trends.

                                              Alternate NamesOccurrence
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              136. Observation.effective[x]:effectivePeriod.id
                                              Definition

                                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                              ShortUnique id for inter-element referencing
                                              Control0..1
                                              This element is affected by the following invariants: ele-1
                                              Typestring
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              138. Observation.effective[x]:effectivePeriod.extension
                                              Definition

                                              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                              ShortAdditional content defined by implementations
                                              Comments

                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                              Control0..*
                                              TypeExtension
                                              Is Modifierfalse
                                              Summaryfalse
                                              Alternate Namesextensions, user content
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              SlicingThis element introduces a set of slices on Observation.effective[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                              • value @ url
                                              • 140. Observation.effective[x]:effectivePeriod.start
                                                Definition

                                                The start of the period. The boundary is inclusive.

                                                ShortStarting time with inclusive boundary
                                                Comments

                                                If the low element is missing, the meaning is that the low boundary is not known.

                                                Control0..1
                                                This element is affected by the following invariants: per-1
                                                TypedateTime
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summarytrue
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                142. Observation.effective[x]:effectivePeriod.end
                                                Definition

                                                The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

                                                ShortEnd time with inclusive boundary, if not ongoing
                                                Comments

                                                The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

                                                Control0..1
                                                This element is affected by the following invariants: per-1
                                                TypedateTime
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summarytrue
                                                Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                144. Observation.issued
                                                Definition

                                                The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

                                                ShortDate/Time this version was made available
                                                Comments

                                                For Observations that don't require review and verification, it may be the same as the lastUpdated time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the lastUpdated time of the resource itself due to a non-clinically significant update that doesn't require the new version to be reviewed and verified again.

                                                Control0..1
                                                Typeinstant
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Must Supportfalse
                                                Summarytrue
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                146. Observation.performer
                                                Definition

                                                Who was responsible for asserting the observed value as "true".

                                                ShortWho is responsible for the observation
                                                Comments

                                                Group is only allowed in the circumstance where the group represents a family or a household, and should not represent groups of Practitioners where other more specific resources can be used instead.

                                                Control0..*
                                                TypeReference(Practitioner, PractitionerRole, Organization, CareTeam, Patient, RelatedPerson, HealthcareService, Group)
                                                Is Modifierfalse
                                                Must Supportfalse
                                                Summarytrue
                                                Requirements

                                                May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.

                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                148. Observation.value[x]
                                                Definition

                                                The information determined as a result of making the observation, if the information has a simple value.

                                                ShortActual result
                                                Comments
                                                • An observation may have:
                                                  1. a single value here
                                                  2. both a value and a set of related or component values
                                                  3. only a set of related or component values.
                                                • If a value is present, the datatype for this element should be determined by the code.
                                                • CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the code defines a coded value.
                                                • Attachment is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the proof in this image), the binary file may be directly represented using DocumentReference and referenced by derivedFrom.
                                                • For additional guidance, see the Notes section below.
                                                • See Interoperability Issues using code value pairs in FHIR for additional information.
                                                Control0..1
                                                This element is affected by the following invariants: obs-7, obs-6, obs-11
                                                TypeQuantity
                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                Is Modifierfalse
                                                Must Supportfalse
                                                Summarytrue
                                                Requirements

                                                An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                unit-system-code-coherent: system and code SHALL be coherent: UCUM system uses UCUM code, MDC system uses MDC code ((system = 'http://unitsofmeasure.org' implies code.memberOf('http://hl7.org/fhir/ValueSet/ucum-units')) and (system = 'urn:iso:std:iso:11073:10101' implies code.memberOf('http://hl7.org/fhir/uv/phd/ValueSet/MDCValueSet')))
                                                phd-dim-code: If system is MDC, code must be a partition-4 dimension code (262144-327679) (system != 'urn:iso:std:iso:11073:10101' or (code.toInteger() >= 262144 and code.toInteger() <= 327679))
                                                150. Observation.value[x].id
                                                Definition

                                                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                ShortUnique id for inter-element referencing
                                                Control0..1
                                                This element is affected by the following invariants: ele-1
                                                Typestring
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                152. Observation.value[x].extension
                                                Definition

                                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                ShortAdditional content defined by implementations
                                                Comments

                                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                Control0..*
                                                TypeExtension
                                                Is Modifierfalse
                                                Summaryfalse
                                                Alternate Namesextensions, user content
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                SlicingThis element introduces a set of slices on Observation.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                • value @ url
                                                • 154. Observation.value[x].value
                                                  Definition

                                                  The decoded FLOAT or SFLOAT value from a PHD Observation.

                                                  ShortNumerical value (with implicit precision)
                                                  Comments

                                                  The implicit precision in the value shall be honored. The MDER encoding used in the above attributes provides this precision. The translating software shall honor that precision when generating this value. This element shall be present unless there is an error reported in the Measurement-Status attribute or the MDER encoding represents one of the special FLOAT values. In that case there is a dataAbsentReason element and the valueQuantity element is not present. Note that not all measurement status values are errors resulting in no measurement being reported here; for example the preliminary or verified status.

                                                  Control1..1
                                                  Typedecimal
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  Requirements

                                                  Precision is handled implicitly in almost all cases of measurement.

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  156. Observation.value[x].comparator
                                                  Definition

                                                  How the value should be understood and represented - whether the actual value is greater than, less than, or approximately equal to the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

                                                  Short< | <= | >= | > | ~ | ad - how to understand the value
                                                  Control0..1
                                                  BindingThe codes SHALL be taken from QuantityComparator
                                                  (required to http://hl7.org/fhir/ValueSet/quantity-comparator|6.0.0-ballot5)

                                                  How the Quantity should be understood and represented.

                                                  Typecode
                                                  Is Modifiertrue because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  Requirements

                                                  Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

                                                  Meaning if MissingIf there is no comparator, then there is no modification of the value
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  158. Observation.value[x].unit
                                                  Definition

                                                  A human-readable form of the unit.

                                                  ShortUnit representation
                                                  Control0..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  Requirements

                                                  There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  160. Observation.value[x].system
                                                  Definition

                                                  The identification of the system that provides the coded form of the unit.

                                                  ShortThe code system for the units of this measurement (UCUM or MDC).
                                                  Comments

                                                  The unit code needs to be translated from the 11073-10101 code from the device. This can be represented as either a UCUM code or an MDC code system. UCUM is preferred but MDC codes are also supported.

                                                  Control1..1
                                                  This element is affected by the following invariants: qty-3
                                                  Typeuri
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  Requirements

                                                  Need to know the system that defines the coded form of the unit.

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  system-is-mdc-or-ucum: system SHALL be either the MDC or UCUM URI ($this = 'urn:iso:std:iso:11073:10101' or $this = 'http://unitsofmeasure.org')
                                                  162. Observation.value[x].code
                                                  Definition

                                                  A computer processable form of the unit in some unit representation system.

                                                  ShortThe UCUM or MDC code for the units of this measurement.
                                                  Comments

                                                  The unit code needs to be translated from the 11073-10101 code from the device. This translation means that the reporting of units is not future proof.

                                                  Control1..1
                                                  This element is affected by the following invariants: qty-3
                                                  Typecode
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  Requirements

                                                  Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  164. Observation.dataAbsentReason
                                                  Definition

                                                  Provides a reason why the expected value in the element Observation.valueQuantity is missing. In this case this could also be 'not-a-number', 'positive-infinity', 'negative-infinity' or 'error'.

                                                  ShortThis element is populated for numeric observations when a special FLOAT value is reported that is not a real number.
                                                  Comments

                                                  The values in the http://terminology.hl7.org/CodeSystem/data-absent-reason system do not provide a code that matches the 'not at this resolution' and 'reserved'. In those cases one uses the generic 'error' code. If both a special FLOAT value and a Measurement-Status indicating invalid, not available, or measurement ongoing are received, the Measurement-Status mapping takes precedence.

                                                  Control0..1
                                                  This element is affected by the following invariants: obs-6, obs-11
                                                  BindingUnless not suitable, these codes SHALL be taken from DataAbsentReason
                                                  (extensible to http://hl7.org/fhir/ValueSet/data-absent-reason|6.0.0-ballot5)

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

                                                  TypeCodeableConcept
                                                  Is Modifierfalse
                                                  Must Supportfalse
                                                  Summaryfalse
                                                  Requirements

                                                  For many results it is necessary to handle exceptional values in measurements.

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  166. Observation.dataAbsentReason.id
                                                  Definition

                                                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                  ShortUnique id for inter-element referencing
                                                  Control0..1
                                                  This element is affected by the following invariants: ele-1
                                                  Typestring
                                                  Is Modifierfalse
                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                  Summaryfalse
                                                  168. Observation.dataAbsentReason.extension
                                                  Definition

                                                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                  ShortAdditional content defined by implementations
                                                  Comments

                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                  Control0..*
                                                  TypeExtension
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Alternate Namesextensions, user content
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  SlicingThis element introduces a set of slices on Observation.dataAbsentReason.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                  • value @ url
                                                  • 170. Observation.dataAbsentReason.coding
                                                    Definition

                                                    A reference to a code defined by a terminology system.

                                                    ShortCode defined by a terminology system
                                                    Comments

                                                    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                    Control0..*
                                                    BindingThe codes SHALL be taken from DataAbsentReason
                                                    (required to http://hl7.org/fhir/ValueSet/data-absent-reason)
                                                    TypeCoding
                                                    Is Modifierfalse
                                                    Summarytrue
                                                    Requirements

                                                    Allows for alternative encodings within a code system, and translations to other code systems.

                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    172. Observation.dataAbsentReason.text
                                                    Definition

                                                    A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                    ShortPlain text representation of the concept
                                                    Comments

                                                    Very often the text is the same as a displayName of one of the codings.

                                                    Control0..1
                                                    Typestring
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    Requirements

                                                    The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    174. Observation.interpretation
                                                    Definition

                                                    A categorical assessment of an observation value. For example, high, low, normal.

                                                    ShortHigh, low, normal, etc
                                                    Comments

                                                    Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.

                                                    Control0..*
                                                    BindingUnless not suitable, these codes SHALL be taken from ObservationInterpretationCodes
                                                    (extensible to http://hl7.org/fhir/ValueSet/observation-interpretation|6.0.0-ballot5)

                                                    Codes identifying interpretations of observations.

                                                    TypeCodeableConcept
                                                    Is Modifierfalse
                                                    Must Supportfalse
                                                    Summaryfalse
                                                    Requirements

                                                    For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

                                                    Alternate NamesAbnormal Flag
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    176. Observation.interpretation.id
                                                    Definition

                                                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                    ShortUnique id for inter-element referencing
                                                    Control0..1
                                                    This element is affected by the following invariants: ele-1
                                                    Typestring
                                                    Is Modifierfalse
                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                    Summaryfalse
                                                    178. Observation.interpretation.extension
                                                    Definition

                                                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                    ShortAdditional content defined by implementations
                                                    Comments

                                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                    Control0..*
                                                    TypeExtension
                                                    Is Modifierfalse
                                                    Summaryfalse
                                                    Alternate Namesextensions, user content
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    SlicingThis element introduces a set of slices on Observation.interpretation.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                    • value @ url
                                                    • 180. Observation.interpretation.coding
                                                      Definition

                                                      A reference to a code defined by a terminology system.

                                                      ShortCode defined by a terminology system
                                                      Comments

                                                      Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                      Control1..*
                                                      TypeCoding
                                                      Is Modifierfalse
                                                      Summarytrue
                                                      Requirements

                                                      Allows for alternative encodings within a code system, and translations to other code systems.

                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      SlicingThis element introduces a set of slices on Observation.interpretation.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                      • value @ system
                                                      • 182. Observation.interpretation.coding:MsmtStatusInterpretation
                                                        Slice NameMsmtStatusInterpretation
                                                        Definition

                                                        A reference to a code defined by a terminology system.

                                                        ShortMeasurement status interpretation when questionable, calibration-ongoing, validated, early-indication, threshold exceeded, alarm inhibited
                                                        Comments

                                                        Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                        Control1..1
                                                        TypeCoding
                                                        Is Modifierfalse
                                                        Summarytrue
                                                        Requirements

                                                        Allows for alternative encodings within a code system, and translations to other code systems.

                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        184. Observation.interpretation.coding:MsmtStatusInterpretation.id
                                                        Definition

                                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                        ShortUnique id for inter-element referencing
                                                        Control0..1
                                                        This element is affected by the following invariants: ele-1
                                                        Typestring
                                                        Is Modifierfalse
                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                        Summaryfalse
                                                        186. Observation.interpretation.coding:MsmtStatusInterpretation.extension
                                                        Definition

                                                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                        ShortAdditional content defined by implementations
                                                        Comments

                                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                        Control0..*
                                                        TypeExtension
                                                        Is Modifierfalse
                                                        Summaryfalse
                                                        Alternate Namesextensions, user content
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        SlicingThis element introduces a set of slices on Observation.interpretation.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                        • value @ url
                                                        • 188. Observation.interpretation.coding:MsmtStatusInterpretation.system
                                                          Definition

                                                          The identification of the code system that defines the meaning of the symbol in the code.

                                                          ShortIdentity of the terminology system
                                                          Comments

                                                          The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.

                                                          Control1..1
                                                          Typeuri
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Summarytrue
                                                          Requirements

                                                          Need to be unambiguous about the source of the definition of the symbol.

                                                          Pattern Valuehttp://hl7.org/fhir/uv/pocd/CodeSystem/measurement-status
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          190. Observation.interpretation.coding:MsmtStatusInterpretation.version
                                                          Definition

                                                          The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                          ShortVersion of the system - if relevant
                                                          Comments

                                                          Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                          NoteThis is a business version Id, not a resource version Id (see discussion)
                                                          Control0..1
                                                          Typestring
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Summarytrue
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          192. Observation.interpretation.coding:MsmtStatusInterpretation.code
                                                          Definition

                                                          A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                          ShortSymbol in syntax defined by the system
                                                          Control1..1
                                                          This element is affected by the following invariants: cod-1
                                                          Typecode
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Summarytrue
                                                          Requirements

                                                          Need to refer to a particular code in the system.

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          194. Observation.interpretation.coding:MsmtStatusInterpretation.display
                                                          Definition

                                                          A representation of the meaning of the code in the system, following the rules of the system.

                                                          ShortRepresentation defined by the system
                                                          Control0..1
                                                          This element is affected by the following invariants: cod-1
                                                          Typestring
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Summarytrue
                                                          Requirements

                                                          Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          196. Observation.interpretation.coding:MsmtStatusInterpretation.userSelected
                                                          Definition

                                                          Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                          ShortIf this coding was chosen directly by the user
                                                          Comments

                                                          Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                          Control0..1
                                                          Typeboolean
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Summarytrue
                                                          Requirements

                                                          This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          198. Observation.interpretation.text
                                                          Definition

                                                          A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                          ShortPlain text representation of the concept
                                                          Comments

                                                          Very often the text is the same as a displayName of one of the codings.

                                                          Control0..1
                                                          Typestring
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Summarytrue
                                                          Requirements

                                                          The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          200. Observation.context
                                                          Definition

                                                          Contextual information that is relevant to understanding the observation value or interpretation. The referenced information may be concurrent or precede the observation.

                                                          ShortContext for understanding the observation
                                                          Comments

                                                          This element provides essential contextual information that affects how the observation should be interpreted. For example, knowing that a patient is diabetic, fasting, or paraplegic may be critical to properly understanding lab results or other observations. Similarly, information about the timing, view, or imaging mode may be relevant to understanding an imaging measurement. This element is intended for interpretive context and not for conveying order, request, or fulfillment workflow information.

                                                          Control0..*
                                                          BindingFor example codes, see ObservationContextCodes
                                                          (example to http://hl7.org/fhir/ValueSet/observation-context|6.0.0-ballot5)

                                                          Codes identifying contextual factors that affect interpretation of observations.

                                                          TypeCodeableReference(Resource)
                                                          Is Modifierfalse
                                                          Must Supportfalse
                                                          Summaryfalse
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          202. Observation.note
                                                          Definition

                                                          Comments about the observation or the results.

                                                          ShortComments about the observation
                                                          Comments

                                                          May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.

                                                          Control0..*
                                                          TypeAnnotation
                                                          Is Modifierfalse
                                                          Must Supportfalse
                                                          Summaryfalse
                                                          Requirements

                                                          Need to be able to provide free text additional information.

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          204. Observation.bodySite
                                                          Definition

                                                          DEPRECATED: This element is deprecated. Use bodyStructure instead. Indicates the site on the subject's body where the observation was made (i.e. the target site).

                                                          ShortDEPRECATED: Observed body part
                                                          Comments

                                                          DEPRECATED: Use bodyStructure instead. Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component.

                                                          Control0..1
                                                          TypeCodeableConcept
                                                          Is Modifierfalse
                                                          Must Supportfalse
                                                          Summaryfalse
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          206. Observation.bodyStructure
                                                          Definition

                                                          Indicates the body structure on the subject's body where the observation was made (i.e. the target site).

                                                          ShortObserved body structure
                                                          Comments

                                                          Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. Use this element instead of the deprecated bodySite element.

                                                          Control0..*
                                                          BindingFor example codes, see SNOMEDCTBodyStructures
                                                          (example to http://hl7.org/fhir/ValueSet/body-site|6.0.0-ballot5)

                                                          SNOMED CT Body Structures

                                                          TypeCodeableReference(BodyStructure)
                                                          Is Modifierfalse
                                                          Must Supportfalse
                                                          Summaryfalse
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          208. Observation.method
                                                          Definition

                                                          Indicates the mechanism used to perform the observation.

                                                          ShortHow it was done
                                                          Comments

                                                          Only used if not implicit in code for Observation.code.

                                                          Control0..1
                                                          BindingFor example codes, see ObservationMethods
                                                          (example to http://hl7.org/fhir/ValueSet/observation-methods|6.0.0-ballot5)

                                                          Methods for simple observations.

                                                          TypeCodeableConcept
                                                          Is Modifierfalse
                                                          Must Supportfalse
                                                          Summaryfalse
                                                          Requirements

                                                          In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          210. Observation.specimen
                                                          Definition

                                                          The specimen that was used when this observation was made.

                                                          ShortSpecimen used for this observation
                                                          Comments

                                                          SHOULD be used when the observation is performed on a specimen. The type of specimen SHOULD be consistent with anything implied in the Observation.code value.

                                                          Control0..1
                                                          TypeReference(Specimen, Group)
                                                          Is Modifierfalse
                                                          Must Supportfalse
                                                          Summaryfalse
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          obs-9: If Observation.specimen is a reference to Group, the group can only have specimens ((reference.resolve().exists() and reference.resolve() is Group) implies reference.resolve().member.entity.resolve().all($this is Specimen))
                                                          212. Observation.device
                                                          Definition

                                                          A reference to the device that generates the measurements or the device settings for the device.

                                                          ShortA reference to the device that generates the measurements or the device settings for the device
                                                          Comments

                                                          This field will reference the PHD Device.

                                                          Control1..1
                                                          TypeReference(PhdDevice)
                                                          Is Modifierfalse
                                                          Must Supportfalse
                                                          Summaryfalse
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          214. Observation.device.id
                                                          Definition

                                                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                          ShortUnique id for inter-element referencing
                                                          Control0..1
                                                          This element is affected by the following invariants: ele-1
                                                          Typestring
                                                          Is Modifierfalse
                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                          Summaryfalse
                                                          216. Observation.device.extension
                                                          Definition

                                                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                          ShortAdditional content defined by implementations
                                                          Comments

                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                          Control0..*
                                                          TypeExtension
                                                          Is Modifierfalse
                                                          Summaryfalse
                                                          Alternate Namesextensions, user content
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          SlicingThis element introduces a set of slices on Observation.device.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                          • value @ url
                                                          • 218. Observation.device.reference
                                                            Definition

                                                            Reference to the device-related resources that describe the sensor device taking the measurement. This element will point to a Device resource following the Phd Device Profile.

                                                            ShortReference to the device responsible for the measurement
                                                            Comments

                                                            This reference points to the Device resource containing information about the sensor device that took the measurement.

                                                            Control1..1
                                                            This element is affected by the following invariants: ref-2, ref-1
                                                            Typestring
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Summarytrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            220. Observation.device.type
                                                            Definition

                                                            The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                            The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                            ShortType the reference refers to (e.g. "Patient") - must be a resource in resources
                                                            Comments

                                                            This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.

                                                            Control0..1
                                                            BindingUnless not suitable, these codes SHALL be taken from ResourceType
                                                            (extensible to http://hl7.org/fhir/ValueSet/resource-types|6.0.0-ballot5)

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

                                                            Typeuri
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Summarytrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            222. Observation.device.identifier
                                                            Definition

                                                            An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                                            ShortLogical reference, when literal reference is not known
                                                            Comments

                                                            When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                                            When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                                            Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                            Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                            This element only allows for a single identifier. In the case where additional identifiers are required, use the additional identifier extension.

                                                            NoteThis is a business identifier, not a resource identifier (see discussion)
                                                            Control0..1
                                                            This element is affected by the following invariants: ref-2
                                                            TypeIdentifier
                                                            Is Modifierfalse
                                                            Summarytrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            224. Observation.device.display
                                                            Definition

                                                            Plain text narrative that identifies the resource in addition to the resource reference.

                                                            ShortText alternative for the resource
                                                            Comments

                                                            This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                                            Control0..1
                                                            This element is affected by the following invariants: ref-2
                                                            Typestring
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Summarytrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            226. Observation.supportingDevice
                                                            Definition

                                                            A reference to additional devices, kits, or reagents (e.g., Test Kit, Calibration Kit, QC materials) used to support the generation of the measurement.

                                                            ShortDevice supporting generation of the measurement
                                                            Control0..*
                                                            BindingFor example codes, see DeviceType
                                                            (example to http://hl7.org/fhir/ValueSet/device-type|6.0.0-ballot5)

                                                            Type of device supporting the generation of the measurement.

                                                            TypeCodeableReference(Device)
                                                            Is Modifierfalse
                                                            Must Supportfalse
                                                            Summaryfalse
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            228. Observation.referenceRange
                                                            Definition

                                                            Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two referenceRange elements would be used.

                                                            ShortProvides guide for interpretation
                                                            Comments

                                                            Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.

                                                            Control0..*
                                                            TypeBackboneElement
                                                            Is Modifierfalse
                                                            Must Supportfalse
                                                            Summaryfalse
                                                            Requirements

                                                            Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

                                                            Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
                                                            obs-3: Must have at least a low or a high or text (low.exists() or high.exists() or text.exists())
                                                            230. Observation.referenceRange.id
                                                            Definition

                                                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                            ShortUnique id for inter-element referencing
                                                            Control0..1
                                                            This element is affected by the following invariants: ele-1
                                                            Typestring
                                                            Is Modifierfalse
                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                            Summaryfalse
                                                            232. Observation.referenceRange.extension
                                                            Definition

                                                            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                            ShortAdditional content defined by implementations
                                                            Comments

                                                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                            Control0..*
                                                            TypeExtension
                                                            Is Modifierfalse
                                                            Summaryfalse
                                                            Alternate Namesextensions, user content
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            SlicingThis element introduces a set of slices on Observation.referenceRange.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                            • value @ url
                                                            • 234. Observation.referenceRange.modifierExtension
                                                              Definition

                                                              May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                              Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                              ShortExtensions that cannot be ignored even if unrecognized
                                                              Comments

                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                              Control0..*
                                                              TypeExtension
                                                              Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                              Summarytrue
                                                              Requirements

                                                              Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                              Alternate Namesextensions, user content, modifiers
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              SlicingThis element introduces a set of slices on Observation.referenceRange.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                              • value @ url
                                                              • 236. Observation.referenceRange.low
                                                                Definition

                                                                The value of the low bound of the reference range.

                                                                ShortLow Range, if relevant
                                                                Comments

                                                                When low.comparator is not populated (the low.comparator element was not available prior to FHIR R6), the low bound of the reference range endpoint is inclusive of the value (e.g., reference range is '>=5' - '<=9'). Alternatively, this can be specified explicitly by populating low.comparator = '>='. When the low bound of the reference range endpoint is intended to be exclusive of the value (e.g., reference range is '>5' - '<9'), this is specified with low.comparator = '>'. If the low bound is omitted, it is assumed to be meaningless (e.g., reference range is '<=2.3').

                                                                Control0..1
                                                                This element is affected by the following invariants: obs-3
                                                                TypeQuantity
                                                                Is Modifierfalse
                                                                Must Supportfalse
                                                                Summaryfalse
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                obs-13: If low.comparator exists, it must be '>=' or '>'. (comparator.exists() implies (comparator = '>=' or comparator = '>'))
                                                                238. Observation.referenceRange.high
                                                                Definition

                                                                The value of the high bound of the reference range.

                                                                ShortHigh Range, if relevant
                                                                Comments

                                                                When high.comparator is not populated (the high.comparator element was not available prior to FHIR R6), the high bound of the reference range endpoint is inclusive of the value (e.g., reference range is '>=5' - '<=9'). Alternatively, this can be specified explicitly by populating high.comparator = '<='. When the high bound of the reference range endpoint is intended to be exclusive of the value (e.g., reference range is '>5' - '<9'), this is specified with high.comparator = '<'. If the high bound is omitted, it is assumed to be meaningless (e.g., reference range is '>=2.3').

                                                                Control0..1
                                                                This element is affected by the following invariants: obs-3
                                                                TypeQuantity
                                                                Is Modifierfalse
                                                                Must Supportfalse
                                                                Summaryfalse
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                obs-14: If high.comparator exists, it must be '<=' or '<'. (comparator.exists() implies (comparator = '<=' or comparator = '<'))
                                                                240. Observation.referenceRange.normalValue
                                                                Definition

                                                                The value of the normal value of the reference range.

                                                                ShortNormal value, if relevant
                                                                Control0..1
                                                                BindingFor example codes, see ObservationReferenceRangeNormalValueCodes
                                                                (example to http://hl7.org/fhir/ValueSet/observation-referencerange-normalvalue|6.0.0-ballot5)

                                                                Codes identifying the normal value of the observation.

                                                                TypeCodeableConcept
                                                                Is Modifierfalse
                                                                Must Supportfalse
                                                                Summaryfalse
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                242. Observation.referenceRange.type
                                                                Definition

                                                                Codes to indicate what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

                                                                ShortReference range qualifier
                                                                Comments

                                                                This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.

                                                                Control0..1
                                                                BindingThe codes SHOULD be taken from ObservationReferenceRangeMeaningCodes
                                                                (preferred to http://hl7.org/fhir/ValueSet/referencerange-meaning|6.0.0-ballot5)

                                                                Code for the meaning of a reference range.

                                                                TypeCodeableConcept
                                                                Is Modifierfalse
                                                                Must Supportfalse
                                                                Summaryfalse
                                                                Requirements

                                                                Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.

                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                244. Observation.referenceRange.appliesTo
                                                                Definition

                                                                Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple appliesTo are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

                                                                ShortReference range population
                                                                Comments

                                                                This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.

                                                                Control0..*
                                                                BindingFor example codes, see ObservationReferenceRangeAppliesToCodes
                                                                (example to http://hl7.org/fhir/ValueSet/referencerange-appliesto|6.0.0-ballot5)

                                                                Codes identifying the population the reference range applies to.

                                                                TypeCodeableConcept
                                                                Is Modifierfalse
                                                                Must Supportfalse
                                                                Summaryfalse
                                                                Requirements

                                                                Need to be able to identify the target population for proper interpretation.

                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                246. Observation.referenceRange.age
                                                                Definition

                                                                The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.

                                                                ShortApplicable age range, if relevant
                                                                Control0..1
                                                                TypeRange
                                                                Is Modifierfalse
                                                                Must Supportfalse
                                                                Summaryfalse
                                                                Requirements

                                                                Some analytes vary greatly over age.

                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                248. Observation.referenceRange.text
                                                                Definition

                                                                Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals".

                                                                ShortText based reference range in an observation
                                                                Control0..1
                                                                This element is affected by the following invariants: obs-3
                                                                Typemarkdown
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Must Supportfalse
                                                                Summaryfalse
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                250. Observation.hasMember
                                                                Definition

                                                                Reference to other PHD Observation resources that are part of this group observation; used for training sessions and other grouped measurements.

                                                                ShortOther PHD Observations that are part of this group observation.
                                                                Comments

                                                                When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see Notes below. Note that a system may calculate results from QuestionnaireResponse into a final score and represent the score as an Observation.

                                                                Control0..*
                                                                TypeReference(PhdBaseObservation)
                                                                Is Modifierfalse
                                                                Must Supportfalse
                                                                Summarytrue
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                252. Observation.derivedFrom
                                                                Definition

                                                                Reference to another PHD Observation resource that was used to create this Observation.

                                                                ShortA source the measurement data is derived from.
                                                                Comments

                                                                All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see Notes below.

                                                                Control0..*
                                                                TypeReference(PhdBaseObservation)
                                                                Is Modifierfalse
                                                                Must Supportfalse
                                                                Summarytrue
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                254. Observation.component
                                                                Definition

                                                                Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.

                                                                ShortComponent results
                                                                Comments

                                                                For a discussion on the ways Observations can be assembled in groups together see Notes below.

                                                                Control0..*
                                                                This element is affected by the following invariants: obs-7, obs-11, obs-10
                                                                TypeBackboneElement
                                                                Is Modifierfalse
                                                                Must Supportfalse
                                                                Summarytrue
                                                                Requirements

                                                                Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, reference range, dataAbsentReason, and interpretation can differ between the components and are not inherited; these should be provided if appropriate.

                                                                Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
                                                                SlicingThis element introduces a set of slices on Observation.component. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                • value @ code
                                                                • 256. Observation.component.id
                                                                  Definition

                                                                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                  ShortUnique id for inter-element referencing
                                                                  Control0..1
                                                                  This element is affected by the following invariants: ele-1
                                                                  Typestring
                                                                  Is Modifierfalse
                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                  Summaryfalse
                                                                  258. Observation.component.extension
                                                                  Definition

                                                                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                  ShortAdditional content defined by implementations
                                                                  Comments

                                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                  Control0..*
                                                                  TypeExtension
                                                                  Is Modifierfalse
                                                                  Summaryfalse
                                                                  Alternate Namesextensions, user content
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  SlicingThis element introduces a set of slices on Observation.component.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                  • value @ url
                                                                  • 260. Observation.component.modifierExtension
                                                                    Definition

                                                                    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                                    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                                    ShortExtensions that cannot be ignored even if unrecognized
                                                                    Comments

                                                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                    Control0..*
                                                                    TypeExtension
                                                                    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                    Summarytrue
                                                                    Requirements

                                                                    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                                    Alternate Namesextensions, user content, modifiers
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    SlicingThis element introduces a set of slices on Observation.component.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                    • value @ url
                                                                    • 262. Observation.component.code
                                                                      Definition

                                                                      Describes what was observed. Sometimes this is called the observation "code".

                                                                      ShortType of component observation (code / type)
                                                                      Comments

                                                                      All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

                                                                      Control1..1
                                                                      This element is affected by the following invariants: obs-7
                                                                      BindingFor example codes, see LOINCObsOrBoth
                                                                      (example to http://hl7.org/fhir/ValueSet/observation-codes-observationorboth|6.0.0-ballot5)

                                                                      Codes identifying names of simple observations.

                                                                      TypeCodeableConcept
                                                                      Is Modifierfalse
                                                                      Must Supportfalse
                                                                      Summarytrue
                                                                      Requirements

                                                                      Knowing what kind of observation is being made is essential to understanding the observation.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      264. Observation.component.value[x]
                                                                      Definition

                                                                      The information determined as a result of making the observation, if the information has a simple value.

                                                                      ShortActual component result
                                                                      Comments

                                                                      Used when observation has a set of component observations:

                                                                      • An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived).
                                                                      • If a value is present, the datatype for this element should be determined by the code.
                                                                      • CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the code defines a coded value.
                                                                      • Attachment is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the proof in this image), the binary file may be directly represented using DocumentReference and referenced by derivedFrom.
                                                                      • If a value is present, the datatype for this element should be determined by the code.
                                                                      • CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the code defines a coded value.
                                                                      • Attachment is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the proof in this image), the binary file may be directly represented using DocumentReference and referenced by derivedFrom.
                                                                      • For additional guidance, see the Notes section below.
                                                                      Control0..1
                                                                      This element is affected by the following invariants: obs-10
                                                                      TypeChoice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period, Attachment
                                                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                      Is Modifierfalse
                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                      Must Supportfalse
                                                                      Summarytrue
                                                                      Requirements

                                                                      An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      266. Observation.component.dataAbsentReason
                                                                      Definition

                                                                      Provides a reason why the expected value in the element Observation.component.value[x] is missing.

                                                                      ShortWhy the component result value is missing
                                                                      Comments

                                                                      "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done".

                                                                      The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values.

                                                                      Control0..1
                                                                      This element is affected by the following invariants: obs-10
                                                                      BindingUnless not suitable, these codes SHALL be taken from DataAbsentReason
                                                                      (extensible to http://hl7.org/fhir/ValueSet/data-absent-reason|6.0.0-ballot5)

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

                                                                      TypeCodeableConcept
                                                                      Is Modifierfalse
                                                                      Must Supportfalse
                                                                      Summaryfalse
                                                                      Requirements

                                                                      For many results it is necessary to handle exceptional values in measurements.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      268. Observation.component.interpretation
                                                                      Definition

                                                                      A categorical assessment of an observation value. For example, high, low, normal.

                                                                      ShortHigh, low, normal, etc
                                                                      Comments

                                                                      Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.

                                                                      Control0..*
                                                                      BindingUnless not suitable, these codes SHALL be taken from ObservationInterpretationCodes
                                                                      (extensible to http://hl7.org/fhir/ValueSet/observation-interpretation|6.0.0-ballot5)

                                                                      Codes identifying interpretations of observations.

                                                                      TypeCodeableConcept
                                                                      Is Modifierfalse
                                                                      Must Supportfalse
                                                                      Summaryfalse
                                                                      Requirements

                                                                      For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

                                                                      Alternate NamesAbnormal Flag
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      270. Observation.component.referenceRange
                                                                      Definition

                                                                      Guidance on how to interpret the value by comparison to a normal or recommended range.

                                                                      ShortProvides guide for interpretation of component result value
                                                                      Comments

                                                                      Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.

                                                                      Control0..*
                                                                      TypeSeettp://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange
                                                                      Is Modifierfalse
                                                                      Must Supportfalse
                                                                      Summaryfalse
                                                                      Requirements

                                                                      Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      272. Observation.component:supplementalTypesComponent
                                                                      Slice NamesupplementalTypesComponent
                                                                      Definition

                                                                      For each code contained in the Supplemental-Types attribute, a separate component is generated. The component is not generated if the attribute is absent or empty. The component shall be generated otherwise.

                                                                      ShortSupplemental Type: A further description of the measurement type.
                                                                      Comments

                                                                      A PHD may send a Supplemental-Types attribute as part of the measurement. This attribute consists of a set of MDC nomenclature codes. Each code describes an aspect of the measurement, such as MDC_MODALITY_SPOT in the pulse oximeter which indicates that the provided measurement is a stable average.

                                                                      Control0..*
                                                                      This element is affected by the following invariants: obs-7, obs-11, obs-10
                                                                      TypeBackboneElement
                                                                      Is Modifierfalse
                                                                      Must Supportfalse
                                                                      Summarytrue
                                                                      Requirements

                                                                      Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, reference range, dataAbsentReason, and interpretation can differ between the components and are not inherited; these should be provided if appropriate.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
                                                                      274. Observation.component:supplementalTypesComponent.id
                                                                      Definition

                                                                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                      ShortUnique id for inter-element referencing
                                                                      Control0..1
                                                                      This element is affected by the following invariants: ele-1
                                                                      Typestring
                                                                      Is Modifierfalse
                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                      Summaryfalse
                                                                      276. Observation.component:supplementalTypesComponent.extension
                                                                      Definition

                                                                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                      ShortAdditional content defined by implementations
                                                                      Comments

                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                      Control0..*
                                                                      TypeExtension
                                                                      Is Modifierfalse
                                                                      Summaryfalse
                                                                      Alternate Namesextensions, user content
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      SlicingThis element introduces a set of slices on Observation.component.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                      • value @ url
                                                                      • 278. Observation.component:supplementalTypesComponent.modifierExtension
                                                                        Definition

                                                                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                                        ShortExtensions that cannot be ignored even if unrecognized
                                                                        Comments

                                                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                        Control0..*
                                                                        TypeExtension
                                                                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                        Summarytrue
                                                                        Requirements

                                                                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                                        Alternate Namesextensions, user content, modifiers
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        SlicingThis element introduces a set of slices on Observation.component.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                        • value @ url
                                                                        • 280. Observation.component:supplementalTypesComponent.code
                                                                          Definition

                                                                          68193 is the 32-bit nomenclature code indicating a 'Supplemental-Types' value

                                                                          ShortSupplemental-Types code (68193)
                                                                          Comments

                                                                          All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

                                                                          Control1..1
                                                                          This element is affected by the following invariants: obs-7
                                                                          BindingFor example codes, see LOINCObsOrBoth
                                                                          (example to http://hl7.org/fhir/ValueSet/observation-codes-observationorboth|6.0.0-ballot5)

                                                                          Codes identifying names of simple observations.

                                                                          TypeCodeableConcept
                                                                          Is Modifierfalse
                                                                          Must Supportfalse
                                                                          Summarytrue
                                                                          Requirements

                                                                          Knowing what kind of observation is being made is essential to understanding the observation.

                                                                          Pattern Value{
                                                                            "coding" : [{
                                                                              "system" : "urn:iso:std:iso:11073:10101",
                                                                              "code" : "68193"
                                                                            }]
                                                                          }
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          282. Observation.component:supplementalTypesComponent.value[x]
                                                                          Definition

                                                                          The information determined as a result of making the observation, if the information has a simple value.

                                                                          ShortActual component result
                                                                          Comments

                                                                          Used when observation has a set of component observations:

                                                                          • An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived).
                                                                          • If a value is present, the datatype for this element should be determined by the code.
                                                                          • CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the code defines a coded value.
                                                                          • Attachment is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the proof in this image), the binary file may be directly represented using DocumentReference and referenced by derivedFrom.
                                                                          • If a value is present, the datatype for this element should be determined by the code.
                                                                          • CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the code defines a coded value.
                                                                          • Attachment is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the proof in this image), the binary file may be directly represented using DocumentReference and referenced by derivedFrom.
                                                                          • For additional guidance, see the Notes section below.
                                                                          Control0..1
                                                                          This element is affected by the following invariants: obs-10
                                                                          TypeCodeableConcept
                                                                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                          Is Modifierfalse
                                                                          Must Supportfalse
                                                                          Summarytrue
                                                                          Requirements

                                                                          An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          284. Observation.component:supplementalTypesComponent.value[x].id
                                                                          Definition

                                                                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                          ShortUnique id for inter-element referencing
                                                                          Control0..1
                                                                          This element is affected by the following invariants: ele-1
                                                                          Typestring
                                                                          Is Modifierfalse
                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                          Summaryfalse
                                                                          286. Observation.component:supplementalTypesComponent.value[x].extension
                                                                          Definition

                                                                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                          ShortAdditional content defined by implementations
                                                                          Comments

                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                          Control0..*
                                                                          TypeExtension
                                                                          Is Modifierfalse
                                                                          Summaryfalse
                                                                          Alternate Namesextensions, user content
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          SlicingThis element introduces a set of slices on Observation.component.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                          • value @ url
                                                                          • 288. Observation.component:supplementalTypesComponent.value[x].coding
                                                                            Definition

                                                                            A reference to a code defined by a terminology system.

                                                                            ShortCode defined by a terminology system
                                                                            Comments

                                                                            Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                            Control0..*
                                                                            TypeCoding
                                                                            Is Modifierfalse
                                                                            Summarytrue
                                                                            Requirements

                                                                            Allows for alternative encodings within a code system, and translations to other code systems.

                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            290. Observation.component:supplementalTypesComponent.value[x].coding.id
                                                                            Definition

                                                                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                            ShortUnique id for inter-element referencing
                                                                            Control0..1
                                                                            This element is affected by the following invariants: ele-1
                                                                            Typestring
                                                                            Is Modifierfalse
                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                            Summaryfalse
                                                                            292. Observation.component:supplementalTypesComponent.value[x].coding.extension
                                                                            Definition

                                                                            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                            ShortAdditional content defined by implementations
                                                                            Comments

                                                                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                            Control0..*
                                                                            TypeExtension
                                                                            Is Modifierfalse
                                                                            Summaryfalse
                                                                            Alternate Namesextensions, user content
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            SlicingThis element introduces a set of slices on Observation.component.value[x].coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                            • value @ url
                                                                            • 294. Observation.component:supplementalTypesComponent.value[x].coding.system
                                                                              Definition

                                                                              The identification of the code system that defines the meaning of the symbol in the code.

                                                                              ShortIdentity of the terminology system
                                                                              Comments

                                                                              The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.

                                                                              Control0..1
                                                                              Typeuri
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Summarytrue
                                                                              Requirements

                                                                              Need to be unambiguous about the source of the definition of the symbol.

                                                                              Pattern Valueurn:iso:std:iso:11073:10101
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              296. Observation.component:supplementalTypesComponent.value[x].coding.version
                                                                              Definition

                                                                              The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                              ShortVersion of the system - if relevant
                                                                              Comments

                                                                              Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                              NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                              Control0..1
                                                                              Typestring
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Summarytrue
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              298. Observation.component:supplementalTypesComponent.value[x].coding.code
                                                                              Definition

                                                                              A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                              ShortSymbol in syntax defined by the system
                                                                              Control0..1
                                                                              This element is affected by the following invariants: cod-1
                                                                              Typecode
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Summarytrue
                                                                              Requirements

                                                                              Need to refer to a particular code in the system.

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              300. Observation.component:supplementalTypesComponent.value[x].coding.display
                                                                              Definition

                                                                              A representation of the meaning of the code in the system, following the rules of the system.

                                                                              ShortRepresentation defined by the system
                                                                              Control0..1
                                                                              This element is affected by the following invariants: cod-1
                                                                              Typestring
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Summarytrue
                                                                              Requirements

                                                                              Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              302. Observation.component:supplementalTypesComponent.value[x].coding.userSelected
                                                                              Definition

                                                                              Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                              ShortIf this coding was chosen directly by the user
                                                                              Comments

                                                                              Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                              Control0..1
                                                                              Typeboolean
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Summarytrue
                                                                              Requirements

                                                                              This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              304. Observation.component:supplementalTypesComponent.value[x].text
                                                                              Definition

                                                                              A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                              ShortPlain text representation of the concept
                                                                              Comments

                                                                              Very often the text is the same as a displayName of one of the codings.

                                                                              Control0..1
                                                                              Typestring
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Summarytrue
                                                                              Requirements

                                                                              The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              306. Observation.component:supplementalTypesComponent.dataAbsentReason
                                                                              Definition

                                                                              Provides a reason why the expected value in the element Observation.component.value[x] is missing.

                                                                              ShortWhy the component result value is missing
                                                                              Comments

                                                                              "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done".

                                                                              The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values.

                                                                              Control0..0
                                                                              This element is affected by the following invariants: obs-10
                                                                              BindingUnless not suitable, these codes SHALL be taken from DataAbsentReason
                                                                              (extensible to http://hl7.org/fhir/ValueSet/data-absent-reason|6.0.0-ballot5)

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

                                                                              TypeCodeableConcept
                                                                              Is Modifierfalse
                                                                              Must Supportfalse
                                                                              Summaryfalse
                                                                              Requirements

                                                                              For many results it is necessary to handle exceptional values in measurements.

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              308. Observation.component:supplementalTypesComponent.interpretation
                                                                              Definition

                                                                              A categorical assessment of an observation value. For example, high, low, normal.

                                                                              ShortHigh, low, normal, etc
                                                                              Comments

                                                                              Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.

                                                                              Control0..*
                                                                              BindingUnless not suitable, these codes SHALL be taken from ObservationInterpretationCodes
                                                                              (extensible to http://hl7.org/fhir/ValueSet/observation-interpretation|6.0.0-ballot5)

                                                                              Codes identifying interpretations of observations.

                                                                              TypeCodeableConcept
                                                                              Is Modifierfalse
                                                                              Must Supportfalse
                                                                              Summaryfalse
                                                                              Requirements

                                                                              For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

                                                                              Alternate NamesAbnormal Flag
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              310. Observation.component:supplementalTypesComponent.referenceRange
                                                                              Definition

                                                                              Guidance on how to interpret the value by comparison to a normal or recommended range.

                                                                              ShortProvides guide for interpretation of component result value
                                                                              Comments

                                                                              Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.

                                                                              Control0..*
                                                                              TypeSeettp://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange
                                                                              Is Modifierfalse
                                                                              Must Supportfalse
                                                                              Summaryfalse
                                                                              Requirements

                                                                              Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))