8.33 Resource NutritionProduct - Content

Name	Flags	Card.	Type	Description & Constraints
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)
manufacturer	Σ	0..*	Reference(Organization | RelatedPerson)	Manufacturer, representative or person officially responsible for the product
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 Binding: Types of Edible Substances (Example)
amount[x]	Σ	0..1		The amount of ingredient that is in the product
amountRatio			Ratio
amountQuantity			Quantity
allergen		0..1	boolean	A known or suspected allergenic and/or substance that is associated with an intolerance
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 of the donation, collection, or pooling event from which biological material in this nutrition product was derived
note		0..*	Annotation	Comments made about the product
Documentation for this format

See the Extensions for this resource

<NutritionProduct xmlns="http://hl7.org/fhir"> 
 <!-- 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|RelatedPerson) Manufacturer, representative or person 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 A known or suspected allergenic and/or substance that is associated with an intolerance -->
 </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 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>

{
  "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(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> // 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
}

@prefix fhir: <http://hl7.org/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: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|RelatedPerson) ] ... ) ; # 0..* Manufacturer, representative or person 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 A known or suspected allergenic and/or substance that is associated with an intolerance
  ] ... ) ;
  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 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.

Name	Flags	Card.	Type	Description & Constraints
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)
manufacturer	Σ	0..*	Reference(Organization | RelatedPerson)	Manufacturer, representative or person officially responsible for the product
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 Binding: Types of Edible Substances (Example)
amount[x]	Σ	0..1		The amount of ingredient that is in the product
amountRatio			Ratio
amountQuantity			Quantity
allergen		0..1	boolean	A known or suspected allergenic and/or substance that is associated with an intolerance
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 of the donation, collection, or pooling event from which biological material in this nutrition product was derived
note		0..*	Annotation	Comments made about the product
Documentation for this format

See the Extensions for this resource

<NutritionProduct xmlns="http://hl7.org/fhir"> 
 <!-- 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|RelatedPerson) Manufacturer, representative or person 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 A known or suspected allergenic and/or substance that is associated with an intolerance -->
 </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 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>

{
  "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(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> // 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
}

@prefix fhir: <http://hl7.org/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: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|RelatedPerson) ] ... ) ; # 0..* Manufacturer, representative or person 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 A known or suspected allergenic and/or substance that is associated with an intolerance
  ] ... ) ;
  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 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.