Administration
This
page
is
part
of
the
Continuous
Integration
Build
of
FHIR
Specification
(v5.0.0:
R5
-
STU
).
This
is
the
current
published
version
in
it's
permanent
home
(it
will
always
(will
be
available
incorrect/inconsistent
at
this
URL).
For
a
full
list
of
available
versions,
see
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
|
Responsible
Owner:
Orders
and
Observations
Work
Group
|
|
Security Category : Business | Compartments : No defined compartments |
Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.
An instance of ObservationDefinition represents the definitional aspects of a kind of observation. This resource is used in a catalog of products or services for healthcare. It represents a set of constraints applicable to the value produced by observations of this kind. It helps the consumer of the results of observations of that kind, to interpret properly these results. If one wants to technically constrain an Observation resource for a particular use case across implementers, a profile is the preferred option and may include profiling on ObservationDefinition and Observation.
For instance, in a catalog of laboratory in vitro diagnostic services, the ObservationDefinition resources describe the observations that should be provided by the orderer alongside with an ordered service (questions asked at order entry or at specimen collection, prior results) as well as the observations that will be reported once the service has been performed.
Observation Definition resources can be used to describe observations which may need to be evaluated in order to determine whether a specific medicine can be administered or held (e.g., weight, lab value result) and provide guidance on the dose to be administered (e.g., sliding scale insulin dose).
In the catalog of tests of an in vitro diagnostic device, ObservationDefinition resources can be used to characterize (absolute range, unit, decimal precision, critical values ...) the observations that will be produced by the IVD tests performed by the device.
ObservationDefinition may be used to characterize observations from any discipline.
An ObservationDefinition resource provides the definitional characteristics for a certain kind of observation. Each time that kind of observation is collected and recorded it is instantiated as an Observation resource, which conforms to these definitional characteristics. Thus, there is a relationship between ObservationDefinition and Observation: The latter may instantiate the former.
When an Observation instantiates an ObservationDefinition, the elements of the Observation resource are expected to inherit their content from the corresponding definitional elements declared in the ObservationDefinition resource:
ObservationDefinition
enables
to
express
some
Quantity
results
in
two
distinct
can
specify
units
of
measure:
allowed
for
the
primary
or
SI
one,
represented
by
valueQuantity
element
unit,
and
a
converted
one,
provided
for
accommodation
of
some
actors,
represented
by
element
customaryUnit.
Observation
may
pick
only
the
primary
unit,
or
may
express
its
result
in
both
units,
in
two
component
results.
setting
ObservationDefinition.permittedUnit.
ObservationDefinitions are only to be used when describing the contents of an observation (including observations in order catalogs or panels). When additional structure, sequence, or rules are needed, the Questionnaire resource should be used.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
Filter:
|
|---|---|---|---|---|
ObservationDefinition
|
|
DomainResource |
Definition
of
an
observation
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation + Rule: If permittedUnit exists, then permittedDataType=Quantity must exist. Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension Interfaces Implemented: MetadataResource |
|
url
|
Σ | 0..1 | uri |
Logical
canonical
URL
to
reference
this
ObservationDefinition
(globally
unique)
|
identifier
|
Σ | 0..1 | Identifier |
Business
identifier
of
the
ObservationDefinition
|
|
version
|
Σ | 0..1 | string |
Business
version
of
the
ObservationDefinition
|
versionAlgorithm[x]
|
Σ | 0..1 |
How
to
compare
versions
Binding: Version Algorithm ( Extensible ) |
|
versionAlgorithmString
|
string | |||
versionAlgorithmCoding
|
Coding | |||
|
name
|
Σ C | 0..1 | string |
Name
for
this
ObservationDefinition
(computer
friendly)
|
|
title
|
Σ T | 0..1 | string |
Name
for
this
ObservationDefinition
(human
friendly)
|
|
status
|
?! Σ | 1..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( Required ) |
|
experimental
|
Σ | 0..1 | boolean |
If
|
|
date
|
Σ | 0..1 | dateTime |
Date
last
changed
|
|
publisher
|
Σ T | 0..1 | string |
The
name
of
the
individual
or
organization
that
published
the
ObservationDefinition
|
|
contact
|
Σ | 0..* | ContactDetail |
Contact
details
for
the
publisher
|
|
description
|
T | 0..1 | markdown |
Natural
language
description
of
the
ObservationDefinition
|
|
useContext
|
Σ | 0..* | UsageContext |
Content
intends
to
support
these
contexts
|
|
jurisdiction
|
Σ
|
0..* | CodeableConcept |
Jurisdiction
of
the
authority
that
maintains
the
this
ObservationDefinition
(if
applicable)
Binding: Jurisdiction ValueSet
(
Extensible
)
|
|
purpose
|
T | 0..1 | markdown |
Why
this
ObservationDefinition
is
defined
|
|
copyright
|
T | 0..1 | markdown |
Notice
about
intellectual
property
ownership,
can
include
restrictions
on
use
|
|
copyrightLabel
|
T | 0..1 | string |
Copyright
holder
and
year(s)
|
|
approvalDate
|
0..1 | date |
When
ObservationDefinition
was
approved
by
publisher
|
|
|
lastReviewDate
|
0..1 | date |
Date
on
which
the
asset
content
was
last
reviewed
by
the
publisher
|
|
|
effectivePeriod
|
Σ | 0..1 | Period |
The
effective
date
range
for
the
ObservationDefinition
|
derivedFromCanonical
|
Σ | 0..* | canonical ( ObservationDefinition ) |
Based
on
FHIR
definition
of
another
observation
|
|
derivedFromUri
|
Σ | 0..* | uri |
Based
on
external
definition
|
|
subject
|
Σ | 0..* | CodeableConcept |
Type
of
subject
for
the
defined
observation
|
|
performerType
|
Σ | 0..1 | CodeableConcept |
Desired
kind
of
performer
for
such
kind
of
observation
|
|
category
|
Σ | 0..* | CodeableConcept |
General
type
of
observation
Binding: Observation Category Codes ( Example ) |
|
code
|
Σ | 1..1 | CodeableConcept |
Type
of
observation
Binding: LOINC |
|
permittedDataType
|
C | 0..* | code |
Quantity
|
CodeableConcept
|
string
|
boolean
|
integer
|
Range
|
Ratio
|
SampledData
|
time
|
dateTime
|
Period
Binding: Observation Data Type ( Required ) |
|
multipleResultsAllowed
|
0..1 | boolean |
Multiple
results
allowed
for
conforming
observations
|
|
|
bodyStructure
|
0..1 |
|
Body
Binding: SNOMED CT Body Structures ( Example ) |
|
|
method
|
0..1 | CodeableConcept |
Method
used
to
produce
the
observation
Binding: Observation Methods ( Example ) |
|
|
specimen
|
0..* | Reference ( SpecimenDefinition ) |
Kind
of
specimen
used
by
this
type
of
observation
|
|
|
device[x]
|
0..1 |
|
Measurement
device
or
model
of
device
|
|
|
deviceReference
|
Reference
(
|
|
||
|
deviceCanonical
| canonical ( DeviceDefinition ) | |||
|
preferredReportName
|
0..1 | string |
The
preferred
name
to
be
used
when
reporting
the
observation
results
|
|
|
permittedUnit
|
C | 0..* | Coding |
Unit
for
quantitative
results
Binding: UCUM Codes ( Preferred ) |
qualifiedValue
|
0..* | BackboneElement |
Set
of
qualified
values
for
observation
results
|
|
|
context
|
0..1 | CodeableConcept |
Context
qualifier
for
the
set
of
qualified
values
Binding: Observation Reference Range Meaning Codes ( Extensible ) |
|
|
appliesTo
|
0..* | CodeableConcept |
Targetted
population
for
the
set
of
qualified
values
Binding: Observation Reference Range Applies To Codes ( Example ) |
|
|
|
0..1 | code |
male
|
female
|
other
|
unknown
Binding: AdministrativeGender ( Required ) |
|
|
age
|
0..1 | Range |
Applicable
age
range
for
the
set
of
qualified
values
|
|
|
gestationalAge
|
0..1 | Range |
Applicable
gestational
age
range
for
the
set
of
qualified
values
|
|
|
condition
|
0..1 | string |
Validity
criterion
for
the
|
|
|
rangeCategory
|
0..1 | code |
reference
|
critical
|
absolute
Binding: Observation Range Category ( Required ) |
|
|
range
|
0..1 | Range |
The
range
for
continuous
or
ordinal
observations
|
|
|
validCodedValueSet
|
0..1 | canonical ( ValueSet ) |
Value
set
of
valid
coded
values
as
part
of
this
set
of
qualified
values
|
|
|
normalCodedValueSet
|
0..1 | canonical ( ValueSet ) |
Value
set
of
normal
coded
values
as
part
of
this
set
of
qualified
values
|
|
|
abnormalCodedValueSet
|
0..1 | canonical ( ValueSet ) |
Value
set
of
abnormal
coded
values
as
part
of
this
set
of
qualified
values
|
|
|
criticalCodedValueSet
|
0..1 | canonical ( ValueSet ) |
Value
set
of
critical
coded
values
as
part
of
this
set
of
qualified
values
|
|
|
interpretation
| 0..* | CodeableConcept |
Expected
coded
interpretation
values
Binding: Observation Interpretation Codes ( Extensible ) | |
|
hasMember
|
0..* | Reference ( ObservationDefinition | Questionnaire ) |
Definitions
of
related
resources
belonging
to
this
kind
of
observation
group
|
|
component
|
C | 0..* | BackboneElement |
Component
results
+ Rule: If permittedUnit exists, then permittedDataType=Quantity must exist. |
code
|
1..1 | CodeableConcept |
Type
of
observation
Binding: LOINC |
|
|
permittedDataType
|
C | 0..* | code |
Quantity
|
CodeableConcept
|
string
|
boolean
|
integer
|
Range
|
Ratio
|
SampledData
|
time
|
dateTime
|
Period
Binding: Observation Data Type ( Required ) |
|
permittedUnit
|
C | 0..* | Coding |
Unit
for
quantitative
results
Binding: UCUM Codes ( Preferred ) |
qualifiedValue
|
0..* | see qualifiedValue |
Set
of
qualified
values
for
observation
results
|
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
UML Diagram ( Legend )
XML Template
<ObservationDefinition xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Logical canonical URL to reference this ObservationDefinition (globally unique) --> <identifier><!-- 0..1 Identifier Business identifier of the ObservationDefinition --></identifier> <version value="[string]"/><!-- 0..1 Business version of the ObservationDefinition --> <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]> <name value="[string]"/><!-- I 0..1 Name for this ObservationDefinition (computer friendly) --> <title value="[string]"/><!-- 0..1 Name for this ObservationDefinition (human friendly) --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
<<experimental value="[boolean]"/><!-- 0..1 If For testing only - never for real usage --> <date value="[dateTime]"/><!-- 0..1 Date last changed --> <publisher value="[string]"/><!-- 0..1 The name of the individual or organization that published the ObservationDefinition --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- 0..1 Natural language description of the ObservationDefinition --> <useContext><!-- 0..* UsageContext Content intends to support these contexts --></useContext><</jurisdiction><jurisdiction><!-- 0..* CodeableConcept Jurisdiction of the authority that maintains the this ObservationDefinition (if applicable)< <<copyright value="[markdown]"/><!-- 0..1 Notice about intellectual property ownership, can include restrictions on use --> <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) --> <approvalDate value="[date]"/><!-- 0..1 When ObservationDefinition was approved by publisher --> <lastReviewDate value="[date]"/><!-- 0..1 Date on which the asset content was last reviewed by the publisher --> <effectivePeriod><!-- 0..1 Period The effective date range for the ObservationDefinition --></effectivePeriod> <derivedFromCanonical><!-- 0..* canonical(ObservationDefinition) Based on FHIR definition of another observation --></derivedFromCanonical> <derivedFromUri value="[uri]"/><!-- 0..* Based on external definition --> <subject><!-- 0..* CodeableConcept Type of subject for the defined observation --></subject> <performerType><!-- 0..1 CodeableConcept Desired kind of performer for such kind of observation --></performerType> <category><!-- 0..* CodeableConcept General type of observation --></category><</code><code><!-- 1..1 CodeableConcept Type of observation --></code> <permittedDataType value="[code]"/><!-- I 0..* Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period --> <multipleResultsAllowed value="[boolean]"/><!-- 0..1 Multiple results allowed for conforming observations --><</bodySite><bodyStructure><!-- 0..1 CodeableReference(BodyStructure) Body structure to be observed --></bodyStructure> <method><!-- 0..1 CodeableConcept Method used to produce the observation --></method> <specimen><!-- 0..* Reference(SpecimenDefinition) Kind of specimen used by this type of observation --></specimen><</device><device[x]><!-- 0..1 Reference(Device)|canonical(DeviceDefinition) Measurement device or model of device --></device[x]> <preferredReportName value="[string]"/><!-- 0..1 The preferred name to be used when reporting the observation results --> <permittedUnit><!-- I 0..* Coding Unit for quantitative results --></permittedUnit> <qualifiedValue> <!-- 0..* Set of qualified values for observation results --> <context><!-- 0..1 CodeableConcept Context qualifier for the set of qualified values --></context> <appliesTo><!-- 0..* CodeableConcept Targetted population for the set of qualified values --></appliesTo><<sexParameterForClinicalUse value="[code]"/><!-- 0..1 male | female | other | unknown --> <age><!-- 0..1 Range Applicable age range for the set of qualified values --></age> <gestationalAge><!-- 0..1 Range Applicable gestational age range for the set of qualified values --></gestationalAge><<condition value="[string]"/><!-- 0..1 Validity criterion for the qualified value --> <rangeCategory value="[code]"/><!-- 0..1 reference | critical | absolute --> <range><!-- 0..1 Range The range for continuous or ordinal observations --></range> <validCodedValueSet><!-- 0..1 canonical(ValueSet) Value set of valid coded values as part of this set of qualified values --></validCodedValueSet> <normalCodedValueSet><!-- 0..1 canonical(ValueSet) Value set of normal coded values as part of this set of qualified values --></normalCodedValueSet> <abnormalCodedValueSet><!-- 0..1 canonical(ValueSet) Value set of abnormal coded values as part of this set of qualified values --></abnormalCodedValueSet> <criticalCodedValueSet><!-- 0..1 canonical(ValueSet) Value set of critical coded values as part of this set of qualified values --></criticalCodedValueSet> <interpretation><!-- 0..* CodeableConcept Expected coded interpretation values --></interpretation> </qualifiedValue> <hasMember><!-- 0..* Reference(ObservationDefinition|Questionnaire) Definitions of related resources belonging to this kind of observation group --></hasMember> <component> <!-- 0..* Component results --><</code><code><!-- 1..1 CodeableConcept Type of observation --></code> <permittedDataType value="[code]"/><!-- I 0..* Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period --> <permittedUnit><!-- I 0..* Coding Unit for quantitative results --></permittedUnit> <qualifiedValue><!-- 0..* Content as for ObservationDefinition.qualifiedValue Set of qualified values for observation results --></qualifiedValue> </component> </ObservationDefinition>
JSON Template
{
"resourceType" : "ObservationDefinition",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // Logical canonical URL to reference this ObservationDefinition (globally unique)
"identifier" : { Identifier }, // Business identifier of the ObservationDefinition
"version" : "<string>", // Business version of the ObservationDefinition
// versionAlgorithm[x]: How to compare versions. One of these 2:
"versionAlgorithmString" : "<string>",
"versionAlgorithmCoding" : { Coding },
"name" : "<string>", // I Name for this ObservationDefinition (computer friendly)
"title" : "<string>", // Name for this ObservationDefinition (human friendly)
"status" : "<code>", // R! draft | active | retired | unknown
"
"experimental" : <boolean>, // If For testing only - never for real usage
"date" : "<dateTime>", // Date last changed
"publisher" : "<string>", // The name of the individual or organization that published the ObservationDefinition
"contact" : [{ ContactDetail }], // Contact details for the publisher
"description" : "<markdown>", // Natural language description of the ObservationDefinition
"useContext" : [{ UsageContext }], // Content intends to support these contexts
"
"jurisdiction" : [{ CodeableConcept }], // Jurisdiction of the authority that maintains the this ObservationDefinition (if applicable)
"purpose" : "<markdown>", // Why this ObservationDefinition is defined
"
"
"copyright" : "<markdown>", // Notice about intellectual property ownership, can include restrictions on use
"copyrightLabel" : "<string>", // Copyright holder and year(s)
"approvalDate" : "<date>", // When ObservationDefinition was approved by publisher
"lastReviewDate" : "<date>", // Date on which the asset content was last reviewed by the publisher
"effectivePeriod" : { Period }, // The effective date range for the ObservationDefinition
"derivedFromCanonical" : ["<canonical(ObservationDefinition)>"], // Based on FHIR definition of another observation
"derivedFromUri" : ["<uri>"], // Based on external definition
"subject" : [{ CodeableConcept }], // Type of subject for the defined observation
"performerType" : { CodeableConcept }, // Desired kind of performer for such kind of observation
"category" : [{ CodeableConcept }], // General type of observation
"
"code" : { CodeableConcept }, // R! Type of observation
"permittedDataType" : ["<code>"], // I Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
"multipleResultsAllowed" : <boolean>, // Multiple results allowed for conforming observations
"
"bodyStructure" : { CodeableReference(BodyStructure) }, // Body structure to be observed
"method" : { CodeableConcept }, // Method used to produce the observation
"specimen" : [{ Reference(SpecimenDefinition) }], // Kind of specimen used by this type of observation
"
// device[x]: Measurement device or model of device. One of these 2:
"deviceReference" : { Reference(Device) },
"deviceCanonical" : "<canonical(DeviceDefinition)>",
"preferredReportName" : "<string>", // The preferred name to be used when reporting the observation results
"permittedUnit" : [{ Coding }], // I Unit for quantitative results
"qualifiedValue" : [{ // Set of qualified values for observation results
"context" : { CodeableConcept }, // Context qualifier for the set of qualified values
"appliesTo" : [{ CodeableConcept }], // Targetted population for the set of qualified values
"
"sexParameterForClinicalUse" : "<code>", // male | female | other | unknown
"age" : { Range }, // Applicable age range for the set of qualified values
"gestationalAge" : { Range }, // Applicable gestational age range for the set of qualified values
"
"condition" : "<string>", // Validity criterion for the qualified value
"rangeCategory" : "<code>", // reference | critical | absolute
"range" : { Range }, // The range for continuous or ordinal observations
"validCodedValueSet" : "<canonical(ValueSet)>", // Value set of valid coded values as part of this set of qualified values
"normalCodedValueSet" : "<canonical(ValueSet)>", // Value set of normal coded values as part of this set of qualified values
"abnormalCodedValueSet" : "<canonical(ValueSet)>", // Value set of abnormal coded values as part of this set of qualified values
"
"criticalCodedValueSet" : "<canonical(ValueSet)>", // Value set of critical coded values as part of this set of qualified values
"interpretation" : [{ CodeableConcept }] // Expected coded interpretation values
}],
"hasMember" : [{ Reference(ObservationDefinition|Questionnaire) }], // Definitions of related resources belonging to this kind of observation group
"component" : [{ // Component results
"
"code" : { CodeableConcept }, // R! Type of observation
"permittedDataType" : ["<code>"], // I Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
"permittedUnit" : [{ Coding }], // I Unit for quantitative results
"qualifiedValue" : [{ Content as for ObservationDefinition.qualifiedValue }] // Set of qualified values for observation results
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .# from # from# from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension fhir:url [ uri ] ; # 0..1 Logical canonical URL to reference this ObservationDefinition (globally unique) fhir:identifier [ Identifier ] ; # 0..1 Business identifier of the ObservationDefinition fhir:version [ string ] ; # 0..1 Business version of the ObservationDefinition # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2fhir: ]fhir:versionAlgorithm [ a fhir:String ; string ] fhir:versionAlgorithm [ a fhir:Coding ; Coding ] fhir:name [ string ] ; # 0..1 I Name for this ObservationDefinition (computer friendly) fhir:title [ string ] ; # 0..1 Name for this ObservationDefinition (human friendly) fhir:status [ code ] ; # 1..1 draft | active | retired | unknownfhir:fhir:experimental [ boolean ] ; # 0..1 If For testing only - never for real usage fhir:date [ dateTime ] ; # 0..1 Date last changed fhir:publisher [ string ] ; # 0..1 The name of the individual or organization that published the ObservationDefinition fhir:contact ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher fhir:description [ markdown ] ; # 0..1 Natural language description of the ObservationDefinition fhir:useContext ( [ UsageContext ] ... ) ; # 0..* Content intends to support these contextsfhir:fhir:jurisdiction ( [ CodeableConcept ] ... ) ; # 0..* Jurisdiction of the authority that maintains the this ObservationDefinition (if applicable) fhir:purpose [ markdown ] ; # 0..1 Why this ObservationDefinition is definedfhir: fhir:fhir:copyright [ markdown ] ; # 0..1 Notice about intellectual property ownership, can include restrictions on use fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s) fhir:approvalDate [ date ] ; # 0..1 When ObservationDefinition was approved by publisher fhir:lastReviewDate [ date ] ; # 0..1 Date on which the asset content was last reviewed by the publisher fhir:effectivePeriod [ Period ] ; # 0..1 The effective date range for the ObservationDefinition fhir:derivedFromCanonical ( [ canonical(ObservationDefinition) ] ... ) ; # 0..* Based on FHIR definition of another observation fhir:derivedFromUri ( [ uri ] ... ) ; # 0..* Based on external definition fhir:subject ( [ CodeableConcept ] ... ) ; # 0..* Type of subject for the defined observation fhir:performerType [ CodeableConcept ] ; # 0..1 Desired kind of performer for such kind of observation fhir:category ( [ CodeableConcept ] ... ) ; # 0..* General type of observation fhir:code [ CodeableConcept ] ; # 1..1 Type of observation fhir:permittedDataType ( [ code ] ... ) ; # 0..* I Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period fhir:multipleResultsAllowed [ boolean ] ; # 0..1 Multiple results allowed for conforming observationsfhir:fhir:bodyStructure [ CodeableReference(BodyStructure) ] ; # 0..1 Body structure to be observed fhir:method [ CodeableConcept ] ; # 0..1 Method used to produce the observation fhir:specimen ( [ Reference(SpecimenDefinition) ] ... ) ; # 0..* Kind of specimen used by this type of observationfhir:# device[x] : 0..1 Measurement device or model of device. One of these 2 fhir:device [ a fhir:Reference ; Reference(Device) ] fhir:device [ a fhir:Canonical ; canonical(DeviceDefinition) ] fhir:preferredReportName [ string ] ; # 0..1 The preferred name to be used when reporting the observation results fhir:permittedUnit ( [ Coding ] ... ) ; # 0..* I Unit for quantitative results fhir:qualifiedValue ( [ # 0..* Set of qualified values for observation results fhir:context [ CodeableConcept ] ; # 0..1 Context qualifier for the set of qualified values fhir:appliesTo ( [ CodeableConcept ] ... ) ; # 0..* Targetted population for the set of qualified valuesfhir:fhir:sexParameterForClinicalUse [ code ] ; # 0..1 male | female | other | unknown fhir:age [ Range ] ; # 0..1 Applicable age range for the set of qualified values fhir:gestationalAge [ Range ] ; # 0..1 Applicable gestational age range for the set of qualified valuesfhir:fhir:condition [ string ] ; # 0..1 Validity criterion for the qualified value fhir:rangeCategory [ code ] ; # 0..1 reference | critical | absolute fhir:range [ Range ] ; # 0..1 The range for continuous or ordinal observations fhir:validCodedValueSet [ canonical(ValueSet) ] ; # 0..1 Value set of valid coded values as part of this set of qualified values fhir:normalCodedValueSet [ canonical(ValueSet) ] ; # 0..1 Value set of normal coded values as part of this set of qualified values fhir:abnormalCodedValueSet [ canonical(ValueSet) ] ; # 0..1 Value set of abnormal coded values as part of this set of qualified values fhir:criticalCodedValueSet [ canonical(ValueSet) ] ; # 0..1 Value set of critical coded values as part of this set of qualified values fhir:interpretation ( [ CodeableConcept ] ... ) ; # 0..* Expected coded interpretation values ] ... ) ; fhir:hasMember ( [ Reference(ObservationDefinition|Questionnaire) ] ... ) ; # 0..* Definitions of related resources belonging to this kind of observation group fhir:component ( [ # 0..* Component results fhir:code [ CodeableConcept ] ; # 1..1 Type of observation fhir:permittedDataType ( [ code ] ... ) ; # 0..* I Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period fhir:permittedUnit ( [ Coding ] ... ) ; # 0..* I Unit for quantitative results fhir:qualifiedValue ( [ See ObservationDefinition.qualifiedValue ] ... ) ; # 0..* Set of qualified values for observation results ] ... ) ; ]
Changes from both R4 and R4B
| ObservationDefinition | |
| ObservationDefinition.url |
|
| ObservationDefinition.identifier |
|
| ObservationDefinition.version |
|
| ObservationDefinition.versionAlgorithm[x] |
|
| ObservationDefinition.name |
|
| ObservationDefinition.title |
|
| ObservationDefinition.status |
|
| ObservationDefinition.experimental |
|
| ObservationDefinition.date |
|
| ObservationDefinition.publisher |
|
| ObservationDefinition.contact |
|
| ObservationDefinition.description |
|
| ObservationDefinition.useContext |
|
| ObservationDefinition.jurisdiction |
|
| ObservationDefinition.purpose |
|
| ObservationDefinition.copyright |
|
| ObservationDefinition.copyrightLabel |
|
| ObservationDefinition.approvalDate |
|
| ObservationDefinition.lastReviewDate |
|
| ObservationDefinition.effectivePeriod |
|
| ObservationDefinition.derivedFromCanonical |
|
| ObservationDefinition.derivedFromUri |
|
| ObservationDefinition.subject |
|
| ObservationDefinition.performerType |
|
|
|
|
| ObservationDefinition.specimen |
|
|
|
|
| ObservationDefinition.permittedUnit |
|
| ObservationDefinition.qualifiedValue |
|
| ObservationDefinition.qualifiedValue.context |
|
| ObservationDefinition.qualifiedValue.appliesTo |
|
|
|
|
| ObservationDefinition.qualifiedValue.age |
|
| ObservationDefinition.qualifiedValue.gestationalAge |
|
| ObservationDefinition.qualifiedValue.condition |
|
| ObservationDefinition.qualifiedValue.rangeCategory |
|
| ObservationDefinition.qualifiedValue.range |
|
| ObservationDefinition.qualifiedValue.validCodedValueSet |
|
| ObservationDefinition.qualifiedValue.normalCodedValueSet |
|
| ObservationDefinition.qualifiedValue.abnormalCodedValueSet |
|
| ObservationDefinition.qualifiedValue.criticalCodedValueSet |
|
| ObservationDefinition.qualifiedValue.interpretation |
|
| ObservationDefinition.hasMember |
|
| ObservationDefinition.component |
|
| ObservationDefinition.component.code |
|
| ObservationDefinition.component.permittedDataType |
|
| ObservationDefinition.component.permittedUnit |
|
| ObservationDefinition.component.qualifiedValue |
|
| ObservationDefinition.quantitativeDetails |
|
| ObservationDefinition.qualifiedInterval |
|
| ObservationDefinition.validCodedValueSet |
|
| ObservationDefinition.normalCodedValueSet |
|
| ObservationDefinition.abnormalCodedValueSet |
|
| ObservationDefinition.criticalCodedValueSet |
|
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
Filter:
|
|---|---|---|---|---|
|
ObservationDefinition
|
|
DomainResource |
Definition
of
an
observation
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation + Rule: If permittedUnit exists, then permittedDataType=Quantity must exist. Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension Interfaces Implemented: MetadataResource |
|
|
url
|
Σ | 0..1 | uri |
Logical
canonical
URL
to
reference
this
ObservationDefinition
(globally
unique)
|
|
identifier
|
Σ | 0..1 | Identifier |
Business
identifier
of
the
ObservationDefinition
|
|
version
|
Σ | 0..1 | string |
Business
version
of
the
ObservationDefinition
|
|
versionAlgorithm[x]
|
Σ | 0..1 |
How
to
compare
versions
Binding: Version Algorithm ( Extensible ) |
|
|
versionAlgorithmString
|
string | |||
|
versionAlgorithmCoding
|
Coding | |||
|
name
|
Σ C | 0..1 | string |
Name
for
this
ObservationDefinition
(computer
friendly)
|
|
title
|
Σ T | 0..1 | string |
Name
for
this
ObservationDefinition
(human
friendly)
|
|
status
|
?! Σ | 1..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( Required ) |
|
experimental
|
Σ | 0..1 | boolean |
If
|
|
date
|
Σ | 0..1 | dateTime |
Date
last
changed
|
|
publisher
|
Σ T | 0..1 | string |
The
name
of
the
individual
or
organization
that
published
the
ObservationDefinition
|
|
contact
|
Σ | 0..* | ContactDetail |
Contact
details
for
the
publisher
|
|
description
|
T | 0..1 | markdown |
Natural
language
description
of
the
ObservationDefinition
|
|
useContext
|
Σ | 0..* | UsageContext |
Content
intends
to
support
these
contexts
|
|
jurisdiction
|
Σ
|
0..* | CodeableConcept |
Jurisdiction
of
the
authority
that
maintains
the
this
ObservationDefinition
(if
applicable)
Binding: Jurisdiction ValueSet
(
Extensible
)
|
|
purpose
|
T | 0..1 | markdown |
Why
this
ObservationDefinition
is
defined
|
|
copyright
|
T | 0..1 | markdown |
Notice
about
intellectual
property
ownership,
can
include
restrictions
on
use
|
|
copyrightLabel
|
T | 0..1 | string |
Copyright
holder
and
year(s)
|
|
approvalDate
|
0..1 | date |
When
ObservationDefinition
was
approved
by
publisher
|
|
|
lastReviewDate
|
0..1 | date |
Date
on
which
the
asset
content
was
last
reviewed
by
the
publisher
|
|
|
effectivePeriod
|
Σ | 0..1 | Period |
The
effective
date
range
for
the
ObservationDefinition
|
|
derivedFromCanonical
|
Σ | 0..* | canonical ( ObservationDefinition ) |
Based
on
FHIR
definition
of
another
observation
|
|
derivedFromUri
|
Σ | 0..* | uri |
Based
on
external
definition
|
|
subject
|
Σ | 0..* | CodeableConcept |
Type
of
subject
for
the
defined
observation
|
|
performerType
|
Σ | 0..1 | CodeableConcept |
Desired
kind
of
performer
for
such
kind
of
observation
|
|
category
|
Σ | 0..* | CodeableConcept |
General
type
of
observation
Binding: Observation Category Codes ( Example ) |
|
code
|
Σ | 1..1 | CodeableConcept |
Type
of
observation
Binding: LOINC |
|
permittedDataType
|
C | 0..* | code |
Quantity
|
CodeableConcept
|
string
|
boolean
|
integer
|
Range
|
Ratio
|
SampledData
|
time
|
dateTime
|
Period
Binding: Observation Data Type ( Required ) |
|
multipleResultsAllowed
|
0..1 | boolean |
Multiple
results
allowed
for
conforming
observations
|
|
|
bodyStructure
|
0..1 |
|
Body
Binding: SNOMED CT Body Structures ( Example ) |
|
|
method
|
0..1 | CodeableConcept |
Method
used
to
produce
the
observation
Binding: Observation Methods ( Example ) |
|
|
specimen
|
0..* | Reference ( SpecimenDefinition ) |
Kind
of
specimen
used
by
this
type
of
observation
|
|
|
device[x]
|
0..1 |
|
Measurement
device
or
model
of
device
|
|
|
deviceReference
|
Reference
(
|
|
||
|
deviceCanonical
| canonical ( DeviceDefinition ) | |||
|
preferredReportName
|
0..1 | string |
The
preferred
name
to
be
used
when
reporting
the
observation
results
|
|
|
permittedUnit
|
C | 0..* | Coding |
Unit
for
quantitative
results
Binding: UCUM Codes ( Preferred ) |
|
qualifiedValue
|
0..* | BackboneElement |
Set
of
qualified
values
for
observation
results
|
|
|
context
|
0..1 | CodeableConcept |
Context
qualifier
for
the
set
of
qualified
values
Binding: Observation Reference Range Meaning Codes ( Extensible ) |
|
|
appliesTo
|
0..* | CodeableConcept |
Targetted
population
for
the
set
of
qualified
values
Binding: Observation Reference Range Applies To Codes ( Example ) |
|
|
|
0..1 | code |
male
|
female
|
other
|
unknown
Binding: AdministrativeGender ( Required ) |
|
|
age
|
0..1 | Range |
Applicable
age
range
for
the
set
of
qualified
values
|
|
|
gestationalAge
|
0..1 | Range |
Applicable
gestational
age
range
for
the
set
of
qualified
values
|
|
|
condition
|
0..1 | string |
Validity
criterion
for
the
|
|
|
rangeCategory
|
0..1 | code |
reference
|
critical
|
absolute
Binding: Observation Range Category ( Required ) |
|
|
range
|
0..1 | Range |
The
range
for
continuous
or
ordinal
observations
|
|
|
validCodedValueSet
|
0..1 | canonical ( ValueSet ) |
Value
set
of
valid
coded
values
as
part
of
this
set
of
qualified
values
|
|
|
normalCodedValueSet
|
0..1 | canonical ( ValueSet ) |
Value
set
of
normal
coded
values
as
part
of
this
set
of
qualified
values
|
|
|
abnormalCodedValueSet
|
0..1 | canonical ( ValueSet ) |
Value
set
of
abnormal
coded
values
as
part
of
this
set
of
qualified
values
|
|
|
criticalCodedValueSet
|
0..1 | canonical ( ValueSet ) |
Value
set
of
critical
coded
values
as
part
of
this
set
of
qualified
values
|
|
|
interpretation
| 0..* | CodeableConcept |
Expected
coded
interpretation
values
Binding: Observation Interpretation Codes ( Extensible ) | |
|
hasMember
|
0..* | Reference ( ObservationDefinition | Questionnaire ) |
Definitions
of
related
resources
belonging
to
this
kind
of
observation
group
|
|
|
component
|
C | 0..* | BackboneElement |
Component
results
+ Rule: If permittedUnit exists, then permittedDataType=Quantity must exist. |
|
code
|
1..1 | CodeableConcept |
Type
of
observation
Binding: LOINC |
|
|
permittedDataType
|
C | 0..* | code |
Quantity
|
CodeableConcept
|
string
|
boolean
|
integer
|
Range
|
Ratio
|
SampledData
|
time
|
dateTime
|
Period
Binding: Observation Data Type ( Required ) |
|
permittedUnit
|
C | 0..* | Coding |
Unit
for
quantitative
results
Binding: UCUM Codes ( Preferred ) |
|
qualifiedValue
|
0..* | see qualifiedValue |
Set
of
qualified
values
for
observation
results
|
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
XML Template
<ObservationDefinition xmlns="http://hl7.org/fhir"><<experimental value="[boolean]"/><!-- 0..1 If For testing only - never for real usage --> <date value="[dateTime]"/><!-- 0..1 Date last changed --> <publisher value="[string]"/><!-- 0..1 The name of the individual or organization that published the ObservationDefinition --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- 0..1 Natural language description of the ObservationDefinition --> <useContext><!-- 0..* UsageContext Content intends to support these contexts --></useContext><</jurisdiction><jurisdiction><!-- 0..* CodeableConcept Jurisdiction of the authority that maintains the this ObservationDefinition (if applicable)< <<copyright value="[markdown]"/><!-- 0..1 Notice about intellectual property ownership, can include restrictions on use --> <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) --> <approvalDate value="[date]"/><!-- 0..1 When ObservationDefinition was approved by publisher --> <lastReviewDate value="[date]"/><!-- 0..1 Date on which the asset content was last reviewed by the publisher --> <effectivePeriod><!-- 0..1 Period The effective date range for the ObservationDefinition --></effectivePeriod> <derivedFromCanonical><!-- 0..* canonical(ObservationDefinition) Based on FHIR definition of another observation --></derivedFromCanonical> <derivedFromUri value="[uri]"/><!-- 0..* Based on external definition --> <subject><!-- 0..* CodeableConcept Type of subject for the defined observation --></subject> <performerType><!-- 0..1 CodeableConcept Desired kind of performer for such kind of observation --></performerType> <category><!-- 0..* CodeableConcept General type of observation --></category><</code><code><!-- 1..1 CodeableConcept Type of observation --></code> <permittedDataType value="[code]"/><!-- I 0..* Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period --> <multipleResultsAllowed value="[boolean]"/><!-- 0..1 Multiple results allowed for conforming observations --><</bodySite><bodyStructure><!-- 0..1 CodeableReference(BodyStructure) Body structure to be observed --></bodyStructure> <method><!-- 0..1 CodeableConcept Method used to produce the observation --></method> <specimen><!-- 0..* Reference(SpecimenDefinition) Kind of specimen used by this type of observation --></specimen><</device><device[x]><!-- 0..1 Reference(Device)|canonical(DeviceDefinition) Measurement device or model of device --></device[x]> <preferredReportName value="[string]"/><!-- 0..1 The preferred name to be used when reporting the observation results --> <permittedUnit><!-- I 0..* Coding Unit for quantitative results --></permittedUnit> <qualifiedValue> <!-- 0..* Set of qualified values for observation results --> <context><!-- 0..1 CodeableConcept Context qualifier for the set of qualified values --></context> <appliesTo><!-- 0..* CodeableConcept Targetted population for the set of qualified values --></appliesTo><<sexParameterForClinicalUse value="[code]"/><!-- 0..1 male | female | other | unknown --> <age><!-- 0..1 Range Applicable age range for the set of qualified values --></age> <gestationalAge><!-- 0..1 Range Applicable gestational age range for the set of qualified values --></gestationalAge><<condition value="[string]"/><!-- 0..1 Validity criterion for the qualified value --> <rangeCategory value="[code]"/><!-- 0..1 reference | critical | absolute --> <range><!-- 0..1 Range The range for continuous or ordinal observations --></range> <validCodedValueSet><!-- 0..1 canonical(ValueSet) Value set of valid coded values as part of this set of qualified values --></validCodedValueSet> <normalCodedValueSet><!-- 0..1 canonical(ValueSet) Value set of normal coded values as part of this set of qualified values --></normalCodedValueSet> <abnormalCodedValueSet><!-- 0..1 canonical(ValueSet) Value set of abnormal coded values as part of this set of qualified values --></abnormalCodedValueSet> <criticalCodedValueSet><!-- 0..1 canonical(ValueSet) Value set of critical coded values as part of this set of qualified values --></criticalCodedValueSet> <interpretation><!-- 0..* CodeableConcept Expected coded interpretation values --></interpretation> </qualifiedValue> <hasMember><!-- 0..* Reference(ObservationDefinition|Questionnaire) Definitions of related resources belonging to this kind of observation group --></hasMember> <component> <!-- 0..* Component results --><</code><code><!-- 1..1 CodeableConcept Type of observation --></code> <permittedDataType value="[code]"/><!-- I 0..* Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period --> <permittedUnit><!-- I 0..* Coding Unit for quantitative results --></permittedUnit> <qualifiedValue><!-- 0..* Content as for ObservationDefinition.qualifiedValue Set of qualified values for observation results --></qualifiedValue> </component> </ObservationDefinition>
JSON Template
{
"resourceType" : "ObservationDefinition",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // Logical canonical URL to reference this ObservationDefinition (globally unique)
"identifier" : { Identifier }, // Business identifier of the ObservationDefinition
"version" : "<string>", // Business version of the ObservationDefinition
// versionAlgorithm[x]: How to compare versions. One of these 2:
"versionAlgorithmString" : "<string>",
"versionAlgorithmCoding" : { Coding },
"name" : "<string>", // I Name for this ObservationDefinition (computer friendly)
"title" : "<string>", // Name for this ObservationDefinition (human friendly)
"status" : "<code>", // R! draft | active | retired | unknown
"
"experimental" : <boolean>, // If For testing only - never for real usage
"date" : "<dateTime>", // Date last changed
"publisher" : "<string>", // The name of the individual or organization that published the ObservationDefinition
"contact" : [{ ContactDetail }], // Contact details for the publisher
"description" : "<markdown>", // Natural language description of the ObservationDefinition
"useContext" : [{ UsageContext }], // Content intends to support these contexts
"
"jurisdiction" : [{ CodeableConcept }], // Jurisdiction of the authority that maintains the this ObservationDefinition (if applicable)
"purpose" : "<markdown>", // Why this ObservationDefinition is defined
"
"
"copyright" : "<markdown>", // Notice about intellectual property ownership, can include restrictions on use
"copyrightLabel" : "<string>", // Copyright holder and year(s)
"approvalDate" : "<date>", // When ObservationDefinition was approved by publisher
"lastReviewDate" : "<date>", // Date on which the asset content was last reviewed by the publisher
"effectivePeriod" : { Period }, // The effective date range for the ObservationDefinition
"derivedFromCanonical" : ["<canonical(ObservationDefinition)>"], // Based on FHIR definition of another observation
"derivedFromUri" : ["<uri>"], // Based on external definition
"subject" : [{ CodeableConcept }], // Type of subject for the defined observation
"performerType" : { CodeableConcept }, // Desired kind of performer for such kind of observation
"category" : [{ CodeableConcept }], // General type of observation
"
"code" : { CodeableConcept }, // R! Type of observation
"permittedDataType" : ["<code>"], // I Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
"multipleResultsAllowed" : <boolean>, // Multiple results allowed for conforming observations
"
"bodyStructure" : { CodeableReference(BodyStructure) }, // Body structure to be observed
"method" : { CodeableConcept }, // Method used to produce the observation
"specimen" : [{ Reference(SpecimenDefinition) }], // Kind of specimen used by this type of observation
"
// device[x]: Measurement device or model of device. One of these 2:
"deviceReference" : { Reference(Device) },
"deviceCanonical" : "<canonical(DeviceDefinition)>",
"preferredReportName" : "<string>", // The preferred name to be used when reporting the observation results
"permittedUnit" : [{ Coding }], // I Unit for quantitative results
"qualifiedValue" : [{ // Set of qualified values for observation results
"context" : { CodeableConcept }, // Context qualifier for the set of qualified values
"appliesTo" : [{ CodeableConcept }], // Targetted population for the set of qualified values
"
"sexParameterForClinicalUse" : "<code>", // male | female | other | unknown
"age" : { Range }, // Applicable age range for the set of qualified values
"gestationalAge" : { Range }, // Applicable gestational age range for the set of qualified values
"
"condition" : "<string>", // Validity criterion for the qualified value
"rangeCategory" : "<code>", // reference | critical | absolute
"range" : { Range }, // The range for continuous or ordinal observations
"validCodedValueSet" : "<canonical(ValueSet)>", // Value set of valid coded values as part of this set of qualified values
"normalCodedValueSet" : "<canonical(ValueSet)>", // Value set of normal coded values as part of this set of qualified values
"abnormalCodedValueSet" : "<canonical(ValueSet)>", // Value set of abnormal coded values as part of this set of qualified values
"
"criticalCodedValueSet" : "<canonical(ValueSet)>", // Value set of critical coded values as part of this set of qualified values
"interpretation" : [{ CodeableConcept }] // Expected coded interpretation values
}],
"hasMember" : [{ Reference(ObservationDefinition|Questionnaire) }], // Definitions of related resources belonging to this kind of observation group
"component" : [{ // Component results
"
"code" : { CodeableConcept }, // R! Type of observation
"permittedDataType" : ["<code>"], // I Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
"permittedUnit" : [{ Coding }], // I Unit for quantitative results
"qualifiedValue" : [{ Content as for ObservationDefinition.qualifiedValue }] // Set of qualified values for observation results
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .# from # from# from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension fhir:url [ uri ] ; # 0..1 Logical canonical URL to reference this ObservationDefinition (globally unique) fhir:identifier [ Identifier ] ; # 0..1 Business identifier of the ObservationDefinition fhir:version [ string ] ; # 0..1 Business version of the ObservationDefinition # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2fhir: ]fhir:versionAlgorithm [ a fhir:String ; string ] fhir:versionAlgorithm [ a fhir:Coding ; Coding ] fhir:name [ string ] ; # 0..1 I Name for this ObservationDefinition (computer friendly) fhir:title [ string ] ; # 0..1 Name for this ObservationDefinition (human friendly) fhir:status [ code ] ; # 1..1 draft | active | retired | unknownfhir:fhir:experimental [ boolean ] ; # 0..1 If For testing only - never for real usage fhir:date [ dateTime ] ; # 0..1 Date last changed fhir:publisher [ string ] ; # 0..1 The name of the individual or organization that published the ObservationDefinition fhir:contact ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher fhir:description [ markdown ] ; # 0..1 Natural language description of the ObservationDefinition fhir:useContext ( [ UsageContext ] ... ) ; # 0..* Content intends to support these contextsfhir:fhir:jurisdiction ( [ CodeableConcept ] ... ) ; # 0..* Jurisdiction of the authority that maintains the this ObservationDefinition (if applicable) fhir:purpose [ markdown ] ; # 0..1 Why this ObservationDefinition is definedfhir: fhir:fhir:copyright [ markdown ] ; # 0..1 Notice about intellectual property ownership, can include restrictions on use fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s) fhir:approvalDate [ date ] ; # 0..1 When ObservationDefinition was approved by publisher fhir:lastReviewDate [ date ] ; # 0..1 Date on which the asset content was last reviewed by the publisher fhir:effectivePeriod [ Period ] ; # 0..1 The effective date range for the ObservationDefinition fhir:derivedFromCanonical ( [ canonical(ObservationDefinition) ] ... ) ; # 0..* Based on FHIR definition of another observation fhir:derivedFromUri ( [ uri ] ... ) ; # 0..* Based on external definition fhir:subject ( [ CodeableConcept ] ... ) ; # 0..* Type of subject for the defined observation fhir:performerType [ CodeableConcept ] ; # 0..1 Desired kind of performer for such kind of observation fhir:category ( [ CodeableConcept ] ... ) ; # 0..* General type of observation fhir:code [ CodeableConcept ] ; # 1..1 Type of observation fhir:permittedDataType ( [ code ] ... ) ; # 0..* I Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period fhir:multipleResultsAllowed [ boolean ] ; # 0..1 Multiple results allowed for conforming observationsfhir:fhir:bodyStructure [ CodeableReference(BodyStructure) ] ; # 0..1 Body structure to be observed fhir:method [ CodeableConcept ] ; # 0..1 Method used to produce the observation fhir:specimen ( [ Reference(SpecimenDefinition) ] ... ) ; # 0..* Kind of specimen used by this type of observationfhir:# device[x] : 0..1 Measurement device or model of device. One of these 2 fhir:device [ a fhir:Reference ; Reference(Device) ] fhir:device [ a fhir:Canonical ; canonical(DeviceDefinition) ] fhir:preferredReportName [ string ] ; # 0..1 The preferred name to be used when reporting the observation results fhir:permittedUnit ( [ Coding ] ... ) ; # 0..* I Unit for quantitative results fhir:qualifiedValue ( [ # 0..* Set of qualified values for observation results fhir:context [ CodeableConcept ] ; # 0..1 Context qualifier for the set of qualified values fhir:appliesTo ( [ CodeableConcept ] ... ) ; # 0..* Targetted population for the set of qualified valuesfhir:fhir:sexParameterForClinicalUse [ code ] ; # 0..1 male | female | other | unknown fhir:age [ Range ] ; # 0..1 Applicable age range for the set of qualified values fhir:gestationalAge [ Range ] ; # 0..1 Applicable gestational age range for the set of qualified valuesfhir:fhir:condition [ string ] ; # 0..1 Validity criterion for the qualified value fhir:rangeCategory [ code ] ; # 0..1 reference | critical | absolute fhir:range [ Range ] ; # 0..1 The range for continuous or ordinal observations fhir:validCodedValueSet [ canonical(ValueSet) ] ; # 0..1 Value set of valid coded values as part of this set of qualified values fhir:normalCodedValueSet [ canonical(ValueSet) ] ; # 0..1 Value set of normal coded values as part of this set of qualified values fhir:abnormalCodedValueSet [ canonical(ValueSet) ] ; # 0..1 Value set of abnormal coded values as part of this set of qualified values fhir:criticalCodedValueSet [ canonical(ValueSet) ] ; # 0..1 Value set of critical coded values as part of this set of qualified values fhir:interpretation ( [ CodeableConcept ] ... ) ; # 0..* Expected coded interpretation values ] ... ) ; fhir:hasMember ( [ Reference(ObservationDefinition|Questionnaire) ] ... ) ; # 0..* Definitions of related resources belonging to this kind of observation group fhir:component ( [ # 0..* Component results fhir:code [ CodeableConcept ] ; # 1..1 Type of observation fhir:permittedDataType ( [ code ] ... ) ; # 0..* I Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period fhir:permittedUnit ( [ Coding ] ... ) ; # 0..* I Unit for quantitative results fhir:qualifiedValue ( [ See ObservationDefinition.qualifiedValue ] ... ) ; # 0..* Set of qualified values for observation results ] ... ) ; ]
Changes from both R4 and R4B
| ObservationDefinition | |
| ObservationDefinition.url |
|
| ObservationDefinition.identifier |
|
| ObservationDefinition.version |
|
| ObservationDefinition.versionAlgorithm[x] |
|
| ObservationDefinition.name |
|
| ObservationDefinition.title |
|
| ObservationDefinition.status |
|
| ObservationDefinition.experimental |
|
| ObservationDefinition.date |
|
| ObservationDefinition.publisher |
|
| ObservationDefinition.contact |
|
| ObservationDefinition.description |
|
| ObservationDefinition.useContext |
|
| ObservationDefinition.jurisdiction |
|
| ObservationDefinition.purpose |
|
| ObservationDefinition.copyright |
|
| ObservationDefinition.copyrightLabel |
|
| ObservationDefinition.approvalDate |
|
| ObservationDefinition.lastReviewDate |
|
| ObservationDefinition.effectivePeriod |
|
| ObservationDefinition.derivedFromCanonical |
|
| ObservationDefinition.derivedFromUri |
|
| ObservationDefinition.subject |
|
| ObservationDefinition.performerType |
|
|
|
|
| ObservationDefinition.specimen |
|
|
|
|
| ObservationDefinition.permittedUnit |
|
| ObservationDefinition.qualifiedValue |
|
| ObservationDefinition.qualifiedValue.context |
|
| ObservationDefinition.qualifiedValue.appliesTo |
|
|
|
|
| ObservationDefinition.qualifiedValue.age |
|
| ObservationDefinition.qualifiedValue.gestationalAge |
|
| ObservationDefinition.qualifiedValue.condition |
|
| ObservationDefinition.qualifiedValue.rangeCategory |
|
| ObservationDefinition.qualifiedValue.range |
|
| ObservationDefinition.qualifiedValue.validCodedValueSet |
|
| ObservationDefinition.qualifiedValue.normalCodedValueSet |
|
| ObservationDefinition.qualifiedValue.abnormalCodedValueSet |
|
| ObservationDefinition.qualifiedValue.criticalCodedValueSet |
|
| ObservationDefinition.qualifiedValue.interpretation |
|
| ObservationDefinition.hasMember |
|
| ObservationDefinition.component |
|
| ObservationDefinition.component.code |
|
| ObservationDefinition.component.permittedDataType |
|
| ObservationDefinition.component.permittedUnit |
|
| ObservationDefinition.component.qualifiedValue |
|
| ObservationDefinition.quantitativeDetails |
|
| ObservationDefinition.qualifiedInterval |
|
| ObservationDefinition.validCodedValueSet |
|
| ObservationDefinition.normalCodedValueSet |
|
| ObservationDefinition.abnormalCodedValueSet |
|
| ObservationDefinition.criticalCodedValueSet |
|
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .
Additional definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) , the spreadsheet version & the dependency analysis
| Path | ValueSet | Type | Documentation |
|---|---|---|---|
| ObservationDefinition.versionAlgorithm[x] | VersionAlgorithm | Extensible |
Indicates the mechanism used to compare versions to determine which is more current. |
| ObservationDefinition.status | PublicationStatus | Required |
The lifecycle status of an artifact. |
| ObservationDefinition.jurisdiction |
JurisdictionValueSet
|
Extensible |
This value set defines a base set of codes for country, country subdivision and region for indicating where a resource is intended to be used.
Note:
The
codes
for
countries
and
country
subdivisions
are
taken
from
ISO
3166
|
| ObservationDefinition.category | ObservationCategoryCodes | Example |
Observation Category codes. |
| ObservationDefinition.code |
|
Example |
|
| ObservationDefinition.permittedDataType | ObservationDataType | Required |
Permitted data type for observation value. |
|
|
SNOMEDCTBodyStructures | Example |
This
value
set
includes
all
codes
from
SNOMED
CT
|
| ObservationDefinition.method | ObservationMethods | Example |
Observation
Method
codes
from
SNOMED
CT
|
| ObservationDefinition.permittedUnit |
UCUMCodes
(a
valid
code
from
UCUM
)
|
Preferred |
Unified Code for Units of Measure (UCUM). This value set includes all UCUM codes |
| ObservationDefinition.qualifiedValue.context | ObservationReferenceRangeMeaningCodes | Extensible |
This value set defines a set of codes that can be used to indicate the meaning/use of a reference range for a particular target population. |
| ObservationDefinition.qualifiedValue.appliesTo | ObservationReferenceRangeAppliesToCodes | Example |
This value set defines a set of codes that can be used to indicate the particular target population the reference range applies to. |
|
|
AdministrativeGender | Required |
The gender of a person used for administrative purposes. |
| ObservationDefinition.qualifiedValue.rangeCategory | ObservationRangeCategory | Required |
Codes identifying the category of observation range. |
| ObservationDefinition.qualifiedValue.interpretation |
)
|
|
A categorical assessment, providing a rough qualitative interpretation of the observation value, such as “normal”/ “abnormal”,”low” / “high”, “better” / “worse”, “susceptible” / “resistant”, “expected”/ “not expected”. The value set is intended to be for ANY use where coded representation of an interpretation is needed. Notes:
This
is
being
communicated
in
v2.x
in
OBX-8
(Observation
Interpretation),
in
v3
in
ObservationInterpretation
(CWE)
in
R1
(Representative
Realm)
and
in
FHIR
in
Observation.interpretation.
Historically
these
values
come
from
the
laboratory
domain,
and
these
codes
are
extensively
used.
The
value
set
|
| ObservationDefinition.component.code | LOINCObsOrBoth | Example | LOINC concepts whose ORDER_OBS property is 'Observation' (Obs only) or 'Both'. |
| ObservationDefinition.component.permittedDataType | ObservationDataType | Required |
Permitted data type for observation value. |
| ObservationDefinition.component.permittedUnit |
UCUMCodes
(a
valid
code
from
UCUM
)
|
Preferred |
Unified Code for Units of Measure (UCUM). This value set includes all UCUM codes |
| UniqueKey | Level | Location | Description | Expression |
cnl-0
|
Warning | (base) | Name should be usable as an identifier for the module by machine processing applications such as code generation | name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') |
|
obd-0
|
Rule | (base) | If permittedUnit exists, then permittedDataType=Quantity must exist. |
permittedUnit.exists()
implies
|
|
obd-1
|
Rule | ObservationDefinition.component | If permittedUnit exists, then permittedDataType=Quantity must exist. |
permittedUnit.exists()
implies
|
Search parameters for this resource. See also the full list of search parameters for this resource , and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
| Name | Type | Description | Expression | In Common |
| body-structure-code | token | Code for body structure to be observed | ObservationDefinition.bodyStructure.concept | |
| category | token | Category (class) of observation | ObservationDefinition.category | |
| code | token | Observation code | ObservationDefinition.code | |
| experimental | token | Not for genuine usage (true) | ObservationDefinition.experimental | |
| identifier | token | The unique identifier associated with the specimen definition | ObservationDefinition.identifier |
|
| method | token | Method of observation | ObservationDefinition.method | |
| reference | reference | Body structure to be observed (reference) |
ObservationDefinition.bodyStructure.reference
( BodyStructure ) | |
| status | token | Publication status of the ObservationDefinition: draft, active, retired, unknown | ObservationDefinition.status |
|
| title | string | Human-friendly name of the ObservationDefinition | ObservationDefinition.title |
|
| url | uri | The uri that identifies the observation definition | ObservationDefinition.url |
|
FHIR
®©
HL7.org
2011+.
FHIR
R5
hl7.fhir.core#5.0.0
R6
hl7.fhir.core#6.0.0-ballot3
generated
on
Sun,
Mar
26,
2023
15:25+1100.
Mon,
Nov
17,
2025
19:29+0000.
Links:
Search
|
Version
History
|
Contents
|
Glossary
|
QA
|
Compare
to
R4
|
Compare
to
R4B
R5
|
Compare
to
Last
Ballot
|
|
Propose
a
change