MyHealtheVet PHR FHIR API
0.3.9-current - ci-build United States of America flag

MyHealtheVet PHR FHIR API, published by VA Digital Services. This guide is not an authorized publication; it is the continuous build for version 0.3.9-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/department-of-veterans-affairs/mhv-fhir-phr-mapping/ and changes regularly. See the Directory of published versions

Resource Profile: MHVlabTest - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 1

Definitions for the VA.MHV.PHR.labTest resource profile.

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

0. Observation
2. Observation.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..?
SlicingThis element introduces a set of slices on Observation.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • pattern @ use
  • 4. Observation.identifier:TOid
    Slice NameTOid
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control1..1
    6. Observation.identifier:TOid.use
    Control1..?
    Pattern Valueusual
    8. Observation.identifier:TOid.system
    Shorturn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
    InvariantsTOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} (value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.'))
    10. Observation.identifier:TOid.value
    Short`LabTestTO` | `.` | {LabTestTO.id}
    12. Observation.basedOn
    Control0..0
    14. Observation.partOf
    Control0..0
    16. Observation.status
    18. Observation.category
    20. Observation.code
    22. Observation.code.coding
    ShortLabTestTO.loinc
    Control0..1
    Must Supporttrue
    24. Observation.code.text
    ShortLabTestTO.name
    Control1..?
    Must Supporttrue
    26. Observation.focus
    Control0..0
    28. Observation.encounter
    Control0..0
    30. Observation.effective[x]
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    SlicingThis element introduces a set of slices on Observation.effective[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • type @ $this
    • 32. Observation.effective[x]:effectiveDateTime
      Slice NameeffectiveDateTime
      Control0..1
      TypedateTime
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Must Support TypesdateTime
      34. Observation.issued
      Must Supporttrue
      36. Observation.performer
      TypeReference(VA MHV PHR Organization)
      38. Observation.value[x]
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      SlicingThis element introduces a set of slices on Observation.value[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • type @ $this
      • 40. Observation.value[x]:valueString
        Slice NamevalueString
        Control0..1
        Typestring
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Must Support Typesstring
        42. Observation.dataAbsentReason
        Control0..0
        44. Observation.interpretation
        Control0..0
        46. Observation.note
        Control0..0
        48. Observation.bodySite
        Control0..0
        50. Observation.method
        Control0..0
        52. Observation.specimen
        TypeReference(VA MHV PHR Lab Specimen)
        Must Supporttrue
        54. Observation.device
        Control0..0
        56. Observation.referenceRange
        Control0..0
        58. Observation.hasMember
        Control0..0
        60. Observation.derivedFrom
        Control0..0
        62. Observation.component
        Control0..0

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

        0. Observation
        Definition

        -


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

        ShortMeasurements and simple assertions
        Comments

        -


        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 Signs, Measurement, Results, Tests
        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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').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: dataAbsentReason SHALL only be present if Observation.value[x] is not present (dataAbsentReason.empty() or value.empty())
        obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present (value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty())
        us-core-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present ((component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists()))
        obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present (dataAbsentReason.empty() or value.empty())
        obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present (value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty())
        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.

        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 it's 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 it's meaning or interpretation
        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()))
        4. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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
        Summaryfalse
        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()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        6. 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)
        Control10..*
        TypeIdentifier
        Is Modifierfalse
        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:
        • pattern @ use
        • 8. Observation.identifier:TOid
          Slice NameTOid
          Definition

          A unique identifier assigned to this observation.

          ShortBusiness Identifier for observation
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control10..1*
          TypeIdentifier
          Is Modifierfalse
          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()))
          10. Observation.identifier:TOid.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.

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

          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.

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

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

          Shorturn:oid:2.16.840.1.113883.4.349.4.{stationNbr}The namespace for the identifier value
          Comments

          Identifier.system is always case sensitive.

          Control0..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.

          Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} (value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.'))
          14. Observation.identifier:TOid.value
          Definition

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

          Short`LabTestTO` | `.` | {LabTestTO.id}The 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 extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

          Control0..1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Example<br/><b>General</b>:123456
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          16. 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..0*
          TypeReference(CarePlan, DeviceRequest, ImmunizationRecommendation, MedicationRequest, NutritionOrder, ServiceRequest)
          Is Modifierfalse
          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()))
          18. 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..0*
          TypeReference(MedicationAdministration, MedicationDispense, MedicationStatement, Procedure, Immunization, ImagingStudy)
          Is Modifierfalse
          Summarytrue
          Alternate NamesContainer
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          20. Observation.status
          Definition

          The status of the result value.

          Shortregistered | preliminary | final | amended +
          Comments

          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|4.0.1
          (required to http://hl7.org/fhir/ValueSet/observation-status)
          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 Supporttrue
          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()))
          22. 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
          (preferred to http://hl7.org/fhir/ValueSet/observation-category)

          Codes for high level observation categories.

          TypeCodeableConcept
          Is Modifierfalse
          Must Supporttrue
          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:
          • pattern @ $this
          • 24. Observation.category:Laboratory
            Slice NameLaboratory
            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..1*
            BindingThe codes SHOULD be taken from ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category
            (preferred to http://hl7.org/fhir/ValueSet/observation-category)

            Codes for high level observation categories.

            TypeCodeableConcept
            Is Modifierfalse
            Must Supporttrue
            Summaryfalse
            Requirements

            Used for filtering what observations are retrieved and displayed.

            Pattern Value{
              "coding" : [{
                "system" : "http://terminology.hl7.org/CodeSystem/observation-category",
                "code" : "laboratory"
              }]
            }
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            26. Observation.code
            Definition

            The test that was performed. A LOINC SHALL be used if the concept is present in LOINC.


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

            ShortLaboratory Test NameType of observation (code / type)
            Comments

            The typical patterns for codes are: 1) a LOINC code either as a translation from a "local" code or as a primary code, or 2) a local code only if no suitable LOINC exists, or 3) both the local and the LOINC translation. Systems SHALL be capable of sending the local code if one exists. When using LOINC , Use either the SHORTNAME or LONG_COMMON_NAME field for the display.


            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.

            Control1..1
            BindingUnless not suitable, these codes SHALL be taken from For example codes, see LOINCCodeshttp://hl7.org/fhir/ValueSet/observation-codes
            (extensible to http://hl7.org/fhir/ValueSet/observation-codes)

            LOINC codes


            Codes identifying names of simple observations.

            TypeCodeableConcept
            Is Modifierfalse
            Must Supporttrue
            Summarytrue
            Requirements

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

            Alternate NamesName, Test Name, Observation Identifer
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            28. Observation.code.coding
            Definition

            A reference to a code defined by a terminology system.

            ShortLabTestTO.loincCode 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..1*
            TypeCoding
            Is Modifierfalse
            Must Supporttrue
            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()))
            30. 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.

            ShortLabTestTO.namePlain text representation of the concept
            Comments

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

            Control10..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            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()))
            32. Observation.subject
            Definition

            The patient, or group of patients, location, or device this observation is about and into whose 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.

            ShortWho 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.

            Control10..1
            TypeReference(US Core Patient Profile, Patient, Group, Device, Location)
            Is Modifierfalse
            Must Supporttrue
            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()))
            34. Observation.focus
            Definition

            The actual focus of an observation when it is not the patient 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.

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

            Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use specimen if a reference to a specimen is required. If a code is required instead of a resource use either bodysite for bodysites or the standard extension focusCode.

            Control0..0*
            TypeReference(Resource)
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            36. 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
            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..01
            TypeReference(Encounter)
            Is Modifierfalse
            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()))
            38. Observation.effective[x]
            Definition

            For lab tests this is the specimen collection date. For Ask at Order Entry Questions (AOE)'s this is the date the question was asked.


            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
            This element is affected by the following invariants: us-core-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 Supporttrue
            Must Support TypesdateTime
            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()))
            us-core-1: Datetime must be at least to day. ($this is DateTime implies $this.toString().length() >= 10)
            SlicingThis element introduces a set of slices on Observation.effective[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • type @ $this
            • 40. Observation.effective[x]:effectiveDateTime
              Slice NameeffectiveDateTime
              Definition

              For lab tests this is the specimen collection date. For Ask at Order Entry Questions (AOE)'s this is the date the question was asked.


              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
              This element is affected by the following invariants: us-core-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 Supporttrue
              Must Support TypesdateTime
              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()))
              us-core-1: Datetime must be at least to day. ($this is DateTime implies $this.toString().length() >= 10)
              42. 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 Supporttrue
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              44. Observation.performer
              Definition

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

              ShortWho is responsible for the observation
              Control0..*
              TypeReference(VA MHV PHR Organization, Practitioner, PractitionerRole, Organization, CareTeam, Patient, RelatedPerson)
              Is Modifierfalse
              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()))
              46. Observation.value[x]
              Definition

              The Laboratory result value. If a coded value, the valueCodeableConcept.code SHOULD be selected from SNOMED CT if the concept exists. If a numeric value, valueQuantity.code SHALL be selected from UCUM. A FHIR UCUM Codes value set that defines all UCUM codes is in the FHIR specification.


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

              ShortResult ValueActual result
              Comments

              An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. If a value is present, the datatype for this element should be determined by Observation.code. A 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 Observation.code defines a coded value. For additional guidance, see the Notes section below.

              Control0..1
              This element is affected by the following invariants: obs-7, us-core-2, us-core-3, us-core-4
              TypeChoice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, 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 Supporttrue
              Must Support TypesChoice of: Quantity, CodeableConcept, string
              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()))
              us-core-4: SHOULD use Snomed CT for coded Results (valueCodeableConcept.coding.system.empty() or valueCodeableConcept.coding.system = 'http://snomed.info/sct')
              us-core-3: SHALL use UCUM for coded quantity units. (valueQuantity.system.empty() or valueQuantity.system = 'http://unitsofmeasure.org')
              SlicingThis element introduces a set of slices on Observation.value[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • type @ $this
              • 48. Observation.value[x]:valueString
                Slice NamevalueString
                Definition

                The Laboratory result value. If a coded value, the valueCodeableConcept.code SHOULD be selected from SNOMED CT if the concept exists. If a numeric value, valueQuantity.code SHALL be selected from UCUM. A FHIR UCUM Codes value set that defines all UCUM codes is in the FHIR specification.


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

                ShortResult ValueActual result
                Comments

                An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. If a value is present, the datatype for this element should be determined by Observation.code. A 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 Observation.code defines a coded value. For additional guidance, see the Notes section below.

                Control0..1
                This element is affected by the following invariants: obs-7, us-core-2, us-core-3, us-core-4
                Typestring, dateTime, boolean, SampledData, Quantity, Period, Ratio, integer, time, Range, CodeableConcept
                [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 Supporttrue
                Must Support TypesstringQuantity
                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()))
                us-core-4: SHOULD use Snomed CT for coded Results (valueCodeableConcept.coding.system.empty() or valueCodeableConcept.coding.system = 'http://snomed.info/sct')
                us-core-3: SHALL use UCUM for coded quantity units. (valueQuantity.system.empty() or valueQuantity.system = 'http://unitsofmeasure.org')
                50. Observation.dataAbsentReason
                Definition

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

                ShortWhy the result 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 "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. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values.

                Control0..01
                This element is affected by the following invariants: obs-6, us-core-2
                BindingUnless not suitable, these codes SHALL be taken from DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason
                (extensible to http://hl7.org/fhir/ValueSet/data-absent-reason)
                TypeCodeableConcept
                Is Modifierfalse
                Must Supporttrue
                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()))
                52. 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..0*
                BindingUnless not suitable, these codes SHALL be taken from ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation
                (extensible to http://hl7.org/fhir/ValueSet/observation-interpretation)

                Codes identifying interpretations of observations.

                TypeCodeableConcept
                Is Modifierfalse
                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()))
                54. 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..0*
                TypeAnnotation
                Is Modifierfalse
                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()))
                56. Observation.bodySite
                Definition

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

                ShortObserved body part
                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.

                If the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension bodySite.

                Control0..01
                BindingFor example codes, see SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site
                (example to http://hl7.org/fhir/ValueSet/body-site)

                Codes describing anatomical locations. May include laterality.

                TypeCodeableConcept
                Is Modifierfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                58. 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..01
                BindingFor example codes, see ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methods
                (example to http://hl7.org/fhir/ValueSet/observation-methods)

                Methods for simple observations.

                TypeCodeableConcept
                Is Modifierfalse
                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()))
                60. Observation.specimen
                Definition

                The specimen that was used when this observation was made.

                ShortSpecimen used for this observation
                Comments

                Should only be used if not implicit in code found in Observation.code. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).

                Control0..1
                TypeReference(VA MHV PHR Lab Specimen, Specimen)
                Is Modifierfalse
                Must Supporttrue
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                62. Observation.device
                Definition

                The device used to generate the observation data.

                Short(Measurement) Device
                Comments

                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.

                Control0..01
                TypeReference(Device, DeviceMetric)
                Is Modifierfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                64. 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..0*
                TypeBackboneElement
                Is Modifierfalse
                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()))
                obs-3: Must have at least a low or a high or text (low.exists() or high.exists() or text.exists())
                obs-3: Must have at least a low or a high or text (low.exists() or high.exists() or text.exists())
                67. Observation.hasMember
                Definition

                This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.

                ShortRelated resource that belongs to the Observation group
                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.


                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..0*
                TypeReference(Observation, QuestionnaireResponse, MolecularSequence)
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                69. Observation.derivedFrom
                Definition

                The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.

                ShortRelated measurements the observation is made 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..0*
                TypeReference(DocumentReference, ImagingStudy, Media, QuestionnaireResponse, Observation, MolecularSequence)
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                71. 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..0*
                TypeBackboneElement
                Is Modifierfalse
                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, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation.

                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 found here

                0. Observation
                Definition

                -

                ShortMeasurements and simple assertions
                Comments

                -

                Control0..*
                Is Modifierfalse
                Must Supportfalse
                Summaryfalse
                Alternate NamesVital Signs, Measurement, Results, Tests
                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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').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: dataAbsentReason SHALL only be present if Observation.value[x] is not present (dataAbsentReason.empty() or value.empty())
                obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present (value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty())
                us-core-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present ((component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.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

                The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

                Control0..1
                Typeid
                Is Modifierfalse
                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
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                6. 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.

                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 it's 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 it's meaning or interpretation
                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()))
                8. 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 SHOULD be taken from CommonLanguages
                (preferred to http://hl7.org/fhir/ValueSet/languages)

                A human language.

                Additional BindingsPurpose
                AllLanguagesMax Binding
                Typecode
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                10. 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 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
                TypeNarrative
                Is Modifierfalse
                Summaryfalse
                Alternate Namesnarrative, html, xhtml, display
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                12. Observation.contained
                Definition

                These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

                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.

                Control0..*
                TypeResource
                Is Modifierfalse
                Summaryfalse
                Alternate Namesinline resources, anonymous resources, contained resources
                14. Observation.extension
                Definition

                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 manageable, 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()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                16. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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
                Summaryfalse
                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()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                18. 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)
                Control1..*
                TypeIdentifier
                Is Modifierfalse
                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:
                • pattern @ use
                • 20. Observation.identifier:TOid
                  Slice NameTOid
                  Definition

                  A unique identifier assigned to this observation.

                  ShortBusiness Identifier for observation
                  NoteThis is a business identifier, not a resource identifier (see discussion)
                  Control1..1
                  TypeIdentifier
                  Is Modifierfalse
                  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()))
                  22. Observation.identifier:TOid.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
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  24. Observation.identifier:TOid.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 manageable, 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()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  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
                  • 26. Observation.identifier:TOid.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.

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

                    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.

                    Pattern Valueusual
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    28. Observation.identifier:TOid.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..1
                    BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                    (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

                    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:TOid.system
                    Definition

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

                    Shorturn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
                    Comments

                    Identifier.system is always case sensitive.

                    Control0..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.

                    Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} (value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.'))
                    32. Observation.identifier:TOid.value
                    Definition

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

                    Short`LabTestTO` | `.` | {LabTestTO.id}
                    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 extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                    Control0..1
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Example<br/><b>General</b>:123456
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    34. Observation.identifier:TOid.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()))
                    36. Observation.identifier:TOid.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()))
                    38. 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..0
                    TypeReference(CarePlan, DeviceRequest, ImmunizationRecommendation, MedicationRequest, NutritionOrder, ServiceRequest)
                    Is Modifierfalse
                    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()))
                    40. 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..0
                    TypeReference(MedicationAdministration, MedicationDispense, MedicationStatement, Procedure, Immunization, ImagingStudy)
                    Is Modifierfalse
                    Summarytrue
                    Alternate NamesContainer
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    42. Observation.status
                    Definition

                    The status of the result value.

                    Shortregistered | preliminary | final | amended +
                    Comments

                    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 ObservationStatus
                    (required to http://hl7.org/fhir/ValueSet/observation-status)
                    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 Supporttrue
                    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()))
                    44. 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)

                    Codes for high level observation categories.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Must Supporttrue
                    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:
                    • pattern @ $this
                    • 46. Observation.category:Laboratory
                      Slice NameLaboratory
                      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..1
                      BindingThe codes SHOULD be taken from ObservationCategoryCodes
                      (preferred to http://hl7.org/fhir/ValueSet/observation-category)

                      Codes for high level observation categories.

                      TypeCodeableConcept
                      Is Modifierfalse
                      Must Supporttrue
                      Summaryfalse
                      Requirements

                      Used for filtering what observations are retrieved and displayed.

                      Pattern Value{
                        "coding" : [{
                          "system" : "http://terminology.hl7.org/CodeSystem/observation-category",
                          "code" : "laboratory"
                        }]
                      }
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      48. Observation.code
                      Definition

                      The test that was performed. A LOINC SHALL be used if the concept is present in LOINC.

                      ShortLaboratory Test Name
                      Comments

                      The typical patterns for codes are: 1) a LOINC code either as a translation from a "local" code or as a primary code, or 2) a local code only if no suitable LOINC exists, or 3) both the local and the LOINC translation. Systems SHALL be capable of sending the local code if one exists. When using LOINC , Use either the SHORTNAME or LONG_COMMON_NAME field for the display.

                      Control1..1
                      BindingUnless not suitable, these codes SHALL be taken from LOINCCodes
                      (extensible to http://hl7.org/fhir/ValueSet/observation-codes)

                      LOINC codes

                      TypeCodeableConcept
                      Is Modifierfalse
                      Must Supporttrue
                      Summarytrue
                      Requirements

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

                      Alternate NamesName, Test Name, Observation Identifer
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      50. 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
                      Typestring
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      52. 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 manageable, 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()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      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
                      • 54. Observation.code.coding
                        Definition

                        A reference to a code defined by a terminology system.

                        ShortLabTestTO.loinc
                        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..1
                        TypeCoding
                        Is Modifierfalse
                        Must Supporttrue
                        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()))
                        56. 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.

                        ShortLabTestTO.name
                        Comments

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

                        Control1..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        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()))
                        58. Observation.subject
                        Definition

                        The patient, or group of patients, location, or device this observation is about and into whose 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.

                        ShortWho 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.

                        Control1..1
                        TypeReference(US Core Patient Profile)
                        Is Modifierfalse
                        Must Supporttrue
                        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()))
                        60. Observation.focus
                        Definition

                        The actual focus of an observation when it is not the patient 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.

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

                        Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use specimen if a reference to a specimen is required. If a code is required instead of a resource use either bodysite for bodysites or the standard extension focusCode.

                        Control0..0
                        TypeReference(Resource)
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        62. 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
                        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..0
                        TypeReference(Encounter)
                        Is Modifierfalse
                        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()))
                        64. Observation.effective[x]
                        Definition

                        For lab tests this is the specimen collection date. For Ask at Order Entry Questions (AOE)'s this is the date the question was asked.

                        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
                        This element is affected by the following invariants: us-core-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 Supporttrue
                        Must Support TypesdateTime
                        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()))
                        us-core-1: Datetime must be at least to day. ($this is DateTime implies $this.toString().length() >= 10)
                        SlicingThis element introduces a set of slices on Observation.effective[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • type @ $this
                        • 66. Observation.effective[x]:effectiveDateTime
                          Slice NameeffectiveDateTime
                          Definition

                          For lab tests this is the specimen collection date. For Ask at Order Entry Questions (AOE)'s this is the date the question was asked.

                          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
                          This element is affected by the following invariants: us-core-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 Supporttrue
                          Must Support TypesdateTime
                          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()))
                          us-core-1: Datetime must be at least to day. ($this is DateTime implies $this.toString().length() >= 10)
                          68. 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 Supporttrue
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          70. Observation.performer
                          Definition

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

                          ShortWho is responsible for the observation
                          Control0..*
                          TypeReference(VA MHV PHR Organization)
                          Is Modifierfalse
                          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()))
                          72. Observation.value[x]
                          Definition

                          The Laboratory result value. If a coded value, the valueCodeableConcept.code SHOULD be selected from SNOMED CT if the concept exists. If a numeric value, valueQuantity.code SHALL be selected from UCUM. A FHIR UCUM Codes value set that defines all UCUM codes is in the FHIR specification.

                          ShortResult Value
                          Comments

                          An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. If a value is present, the datatype for this element should be determined by Observation.code. A 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 Observation.code defines a coded value. For additional guidance, see the Notes section below.

                          Control0..1
                          This element is affected by the following invariants: obs-7, us-core-2, us-core-3, us-core-4
                          TypeChoice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, 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 Supporttrue
                          Must Support TypesChoice of: Quantity, CodeableConcept, string
                          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()))
                          us-core-4: SHOULD use Snomed CT for coded Results (valueCodeableConcept.coding.system.empty() or valueCodeableConcept.coding.system = 'http://snomed.info/sct')
                          us-core-3: SHALL use UCUM for coded quantity units. (valueQuantity.system.empty() or valueQuantity.system = 'http://unitsofmeasure.org')
                          SlicingThis element introduces a set of slices on Observation.value[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • type @ $this
                          • 74. Observation.value[x]:valueString
                            Slice NamevalueString
                            Definition

                            The Laboratory result value. If a coded value, the valueCodeableConcept.code SHOULD be selected from SNOMED CT if the concept exists. If a numeric value, valueQuantity.code SHALL be selected from UCUM. A FHIR UCUM Codes value set that defines all UCUM codes is in the FHIR specification.

                            ShortResult Value
                            Comments

                            An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. If a value is present, the datatype for this element should be determined by Observation.code. A 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 Observation.code defines a coded value. For additional guidance, see the Notes section below.

                            Control0..1
                            This element is affected by the following invariants: obs-7, us-core-2, us-core-3, us-core-4
                            Typestring
                            [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 Supporttrue
                            Must Support Typesstring
                            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()))
                            us-core-4: SHOULD use Snomed CT for coded Results (valueCodeableConcept.coding.system.empty() or valueCodeableConcept.coding.system = 'http://snomed.info/sct')
                            us-core-3: SHALL use UCUM for coded quantity units. (valueQuantity.system.empty() or valueQuantity.system = 'http://unitsofmeasure.org')
                            76. Observation.dataAbsentReason
                            Definition

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

                            ShortWhy the result 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 "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. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values.

                            Control0..0
                            This element is affected by the following invariants: obs-6, us-core-2
                            BindingUnless not suitable, these codes SHALL be taken from DataAbsentReason
                            (extensible to http://hl7.org/fhir/ValueSet/data-absent-reason)
                            TypeCodeableConcept
                            Is Modifierfalse
                            Must Supporttrue
                            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()))
                            78. 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..0
                            BindingUnless not suitable, these codes SHALL be taken from ObservationInterpretationCodes
                            (extensible to http://hl7.org/fhir/ValueSet/observation-interpretation)

                            Codes identifying interpretations of observations.

                            TypeCodeableConcept
                            Is Modifierfalse
                            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()))
                            80. 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..0
                            TypeAnnotation
                            Is Modifierfalse
                            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()))
                            82. Observation.bodySite
                            Definition

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

                            ShortObserved body part
                            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.

                            If the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension bodySite.

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

                            Codes describing anatomical locations. May include laterality.

                            TypeCodeableConcept
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            84. 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..0
                            BindingFor example codes, see ObservationMethods
                            (example to http://hl7.org/fhir/ValueSet/observation-methods)

                            Methods for simple observations.

                            TypeCodeableConcept
                            Is Modifierfalse
                            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()))
                            86. Observation.specimen
                            Definition

                            The specimen that was used when this observation was made.

                            ShortSpecimen used for this observation
                            Comments

                            Should only be used if not implicit in code found in Observation.code. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).

                            Control0..1
                            TypeReference(VA MHV PHR Lab Specimen)
                            Is Modifierfalse
                            Must Supporttrue
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            88. Observation.device
                            Definition

                            The device used to generate the observation data.

                            Short(Measurement) Device
                            Comments

                            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.

                            Control0..0
                            TypeReference(Device, DeviceMetric)
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            90. 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..0
                            TypeBackboneElement
                            Is Modifierfalse
                            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()))
                            obs-3: Must have at least a low or a high or text (low.exists() or high.exists() or text.exists())
                            101. Observation.hasMember
                            Definition

                            This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.

                            ShortRelated resource that belongs to the Observation group
                            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..0
                            TypeReference(Observation, QuestionnaireResponse, MolecularSequence)
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            103. Observation.derivedFrom
                            Definition

                            The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.

                            ShortRelated measurements the observation is made 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..0
                            TypeReference(DocumentReference, ImagingStudy, Media, QuestionnaireResponse, Observation, MolecularSequence)
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            105. 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..0
                            TypeBackboneElement
                            Is Modifierfalse
                            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, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation.

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