View raw Markdown
type: resource-definitionsresource: NutritionProduct

NutritionProduct Definitions

<a id="NutritionProduct"></a>

NutritionProduct

A product used for nutritional purposes (i.e. food or supplement)

Definition: A food or supplement that is consumed by patients.

Cardinality: 0..*

Mappings: rim=Act[moodCode=EVN]; w5=clinical.general

<a id="NutritionProduct.code"></a>

NutritionProduct.code

A code that can identify the product

Definition: A code that specifies the product or a textual description if no code is available. This could be such codes as a USDA Branded Food Products Database number, a USDA Food Data Central (FDC) ID number, Universal Product Code (UPC), a Langual code, or a country specific food database code.

Aliases: type

Cardinality: 0..1

Type: CodeableConcept

Binding: preferred:edible-substance-type

Summary: true

Mappings: w5=FiveWs.identifier; v2=Varies by domain; rim=.code

<a id="NutritionProduct.status"></a>

NutritionProduct.status

active | inactive | entered-in-error

Definition: The current state of the product.

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.

Cardinality: 1..1

Type: code

Binding: required:nutritionproduct-status

Summary: true

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)

Mappings: w5=FiveWs.status; v2=Varies by domain; rim=.status

<a id="NutritionProduct.category"></a>

NutritionProduct.category

Broad product groups, like Fruit, Grain, Beverages, or Vegetables Products

Definition: Nutrition products fall into various categories based on their composition (e.g., Fruit and Grain, Vegetables) or form (e.g., Beverages).

Aliases: class

Cardinality: 0..*

Type: CodeableConcept

Binding: preferred:nutrition-product-category

Summary: true

Mappings: w5=FiveWs.class; v2=Varies by domain; rim=.code

<a id="NutritionProduct.manufacturer"></a>

NutritionProduct.manufacturer

Manufacturer, representative or person officially responsible for the product

Definition: The organisation (manufacturer, representative or legal authorization holder) or person that is responsible for nutrition product.

Cardinality: 0..*

Type: Reference(Organization, RelatedPerson)

Summary: true

Mappings: v2=Varies by domain

<a id="NutritionProduct.nutrient"></a>

NutritionProduct.nutrient

The product's nutritional information expressed by the nutrients

Definition: The product's nutritional information expressed by the nutrients.

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.

Requirements: Allows identification of the product as it is known by various participating systems and in a way that remains consistent across servers.

Cardinality: 0..*

Type: BackboneElement

Summary: true

Mappings: v2=Varies by domain; rim=.identifier

<a id="NutritionProduct.nutrient.item"></a>

NutritionProduct.nutrient.item

The (relevant) nutrients in the product

Definition: The (relevant) nutrients in the product.

Cardinality: 1..1

Type: CodeableReference

Binding: example:nutrient-code

Summary: true

<a id="NutritionProduct.nutrient.amount[x]"></a>

NutritionProduct.nutrient.amount[x]

The amount of nutrient present in the product

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

Comments: Quantity is allowed to specify a specific amount of a nutrient, eg. 100mg or 100 mg/serving. Ratio is to say 100mg / 5mL and you don't want to normalize the ratio. Quantity also allows for indicating trace amounts of nutrients.

Cardinality: 0..1

Type: Ratio, Quantity

<a id="NutritionProduct.ingredientSummary"></a>

NutritionProduct.ingredientSummary

Textual description of product ingredients

Definition: The textual description of the ingredients in the product. For example, the following is a concatenated list of the ingredients for a peanut butter would read 'ROASTED PEANUTS, SUGAR, HYDROGENATED VEGETABLE OIL (COTTONSEED, SOYBEAN AND RAPESEED OIL) TO PREVENT SEPARATION, SALT'.

Comments: If structured ingredient information is present, the ingredientSummary should be consistent.

Cardinality: 0..1

Type: markdown

<a id="NutritionProduct.ingredient"></a>

NutritionProduct.ingredient

Ingredients contained in this product

Definition: Ingredients contained in this product.

Cardinality: 0..*

Type: BackboneElement

<a id="NutritionProduct.ingredient.item"></a>

NutritionProduct.ingredient.item

The ingredient contained in the product

Definition: The ingredient contained in the product.

Cardinality: 1..1

Type: CodeableReference

Binding: example:edible-substance-type

Summary: true

<a id="NutritionProduct.ingredient.amount[x]"></a>

NutritionProduct.ingredient.amount[x]

The amount of ingredient that is in the product

Definition: The amount of ingredient that is in the product.

Comments: Quantity is allowed to specify a specific amount of an ingredient, eg. 100mg or 100 mg/mL. Ratio is to say 100mg / 5mL and you don't want to normalize the ratio. Quantity also allows for indicating trace amounts of ingredients.

Cardinality: 0..1

Type: Ratio, Quantity

Summary: true

<a id="NutritionProduct.ingredient.allergen"></a>

NutritionProduct.ingredient.allergen

A known or suspected allergenic and/or substance that is associated with an intolerance

Definition: A known or suspected allergenic and/or substance that is associated with an intolerance.

Cardinality: 0..1

Type: boolean

<a id="NutritionProduct.energy"></a>

NutritionProduct.energy

The amount of energy present in the product expressed in kilocalories or kilojoules

Definition: The amount of energy present in the product expressed in kilocalories or kilojoules.

Cardinality: 0..1

Type: Quantity

<a id="NutritionProduct.characteristic"></a>

NutritionProduct.characteristic

Specifies descriptive properties of the nutrition product

Definition: Specifies descriptive properties of the nutrition product.

Cardinality: 0..*

Type: BackboneElement

<a id="NutritionProduct.characteristic.type"></a>

NutritionProduct.characteristic.type

Code specifying the type of characteristic

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

Cardinality: 1..1

Type: CodeableConcept

Binding: example:measurement-property

<a id="NutritionProduct.characteristic.value[x]"></a>

NutritionProduct.characteristic.value[x]

The value of the characteristic

Definition: The actual characteristic value corresponding to the type.

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.

Cardinality: 1..1

Type: CodeableConcept, string, Quantity(SimpleQuantity), base64Binary, Attachment, boolean

<a id="NutritionProduct.instance"></a>

NutritionProduct.instance

One or several physical instances or occurrences of the nutrition product

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

Cardinality: 0..*

Type: BackboneElement

<a id="NutritionProduct.instance.quantity"></a>

NutritionProduct.instance.quantity

The amount of items or instances

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

Cardinality: 0..1

Type: Quantity(SimpleQuantity)

<a id="NutritionProduct.instance.identifier"></a>

NutritionProduct.instance.identifier

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

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

Aliases: serialNumber

Cardinality: 0..*

Type: Identifier

<a id="NutritionProduct.instance.name"></a>

NutritionProduct.instance.name

The name or brand for the specific product

Definition: The name or brand for the specific product.

Aliases: productName

Cardinality: 0..1

Type: string

<a id="NutritionProduct.instance.lotNumber"></a>

NutritionProduct.instance.lotNumber

The identification of the batch or lot of the product

Definition: The identification of the batch or lot of the product.

Cardinality: 0..1

Type: string

<a id="NutritionProduct.instance.expiry"></a>

NutritionProduct.instance.expiry

The expiry date or date and time for the product

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.

Cardinality: 0..1

Type: dateTime

<a id="NutritionProduct.instance.useBy"></a>

NutritionProduct.instance.useBy

The date until which the product is expected to be good for consumption

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.

Cardinality: 0..1

Type: dateTime

<a id="NutritionProduct.instance.biologicalSourceEvent"></a>

NutritionProduct.instance.biologicalSourceEvent

An identifier of the donation, collection, or pooling event from which biological material in this nutrition product was derived

Definition: An identifier of the donation, collection, or pooling event from which biological material in this nutrition product was derived.

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.

Cardinality: 0..1

Type: Identifier

<a id="NutritionProduct.note"></a>

NutritionProduct.note

Comments made about the product

Definition: Comments made about the product.

Cardinality: 0..*

Type: Annotation

Mappings: v2=NTE