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

8.29 Resource NutritionProduct - Content

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

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

8.29.1 Scope and Usage

The NutritionProduct resource represents the identification of a food or fluid product consumed by patients. The scope of the NutritionProduct resource includes all the products that are understood to be food and beverage products for human consumption.

8.29.2 Boundaries and Relationships

  • Oral intake of food, fluids, oral nutritional supplements (i.e. Ensure), or enteral nutrition should be recorded using the NutritionIntake resource.
  • Supplements, such as vitamins, minerals, herbals, should be recorded using the medication resources
  • Parenteral nutrition should be recorded using the medication resources

8.29.3 References to this Resource

This resource is referenced by itself,

8.29.4 Resource Content

Structure

Name icon Flags icon Card. icon Type icon Description & Constraints icon doco icon
. . NutritionProduct TU DomainResource A product used for nutritional purposes (i.e. food or supplement)

Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . status . code ?! Σ 1..1 0..1 code CodeableConcept active | inactive | entered-in-error A code that can identify the detailed nutrients and ingredients in a specific food product
NutritionProductStatus Types of Edible Substances ( Required Example )
. . category . status ?! Σ 0..* 1..1 CodeableConcept code A category or class of the nutrition product (halal, kosher, gluten free, vegan, etc) active | inactive | entered-in-error
Categories of Nutrition Products NutritionProductStatus ( Example Required )
. . . code category Σ 0..1 0..* CodeableConcept A code designating a specific type of nutritional Broad product groups or categories used to classify the product, such as Legume and Legume Products, Beverages, or Beef Products
NutritionProductCode Categories of Nutrition Products ( Example )

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

. . . . item 0..1 CodeableReference ( Substance ) The (relevant) nutrients in the product
Codes for Nutrition Product Nutrients ( Example )
. . . . amount 0..* Ratio The amount of nutrient expressed in one or more units: X per pack / per serving / per dose

. . . ingredient 0..* BackboneElement Ingredients contained in this product

. . . . item Σ 1..1 CodeableReference ( NutritionProduct ) The ingredient contained in the product
. . . . amount Σ 0..* Ratio The amount of ingredient that is in the product

. . . knownAllergen 0..* CodeableReference ( Substance ) Known or suspected allergens that are a part of this product
Codes for Allergen Classes ( Example )

. . . productCharacteristic characteristic 0..* BackboneElement Specifies descriptive properties of the nutrition product

. . . . type 1..1 CodeableConcept Code specifying the type of characteristic
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..1 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

. . . . lotNumber name 0..1 string The name 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 the event during which material in this product from one or more biological entities was obtained or pooled
. . . 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 code assigned to the product, for example a USDA NDB number, a USDA FDC ID number, or a Langual code code : CodeableConcept [0..1] « null (Strength=Example) 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 category : CodeableConcept [0..*] « null (Strength=Example) Categories of Nutrition Produ... ?? » The code assigned to the product, for example a manufacturer number or other terminology code : CodeableConcept [0..1] « null (Strength=Example) NutritionProductCode CategoriesOfNutritionProducts ?? » The organisation (manufacturer, representative or legal authorisation holder) that is responsible for the device manufacturer : Reference [0..*] « Organization » Allergens that are known or suspected to be a part of this nutrition product knownAllergen : Element CodeableReference [0..*] « Substance ; null (Strength=Example) Codes for Allergen Classes CodesForAllergenClasses ?? » Comments made about the product note : Annotation [0..*] Nutrient The (relevant) nutrients in the product item : Element CodeableReference [0..1] « Substance ; null (Strength=Example) Codes for Nutrition Product N... CodesForNutritionProductNutri... ?? » The amount of nutrient expressed in one or more units: X per pack / per serving / per dose amount : Ratio [0..*] Ingredient The ingredient contained in the product item : Element CodeableReference [1..1] « NutritionProduct » The amount of ingredient that is in the product amount : Ratio [0..*] ProductCharacteristic Characteristic A code specifying which characteristic of the product is being described (for example, colour, shape) type : CodeableConcept [1..1] « null (Strength=Example) Codes for Product Characteris... CodesForProductCharacteristics ?? » The actual characteristic value corresponding to the type value[x] : Element 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 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 the event during which material in this product from one or more biological entities was obtained or pooled 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 productCharacteristic characteristic [0..*] Conveys instance-level information about this product item. One or several physical, countable instances or occurrences of the product instance [0..1] [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><!-- 0..1 CodeableConcept A code that can identify the detailed nutrients and ingredients in a specific food product --></code>

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

 <category><!-- 0..* CodeableConcept Broad product groups or categories used to classify the product, such as Legume and Legume Products, Beverages, or Beef Products --></category>

 <manufacturer><!-- 0..* Reference(Organization) Manufacturer, representative or officially responsible for the product --></manufacturer>
 <nutrient>  <!-- 0..* The product's nutritional information expressed by the nutrients -->
  <item><!-- 0..1 CodeableReference(Substance) The (relevant) nutrients in the product --></item>
  <amount><!-- 0..* Ratio The amount of nutrient expressed in one or more units: X per pack / per serving / per dose --></amount>
 </nutrient>
 <ingredient>  <!-- 0..* Ingredients contained in this product -->
  <item><!-- 1..1 CodeableReference(NutritionProduct) The ingredient contained in the product --></item>
  <amount><!-- 0..* Ratio The amount of ingredient that is in the product --></amount>
 </ingredient>
 <knownAllergen><!-- 0..* CodeableReference(Substance) Known or suspected allergens that are a part of this product --></knownAllergen>
 <
  <</type>
  <)|

 <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]>
 </productCharacteristic>
 <

 </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>

  <identifier><!-- 0..* Identifier The identifier for the physical instance, typically a serial number or manufacturer number --></identifier>
  <name value="[string]"/><!-- 0..1 The name 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><!-- 0..1 Identifier An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled --></biologicalSourceEvent>

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

JSON Template 

{doco
  "resourceType" : "",

  "resourceType" : "NutritionProduct",

  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "code" : { CodeableConcept }, // A code that can identify the detailed nutrients and ingredients in a specific food product

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

  "category" : [{ CodeableConcept }], // Broad product groups or categories used to classify the product, such as Legume and Legume Products, Beverages, or Beef Products

  "manufacturer" : [{ Reference(Organization) }], // Manufacturer, representative or officially responsible for the product
  "nutrient" : [{ // The product's nutritional information expressed by the nutrients
    "item" : { CodeableReference(Substance) }, // The (relevant) nutrients in the product
    "amount" : [{ Ratio }] // The amount of nutrient expressed in one or more units: X per pack / per serving / per dose
  }],
  "ingredient" : [{ // Ingredients contained in this product
    "item" : { CodeableReference(NutritionProduct) }, // R!  The ingredient contained in the product
    "amount" : [{ Ratio }] // The amount of ingredient that is in the product
  }],
  "knownAllergen" : [{ CodeableReference(Substance) }], // Known or suspected allergens that are a part of this product
  "
    "

  "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 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 that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled
  }],

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

Turtle Template 

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


[ a fhir:;

[ a fhir:NutritionProduct;

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

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:NutritionProduct.code [ CodeableConcept ]; # 0..1 A code that can identify the detailed nutrients and ingredients in a specific food product

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

  fhir:NutritionProduct.category [ CodeableConcept ], ... ; # 0..* Broad product groups or categories used to classify the product, such as Legume and Legume Products, Beverages, or Beef Products

  fhir:NutritionProduct.manufacturer [ Reference(Organization) ], ... ; # 0..* Manufacturer, representative or officially responsible for the product
  fhir:NutritionProduct.nutrient [ # 0..* The product's nutritional information expressed by the nutrients
    fhir:NutritionProduct.nutrient.item [ CodeableReference(Substance) ]; # 0..1 The (relevant) nutrients in the product
    fhir:NutritionProduct.nutrient.amount [ Ratio ], ... ; # 0..* The amount of nutrient expressed in one or more units: X per pack / per serving / per dose
  ], ...;
  fhir:NutritionProduct.ingredient [ # 0..* Ingredients contained in this product
    fhir:NutritionProduct.ingredient.item [ CodeableReference(NutritionProduct) ]; # 1..1 The ingredient contained in the product
    fhir:NutritionProduct.ingredient.amount [ Ratio ], ... ; # 0..* The amount of ingredient that is in the product
  ], ...;
  fhir:NutritionProduct.knownAllergen [ CodeableReference(Substance) ], ... ; # 0..* Known or suspected allergens that are a part of this product
  fhir:
    fhir:
    # . One of these 6
      fhir: ]
      fhir: ]
      fhir:) ]
      fhir: ]
      fhir: ]
      fhir: ]

  fhir:NutritionProduct.characteristic [ # 0..* Specifies descriptive properties of the nutrition product
    fhir:NutritionProduct.characteristic.type [ CodeableConcept ]; # 1..1 Code specifying the type of characteristic
    # NutritionProduct.characteristic.value[x] : 1..1 The value of the characteristic. One of these 6
      fhir:NutritionProduct.characteristic.valueCodeableConcept [ CodeableConcept ]
      fhir:NutritionProduct.characteristic.valueString [ string ]
      fhir:NutritionProduct.characteristic.valueSimpleQuantity [ Quantity(SimpleQuantity) ]
      fhir:NutritionProduct.characteristic.valueBase64Binary [ base64Binary ]
      fhir:NutritionProduct.characteristic.valueAttachment [ Attachment ]
      fhir:NutritionProduct.characteristic.valueBoolean [ boolean ]

  ], ...;
  fhir:

  fhir:NutritionProduct.instance [ # 0..* One or several physical instances or occurrences of the nutrition product

    fhir:NutritionProduct.instance.quantity [ Quantity(SimpleQuantity) ]; # 0..1 The amount of items or instances
    fhir:

    fhir:NutritionProduct.instance.identifier [ Identifier ], ... ; # 0..* The identifier for the physical instance, typically a serial number or manufacturer number
    fhir:NutritionProduct.instance.name [ string ]; # 0..1 The name for the specific product

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

    fhir:NutritionProduct.instance.biologicalSourceEvent [ Identifier ]; # 0..1 An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled
  ], ...;

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

Changes since R4

This resource did not exist in Release 3

This analysis is available as XML or JSON .

Conversions between R3 and R4

Structure

Name icon Flags icon Card. icon Type icon Description & Constraints icon doco icon
. . NutritionProduct TU DomainResource A product used for nutritional purposes (i.e. food or supplement)

Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . status . code ?! Σ 1..1 0..1 code CodeableConcept active | inactive | entered-in-error A code that can identify the detailed nutrients and ingredients in a specific food product
NutritionProductStatus Types of Edible Substances ( Required Example )
. . category . status ?! Σ 0..* 1..1 CodeableConcept code A category or class of the nutrition product (halal, kosher, gluten free, vegan, etc) active | inactive | entered-in-error
Categories of Nutrition Products NutritionProductStatus ( Example Required )
. . . code category Σ 0..1 0..* CodeableConcept A code designating a specific type of nutritional Broad product groups or categories used to classify the product, such as Legume and Legume Products, Beverages, or Beef Products
NutritionProductCode Categories of Nutrition Products ( Example )

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

. . . . item 0..1 CodeableReference ( Substance ) The (relevant) nutrients in the product
Codes for Nutrition Product Nutrients ( Example )
. . . . amount 0..* Ratio The amount of nutrient expressed in one or more units: X per pack / per serving / per dose

. . . ingredient 0..* BackboneElement Ingredients contained in this product

. . . . item Σ 1..1 CodeableReference ( NutritionProduct ) The ingredient contained in the product
. . . . amount Σ 0..* Ratio The amount of ingredient that is in the product

. . . knownAllergen 0..* CodeableReference ( Substance ) Known or suspected allergens that are a part of this product
Codes for Allergen Classes ( Example )

. . . productCharacteristic characteristic 0..* BackboneElement Specifies descriptive properties of the nutrition product

. . . . type 1..1 CodeableConcept Code specifying the type of characteristic
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..1 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

. . . . lotNumber name 0..1 string The name 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 the event during which material in this product from one or more biological entities was obtained or pooled
. . . 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 code assigned to the product, for example a USDA NDB number, a USDA FDC ID number, or a Langual code code : CodeableConcept [0..1] « null (Strength=Example) 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 category : CodeableConcept [0..*] « null (Strength=Example) Categories of Nutrition Produ... ?? » The code assigned to the product, for example a manufacturer number or other terminology code : CodeableConcept [0..1] « null (Strength=Example) NutritionProductCode CategoriesOfNutritionProducts ?? » The organisation (manufacturer, representative or legal authorisation holder) that is responsible for the device manufacturer : Reference [0..*] « Organization » Allergens that are known or suspected to be a part of this nutrition product knownAllergen : Element CodeableReference [0..*] « Substance ; null (Strength=Example) Codes for Allergen Classes CodesForAllergenClasses ?? » Comments made about the product note : Annotation [0..*] Nutrient The (relevant) nutrients in the product item : Element CodeableReference [0..1] « Substance ; null (Strength=Example) Codes for Nutrition Product N... CodesForNutritionProductNutri... ?? » The amount of nutrient expressed in one or more units: X per pack / per serving / per dose amount : Ratio [0..*] Ingredient The ingredient contained in the product item : Element CodeableReference [1..1] « NutritionProduct » The amount of ingredient that is in the product amount : Ratio [0..*] ProductCharacteristic Characteristic A code specifying which characteristic of the product is being described (for example, colour, shape) type : CodeableConcept [1..1] « null (Strength=Example) Codes for Product Characteris... CodesForProductCharacteristics ?? » The actual characteristic value corresponding to the type value[x] : Element 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 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 the event during which material in this product from one or more biological entities was obtained or pooled 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 productCharacteristic characteristic [0..*] Conveys instance-level information about this product item. One or several physical, countable instances or occurrences of the product instance [0..1] [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><!-- 0..1 CodeableConcept A code that can identify the detailed nutrients and ingredients in a specific food product --></code>

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

 <category><!-- 0..* CodeableConcept Broad product groups or categories used to classify the product, such as Legume and Legume Products, Beverages, or Beef Products --></category>

 <manufacturer><!-- 0..* Reference(Organization) Manufacturer, representative or officially responsible for the product --></manufacturer>
 <nutrient>  <!-- 0..* The product's nutritional information expressed by the nutrients -->
  <item><!-- 0..1 CodeableReference(Substance) The (relevant) nutrients in the product --></item>
  <amount><!-- 0..* Ratio The amount of nutrient expressed in one or more units: X per pack / per serving / per dose --></amount>
 </nutrient>
 <ingredient>  <!-- 0..* Ingredients contained in this product -->
  <item><!-- 1..1 CodeableReference(NutritionProduct) The ingredient contained in the product --></item>
  <amount><!-- 0..* Ratio The amount of ingredient that is in the product --></amount>
 </ingredient>
 <knownAllergen><!-- 0..* CodeableReference(Substance) Known or suspected allergens that are a part of this product --></knownAllergen>
 <
  <</type>
  <)|

 <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]>
 </productCharacteristic>
 <

 </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>

  <identifier><!-- 0..* Identifier The identifier for the physical instance, typically a serial number or manufacturer number --></identifier>
  <name value="[string]"/><!-- 0..1 The name 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><!-- 0..1 Identifier An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled --></biologicalSourceEvent>

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

JSON Template 

{doco
  "resourceType" : "",

  "resourceType" : "NutritionProduct",

  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "code" : { CodeableConcept }, // A code that can identify the detailed nutrients and ingredients in a specific food product

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

  "category" : [{ CodeableConcept }], // Broad product groups or categories used to classify the product, such as Legume and Legume Products, Beverages, or Beef Products

  "manufacturer" : [{ Reference(Organization) }], // Manufacturer, representative or officially responsible for the product
  "nutrient" : [{ // The product's nutritional information expressed by the nutrients
    "item" : { CodeableReference(Substance) }, // The (relevant) nutrients in the product
    "amount" : [{ Ratio }] // The amount of nutrient expressed in one or more units: X per pack / per serving / per dose
  }],
  "ingredient" : [{ // Ingredients contained in this product
    "item" : { CodeableReference(NutritionProduct) }, // R!  The ingredient contained in the product
    "amount" : [{ Ratio }] // The amount of ingredient that is in the product
  }],
  "knownAllergen" : [{ CodeableReference(Substance) }], // Known or suspected allergens that are a part of this product
  "
    "

  "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 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 that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled
  }],

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

Turtle Template 

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


[ a fhir:;

[ a fhir:NutritionProduct;

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

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:NutritionProduct.code [ CodeableConcept ]; # 0..1 A code that can identify the detailed nutrients and ingredients in a specific food product

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

  fhir:NutritionProduct.category [ CodeableConcept ], ... ; # 0..* Broad product groups or categories used to classify the product, such as Legume and Legume Products, Beverages, or Beef Products

  fhir:NutritionProduct.manufacturer [ Reference(Organization) ], ... ; # 0..* Manufacturer, representative or officially responsible for the product
  fhir:NutritionProduct.nutrient [ # 0..* The product's nutritional information expressed by the nutrients
    fhir:NutritionProduct.nutrient.item [ CodeableReference(Substance) ]; # 0..1 The (relevant) nutrients in the product
    fhir:NutritionProduct.nutrient.amount [ Ratio ], ... ; # 0..* The amount of nutrient expressed in one or more units: X per pack / per serving / per dose
  ], ...;
  fhir:NutritionProduct.ingredient [ # 0..* Ingredients contained in this product
    fhir:NutritionProduct.ingredient.item [ CodeableReference(NutritionProduct) ]; # 1..1 The ingredient contained in the product
    fhir:NutritionProduct.ingredient.amount [ Ratio ], ... ; # 0..* The amount of ingredient that is in the product
  ], ...;
  fhir:NutritionProduct.knownAllergen [ CodeableReference(Substance) ], ... ; # 0..* Known or suspected allergens that are a part of this product
  fhir:
    fhir:
    # . One of these 6
      fhir: ]
      fhir: ]
      fhir:) ]
      fhir: ]
      fhir: ]
      fhir: ]

  fhir:NutritionProduct.characteristic [ # 0..* Specifies descriptive properties of the nutrition product
    fhir:NutritionProduct.characteristic.type [ CodeableConcept ]; # 1..1 Code specifying the type of characteristic
    # NutritionProduct.characteristic.value[x] : 1..1 The value of the characteristic. One of these 6
      fhir:NutritionProduct.characteristic.valueCodeableConcept [ CodeableConcept ]
      fhir:NutritionProduct.characteristic.valueString [ string ]
      fhir:NutritionProduct.characteristic.valueSimpleQuantity [ Quantity(SimpleQuantity) ]
      fhir:NutritionProduct.characteristic.valueBase64Binary [ base64Binary ]
      fhir:NutritionProduct.characteristic.valueAttachment [ Attachment ]
      fhir:NutritionProduct.characteristic.valueBoolean [ boolean ]

  ], ...;
  fhir:

  fhir:NutritionProduct.instance [ # 0..* One or several physical instances or occurrences of the nutrition product

    fhir:NutritionProduct.instance.quantity [ Quantity(SimpleQuantity) ]; # 0..1 The amount of items or instances
    fhir:

    fhir:NutritionProduct.instance.identifier [ Identifier ], ... ; # 0..* The identifier for the physical instance, typically a serial number or manufacturer number
    fhir:NutritionProduct.instance.name [ string ]; # 0..1 The name for the specific product

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

    fhir:NutritionProduct.instance.biologicalSourceEvent [ Identifier ]; # 0..1 An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled
  ], ...;

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

Changes since Release 4

This resource did not exist in Release 3

This analysis is available as XML or JSON .

Conversions between R3 and R4

 

See the Profiles & Extensions and the alternate Additional definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions , the spreadsheet version & the dependency analysis

8.29.4.1 Terminology Bindings

NutritionProduct.status NutritionProduct.category NutritionProduct.code
Path Definition Type Reference
NutritionProduct.code

This value set represents codes for types of edible substances and is provided as a suggestive example. It include codes from SNOMED CT icon where concept is-a 762766007 Edible Substance (substance).

Required Example NutritionProductStatus TypesOfEdibleSubstances
NutritionProduct.status

Codes identifying the lifecycle stage of a product.

Example Required Categories of Nutrition Products NutritionProductStatus
NutritionProduct.category

This value set represents codes for types of edible substances and is provided as a suggestive example. It include codes from SNOMED CT icon where concept has a parent of 255620007 Foods (substance) or has a parent of 226465004 Drinks (substance).

Example http://hl7.org/fhir/ValueSet/edible-substance-type CategoriesOfNutritionProducts
NutritionProduct.nutrient.item

This value set represents codes for food nutrients and is provided as a suggestive example. It include codes from SNOMED CT icon where concept has a parent of 226355009 Nutrients (substance).

Example Codes for Nutrition Product Nutrients CodesForNutritionProductNutrients
NutritionProduct.knownAllergen

This value set represents codes for food nutrients and is provided as a suggestive example. It include codes from SNOMED CT icon where concept has a parent of 406455002 Allergen class (substance).

Example Codes for Allergen Classes CodesForAllergenClasses
NutritionProduct.productCharacteristic.type NutritionProduct.characteristic.type

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).

Example Codes for Product Characteristics CodesForProductCharacteristics

8.29.5 Search Parameters

Search parameters for 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
identifier token The identifier for the physical instance, typically a serial number NutritionProduct.instance.identifier
status N token active | inactive | entered-in-error The broad product group or category of the nutrition product NutritionProduct.status NutritionProduct.category