FHIR CI-Build

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

8.33 Resource NutritionProduct - Content

Orders and Observations icon Work GroupMaturity Level: 3 Trial UseSecurity Category: Business Compartments: No defined compartments

A food or supplement that is consumed by patients.

8.33.1 Scope and Usage

The NutritionProduct resource represents the identification of a food (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 (i.e., solid and/or liquid) products for human consumption.

8.33.2 Boundaries and Relationships

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

8.33.3 References to this Resource

8.33.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... code Σ 0..1 CodeableConcept A code that can identify the product
Binding: Types of Edible Substances (Preferred)
... status ?!Σ 1..1 code active | inactive | entered-in-error
Binding: Nutrition Product Status (Required)
... category Σ 0..* CodeableConcept Broad product groups, like Fruit, Grain, Beverages, or Vegetables Products
Binding: Categories of Nutrition Products (Preferred)

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

.... item Σ 1..1 CodeableReference(Substance) The (relevant) nutrients in the product
Binding: Nutrient Codes (Example)
.... amount[x] 0..1 The amount of nutrient present in the product
..... amountRatio Ratio
..... 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
.... amount[x] Σ 0..1 The amount of ingredient that is in the product
..... amountRatio Ratio
..... amountQuantity Quantity
.... allergen 0..1 boolean Known or suspected substances that are a part of this product
... energy 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 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)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 codecode : CodeableConcept [0..1] « null (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 fall into various categories based on their composition (e.g., Fruit and Grain, Vegetables) or form (e.g., Beverages)category : CodeableConcept [0..*] « null (Strength=Preferred)CategoriesOfNutritionProducts? »The organisation (manufacturer, representative or legal authorization holder) that is responsible for the devicemanufacturer : Reference [0..*] « Organization »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'ingredientSummary : markdown [0..1]The amount of energy present in the product expressed in kilocalories or kilojoulesenergy : Quantity [0..1]Comments made about the productnote : Annotation [0..*]NutrientThe (relevant) nutrients in the productitem : CodeableReference [1..1] « Substance; null (Strength=Example)NutrientCodes?? »The amount of nutrient expressed in one or more units, either X per pack / per serving / per dose or X amountamount[x] : DataType [0..1] « Ratio|Quantity »IngredientThe ingredient contained in the productitem : CodeableReference [1..1] « NutritionProduct »The amount of ingredient that is in the productamount[x] : DataType [0..1] « Ratio|Quantity »Substances associated with allergies and/or intolerances that a part of this productallergen : boolean [0..1]CharacteristicA 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 typevalue[x] : DataType [1..1] « CodeableConcept|string|Quantity(SimpleQuantity)| base64Binary|Attachment|boolean »InstanceThe amount of items or instances that the resource considers, for instance when referring to 2 identical units togetherquantity : Quantity(SimpleQuantity) [0..1]The identifier for the physical instance, typically a serial number or manufacturer numberidentifier : Identifier [0..*]The name or brand for the specific productname : string [0..1]The identification of the batch or lot of the productlotNumber : 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 allowedexpiry : 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 alloweduseBy : 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 pooledbiologicalSourceEvent : Identifier [0..1]The product's nutritional information expressed by the nutrientsnutrient[0..*]Ingredients contained in this productingredient[0..*]Specifies descriptive properties of the nutrition productcharacteristic[0..*]Conveys instance-level information about this product item. One or several physical, countable instances or occurrences of the productinstance[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 product --></code>
 <status value="[code]"/><!-- 1..1 active | inactive | entered-in-error -->
 <category><!-- 0..* CodeableConcept Broad product groups, like Fruit, Grain, Beverages, or Vegetables 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><!-- 1..1 CodeableReference(Substance) 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><!-- 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 Known or suspected substances that are a part of this product -->
 </ingredient>
 <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><!-- 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" : "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) }], // Manufacturer, representative or officially responsible for the product
  "nutrient" : [{ // The product's nutritional information expressed by the nutrients
    "item" : { CodeableReference(Substance) }, // 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> // Known or suspected substances that are a part of this product
  }],
  "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 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: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:code [ CodeableConcept ] ; # 0..1 A code that can identify the product
  fhir:status [ code ] ; # 1..1 active | inactive | entered-in-error
  fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* Broad product groups, like Fruit, Grain, Beverages, or Vegetables Products
  fhir:manufacturer  ( [ Reference(Organization) ] ... ) ; # 0..* Manufacturer, representative or officially responsible for the product
  fhir:nutrient ( [ # 0..* The product's nutritional information expressed by the nutrients
    fhir:item [ CodeableReference(Substance) ] ; # 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
    # 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 Known or suspected substances that are a part of this product
  ] ... ) ;
  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:value [  a fhir:string ; string ]
      fhir:value [  a fhir:SimpleQuantity ; Quantity(SimpleQuantity) ]
      fhir:value [  a fhir:base64Binary ; base64Binary ]
      fhir:value [  a fhir:Attachment ; Attachment ]
      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: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: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: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

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... code Σ 0..1 CodeableConcept A code that can identify the product
Binding: Types of Edible Substances (Preferred)
... status ?!Σ 1..1 code active | inactive | entered-in-error
Binding: Nutrition Product Status (Required)
... category Σ 0..* CodeableConcept Broad product groups, like Fruit, Grain, Beverages, or Vegetables Products
Binding: Categories of Nutrition Products (Preferred)

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

.... item Σ 1..1 CodeableReference(Substance) The (relevant) nutrients in the product
Binding: Nutrient Codes (Example)
.... amount[x] 0..1 The amount of nutrient present in the product
..... amountRatio Ratio
..... 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
.... amount[x] Σ 0..1 The amount of ingredient that is in the product
..... amountRatio Ratio
..... amountQuantity Quantity
.... allergen 0..1 boolean Known or suspected substances that are a part of this product
... energy 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 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)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 codecode : CodeableConcept [0..1] « null (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 fall into various categories based on their composition (e.g., Fruit and Grain, Vegetables) or form (e.g., Beverages)category : CodeableConcept [0..*] « null (Strength=Preferred)CategoriesOfNutritionProducts? »The organisation (manufacturer, representative or legal authorization holder) that is responsible for the devicemanufacturer : Reference [0..*] « Organization »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'ingredientSummary : markdown [0..1]The amount of energy present in the product expressed in kilocalories or kilojoulesenergy : Quantity [0..1]Comments made about the productnote : Annotation [0..*]NutrientThe (relevant) nutrients in the productitem : CodeableReference [1..1] « Substance; null (Strength=Example)NutrientCodes?? »The amount of nutrient expressed in one or more units, either X per pack / per serving / per dose or X amountamount[x] : DataType [0..1] « Ratio|Quantity »IngredientThe ingredient contained in the productitem : CodeableReference [1..1] « NutritionProduct »The amount of ingredient that is in the productamount[x] : DataType [0..1] « Ratio|Quantity »Substances associated with allergies and/or intolerances that a part of this productallergen : boolean [0..1]CharacteristicA 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 typevalue[x] : DataType [1..1] « CodeableConcept|string|Quantity(SimpleQuantity)| base64Binary|Attachment|boolean »InstanceThe amount of items or instances that the resource considers, for instance when referring to 2 identical units togetherquantity : Quantity(SimpleQuantity) [0..1]The identifier for the physical instance, typically a serial number or manufacturer numberidentifier : Identifier [0..*]The name or brand for the specific productname : string [0..1]The identification of the batch or lot of the productlotNumber : 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 allowedexpiry : 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 alloweduseBy : 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 pooledbiologicalSourceEvent : Identifier [0..1]The product's nutritional information expressed by the nutrientsnutrient[0..*]Ingredients contained in this productingredient[0..*]Specifies descriptive properties of the nutrition productcharacteristic[0..*]Conveys instance-level information about this product item. One or several physical, countable instances or occurrences of the productinstance[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 product --></code>
 <status value="[code]"/><!-- 1..1 active | inactive | entered-in-error -->
 <category><!-- 0..* CodeableConcept Broad product groups, like Fruit, Grain, Beverages, or Vegetables 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><!-- 1..1 CodeableReference(Substance) 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><!-- 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 Known or suspected substances that are a part of this product -->
 </ingredient>
 <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><!-- 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" : "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) }], // Manufacturer, representative or officially responsible for the product
  "nutrient" : [{ // The product's nutritional information expressed by the nutrients
    "item" : { CodeableReference(Substance) }, // 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> // Known or suspected substances that are a part of this product
  }],
  "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 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: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:code [ CodeableConcept ] ; # 0..1 A code that can identify the product
  fhir:status [ code ] ; # 1..1 active | inactive | entered-in-error
  fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* Broad product groups, like Fruit, Grain, Beverages, or Vegetables Products
  fhir:manufacturer  ( [ Reference(Organization) ] ... ) ; # 0..* Manufacturer, representative or officially responsible for the product
  fhir:nutrient ( [ # 0..* The product's nutritional information expressed by the nutrients
    fhir:item [ CodeableReference(Substance) ] ; # 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
    # 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 Known or suspected substances that are a part of this product
  ] ... ) ;
  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:value [  a fhir:string ; string ]
      fhir:value [  a fhir:SimpleQuantity ; Quantity(SimpleQuantity) ]
      fhir:value [  a fhir:base64Binary ; base64Binary ]
      fhir:value [  a fhir:Attachment ; Attachment ]
      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: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: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: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.33.4.1 Terminology Bindings

Path ValueSet Type Documentation
NutritionProduct.code TypesOfEdibleSubstances Preferred

This value set represents codes for types of edible substances. It include codes from SNOMED CT icon where concept 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.status NutritionProductStatus Required

Codes identifying the lifecycle stage of a product.
NutritionProduct.category CategoriesOfNutritionProducts Preferred

This value set represents codes for categories of nutrition products. It includes all of the codes from the Food Type Modifiers valueset. It include codes from SNOMED CT icon where concept 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 (226465004) and its sub-concepts, Water (11713004), Potable Water (890302005) and its sub-concepts, and 444923006 (Tap Water).
NutritionProduct.nutrient.item NutrientCodes Example

NutrientModifier : Codes for types of nutrients that are being modified such as carbohydrate or sodium. This value set includes codes from SNOMED CT icon where concept is-a 226355009 (Nutrients(substance)), and the concepts for Sodium, Potassium and Fluid. This is provided as a suggestive example.
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.33.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
identifier token The identifier for the physical instance, typically a serial number NutritionProduct.instance.identifier
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