Release 4B Snapshot 3: Connectathon 32 Base

This page is part of the FHIR Specification (v4.3.0: R4B - STU (v5.0.0-snapshot3: R5 Snapshot #3, to support Connectathon 32 ). 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

Orders and Observations icon Work Group Maturity Level : 0 1   Trial Use Security Category : Business Compartments : Not linked to any defined compartments

Detailed Descriptions for the elements in the NutritionProduct resource.

To Do To discuss - what if a product has two codes?
NutritionProduct
Element Id NutritionProduct
Definition

A food or fluid product supplement that is consumed by patients.

Short Display A product used for nutritional purposes (i.e. food or supplement)
Cardinality 0..*
Type DomainResource
Summary false
NutritionProduct.code
Element Id NutritionProduct.code
Definition

The code assigned to the product, for example a USDA NDB number, a USDA FDC ID number, or a Langual code.

Short Display A code that can identify the detailed nutrients and ingredients in a specific food product
Cardinality 0..1
Terminology Binding Types of Edible Substances ( Example )
Type CodeableConcept
Alternate Names type
Summary true
NutritionProduct.status
Element Id NutritionProduct.status
Definition

The current state of the product.

Short Display active | inactive | entered-in-error
Cardinality 1..1
Terminology Binding NutritionProductStatus ( Required )
Type code
Is Modifier true (Reason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid)
Summary true
Comments

Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.

NutritionProduct.category
Element Id NutritionProduct.category
Definition

Nutrition products can have different classifications - according to its nutritional properties, preparation methods, etc.

Cardinality 0..* Terminology Binding Categories of Nutrition Products ( Example ) Type CodeableConcept Alternate Names class Summary true NutritionProduct.code Element Id NutritionProduct.code Definition Short Display The code assigned Broad product groups or categories used to classify the product, for example a manufacturer number such as Legume and Legume Products, Beverages, or other terminology. Beef Products
Cardinality 0..1 0..*
Terminology Binding NutritionProductCode : Categories of Nutrition Products ( Example )
Type CodeableConcept
Alternate Names type class
Summary true
NutritionProduct.manufacturer
Element Id NutritionProduct.manufacturer
Definition

The organisation (manufacturer, representative or legal authorisation holder) that is responsible for the device.

Short Display Manufacturer, representative or officially responsible for the product
Cardinality 0..*
Type Reference ( Organization )
Summary true
NutritionProduct.nutrient
Element Id NutritionProduct.nutrient
Definition

The product's nutritional information expressed by the nutrients.

Short Display The product's nutritional information expressed by the nutrients
Cardinality 0..*
Requirements

Allows identification of the {{title}} as it is known by various participating systems and in a way that remains consistent across servers.

Summary true
Comments

Note: This is a business identifier, not a resource identifier (see discussion ). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

NutritionProduct.nutrient.item
Element Id NutritionProduct.nutrient.item
Definition

The (relevant) nutrients in the product.

Short Display The (relevant) nutrients in the product
Cardinality 0..1
Terminology Binding Codes for Nutrition Product Nutrients ( Example )
Type CodeableReference ( Substance )
Summary false
NutritionProduct.nutrient.amount
Element Id NutritionProduct.nutrient.amount
Definition

The amount of nutrient expressed in one or more units: X per pack / per serving / per dose.

Short Display The amount of nutrient expressed in one or more units: X per pack / per serving / per dose
Cardinality 0..*
Type Ratio
Summary false
NutritionProduct.ingredient
Element Id NutritionProduct.ingredient
Definition

Ingredients contained in this product.

Short Display Ingredients contained in this product
Cardinality 0..*
Summary false
NutritionProduct.ingredient.item
Element Id NutritionProduct.ingredient.item
Definition

The ingredient contained in the product.

Short Display The ingredient contained in the product
Cardinality 1..1
Type CodeableReference ( NutritionProduct )
Summary true
NutritionProduct.ingredient.amount
Element Id NutritionProduct.ingredient.amount
Definition

The amount of ingredient that is in the product.

Short Display The amount of ingredient that is in the product
Cardinality 0..*
Type Ratio
Summary true
NutritionProduct.knownAllergen
Element Id NutritionProduct.knownAllergen
Definition

Allergens that are known or suspected to be a part of this nutrition product.

Short Display Known or suspected allergens that are a part of this product
Cardinality 0..*
Terminology Binding Codes for Allergen Classes ( Example )
Type CodeableReference ( Substance )
Summary false
NutritionProduct.productCharacteristic NutritionProduct.characteristic
Element Id NutritionProduct.productCharacteristic NutritionProduct.characteristic
Definition

Specifies descriptive properties of the nutrition product.

Short Display Specifies descriptive properties of the nutrition product
Cardinality 0..*
Summary false
NutritionProduct.productCharacteristic.type NutritionProduct.characteristic.type
Element Id NutritionProduct.productCharacteristic.type NutritionProduct.characteristic.type
Definition

A code specifying which characteristic of the product is being described (for example, colour, shape).

Short Display Code specifying the type of characteristic
Cardinality 1..1
Terminology Binding Codes for Product Characteristics ( Example )
Type CodeableConcept
Summary false
NutritionProduct.productCharacteristic.value[x] NutritionProduct.characteristic.value[x]
Element Id NutritionProduct.productCharacteristic.value[x] NutritionProduct.characteristic.value[x]
Definition

The actual characteristic value corresponding to the type.

Short Display The value of the characteristic
Cardinality 1..1
Type CodeableConcept | string | SimpleQuantity | base64Binary | Attachment | boolean
[x] Note See Choice of Data Types Datatypes for further information about how to use [x]
Summary false
Comments

The description should be provided as a CodeableConcept, SimpleQuantity or an image. The description can be a string only when these others are not available.

NutritionProduct.instance
Element Id NutritionProduct.instance
Definition

Conveys instance-level information about this product item. One or several physical, countable instances or occurrences of the product.

Short Display One or several physical instances or occurrences of the nutrition product
Cardinality 0..1 0..*
Summary false
NutritionProduct.instance.quantity
Element Id NutritionProduct.instance.quantity
Definition

The amount of items or instances that the resource considers, for instance when referring to 2 identical units together.

Short Display The amount of items or instances
Cardinality 0..1
Type SimpleQuantity
Summary false
NutritionProduct.instance.identifier
Element Id NutritionProduct.instance.identifier
Definition

The identifier for the physical instance, typically a serial number or manufacturer number.

Short Display The identifier for the physical instance, typically a serial number or manufacturer number
Note This is a business identifier, not a resource identifier (see discussion )
Cardinality 0..*
Type Identifier
Alternate Names serialNumber
Summary false
NutritionProduct.instance.name
Element Id NutritionProduct.instance.name
Definition

The name for the specific product.

Short Display The name for the specific product
Cardinality 0..1
Type string
Alternate Names productName
Summary false
NutritionProduct.instance.lotNumber
Element Id NutritionProduct.instance.lotNumber
Definition

The identification of the batch or lot of the product.

Short Display The identification of the batch or lot of the product
Cardinality 0..1
Type string
Summary false
NutritionProduct.instance.expiry
Element Id NutritionProduct.instance.expiry
Definition

The time after which the product is no longer expected to be in proper condition, or its use is not advised or not allowed.

Short Display The expiry date or date and time for the product
Cardinality 0..1
Type dateTime
Summary false
NutritionProduct.instance.useBy
Element Id NutritionProduct.instance.useBy
Definition

The time after which the product is no longer expected to be in proper condition, or its use is not advised or not allowed.

Short Display The date until which the product is expected to be good for consumption
Cardinality 0..1
Type dateTime
Summary false
NutritionProduct.instance.biologicalSourceEvent
Element Id NutritionProduct.instance.biologicalSourceEvent
Definition

An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled.

Short Display An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled
Cardinality 0..1
Type Identifier
Summary false
Comments

Necessary to support mandatory requirements for traceability from donor/source to recipient and vice versa, while also satisfying donor anonymity requirements. The element is defined consistently across BiologicallyDerivedProduct, NutritionProduct, and Device. The identifier references an event that links to a single biological entity such as a blood donor, or to multiple biological entities (e.g. when the product is an embryo or a pooled platelet product). A single biologicalSourceEvent identifier may appear on multiple products of many types derived from a single donation event or source extraction. As an example, a single donation event may provide 2 kidneys and a liver for organ transplantation, 2 corneas for eye surgery, heart valves and arterial tissue for cardiovascular surgery, multiple skin grafts, tendons, multiple shaped bone grafts and a large number of bone putty/paste products; and each of them may be assigned to the same biological source event identifier.

NutritionProduct.note
Element Id NutritionProduct.note
Definition

Comments made about the product.

Short Display Comments made about the product
Cardinality 0..*
Type Annotation
Summary false