R4 Ballot #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.5.0: R4 Ballot #2). 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

Orders and Observations Work GroupMaturity Level: 0 Trial Use Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the ObservationDefinition resource.

ObservationDefinition
Element IdObservationDefinition
Definition

Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.

Control1..1
TypeDomainResource
Requirements

In a catalog of health-related services that use or produce observations and measurements, this resource describes the expected characteristics of these observation / measurements.

Comments

An instance of this resource informs the consumer of a health-related service (such as a lab diagnostic test or panel) about how the observations used or produced by this service will look like.

ObservationDefinition.category
Element IdObservationDefinition.category
Definition

A code that classifies the general type of observation.

Control0..1
TypeCoding
Requirements

Used for filtering what observations are retrieved and displayed.

Alternate NamesClass of observation
Summarytrue
Comments

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

ObservationDefinition.code
Element IdObservationDefinition.code
Definition

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

Control1..1
Terminology BindingLOINC Codes (Example)
TypeCoding
Requirements

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

Alternate NamesName
Summarytrue
ObservationDefinition.permittedDataType
Element IdObservationDefinition.permittedDataType
Definition

Data type allowed for the result of the observation.

Control0..*
TypeCoding
ObservationDefinition.multipleResultsAllowed
Element IdObservationDefinition.multipleResultsAllowed
Definition

Multiple results allowed for this kind of observation.

Control0..1
Typeboolean
ObservationDefinition.method
Element IdObservationDefinition.method
Definition

The method or technique used to perform the observation.

Control0..1
Terminology BindingObservation Methods (Example)
TypeCodeableConcept
Requirements

In some cases, method can impact results.

Comments

Only used if not implicit in observation code.

ObservationDefinition.preferredReportName
Element IdObservationDefinition.preferredReportName
Definition

The preferred name to be used when reporting the results of this observation.

Control0..1
Typestring
ObservationDefinition.quantitativeDetails
Element IdObservationDefinition.quantitativeDetails
Definition

Characteristics for quantitative results of this observation.

Control0..1
ObservationDefinition.quantitativeDetails.customaryUnit
Element IdObservationDefinition.quantitativeDetails.customaryUnit
Definition

Customary unit used to report quantitative results of this observation.

Control0..1
Terminology BindingObservationUnit :
TypeCoding
ObservationDefinition.quantitativeDetails.unit
Element IdObservationDefinition.quantitativeDetails.unit
Definition

SI unit used to report quantitative results of this observation.

Control0..1
Terminology BindingObservationUnit :
TypeCoding
ObservationDefinition.quantitativeDetails.conversionFactor
Element IdObservationDefinition.quantitativeDetails.conversionFactor
Definition

Factor for converting value expressed with SI unit to value expressed with customary unit.

Control0..1
Typedecimal
ObservationDefinition.quantitativeDetails.decimalPrecision
Element IdObservationDefinition.quantitativeDetails.decimalPrecision
Definition

Number of digits after decimal separator when the results of this observation are of type Quantity.

Control0..1
Typeinteger
ObservationDefinition.qualifiedInterval
Element IdObservationDefinition.qualifiedInterval
Definition

Reference range for ordinal and continuous observations.

Control0..*
Requirements

multiple reference ranges, for different patient contexts.

ObservationDefinition.qualifiedInterval.category
Element IdObservationDefinition.qualifiedInterval.category
Definition

The category or type of interval.

Control0..1
Terminology BindingObservation Category Codes (Preferred)
TypeCodeableConcept
ObservationDefinition.qualifiedInterval.range
Element IdObservationDefinition.qualifiedInterval.range
Definition

The value and associated unit of the low bound (inclusive) of the reference range.

Control0..1
TypeRange
Requirements

The unit may be not relevant for ordinal values. In case it is there, it is the same as SIunit or customaryUnit.

ObservationDefinition.qualifiedInterval.type
Element IdObservationDefinition.qualifiedInterval.type
Definition

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

Control0..1
Terminology BindingObservation Reference Range Meaning Codes (Extensible)
TypeCodeableConcept
Requirements

what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.

Comments

normal range is the default.

ObservationDefinition.qualifiedInterval.appliesTo
Element IdObservationDefinition.qualifiedInterval.appliesTo
Definition

Codes to indicate the target population this reference range applies to.

Control0..*
Terminology BindingObservation Reference Range Applies To Codes (Example)
TypeCodeableConcept
Requirements

target population (male, female, pregnancy, a specific race ….

Comments

If this element is not present then the global population is assumed.

ObservationDefinition.qualifiedInterval.age
Element IdObservationDefinition.qualifiedInterval.age
Definition

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

Control0..1
TypeRange
Requirements

Some analytes vary greatly over age.

ObservationDefinition.qualifiedInterval.gestationalAge
Element IdObservationDefinition.qualifiedInterval.gestationalAge
Definition

The gestational age at which this reference range is applicable, in the context of pregnancy.

Control0..1
TypeRange
ObservationDefinition.qualifiedInterval.condition
Element IdObservationDefinition.qualifiedInterval.condition
Definition

Text based condition for which the reference range is valid.

Control0..1
Typestring
ObservationDefinition.validCodedValueSet
Element IdObservationDefinition.validCodedValueSet
Definition

The set of valid coded results for the observation.

Control0..1
Typeuri
ObservationDefinition.normalCodedValueSet
Element IdObservationDefinition.normalCodedValueSet
Definition

The set of normal coded results for the observation.

Control0..1
Typeuri
ObservationDefinition.abnormalCodedValueSet
Element IdObservationDefinition.abnormalCodedValueSet
Definition

The set of abnormal coded results for the observation.

Control0..1
Typeuri
ObservationDefinition.criticalCodedValueSet
Element IdObservationDefinition.criticalCodedValueSet
Definition

The set of critical coded results for the observation.

Control0..1
Typeuri