FHIR Release 3 (STU)

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

10.1 Resource Observation - Content

Orders and Observations Work GroupMaturity Level: 5 Trial UseCompartments: Device, Encounter, Patient, Practitioner, RelatedPerson

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

10.1.1 Scope and Usage

This resource is an event resource from a FHIR workflow perspective - see Workflow.

Observations are a central element in healthcare, used to support diagnosis, monitor progress, determine baselines and patterns and even capture demographic characteristics. Most observations are simple name/value pair assertions with some metadata, but some observations group other observations together logically, or even are multi-component observations. Note that the DiagnosticReport resource provides a clinical or workflow context for a set of observations and the Observation resource is referenced by DiagnosticReport to represent lab, imaging, and other clinical and diagnostic data to form a complete report.

Uses for the Observation resource include:

10.1.1.1 Core Profiles for Observation

The following core profiles for the Observation resource have been defined as well. If implementations use this Resource when expressing the profile-specific concepts as structured data, they SHALL conform to the following profiles:

Profile Description
Vital signs The FHIR Vital Signs profile sets a minimum expectations for the Observation Resource to record, search and fetch the vital signs (e.g. temperature, blood pressure, respiration rate, etc) associated with a patient

10.1.2 Boundaries and Relationships

In contrast to the Observation resource, the DiagnosticReport resource typically includes additional clinical context and some mix of atomic results, images, imaging reports, textual and coded interpretation, and formatted representations. Laboratory reports, pathology reports, and imaging reports should be represented using the DiagnosticReport resource. The Observation resource is referenced by the DiagnosticReport to provide the atomic results for a particular investigation.

"Laboratories routinely have a variable that is summative across a series of discrete variables - these are usually called 'impressions' or 'interpretations'. Sometimes they are algorithmically specified and sometimes they have the imprimatur of pathologists and they are conveyed in Observation or DiagnosticReport instead of the Clinical Impression resource. However, the Observation resources should not be used to record clinical diagnosis about a patient or subject that are typically captured in the Condition resource or the ClinicalImpression resource.

The Observation resource is often referenced by the Condition resource to provide specific subjective and objective data to support its assertions. There are other resources that can be considered "specializations" of the Observation resource and should be used for those specific contexts and use cases. They include AllergyIntolerance resource, FamilyMemberHistory resource, Procedure resource, and Questionnaire resource. In some cases, such as when source data is coming from an HL7 v2 feed, a system may not have information that allows it to distinguish diagnosis, allergy and other "specialized" types of observations from lab, vital sign and other observation types intended to be conveyed with this resource. In those circumstances, such specialized observations may also appear using this resource.

The Media resource captures a specific type of observation whose value is audio, video or image data. This resource is the preferred representation of such forms of information as it exposes the metadata relevant for interpreting the information. However, in some implementations, media information may appear in Observation susing the valueAttachment element and systems should be aware of this possibility.

This resource is referenced by AdverseEvent, ChargeItem, ClinicalImpression, Communication, CommunicationRequest, Condition, DiagnosticReport, FamilyMemberHistory, Goal, Immunization, ImmunizationRecommendation, MedicationAdministration, MedicationRequest, MedicationStatement, Procedure, ProcedureRequest, QuestionnaireResponse, ReferralRequest and Sequence

10.1.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation IDomainResourceMeasurements and simple assertions
+ If code is the same as a component code then the value element associated with the code SHALL NOT be present
+ dataAbsentReason SHALL only be present if Observation.value[x] is not present
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ProcedureRequest | ReferralRequest)Fulfills plan, proposal or order
... status ?!Σ1..1coderegistered | preliminary | final | amended +
ObservationStatus (Required)
... category 0..*CodeableConceptClassification of type of observation
Observation Category Codes (Preferred)
... code Σ1..1CodeableConceptType of observation (code / type)
LOINC Codes (Example)
... subject Σ0..1Reference(Patient | Group | Device | Location)Who and/or what this is about
... context 0..1Reference(Encounter | EpisodeOfCare)Healthcare event during which this observation is made
... effective[x] Σ0..1Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... issued Σ0..1instantDate/Time this was made available
... performer Σ0..*Reference(Practitioner | Organization | Patient | RelatedPerson)Who is responsible for the observation
... value[x] ΣI0..1Actual result
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueAttachmentAttachment
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Observation Value Absent Reason (Extensible)
... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Observation Interpretation Codes (Extensible)
... comment 0..1stringComments about result
... bodySite 0..1CodeableConceptObserved body part
SNOMED CT Body Structures (Example)
... method 0..1CodeableConceptHow it was done
Observation Methods (Example)
... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I0..*BackboneElementProvides guide for interpretation
+ Must have at least a low or a high or text
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... type 0..1CodeableConceptReference range qualifier
Observation Reference Range Meaning Codes (Extensible)
.... appliesTo 0..*CodeableConceptReference range population
Observation Reference Range Applies To Codes (Example)
.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... related Σ0..*BackboneElementResource related to this observation
.... type 0..1codehas-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
ObservationRelationshipType (Required)
.... target 1..1Reference(Observation | QuestionnaireResponse | Sequence)Resource that is related to this one
... component Σ0..*BackboneElementComponent results
.... code Σ1..1CodeableConceptType of component observation (code / type)
LOINC Codes (Example)
.... value[x] Σ0..1Actual component result
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueAttachmentAttachment
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Observation Value Absent Reason (Extensible)
.... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Observation Interpretation Codes (Extensible)
.... referenceRange 0..*see referenceRangeProvides guide for interpretation of component result

doco Documentation for this format

UML Diagram (Legend)

Observation (DomainResource)A unique identifier assigned to this observationidentifier : Identifier [0..*]A plan, proposal or order that is fulfilled in whole or in part by this eventbasedOn : Reference [0..*] CarePlan|DeviceRequest| ImmunizationRecommendation|MedicationRequest|NutritionOrder| ProcedureRequest|ReferralRequest The status of the result value (this element modifies the meaning of other elements)status : code [1..1] Codes providing the status of an observation. (Strength=Required)ObservationStatus! A code that classifies the general type of observation being madecategory : CodeableConcept [0..*] Codes for high level observation categories. (Strength=Preferred)Observation Category ? Describes what was observed. Sometimes this is called the observation "name"code : CodeableConcept [1..1] Codes identifying names of simple observations. (Strength=Example)LOINC ?? The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subjectsubject : Reference [0..1] Patient|Group|Device|Location The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is madecontext : Reference [0..1] Encounter|EpisodeOfCare 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 itselfeffective[x] : Type [0..1] dateTime|Period The date and time this observation was made available to providers, typically after the results have been reviewed and verifiedissued : instant [0..1]Who was responsible for asserting the observed value as "true"performer : Reference [0..*] Practitioner|Organization|Patient| RelatedPerson The information determined as a result of making the observation, if the information has a simple valuevalue[x] : Type [0..1] Quantity|CodeableConcept|string|boolean| Range|Ratio|SampledData|Attachment|time|dateTime|Period Provides a reason why the expected value in the element Observation.value[x] is missingdataAbsentReason : CodeableConcept [0..1] Codes specifying why the result (Observation.value[x]) is missing. (Strength=Extensible)Observation Value Absent Reas...+ The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flaginterpretation : CodeableConcept [0..1] Codes identifying interpretations of observations. (Strength=Extensible)Observation Interpretation + May include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the resultcomment : string [0..1]Indicates the site on the subject's body where the observation was made (i.e. the target site)bodySite : CodeableConcept [0..1] Codes describing anatomical locations. May include laterality. (Strength=Example)SNOMED CT Body Structures?? Indicates the mechanism used to perform the observationmethod : CodeableConcept [0..1] Methods for simple observations. (Strength=Example)Observation Methods?? The specimen that was used when this observation was madespecimen : Reference [0..1] Specimen The device used to generate the observation datadevice : Reference [0..1] Device|DeviceMetric ReferenceRangeThe value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3)low : Quantity(SimpleQuantity) [0..1]The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3)high : Quantity(SimpleQuantity) [0..1]Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic rangetype : CodeableConcept [0..1] Code for the meaning of a reference range. (Strength=Extensible)Observation Reference Range M...+ Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or raceappliesTo : CodeableConcept [0..*] Codes identifying the population the reference range applies to. (Strength=Example)Observation Reference Range A...?? The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says soage : Range [0..1]Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of 'normals'text : string [0..1]RelatedA code specifying the kind of relationship that exists with the target resourcetype : code [0..1] Codes specifying how two observations are related. (Strength=Required)ObservationRelationshipType! A reference to the observation or [[[QuestionnaireResponse]]] resource that is related to this observationtarget : Reference [1..1] Observation|QuestionnaireResponse| Sequence ComponentDescribes what was observed. Sometimes this is called the observation "code"code : CodeableConcept [1..1] Codes identifying names of simple observations. (Strength=Example)LOINC ?? The information determined as a result of making the observation, if the information has a simple valuevalue[x] : Type [0..1] Quantity|CodeableConcept|string|Range|Ratio| SampledData|Attachment|time|dateTime|Period Provides a reason why the expected value in the element Observation.value[x] is missingdataAbsentReason : CodeableConcept [0..1] Codes specifying why the result (Observation.value[x]) is missing. (Strength=Extensible)Observation Value Absent Reas...+ The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flaginterpretation : CodeableConcept [0..1] Codes identifying interpretations of observations. (Strength=Extensible)Observation Interpretation + Guidance on how to interpret the value by comparison to a normal or recommended rangereferenceRange[0..*]A reference to another resource (usually another Observation) whose relationship is defined by the relationship type coderelated[0..*]Guidance on how to interpret the value by comparison to a normal or recommended rangereferenceRange[0..*]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 observationscomponent[0..*]

XML Template

<Observation xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business Identifier for observation --></identifier>
 <basedOn><!-- 0..* Reference(CarePlan|DeviceRequest|ImmunizationRecommendation|
   MedicationRequest|NutritionOrder|ProcedureRequest|ReferralRequest) Fulfills plan, proposal or order --></basedOn>
 <status value="[code]"/><!-- 1..1 registered | preliminary | final | amended + -->
 <category><!-- 0..* CodeableConcept Classification of  type of observation --></category>
 <code><!-- 1..1 CodeableConcept Type of observation (code / type) --></code>
 <subject><!-- 0..1 Reference(Patient|Group|Device|Location) Who and/or what this is about --></subject>
 <context><!-- 0..1 Reference(Encounter|EpisodeOfCare) Healthcare event during which this observation is made --></context>
 <effective[x]><!-- 0..1 dateTime|Period Clinically relevant time/time-period for observation --></effective[x]>
 <issued value="[instant]"/><!-- 0..1 Date/Time this was made available -->
 <performer><!-- 0..* Reference(Practitioner|Organization|Patient|RelatedPerson) Who is responsible for the observation --></performer>
 <value[x]><!-- ?? 0..1 Quantity|CodeableConcept|string|boolean|Range|Ratio|
   SampledData|Attachment|time|dateTime|Period Actual result --></value[x]>
 <dataAbsentReason><!-- ?? 0..1 CodeableConcept Why the result is missing --></dataAbsentReason>
 <interpretation><!-- 0..1 CodeableConcept High, low, normal, etc. --></interpretation>
 <comment value="[string]"/><!-- 0..1 Comments about result -->
 <bodySite><!-- 0..1 CodeableConcept Observed body part --></bodySite>
 <method><!-- 0..1 CodeableConcept How it was done --></method>
 <specimen><!-- 0..1 Reference(Specimen) Specimen used for this observation --></specimen>
 <device><!-- 0..1 Reference(Device|DeviceMetric) (Measurement) Device --></device>
 <referenceRange>  <!-- 0..* Provides guide for interpretation -->
  <low><!-- ?? 0..1 Quantity(SimpleQuantity) Low Range, if relevant --></low>
  <high><!-- ?? 0..1 Quantity(SimpleQuantity) High Range, if relevant --></high>
  <type><!-- 0..1 CodeableConcept Reference range qualifier --></type>
  <appliesTo><!-- 0..* CodeableConcept Reference range population --></appliesTo>
  <age><!-- 0..1 Range Applicable age range, if relevant --></age>
  <text value="[string]"/><!-- 0..1 Text based reference range in an observation -->
 </referenceRange>
 <related>  <!-- 0..* Resource related to this observation -->
  <type value="[code]"/><!-- 0..1 has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by -->
  <target><!-- 1..1 Reference(Observation|QuestionnaireResponse|Sequence) Resource that is related to this one --></target>
 </related>
 <component>  <!-- 0..* Component results -->
  <code><!-- 1..1 CodeableConcept Type of component observation (code / type) --></code>
  <value[x]><!-- 0..1 Quantity|CodeableConcept|string|Range|Ratio|SampledData|
    Attachment|time|dateTime|Period Actual component result --></value[x]>
  <dataAbsentReason><!-- ?? 0..1 CodeableConcept Why the component result is missing --></dataAbsentReason>
  <interpretation><!-- 0..1 CodeableConcept High, low, normal, etc. --></interpretation>
  <referenceRange><!-- 0..* Content as for Observation.referenceRange Provides guide for interpretation of component result --></referenceRange>
 </component>
</Observation>

JSON Template

{doco
  "resourceType" : "Observation",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifier for observation
  "basedOn" : [{ Reference(CarePlan|DeviceRequest|ImmunizationRecommendation|
   MedicationRequest|NutritionOrder|ProcedureRequest|ReferralRequest) }], // Fulfills plan, proposal or order
  "status" : "<code>", // R!  registered | preliminary | final | amended +
  "category" : [{ CodeableConcept }], // Classification of  type of observation
  "code" : { CodeableConcept }, // R!  Type of observation (code / type)
  "subject" : { Reference(Patient|Group|Device|Location) }, // Who and/or what this is about
  "context" : { Reference(Encounter|EpisodeOfCare) }, // Healthcare event during which this observation is made
  // effective[x]: Clinically relevant time/time-period for observation. One of these 2:
  "effectiveDateTime" : "<dateTime>",
  "effectivePeriod" : { Period },
  "issued" : "<instant>", // Date/Time this was made available
  "performer" : [{ Reference(Practitioner|Organization|Patient|RelatedPerson) }], // Who is responsible for the observation
  // value[x]: Actual result. One of these 11:
  "valueQuantity" : { Quantity },
  "valueCodeableConcept" : { CodeableConcept },
  "valueString" : "<string>",
  "valueBoolean" : <boolean>,
  "valueRange" : { Range },
  "valueRatio" : { Ratio },
  "valueSampledData" : { SampledData },
  "valueAttachment" : { Attachment },
  "valueTime" : "<time>",
  "valueDateTime" : "<dateTime>",
  "valuePeriod" : { Period },
  "dataAbsentReason" : { CodeableConcept }, // C? Why the result is missing
  "interpretation" : { CodeableConcept }, // High, low, normal, etc.
  "comment" : "<string>", // Comments about result
  "bodySite" : { CodeableConcept }, // Observed body part
  "method" : { CodeableConcept }, // How it was done
  "specimen" : { Reference(Specimen) }, // Specimen used for this observation
  "device" : { Reference(Device|DeviceMetric) }, // (Measurement) Device
  "referenceRange" : [{ // Provides guide for interpretation
    "low" : { Quantity(SimpleQuantity) }, // C? Low Range, if relevant
    "high" : { Quantity(SimpleQuantity) }, // C? High Range, if relevant
    "type" : { CodeableConcept }, // Reference range qualifier
    "appliesTo" : [{ CodeableConcept }], // Reference range population
    "age" : { Range }, // Applicable age range, if relevant
    "text" : "<string>" // Text based reference range in an observation
  }],
  "related" : [{ // Resource related to this observation
    "type" : "<code>", // has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
    "target" : { Reference(Observation|QuestionnaireResponse|Sequence) } // R!  Resource that is related to this one
  }],
  "component" : [{ // Component results
    "code" : { CodeableConcept }, // R!  Type of component observation (code / type)
    // value[x]: Actual component result. One of these 10:
    "valueQuantity" : { Quantity },
    "valueCodeableConcept" : { CodeableConcept },
    "valueString" : "<string>",
    "valueRange" : { Range },
    "valueRatio" : { Ratio },
    "valueSampledData" : { SampledData },
    "valueAttachment" : { Attachment },
    "valueTime" : "<time>",
    "valueDateTime" : "<dateTime>",
    "valuePeriod" : { Period },
    "dataAbsentReason" : { CodeableConcept }, // C? Why the component result is missing
    "interpretation" : { CodeableConcept }, // High, low, normal, etc.
    "referenceRange" : [{ Content as for Observation.referenceRange }] // Provides guide for interpretation of component result
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Observation;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Observation.identifier [ Identifier ], ... ; # 0..* Business Identifier for observation
  fhir:Observation.basedOn [ Reference(CarePlan|DeviceRequest|ImmunizationRecommendation|MedicationRequest|
  NutritionOrder|ProcedureRequest|ReferralRequest) ], ... ; # 0..* Fulfills plan, proposal or order
  fhir:Observation.status [ code ]; # 1..1 registered | preliminary | final | amended +
  fhir:Observation.category [ CodeableConcept ], ... ; # 0..* Classification of  type of observation
  fhir:Observation.code [ CodeableConcept ]; # 1..1 Type of observation (code / type)
  fhir:Observation.subject [ Reference(Patient|Group|Device|Location) ]; # 0..1 Who and/or what this is about
  fhir:Observation.context [ Reference(Encounter|EpisodeOfCare) ]; # 0..1 Healthcare event during which this observation is made
  # Observation.effective[x] : 0..1 Clinically relevant time/time-period for observation. One of these 2
    fhir:Observation.effectiveDateTime [ dateTime ]
    fhir:Observation.effectivePeriod [ Period ]
  fhir:Observation.issued [ instant ]; # 0..1 Date/Time this was made available
  fhir:Observation.performer [ Reference(Practitioner|Organization|Patient|RelatedPerson) ], ... ; # 0..* Who is responsible for the observation
  # Observation.value[x] : 0..1 Actual result. One of these 11
    fhir:Observation.valueQuantity [ Quantity ]
    fhir:Observation.valueCodeableConcept [ CodeableConcept ]
    fhir:Observation.valueString [ string ]
    fhir:Observation.valueBoolean [ boolean ]
    fhir:Observation.valueRange [ Range ]
    fhir:Observation.valueRatio [ Ratio ]
    fhir:Observation.valueSampledData [ SampledData ]
    fhir:Observation.valueAttachment [ Attachment ]
    fhir:Observation.valueTime [ time ]
    fhir:Observation.valueDateTime [ dateTime ]
    fhir:Observation.valuePeriod [ Period ]
  fhir:Observation.dataAbsentReason [ CodeableConcept ]; # 0..1 Why the result is missing
  fhir:Observation.interpretation [ CodeableConcept ]; # 0..1 High, low, normal, etc.
  fhir:Observation.comment [ string ]; # 0..1 Comments about result
  fhir:Observation.bodySite [ CodeableConcept ]; # 0..1 Observed body part
  fhir:Observation.method [ CodeableConcept ]; # 0..1 How it was done
  fhir:Observation.specimen [ Reference(Specimen) ]; # 0..1 Specimen used for this observation
  fhir:Observation.device [ Reference(Device|DeviceMetric) ]; # 0..1 (Measurement) Device
  fhir:Observation.referenceRange [ # 0..* Provides guide for interpretation
    fhir:Observation.referenceRange.low [ Quantity(SimpleQuantity) ]; # 0..1 Low Range, if relevant
    fhir:Observation.referenceRange.high [ Quantity(SimpleQuantity) ]; # 0..1 High Range, if relevant
    fhir:Observation.referenceRange.type [ CodeableConcept ]; # 0..1 Reference range qualifier
    fhir:Observation.referenceRange.appliesTo [ CodeableConcept ], ... ; # 0..* Reference range population
    fhir:Observation.referenceRange.age [ Range ]; # 0..1 Applicable age range, if relevant
    fhir:Observation.referenceRange.text [ string ]; # 0..1 Text based reference range in an observation
  ], ...;
  fhir:Observation.related [ # 0..* Resource related to this observation
    fhir:Observation.related.type [ code ]; # 0..1 has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
    fhir:Observation.related.target [ Reference(Observation|QuestionnaireResponse|Sequence) ]; # 1..1 Resource that is related to this one
  ], ...;
  fhir:Observation.component [ # 0..* Component results
    fhir:Observation.component.code [ CodeableConcept ]; # 1..1 Type of component observation (code / type)
    # Observation.component.value[x] : 0..1 Actual component result. One of these 10
      fhir:Observation.component.valueQuantity [ Quantity ]
      fhir:Observation.component.valueCodeableConcept [ CodeableConcept ]
      fhir:Observation.component.valueString [ string ]
      fhir:Observation.component.valueRange [ Range ]
      fhir:Observation.component.valueRatio [ Ratio ]
      fhir:Observation.component.valueSampledData [ SampledData ]
      fhir:Observation.component.valueAttachment [ Attachment ]
      fhir:Observation.component.valueTime [ time ]
      fhir:Observation.component.valueDateTime [ dateTime ]
      fhir:Observation.component.valuePeriod [ Period ]
    fhir:Observation.component.dataAbsentReason [ CodeableConcept ]; # 0..1 Why the component result is missing
    fhir:Observation.component.interpretation [ CodeableConcept ]; # 0..1 High, low, normal, etc.
    fhir:Observation.component.referenceRange [ See Observation.referenceRange ], ... ; # 0..* Provides guide for interpretation of component result
  ], ...;
]

Changes since DSTU2

Observation
Observation.basedOn
  • Added Element
Observation.category
  • Max Cardinality changed from 1 to *
Observation.context
  • Renamed from encounter to context
  • Add Reference(EpisodeOfCare)
Observation.value[x]
  • Add boolean
Observation.comment
  • Renamed from comments to comment
Observation.referenceRange.type
  • Added Element
Observation.referenceRange.appliesTo
  • Renamed from meaning to appliesTo
  • Max Cardinality changed from 1 to *
Observation.related.target
  • Add Reference(Sequence)
Observation.component.interpretation
  • Added Element

See the Full Difference for further information

This analysis is available as XML or JSON.

See R2 <--> R3 Conversion Maps (status = 34 tests that all execute ok. All tests pass round-trip testing and 15 r3 resources are invalid (58 errors).).

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation IDomainResourceMeasurements and simple assertions
+ If code is the same as a component code then the value element associated with the code SHALL NOT be present
+ dataAbsentReason SHALL only be present if Observation.value[x] is not present
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ProcedureRequest | ReferralRequest)Fulfills plan, proposal or order
... status ?!Σ1..1coderegistered | preliminary | final | amended +
ObservationStatus (Required)
... category 0..*CodeableConceptClassification of type of observation
Observation Category Codes (Preferred)
... code Σ1..1CodeableConceptType of observation (code / type)
LOINC Codes (Example)
... subject Σ0..1Reference(Patient | Group | Device | Location)Who and/or what this is about
... context 0..1Reference(Encounter | EpisodeOfCare)Healthcare event during which this observation is made
... effective[x] Σ0..1Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... issued Σ0..1instantDate/Time this was made available
... performer Σ0..*Reference(Practitioner | Organization | Patient | RelatedPerson)Who is responsible for the observation
... value[x] ΣI0..1Actual result
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueAttachmentAttachment
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Observation Value Absent Reason (Extensible)
... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Observation Interpretation Codes (Extensible)
... comment 0..1stringComments about result
... bodySite 0..1CodeableConceptObserved body part
SNOMED CT Body Structures (Example)
... method 0..1CodeableConceptHow it was done
Observation Methods (Example)
... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I0..*BackboneElementProvides guide for interpretation
+ Must have at least a low or a high or text
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... type 0..1CodeableConceptReference range qualifier
Observation Reference Range Meaning Codes (Extensible)
.... appliesTo 0..*CodeableConceptReference range population
Observation Reference Range Applies To Codes (Example)
.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... related Σ0..*BackboneElementResource related to this observation
.... type 0..1codehas-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
ObservationRelationshipType (Required)
.... target 1..1Reference(Observation | QuestionnaireResponse | Sequence)Resource that is related to this one
... component Σ0..*BackboneElementComponent results
.... code Σ1..1CodeableConceptType of component observation (code / type)
LOINC Codes (Example)
.... value[x] Σ0..1Actual component result
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueAttachmentAttachment
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Observation Value Absent Reason (Extensible)
.... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Observation Interpretation Codes (Extensible)
.... referenceRange 0..*see referenceRangeProvides guide for interpretation of component result

doco Documentation for this format

UML Diagram (Legend)

Observation (DomainResource)A unique identifier assigned to this observationidentifier : Identifier [0..*]A plan, proposal or order that is fulfilled in whole or in part by this eventbasedOn : Reference [0..*] CarePlan|DeviceRequest| ImmunizationRecommendation|MedicationRequest|NutritionOrder| ProcedureRequest|ReferralRequest The status of the result value (this element modifies the meaning of other elements)status : code [1..1] Codes providing the status of an observation. (Strength=Required)ObservationStatus! A code that classifies the general type of observation being madecategory : CodeableConcept [0..*] Codes for high level observation categories. (Strength=Preferred)Observation Category ? Describes what was observed. Sometimes this is called the observation "name"code : CodeableConcept [1..1] Codes identifying names of simple observations. (Strength=Example)LOINC ?? The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subjectsubject : Reference [0..1] Patient|Group|Device|Location The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is madecontext : Reference [0..1] Encounter|EpisodeOfCare 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 itselfeffective[x] : Type [0..1] dateTime|Period The date and time this observation was made available to providers, typically after the results have been reviewed and verifiedissued : instant [0..1]Who was responsible for asserting the observed value as "true"performer : Reference [0..*] Practitioner|Organization|Patient| RelatedPerson The information determined as a result of making the observation, if the information has a simple valuevalue[x] : Type [0..1] Quantity|CodeableConcept|string|boolean| Range|Ratio|SampledData|Attachment|time|dateTime|Period Provides a reason why the expected value in the element Observation.value[x] is missingdataAbsentReason : CodeableConcept [0..1] Codes specifying why the result (Observation.value[x]) is missing. (Strength=Extensible)Observation Value Absent Reas...+ The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flaginterpretation : CodeableConcept [0..1] Codes identifying interpretations of observations. (Strength=Extensible)Observation Interpretation + May include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the resultcomment : string [0..1]Indicates the site on the subject's body where the observation was made (i.e. the target site)bodySite : CodeableConcept [0..1] Codes describing anatomical locations. May include laterality. (Strength=Example)SNOMED CT Body Structures?? Indicates the mechanism used to perform the observationmethod : CodeableConcept [0..1] Methods for simple observations. (Strength=Example)Observation Methods?? The specimen that was used when this observation was madespecimen : Reference [0..1] Specimen The device used to generate the observation datadevice : Reference [0..1] Device|DeviceMetric ReferenceRangeThe value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3)low : Quantity(SimpleQuantity) [0..1]The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3)high : Quantity(SimpleQuantity) [0..1]Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic rangetype : CodeableConcept [0..1] Code for the meaning of a reference range. (Strength=Extensible)Observation Reference Range M...+ Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or raceappliesTo : CodeableConcept [0..*] Codes identifying the population the reference range applies to. (Strength=Example)Observation Reference Range A...?? The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says soage : Range [0..1]Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of 'normals'text : string [0..1]RelatedA code specifying the kind of relationship that exists with the target resourcetype : code [0..1] Codes specifying how two observations are related. (Strength=Required)ObservationRelationshipType! A reference to the observation or [[[QuestionnaireResponse]]] resource that is related to this observationtarget : Reference [1..1] Observation|QuestionnaireResponse| Sequence ComponentDescribes what was observed. Sometimes this is called the observation "code"code : CodeableConcept [1..1] Codes identifying names of simple observations. (Strength=Example)LOINC ?? The information determined as a result of making the observation, if the information has a simple valuevalue[x] : Type [0..1] Quantity|CodeableConcept|string|Range|Ratio| SampledData|Attachment|time|dateTime|Period Provides a reason why the expected value in the element Observation.value[x] is missingdataAbsentReason : CodeableConcept [0..1] Codes specifying why the result (Observation.value[x]) is missing. (Strength=Extensible)Observation Value Absent Reas...+ The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flaginterpretation : CodeableConcept [0..1] Codes identifying interpretations of observations. (Strength=Extensible)Observation Interpretation + Guidance on how to interpret the value by comparison to a normal or recommended rangereferenceRange[0..*]A reference to another resource (usually another Observation) whose relationship is defined by the relationship type coderelated[0..*]Guidance on how to interpret the value by comparison to a normal or recommended rangereferenceRange[0..*]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 observationscomponent[0..*]

XML Template

<Observation xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business Identifier for observation --></identifier>
 <basedOn><!-- 0..* Reference(CarePlan|DeviceRequest|ImmunizationRecommendation|
   MedicationRequest|NutritionOrder|ProcedureRequest|ReferralRequest) Fulfills plan, proposal or order --></basedOn>
 <status value="[code]"/><!-- 1..1 registered | preliminary | final | amended + -->
 <category><!-- 0..* CodeableConcept Classification of  type of observation --></category>
 <code><!-- 1..1 CodeableConcept Type of observation (code / type) --></code>
 <subject><!-- 0..1 Reference(Patient|Group|Device|Location) Who and/or what this is about --></subject>
 <context><!-- 0..1 Reference(Encounter|EpisodeOfCare) Healthcare event during which this observation is made --></context>
 <effective[x]><!-- 0..1 dateTime|Period Clinically relevant time/time-period for observation --></effective[x]>
 <issued value="[instant]"/><!-- 0..1 Date/Time this was made available -->
 <performer><!-- 0..* Reference(Practitioner|Organization|Patient|RelatedPerson) Who is responsible for the observation --></performer>
 <value[x]><!-- ?? 0..1 Quantity|CodeableConcept|string|boolean|Range|Ratio|
   SampledData|Attachment|time|dateTime|Period Actual result --></value[x]>
 <dataAbsentReason><!-- ?? 0..1 CodeableConcept Why the result is missing --></dataAbsentReason>
 <interpretation><!-- 0..1 CodeableConcept High, low, normal, etc. --></interpretation>
 <comment value="[string]"/><!-- 0..1 Comments about result -->
 <bodySite><!-- 0..1 CodeableConcept Observed body part --></bodySite>
 <method><!-- 0..1 CodeableConcept How it was done --></method>
 <specimen><!-- 0..1 Reference(Specimen) Specimen used for this observation --></specimen>
 <device><!-- 0..1 Reference(Device|DeviceMetric) (Measurement) Device --></device>
 <referenceRange>  <!-- 0..* Provides guide for interpretation -->
  <low><!-- ?? 0..1 Quantity(SimpleQuantity) Low Range, if relevant --></low>
  <high><!-- ?? 0..1 Quantity(SimpleQuantity) High Range, if relevant --></high>
  <type><!-- 0..1 CodeableConcept Reference range qualifier --></type>
  <appliesTo><!-- 0..* CodeableConcept Reference range population --></appliesTo>
  <age><!-- 0..1 Range Applicable age range, if relevant --></age>
  <text value="[string]"/><!-- 0..1 Text based reference range in an observation -->
 </referenceRange>
 <related>  <!-- 0..* Resource related to this observation -->
  <type value="[code]"/><!-- 0..1 has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by -->
  <target><!-- 1..1 Reference(Observation|QuestionnaireResponse|Sequence) Resource that is related to this one --></target>
 </related>
 <component>  <!-- 0..* Component results -->
  <code><!-- 1..1 CodeableConcept Type of component observation (code / type) --></code>
  <value[x]><!-- 0..1 Quantity|CodeableConcept|string|Range|Ratio|SampledData|
    Attachment|time|dateTime|Period Actual component result --></value[x]>
  <dataAbsentReason><!-- ?? 0..1 CodeableConcept Why the component result is missing --></dataAbsentReason>
  <interpretation><!-- 0..1 CodeableConcept High, low, normal, etc. --></interpretation>
  <referenceRange><!-- 0..* Content as for Observation.referenceRange Provides guide for interpretation of component result --></referenceRange>
 </component>
</Observation>

JSON Template

{doco
  "resourceType" : "Observation",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifier for observation
  "basedOn" : [{ Reference(CarePlan|DeviceRequest|ImmunizationRecommendation|
   MedicationRequest|NutritionOrder|ProcedureRequest|ReferralRequest) }], // Fulfills plan, proposal or order
  "status" : "<code>", // R!  registered | preliminary | final | amended +
  "category" : [{ CodeableConcept }], // Classification of  type of observation
  "code" : { CodeableConcept }, // R!  Type of observation (code / type)
  "subject" : { Reference(Patient|Group|Device|Location) }, // Who and/or what this is about
  "context" : { Reference(Encounter|EpisodeOfCare) }, // Healthcare event during which this observation is made
  // effective[x]: Clinically relevant time/time-period for observation. One of these 2:
  "effectiveDateTime" : "<dateTime>",
  "effectivePeriod" : { Period },
  "issued" : "<instant>", // Date/Time this was made available
  "performer" : [{ Reference(Practitioner|Organization|Patient|RelatedPerson) }], // Who is responsible for the observation
  // value[x]: Actual result. One of these 11:
  "valueQuantity" : { Quantity },
  "valueCodeableConcept" : { CodeableConcept },
  "valueString" : "<string>",
  "valueBoolean" : <boolean>,
  "valueRange" : { Range },
  "valueRatio" : { Ratio },
  "valueSampledData" : { SampledData },
  "valueAttachment" : { Attachment },
  "valueTime" : "<time>",
  "valueDateTime" : "<dateTime>",
  "valuePeriod" : { Period },
  "dataAbsentReason" : { CodeableConcept }, // C? Why the result is missing
  "interpretation" : { CodeableConcept }, // High, low, normal, etc.
  "comment" : "<string>", // Comments about result
  "bodySite" : { CodeableConcept }, // Observed body part
  "method" : { CodeableConcept }, // How it was done
  "specimen" : { Reference(Specimen) }, // Specimen used for this observation
  "device" : { Reference(Device|DeviceMetric) }, // (Measurement) Device
  "referenceRange" : [{ // Provides guide for interpretation
    "low" : { Quantity(SimpleQuantity) }, // C? Low Range, if relevant
    "high" : { Quantity(SimpleQuantity) }, // C? High Range, if relevant
    "type" : { CodeableConcept }, // Reference range qualifier
    "appliesTo" : [{ CodeableConcept }], // Reference range population
    "age" : { Range }, // Applicable age range, if relevant
    "text" : "<string>" // Text based reference range in an observation
  }],
  "related" : [{ // Resource related to this observation
    "type" : "<code>", // has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
    "target" : { Reference(Observation|QuestionnaireResponse|Sequence) } // R!  Resource that is related to this one
  }],
  "component" : [{ // Component results
    "code" : { CodeableConcept }, // R!  Type of component observation (code / type)
    // value[x]: Actual component result. One of these 10:
    "valueQuantity" : { Quantity },
    "valueCodeableConcept" : { CodeableConcept },
    "valueString" : "<string>",
    "valueRange" : { Range },
    "valueRatio" : { Ratio },
    "valueSampledData" : { SampledData },
    "valueAttachment" : { Attachment },
    "valueTime" : "<time>",
    "valueDateTime" : "<dateTime>",
    "valuePeriod" : { Period },
    "dataAbsentReason" : { CodeableConcept }, // C? Why the component result is missing
    "interpretation" : { CodeableConcept }, // High, low, normal, etc.
    "referenceRange" : [{ Content as for Observation.referenceRange }] // Provides guide for interpretation of component result
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Observation;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Observation.identifier [ Identifier ], ... ; # 0..* Business Identifier for observation
  fhir:Observation.basedOn [ Reference(CarePlan|DeviceRequest|ImmunizationRecommendation|MedicationRequest|
  NutritionOrder|ProcedureRequest|ReferralRequest) ], ... ; # 0..* Fulfills plan, proposal or order
  fhir:Observation.status [ code ]; # 1..1 registered | preliminary | final | amended +
  fhir:Observation.category [ CodeableConcept ], ... ; # 0..* Classification of  type of observation
  fhir:Observation.code [ CodeableConcept ]; # 1..1 Type of observation (code / type)
  fhir:Observation.subject [ Reference(Patient|Group|Device|Location) ]; # 0..1 Who and/or what this is about
  fhir:Observation.context [ Reference(Encounter|EpisodeOfCare) ]; # 0..1 Healthcare event during which this observation is made
  # Observation.effective[x] : 0..1 Clinically relevant time/time-period for observation. One of these 2
    fhir:Observation.effectiveDateTime [ dateTime ]
    fhir:Observation.effectivePeriod [ Period ]
  fhir:Observation.issued [ instant ]; # 0..1 Date/Time this was made available
  fhir:Observation.performer [ Reference(Practitioner|Organization|Patient|RelatedPerson) ], ... ; # 0..* Who is responsible for the observation
  # Observation.value[x] : 0..1 Actual result. One of these 11
    fhir:Observation.valueQuantity [ Quantity ]
    fhir:Observation.valueCodeableConcept [ CodeableConcept ]
    fhir:Observation.valueString [ string ]
    fhir:Observation.valueBoolean [ boolean ]
    fhir:Observation.valueRange [ Range ]
    fhir:Observation.valueRatio [ Ratio ]
    fhir:Observation.valueSampledData [ SampledData ]
    fhir:Observation.valueAttachment [ Attachment ]
    fhir:Observation.valueTime [ time ]
    fhir:Observation.valueDateTime [ dateTime ]
    fhir:Observation.valuePeriod [ Period ]
  fhir:Observation.dataAbsentReason [ CodeableConcept ]; # 0..1 Why the result is missing
  fhir:Observation.interpretation [ CodeableConcept ]; # 0..1 High, low, normal, etc.
  fhir:Observation.comment [ string ]; # 0..1 Comments about result
  fhir:Observation.bodySite [ CodeableConcept ]; # 0..1 Observed body part
  fhir:Observation.method [ CodeableConcept ]; # 0..1 How it was done
  fhir:Observation.specimen [ Reference(Specimen) ]; # 0..1 Specimen used for this observation
  fhir:Observation.device [ Reference(Device|DeviceMetric) ]; # 0..1 (Measurement) Device
  fhir:Observation.referenceRange [ # 0..* Provides guide for interpretation
    fhir:Observation.referenceRange.low [ Quantity(SimpleQuantity) ]; # 0..1 Low Range, if relevant
    fhir:Observation.referenceRange.high [ Quantity(SimpleQuantity) ]; # 0..1 High Range, if relevant
    fhir:Observation.referenceRange.type [ CodeableConcept ]; # 0..1 Reference range qualifier
    fhir:Observation.referenceRange.appliesTo [ CodeableConcept ], ... ; # 0..* Reference range population
    fhir:Observation.referenceRange.age [ Range ]; # 0..1 Applicable age range, if relevant
    fhir:Observation.referenceRange.text [ string ]; # 0..1 Text based reference range in an observation
  ], ...;
  fhir:Observation.related [ # 0..* Resource related to this observation
    fhir:Observation.related.type [ code ]; # 0..1 has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
    fhir:Observation.related.target [ Reference(Observation|QuestionnaireResponse|Sequence) ]; # 1..1 Resource that is related to this one
  ], ...;
  fhir:Observation.component [ # 0..* Component results
    fhir:Observation.component.code [ CodeableConcept ]; # 1..1 Type of component observation (code / type)
    # Observation.component.value[x] : 0..1 Actual component result. One of these 10
      fhir:Observation.component.valueQuantity [ Quantity ]
      fhir:Observation.component.valueCodeableConcept [ CodeableConcept ]
      fhir:Observation.component.valueString [ string ]
      fhir:Observation.component.valueRange [ Range ]
      fhir:Observation.component.valueRatio [ Ratio ]
      fhir:Observation.component.valueSampledData [ SampledData ]
      fhir:Observation.component.valueAttachment [ Attachment ]
      fhir:Observation.component.valueTime [ time ]
      fhir:Observation.component.valueDateTime [ dateTime ]
      fhir:Observation.component.valuePeriod [ Period ]
    fhir:Observation.component.dataAbsentReason [ CodeableConcept ]; # 0..1 Why the component result is missing
    fhir:Observation.component.interpretation [ CodeableConcept ]; # 0..1 High, low, normal, etc.
    fhir:Observation.component.referenceRange [ See Observation.referenceRange ], ... ; # 0..* Provides guide for interpretation of component result
  ], ...;
]

Changes since DSTU2

Observation
Observation.basedOn
  • Added Element
Observation.category
  • Max Cardinality changed from 1 to *
Observation.context
  • Renamed from encounter to context
  • Add Reference(EpisodeOfCare)
Observation.value[x]
  • Add boolean
Observation.comment
  • Renamed from comments to comment
Observation.referenceRange.type
  • Added Element
Observation.referenceRange.appliesTo
  • Renamed from meaning to appliesTo
  • Max Cardinality changed from 1 to *
Observation.related.target
  • Add Reference(Sequence)
Observation.component.interpretation
  • Added Element

See the Full Difference for further information

This analysis is available as XML or JSON.

See R2 <--> R3 Conversion Maps (status = 34 tests that all execute ok. All tests pass round-trip testing and 15 r3 resources are invalid (58 errors).).

 

Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle)

10.1.3.1 Terminology Bindings

PathDefinitionTypeReference
Observation.status Codes providing the status of an observation.RequiredObservationStatus
Observation.category Codes for high level observation categories.PreferredObservation Category Codes
Observation.code
Observation.component.code 		Codes identifying names of simple observations.ExampleLOINC Codes
Observation.dataAbsentReason
Observation.component.dataAbsentReason 		Codes specifying why the result (Observation.value[x]) is missing.ExtensibleObservation Value Absent Reason
Observation.interpretation
Observation.component.interpretation 		Codes identifying interpretations of observations.ExtensibleObservation Interpretation Codes
Observation.bodySite Codes describing anatomical locations. May include laterality.ExampleSNOMED CT Body Structures
Observation.method Methods for simple observations.ExampleObservation Methods
Observation.referenceRange.type Code for the meaning of a reference range.ExtensibleObservation Reference Range Meaning Codes
Observation.referenceRange.appliesTo Codes identifying the population the reference range applies to.ExampleObservation Reference Range Applies To Codes
Observation.related.type Codes specifying how two observations are related.RequiredObservationRelationshipType

10.1.3.2 Constraints

  • obs-3: On Observation.referenceRange: Must have at least a low or a high or text (expression on Observation.referenceRange: low.exists() or high.exists() or text.exists())
  • obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present (expression : dataAbsentReason.empty() or value.empty())
  • obs-7: If code is the same as a component code then the value element associated with the code SHALL NOT be present (expression : value.empty() or component.code.where( (coding.code = %resource.code.coding.code) and (coding.system = %resource.code.coding.system)).empty())

10.1.4 Notes:

At its simplest, a resource instances can consist of only a code and a value, and status flag. The relevance of other properties will vary based on the type of observation.

Profiles will be created to provide guidance on capturing certain types of simple observations. This resource focuses on the level of detail captured by most systems. However, any "simple" observation can easily be broken into numerous components and sub-components to provide additional information relevant in certain circumstances. As with other resources, extensions can be used to introduce this additional complexity.

10.1.4.1 Observation Grouping

Many observations have important relationships to other observations and need to be grouped together. Three structures have been defined to do this: DiagnosticReport and DiagnosticReport.result, Observation and Observation.component, and Observation and Observation.related. The table below provides guidance around which structure to use. Because the idea of what to group together is often highly contextual and based upon the end user's point of view, the choice of which structure to use will be driven by jurisdiction, organizational practice and context. Profiling will normally be necessary for implementation.

DiagnosticReport and DiagnosticReport.result Observation and Observation.component Observation and Observation.related
DiagnosticReport relates directly to an order (ProcedureRequest). The DiagnosticReport.code names the panel and serves as the grouping element, which is traditionally referred to as a "panel" or "battery" by laboratories. The DiagnosticReport.result element references the individual observations. Several examples demonstrate observation grouping using DiagnosticReport as the grouping structure. Observation.component is used for any supporting result that cannot reasonably be interpreted and used outside the scope of the Observation it is a component of. Components should only be used when there is only one method, one observation, one performer, one device, and one time. For example, systolic and diastolic blood pressure are represented as a single Observation (e.g. Blood pressure panel) because the two are almost always produced and interpreted together. Note that the component.code may in some cases only be able to be understood in relation to the Observation.code (for example, see the $stats operation). Observation.related is used for any supporting result that can be interpreted and used on its own and has one or more different values for method, observation, performer, device, time, and/or error conditions. The top level observation specifies the grouping code in Observation.code, but typically does not have its own Observation.value, and the set of member observations are listed in the Observation.related element. This structure permits nested grouping when used with DiagnosticReport (e.g. complex micro isolate and sensitivities report).

10.1.4.2 Value[x] and Datatypes

  • The element, Observation.value[x], has a variable name depending on the type as follows:
    • valueQuantity
    • valueCodeableConcept
    • valueString
    • valueBoolean
    • valueRange
    • valueRatio
    • valueSampledData
    • valueAttachment
    • valueTime
    • valueDateTime
    • valuePeriod

  • Using codes for result values

    When a result value is a represented as a predefined concept using a code, valueCodeableConcept is used. This element is bound to a value set comprised of a standard nomenclature such as SNOMED CT or a source system ("local") coded result values. Results may be coded in multiple value sets based on different code systems and these may be mapped using the ConceptMap resource and/or given as translations directly in the element as shown in the example below.

    For example the LOINC 43304-5 Chlamydia trachomatis rRNA [Presence] in Unspecified specimen by Probe and target amplification method is typically associated with coded presence/absence concepts. Using the coded value for 'negative' with a standard code translation, valueCodeableConcept would be:

    	"valueCodeableConcept": {
	"coding": [
	  {
		"system": "http://snomed.info/sct",
		"code": "260385009",
		"display": "Negative"
	  },
	  {
		"https://acme.lab/resultcodes",
		"code": "NEG",
		"display": "Negative"
	  }
	],
	"text": "Negative for Chlamydia Trachomatis rRNA"
	  }

    Text values for coded results:

    When the data element is usually coded or the type associated with the code element defines a coded value, use valueCodeableConcept even if there is no appropriate code and only un-coded text is available. For example using text only, the valueCodeableConcept element would be:

    	"valueCodeableConcept": {
	"text": "uncoded free text result"
	  }

    When a coded answer list includes a concept code for "other" and there is a free text description of the concept, the valueCodeableConcept.text element should be used to capture the full meaning of the source. In the example below, the answer code "Other" is provided in the valueCodeableConcept element and the text value supplied value in the CodeableConcept.text element.

        {
      "resourceType": "Observation",
      "code": {
        "coding": [{
          "system": "http://loinc.org",
          "code": "74076-1",
          "display": "Medication or substance involved"
        }]
      },
      "valueCodeableConcept": {
        "coding": [{
          "system": "http://loinc.org",
          "code": " LA20343-2",
          "display": "Other substance: PLEASE SPECIFY"
        }],
        "text": "Other: Blue pills I found under my couch"
      }
    }
  • The Boolean data type is rarely used for value[x] because most observations result values are never truly Boolean due to exceptional values such as "unknown", therefore they should use the CodeableConcept data type instead.
  • The special values "E" (error), "L" (below detection limit) and "U" (above detection limit) can be used are in the SampledData data type. However when using valueQuantity in an observation for above and below detection limit values, valueQuantity should be used by stating the limit along with the comparator. In addition, when there is an error the dataAbsentReason element should be used with the appropriate value ('error' or 'NaN'). For example if the value was below the lower limit of detection of <2.0 mmol/L the valueQuantity would be: 
    		"valueQuantity": {
    "value": 2.0,
     "comparator" : "<",
    "unit": "mmol/l",
    "system": "http://unitsofmeasure.org",
    "code": "mmol/L"
     }
    If the value was "NaN" (i.e. an error) the valueCodeableConcept element would be absent and dataAbsentReason element would be: 
    "dataAbsentReason": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/data-absent-reason",
        "code": "NaN",
        "display": "Not a Number"
      }
  • Because there are multiple types allowed for the value element, multiple value search parameters are defined. There is no standard parameter for searching values of type Attachment, or Ratio

10.1.4.3 Physiologically Relevant Time of the Observation

The effectiveDateTime or effectivePeriod is the time that the observation is most relevant as an observation of the subject. For a biological subject (e.g. a human patient), this is the physiologically relevant time of the observation. In the case of an observation using a specimen, this represents the start and end of the specimen collection (e.g. 24 hour Urine Sodium), but if the collection time is sufficiently short, this is reported as a point in time value (e.g. normal venipuncture). In the case of an observation obtained directly from a subject (e.g. BP, Chest X-ray), this is the start and end time of the observation process, which again, is often reported as a single point in time.

10.1.4.4 Reference Range

Most common observations will only have one generic reference range. Reference ranges may be useful for lab tests and other measures like systolic blood pressure, but will have little relevance for something like "pregnancy status". 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 may 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.

10.1.4.5 Canceled or Aborted Observations

If a measurement or test could not be completed (for example if the specimen is unsatisfactory or the provider cancelled the order), then the status value should be updated to "cancelled" and the specific details given - preferably as coded values in the dataAbsentReason or valueCodeableConcept element. Additional information may be provided in comments as well. The specimen reject example demonstrates this using a coded value for unsatisfactory specimen in dataAbsentReason.

10.1.5 Operations defined for Observation

10.1.5.1 Searching for the Last N Observations

The lastn query operation meets the common need for searching for the most recent or "last known" Observations for a subject. Examples where this query could be used:

  • Fetch the last 5 temperatures for a patient to view trends
  • Get the most recent lab results for patient
  • Fetch the last 3 results for all vitals for a patient

See the Last N Observations Query section in the Observation resource operations page for more information and examples

STU Note: This is the first draft of this operation and we are seeking input from the implementer community on it and whether it should be extended to other resources such as DiagnosticReport. This operation could be the subject of future connectathon testing.

Feedback is welcome here .

10.1.5.2 Retrieving Statistics for Laboratory Observations

The stats operation performs a set of statistical calculations on a set of clinical measurements such as a blood pressure as stored on the server. This operation is focused on Observation resources with valueQuantity elements that have UCUM unit codes. Examples where this operation could be used:

  • Get the average, min, max and count of a series of BP measurements for a patient
  • Determine 20th or 80th percentile on a set of measurements over a time period
See the Observation Statistics section in the Observation resource operations page for more information and examples

10.1.6 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
based-onreferenceReference to the test or procedure request.Observation.basedOn
(ReferralRequest, CarePlan, MedicationRequest, NutritionOrder, ProcedureRequest, DeviceRequest, ImmunizationRecommendation)
categorytokenThe classification of the type of observationObservation.category
codetokenThe code of the observation typeObservation.code8 Resources
code-value-conceptcompositeCode and coded value parameter pairObservation
code-value-datecompositeCode and date/time value parameter pairObservation
code-value-quantitycompositeCode and quantity value parameter pairObservation
code-value-stringcompositeCode and string value parameter pairObservation
combo-codetokenThe code of the observation type or component typeObservation.code | Observation.component.code
combo-code-value-conceptcompositeCode and coded value parameter pair, including in componentsObservation | Observation.component
combo-code-value-quantitycompositeCode and quantity value parameter pair, including in componentsObservation | Observation.component
combo-data-absent-reasontokenThe reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing.Observation.dataAbsentReason | Observation.component.dataAbsentReason
combo-value-concepttokenThe value or component value of the observation, if the value is a CodeableConceptObservation.value.as(CodeableConcept) | Observation.component.value.as(CodeableConcept)
combo-value-quantityquantityThe value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)Observation.value.as(Quantity) | Observation.component.value.as(Quantity)
component-codetokenThe component code of the observation typeObservation.component.code
component-code-value-conceptcompositeComponent code and component coded value parameter pairObservation.component
component-code-value-quantitycompositeComponent code and component quantity value parameter pairObservation.component
component-data-absent-reasontokenThe reason why the expected value in the element Observation.component.value[x] is missing.Observation.component.dataAbsentReason
component-value-concepttokenThe value of the component observation, if the value is a CodeableConceptObservation.component.value.as(CodeableConcept)
component-value-quantityquantityThe value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)Observation.component.value.as(Quantity)
contextreferenceHealthcare event (Episode-of-care or Encounter) related to the observationObservation.context
(EpisodeOfCare, Encounter)
data-absent-reasontokenThe reason why the expected value in the element Observation.value[x] is missing.Observation.dataAbsentReason
datedateObtained date/time. If the obtained element is a period, a date that falls in the periodObservation.effective18 Resources
devicereferenceThe Device that generated the observation data.Observation.device
(Device, DeviceMetric)
encounterreferenceEncounter related to the observationObservation.context
(Encounter)		12 Resources
identifiertokenThe unique id for a particular observationObservation.identifier26 Resources
methodtokenThe method used for the observationObservation.method
patientreferenceThe subject that the observation is about (if patient)Observation.subject
(Patient)		31 Resources
performerreferenceWho performed the observationObservation.performer
(Practitioner, Organization, Patient, RelatedPerson)
relatedcompositeRelated Observations - search on related-type and related-target togetherObservation.related
related-targetreferenceResource that is related to this oneObservation.related.target
(Observation, Sequence, QuestionnaireResponse)
related-typetokenhas-member | derived-from | sequel-to | replaces | qualified-by | interfered-byObservation.related.type
specimenreferenceSpecimen used for this observationObservation.specimen
(Specimen)
statustokenThe status of the observationObservation.status
subjectreferenceThe subject that the observation is aboutObservation.subject
(Group, Device, Patient, Location)
value-concepttokenThe value of the observation, if the value is a CodeableConceptObservation.value.as(CodeableConcept)
value-datedateThe value of the observation, if the value is a date or period of timeObservation.value.as(DateTime) | Observation.value.as(Period)
value-quantityquantityThe value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)Observation.value.as(Quantity)
value-stringstringThe value of the observation, if the value is a string, and also searches in CodeableConcept.textObservation.value.as(String)