FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Orders and Observations icon Work GroupMaturity Level: 1 Trial UseSecurity Category: Business Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the NutritionProduct resource.

NutritionProduct
Element IdNutritionProduct
Definition

A food or supplement that is consumed by patients.

Short DisplayA product used for nutritional purposes (i.e. food or supplement)
Cardinality0..*
TypeDomainResource
Summaryfalse
NutritionProduct.code
Element IdNutritionProduct.code
Definition

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

Short DisplayA code that can identify the detailed nutrients and ingredients in a specific food product
Cardinality0..1
Terminology BindingTypes of Edible Substances (Example)
TypeCodeableConcept
Alternate Namestype
Summarytrue
NutritionProduct.status
Element IdNutritionProduct.status
Definition

The current state of the product.

Short Displayactive | inactive | entered-in-error
Cardinality1..1
Terminology BindingNutritionProductStatus (Required)
Typecode
Is Modifiertrue (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)
Summarytrue
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 IdNutritionProduct.category
Definition

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

Short DisplayBroad product groups or categories used to classify the product, such as Legume and Legume Products, Beverages, or Beef Products
Cardinality0..*
Terminology BindingCategories of Nutrition Products (Example)
TypeCodeableConcept
Alternate Namesclass
Summarytrue
NutritionProduct.manufacturer
Element IdNutritionProduct.manufacturer
Definition

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

Short DisplayManufacturer, representative or officially responsible for the product
Cardinality0..*
TypeReference(Organization)
Summarytrue
NutritionProduct.nutrient
Element IdNutritionProduct.nutrient
Definition

The product's nutritional information expressed by the nutrients.

Short DisplayThe product's nutritional information expressed by the nutrients
Cardinality0..*
Requirements

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

Summarytrue
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 IdNutritionProduct.nutrient.item
Definition

The (relevant) nutrients in the product.

Short DisplayThe (relevant) nutrients in the product
Cardinality0..1
Terminology BindingCodes for Nutrition Product Nutrients (Example)
TypeCodeableReference(Substance)
Summaryfalse
NutritionProduct.nutrient.amount
Element IdNutritionProduct.nutrient.amount
Definition

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

Short DisplayThe amount of nutrient expressed in one or more units: X per pack / per serving / per dose
Cardinality0..*
TypeRatio
Summaryfalse
NutritionProduct.ingredient
Element IdNutritionProduct.ingredient
Definition

Ingredients contained in this product.

Short DisplayIngredients contained in this product
Cardinality0..*
Summaryfalse
NutritionProduct.ingredient.item
Element IdNutritionProduct.ingredient.item
Definition

The ingredient contained in the product.

Short DisplayThe ingredient contained in the product
Cardinality1..1
TypeCodeableReference(NutritionProduct)
Summarytrue
NutritionProduct.ingredient.amount
Element IdNutritionProduct.ingredient.amount
Definition

The amount of ingredient that is in the product.

Short DisplayThe amount of ingredient that is in the product
Cardinality0..*
TypeRatio
Summarytrue
NutritionProduct.knownAllergen
Element IdNutritionProduct.knownAllergen
Definition

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

Short DisplayKnown or suspected allergens that are a part of this product
Cardinality0..*
Terminology BindingCodes for Allergen Classes (Example)
TypeCodeableReference(Substance)
Summaryfalse
NutritionProduct.characteristic
Element IdNutritionProduct.characteristic
Definition

Specifies descriptive properties of the nutrition product.

Short DisplaySpecifies descriptive properties of the nutrition product
Cardinality0..*
Summaryfalse
NutritionProduct.characteristic.type
Element IdNutritionProduct.characteristic.type
Definition

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

Short DisplayCode specifying the type of characteristic
Cardinality1..1
Terminology BindingCodes for Product Characteristics (Example)
TypeCodeableConcept
Summaryfalse
NutritionProduct.characteristic.value[x]
Element IdNutritionProduct.characteristic.value[x]
Definition

The actual characteristic value corresponding to the type.

Short DisplayThe value of the characteristic
Cardinality1..1
TypeCodeableConcept|string|SimpleQuantity|base64Binary|Attachment|boolean
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
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 IdNutritionProduct.instance
Definition

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

Short DisplayOne or several physical instances or occurrences of the nutrition product
Cardinality0..*
Summaryfalse
NutritionProduct.instance.quantity
Element IdNutritionProduct.instance.quantity
Definition

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

Short DisplayThe amount of items or instances
Cardinality0..1
TypeSimpleQuantity
Summaryfalse
NutritionProduct.instance.identifier
Element IdNutritionProduct.instance.identifier
Definition

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

Short DisplayThe identifier for the physical instance, typically a serial number or manufacturer number
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Alternate NamesserialNumber
Summaryfalse
NutritionProduct.instance.name
Element IdNutritionProduct.instance.name
Definition

The name for the specific product.

Short DisplayThe name for the specific product
Cardinality0..1
Typestring
Alternate NamesproductName
Summaryfalse
NutritionProduct.instance.lotNumber
Element IdNutritionProduct.instance.lotNumber
Definition

The identification of the batch or lot of the product.

Short DisplayThe identification of the batch or lot of the product
Cardinality0..1
Typestring
Summaryfalse
NutritionProduct.instance.expiry
Element IdNutritionProduct.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 DisplayThe expiry date or date and time for the product
Cardinality0..1
TypedateTime
Summaryfalse
NutritionProduct.instance.useBy
Element IdNutritionProduct.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 DisplayThe date until which the product is expected to be good for consumption
Cardinality0..1
TypedateTime
Summaryfalse
NutritionProduct.instance.biologicalSourceEvent
Element IdNutritionProduct.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 DisplayAn identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled
Cardinality0..1
TypeIdentifier
Summaryfalse
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 IdNutritionProduct.note
Definition

Comments made about the product.

Short DisplayComments made about the product
Cardinality0..*
TypeAnnotation
Summaryfalse