Administration
This
page
is
part
of
the
FHIR
Specification
(v5.0.0:
R5
-
STU
v6.0.0-ballot1:
Release
6
Ballot
(1st
Draft)
(see
Ballot
Notes
).
This
is
the
The
current
published
version
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
|
Orders
and
Observations
Work
Group
|
Maturity Level : 1 | Trial Use | Security Category : Business | Compartments : No defined compartments |
A food or supplement that is consumed by patients.
The NutritionProduct resource represents the identification of a food or fluid product consumed by patients. The scope of the NutritionProduct resource includes all the products that are understood to be food and beverage products for human consumption.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
NutritionProduct
|
TU | DomainResource |
A
product
used
for
nutritional
purposes
(i.e.
food
or
supplement)
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
code
|
Σ | 0..1 | CodeableConcept |
A
code
that
can
identify
the
detailed
nutrients
and
ingredients
in
a
specific
food
product
Binding: Types of Edible Substances ( Example ) |
status
|
?! Σ | 1..1 | code |
active
|
inactive
|
entered-in-error
Binding: Nutrition Product Status ( Required ) |
|
category
|
Σ | 0..* | CodeableConcept |
Broad
product
groups
or
categories
used
to
classify
the
product,
such
as
Legume
and
Legume
Products,
Beverages,
or
Beef
Products
Binding: Categories of Nutrition Products ( Example ) |
manufacturer
|
Σ | 0..* | Reference ( Organization ) |
Manufacturer,
representative
or
officially
responsible
for
the
product
|
nutrient
|
Σ | 0..* | BackboneElement |
The
product's
nutritional
information
expressed
by
the
nutrients
|
item
|
0..1 | CodeableReference ( Substance ) |
The
(relevant)
nutrients
in
the
product
Binding: Codes for Nutrition Product Nutrients ( Example ) |
|
amount
|
0..* | Ratio |
The
amount
of
nutrient
expressed
in
one
or
more
units:
X
per
pack
/
per
serving
/
per
dose
|
|
|
ingredient
|
0..* | BackboneElement |
Ingredients
contained
in
this
product
|
|
|
item
|
Σ | 1..1 | CodeableReference ( NutritionProduct ) |
The
ingredient
contained
in
the
product
|
|
amount
|
Σ | 0..* | Ratio |
The
amount
of
ingredient
that
is
in
the
product
|
|
knownAllergen
|
0..* | CodeableReference ( Substance ) |
Known
or
suspected
allergens
that
are
a
part
of
this
product
Binding: Codes for Allergen Classes ( Example ) |
|
|
characteristic
|
0..* | BackboneElement |
Specifies
descriptive
properties
of
the
nutrition
product
|
|
|
type
|
1..1 | CodeableConcept |
Code
specifying
the
type
of
characteristic
Binding: Codes for Product Characteristics ( Example ) |
|
value[x]
|
1..1 |
The
value
of
the
characteristic
|
||
valueCodeableConcept
|
CodeableConcept | |||
|
valueString
|
string | |||
|
valueQuantity
|
SimpleQuantity | |||
|
valueBase64Binary
|
base64Binary | |||
|
valueAttachment
|
Attachment | |||
|
valueBoolean
|
boolean | |||
|
instance
|
0..* | BackboneElement |
One
or
several
physical
instances
or
occurrences
of
the
nutrition
product
|
|
|
quantity
|
0..1 | SimpleQuantity |
The
amount
of
items
or
instances
|
|
|
identifier
|
0..* | Identifier |
The
identifier
for
the
physical
instance,
typically
a
serial
number
or
manufacturer
number
|
|
|
name
|
0..1 | string |
The
name
for
the
specific
product
|
|
|
lotNumber
|
0..1 | string |
The
identification
of
the
batch
or
lot
of
the
product
|
|
|
expiry
|
0..1 | dateTime |
The
expiry
date
or
date
and
time
for
the
product
|
|
|
useBy
|
0..1 | dateTime |
The
date
until
which
the
product
is
expected
to
be
good
for
consumption
|
|
|
biologicalSourceEvent
|
0..1 | Identifier |
An
identifier
that
supports
traceability
to
the
event
during
which
material
in
this
product
from
one
or
more
biological
entities
was
obtained
or
pooled
|
|
|
note
|
0..* | Annotation |
Comments
made
about
the
product
|
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
UML Diagram ( Legend )
XML Template
<NutritionProduct xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <code><!-- 0..1 CodeableConcept A code that can identify the detailed nutrients and ingredients in a specific food product --></code> <status value="[code]"/><!-- 1..1 active | inactive | entered-in-error --> <category><!-- 0..* CodeableConcept Broad product groups or categories used to classify the product, such as Legume and Legume Products, Beverages, or Beef Products --></category> <manufacturer><!-- 0..* Reference(Organization) Manufacturer, representative or officially responsible for the product --></manufacturer> <nutrient> <!-- 0..* The product's nutritional information expressed by the nutrients --> <item><!-- 0..1 CodeableReference(Substance) The (relevant) nutrients in the product --></item> <amount><!-- 0..* Ratio The amount of nutrient expressed in one or more units: X per pack / per serving / per dose --></amount> </nutrient> <ingredient> <!-- 0..* Ingredients contained in this product --> <item><!-- 1..1 CodeableReference(NutritionProduct) The ingredient contained in the product --></item> <amount><!-- 0..* Ratio The amount of ingredient that is in the product --></amount> </ingredient> <knownAllergen><!-- 0..* CodeableReference(Substance) Known or suspected allergens that are a part of this product --></knownAllergen> <characteristic> <!-- 0..* Specifies descriptive properties of the nutrition product --> <type><!-- 1..1 CodeableConcept Code specifying the type of characteristic --></type> <value[x]><!-- 1..1 CodeableConcept|string|Quantity(SimpleQuantity)| base64Binary|Attachment|boolean The value of the characteristic --></value[x]> </characteristic> <instance> <!-- 0..* One or several physical instances or occurrences of the nutrition product --> <quantity><!-- 0..1 Quantity(SimpleQuantity) The amount of items or instances --></quantity> <identifier><!-- 0..* Identifier The identifier for the physical instance, typically a serial number or manufacturer number --></identifier> <name value="[string]"/><!-- 0..1 The name for the specific product --> <lotNumber value="[string]"/><!-- 0..1 The identification of the batch or lot of the product --> <expiry value="[dateTime]"/><!-- 0..1 The expiry date or date and time for the product --> <useBy value="[dateTime]"/><!-- 0..1 The date until which the product is expected to be good for consumption --> <biologicalSourceEvent><!-- 0..1 Identifier An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled --></biologicalSourceEvent> </instance> <note><!-- 0..* Annotation Comments made about the product --></note> </NutritionProduct>
JSON Template
{
"resourceType" : "NutritionProduct",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"code" : { CodeableConcept }, // A code that can identify the detailed nutrients and ingredients in a specific food product
"status" : "<code>", // R! active | inactive | entered-in-error
"category" : [{ CodeableConcept }], // Broad product groups or categories used to classify the product, such as Legume and Legume Products, Beverages, or Beef Products
"manufacturer" : [{ Reference(Organization) }], // Manufacturer, representative or officially responsible for the product
"nutrient" : [{ // The product's nutritional information expressed by the nutrients
"item" : { CodeableReference(Substance) }, // The (relevant) nutrients in the product
"amount" : [{ Ratio }] // The amount of nutrient expressed in one or more units: X per pack / per serving / per dose
}],
"ingredient" : [{ // Ingredients contained in this product
"item" : { CodeableReference(NutritionProduct) }, // R! The ingredient contained in the product
"amount" : [{ Ratio }] // The amount of ingredient that is in the product
}],
"knownAllergen" : [{ CodeableReference(Substance) }], // Known or suspected allergens that are a part of this product
"characteristic" : [{ // Specifies descriptive properties of the nutrition product
"type" : { CodeableConcept }, // R! Code specifying the type of characteristic
// value[x]: The value of the characteristic. One of these 6:
"valueCodeableConcept" : { CodeableConcept },
"valueString" : "<string>",
"valueQuantity" : { Quantity(SimpleQuantity) },
"valueBase64Binary" : "<base64Binary>",
"valueAttachment" : { Attachment },
"valueBoolean" : <boolean>
}],
"instance" : [{ // One or several physical instances or occurrences of the nutrition product
"quantity" : { Quantity(SimpleQuantity) }, // The amount of items or instances
"identifier" : [{ Identifier }], // The identifier for the physical instance, typically a serial number or manufacturer number
"name" : "<string>", // The name for the specific product
"lotNumber" : "<string>", // The identification of the batch or lot of the product
"expiry" : "<dateTime>", // The expiry date or date and time for the product
"useBy" : "<dateTime>", // The date until which the product is expected to be good for consumption
"biologicalSourceEvent" : { Identifier } // An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled
}],
"note" : [{ Annotation }] // Comments made about the product
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes from both R4 and R4B
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
|
|---|---|---|---|---|
|
NutritionProduct
|
TU | DomainResource |
A
product
used
for
nutritional
purposes
(i.e.
food
or
supplement)
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
code
|
Σ | 0..1 | CodeableConcept |
A
code
that
can
identify
the
detailed
nutrients
and
ingredients
in
a
specific
food
product
Binding: Types of Edible Substances ( Example ) |
|
status
|
?! Σ | 1..1 | code |
active
|
inactive
|
entered-in-error
Binding: Nutrition Product Status ( Required ) |
|
category
|
Σ | 0..* | CodeableConcept |
Broad
product
groups
or
categories
used
to
classify
the
product,
such
as
Legume
and
Legume
Products,
Beverages,
or
Beef
Products
Binding: Categories of Nutrition Products ( Example ) |
|
manufacturer
|
Σ | 0..* | Reference ( Organization ) |
Manufacturer,
representative
or
officially
responsible
for
the
product
|
|
nutrient
|
Σ | 0..* | BackboneElement |
The
product's
nutritional
information
expressed
by
the
nutrients
|
|
item
|
0..1 | CodeableReference ( Substance ) |
The
(relevant)
nutrients
in
the
product
Binding: Codes for Nutrition Product Nutrients ( Example ) |
|
|
amount
|
0..* | Ratio |
The
amount
of
nutrient
expressed
in
one
or
more
units:
X
per
pack
/
per
serving
/
per
dose
|
|
|
ingredient
|
0..* | BackboneElement |
Ingredients
contained
in
this
product
|
|
|
item
|
Σ | 1..1 | CodeableReference ( NutritionProduct ) |
The
ingredient
contained
in
the
product
|
|
amount
|
Σ | 0..* | Ratio |
The
amount
of
ingredient
that
is
in
the
product
|
|
knownAllergen
|
0..* | CodeableReference ( Substance ) |
Known
or
suspected
allergens
that
are
a
part
of
this
product
Binding: Codes for Allergen Classes ( Example ) |
|
|
characteristic
|
0..* | BackboneElement |
Specifies
descriptive
properties
of
the
nutrition
product
|
|
|
type
|
1..1 | CodeableConcept |
Code
specifying
the
type
of
characteristic
Binding: Codes for Product Characteristics ( Example ) |
|
|
value[x]
|
1..1 |
The
value
of
the
characteristic
|
||
|
valueCodeableConcept
|
CodeableConcept | |||
|
valueString
|
string | |||
|
valueQuantity
|
SimpleQuantity | |||
|
valueBase64Binary
|
base64Binary | |||
|
valueAttachment
|
Attachment | |||
|
valueBoolean
|
boolean | |||
|
instance
|
0..* | BackboneElement |
One
or
several
physical
instances
or
occurrences
of
the
nutrition
product
|
|
|
quantity
|
0..1 | SimpleQuantity |
The
amount
of
items
or
instances
|
|
|
identifier
|
0..* | Identifier |
The
identifier
for
the
physical
instance,
typically
a
serial
number
or
manufacturer
number
|
|
|
name
|
0..1 | string |
The
name
for
the
specific
product
|
|
|
lotNumber
|
0..1 | string |
The
identification
of
the
batch
or
lot
of
the
product
|
|
|
expiry
|
0..1 | dateTime |
The
expiry
date
or
date
and
time
for
the
product
|
|
|
useBy
|
0..1 | dateTime |
The
date
until
which
the
product
is
expected
to
be
good
for
consumption
|
|
|
biologicalSourceEvent
|
0..1 | Identifier |
An
identifier
that
supports
traceability
to
the
event
during
which
material
in
this
product
from
one
or
more
biological
entities
was
obtained
or
pooled
|
|
|
note
|
0..* | Annotation |
Comments
made
about
the
product
|
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
XML Template
<NutritionProduct xmlns="http://hl7.org/fhir">
JSON Template
{
"resourceType" : "NutritionProduct",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"code" : { CodeableConcept }, // A code that can identify the detailed nutrients and ingredients in a specific food product
"status" : "<code>", // R! active | inactive | entered-in-error
"category" : [{ CodeableConcept }], // Broad product groups or categories used to classify the product, such as Legume and Legume Products, Beverages, or Beef Products
"manufacturer" : [{ Reference(Organization) }], // Manufacturer, representative or officially responsible for the product
"nutrient" : [{ // The product's nutritional information expressed by the nutrients
"item" : { CodeableReference(Substance) }, // The (relevant) nutrients in the product
"amount" : [{ Ratio }] // The amount of nutrient expressed in one or more units: X per pack / per serving / per dose
}],
"ingredient" : [{ // Ingredients contained in this product
"item" : { CodeableReference(NutritionProduct) }, // R! The ingredient contained in the product
"amount" : [{ Ratio }] // The amount of ingredient that is in the product
}],
"knownAllergen" : [{ CodeableReference(Substance) }], // Known or suspected allergens that are a part of this product
"characteristic" : [{ // Specifies descriptive properties of the nutrition product
"type" : { CodeableConcept }, // R! Code specifying the type of characteristic
// value[x]: The value of the characteristic. One of these 6:
"valueCodeableConcept" : { CodeableConcept },
"valueString" : "<string>",
"valueQuantity" : { Quantity(SimpleQuantity) },
"valueBase64Binary" : "<base64Binary>",
"valueAttachment" : { Attachment },
"valueBoolean" : <boolean>
}],
"instance" : [{ // One or several physical instances or occurrences of the nutrition product
"quantity" : { Quantity(SimpleQuantity) }, // The amount of items or instances
"identifier" : [{ Identifier }], // The identifier for the physical instance, typically a serial number or manufacturer number
"name" : "<string>", // The name for the specific product
"lotNumber" : "<string>", // The identification of the batch or lot of the product
"expiry" : "<dateTime>", // The expiry date or date and time for the product
"useBy" : "<dateTime>", // The date until which the product is expected to be good for consumption
"biologicalSourceEvent" : { Identifier } // An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled
}],
"note" : [{ Annotation }] // Comments made about the product
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes from both R4 and R4B
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 |
|---|---|---|---|
| NutritionProduct.code | TypesOfEdibleSubstances | Example |
This
value
set
represents
codes
for
types
of
edible
substances
and
is
provided
as
a
suggestive
example.
It
include
codes
from
SNOMED
CT
|
| NutritionProduct.status | NutritionProductStatus | Required |
Codes identifying the lifecycle stage of a product. |
| NutritionProduct.category | CategoriesOfNutritionProducts | Example |
This
value
set
represents
codes
for
types
of
edible
substances
and
is
provided
as
a
suggestive
example.
It
include
codes
from
SNOMED
CT
|
| NutritionProduct.nutrient.item | CodesForNutritionProductNutrients | Example |
This
value
set
represents
codes
for
food
nutrients
and
is
provided
as
a
suggestive
example.
It
include
codes
from
SNOMED
CT
|
| NutritionProduct.knownAllergen | CodesForAllergenClasses | Example |
This
value
set
represents
codes
for
food
nutrients
and
is
provided
as
a
suggestive
example.
It
include
codes
from
SNOMED
CT
|
| NutritionProduct.characteristic.type | CodesForProductCharacteristics | Example |
This
value
set
represents
codes
for
properties
that
can
be
measured
and
is
provided
as
a
suggestive
example.
It
include
codes
from
SNOMED
CT
|
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 | The code identifying a specific nutrition product | NutritionProduct.code | |
| identifier | token | The identifier for the physical instance, typically a serial number | NutritionProduct.instance.identifier | |
| lot-number | token | The lot number | NutritionProduct.instance.lotNumber | |
| serial-number | token | The serial number | NutritionProduct.instance.identifier | |
| status | token | The broad product group or category of the nutrition product | NutritionProduct.category |
FHIR
®©
HL7.org
2011+.
FHIR
R5
hl7.fhir.core#5.0.0
R6
hl7.fhir.core#6.0.0-ballot1
generated
on
Sun,
Mar
26,
Mon,
Dec
18,
2023
15:25+1100.
15:17+1100.
Links:
Search
|
Version
History
|
Contents
|
Glossary
|
QA
|
Compare
to
R4
|
Compare
to
R4B
R5
|
|
Propose
a
change