This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
(v3.0.2:
STU
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
3).
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
R3
R2
R3
|
|
|
|
|
This
structure
is
derived
from
Observation
.
Raw
Turtle
,
JSON-LD
Summary
Mandatory:
3
elements
Must-Support:
5
elements
Fixed
Value:
2
elements
Prohibited:
6
elements
Differential
View
This
structure
is
derived
from
Observation
.
Name
Flags
Card.
Type
Description
&
Constraints
Observation
1..1
HDL
Cholesterol
Result
code
S
1..1
CodeableConcept
HDL
Cholesterol
Fixed
Value:
As
shown
coding
1..1
Coding
Code
defined
by
a
terminology
system
Fixed
Value:
(complex)
system
1..1
uri
Identity
of
the
terminology
system
Fixed
Value:
http://loinc.org
code
1..1
code
Symbol
in
syntax
defined
by
the
system
Fixed
Value:
2085-9
display
1..1
string
Representation
defined
by
the
system
Fixed
Value:
HDL
Cholesterol
valueQuantity
S
0..1
Quantity
HDL
Cholesterol
value
interpretation
S
0..1
CodeableConcept
+
|
++
|
+++
|
-
|
--
|
---
note
S
0..*
Annotation
Comments
about
result
referenceRange
S
1..1
BackboneElement
low
1..1
SimpleQuantity
Fixed
Value:
As
shown
value
1..1
decimal
Numerical
value
(with
implicit
precision)
Fixed
Value:
1.5
high
0
..
0
type
0
..
0
appliesTo
0
..
0
age
0
..
0
hasMember
0
..
0
derivedFrom
0
..
0
Documentation
for
this
format
Snapshot
View
Name
Flags
Card.
Type
Description
&
Constraints
Observation
I
1..1
HDL
Cholesterol
Result
id
Σ
0..1
string
Logical
id
of
this
artifact
meta
Σ
I
0..1
Meta
Metadata
about
the
resource
implicitRules
?!
Σ
I
0..1
uri
A
set
of
rules
under
which
this
content
was
created
language
I
0..1
code
Language
of
the
resource
content
Binding:
Common
Languages
(
preferred
)
Max
Binding:
All
Languages
text
I
0..1
Narrative
Text
summary
of
the
resource,
for
human
interpretation
contained
0..*
Resource
Contained,
inline
Resources
extension
I
0..*
Extension
Additional
content
defined
by
implementations
modifierExtension
?!
I
0..*
Extension
Extensions
that
cannot
be
ignored
identifier
Σ
I
0..*
Identifier
Business
Identifier
for
observation
basedOn
Σ
I
0..*
Reference
(
CarePlan
|
DeviceRequest
|
ImmunizationRecommendation
|
MedicationRequest
|
NutritionOrder
|
ServiceRequest
)
Fulfills
plan,
proposal
or
order
partOf
Σ
I
0..*
Reference
(
MedicationAdministration
|
MedicationDispense
|
MedicationStatement
|
Procedure
|
Immunization
|
ImagingStudy
)
Part
of
referenced
event
status
?!
Σ
I
1..1
code
registered
|
preliminary
|
final
|
amended
+
Binding:
ObservationStatus
(
required
)
category
I
0..*
CodeableConcept
Classification
of
type
of
observation
Binding:
Observation
Category
Codes
(
preferred
)
code
S
Σ
I
1..1
CodeableConcept
HDL
Cholesterol
Binding:
LOINC
Codes
(
example
)
Fixed
Value:
As
shown
id
0..0
string
Unique
id
for
inter-element
referencing
extension
0..0
Extension
Additional
content
defined
by
implementations
coding
1..1
Coding
Code
defined
by
a
terminology
system
Fixed
Value:
(complex)
id
0..0
string
Unique
id
for
inter-element
referencing
extension
0..0
Extension
Additional
content
defined
by
implementations
system
1..1
uri
Identity
of
the
terminology
system
Fixed
Value:
http://loinc.org
version
0..0
string
Version
of
the
system
-
if
relevant
code
1..1
code
Symbol
in
syntax
defined
by
the
system
Fixed
Value:
2085-9
display
1..1
string
Representation
defined
by
the
system
Fixed
Value:
HDL
Cholesterol
userSelected
0..0
boolean
If
this
coding
was
chosen
directly
by
the
user
text
0..0
string
Plain
text
representation
of
the
concept
subject
Σ
I
0..1
Reference
(
Patient
|
Group
|
Device
|
Location
)
Who
and/or
what
the
observation
is
about
focus
Σ
I
0..*
Reference
(
Resource
)
What
the
observation
is
about,
when
it
is
not
about
the
subject
of
record
encounter
Σ
I
0..1
Reference
(
Encounter
)
Healthcare
event
during
which
this
observation
is
made
effective[x]
Σ
I
0..1
Clinically
relevant
time/time-period
for
observation
effectiveDateTime
dateTime
effectivePeriod
Period
effectiveTiming
Timing
effectiveInstant
instant
issued
Σ
I
0..1
instant
Date/Time
this
version
was
made
available
performer
Σ
I
0..*
Reference
(
Practitioner
|
PractitionerRole
|
Organization
|
CareTeam
|
Patient
|
RelatedPerson
)
Who
is
responsible
for
the
observation
value[x]
Σ
I
(Slice
Definition)
Actual
result
Slice:
Unordered,
Closed
by
type:$this
value[x]:valueQuantity
S
Σ
I
0..1
Quantity
HDL
Cholesterol
value
dataAbsentReason
I
0..1
CodeableConcept
Why
the
result
is
missing
Binding:
DataAbsentReason
(
extensible
)
interpretation
S
I
0..1
CodeableConcept
+
|
++
|
+++
|
-
|
--
|
---
Binding:
Observation
Interpretation
Codes
(
extensible
)
note
S
I
0..*
Annotation
Comments
about
result
bodySite
I
0..1
CodeableConcept
Observed
body
part
Binding:
SNOMED
CT
Body
Structures
(
example
)
method
I
0..1
CodeableConcept
How
it
was
done
Binding:
Observation
Methods
(
example
)
specimen
I
0..1
Reference
(
Specimen
)
Specimen
used
for
this
observation
device
I
0..1
Reference
(
Device
|
DeviceMetric
)
(Measurement)
Device
referenceRange
S
I
1..1
BackboneElement
Provides
guide
for
interpretation
id
0..1
string
Unique
id
for
inter-element
referencing
extension
I
0..*
Extension
Additional
content
defined
by
implementations
modifierExtension
?!
Σ
I
0..*
Extension
Extensions
that
cannot
be
ignored
even
if
unrecognized
low
I
1..1
SimpleQuantity
A
fixed
quantity
(no
comparator)
Fixed
Value:
As
shown
id
0..0
string
Unique
id
for
inter-element
referencing
extension
0..0
Extension
Additional
content
defined
by
implementations
value
1..1
decimal
Numerical
value
(with
implicit
precision)
Fixed
Value:
1.5
comparator
0..0
code
<
|
<=
|
>=
|
>
-
how
to
understand
the
value
unit
0..0
string
Unit
representation
system
0..0
uri
System
that
defines
coded
unit
form
code
0..0
code
Coded
form
of
the
unit
text
I
0..1
string
Text
based
reference
range
in
an
observation
component
Σ
I
0..*
BackboneElement
Component
results
id
0..1
string
Unique
id
for
inter-element
referencing
extension
I
0..*
Extension
Additional
content
defined
by
implementations
modifierExtension
?!
Σ
I
0..*
Extension
Extensions
that
cannot
be
ignored
even
if
unrecognized
code
Σ
I
1..1
CodeableConcept
Type
of
component
observation
(code
/
type)
Binding:
LOINC
Codes
(
example
)
value[x]
Σ
I
0..1
Actual
component
result
valueQuantity
Quantity
valueCodeableConcept
CodeableConcept
valueString
string
valueBoolean
boolean
valueInteger
integer
valueRange
Range
valueRatio
Ratio
valueSampledData
SampledData
valueTime
time
valueDateTime
dateTime
valuePeriod
Period
dataAbsentReason
I
0..1
CodeableConcept
Why
the
component
result
is
missing
Binding:
DataAbsentReason
(
extensible
)
interpretation
I
0..*
CodeableConcept
High,
low,
normal,
etc.
Binding:
Observation
Interpretation
Codes
(
extensible
)
referenceRange
I
0..*
Unknown
reference
to
#Observation.referenceRange
Provides
guide
for
interpretation
of
component
result
Documentation
for
this
format
XML
Template
virtual
encounter
@prefix fhir: <http://hl7.org/fhir/> . @prefix owl: <http://www.w3.org/2002/07/owl#> . @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> . @prefix xsd: <http://www.w3.org/2001/XMLSchema#> .< xmlns="http://hl7.org/fhir" > <!-- from Element: --> <</id> <</meta> < < < Text summary of the resource, for human interpretation</text> <</contained> <<a href="hdlcholesterol-definitions.html#Observation.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.# - resource -------------------------------------------------------------------Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> < Business Identifier for observation</identifier> <</basedOn> <</partOf> < <</category> <</code> < Who and/or what the observation is about</subject> < What the observation is about, when it is not about the subject of record</focus> < Healthcare event during which this observation is made</encounter> < Clinically relevant time/time-period for observation</effective[x]> < < Who is responsible for the observation</performer> <</valueQuantity> <</dataAbsentReason> <</interpretation> <</note> <</bodySite> <</method> <</specimen> <</device> < <<a href="hdlcholesterol-definitions.html#Observation.referenceRange.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.<http://hl7.org/fhir/Encounter/home> a fhir:Encounter; fhir:nodeRole fhir:treeRoot; fhir:Resource.id [ fhir:value "home"]; fhir:DomainResource.text [ fhir:Narrative.status [ fhir:value "generated" ]; fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\">Encounter with patient @example who is at home</div>" ]; fhir:DomainResource.contained [ a fhir:Location; fhir:index 0; fhir:Resource.id [ fhir:value "home" ]; fhir:Location.description [ fhir:value "Client's home" ]; fhir:Location.mode [ fhir:value "kind" ] ]; fhir:Encounter.status [ fhir:value "finished"]; fhir:Encounter.class [ fhir:Coding.system [ fhir:value "http://hl7.org/fhir/v3/ActCode" ]; fhir:Coding.code [ fhir:value "HH" ]; fhir:Coding.display [ fhir:value "home health" ] ]; fhir:Encounter.subject [ fhir:link <http://hl7.org/fhir/Patient/example>; fhir:Reference.reference [ fhir:value "Patient/example" ] ]; fhir:Encounter.participant [ fhir:index 0; fhir:Encounter.participant.period [ fhir:Period.start [ fhir:value "2015-01-17T16:00:00+10:00"^^xsd:dateTime ]; fhir:Period.end [ fhir:value "2015-01-17T16:30:00+10:00"^^xsd:dateTime ] ]; fhir:Encounter.participant.individual [ fhir:link <http://hl7.org/fhir/Practitioner/example>; fhir:Reference.reference [ fhir:value "Practitioner/example" ]; fhir:Reference.display [ fhir:value "Dr Adam Careful" ] ] ]; fhir:Encounter.period [ fhir:Period.start [ fhir:value "2015-01-17T16:00:00+10:00"^^xsd:dateTime ]; fhir:Period.end [ fhir:value "2015-01-17T16:30:00+10:00"^^xsd:dateTime ] ]; fhir:Encounter.location [ fhir:index 0; fhir:Encounter.location.location [ fhir:Reference.reference [ fhir:value "#home" ]; fhir:Reference.display [ fhir:value "Client's home" ] ]; fhir:Encounter.location.status [ fhir:value "completed" ]; fhir:Encounter.location.period [ fhir:Period.start [ fhir:value "2015-01-17T16:00:00+10:00"^^xsd:dateTime ]; fhir:Period.end [ fhir:value "2015-01-17T16:30:00+10:00"^^xsd:dateTime ] ] ] .Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> < A fixed quantity (no comparator)</low> < High Range, if relevant</high> <</type> <</appliesTo> < Applicable age range, if relevant</age> < </referenceRange> < Related resource that belongs to the Observation group</hasMember> < Related measurements the observation is made from</derivedFrom> < <<a href="hdlcholesterol-definitions.html#Observation.component.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.<http://hl7.org/fhir/Patient/example> a fhir:Patient . <http://hl7.org/fhir/Practitioner/example> a fhir:Practitioner . # - ontology header ------------------------------------------------------------ <http://hl7.org/fhir/Encounter/home.ttl> a owl:Ontology; owl:imports fhir:fhir.ttl; owl:versionIRI <http://hl7.org/fhir/STU3/Encounter/home.ttl> . # -------------------------------------------------------------------------------------Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> <</code> <| Actual component result</value[x]> <</dataAbsentReason> <</interpretation> <</referenceRange> </component> </Observation> JSON Template { // // from Element: " " " " " "<a href="hdlcholesterol-definitions.html#Observation.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"> " " " " " " " " " " " " " " " " { // // from Element: } ], " " " " " " " " " }
Alternate
definitions:
Master
Definition
(
XML
,
JSON
),
Schematron
Usage
note:
every
effort
has
been
made
to
ensure
that
the
examples
are
correct
and
useful,
but
they
are
not
a
normative
part
of
the
specification.