Release 5 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v5.0.0: R5 - STU ). This is the current published version in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). For a full list of available versions, see times).
See the Directory of published versions icon . Page versions: R5 R4B

8.32 8.29 Resource NutritionProduct - Content

Responsible Owner: Orders and Observations icon Work Group Maturity Level : 1   Trial Use Normative Security Category : Business Compartments : No defined compartments

A food or supplement that is consumed by patients.

8.32.1 8.29.1 Scope and Usage

Note to Implementers: For an overview of this resource and others in the Nutrition domain, also see the module page .

The NutritionProduct resource represents the identification of a food or fluid (i.e., solid and/or liquid) product consumed by patients. The scope of the NutritionProduct resource includes all the products that are understood to be food and beverage (i.e., solid and/or liquid) products for human consumption.

8.32.2

8.29.2 Boundaries and Relationships

  • Oral intake of food, fluids, oral nutritional supplements (i.e. Ensure), BiologicallyDerivedProduct - If the product is for transplant, infusion, therapeutic administration, or enteral nutrition should injection it is represented as a BiologicallyDerivedProduct. If the product is for dietary administration it is represented as a NutritionProduct. We note that this remains ambiguous, particularly around certain uses of donated human milk, and additional use cases may need to be recorded using clarified to determine the NutritionIntake resource. appropriate representation. Local implementation guidance may provide further direction.
  • Supplements, Medication - Products such as supplements (e.g., vitamins, minerals, herbals, and herbals) or parenteral nutrition (e.g., TPN) should be recorded using the medication resources resources.
  • Parenteral nutrition AdministrableProductDefinition - Used when describing regulated medicinal products (including parenteral nutrition) intended for administration as a drug or infusion.
  • NutritionIntake - Used for recording oral intake of food (i.e., solid and/or liquid), oral nutritional supplements, enteral nutrition, and infant formula should be recorded using the medication resources NutritionIntake resource.
  • NutritionOrder - Used when requesting oral diets, oral nutrition supplements, enteral feedings, nutrition products, and infant formula.

8.32.3 8.29.3 References to this Resource

8.32.4 8.29.4 Resource Content

Structure

0..* Ratio
Name Flags Card. Type Description & Constraints      Filter: Filters doco
. . NutritionProduct TU N 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 Preferred )
. . . 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, groups, like Fruit, Grain, Beverages, or Beef Vegetables Products
Binding: Categories of Nutrition Products ( Example Preferred )

. . . nutrient Σ 0..* BackboneElement The product's nutritional information expressed by the nutrients

. . . . item Σ 0..1 1..1 CodeableReference ( Substance SubstanceDefinition ) The (relevant) nutrients in the product
Binding: Nutrient Codes for Nutrition Product Nutrients ( Example )
. . . amount . amount[x] 0..1 0..* The amount of nutrient present in the product
. . . . . amountRatio Ratio The amount of nutrient expressed in one or more units: X per pack / per serving / per dose
. . . . . amountQuantity Quantity
. . . ingredientSummary 0..1 markdown Textual description of product ingredients
. . . ingredient 0..* BackboneElement Ingredients contained in this product

. . . . item Σ 1..1 CodeableReference ( NutritionProduct ) The ingredient contained in the product
Binding: Types of Edible Substances ( Example )
. . . amount . amount[x] Σ 0..1 The amount of ingredient that is in the product
. . . . knownAllergen . amountRatio Ratio
. . . . . amountQuantity 0..* CodeableReference Quantity ( Substance
. . . . allergen ) Known 0..1 boolean A known or suspected allergens allergenic and/or substance that are a part of this product is associated with an intolerance
Binding: Codes for Allergen Classes
. . . energy ( Example ) 0..1 Quantity The amount of energy present in the product expressed in kilocalories or kilojoules
. . . 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 or brand 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 of the donation, collection, or pooling event during from which biological material in this nutrition product from one or more biological entities was obtained or pooled derived
. . . note 0..* Annotation Comments made about the product


doco Documentation for this format icon

See the Extensions for this resource

UML Diagram ( Legend )

NutritionProduct ( DomainResource ) The A code assigned to that specifies the product, for example product or a textual description if no code is available. This could be such codes as a USDA NDB Branded Food Products Database number, a USDA FDC Food Data Central (FDC) ID number, or Universal Product Code (UPC), a Langual code, or a country specific food database code code : CodeableConcept [0..1] « null (Strength=Example) (Strength=Preferred) TypesOfEdibleSubstances ?? ? » The current state of the product (this element modifies the meaning of other elements) status : code [1..1] « null (Strength=Required) NutritionProductStatus ! » Nutrition products can have different classifications - according to its nutritional properties, preparation methods, etc fall into various categories based on their composition (e.g., Fruit and Grain, Vegetables) or form (e.g., Beverages) category : CodeableConcept [0..*] « null (Strength=Example) (Strength=Preferred) CategoriesOfNutritionProducts ?? ? » The organisation (manufacturer, representative or legal authorization holder) or person that is responsible for the device nutrition product manufacturer : Reference [0..*] « Organization | RelatedPerson » Allergens that are known or suspected to be The textual description of the ingredients in the product. For example, the following is a part concatenated list of this nutrition product the ingredients for a peanut butter would read 'ROASTED PEANUTS, SUGAR, HYDROGENATED VEGETABLE OIL (COTTONSEED, SOYBEAN AND RAPESEED OIL) TO PREVENT SEPARATION, SALT' knownAllergen ingredientSummary : CodeableReference [0..*] « Substance markdown ; null (Strength=Example) [0..1] CodesForAllergenClasses The amount of energy present in the product expressed in kilocalories or kilojoules energy ?? » : Quantity [0..1] Comments made about the product note : Annotation [0..*] Nutrient The (relevant) nutrients in the product item : CodeableReference [0..1] [1..1] « Substance SubstanceDefinition ; null (Strength=Example) CodesForNutritionProductNutri... NutrientCodes ?? » The amount of nutrient expressed in one or more units: units, either X per pack / per serving / per dose or X amount amount[x] : DataType [0..1] « Ratio [0..*] | Quantity » Ingredient The ingredient contained in the product item : CodeableReference [1..1] « NutritionProduct ; null (Strength=Example) TypesOfEdibleSubstances ?? » The amount of ingredient that is in the product amount amount[x] : DataType [0..1] « Ratio [0..*] | Quantity » A known or suspected allergenic and/or substance that is associated with an intolerance allergen : boolean [0..1] Characteristic A code specifying which characteristic of the product is being described (for example, colour, shape) type : CodeableConcept [1..1] « null (Strength=Example) CodesForProductCharacteristics ?? » The actual characteristic value corresponding to the type value[x] : DataType [1..1] « CodeableConcept | string | Quantity ( SimpleQuantity )| base64Binary | Attachment | boolean » Instance The amount of items or instances that the resource considers, for instance when referring to 2 identical units together quantity : Quantity ( SimpleQuantity ) [0..1] The identifier for the physical instance, typically a serial number or manufacturer number identifier : Identifier [0..*] The name or brand for the specific product name : string [0..1] The identification of the batch or lot of the product lotNumber : string [0..1] The time after which the product is no longer expected to be in proper condition, or its use is not advised or not allowed expiry : dateTime [0..1] The time after which the product is no longer expected to be in proper condition, or its use is not advised or not allowed useBy : dateTime [0..1] An identifier that supports traceability to of the donation, collection, or pooling event during from which biological material in this nutrition product from one or more biological entities was obtained or pooled derived biologicalSourceEvent : Identifier [0..1] The product's nutritional information expressed by the nutrients nutrient [0..*] Ingredients contained in this product ingredient [0..*] Specifies descriptive properties of the nutrition product characteristic [0..*] Conveys instance-level information about this product item. One or several physical, countable instances or occurrences of the product instance [0..*]

XML Template 

<NutritionProduct xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <</code>

 <code><!-- 0..1 CodeableConcept A code that can identify the product --></code>

 <status value="[code]"/><!-- 1..1 active | inactive | entered-in-error -->
 <</category>
 <</manufacturer>

 <category><!-- 0..* CodeableConcept Broad product groups, like Fruit, Grain, Beverages, or Vegetables Products --></category>
 <manufacturer><!-- 0..* Reference(Organization|RelatedPerson) Manufacturer, representative or person officially responsible for the product --></manufacturer>

 <nutrient>  <!-- 0..* The product's nutritional information expressed by the nutrients -->
  <</item>
  <</amount>

  <item><!-- 1..1 CodeableReference(SubstanceDefinition) The (relevant) nutrients in the product --></item>
  <amount[x]><!-- 0..1 Ratio|Quantity The amount of nutrient present in the product --></amount[x]>

 </nutrient>
 <ingredientSummary value="[markdown]"/><!-- 0..1 Textual description of product ingredients -->

 <ingredient>  <!-- 0..* Ingredients contained in this product -->
  <</item>
  <</amount>

  <item><!-- 1..1 CodeableReference(NutritionProduct) The ingredient contained in the product --></item>
  <amount[x]><!-- 0..1 Ratio|Quantity The amount of ingredient that is in the product --></amount[x]>
  <allergen value="[boolean]"/><!-- 0..1 A known or suspected allergenic and/or substance that is associated with an intolerance -->

 </ingredient>
 <</knownAllergen>

 <energy><!-- 0..1 Quantity The amount of energy present in the product expressed in kilocalories or kilojoules --></energy>

 <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 or brand 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>

  <biologicalSourceEvent><!-- 0..1 Identifier An identifier of the donation, collection, or pooling event from which biological material in this nutrition product was derived --></biologicalSourceEvent>

 </instance>
 <note><!-- 0..* Annotation Comments made about the product --></note>
</NutritionProduct>

JSON Template 

{doco
  "resourceType" : "NutritionProduct",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "

  "code" : { CodeableConcept }, // A code that can identify the product

  "status" : "<code>", // R!  active | inactive | entered-in-error
  "
  "

  "category" : [{ CodeableConcept }], // Broad product groups, like Fruit, Grain, Beverages, or Vegetables Products
  "manufacturer" : [{ Reference(Organization|RelatedPerson) }], // Manufacturer, representative or person officially responsible for the product

  "nutrient" : [{ // The product's nutritional information expressed by the nutrients
    "
    "

    "item" : { CodeableReference(SubstanceDefinition) }, // R!  The (relevant) nutrients in the product
    // amount[x]: The amount of nutrient present in the product. One of these 2:

    "amountRatio" : { Ratio },
    "amountQuantity" : { Quantity }

  }],
  "ingredientSummary" : "<markdown>", // Textual description of product ingredients

  "ingredient" : [{ // Ingredients contained in this product
    "
    "

    "item" : { CodeableReference(NutritionProduct) }, // R!  The ingredient contained in the product
    // amount[x]: The amount of ingredient that is in the product. One of these 2:

    "amountRatio" : { Ratio },
    "amountQuantity" : { Quantity },
    "allergen" : <boolean> // A known or suspected allergenic and/or substance that is associated with an intolerance

  }],
  "

  "energy" : { Quantity }, // The amount of energy present in the product expressed in kilocalories or kilojoules

  "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 or brand 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 of the donation, collection, or pooling event from which biological material in this nutrition product was derived

  }],
  "note" : [{ Annotation }] // Comments made about the product
}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:NutritionProduct;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from 
  # from 
  fhir:

  # from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language
  # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension
  fhir:code [ CodeableConcept ] ; # 0..1 A code that can identify the product

  fhir:status [ code ] ; # 1..1 active | inactive | entered-in-error
  fhir:
  fhir:

  fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* Broad product groups, like Fruit, Grain, Beverages, or Vegetables Products
  fhir:manufacturer  ( [ Reference(Organization|RelatedPerson) ] ... ) ; # 0..* Manufacturer, representative or person officially responsible for the product

  fhir:nutrient ( [ # 0..* The product's nutritional information expressed by the nutrients
    fhir:
    fhir:

    fhir:item [ CodeableReference(SubstanceDefinition) ] ; # 1..1 The (relevant) nutrients in the product
    # amount[x] : 0..1 The amount of nutrient present in the product. One of these 2
      fhir:amount [  a fhir:Ratio ; Ratio ]
      fhir:amount [  a fhir:Quantity ; Quantity ]

  ] ... ) ;
  fhir:ingredientSummary [ markdown ] ; # 0..1 Textual description of product ingredients

  fhir:ingredient ( [ # 0..* Ingredients contained in this product
    fhir:item [ CodeableReference(NutritionProduct) ] ; # 1..1 The ingredient contained in the product
    fhir:

    # amount[x] : 0..1 The amount of ingredient that is in the product. One of these 2
      fhir:amount [  a fhir:Ratio ; Ratio ]
      fhir:amount [  a fhir:Quantity ; Quantity ]
    fhir:allergen [ boolean ] ; # 0..1 A known or suspected allergenic and/or substance that is associated with an intolerance

  ] ... ) ;
  fhir:

  fhir:energy [ Quantity ] ; # 0..1 The amount of energy present in the product expressed in kilocalories or kilojoules

  fhir:characteristic ( [ # 0..* Specifies descriptive properties of the nutrition product
    fhir:type [ CodeableConcept ] ; # 1..1 Code specifying the type of characteristic
    # value[x] : 1..1 The value of the characteristic. One of these 6
      fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
      fhir: ]

      fhir:value [  a fhir:String ; string ]

      fhir:value [  a fhir:SimpleQuantity ; Quantity(SimpleQuantity) ]
      fhir: ]

      fhir:value [  a fhir:Base64Binary ; base64Binary ]

      fhir:value [  a fhir:Attachment ; Attachment ]
      fhir: ]

      fhir:value [  a fhir:Boolean ; boolean ]

  ] ... ) ;
  fhir:instance ( [ # 0..* One or several physical instances or occurrences of the nutrition product
    fhir:quantity [ Quantity(SimpleQuantity) ] ; # 0..1 The amount of items or instances
    fhir:identifier  ( [ Identifier ] ... ) ; # 0..* The identifier for the physical instance, typically a serial number or manufacturer number
    fhir:

    fhir:name [ string ] ; # 0..1 The name or brand for the specific product

    fhir:lotNumber [ string ] ; # 0..1 The identification of the batch or lot of the product
    fhir:expiry [ dateTime ] ; # 0..1 The expiry date or date and time for the product
    fhir:useBy [ dateTime ] ; # 0..1 The date until which the product is expected to be good for consumption
    fhir:

    fhir:biologicalSourceEvent [ Identifier ] ; # 0..1 An identifier of the donation, collection, or pooling event from which biological material in this nutrition product was derived

  ] ... ) ;
  fhir:note  ( [ Annotation ] ... ) ; # 0..* Comments made about the product
]

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

0..* Ratio
Name Flags Card. Type Description & Constraints      Filter: Filters doco
. . NutritionProduct TU N 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 Preferred )
. . . 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, groups, like Fruit, Grain, Beverages, or Beef Vegetables Products
Binding: Categories of Nutrition Products ( Example Preferred )

. . . nutrient Σ 0..* BackboneElement The product's nutritional information expressed by the nutrients

. . . . item Σ 0..1 1..1 CodeableReference ( Substance SubstanceDefinition ) The (relevant) nutrients in the product
Binding: Nutrient Codes for Nutrition Product Nutrients ( Example )
. . . amount . amount[x] 0..1 The amount of nutrient present in the product
0..*
. . . . . amountRatio Ratio The amount of nutrient expressed in one or more units: X per pack / per serving / per dose
. . . . . amountQuantity Quantity
... ingredientSummary 0..1 markdown Textual description of product ingredients
. . . ingredient 0..* BackboneElement Ingredients contained in this product

. . . . item Σ 1..1 CodeableReference ( NutritionProduct ) The ingredient contained in the product
Binding: Types of Edible Substances ( Example )
. . . amount . amount[x] Σ 0..1 The amount of ingredient that is in the product
. . . . knownAllergen . amountRatio Ratio
. . . . . amountQuantity 0..* CodeableReference Quantity ( Substance
. . . . allergen ) Known 0..1 boolean A known or suspected allergens allergenic and/or substance that are a part of this product is associated with an intolerance
Binding: Codes for Allergen Classes
. . . energy ( Example 0..1 Quantity ) The amount of energy present in the product expressed in kilocalories or kilojoules
. . . 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 or brand 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 of the donation, collection, or pooling event during from which biological material in this nutrition product from one or more biological entities was obtained or pooled derived
. . . note 0..* Annotation Comments made about the product


doco Documentation for this format icon

See the Extensions for this resource

UML Diagram ( Legend )

NutritionProduct ( DomainResource ) The A code assigned to that specifies the product, for example product or a textual description if no code is available. This could be such codes as a USDA NDB Branded Food Products Database number, a USDA FDC Food Data Central (FDC) ID number, or Universal Product Code (UPC), a Langual code, or a country specific food database code code : CodeableConcept [0..1] « null (Strength=Example) (Strength=Preferred) TypesOfEdibleSubstances ?? ? » The current state of the product (this element modifies the meaning of other elements) status : code [1..1] « null (Strength=Required) NutritionProductStatus ! » Nutrition products can have different classifications - according to its nutritional properties, preparation methods, etc fall into various categories based on their composition (e.g., Fruit and Grain, Vegetables) or form (e.g., Beverages) category : CodeableConcept [0..*] « null (Strength=Example) (Strength=Preferred) CategoriesOfNutritionProducts ?? ? » The organisation (manufacturer, representative or legal authorization holder) or person that is responsible for the device nutrition product manufacturer : Reference [0..*] « Organization | RelatedPerson » Allergens that are known or suspected to be The textual description of the ingredients in the product. For example, the following is a part concatenated list of this nutrition product the ingredients for a peanut butter would read 'ROASTED PEANUTS, SUGAR, HYDROGENATED VEGETABLE OIL (COTTONSEED, SOYBEAN AND RAPESEED OIL) TO PREVENT SEPARATION, SALT' knownAllergen ingredientSummary : CodeableReference [0..*] « Substance markdown ; null (Strength=Example) [0..1] CodesForAllergenClasses The amount of energy present in the product expressed in kilocalories or kilojoules energy ?? » : Quantity [0..1] Comments made about the product note : Annotation [0..*] Nutrient The (relevant) nutrients in the product item : CodeableReference [0..1] [1..1] « Substance SubstanceDefinition ; null (Strength=Example) CodesForNutritionProductNutri... NutrientCodes ?? » The amount of nutrient expressed in one or more units: units, either X per pack / per serving / per dose or X amount amount[x] : DataType [0..1] « Ratio [0..*] | Quantity » Ingredient The ingredient contained in the product item : CodeableReference [1..1] « NutritionProduct ; null (Strength=Example) TypesOfEdibleSubstances ?? » The amount of ingredient that is in the product amount amount[x] : DataType [0..1] « Ratio [0..*] | Quantity » A known or suspected allergenic and/or substance that is associated with an intolerance allergen : boolean [0..1] Characteristic A code specifying which characteristic of the product is being described (for example, colour, shape) type : CodeableConcept [1..1] « null (Strength=Example) CodesForProductCharacteristics ?? » The actual characteristic value corresponding to the type value[x] : DataType [1..1] « CodeableConcept | string | Quantity ( SimpleQuantity )| base64Binary | Attachment | boolean » Instance The amount of items or instances that the resource considers, for instance when referring to 2 identical units together quantity : Quantity ( SimpleQuantity ) [0..1] The identifier for the physical instance, typically a serial number or manufacturer number identifier : Identifier [0..*] The name or brand for the specific product name : string [0..1] The identification of the batch or lot of the product lotNumber : string [0..1] The time after which the product is no longer expected to be in proper condition, or its use is not advised or not allowed expiry : dateTime [0..1] The time after which the product is no longer expected to be in proper condition, or its use is not advised or not allowed useBy : dateTime [0..1] An identifier that supports traceability to of the donation, collection, or pooling event during from which biological material in this nutrition product from one or more biological entities was obtained or pooled derived biologicalSourceEvent : Identifier [0..1] The product's nutritional information expressed by the nutrients nutrient [0..*] Ingredients contained in this product ingredient [0..*] Specifies descriptive properties of the nutrition product characteristic [0..*] Conveys instance-level information about this product item. One or several physical, countable instances or occurrences of the product instance [0..*]

XML Template 

<NutritionProduct xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <</code>

 <code><!-- 0..1 CodeableConcept A code that can identify the product --></code>

 <status value="[code]"/><!-- 1..1 active | inactive | entered-in-error -->
 <</category>
 <</manufacturer>

 <category><!-- 0..* CodeableConcept Broad product groups, like Fruit, Grain, Beverages, or Vegetables Products --></category>
 <manufacturer><!-- 0..* Reference(Organization|RelatedPerson) Manufacturer, representative or person officially responsible for the product --></manufacturer>

 <nutrient>  <!-- 0..* The product's nutritional information expressed by the nutrients -->
  <</item>
  <</amount>

  <item><!-- 1..1 CodeableReference(SubstanceDefinition) The (relevant) nutrients in the product --></item>
  <amount[x]><!-- 0..1 Ratio|Quantity The amount of nutrient present in the product --></amount[x]>

 </nutrient>
 <ingredientSummary value="[markdown]"/><!-- 0..1 Textual description of product ingredients -->

 <ingredient>  <!-- 0..* Ingredients contained in this product -->
  <</item>
  <</amount>

  <item><!-- 1..1 CodeableReference(NutritionProduct) The ingredient contained in the product --></item>
  <amount[x]><!-- 0..1 Ratio|Quantity The amount of ingredient that is in the product --></amount[x]>
  <allergen value="[boolean]"/><!-- 0..1 A known or suspected allergenic and/or substance that is associated with an intolerance -->

 </ingredient>
 <</knownAllergen>

 <energy><!-- 0..1 Quantity The amount of energy present in the product expressed in kilocalories or kilojoules --></energy>

 <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 or brand 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>

  <biologicalSourceEvent><!-- 0..1 Identifier An identifier of the donation, collection, or pooling event from which biological material in this nutrition product was derived --></biologicalSourceEvent>

 </instance>
 <note><!-- 0..* Annotation Comments made about the product --></note>
</NutritionProduct>

JSON Template 

{doco
  "resourceType" : "NutritionProduct",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "

  "code" : { CodeableConcept }, // A code that can identify the product

  "status" : "<code>", // R!  active | inactive | entered-in-error
  "
  "

  "category" : [{ CodeableConcept }], // Broad product groups, like Fruit, Grain, Beverages, or Vegetables Products
  "manufacturer" : [{ Reference(Organization|RelatedPerson) }], // Manufacturer, representative or person officially responsible for the product

  "nutrient" : [{ // The product's nutritional information expressed by the nutrients
    "
    "

    "item" : { CodeableReference(SubstanceDefinition) }, // R!  The (relevant) nutrients in the product
    // amount[x]: The amount of nutrient present in the product. One of these 2:

    "amountRatio" : { Ratio },
    "amountQuantity" : { Quantity }

  }],
  "ingredientSummary" : "<markdown>", // Textual description of product ingredients

  "ingredient" : [{ // Ingredients contained in this product
    "
    "

    "item" : { CodeableReference(NutritionProduct) }, // R!  The ingredient contained in the product
    // amount[x]: The amount of ingredient that is in the product. One of these 2:

    "amountRatio" : { Ratio },
    "amountQuantity" : { Quantity },
    "allergen" : <boolean> // A known or suspected allergenic and/or substance that is associated with an intolerance

  }],
  "

  "energy" : { Quantity }, // The amount of energy present in the product expressed in kilocalories or kilojoules

  "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 or brand 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 of the donation, collection, or pooling event from which biological material in this nutrition product was derived

  }],
  "note" : [{ Annotation }] // Comments made about the product
}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:NutritionProduct;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from 
  # from 
  fhir:

  # from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language
  # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension
  fhir:code [ CodeableConcept ] ; # 0..1 A code that can identify the product

  fhir:status [ code ] ; # 1..1 active | inactive | entered-in-error
  fhir:
  fhir:

  fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* Broad product groups, like Fruit, Grain, Beverages, or Vegetables Products
  fhir:manufacturer  ( [ Reference(Organization|RelatedPerson) ] ... ) ; # 0..* Manufacturer, representative or person officially responsible for the product

  fhir:nutrient ( [ # 0..* The product's nutritional information expressed by the nutrients
    fhir:
    fhir:

    fhir:item [ CodeableReference(SubstanceDefinition) ] ; # 1..1 The (relevant) nutrients in the product
    # amount[x] : 0..1 The amount of nutrient present in the product. One of these 2
      fhir:amount [  a fhir:Ratio ; Ratio ]
      fhir:amount [  a fhir:Quantity ; Quantity ]

  ] ... ) ;
  fhir:ingredientSummary [ markdown ] ; # 0..1 Textual description of product ingredients

  fhir:ingredient ( [ # 0..* Ingredients contained in this product
    fhir:item [ CodeableReference(NutritionProduct) ] ; # 1..1 The ingredient contained in the product
    fhir:

    # amount[x] : 0..1 The amount of ingredient that is in the product. One of these 2
      fhir:amount [  a fhir:Ratio ; Ratio ]
      fhir:amount [  a fhir:Quantity ; Quantity ]
    fhir:allergen [ boolean ] ; # 0..1 A known or suspected allergenic and/or substance that is associated with an intolerance

  ] ... ) ;
  fhir:

  fhir:energy [ Quantity ] ; # 0..1 The amount of energy present in the product expressed in kilocalories or kilojoules

  fhir:characteristic ( [ # 0..* Specifies descriptive properties of the nutrition product
    fhir:type [ CodeableConcept ] ; # 1..1 Code specifying the type of characteristic
    # value[x] : 1..1 The value of the characteristic. One of these 6
      fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
      fhir: ]

      fhir:value [  a fhir:String ; string ]

      fhir:value [  a fhir:SimpleQuantity ; Quantity(SimpleQuantity) ]
      fhir: ]

      fhir:value [  a fhir:Base64Binary ; base64Binary ]

      fhir:value [  a fhir:Attachment ; Attachment ]
      fhir: ]

      fhir:value [  a fhir:Boolean ; boolean ]

  ] ... ) ;
  fhir:instance ( [ # 0..* One or several physical instances or occurrences of the nutrition product
    fhir:quantity [ Quantity(SimpleQuantity) ] ; # 0..1 The amount of items or instances
    fhir:identifier  ( [ Identifier ] ... ) ; # 0..* The identifier for the physical instance, typically a serial number or manufacturer number
    fhir:

    fhir:name [ string ] ; # 0..1 The name or brand for the specific product

    fhir:lotNumber [ string ] ; # 0..1 The identification of the batch or lot of the product
    fhir:expiry [ dateTime ] ; # 0..1 The expiry date or date and time for the product
    fhir:useBy [ dateTime ] ; # 0..1 The date until which the product is expected to be good for consumption
    fhir:

    fhir:biologicalSourceEvent [ Identifier ] ; # 0..1 An identifier of the donation, collection, or pooling event from which biological material in this nutrition product was derived

  ] ... ) ;
  fhir:note  ( [ Annotation ] ... ) ; # 0..* Comments made about the product
]

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

8.32.4.1 8.29.4.1 Terminology Bindings

NutritionProduct.knownAllergen
Path ValueSet Type Documentation
NutritionProduct.code TypesOfEdibleSubstances Example Preferred

This value set represents codes for types of edible substances and is provided as a suggestive example. substances. It include codes from SNOMED CT icon where concept is-a 762766007 Edible Substance (substance). (substance) and its sub-concepts, Infant Formula (412413001) and its sub-concepts, Enteral and Supplement Feeds (346415002) and its sub-concepts, Water (11713004), Potable Water (890302005) and its sub-concepts, and Tap Water (444923006).

NutritionProduct.status NutritionProductStatus Required

Codes identifying the lifecycle stage of a product.

NutritionProduct.category CategoriesOfNutritionProducts Example Preferred

This value set represents codes for types categories of edible substances and is provided as a suggestive example. nutrition products. It includes all of the codes from the Food Type Modifiers valueset. It include codes from SNOMED CT icon where concept has a parent of 255620007 Foods (substance) or has a parent of 226465004 is Breast Milk (226789007) and its sub-concepts, Infant Formula (412413001) and its sub-concepts, Enteral and Supplement Feeds (346415002) and its sub-concepts, Drinks (substance). (226465004) and its sub-concepts, Water (11713004), Potable Water (890302005) and its sub-concepts, and 444923006 (Tap Water).

NutritionProduct.nutrient.item CodesForNutritionProductNutrients NutrientCodes Example

This value set represents codes NutrientModifier : Codes for food types of nutrients and is provided that are being modified such as a suggestive example. It include carbohydrate or sodium. This value set includes codes from SNOMED CT icon where concept has a parent of is-a 226355009 Nutrients (substance). (Nutrients(substance)), and the concepts for Sodium, Potassium and Fluid. This is provided as a suggestive example.

NutritionProduct.ingredient.item CodesForAllergenClasses TypesOfEdibleSubstances Example

This value set represents codes for food nutrients and is provided as a suggestive example. types of edible substances. It include codes from SNOMED CT icon where concept has a parent of 406455002 Allergen class (substance). 762766007 Edible Substance (substance) and its sub-concepts, Infant Formula (412413001) and its sub-concepts, Enteral and Supplement Feeds (346415002) and its sub-concepts, Water (11713004), Potable Water (890302005) and its sub-concepts, and Tap Water (444923006).

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 icon where concept has a parent of 118598001 Property of measurement (qualifier value).

8.32.5 8.29.5 Search Parameters

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
expiration-date date When the product expired (or is expected to expire) NutritionProduct.instance.expiry
identifier token The identifier for the physical instance, typically a serial number NutritionProduct.instance.identifier
ingredient-item token The specific ingredient NutritionProduct.ingredient.item.concept
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