Observation
Measurements and simple assertions made about a patient, device or other subject. US Core Profiles related to Observations are as follows:
- US Core Laboratory Result profile
- US Core Smoking Status Observation profile.
- US Core Pulse Oximetry Profile
- US Core Pediatric BMI for Age Profile
- US Core Pediatric Weight for Height
- US Core Pediatric Head Circumference
- US Core Observation Survey
- US Core Observation Social History
- US Core Clinical Test Result
- US Core Observation Sexual Orientation
Properties
Name | Required | Type | Description |
---|---|---|---|
identifier | Identifier[] | Business Identifier for observation DetailsA unique identifier assigned to this observation. | |
basedOn | Reference< CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest >[] | Fulfills plan, proposal or order DetailsA 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. | |
partOf | Reference< MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy >[] | Part of referenced event DetailsA larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation. | |
status | ✓ | code | registered | preliminary | final | amended + DetailsThe status of the result value. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
category | CodeableConcept[] | Classification of type of observation DetailsA code that classifies the general type of observation being made. 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. | |
code | ✓ | CodeableConcept | Type of observation (code / type) DetailsDescribes what was observed. Sometimes this is called the observation "name". *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. |
subject | Reference< Patient | Group | Device | Location > | Who and/or what the observation is about DetailsThe 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. 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. | |
focus | Reference<Resource>[] | What the observation is about, when it is not about the subject of record DetailsThe 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. 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](extension-observation-focuscode.html). | |
encounter | Reference<Encounter> | Healthcare event during which this observation is made DetailsThe healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. 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). | |
effective[x] | dateTime, Period, Timing, instant | Clinically relevant time/time-period for observation DetailsThe 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. 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](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events. | |
issued | instant | Date/Time this version was made available DetailsThe date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don’t require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.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. | |
performer | Reference< Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson >[] | Who is responsible for the observation DetailsWho was responsible for asserting the observed value as "true". | |
value[x] | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual result DetailsThe information determined as a result of making the observation, if the information has a simple value. 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](observation.html#notes) below. | |
dataAbsentReason | CodeableConcept | Why the result is missing DetailsProvides a reason why the expected value in the element Observation.value[x] is missing. 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. | |
interpretation | CodeableConcept[] | High, low, normal, etc. DetailsA categorical assessment of an observation value. For example, high, low, normal. 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. | |
note | Annotation[] | Comments about the observation DetailsComments about the observation or the results. 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. | |
bodySite | CodeableConcept | Observed body part DetailsIndicates the site on the subject's body where the observation was made (i.e. the target site). 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](extension-bodysite.html). | |
method | CodeableConcept | How it was done DetailsIndicates the mechanism used to perform the observation. Only used if not implicit in code for Observation.code. | |
specimen | Reference<Specimen> | Specimen used for this observation DetailsThe specimen that was used when this observation was made. 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). | |
device | Reference<Device | DeviceMetric> | (Measurement) Device DetailsThe device used to generate the observation data. 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. | |
referenceRange | ObservationReferenceRange[] | Provides guide for interpretation DetailsGuidance 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. 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. | |
id | string | Unique id for inter-element referencing DetailsUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
extension | Extension[] | Additional content defined by implementations DetailsMay 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. 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. | |
modifierExtension | Extension[] | Extensions that cannot be ignored even if unrecognized DetailsMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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. 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). 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. | |
low | Quantity | Low Range, if relevant DetailsThe 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). | |
high | Quantity | High Range, if relevant DetailsThe 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). | |
type | CodeableConcept | Reference range qualifier DetailsCodes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. | |
appliesTo | CodeableConcept[] | Reference range population DetailsCodes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. | |
age | Range | Applicable age range, if relevant DetailsThe age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so. | |
text | string | Text based reference range in an observation DetailsText 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". | |
hasMember | Reference< Observation | QuestionnaireResponse | MolecularSequence >[] | Related resource that belongs to the Observation group DetailsThis 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. 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](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation. | |
derivedFrom | Reference< DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence >[] | Related measurements the observation is made from DetailsThe 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. 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](observation.html#obsgrouping) below. | |
component | ObservationComponent[] | Component results DetailsSome 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. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below. | |
id | string | Unique id for inter-element referencing DetailsUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
extension | Extension[] | Additional content defined by implementations DetailsMay 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. 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. | |
modifierExtension | Extension[] | Extensions that cannot be ignored even if unrecognized DetailsMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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. 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). 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. | |
code | ✓ | CodeableConcept | Type of component observation (code / type) DetailsDescribes what was observed. Sometimes this is called the observation "code". *All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
value[x] | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual component result DetailsThe information determined as a result of making the observation, if the information has a simple value. Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). If a value is present, the datatype for this element should be determined by 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](observation.html#notes) below. | |
dataAbsentReason | CodeableConcept | Why the component result is missing DetailsProvides a reason why the expected value in the element Observation.component.value[x] is missing. "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. | |
interpretation | CodeableConcept[] | High, low, normal, etc. DetailsA categorical assessment of an observation value. For example, high, low, normal. 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. | |
referenceRange | [] | Provides guide for interpretation of component result DetailsGuidance on how to interpret the value by comparison to a normal or recommended range. 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. |
Search Parameters
Name | Type | Description | Expression |
---|---|---|---|
code | token | The code of the observation type | Observation.code |
date | date | Obtained date/time. If the obtained element is a period, a date that falls in the period | Observation.effective |
identifier | token | The unique id for a particular observation | Observation.identifier |
patient | reference | The subject that the observation is about (if patient) | Observation.subject |
encounter | reference | Encounter related to the observation | Observation.encounter |
based-on | reference | Reference to the service request. | Observation.basedOn |
category | token | The classification of the type of observation | Observation.category |
combo-code | token | The code of the observation type or component type | Observation.code |
combo-data-absent-reason | token | The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing. | Observation.dataAbsentReason |
combo-value-concept | token | The value or component value of the observation, if the value is a CodeableConcept | Observation.value |
combo-value-quantity | quantity | The 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 |
component-code | token | The component code of the observation type | Observation.component.code |
component-data-absent-reason | token | The reason why the expected value in the element Observation.component.value[x] is missing. | Observation.component.dataAbsentReason |
component-value-concept | token | The value of the component observation, if the value is a CodeableConcept | Observation.component.value |
component-value-quantity | quantity | The 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 |
data-absent-reason | token | The reason why the expected value in the element Observation.value[x] is missing. | Observation.dataAbsentReason |
derived-from | reference | Related measurements the observation is made from | Observation.derivedFrom |
device | reference | The Device that generated the observation data. | Observation.device |
focus | reference | The focus of an observation when the focus is not the patient of record. | Observation.focus |
has-member | reference | Related resource that belongs to the Observation group | Observation.hasMember |
method | token | The method used for the observation | Observation.method |
part-of | reference | Part of referenced event | Observation.partOf |
performer | reference | Who performed the observation | Observation.performer |
specimen | reference | Specimen used for this observation | Observation.specimen |
status | token | The status of the observation | Observation.status |
subject | reference | The subject that the observation is about | Observation.subject |
value-concept | token | The value of the observation, if the value is a CodeableConcept | Observation.value |
value-date | date | The value of the observation, if the value is a date or period of time | Observation.value |
value-quantity | quantity | The 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 |
value-string | string | The value of the observation, if the value is a string, and also searches in CodeableConcept.text | Observation.value |
code-value-concept | composite | Code and coded value parameter pair | |
code-value-date | composite | Code and date/time value parameter pair | |
code-value-quantity | composite | Code and quantity value parameter pair | |
code-value-string | composite | Code and string value parameter pair | |
combo-code-value-concept | composite | Code and coded value parameter pair, including in components | Observation.component |
combo-code-value-quantity | composite | Code and quantity value parameter pair, including in components | Observation.component |
component-code-value-concept | composite | Component code and component coded value parameter pair | Observation.component |
component-code-value-quantity | composite | Component code and component quantity value parameter pair | Observation.component |
Inherited Properties
Name | Required | Type | Description |
---|---|---|---|
id | string | Logical id of this artifact DetailsThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | |
meta | Meta | Metadata about the resource DetailsThe 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. | |
implicitRules | uri | A set of rules under which this content was created DetailsA 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. 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. | |
language | code | Language of the resource content DetailsThe base language in which the resource is written. 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). | |
text | Narrative | Text summary of the resource, for human interpretation DetailsA 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. 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. | |
contained | Resource[] | Contained, inline Resources DetailsThese 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. 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. | |
extension | Extension[] | Additional content defined by implementations DetailsMay 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. 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. | |
modifierExtension | Extension[] | Extensions that cannot be ignored DetailsMay 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). 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. |