This page is part of the FHIR Specification v4.3.0-snapshot1: R4B Snapshot to support the Jan 2022 Connectathon. About the R4B version of FHIR. The current officially released version is 4.3.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4
Orders and Observations Work Group | Maturity Level: 0 | Trial Use | Security Category: Business | Compartments: Not linked to any defined compartments |
Detailed Descriptions for the elements in the ObservationDefinition resource.
ObservationDefinition | |
Element Id | ObservationDefinition |
Definition | Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service. |
Cardinality | 0..* |
Type | DomainResource |
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. |
Summary | false |
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 Id | ObservationDefinition.category |
Definition | A code that classifies the general type of observation. |
Cardinality | 0..* |
Terminology Binding | Observation Category Codes (Example) |
Type | CodeableConcept |
Requirements | Used for filtering what kinds of observations are retrieved and displayed. |
Alternate Names | Class of observation |
Summary | true |
Comments | This element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used for one instance of ObservationDefinition. The level of granularity is defined by the category concepts in the value set. |
ObservationDefinition.code | |
Element Id | ObservationDefinition.code |
Definition | Describes what will be observed. Sometimes this is called the observation "name". |
Cardinality | 1..1 |
Terminology Binding | LOINC Codes (Example) |
Type | CodeableConcept |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Alternate Names | Name |
Summary | true |
ObservationDefinition.identifier | |
Element Id | ObservationDefinition.identifier |
Definition | A unique identifier assigned to this ObservationDefinition artifact. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Cardinality | 0..* |
Type | Identifier |
Summary | true |
ObservationDefinition.permittedDataType | |
Element Id | ObservationDefinition.permittedDataType |
Definition | The data types allowed for the value element of the instance observations conforming to this ObservationDefinition. |
Cardinality | 0..* |
Terminology Binding | ObservationDataType (Required) |
Type | code |
Summary | false |
ObservationDefinition.multipleResultsAllowed | |
Element Id | ObservationDefinition.multipleResultsAllowed |
Definition | Multiple results allowed for observations conforming to this ObservationDefinition. |
Cardinality | 0..1 |
Type | boolean |
Summary | false |
Comments | An example of observation allowing multiple results is "bacteria identified by culture". Conversely, the measurement of a potassium level allows a single result. |
ObservationDefinition.method | |
Element Id | ObservationDefinition.method |
Definition | The method or technique used to perform the observation. |
Cardinality | 0..1 |
Terminology Binding | Observation Methods (Example) |
Type | CodeableConcept |
Requirements | In some cases, method can impact results. |
Summary | false |
Comments | Only used if not implicit in observation code. |
ObservationDefinition.preferredReportName | |
Element Id | ObservationDefinition.preferredReportName |
Definition | The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition. |
Cardinality | 0..1 |
Type | string |
Summary | false |
ObservationDefinition.quantitativeDetails | |
Element Id | ObservationDefinition.quantitativeDetails |
Definition | Characteristics for quantitative results of this observation. |
Cardinality | 0..1 |
Summary | false |
ObservationDefinition.quantitativeDetails.customaryUnit | |
Element Id | ObservationDefinition.quantitativeDetails.customaryUnit |
Definition | Customary unit used to report quantitative results of observations conforming to this ObservationDefinition. |
Cardinality | 0..1 |
Terminology Binding | UCUM Codes (Extensible) |
Type | CodeableConcept |
Summary | false |
ObservationDefinition.quantitativeDetails.unit | |
Element Id | ObservationDefinition.quantitativeDetails.unit |
Definition | SI unit used to report quantitative results of observations conforming to this ObservationDefinition. |
Cardinality | 0..1 |
Terminology Binding | UCUM Codes (Extensible) |
Type | CodeableConcept |
Summary | false |
ObservationDefinition.quantitativeDetails.conversionFactor | |
Element Id | ObservationDefinition.quantitativeDetails.conversionFactor |
Definition | Factor for converting value expressed with SI unit to value expressed with customary unit. |
Cardinality | 0..1 |
Type | decimal |
Summary | false |
ObservationDefinition.quantitativeDetails.decimalPrecision | |
Element Id | ObservationDefinition.quantitativeDetails.decimalPrecision |
Definition | Number of digits after decimal separator when the results of such observations are of type Quantity. |
Cardinality | 0..1 |
Type | integer |
Summary | false |
ObservationDefinition.qualifiedInterval | |
Element Id | ObservationDefinition.qualifiedInterval |
Definition | Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition. |
Cardinality | 0..* |
Summary | false |
ObservationDefinition.qualifiedInterval.category | |
Element Id | ObservationDefinition.qualifiedInterval.category |
Definition | The category of interval of values for continuous or ordinal observations conforming to this ObservationDefinition. |
Cardinality | 0..1 |
Terminology Binding | ObservationRangeCategory (Required) |
Type | code |
Summary | false |
ObservationDefinition.qualifiedInterval.range | |
Element Id | ObservationDefinition.qualifiedInterval.range |
Definition | The low and high values determining the interval. There may be only one of the two. |
Cardinality | 0..1 |
Type | Range |
Requirements | The unit may be not relevant for ordinal values. In case it is there, it is the same as quantitativeDetails.unit. |
Summary | false |
ObservationDefinition.qualifiedInterval.context | |
Element Id | ObservationDefinition.qualifiedInterval.context |
Definition | Codes to indicate the health context the range applies to. For example, the normal or therapeutic range. |
Cardinality | 0..1 |
Terminology Binding | Observation Reference Range Meaning Codes (Extensible) |
Type | CodeableConcept |
Summary | false |
ObservationDefinition.qualifiedInterval.appliesTo | |
Element Id | ObservationDefinition.qualifiedInterval.appliesTo |
Definition | Codes to indicate the target population this reference range applies to. |
Cardinality | 0..* |
Terminology Binding | Observation Reference Range Applies To Codes (Example) |
Type | CodeableConcept |
Summary | false |
Comments | If this element is not present then the global population is assumed. |
ObservationDefinition.qualifiedInterval.gender | |
Element Id | ObservationDefinition.qualifiedInterval.gender |
Definition | Sex of the population the range applies to. |
Cardinality | 0..1 |
Terminology Binding | AdministrativeGender (Required) |
Type | code |
Summary | false |
ObservationDefinition.qualifiedInterval.age | |
Element Id | ObservationDefinition.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. |
Cardinality | 0..1 |
Type | Range |
Summary | false |
Comments | Some analytes vary greatly over age. |
ObservationDefinition.qualifiedInterval.gestationalAge | |
Element Id | ObservationDefinition.qualifiedInterval.gestationalAge |
Definition | The gestational age to which this reference range is applicable, in the context of pregnancy. |
Cardinality | 0..1 |
Type | Range |
Summary | false |
ObservationDefinition.qualifiedInterval.condition | |
Element Id | ObservationDefinition.qualifiedInterval.condition |
Definition | Text based condition for which the reference range is valid. |
Cardinality | 0..1 |
Type | string |
Summary | false |
ObservationDefinition.validCodedValueSet | |
Element Id | ObservationDefinition.validCodedValueSet |
Definition | The set of valid coded results for the observations conforming to this ObservationDefinition. |
Cardinality | 0..1 |
Type | Reference(ValueSet) |
Summary | false |
ObservationDefinition.normalCodedValueSet | |
Element Id | ObservationDefinition.normalCodedValueSet |
Definition | The set of normal coded results for the observations conforming to this ObservationDefinition. |
Cardinality | 0..1 |
Type | Reference(ValueSet) |
Summary | false |
ObservationDefinition.abnormalCodedValueSet | |
Element Id | ObservationDefinition.abnormalCodedValueSet |
Definition | The set of abnormal coded results for the observation conforming to this ObservationDefinition. |
Cardinality | 0..1 |
Type | Reference(ValueSet) |
Summary | false |
ObservationDefinition.criticalCodedValueSet | |
Element Id | ObservationDefinition.criticalCodedValueSet |
Definition | The set of critical coded results for the observation conforming to this ObservationDefinition. |
Cardinality | 0..1 |
Type | Reference(ValueSet) |
Summary | false |