This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
(v4.0.1:
R4
-
Mixed
Normative
and
STU
3).
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
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
R4
R3
Work
Group
|
Maturity
Level
:
|
|
Use Context : Any |
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/bodyweight
FHIR Body Weight Profile
This
profile
was
published
on
Fri,
Mar
25,
2016
00:00+1100
Sat,
Aug
11,
2018
00:00+1000
as
a
draft
by
Health
Level
Seven
International
(Orders
and
Observations
Workgroup).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work .
This
structure
is
derived
from
Vital
Signs
Profile
observation-vitalsigns
.
Summary
Observation.code
which
must
have
Observation.code.coding.system
=
'http
://loinc.org'
Observation.code.coding.code
=
'29463-7'
Observation.code
-
e.g.
more
specific
LOINC
Codes,
SNOMED
CT
concepts,
system
specific
codes.
All
codes
SHALL
have
an
system
value
Mandatory:
3
elements
(+4
nested
mandatory
elements)
Must-Support:
4
elements
Fixed
Value:
2
3
elements
Slices
This structure defines the following Slices :
This
structure
is
derived
from
Vital
Signs
Profile
observation-vitalsigns
.
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
|
0..* |
FHIR
Body
Weight
Profile
|
|
|
1 .. 1 | CodeableConcept | Body Weight | |
|
|
(Slice Definition) |
Slice:
Unordered,
Open
by
|
|
|
|
1..1 | Coding | |
|
|
1..1 | uri | Fixed Value: http://loinc.org |
|
|
1..1 | code | Fixed Value: 29463-7 |
|
0 .. 1 | Quantity | ||
| S | 1..1 | decimal | |
|
S | 1..1 | string | |
![]() ![]() ![]() |
S
|
1..1 | uri |
Fixed
Value:
|
|
S | 1..1 | code |
Coded
responses
from
the
common
UCUM
units
for
vital
signs
value
set.
Binding: Body Weight Units ( required ) |
Documentation
for
this
format
|
||||
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
I | 0..* |
FHIR
Body
Weight
Profile
|
|
|
Σ | 0..1 |
|
Logical id of this artifact |
|
Σ I | 0..1 | Meta | Metadata about the resource |
|
?! Σ I | 0..1 | uri | A set of rules under which this content was created |
|
I | 0..1 | code |
Language
of
the
resource
content
Binding: Common Languages ( Max Binding: All Languages |
|
I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
|
0..* | Resource |
Contained,
inline
Resources
|
|
|
I | 0..* | Extension |
Additional
|
|
?! I | 0..* | Extension |
Extensions
that
cannot
be
ignored
|
|
Σ I | 0..* | Identifier |
Business
Identifier
for
observation
|
|
Σ I | 0..* |
Reference
(
CarePlan
|
Fulfills
plan,
proposal
or
order
|
| Σ I | 0..* | Reference ( MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy ) |
Part
of
referenced
event
|
|
?! S Σ I | 1..1 | code |
registered
|
preliminary
|
final
|
amended
+
Binding: ObservationStatus ( required ) |
|
S I | (Slice Definition) |
Classification
of
type
of
observation
Slice: Unordered, Open by value:coding.code, value:coding.system Binding: Observation Category Codes ( preferred ) | |
![]() ![]() ![]() |
S I |
|
CodeableConcept |
Classification
of
type
of
observation
Binding: Observation Category Codes ( preferred ) |
| 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | I | 0..* | Extension |
Additional
content
defined
by
implementations
|
![]() ![]() ![]() ![]() | S Σ I | 1..* | Coding |
Code
defined
by
a
|
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | I | 0..* | Extension |
Additional
content
defined
by
implementations
Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() ![]() | S Σ I | 1..1 | uri |
Identity
of
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category |
![]() ![]() ![]() ![]() ![]() | Σ I | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() |
S Σ I | 1..1 | code |
Symbol
in
syntax
defined
by
the
system
Fixed Value: vital-signs |
![]() ![]() ![]() ![]() ![]() | Σ I | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() | Σ I | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() | Σ I | 0..1 | string | Plain text representation of the concept |
|
S Σ I | 1..1 | CodeableConcept |
Body
Weight
Binding: Vital Signs ( extensible ) |
|
0..1 | string | Unique id for inter-element referencing | |
| I | 0..* | Extension |
Additional
content
defined
by
implementations
Slice: Unordered, Open by value:url |
![]() ![]() ![]() |
Σ I | (Slice Definition) |
Code
defined
by
a
terminology
system
Slice: Unordered, Open by |
|
|
Σ I |
|
Coding |
Code
defined
by
a
terminology
system
|
|
0..1 | string | Unique id for inter-element referencing | |
|
|
| Extension |
Additional
content
defined
by
implementations
Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() ![]() | Σ I | 1..1 | uri |
Identity
of
the
terminology
system
Fixed Value: http://loinc.org |
|
Σ I | 0..1 | string | Version of the system - if relevant |
|
Σ I | 1..1 | code |
Symbol
in
syntax
defined
by
the
system
Fixed Value: 29463-7 |
|
Σ I | 0..1 | string | Representation defined by the system |
|
Σ I | 0..1 | boolean | If this coding was chosen directly by the user |
|
Σ I | 0..1 | string | Plain text representation of the concept |
|
S Σ I | 1..1 | Reference ( Patient ) |
Who
and/or
what
|
|
Σ I |
|
Reference
(
|
What
the
observation
is
about,
when
it
is
not
about
the
subject
of
record
|
![]() ![]() | Σ I | 0..1 |
Reference
(
|
Healthcare event during which this observation is made |
|
S Σ I | 1..1 |
|
Often
just
a
dateTime
for
Vital
Signs
vs-1: |
![]() ![]() ![]() | dateTime | |||
| Period | |||
|
Σ I | 0..1 | instant | Date/Time this version was made available |
|
Σ I | 0..* |
Reference
(
Practitioner
|
Who
is
responsible
for
the
observation
|
| S Σ I | (Slice Definition) |
Vital
Signs
value
are
recorded
using
the
Quantity
data
type.
For
supporting
observations
such
as
Cuff
size
could
use
other
datatypes
such
as
CodeableConcept.
Slice: Unordered, Closed by type:$this | |
![]() ![]()
|
S Σ I | 0..1 | Quantity |
Vital
|
|
0..1 | string | Unique id for inter-element referencing | |
|
I |
|
|
Slice: Unordered, Open by value:url |
|
S Σ I | 1..1 | decimal | Numerical value (with implicit precision) |
|
?! Σ I | 0..1 | code |
<
|
<=
|
>=
|
>
-
how
to
understand
the
value
Binding: QuantityComparator ( required ) |
|
S Σ I | 1..1 | string | Unit representation |
|
S Σ I | 1..1 | uri |
System
that
defines
coded
unit
form
Fixed Value: http://unitsofmeasure.org |
|
S Σ I | 1..1 | code |
Coded
responses
from
the
common
UCUM
units
for
vital
signs
value
set.
Binding: Body Weight Units ( required ) |
|
S I | 0..1 | CodeableConcept |
Why
the
result
is
missing
Binding: |
|
I
|
0..* | CodeableConcept |
High,
low,
normal,
etc.
Binding: Observation Interpretation Codes ( extensible ) |
|
I |
|
|
Comments
about
|
|
I | 0..1 | CodeableConcept |
Observed
body
part
Binding: SNOMED CT Body Structures ( example ) |
|
I | 0..1 | CodeableConcept |
How
it
was
done
Binding: Observation Methods ( example ) |
|
I | 0..1 | Reference ( Specimen ) | Specimen used for this observation |
|
I | 0..1 |
Reference
(
Device
|
(Measurement) Device |
|
I | 0..* | BackboneElement |
Provides
guide
for
interpretation
obs-3: Must have at least a low or a high or text |
|
0..1 | string |
|
|
|
I | 0..* | Extension |
Additional
|
|
?! Σ I | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
|
I | 0..1 | SimpleQuantity | Low Range, if relevant |
|
I | 0..1 | SimpleQuantity | High Range, if relevant |
|
I | 0..1 | CodeableConcept |
Reference
range
qualifier
Binding: Observation Reference Range Meaning Codes ( |
|
I | 0..* | CodeableConcept |
Reference
range
population
Binding: Observation Reference Range Applies To Codes ( example ) |
|
I | 0..1 | Range | Applicable age range, if relevant |
|
I | 0..1 | string | Text based reference range in an observation |
|
Σ I | 0..* |
|
Used
when
reporting
vital
signs
panel
components
|
|
|
0..* |
|
|
|
S Σ I | 0..* | BackboneElement |
Used
when
reporting
systolic
and
diastolic
blood
pressure.
vs-3: If there is no a value a data absent reason must be present |
|
0..1 | string |
|
|
|
I | 0..* | Extension |
Additional
|
|
?! Σ I | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
|
S Σ I | 1..1 | CodeableConcept |
Type
of
component
observation
(code
/
type)
Binding: Vital Signs ( extensible ) |
|
S Σ I | 0..1 |
|
Vital
Sign
Value
recorded
with
UCUM
Binding: Vital Signs Units ( required ) |
|
|
|
||
|
CodeableConcept |
|
||
|
|
string | ||
|
|
|
|
|
|
integer
|
|||
|
|
|
|
|
|
Ratio |
|
||
|
|
|
SampledData |
|
|
time | |||
|
dateTime |
|
||
|
|
Period | ||
|
S I | 0..1 | CodeableConcept |
Why
the
component
result
is
missing
Binding: |
|
I
|
0..* | CodeableConcept |
High,
low,
normal,
etc.
Binding: Observation Interpretation Codes ( extensible ) |
|
I | 0..* |
Unknown
reference
to
#Observation.referenceRange
Provides guide for interpretation of component result |
|
Documentation
for
this
format
|
||||
<!-- Vital Signs Profile --><!-- observation-bodyweight -->![]()
< xmlns="http://hl7.org/fhir"<Observation xmlns="http://hl7.org/fhir" > <!-- from Element: extension -->< <</meta> < < <<id><!-- 0..1 string Logical id of this artifact --></id> <meta><!--0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!--
0..1 A set of rules under which this content was created --> <language value="[code]"/><!--
0..1 Language of the resource content --> <text><!--
0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained>
<</modifierExtension> <<modifierExtension><!--0..* Extension Extensions that cannot be ignored --></modifierExtension> <identifier><!--
0..* Identifier Business Identifier for observation --></identifier>
<)| </basedOn> < <</category> < < < < < < <<basedOn><!--0..* Reference(CarePlan) Fulfills plan, proposal or order --></basedOn> <partOf><!--
0..* Reference(MedicationAdministration) Part of referenced event --></partOf> <status value="[code]"/><!--
1..1 registered | preliminary | final | amended + --> <-- category sliced by value:coding.code, value:coding.system in the specified orderOpen--> <category>
1..1 CodeableConcept <!--
1..1 Classification of type of observation --> <coding>
1..* Coding <!--
1..* Code defined by a terminology system --> <system value="[uri]"/><!--
1..1 Identity of the terminology system --> <version value="[string]"/><!--
0..1 Version of the system - if relevant --> <code value="[code]"/><!--
1..1 Symbol in syntax defined by the system --> <display value="[string]"/><!--
0..1 Representation defined by the system --> <userSelected value="[boolean]"/><!--
0..1 If this coding was chosen directly by the user --> </coding>
<<text value="[string]"/><!--0..1 Plain text representation of the concept --> </category> <code>
1..1 CodeableConcept <!--
1..1 Body Weight --> <-- coding sliced by value:code, value:system in the specified orderOpen--> <coding>
1..1 Coding <!--
1..1 Code defined by a terminology system --> <system value="[uri]"/><!--
1..1 Identity of the terminology system --> <version value="[string]"/><!--
0..1 Version of the system - if relevant --> <code value="[code]"/><!--
1..1 Symbol in syntax defined by the system --> <display value="[string]"/><!--
0..1 Representation defined by the system --> <userSelected value="[boolean]"/><!--
0..1 If this coding was chosen directly by the user --> </coding> <text value="[string]"/><!--
0..1 Plain text representation of the concept --> </code>
<</subject> < Healthcare event during which this observation is made</context> <<subject><!--1..1 Reference(Patient) Who and/or what the observation is about --></subject> <focus><!--
0..* Reference(Resource) What the observation is about, when it is not about the subject of record --></focus> <encounter><!--
0..1 Reference(Encounter) Healthcare event during which this observation is made --></encounter> <effective[x]><!--
1..1 dateTime|Period Often just a dateTime for Vital Signs --></effective[x]>
< <<issued value="[instant]"/><!--0..1 Date/Time this version was made available --> <performer><!--
0..* Reference(Practitioner) Who is responsible for the observation --></performer>
< < < < < <<-- valueQuantity sliced by type:$this in the specified orderClosed--> <valueQuantity>0..1 Quantity <!--
0..1 Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. --> <value value="[decimal]"/><!--
1..1 Numerical value (with implicit precision) --> <comparator value="[code]"/><!--
0..1 < | <= | >= | > - how to understand the value --> <unit value="[string]"/><!--
1..1 Unit representation --> <system value="[uri]"/><!--
1..1 System that defines coded unit form --> <code value="[code]"/><!--
1..1 Coded responses from the common UCUM units for vital signs value set. --> </valueQuantity>
<</dataAbsentReason> <</interpretation> < <</bodySite> <</method> <</specimen> <</device> < <</modifierExtension> <<dataAbsentReason><!--0..1 CodeableConcept Why the result is missing --></dataAbsentReason> <interpretation><!--
0..* CodeableConcept High, low, normal, etc. --></interpretation> <note><!--
0..* Annotation Comments about the observation --></note> <bodySite><!--
0..1 CodeableConcept Observed body part --></bodySite> <method><!--
0..1 CodeableConcept How it was done --></method> <specimen><!--
0..1 Reference(Specimen) Specimen used for this observation --></specimen> <device><!--
0..1 Reference(Device) (Measurement) Device --></device> <referenceRange>
0..* BackboneElement <!--
0..* Provides guide for interpretation --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <low><!--
0..1 Quantity Low Range, if relevant --></low>
<<high><!--0..1 Quantity High Range, if relevant --></high>
<</type> <</appliesTo> <<type><!--0..1 CodeableConcept Reference range qualifier --></type> <appliesTo><!--
0..* CodeableConcept Reference range population --></appliesTo> <age><!--
0..1 Range Applicable age range, if relevant --></age>
<<text value="[string]"/><!--0..1 Text based reference range in an observation --> </referenceRange>
< <</modifierExtension> < < Resource that is related to this one</target> </related><hasMember><!--0..* Reference(QuestionnaireResponse) Used when reporting vital signs panel components --></hasMember> <derivedFrom><!--
0..* Reference(DocumentReference) Related measurements the observation is made from --></derivedFrom> <component>
0..* BackboneElement <!--
0..* Used when reporting systolic and diastolic blood pressure. -->
<</modifierExtension> <</code> < < < < < < Coded responses from the common UCUM units for vital signs value set. </valueQuantity> <</dataAbsentReason> <</interpretation><modifierExtension><!--0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!--
1..1 CodeableConcept Type of component observation (code / type) --></code> <value[x]><!--
0..1 Quantity|CodeableConcept|string| boolean|integer|Range|Ratio|SampledData|time|dateTime|Period Vital Sign Value recorded with UCUM --></value[x]> <dataAbsentReason><!--
0..1 CodeableConcept Why the component result is missing --></dataAbsentReason> <interpretation><!--
0..* CodeableConcept High, low, normal, etc. --></interpretation> <referenceRange><!-- See #Observation.referenceRange Provides guide for interpretation of component result --></referenceRange> </component> </Observation>
{ //{ // observation-bodyweight // from Element: extension" " " " " " " " " " " " " " " " " " " ""meta" : { Meta }, // C?Metadata about the resource "implicitRules" : "<uri>", // C?A set of rules under which this content was created "language" : "<code>", // C?Language of the resource content "text" : { Narrative }, // C?Text summary of the resource, for human interpretation "contained" : [{ Resource }], //Contained, inline Resources "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored "identifier" : [{ Identifier }], // C?Business Identifier for observation "basedOn" : [{ Reference(CarePlan) }], // C?Fulfills plan, proposal or order "partOf" : [{ Reference(MedicationAdministration) }], // C?Part of referenced event "status" : "<code>", // C? R! registered | preliminary | final | amended + "category" : [ // sliced by value:coding.code, value:coding.system in the specified order, Open { // Classification of type of observation // C? R! // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "coding" : [{ Coding }], // C? R! Code defined by a terminology system "text" : "<string>" // C?Plain text representation of the concept } ], "code" : { CodeableConcept }, // C? R! Body Weight "subject" : { Reference(Patient) }, // C? R! Who and/or what the observation is about "focus" : [{ Reference(Resource) }], // C?What the observation is about, when it is not about the subject of record "encounter" : { Reference(Encounter) }, // C?Healthcare event during which this observation is made // value[x]: Often just a dateTime for Vital Signs. One of these 2:" " " " " " " " " " " " " " " " " " ""effectiveDateTime" : "<dateTime>", // C? R! Often just a dateTime for Vital Signs "effectivePeriod" : { Period }, // C? R! Often just a dateTime for Vital Signs "issued" : "<instant>", // C?Date/Time this version was made available "performer" : [{ Reference(Practitioner) }], // C?Who is responsible for the observation "valueQuantity" : [ // sliced by type:$this in the specified order, Closed { // Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. // C? // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "value" : <decimal>, // C? R! Numerical value (with implicit precision) "comparator" : "<code>", // C?< | <= | >= | > - how to understand the value "unit" : "<string>", // C? R! Unit representation "system" : "http://unitsofmeasure.org", // C? R! "code" : "<code>" // C? R! Coded responses from the common UCUM units for vital signs value set. } ], "dataAbsentReason" : { CodeableConcept }, // C?Why the result is missing "interpretation" : [{ CodeableConcept }], // C?High, low, normal, etc. "note" : [{ Annotation }], // C?Comments about the observation "bodySite" : { CodeableConcept }, // C?Observed body part "method" : { CodeableConcept }, // C?How it was done "specimen" : { Reference(Specimen) }, // C?Specimen used for this observation "device" : { Reference(Device) }, // C?(Measurement) Device "referenceRange" : [{ BackboneElement }], // C?Provides guide for interpretation "hasMember" : [{ Reference(QuestionnaireResponse) }], // C?Used when reporting vital signs panel components "derivedFrom" : [{ Reference(DocumentReference) }], // C?Related measurements the observation is made from "component" : [{ BackboneElement }], // C?Used when reporting systolic and diastolic blood pressure. }
This
structure
is
derived
from
Vital
Signs
Profile
observation-vitalsigns
.
Summary
Observation.code
which
must
have
Observation.code.coding.system
=
'http
://loinc.org'
Observation.code.coding.code
=
'29463-7'
Observation.code
-
e.g.
more
specific
LOINC
Codes,
SNOMED
CT
concepts,
system
specific
codes.
All
codes
SHALL
have
an
system
value
Mandatory:
3
elements
(+4
nested
mandatory
elements)
Must-Support:
4
elements
Fixed
Value:
2
3
elements
Slices
This structure defines the following Slices :
Differential View
This
structure
is
derived
from
Vital
Signs
Profile
observation-vitalsigns
.
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
|
0..* |
FHIR
Body
Weight
Profile
|
|
|
1 .. 1 | CodeableConcept | Body Weight | |
|
|
(Slice Definition) |
Slice:
Unordered,
Open
by
|
|
|
|
1..1 | Coding | |
|
|
1..1 | uri | Fixed Value: http://loinc.org |
|
|
1..1 | code | Fixed Value: 29463-7 |
|
0 .. 1 | Quantity | ||
| S | 1..1 | decimal | |
|
S | 1..1 | string | |
![]() ![]() ![]() |
S
|
1..1 | uri |
Fixed
Value:
|
|
S | 1..1 | code |
Coded
responses
from
the
common
UCUM
units
for
vital
signs
value
set.
Binding: Body Weight Units ( required ) |
Documentation
for
this
format
|
||||
Snapshot View
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
I | 0..* |
FHIR
Body
Weight
Profile
|
|
|
Σ | 0..1 |
|
Logical id of this artifact |
|
Σ I | 0..1 | Meta | Metadata about the resource |
|
?! Σ I | 0..1 | uri | A set of rules under which this content was created |
|
I | 0..1 | code |
Language
of
the
resource
content
Binding: Common Languages ( Max Binding: All Languages |
|
I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
|
0..* | Resource |
Contained,
inline
Resources
|
|
|
I | 0..* | Extension |
Additional
|
|
?! I | 0..* | Extension |
Extensions
that
cannot
be
ignored
|
|
Σ I | 0..* | Identifier |
Business
Identifier
for
observation
|
|
Σ I | 0..* |
Reference
(
CarePlan
|
Fulfills
plan,
proposal
or
order
|
| Σ I | 0..* | Reference ( MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy ) |
Part
of
referenced
event
|
|
?! S Σ I | 1..1 | code |
registered
|
preliminary
|
final
|
amended
+
Binding: ObservationStatus ( required ) |
|
S I | (Slice Definition) |
Classification
of
type
of
observation
Slice: Unordered, Open by value:coding.code, value:coding.system Binding: Observation Category Codes ( preferred ) | |
![]() ![]() ![]() |
S I |
|
CodeableConcept |
Classification
of
type
of
observation
Binding: Observation Category Codes ( preferred ) |
| 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | I | 0..* | Extension |
Additional
content
defined
by
implementations
|
![]() ![]() ![]() ![]() | S Σ I | 1..* | Coding |
Code
defined
by
a
|
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | I | 0..* | Extension |
Additional
content
defined
by
implementations
Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() ![]() | S Σ I | 1..1 | uri |
Identity
of
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category |
![]() ![]() ![]() ![]() ![]() | Σ I | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() | S Σ I | 1..1 | code |
Symbol
in
syntax
defined
by
the
system
Fixed Value: vital-signs |
![]() ![]() ![]() ![]() ![]() | Σ I | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() | Σ I | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() | Σ I | 0..1 | string | Plain text representation of the concept |
|
S Σ I | 1..1 | CodeableConcept |
Body
Weight
Binding: Vital Signs ( extensible ) |
|
0..1 | string | Unique id for inter-element referencing | |
| I | 0..* | Extension |
Additional
content
defined
by
implementations
Slice: Unordered, Open by value:url |
![]() ![]() ![]() |
Σ I | (Slice Definition) |
Code
defined
by
a
terminology
system
Slice: Unordered, Open by |
|
|
Σ I |
|
Coding |
Code
defined
by
a
terminology
system
|
|
0..1 | string | Unique id for inter-element referencing | |
|
|
| Extension |
Additional
content
defined
by
implementations
Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() ![]() | Σ I | 1..1 | uri |
Identity
of
the
terminology
system
Fixed Value: http://loinc.org |
|
Σ I | 0..1 | string | Version of the system - if relevant |
|
Σ I | 1..1 | code |
Symbol
in
syntax
defined
by
the
system
Fixed Value: 29463-7 |
|
Σ I | 0..1 | string | Representation defined by the system |
|
Σ I | 0..1 | boolean | If this coding was chosen directly by the user |
|
Σ I | 0..1 | string | Plain text representation of the concept |
|
S Σ I | 1..1 | Reference ( Patient ) |
Who
and/or
what
|
|
Σ I |
|
Reference
(
|
What
the
observation
is
about,
when
it
is
not
about
the
subject
of
record
|
![]() ![]() | Σ I | 0..1 |
Reference
(
|
Healthcare event during which this observation is made |
|
S Σ I | 1..1 |
|
Often
just
a
dateTime
for
Vital
Signs
vs-1: |
![]() ![]() ![]() | dateTime | |||
| Period | |||
|
Σ I | 0..1 | instant | Date/Time this version was made available |
|
Σ I | 0..* |
Reference
(
Practitioner
|
Who
is
responsible
for
the
observation
|
| S Σ I | (Slice Definition) |
Vital
Signs
value
are
recorded
using
the
Quantity
data
type.
For
supporting
observations
such
as
Cuff
size
could
use
other
datatypes
such
as
CodeableConcept.
Slice: Unordered, Closed by type:$this | |
![]() ![]()
|
S Σ I | 0..1 | Quantity |
Vital
|
|
0..1 | string | Unique id for inter-element referencing | |
|
I |
|
|
Slice: Unordered, Open by value:url |
|
S Σ I | 1..1 | decimal | Numerical value (with implicit precision) |
|
?! Σ I | 0..1 | code |
<
|
<=
|
>=
|
>
-
how
to
understand
the
value
Binding: QuantityComparator ( required ) |
|
S Σ I | 1..1 | string | Unit representation |
|
S Σ I | 1..1 | uri |
System
that
defines
coded
unit
form
Fixed Value: http://unitsofmeasure.org |
|
S Σ I | 1..1 | code |
Coded
responses
from
the
common
UCUM
units
for
vital
signs
value
set.
Binding: Body Weight Units ( required ) |
|
S I | 0..1 | CodeableConcept |
Why
the
result
is
missing
Binding: |
|
I
|
0..* | CodeableConcept |
High,
low,
normal,
etc.
Binding: Observation Interpretation Codes ( extensible ) |
|
I |
|
|
Comments
about
|
|
I | 0..1 | CodeableConcept |
Observed
body
part
Binding: SNOMED CT Body Structures ( example ) |
|
I | 0..1 | CodeableConcept |
How
it
was
done
Binding: Observation Methods ( example ) |
|
I | 0..1 | Reference ( Specimen ) | Specimen used for this observation |
|
I | 0..1 |
Reference
(
Device
|
(Measurement) Device |
|
I | 0..* | BackboneElement |
Provides
guide
for
interpretation
obs-3: Must have at least a low or a high or text |
|
0..1 | string |
|
|
|
I | 0..* | Extension |
Additional
|
|
?! Σ I | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
|
I | 0..1 | SimpleQuantity | Low Range, if relevant |
|
I | 0..1 | SimpleQuantity | High Range, if relevant |
|
I | 0..1 | CodeableConcept |
Reference
range
qualifier
Binding: Observation Reference Range Meaning Codes ( |
|
I | 0..* | CodeableConcept |
Reference
range
population
Binding: Observation Reference Range Applies To Codes ( example ) |
|
I | 0..1 | Range | Applicable age range, if relevant |
|
I | 0..1 | string | Text based reference range in an observation |
|
Σ I | 0..* |
|
Used
when
reporting
vital
signs
panel
components
|
|
|
0..* |
|
|
|
S Σ I | 0..* | BackboneElement |
Used
when
reporting
systolic
and
diastolic
blood
pressure.
vs-3: If there is no a value a data absent reason must be present |
|
0..1 | string |
|
|
|
I | 0..* | Extension |
Additional
|
|
?! Σ I | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
|
S Σ I | 1..1 | CodeableConcept |
Type
of
component
observation
(code
/
type)
Binding: Vital Signs ( extensible ) |
|
S Σ I | 0..1 |
|
Vital
Sign
Value
recorded
with
UCUM
Binding: Vital Signs Units ( required ) |
|
|
|
||
|
CodeableConcept |
|
||
|
|
string | ||
|
|
|
|
|
|
integer
|
|||
|
|
|
|
|
|
Ratio |
|
||
|
|
|
SampledData |
|
|
time | |||
|
dateTime |
|
||
|
|
Period | ||
|
S I | 0..1 | CodeableConcept |
Why
the
component
result
is
missing
Binding: |
|
I
|
0..* | CodeableConcept |
High,
low,
normal,
etc.
Binding: Observation Interpretation Codes ( extensible ) |
|
I | 0..* |
Unknown
reference
to
#Observation.referenceRange
Provides guide for interpretation of component result |
|
Documentation
for
this
format
|
||||
XML Template
<!-- Vital Signs Profile --><!-- observation-bodyweight -->![]()
< xmlns="http://hl7.org/fhir"<Observation xmlns="http://hl7.org/fhir" > <!-- from Element: extension -->< <</meta> < < <<id><!-- 0..1 string Logical id of this artifact --></id> <meta><!--0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!--
0..1 A set of rules under which this content was created --> <language value="[code]"/><!--
0..1 Language of the resource content --> <text><!--
0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained>
<</modifierExtension> <<modifierExtension><!--0..* Extension Extensions that cannot be ignored --></modifierExtension> <identifier><!--
0..* Identifier Business Identifier for observation --></identifier>
<)| </basedOn> < <</category> < < < < < < <<basedOn><!--0..* Reference(CarePlan) Fulfills plan, proposal or order --></basedOn> <partOf><!--
0..* Reference(MedicationAdministration) Part of referenced event --></partOf> <status value="[code]"/><!--
1..1 registered | preliminary | final | amended + --> <-- category sliced by value:coding.code, value:coding.system in the specified orderOpen--> <category>
1..1 CodeableConcept <!--
1..1 Classification of type of observation --> <coding>
1..* Coding <!--
1..* Code defined by a terminology system --> <system value="[uri]"/><!--
1..1 Identity of the terminology system --> <version value="[string]"/><!--
0..1 Version of the system - if relevant --> <code value="[code]"/><!--
1..1 Symbol in syntax defined by the system --> <display value="[string]"/><!--
0..1 Representation defined by the system --> <userSelected value="[boolean]"/><!--
0..1 If this coding was chosen directly by the user --> </coding>
<<text value="[string]"/><!--0..1 Plain text representation of the concept --> </category> <code>
1..1 CodeableConcept <!--
1..1 Body Weight --> <-- coding sliced by value:code, value:system in the specified orderOpen--> <coding>
1..1 Coding <!--
1..1 Code defined by a terminology system --> <system value="[uri]"/><!--
1..1 Identity of the terminology system --> <version value="[string]"/><!--
0..1 Version of the system - if relevant --> <code value="[code]"/><!--
1..1 Symbol in syntax defined by the system --> <display value="[string]"/><!--
0..1 Representation defined by the system --> <userSelected value="[boolean]"/><!--
0..1 If this coding was chosen directly by the user --> </coding> <text value="[string]"/><!--
0..1 Plain text representation of the concept --> </code>
<</subject> < Healthcare event during which this observation is made</context> <<subject><!--1..1 Reference(Patient) Who and/or what the observation is about --></subject> <focus><!--
0..* Reference(Resource) What the observation is about, when it is not about the subject of record --></focus> <encounter><!--
0..1 Reference(Encounter) Healthcare event during which this observation is made --></encounter> <effective[x]><!--
1..1 dateTime|Period Often just a dateTime for Vital Signs --></effective[x]>
< <<issued value="[instant]"/><!--0..1 Date/Time this version was made available --> <performer><!--
0..* Reference(Practitioner) Who is responsible for the observation --></performer>
< < < < < <<-- valueQuantity sliced by type:$this in the specified orderClosed--> <valueQuantity>0..1 Quantity <!--
0..1 Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. --> <value value="[decimal]"/><!--
1..1 Numerical value (with implicit precision) --> <comparator value="[code]"/><!--
0..1 < | <= | >= | > - how to understand the value --> <unit value="[string]"/><!--
1..1 Unit representation --> <system value="[uri]"/><!--
1..1 System that defines coded unit form --> <code value="[code]"/><!--
1..1 Coded responses from the common UCUM units for vital signs value set. --> </valueQuantity>
<</dataAbsentReason> <</interpretation> < <</bodySite> <</method> <</specimen> <</device> < <</modifierExtension> <<dataAbsentReason><!--0..1 CodeableConcept Why the result is missing --></dataAbsentReason> <interpretation><!--
0..* CodeableConcept High, low, normal, etc. --></interpretation> <note><!--
0..* Annotation Comments about the observation --></note> <bodySite><!--
0..1 CodeableConcept Observed body part --></bodySite> <method><!--
0..1 CodeableConcept How it was done --></method> <specimen><!--
0..1 Reference(Specimen) Specimen used for this observation --></specimen> <device><!--
0..1 Reference(Device) (Measurement) Device --></device> <referenceRange>
0..* BackboneElement <!--
0..* Provides guide for interpretation --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <low><!--
0..1 Quantity Low Range, if relevant --></low>
<<high><!--0..1 Quantity High Range, if relevant --></high>
<</type> <</appliesTo> <<type><!--0..1 CodeableConcept Reference range qualifier --></type> <appliesTo><!--
0..* CodeableConcept Reference range population --></appliesTo> <age><!--
0..1 Range Applicable age range, if relevant --></age>
<<text value="[string]"/><!--0..1 Text based reference range in an observation --> </referenceRange>
< <</modifierExtension> < < Resource that is related to this one</target> </related><hasMember><!--0..* Reference(QuestionnaireResponse) Used when reporting vital signs panel components --></hasMember> <derivedFrom><!--
0..* Reference(DocumentReference) Related measurements the observation is made from --></derivedFrom> <component>
0..* BackboneElement <!--
0..* Used when reporting systolic and diastolic blood pressure. -->
<</modifierExtension> <</code> < < < < < < Coded responses from the common UCUM units for vital signs value set. </valueQuantity> <</dataAbsentReason> <</interpretation><modifierExtension><!--0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!--
1..1 CodeableConcept Type of component observation (code / type) --></code> <value[x]><!--
0..1 Quantity|CodeableConcept|string| boolean|integer|Range|Ratio|SampledData|time|dateTime|Period Vital Sign Value recorded with UCUM --></value[x]> <dataAbsentReason><!--
0..1 CodeableConcept Why the component result is missing --></dataAbsentReason> <interpretation><!--
0..* CodeableConcept High, low, normal, etc. --></interpretation> <referenceRange><!-- See #Observation.referenceRange Provides guide for interpretation of component result --></referenceRange> </component> </Observation>
JSON Template
{ //{ // observation-bodyweight // from Element: extension" " " " " " " " " " " " " " " " " " " ""meta" : { Meta }, // C?Metadata about the resource "implicitRules" : "<uri>", // C?A set of rules under which this content was created "language" : "<code>", // C?Language of the resource content "text" : { Narrative }, // C?Text summary of the resource, for human interpretation "contained" : [{ Resource }], //Contained, inline Resources "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored "identifier" : [{ Identifier }], // C?Business Identifier for observation "basedOn" : [{ Reference(CarePlan) }], // C?Fulfills plan, proposal or order "partOf" : [{ Reference(MedicationAdministration) }], // C?Part of referenced event "status" : "<code>", // C? R! registered | preliminary | final | amended + "category" : [ // sliced by value:coding.code, value:coding.system in the specified order, Open { // Classification of type of observation // C? R! // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "coding" : [{ Coding }], // C? R! Code defined by a terminology system "text" : "<string>" // C?Plain text representation of the concept } ], "code" : { CodeableConcept }, // C? R! Body Weight "subject" : { Reference(Patient) }, // C? R! Who and/or what the observation is about "focus" : [{ Reference(Resource) }], // C?What the observation is about, when it is not about the subject of record "encounter" : { Reference(Encounter) }, // C?Healthcare event during which this observation is made // value[x]: Often just a dateTime for Vital Signs. One of these 2:" " " " " " " " " " " " " " " " " " ""effectiveDateTime" : "<dateTime>", // C? R! Often just a dateTime for Vital Signs "effectivePeriod" : { Period }, // C? R! Often just a dateTime for Vital Signs "issued" : "<instant>", // C?Date/Time this version was made available "performer" : [{ Reference(Practitioner) }], // C?Who is responsible for the observation "valueQuantity" : [ // sliced by type:$this in the specified order, Closed { // Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. // C? // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "value" : <decimal>, // C? R! Numerical value (with implicit precision) "comparator" : "<code>", // C?< | <= | >= | > - how to understand the value "unit" : "<string>", // C? R! Unit representation "system" : "http://unitsofmeasure.org", // C? R! "code" : "<code>" // C? R! Coded responses from the common UCUM units for vital signs value set. } ], "dataAbsentReason" : { CodeableConcept }, // C?Why the result is missing "interpretation" : [{ CodeableConcept }], // C?High, low, normal, etc. "note" : [{ Annotation }], // C?Comments about the observation "bodySite" : { CodeableConcept }, // C?Observed body part "method" : { CodeableConcept }, // C?How it was done "specimen" : { Reference(Specimen) }, // C?Specimen used for this observation "device" : { Reference(Device) }, // C?(Measurement) Device "referenceRange" : [{ BackboneElement }], // C?Provides guide for interpretation "hasMember" : [{ Reference(QuestionnaireResponse) }], // C?Used when reporting vital signs panel components "derivedFrom" : [{ Reference(DocumentReference) }], // C?Related measurements the observation is made from "component" : [{ BackboneElement }], // C?Used when reporting systolic and diastolic blood pressure. }
Other
representations
of
profile:
Alternate
definitions:
Master
Definition
(
XML
,
JSON
),
Schematron
| Path | Name | Conformance | ValueSet |
| Observation.language | Common Languages |
|
Common Languages |
| Observation.status | ObservationStatus | required | ObservationStatus |
| Observation.category | Observation Category Codes | preferred | Observation Category Codes |
|
|
|
|
|
|
|
Vital
Signs
|
|
Vital
Signs
|
|
|
QuantityComparator | required | QuantityComparator |
|
|
Body Weight Units | required | Body Weight Units |
| Observation.dataAbsentReason |
|
extensible |
|
| Observation.interpretation | Observation Interpretation Codes | extensible | Observation Interpretation Codes |
| Observation.bodySite | SNOMED CT Body Structures | example | SNOMED CT Body Structures |
| Observation.method | Observation Methods | example | Observation Methods |
| Observation.referenceRange.type | Observation Reference Range Meaning Codes |
|
Observation Reference Range Meaning Codes |
| Observation.referenceRange.appliesTo | Observation Reference Range Applies To Codes | example | Observation Reference Range Applies To Codes |
|
|
Vital Signs | extensible | Vital Signs |
|
|
Vital Signs Units | required | Vital Signs Units |
|
|
|
extensible |
|
| Observation.component.interpretation | Observation Interpretation Codes | extensible | Observation Interpretation Codes |
| Id | Path | Details | Requirements |
| vs-1 | Observation.effective[x] |
Expression
:
($this
as
dateTime).toString().length()
>=
8
|
|
| obs-3 | Observation.referenceRange |
Must
have
at
least
a
low
or
a
high
or
text
Expression
:
low.exists()
or
high.exists()
or
text.exists()
|
|
| vs-3 | Observation.component |
If
there
is
no
a
value
a
data
absent
reason
must
be
present
Expression
:
value.exists()
or
dataAbsentReason.exists()
|