This
page
is
part
of
the
FHIR
Specification
v6.0.0-ballot3:
v6.0.0-ballot4:
Release
6
Ballot
(3rd
Draft)
(1st
Full
Ballot)
(see
Ballot
Notes
).
The
current
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
for
published
versions
Responsible
Owner:
Orders
and
Observations
Work
Group
|
|
Security Category : Patient | Compartments : Encounter , Group , Patient , Practitioner , RelatedPerson |
A record of intake by a patient. A NutritionIntake may indicate that the patient may be consuming the food (i.e., solid and/or liquid), breastmilk, infant formula, supplements, enteral formula now or has consumed it in the past. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay or through an app that tracks food (i.e., solid and/or liquid), breastmilk, infant formula, supplements, enteral formula consumed. The consumption information may come from sources such as the patient's memory, from a nutrition label, or from a clinician documenting observed intake.
Note to Balloters: To ensure this resource is ready for Normative status, we are seeking ballot comment on the substantive content. The key changes made since R5 include:
- Removed the instantiates workflow elements NutritionIntake.instantiatesCanonical and NutritionIntake.instantiatesUri and advise implementers to use the workflow instantiates extensions
- Consolidated NutritionIntake.consumedItem and NutritionIntake.ingredientLabel into a NutritionIntake.nutritionItem backbone
- The nutritionintake-status-reason code system used in NutritionIntake.statusReason is currently defined in the FHIR specification, but is expected to be moved to HL7 Terminology
(THO).
Note to Implementers: For an overview of this resource and others in the Nutrition domain, also see the module page .
This
resource
is
an
event
resource
from
a
FHIR
workflow
perspective
-
see
Workflow
.
It
is
the
intent
of
the
Orders
and
Observation
Workgroup
to
align
this
resource
with
the
workflow
pattern
for
event
resources
.
The
NutritionIntake
resource,
in
conjunction
with
the
NutritionProduct
resource,
is
utilized
to
capture
details
about
the
consumption
of
foods
(i.e.,
solid
and/or
liquid),
supplements,
enteral
nutrition,
and
infant
formula.
Dietitians
and
other
practitioners
use
the
data
to
calculate
how
much
nutrition
a
patient
has
taken
in.
NutritionIntake
represents
the
event
of
consuming
food
(i.e.
solid
and/or
liquid),
etc.
and
NutritionProduct
represents
the
actual
food
and
formula
items.
NutritionIntake can also be used to record a person’s intake through the use of food tracking apps (e.g.MyFitnessPal), inpatient hospital consumption or administration, or a student’s meal consumption in a school district.
NutritionIntake can be utilized in many environments where food is served or consumed: hospitals/acute care, meal tracking systems, enteral or supplement in a home setting, outpatient settings, long-term care, etc. NutritionIntake should be general enough to capture intake regardless of country or region.
Parenteral nutrition is out of scope as this ordering is handled through MedicationRequest, thus administration of parenteral nutrition should also be captured through MedicationAdministration.
As a dietitian, it is important to be able to know what a person is consuming and/or administered to assess the adequacy of the patient’s intake. Capturing a patient’s intake is important to establish a baseline, determine care, track trends, and see improvement in that patient. Dietitians might use intake data to see patterns, such as when a diabetic patient’s blood glucose is consistently high given the distribution of carbohydrates. Other practitioners have the need to monitor intake as well; for example, a nurse might need to know intake for administering insulin prior to meals, a speech therapist needs this information for ensuring safe administration of food, or a physician may need to ensure a patient fluid restriction is consistent with recommendations.
Having intake documented within its own resource allows for consistency in documentation across multiple disciplines and settings. In some instances, the Observation resource has been extended to capture intake; while this allows for a quick way to document intake, the Observation resource does not provide all the detail necessary, such as capturing energy and nutrients (including vitamins, minerals, carbohydrates, etc.). Previous implementation attempts of using the Observation resource have noted this is cumbersome and has required too many extensions without being able to document all the necessary details tied to ingredients in food (i.e., solid and/or liquid) products.
Note to Balloters: The nutritionintake-status-reason code system used in NutritionIntake.statusReason is currently defined in the FHIR specification, but is expected to be moved to HL7 Terminology
(THO).
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
Filter:
|
|---|---|---|---|---|
|
|
DomainResource |
Record
of
intake
by
a
patient
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
External
identifier
|
|
Σ | 0..* | Reference ( NutritionOrder | CarePlan | ServiceRequest ) |
Fulfils
plan,
proposal
or
order
|
|
Σ | 0..* | Reference ( NutritionIntake | Procedure | Observation ) |
Part
of
referenced
event
|
|
?! Σ | 1..1 | code |
preparation
|
in-progress
|
not-done
|
on-hold
|
stopped
|
completed
|
entered-in-error
|
unknown
Binding: EventStatus ( Required ) |
|
0..* | CodeableConcept |
Reason
for
current
status
Binding: Nutrition Intake Status Reason ( Example ) |
|
|
Σ | 0..1 | CodeableConcept |
Code
representing
an
overall
type
of
nutrition
intake
Binding: Diet Codes ( Preferred ) |
|
Σ | 1..1 | Reference ( Patient | Group ) |
Who
is/was
consuming
the
food
(i.e.
solid
and/or
liquid)
|
|
Σ | 0..1 | Reference ( Encounter ) |
Encounter
associated
with
NutritionIntake
|
|
Σ | 0..1 |
The
date/time
or
interval
when
the
food
(i.e.
solid
and/or
liquid)
is/was
consumed
|
|
|
dateTime | |||
|
Period | |||
|
Σ | 0..1 | dateTime |
When
the
intake
was
recorded
|
|
0..1 |
Indicates
if
this
is
a
reported
rather
than
a
primary
record.
Can
also
indicate
the
source
that
provided
the
information
about
the
consumption
|
||
|
boolean | |||
|
Reference ( Patient | RelatedPerson | Practitioner | PractitionerRole | Organization | Group ) | |||
|
C | 0..* | BackboneElement |
The
nutrition
product
intended
for
consumption
and/or
administration
+ Rule: If nutritionItem is present then SHALL have at least one of nutritionItem.type or nutritionItem.nutritionProduct[x] |
|
Σ | 0..1 | CodeableConcept |
The
type
of
food
(i.e.
solid
or
liquid)
product
Binding: Food Type Codes ( Example ) |
|
Σ | 0..1 | CodeableReference ( NutritionProduct ) |
A
product
used
for
nutritional
purposes
(e.g.
food
or
supplement)
Binding: Types of Edible Substances ( Preferred ) |
|
0..* | BackboneElement |
What
nutrition
item
was
consumed
|
|
|
0..1 | Timing |
Scheduled
frequency
of
consumption
|
|
|
Σ | 0..1 | SimpleQuantity |
Quantity
of
the
specified
food
(i.e.
solid
and/or
liquid)
|
|
Σ | 0..1 |
Rate
of
enteral
feeding
administration
|
|
|
Quantity | |||
|
Ratio | |||
|
0..* | BackboneElement |
Nutrients
and/or
energy
contained
in
the
intake
|
|
|
1..1 |
CodeableReference
(
|
Type
of
nutrient
consumed
in
the
intake
Binding: Nutrient Codes ( Example ) |
|
|
1..1 | SimpleQuantity |
Total
amount
of
nutrient
consumed
|
|
|
0..1 | SimpleQuantity |
Total
energy
consumed
in
kilocalories
or
kilojoules
|
|
|
0..* | BackboneElement |
What
nutrition
item
was
not
consumed
|
|
|
0..1 | CodeableConcept |
Reason
the
nutrition
item
was
not
consumed
Binding: Reasons for why a food item was not consumed ( Example ) |
|
|
0..1 | Timing |
The
intended
frequency
of
consumption
that
was
not
followed
|
|
|
Σ | 0..1 | SimpleQuantity |
Quantity
of
the
specified
food
(i.e.
solid
and/or
liquid)
that
was
not
consumed
|
|
0..* | BackboneElement |
Who
or
what
performed
the
intake
and
how
they
were
involved
|
|
|
0..1 | CodeableConcept |
Type
of
performer
Binding: Procedure Performer Role Codes ( Example ) |
|
|
1..1 | Reference ( Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | Group ) |
Who
or
what
performed
the
intake
|
|
|
0..1 | Reference ( Location ) |
Where
the
intake
occurred
|
|
|
0..* | Reference ( Any ) |
Additional
supporting
information
|
|
|
0..* | CodeableReference ( Condition | Observation | DiagnosticReport | DocumentReference ) |
Reason
for
why
the
food
(i.e.
solid
and/or
liquid)
is
/was
consumed
Binding: Condition/Problem/Diagnosis Codes ( Example ) |
|
|
0..* | Annotation |
Further
information
about
the
consumption
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
UML Diagram ( Legend )
XML Template
<NutritionIntake xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier External identifier --></identifier> <basedOn><!-- 0..* Reference(CarePlan|NutritionOrder|ServiceRequest) Fulfils plan, proposal or order --></basedOn> <partOf><!-- 0..* Reference(NutritionIntake|Observation|Procedure) Part of referenced event --></partOf> <status value="[code]"/><!-- 1..1 preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown --> <statusReason><!-- 0..* CodeableConcept Reason for current status --></statusReason> <code><!-- 0..1 CodeableConcept Code representing an overall type of nutrition intake --></code> <subject><!-- 1..1 Reference(Group|Patient) Who is/was consuming the food (i.e. solid and/or liquid) --></subject> <encounter><!-- 0..1 Reference(Encounter) Encounter associated with NutritionIntake --></encounter> <occurrence[x]><!-- 0..1 dateTime|Period The date/time or interval when the food (i.e. solid and/or liquid) is/was consumed --></occurrence[x]> <recorded value="[dateTime]"/><!-- 0..1 When the intake was recorded --> <reported[x]><!-- 0..1 boolean|Reference(Group|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) Indicates if this is a reported rather than a primary record. Can also indicate the source that provided the information about the consumption --></reported[x]> <nutritionItem> <!-- 0..* The nutrition product intended for consumption and/or administration --> <type><!-- 0..1 CodeableConcept The type of food (i.e. solid or liquid) product --></type> <nutritionProduct><!-- 0..1 CodeableReference(NutritionProduct) A product used for nutritional purposes (e.g. food or supplement) --></nutritionProduct> <consumedItem> <!-- 0..* What nutrition item was consumed --> <schedule><!-- 0..1 Timing Scheduled frequency of consumption --></schedule> <amount><!-- 0..1 Quantity(SimpleQuantity) Quantity of the specified food (i.e. solid and/or liquid) --></amount> <rate[x]><!-- 0..1 Quantity|Ratio Rate of enteral feeding administration --></rate[x]> <totalIntake> <!-- 0..* Nutrients and/or energy contained in the intake -->
<</nutrient><nutrient><!-- 1..1 CodeableReference(SubstanceDefinition) Type of nutrient consumed in the intake --></nutrient> <amount><!-- 1..1 Quantity(SimpleQuantity) Total amount of nutrient consumed --></amount> <energy><!-- 0..1 Quantity(SimpleQuantity) Total energy consumed in kilocalories or kilojoules --></energy> </totalIntake> </consumedItem> <notConsumedItem> <!-- 0..* What nutrition item was not consumed --> <reason><!-- 0..1 CodeableConcept Reason the nutrition item was not consumed --></reason> <schedule><!-- 0..1 Timing The intended frequency of consumption that was not followed --></schedule> <amount><!-- 0..1 Quantity(SimpleQuantity) Quantity of the specified food (i.e. solid and/or liquid) that was not consumed --></amount> </notConsumedItem> </nutritionItem> <performer> <!-- 0..* Who or what performed the intake and how they were involved --> <function><!-- 0..1 CodeableConcept Type of performer --></function> <actor><!-- 1..1 Reference(CareTeam|Device|Group|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson) Who or what performed the intake --></actor> </performer> <location><!-- 0..1 Reference(Location) Where the intake occurred --></location> <derivedFrom><!-- 0..* Reference(Any) Additional supporting information --></derivedFrom> <reason><!-- 0..* CodeableReference(Condition|DiagnosticReport|DocumentReference| Observation) Reason for why the food (i.e. solid and/or liquid) is /was consumed --></reason> <note><!-- 0..* Annotation Further information about the consumption --></note> </NutritionIntake>
JSON Template
{
"resourceType" : "NutritionIntake",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // External identifier
"basedOn" : [{ Reference(CarePlan|NutritionOrder|ServiceRequest) }], // Fulfils plan, proposal or order
"partOf" : [{ Reference(NutritionIntake|Observation|Procedure) }], // Part of referenced event
"status" : "<code>", // R! preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
"statusReason" : [{ CodeableConcept }], // Reason for current status
"code" : { CodeableConcept }, // Code representing an overall type of nutrition intake
"subject" : { Reference(Group|Patient) }, // R! Who is/was consuming the food (i.e. solid and/or liquid)
"encounter" : { Reference(Encounter) }, // Encounter associated with NutritionIntake
// occurrence[x]: The date/time or interval when the food (i.e. solid and/or liquid) is/was consumed. One of these 2:
"occurrenceDateTime" : "<dateTime>",
"occurrencePeriod" : { Period },
"recorded" : "<dateTime>", // When the intake was recorded
// reported[x]:
Indicates if this is a reported rather than a primary record. Can also indicate the source that provided the information about the consumption. One of these 2:
"reportedBoolean" : <boolean>,
"reportedReference" : { Reference(Group|Organization|Patient|Practitioner|
PractitionerRole|RelatedPerson) },
"nutritionItem" : [{ // The nutrition product intended for consumption and/or administration
"type" : { CodeableConcept }, // The type of food (i.e. solid or liquid) product
"nutritionProduct" : { CodeableReference(NutritionProduct) }, // A product used for nutritional purposes (e.g. food or supplement)
"consumedItem" : [{ // What nutrition item was consumed
"schedule" : { Timing }, // Scheduled frequency of consumption
"amount" : { Quantity(SimpleQuantity) }, // Quantity of the specified food (i.e. solid and/or liquid)
// rate[x]: Rate of enteral feeding administration. One of these 2:
"rateQuantity" : { Quantity },
"rateRatio" : { Ratio },
"totalIntake" : [{ // Nutrients and/or energy contained in the intake
"
"nutrient" : { CodeableReference(SubstanceDefinition) }, // R! Type of nutrient consumed in the intake
"amount" : { Quantity(SimpleQuantity) }, // R! Total amount of nutrient consumed
"energy" : { Quantity(SimpleQuantity) } // Total energy consumed in kilocalories or kilojoules
}]
}],
"notConsumedItem" : [{ // What nutrition item was not consumed
"reason" : { CodeableConcept }, // Reason the nutrition item was not consumed
"schedule" : { Timing }, // The intended frequency of consumption that was not followed
"amount" : { Quantity(SimpleQuantity) } // Quantity of the specified food (i.e. solid and/or liquid) that was not consumed
}]
}],
"performer" : [{ // Who or what performed the intake and how they were involved
"function" : { CodeableConcept }, // Type of performer
"actor" : { Reference(CareTeam|Device|Group|Organization|Patient|
Practitioner|PractitionerRole|RelatedPerson) } // R! Who or what performed the intake
}],
"location" : { Reference(Location) }, // Where the intake occurred
"derivedFrom" : [{ Reference(Any) }], // Additional supporting information
"reason" : [{ CodeableReference(Condition|DiagnosticReport|DocumentReference|
Observation) }], // Reason for why the food (i.e. solid and/or liquid) is /was consumed
"note" : [{ Annotation }] // Further information about the consumption
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:NutritionIntake; fhir:nodeRole fhir:treeRoot; # if this is the parser root
# 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:identifier ( [ Identifier ] ... ) ; # 0..* External identifier fhir:basedOn ( [ Reference(CarePlan|NutritionOrder|ServiceRequest) ] ... ) ; # 0..* Fulfils plan, proposal or order fhir:partOf ( [ Reference(NutritionIntake|Observation|Procedure) ] ... ) ; # 0..* Part of referenced event fhir:status [ code ] ; # 1..1 preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown fhir:statusReason ( [ CodeableConcept ] ... ) ; # 0..* Reason for current status fhir:code [ CodeableConcept ] ; # 0..1 Code representing an overall type of nutrition intake fhir:subject [ Reference(Group|Patient) ] ; # 1..1 Who is/was consuming the food (i.e. solid and/or liquid) fhir:encounter [ Reference(Encounter) ] ; # 0..1 Encounter associated with NutritionIntake # occurrence[x] : 0..1 The date/time or interval when the food (i.e. solid and/or liquid) is/was consumed. One of these 2fhir: ]fhir:occurrence [ a fhir:DateTime ; dateTime ] fhir:occurrence [ a fhir:Period ; Period ] fhir:recorded [ dateTime ] ; # 0..1 When the intake was recorded # reported[x] : 0..1 Indicates if this is a reported rather than a primary record. Can also indicate the source that provided the information about the consumption. One of these 2fhir: ]fhir:reported [ a fhir:Boolean ; boolean ] fhir:reported [ a fhir:Reference ; Reference(Group|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] fhir:nutritionItem ( [ # 0..* The nutrition product intended for consumption and/or administration fhir:type [ CodeableConcept ] ; # 0..1 The type of food (i.e. solid or liquid) product fhir:nutritionProduct [ CodeableReference(NutritionProduct) ] ; # 0..1 A product used for nutritional purposes (e.g. food or supplement) fhir:consumedItem ( [ # 0..* What nutrition item was consumed fhir:schedule [ Timing ] ; # 0..1 Scheduled frequency of consumption fhir:amount [ Quantity(SimpleQuantity) ] ; # 0..1 Quantity of the specified food (i.e. solid and/or liquid) # rate[x] : 0..1 Rate of enteral feeding administration. One of these 2 fhir:rate [ a fhir:Quantity ; Quantity ] fhir:rate [ a fhir:Ratio ; Ratio ] fhir:totalIntake ( [ # 0..* Nutrients and/or energy contained in the intakefhir:fhir:nutrient [ CodeableReference(SubstanceDefinition) ] ; # 1..1 Type of nutrient consumed in the intake fhir:amount [ Quantity(SimpleQuantity) ] ; # 1..1 Total amount of nutrient consumed fhir:energy [ Quantity(SimpleQuantity) ] ; # 0..1 Total energy consumed in kilocalories or kilojoules ] ... ) ; ] ... ) ; fhir:notConsumedItem ( [ # 0..* What nutrition item was not consumed fhir:reason [ CodeableConcept ] ; # 0..1 Reason the nutrition item was not consumed fhir:schedule [ Timing ] ; # 0..1 The intended frequency of consumption that was not followed fhir:amount [ Quantity(SimpleQuantity) ] ; # 0..1 Quantity of the specified food (i.e. solid and/or liquid) that was not consumed ] ... ) ; ] ... ) ; fhir:performer ( [ # 0..* Who or what performed the intake and how they were involved fhir:function [ CodeableConcept ] ; # 0..1 Type of performer fhir:actor [ Reference(CareTeam|Device|Group|Organization|Patient|Practitioner|PractitionerRole| RelatedPerson) ] ; # 1..1 Who or what performed the intake ] ... ) ; fhir:location [ Reference(Location) ] ; # 0..1 Where the intake occurred fhir:derivedFrom ( [ Reference(Any) ] ... ) ; # 0..* Additional supporting information fhir:reason ( [ CodeableReference(Condition|DiagnosticReport|DocumentReference|Observation) ] ... ) ; # 0..* Reason for why the food (i.e. solid and/or liquid) is /was consumed fhir:note ( [ Annotation ] ... ) ; # 0..* Further information about the consumption ]
Changes
from
both
R4
and
R5
to
R6
| NutritionIntake | |
| NutritionIntake.nutritionItem |
|
| NutritionIntake.nutritionItem.type |
|
| NutritionIntake.nutritionItem.nutritionProduct |
|
| NutritionIntake.nutritionItem.consumedItem |
|
| NutritionIntake.nutritionItem.consumedItem.schedule |
|
| NutritionIntake.nutritionItem.consumedItem.amount |
|
| NutritionIntake.nutritionItem.consumedItem.rate[x] |
|
| NutritionIntake.nutritionItem.consumedItem.totalIntake |
|
| NutritionIntake.nutritionItem.consumedItem.totalIntake.nutrient |
|
| NutritionIntake.nutritionItem.consumedItem.totalIntake.amount |
|
| NutritionIntake.nutritionItem.consumedItem.totalIntake.energy |
|
| NutritionIntake.nutritionItem.notConsumedItem |
|
| NutritionIntake.nutritionItem.notConsumedItem.reason |
|
| NutritionIntake.nutritionItem.notConsumedItem.schedule |
|
| NutritionIntake.nutritionItem.notConsumedItem.amount |
|
| NutritionIntake.performer.actor |
|
| NutritionIntake.instantiatesCanonical |
|
| NutritionIntake.instantiatesUri |
|
| NutritionIntake.consumedItem |
|
| NutritionIntake.ingredientLabel |
|
Changes from R4B to R6
This resource did not exist in Release R4B
Changes from R4 to R6
This resource did not exist in Release R4
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:
|
|---|---|---|---|---|
|
|
DomainResource |
Record
of
intake
by
a
patient
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
External
identifier
|
|
Σ | 0..* | Reference ( NutritionOrder | CarePlan | ServiceRequest ) |
Fulfils
plan,
proposal
or
order
|
|
Σ | 0..* | Reference ( NutritionIntake | Procedure | Observation ) |
Part
of
referenced
event
|
|
?! Σ | 1..1 | code |
preparation
|
in-progress
|
not-done
|
on-hold
|
stopped
|
completed
|
entered-in-error
|
unknown
Binding: EventStatus ( Required ) |
|
0..* | CodeableConcept |
Reason
for
current
status
Binding: Nutrition Intake Status Reason ( Example ) |
|
|
Σ | 0..1 | CodeableConcept |
Code
representing
an
overall
type
of
nutrition
intake
Binding: Diet Codes ( Preferred ) |
|
Σ | 1..1 | Reference ( Patient | Group ) |
Who
is/was
consuming
the
food
(i.e.
solid
and/or
liquid)
|
|
Σ | 0..1 | Reference ( Encounter ) |
Encounter
associated
with
NutritionIntake
|
|
Σ | 0..1 |
The
date/time
or
interval
when
the
food
(i.e.
solid
and/or
liquid)
is/was
consumed
|
|
|
dateTime | |||
|
Period | |||
|
Σ | 0..1 | dateTime |
When
the
intake
was
recorded
|
|
0..1 |
Indicates
if
this
is
a
reported
rather
than
a
primary
record.
Can
also
indicate
the
source
that
provided
the
information
about
the
consumption
|
||
|
boolean | |||
|
Reference ( Patient | RelatedPerson | Practitioner | PractitionerRole | Organization | Group ) | |||
|
C | 0..* | BackboneElement |
The
nutrition
product
intended
for
consumption
and/or
administration
+ Rule: If nutritionItem is present then SHALL have at least one of nutritionItem.type or nutritionItem.nutritionProduct[x] |
|
Σ | 0..1 | CodeableConcept |
The
type
of
food
(i.e.
solid
or
liquid)
product
Binding: Food Type Codes ( Example ) |
|
Σ | 0..1 | CodeableReference ( NutritionProduct ) |
A
product
used
for
nutritional
purposes
(e.g.
food
or
supplement)
Binding: Types of Edible Substances ( Preferred ) |
|
0..* | BackboneElement |
What
nutrition
item
was
consumed
|
|
|
0..1 | Timing |
Scheduled
frequency
of
consumption
|
|
|
Σ | 0..1 | SimpleQuantity |
Quantity
of
the
specified
food
(i.e.
solid
and/or
liquid)
|
|
Σ | 0..1 |
Rate
of
enteral
feeding
administration
|
|
|
Quantity | |||
|
Ratio | |||
|
0..* | BackboneElement |
Nutrients
and/or
energy
contained
in
the
intake
|
|
|
1..1 |
CodeableReference
(
|
Type
of
nutrient
consumed
in
the
intake
Binding: Nutrient Codes ( Example ) |
|
|
1..1 | SimpleQuantity |
Total
amount
of
nutrient
consumed
|
|
|
0..1 | SimpleQuantity |
Total
energy
consumed
in
kilocalories
or
kilojoules
|
|
|
0..* | BackboneElement |
What
nutrition
item
was
not
consumed
|
|
|
0..1 | CodeableConcept |
Reason
the
nutrition
item
was
not
consumed
Binding: Reasons for why a food item was not consumed ( Example ) |
|
|
0..1 | Timing |
The
intended
frequency
of
consumption
that
was
not
followed
|
|
|
Σ | 0..1 | SimpleQuantity |
Quantity
of
the
specified
food
(i.e.
solid
and/or
liquid)
that
was
not
consumed
|
|
0..* | BackboneElement |
Who
or
what
performed
the
intake
and
how
they
were
involved
|
|
|
0..1 | CodeableConcept |
Type
of
performer
Binding: Procedure Performer Role Codes ( Example ) |
|
|
1..1 | Reference ( Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | Group ) |
Who
or
what
performed
the
intake
|
|
|
0..1 | Reference ( Location ) |
Where
the
intake
occurred
|
|
|
0..* | Reference ( Any ) |
Additional
supporting
information
|
|
|
0..* | CodeableReference ( Condition | Observation | DiagnosticReport | DocumentReference ) |
Reason
for
why
the
food
(i.e.
solid
and/or
liquid)
is
/was
consumed
Binding: Condition/Problem/Diagnosis Codes ( Example ) |
|
|
0..* | Annotation |
Further
information
about
the
consumption
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
XML Template
<NutritionIntake xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier External identifier --></identifier> <basedOn><!-- 0..* Reference(CarePlan|NutritionOrder|ServiceRequest) Fulfils plan, proposal or order --></basedOn> <partOf><!-- 0..* Reference(NutritionIntake|Observation|Procedure) Part of referenced event --></partOf> <status value="[code]"/><!-- 1..1 preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown --> <statusReason><!-- 0..* CodeableConcept Reason for current status --></statusReason> <code><!-- 0..1 CodeableConcept Code representing an overall type of nutrition intake --></code> <subject><!-- 1..1 Reference(Group|Patient) Who is/was consuming the food (i.e. solid and/or liquid) --></subject> <encounter><!-- 0..1 Reference(Encounter) Encounter associated with NutritionIntake --></encounter> <occurrence[x]><!-- 0..1 dateTime|Period The date/time or interval when the food (i.e. solid and/or liquid) is/was consumed --></occurrence[x]> <recorded value="[dateTime]"/><!-- 0..1 When the intake was recorded --> <reported[x]><!-- 0..1 boolean|Reference(Group|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) Indicates if this is a reported rather than a primary record. Can also indicate the source that provided the information about the consumption --></reported[x]> <nutritionItem> <!-- 0..* The nutrition product intended for consumption and/or administration --> <type><!-- 0..1 CodeableConcept The type of food (i.e. solid or liquid) product --></type> <nutritionProduct><!-- 0..1 CodeableReference(NutritionProduct) A product used for nutritional purposes (e.g. food or supplement) --></nutritionProduct> <consumedItem> <!-- 0..* What nutrition item was consumed --> <schedule><!-- 0..1 Timing Scheduled frequency of consumption --></schedule> <amount><!-- 0..1 Quantity(SimpleQuantity) Quantity of the specified food (i.e. solid and/or liquid) --></amount> <rate[x]><!-- 0..1 Quantity|Ratio Rate of enteral feeding administration --></rate[x]> <totalIntake> <!-- 0..* Nutrients and/or energy contained in the intake -->
<</nutrient><nutrient><!-- 1..1 CodeableReference(SubstanceDefinition) Type of nutrient consumed in the intake --></nutrient> <amount><!-- 1..1 Quantity(SimpleQuantity) Total amount of nutrient consumed --></amount> <energy><!-- 0..1 Quantity(SimpleQuantity) Total energy consumed in kilocalories or kilojoules --></energy> </totalIntake> </consumedItem> <notConsumedItem> <!-- 0..* What nutrition item was not consumed --> <reason><!-- 0..1 CodeableConcept Reason the nutrition item was not consumed --></reason> <schedule><!-- 0..1 Timing The intended frequency of consumption that was not followed --></schedule> <amount><!-- 0..1 Quantity(SimpleQuantity) Quantity of the specified food (i.e. solid and/or liquid) that was not consumed --></amount> </notConsumedItem> </nutritionItem> <performer> <!-- 0..* Who or what performed the intake and how they were involved --> <function><!-- 0..1 CodeableConcept Type of performer --></function> <actor><!-- 1..1 Reference(CareTeam|Device|Group|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson) Who or what performed the intake --></actor> </performer> <location><!-- 0..1 Reference(Location) Where the intake occurred --></location> <derivedFrom><!-- 0..* Reference(Any) Additional supporting information --></derivedFrom> <reason><!-- 0..* CodeableReference(Condition|DiagnosticReport|DocumentReference| Observation) Reason for why the food (i.e. solid and/or liquid) is /was consumed --></reason> <note><!-- 0..* Annotation Further information about the consumption --></note> </NutritionIntake>
JSON Template
{
"resourceType" : "NutritionIntake",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // External identifier
"basedOn" : [{ Reference(CarePlan|NutritionOrder|ServiceRequest) }], // Fulfils plan, proposal or order
"partOf" : [{ Reference(NutritionIntake|Observation|Procedure) }], // Part of referenced event
"status" : "<code>", // R! preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
"statusReason" : [{ CodeableConcept }], // Reason for current status
"code" : { CodeableConcept }, // Code representing an overall type of nutrition intake
"subject" : { Reference(Group|Patient) }, // R! Who is/was consuming the food (i.e. solid and/or liquid)
"encounter" : { Reference(Encounter) }, // Encounter associated with NutritionIntake
// occurrence[x]: The date/time or interval when the food (i.e. solid and/or liquid) is/was consumed. One of these 2:
"occurrenceDateTime" : "<dateTime>",
"occurrencePeriod" : { Period },
"recorded" : "<dateTime>", // When the intake was recorded
// reported[x]:
Indicates if this is a reported rather than a primary record. Can also indicate the source that provided the information about the consumption. One of these 2:
"reportedBoolean" : <boolean>,
"reportedReference" : { Reference(Group|Organization|Patient|Practitioner|
PractitionerRole|RelatedPerson) },
"nutritionItem" : [{ // The nutrition product intended for consumption and/or administration
"type" : { CodeableConcept }, // The type of food (i.e. solid or liquid) product
"nutritionProduct" : { CodeableReference(NutritionProduct) }, // A product used for nutritional purposes (e.g. food or supplement)
"consumedItem" : [{ // What nutrition item was consumed
"schedule" : { Timing }, // Scheduled frequency of consumption
"amount" : { Quantity(SimpleQuantity) }, // Quantity of the specified food (i.e. solid and/or liquid)
// rate[x]: Rate of enteral feeding administration. One of these 2:
"rateQuantity" : { Quantity },
"rateRatio" : { Ratio },
"totalIntake" : [{ // Nutrients and/or energy contained in the intake
"
"nutrient" : { CodeableReference(SubstanceDefinition) }, // R! Type of nutrient consumed in the intake
"amount" : { Quantity(SimpleQuantity) }, // R! Total amount of nutrient consumed
"energy" : { Quantity(SimpleQuantity) } // Total energy consumed in kilocalories or kilojoules
}]
}],
"notConsumedItem" : [{ // What nutrition item was not consumed
"reason" : { CodeableConcept }, // Reason the nutrition item was not consumed
"schedule" : { Timing }, // The intended frequency of consumption that was not followed
"amount" : { Quantity(SimpleQuantity) } // Quantity of the specified food (i.e. solid and/or liquid) that was not consumed
}]
}],
"performer" : [{ // Who or what performed the intake and how they were involved
"function" : { CodeableConcept }, // Type of performer
"actor" : { Reference(CareTeam|Device|Group|Organization|Patient|
Practitioner|PractitionerRole|RelatedPerson) } // R! Who or what performed the intake
}],
"location" : { Reference(Location) }, // Where the intake occurred
"derivedFrom" : [{ Reference(Any) }], // Additional supporting information
"reason" : [{ CodeableReference(Condition|DiagnosticReport|DocumentReference|
Observation) }], // Reason for why the food (i.e. solid and/or liquid) is /was consumed
"note" : [{ Annotation }] // Further information about the consumption
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:NutritionIntake; fhir:nodeRole fhir:treeRoot; # if this is the parser root
# 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:identifier ( [ Identifier ] ... ) ; # 0..* External identifier fhir:basedOn ( [ Reference(CarePlan|NutritionOrder|ServiceRequest) ] ... ) ; # 0..* Fulfils plan, proposal or order fhir:partOf ( [ Reference(NutritionIntake|Observation|Procedure) ] ... ) ; # 0..* Part of referenced event fhir:status [ code ] ; # 1..1 preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown fhir:statusReason ( [ CodeableConcept ] ... ) ; # 0..* Reason for current status fhir:code [ CodeableConcept ] ; # 0..1 Code representing an overall type of nutrition intake fhir:subject [ Reference(Group|Patient) ] ; # 1..1 Who is/was consuming the food (i.e. solid and/or liquid) fhir:encounter [ Reference(Encounter) ] ; # 0..1 Encounter associated with NutritionIntake # occurrence[x] : 0..1 The date/time or interval when the food (i.e. solid and/or liquid) is/was consumed. One of these 2fhir: ]fhir:occurrence [ a fhir:DateTime ; dateTime ] fhir:occurrence [ a fhir:Period ; Period ] fhir:recorded [ dateTime ] ; # 0..1 When the intake was recorded # reported[x] : 0..1 Indicates if this is a reported rather than a primary record. Can also indicate the source that provided the information about the consumption. One of these 2fhir: ]fhir:reported [ a fhir:Boolean ; boolean ] fhir:reported [ a fhir:Reference ; Reference(Group|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] fhir:nutritionItem ( [ # 0..* The nutrition product intended for consumption and/or administration fhir:type [ CodeableConcept ] ; # 0..1 The type of food (i.e. solid or liquid) product fhir:nutritionProduct [ CodeableReference(NutritionProduct) ] ; # 0..1 A product used for nutritional purposes (e.g. food or supplement) fhir:consumedItem ( [ # 0..* What nutrition item was consumed fhir:schedule [ Timing ] ; # 0..1 Scheduled frequency of consumption fhir:amount [ Quantity(SimpleQuantity) ] ; # 0..1 Quantity of the specified food (i.e. solid and/or liquid) # rate[x] : 0..1 Rate of enteral feeding administration. One of these 2 fhir:rate [ a fhir:Quantity ; Quantity ] fhir:rate [ a fhir:Ratio ; Ratio ] fhir:totalIntake ( [ # 0..* Nutrients and/or energy contained in the intakefhir:fhir:nutrient [ CodeableReference(SubstanceDefinition) ] ; # 1..1 Type of nutrient consumed in the intake fhir:amount [ Quantity(SimpleQuantity) ] ; # 1..1 Total amount of nutrient consumed fhir:energy [ Quantity(SimpleQuantity) ] ; # 0..1 Total energy consumed in kilocalories or kilojoules ] ... ) ; ] ... ) ; fhir:notConsumedItem ( [ # 0..* What nutrition item was not consumed fhir:reason [ CodeableConcept ] ; # 0..1 Reason the nutrition item was not consumed fhir:schedule [ Timing ] ; # 0..1 The intended frequency of consumption that was not followed fhir:amount [ Quantity(SimpleQuantity) ] ; # 0..1 Quantity of the specified food (i.e. solid and/or liquid) that was not consumed ] ... ) ; ] ... ) ; fhir:performer ( [ # 0..* Who or what performed the intake and how they were involved fhir:function [ CodeableConcept ] ; # 0..1 Type of performer fhir:actor [ Reference(CareTeam|Device|Group|Organization|Patient|Practitioner|PractitionerRole| RelatedPerson) ] ; # 1..1 Who or what performed the intake ] ... ) ; fhir:location [ Reference(Location) ] ; # 0..1 Where the intake occurred fhir:derivedFrom ( [ Reference(Any) ] ... ) ; # 0..* Additional supporting information fhir:reason ( [ CodeableReference(Condition|DiagnosticReport|DocumentReference|Observation) ] ... ) ; # 0..* Reason for why the food (i.e. solid and/or liquid) is /was consumed fhir:note ( [ Annotation ] ... ) ; # 0..* Further information about the consumption ]
Changes
from
both
R4
and
R5
to
R6
| NutritionIntake | |
| NutritionIntake.nutritionItem |
|
| NutritionIntake.nutritionItem.type |
|
| NutritionIntake.nutritionItem.nutritionProduct |
|
| NutritionIntake.nutritionItem.consumedItem |
|
| NutritionIntake.nutritionItem.consumedItem.schedule |
|
| NutritionIntake.nutritionItem.consumedItem.amount |
|
| NutritionIntake.nutritionItem.consumedItem.rate[x] |
|
| NutritionIntake.nutritionItem.consumedItem.totalIntake |
|
| NutritionIntake.nutritionItem.consumedItem.totalIntake.nutrient |
|
| NutritionIntake.nutritionItem.consumedItem.totalIntake.amount |
|
| NutritionIntake.nutritionItem.consumedItem.totalIntake.energy |
|
| NutritionIntake.nutritionItem.notConsumedItem |
|
| NutritionIntake.nutritionItem.notConsumedItem.reason |
|
| NutritionIntake.nutritionItem.notConsumedItem.schedule |
|
| NutritionIntake.nutritionItem.notConsumedItem.amount |
|
| NutritionIntake.performer.actor |
|
| NutritionIntake.instantiatesCanonical |
|
| NutritionIntake.instantiatesUri |
|
| NutritionIntake.consumedItem |
|
| NutritionIntake.ingredientLabel |
|
Changes from R4B to R6
This resource did not exist in Release R4B
Changes from R4 to R6
This resource did not exist in Release R4
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 ) + see the extensions , the spreadsheet version & the dependency analysis
| Path | ValueSet | Type | Documentation |
|---|---|---|---|
| NutritionIntake.status | EventStatus | Required |
Codes identifying the lifecycle stage of an event. |
| NutritionIntake.statusReason | NutritionIntakeStatusReason | Example |
This value set represents codes indicating reasons for the status of the nutrition intake. |
| NutritionIntake.code | DietCodes | Preferred |
Codes
that
can
be
used
to
indicate
the
type
of
food
being
ordered
for
a
patient.
It
includes
codes
from
SNOMED
CT
|
| NutritionIntake.nutritionItem.type | FoodTypeCodes | Example |
This
value
set
represents
codes
for
types
of
foods
and
is
provided
as
a
suggestive
example.
It
include
codes
from
SNOMED
CT
|
| NutritionIntake.nutritionItem.nutritionProduct | TypesOfEdibleSubstances | Preferred |
This
value
set
represents
codes
for
types
of
edible
substances.
It
include
codes
from
SNOMED
CT
|
| NutritionIntake.nutritionItem.consumedItem.totalIntake.nutrient | NutrientCodes | Example |
NutrientModifier
:
Codes
for
types
of
nutrients
that
are
being
modified
such
as
carbohydrate
or
sodium.
This
value
set
includes
codes
from
SNOMED
CT
|
| NutritionIntake.nutritionItem.notConsumedItem.reason | ReasonsFoodItemNotConsumed | Example |
This
value
set
represents
codes
for
types
of
edible
substances
and
is
provided
as
a
suggestive
example.
It
include
codes
from
SNOMED
CT
|
| NutritionIntake.performer.function | ProcedurePerformerRoleCodes | Example |
This example value set defines the set of codes that can be used to indicate a role of a procedure performer. |
| NutritionIntake.reason | ConditionProblemDiagnosisCodes | Example |
Example value set for Condition/Problem/Diagnosis codes. |
| UniqueKey | Level | Location | Description | Expression |
nin-1
|
Rule | NutritionIntake.nutritionItem | If nutritionItem is present then SHALL have at least one of nutritionItem.type or nutritionItem.nutritionProduct[x] | (type.exists() or nutritionProduct.exists()) |
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 |
| code | token | Returns statements of this code of NutritionIntake | NutritionIntake.code |
|
| date | date | Date when patient was taking (or not taking) the medication | NutritionIntake.occurrence.ofType(dateTime) | NutritionIntake.occurrence.ofType(Period) |
|
| encounter | reference | Returns statements for a specific encounter |
NutritionIntake.encounter
( Encounter ) |
|
| identifier | token | Return statements with this external identifier | NutritionIntake.identifier |
|
| nutrition | token | Return intakes for a specific consumed item | NutritionIntake.nutritionItem.nutritionProduct.concept | |
| patient | reference | Returns statements for a specific patient. |
NutritionIntake.subject.where(resolve()
is
Patient)
( Patient ) |
|
| source | reference | Who or where the information in the statement came from |
(NutritionIntake.reported
as
Reference)
( Practitioner , Group , Organization , Patient , PractitionerRole , RelatedPerson ) |
|
| status | token | Return statements that match the given status | NutritionIntake.status | |
| subject | reference | The identity of a patient, animal or group to list statements for |
NutritionIntake.subject
( Group , Patient ) |