This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions
Orders and Observations Work Group | Maturity Level: 3 | Trial Use | Security Category: Business | Compartments: No defined compartments |
Detailed Descriptions for the elements in the NutritionProduct resource.
NutritionProduct | |
Element Id | NutritionProduct |
Definition | A food or 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 | 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. |
Short Display | A code that can identify the product |
Cardinality | 0..1 |
Terminology Binding | Types of Edible Substances (Preferred) |
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 | Nutrition Product Status (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 fall into various categories based on their composition (e.g., Fruit and Grain, Vegetables) or form (e.g., Beverages). |
Short Display | Broad product groups, like Fruit, Grain, Beverages, or Vegetables Products |
Cardinality | 0..* |
Terminology Binding | Categories of Nutrition Products (Preferred) |
Type | CodeableConcept |
Alternate Names | class |
Summary | true |
NutritionProduct.manufacturer | |
Element Id | NutritionProduct.manufacturer |
Definition | The organisation (manufacturer, representative or legal authorization 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 product 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 | 1..1 |
Terminology Binding | Nutrient Codes (Example) |
Type | CodeableReference(Substance) |
Summary | true |
NutritionProduct.nutrient.amount[x] | |
Element Id | NutritionProduct.nutrient.amount[x] |
Definition | The amount of nutrient expressed in one or more units, either X per pack / per serving / per dose or X amount. |
Short Display | The amount of nutrient present in the product |
Cardinality | 0..1 |
Type | Ratio|Quantity |
[x] Note | See Choice of Datatypes for further information about how to use [x] |
Summary | false |
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. |
NutritionProduct.ingredientSummary | |
Element Id | NutritionProduct.ingredientSummary |
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'. |
Short Display | Textual description of product ingredients |
Cardinality | 0..1 |
Type | markdown |
Summary | false |
Comments | If structured ingredient information is present, the ingredientSummary should be consistent. |
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[x] | |
Element Id | NutritionProduct.ingredient.amount[x] |
Definition | The amount of ingredient that is in the product. |
Short Display | The amount of ingredient that is in the product |
Cardinality | 0..1 |
Type | Ratio|Quantity |
[x] Note | See Choice of Datatypes for further information about how to use [x] |
Summary | true |
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. |
NutritionProduct.ingredient.allergen | |
Element Id | NutritionProduct.ingredient.allergen |
Definition | Substances associated with allergies and/or intolerances that a part of this product. |
Short Display | Known or suspected substances that are a part of this product |
Cardinality | 0..1 |
Type | boolean |
Summary | false |
NutritionProduct.energy | |
Element Id | NutritionProduct.energy |
Definition | The amount of energy present in the product expressed in kilocalories or kilojoules. |
Short Display | The amount of energy present in the product expressed in kilocalories or kilojoules |
Cardinality | 0..1 |
Type | Quantity |
Summary | false |
NutritionProduct.characteristic | |
Element Id | NutritionProduct.characteristic |
Definition | Specifies descriptive properties of the nutrition product. |
Short Display | Specifies descriptive properties of the nutrition product |
Cardinality | 0..* |
Summary | false |
NutritionProduct.characteristic.type | |
Element Id | 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.characteristic.value[x] | |
Element Id | 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 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..* |
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 or brand for the specific product. |
Short Display | The name or brand 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 |