This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
(v4.2.0:
R5
Preview
#1).
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
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. |
| 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. |
|
|
|
| Element Id |
|
| Definition |
|
| Cardinality | 0..1 |
| Type | uri |
| Requirements | Allows the ObservationDefinition to be referenced by a single globally unique identifier. |
| Summary | true |
| Comments | Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. This is the URI that will be used when making canonical references to this resource. |
| ObservationDefinition.identifier | |
| Element Id | ObservationDefinition.identifier |
| Definition | Business identifiers assigned to this ObservationDefinition. by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. |
| Note | This is a business identifier, not a resource identifier (see discussion ) |
| Cardinality | 0..1 |
| Type | Identifier |
| Requirements | Allows identification of the ObservationDefinition as it is known by various participating systems and in a way that remains consistent across servers. |
| Summary | true |
| Comments | This is a business identifier, not a resource identifier. It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. |
| ObservationDefinition.version | |
| Element Id | ObservationDefinition.version |
| Definition | The identifier that is used to identify this version of the ObservationDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the ObservationDefinition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable. |
| Note | This is a business versionId, not a resource version id (see discussion ) |
| Cardinality | 0..1 |
| Type | string |
| Summary | true |
| Comments | There may be multiple different instances of a ObservationDefinition that have the same identifier but different versions. |
| ObservationDefinition.title | |
| Element Id | ObservationDefinition.title |
| Definition | A short, descriptive, user-friendly title for the ObservationDefinition. |
| Cardinality | 0..1 |
| Type | string |
| Summary | true |
| ObservationDefinition.derivedFromCanonical | |
| Element Id | ObservationDefinition.derivedFromCanonical |
| Definition | The canonical URL pointing to another FHIR-defined ObservationDefinition that is adhered to in whole or in part by this definition. |
| Cardinality | 0..* |
| Type | canonical ( ObservationDefinition ) |
| Summary | true |
| ObservationDefinition.derivedFromUri | |
| Element Id | ObservationDefinition.derivedFromUri |
| Definition | The URL pointing to an externally-defined observation definition, guideline or other definition that is adhered to in whole or in part by this definition. |
| Cardinality | 0..* |
| Type | uri |
| Requirements | Observation definitions may be refinements of other definitions. |
| Summary | true |
| ObservationDefinition.status | |
| Element Id | ObservationDefinition.status |
| Definition | The current state of the ObservationDefinition. |
| Cardinality | 1..1 |
| Terminology Binding |
|
| Type |
|
|
| true (Reason: Not known why this is labelled a modifier) |
| Summary | true |
| Comments |
|
| ObservationDefinition.experimental | |
| Element Id | ObservationDefinition.experimental |
| Definition | A flag to indicate that this ObservationDefinition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. |
| Cardinality | 0..1 |
| Type | boolean |
| Is Modifier | true (Reason: Not known why this is labelled a modifier) |
| Summary | true |
| Comments |
Allows
filtering
|
| ObservationDefinition.subject[x] | |
|
| ObservationDefinition.subject[x] |
| Definition |
A
code
or
group
definition
that
describes
the
intended
subject
of
|
| Cardinality | 0..1 |
| Type | CodeableConcept | Reference ( Group ) |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Summary | true |
| Comments |
|
| ObservationDefinition.date | |
| Element Id | ObservationDefinition.date |
| Definition |
For
draft
definitions,
indicates
the
|
| Cardinality | 0..1 |
| Type | dateTime |
| Summary | true |
| ObservationDefinition.publisher | |
| Element Id | ObservationDefinition.publisher |
| Definition | Helps establish the "authority/credibility" of the ObservationDefinition. May also allow for contact. |
| Cardinality | 0..1 |
| Type | Reference ( Practitioner | PractitionerRole | Organization ) |
| Patterns | Reference(Practitioner,PractitionerRole,Organization): Common patterns = Participant |
| Requirements |
Usually
an
organization,
but
may
be
|
| Summary | true |
| ObservationDefinition.contact | |
| Element Id | ObservationDefinition.contact |
| Definition |
Contact
details
to
assist
a
user
in
finding
and
communicating
with
the
|
| Cardinality | 0..* |
| Type | ContactDetail |
| Summary | true |
| Comments | May be a web site, an email address, a telephone number, etc. |
|
|
|
| Element Id |
|
| Definition |
|
| Cardinality | 0..1 |
| Type | markdown |
| Comments |
This
description
can
be
|
| ObservationDefinition.useContext | |
| Element Id | ObservationDefinition.useContext |
| Definition |
The
content
was
developed
with
a
focus
and
intent
of
supporting
the
contexts
that
are
listed.
These
terms
may
be
used
to
assist
with
indexing
and
searching
of
observation
|
| Cardinality |
|
| Type | UsageContext |
| Requirements | Assist in searching for appropriate content. |
| Comments | When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply. |
| ObservationDefinition.jurisdiction | |
| Element Id | ObservationDefinition.jurisdiction |
| Definition | A jurisdiction in which the ObservationDefinition is intended to be used. |
| Cardinality | 0..* |
| Terminology Binding |
|
| Type | CodeableConcept |
|
| true |
| ObservationDefinition.purpose | |
| Element Id | ObservationDefinition.purpose |
| Definition |
|
| Cardinality | 0..1 |
| Type | markdown |
| Comments |
This
element
does
not
describe
the
usage
of
|
| ObservationDefinition.copyright | |
| Element Id | ObservationDefinition.copyright |
| Definition | Copyright statement relating to the ObservationDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the ObservationDefinition. |
| Cardinality | 0..1 |
| Type | markdown |
| Requirements | Consumers of the ObservationDefinition must be able to determine any legal restrictions on the use of the artifact and/or its content. |
| Alternate Names |
|
| ObservationDefinition.approvalDate | |
| Element Id | ObservationDefinition.approvalDate |
| Definition | The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage. |
| Cardinality | 0..1 |
| Type | date |
| Comments | The date may be more recent than the approval date because of minor changes / editorial corrections. |
| ObservationDefinition.lastReviewDate | |
| Element Id | ObservationDefinition.lastReviewDate |
| Definition | The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date. |
| Cardinality | 0..1 |
| Type | date |
| Comments | If specified, this is usually after the approval date. |
| ObservationDefinition.effectivePeriod | |
| Element Id | ObservationDefinition.effectivePeriod |
| Definition | The period during which the ObservationDefinition content was or is planned to be effective. |
| Cardinality | 0..1 |
| Type | Period |
| Summary | true |
| Comments | The effective period for an ObservationDefinition determines when the content is applicable for usage and is independent of publication and review dates. For example, an observation intended to be used for the year 2020 would be published in 2019. |
|
|
|
| Element Id |
|
| Definition |
|
|
|
0..1 |
| Type | CodeableConcept |
| Summary | true |
| 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
|
|
| |
| Element Id | ObservationDefinition.code |
| Definition | Describes what will be observed. Sometimes this is called the observation "name". |
| Cardinality |
|
| Terminology Binding | LOINC Codes ( Example ) |
| Type |
|
| Alternate Names | Name |
| 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 |
| ObservationDefinition.multipleResultsAllowed | |
| Element Id | ObservationDefinition.multipleResultsAllowed |
| Definition |
Multiple results allowed for observations conforming to this ObservationDefinition. |
| Cardinality | 0..1 |
| Type | boolean |
| 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.bodySite | |
| Element Id | ObservationDefinition.bodySite |
| Definition | The site on the subject's body where the observation is to be made. |
| Cardinality | 0..1 |
| Terminology Binding | SNOMED CT Body Structures ( Example ) |
| Type | CodeableConcept |
| Comments | Only used if the defined observation is to be made directly on a body part and if this body part is not implied by code found in ObservationDefinition.code. Not used for in vitro diagnostic observations. Example: 14975008 |Forearm structure|. |
| 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. |
| Comments |
Only
used
if
not
implicit
in
observation
|
| ObservationDefinition.specimen | |
| Element Id | ObservationDefinition.specimen |
| Definition | The kind of specimen that this type of observation is produced on. |
| Cardinality | 0..1 |
| Type | Reference ( SpecimenDefinition ) |
| Comments | Only used for in vitro observations. |
| ObservationDefinition.device | |
| Element Id | ObservationDefinition.device |
| Definition | The measurement device used to produce observations of this type. |
| Cardinality | 0..1 |
| Type | Reference ( Device ) |
| 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 |
| ObservationDefinition.quantitativeDetails | |
| Element Id | ObservationDefinition.quantitativeDetails |
| Definition |
Characteristics for quantitative results of this observation. |
| Cardinality | 0..1 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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..* |
| 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 |
| 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. |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| ObservationDefinition.qualifiedInterval.condition | |
| Element Id | ObservationDefinition.qualifiedInterval.condition |
| Definition |
Text based condition for which the reference range is valid. |
| Cardinality | 0..1 |
| Type | string |
| 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 ) |
| 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 ) |
| 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 ) |
| 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 ) |
| ObservationDefinition.hasMember | |
| Element Id | ObservationDefinition.hasMember |
| Definition | This ObservationDefinition defines 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. |
| Cardinality | 0..* |
| Type | Reference ( ObservationDefinition | Questionnaire ) |
| Patterns | Reference(ObservationDefinition,Questionnaire): No common pattern |
| ObservationDefinition.component | |
| Element Id | ObservationDefinition.component |
| Definition | Some observations have multiple component observations, expressed as separate code value pairs. |
| Cardinality | 0..* |
| Requirements | Component observations share the same attributes as the primary observation and are always treated as a part of it (they are not separable). |
| ObservationDefinition.component.code | |
| Element Id | ObservationDefinition.component.code |
| Definition | Describes what will be observed. |
| Cardinality | 1..1 |
| Terminology Binding | LOINC Codes ( Example ) |
| Type | CodeableConcept |
| ObservationDefinition.component.permittedDataType | |
| Element Id | ObservationDefinition.component.permittedDataType |
| Definition | The data types allowed for the value element of the instance of this component observations. |
| Cardinality | 0..* |
| Terminology Binding | ObservationDataType ( Required ) |
| Type | code |
| ObservationDefinition.component.quantitativeDetails | |
| Element Id | ObservationDefinition.component.quantitativeDetails |
| Definition | The quantitative details specified. |
| Cardinality | 0..1 |
| Type | See ObservationDefinition.quantitativeDetails |
| ObservationDefinition.component.qualifiedInterval | |
| Element Id | ObservationDefinition.component.qualifiedInterval |
| Definition | The qualified interval specified. |
| Cardinality | 0..* |
| Type | See ObservationDefinition.qualifiedInterval |