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).
(v5.0.0-snapshot1:
R5
Snapshot
#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
:
|
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. |
||||||||
| Invariants |
| ||||||||
|
|
|||||||||
| Element Id |
| ||||||||
| Definition | An absolute URL that is used to identify this ObservationDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this ObservationDefinition is (or will be) published. The URL SHOULD include the major version of the ObservationDefinition. For more information see Technical and Business Versions. | ||||||||
| 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.name | |||||||||
| Element Id | ObservationDefinition.name | ||||||||
| Definition |
A natural language name identifying the ObservationDefinition. This name should be usable as an identifier for the module by machine processing applications such as code generation. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Requirements | Support human navigation and code generation. | ||||||||
| Summary | true | ||||||||
| Comments |
The
name
is
not
expected
to
be
globally
unique.
The
name
should
be
a
simple
alphanumeric
type
name
to
ensure
that
| ||||||||
| Invariants |
| ||||||||
| ObservationDefinition.title | |||||||||
| Element Id | ObservationDefinition.title | ||||||||
| Definition | A short, descriptive, user-friendly title for the ObservationDefinition. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Summary | true | ||||||||
| ObservationDefinition.status | |||||||||
| Element Id | ObservationDefinition.status | ||||||||
| Definition |
The
current
state
of
|
||||||||
| Cardinality |
|
||||||||
| 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.date | |||||||||
| Element Id | ObservationDefinition.date | ||||||||
| Definition |
The
date
(and
optionally
time)
when
the
ObservationDefinition
was
published.
The
date
must
change
when
the
business
version
changes
and
|
||||||||
| Cardinality | 0..1 | ||||||||
| Type | dateTime | ||||||||
| Alternate Names |
|
||||||||
| Summary | true | ||||||||
| Comments |
| ||||||||
| ObservationDefinition.publisher | |||||||||
| Element Id | ObservationDefinition.publisher | ||||||||
| Definition |
Helps
establish
the
"authority/credibility"
of
the
ObservationDefinition.
May
also
allow
for
| ||||||||
| Cardinality | 0..1 | ||||||||
| Type | Reference ( Practitioner | PractitionerRole | Organization ) | ||||||||
| Patterns | Reference(Practitioner,PractitionerRole,Organization): Common patterns = Participant | ||||||||
| Requirements |
Usually
an
organization,
but
may
be
an
individual.
The
publisher
(or
steward)
of
the
ObservationDefinition
is
the
organization
or
individual
primarily
responsible
for
the
maintenance
and
upkeep
of
the
ObservationDefinition.
This
is
not
necessarily
the
same
individual
or
organization
that
developed
and
initially
authored
the
content.
The
| ||||||||
| 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. | ||||||||
| ObservationDefinition.description | |||||||||
| Element Id | ObservationDefinition.description | ||||||||
| Definition | A free text natural language description of the ObservationDefinition from the consumer's perspective. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | markdown | ||||||||
| Summary | false | ||||||||
| Comments |
This
description
can
be
used
to
capture
details
such
as
why
the
ObservationDefinition
was
built,
comments
about
misuse,
instructions
for
clinical
use
and
interpretation,
literature
references,
examples
from
the
paper
world,
etc.
It
is
not
a
rendering
of
the
module
as
conveyed
in
the
|
||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
| ||||||||
| Cardinality | 0..* | ||||||||
| Type | UsageContext | ||||||||
| Requirements | Assist in searching for appropriate content. | ||||||||
| Summary | true | ||||||||
| Comments |
When
multiple
usageContexts
are
specified,
there
is
| ||||||||
| ObservationDefinition.jurisdiction | |||||||||
| Element Id | ObservationDefinition.jurisdiction | ||||||||
| Definition | A jurisdiction in which the ObservationDefinition is intended to be used. |
||||||||
| Cardinality |
|
||||||||
| Terminology Binding |
|
||||||||
| Type | CodeableConcept | ||||||||
|
| true | ||||||||
| Comments |
| ||||||||
| ObservationDefinition.purpose | |||||||||
| Element Id | ObservationDefinition.purpose | ||||||||
| Definition | Explains why this ObservationDefinition is needed and why it has been designed as it has. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | markdown | ||||||||
| Summary | false | ||||||||
| 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 |
| ||||||||
| Summary | false | ||||||||
| 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 | ||||||||
| Summary | false | ||||||||
| 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 | ||||||||
| Summary | false | ||||||||
| 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 2021 might be published in 2020. | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| 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. |
||||||||
|
|
| ||||||||
| Type | uri | ||||||||
| Requirements | Observation definitions may be refinements of other definitions. | ||||||||
| Summary | true | ||||||||
| ObservationDefinition.subject | |||||||||
| Element Id | ObservationDefinition.subject | ||||||||
| Definition | A code that describes the intended kind of subject of Observation instances conforming to this ObservationDefinition. | ||||||||
| Cardinality | 0..* | ||||||||
| Type | CodeableConcept | ||||||||
| Summary | true | ||||||||
| Comments | Examples: person, animal, device, air, surface …. | ||||||||
| ObservationDefinition.performerType | |||||||||
| Element Id | ObservationDefinition.performerType | ||||||||
| Definition |
The
type
of
individual/organization/device
that
is
| ||||||||
|
Cardinality
|
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 |
| ||||||||
| 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 | ||||||||
| 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.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 | ||||||||
| Summary | false | ||||||||
| 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. |
||||||||
| Summary | false | ||||||||
| 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..* | ||||||||
| Type | Reference ( SpecimenDefinition ) | ||||||||
| Summary | false | ||||||||
| Comments | Only used for in vitro observations. When multiple occurrences of specimen are present, they are to be combined with a logical AND: all specified specimens are needed for the observation. | ||||||||
| ObservationDefinition.device | |||||||||
| Element Id | ObservationDefinition.device | ||||||||
| Definition | The measurement model of device or actual device used to produce observations of this type. | ||||||||
| Cardinality | 0..* | ||||||||
| Type | Reference ( DeviceDefinition | Device ) | ||||||||
| Patterns | Reference(DeviceDefinition,Device): No common pattern | ||||||||
| Summary | false | ||||||||
| Comments | When multiple occurrences of device are present, they are to be combined with a logical OR: at least one of the specified devices is used to produce the observation. |
||||||||
| 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
observations
conforming
to
this
|
||||||||
| Cardinality | 0..1 | ||||||||
| Summary | false | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
|
||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding | UCUM Codes ( Extensible ) | ||||||||
| Type | CodeableConcept | ||||||||
| Summary | false | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
|
||||||||
| 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
|
||||||||
| 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 | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
|
||||||||
| Cardinality | 0..* | ||||||||
| Summary | false | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
|
||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding |
|
||||||||
| Type |
|
||||||||
| Summary | false | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
The
|
||||||||
| Cardinality |
| ||||||||
| Terminology Binding | Observation Reference Range Applies To Codes ( Example ) | ||||||||
| Type |
|
||||||||
|
| false | ||||||||
| Comments |
|
||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
|
||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding |
|
||||||||
| Type |
|
||||||||
| Summary | false | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
|
||||||||
| Cardinality |
|
||||||||
|
|
|
||||||||
|
Summary
|
false | ||||||||
| Comments | Some analytes vary greatly over age. | ||||||||
| ObservationDefinition.qualifiedValue.gestationalAge | |||||||||
| Element Id | ObservationDefinition.qualifiedValue.gestationalAge | ||||||||
| Definition | The gestational age this set of qualified values applies to. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type |
|
||||||||
|
| false | ||||||||
| ObservationDefinition.qualifiedValue.condition | |||||||||
| Element Id | ObservationDefinition.qualifiedValue.condition | ||||||||
| Definition |
|
||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Summary | false | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
|
||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding |
|
||||||||
| Type | code | ||||||||
| Summary | false | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
The
|
||||||||
| Cardinality | 0..1 | ||||||||
| Type | Range | ||||||||
|
|
|
||||||||
| Summary | false | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
The
|
||||||||
| Cardinality | 0..1 | ||||||||
| Type |
| ||||||||
| Summary | false | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
|
||||||||
| Cardinality | 0..1 | ||||||||
| Type |
| ||||||||
| Summary | false | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
The
set
of
|
||||||||
| Cardinality | 0..1 | ||||||||
| Type |
|
||||||||
| Summary | false | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
The
set
of
|
||||||||
| Cardinality | 0..1 | ||||||||
| Type |
|
||||||||
| Summary | false | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
|
||||||||
| Cardinality |
|
||||||||
| Type |
Reference
(
|
||||||||
| Patterns | Reference(ObservationDefinition,Questionnaire): No common pattern | ||||||||
| Summary | false | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
| ||||||||
| Cardinality | 0..* | ||||||||
| Requirements |
Component
observations
share
the
same
attributes
as
the
primary
observation
and
are
always
treated
as
a
part
of
| ||||||||
| Summary | false | ||||||||
| ObservationDefinition.component.code | |||||||||
| Element Id | ObservationDefinition.component.code | ||||||||
| Definition | Describes what will be observed. | ||||||||
| Cardinality | 1..1 | ||||||||
| Terminology Binding | LOINC Codes ( Example ) | ||||||||
| Type | CodeableConcept | ||||||||
| Summary | false | ||||||||
| ObservationDefinition.component.permittedDataType | |||||||||
| Element Id | ObservationDefinition.component.permittedDataType | ||||||||
| Definition |
The
data
types
allowed
for
the
| ||||||||
| Cardinality | 0..* | ||||||||
| Terminology Binding | ObservationDataType ( Required ) | ||||||||
| Type | code | ||||||||
| Summary | false | ||||||||
| ObservationDefinition.component.quantitativeDetails | |||||||||
| Element Id | ObservationDefinition.component.quantitativeDetails | ||||||||
| Definition | Characteristics for quantitative results of this observation. |
||||||||
| Cardinality | 0..1 | ||||||||
| Type |
|
||||||||
|
Summary
|
false | ||||||||
| ObservationDefinition.component.qualifiedValue | |||||||||
| Element Id | ObservationDefinition.component.qualifiedValue | ||||||||
| Definition | A set of qualified values associated with a context and a set of conditions - provides a range for quantitative and ordinal observations and a collection of value sets for qualitative observations. | ||||||||
| Cardinality | 0..* | ||||||||
| Type | See ObservationDefinition.qualifiedValue | ||||||||
| Summary | false | ||||||||