8.29 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 detailed nutrients and ingredients in a specific food product Types of Edible Substances (Example)
status	?!Σ	1..1	code	active | inactive | entered-in-error NutritionProductStatus (Required)
category	Σ	0..*	CodeableConcept	Broad product groups or categories used to classify the product, such as Legume and Legume Products, Beverages, or Beef Products Categories of Nutrition Products (Example)
manufacturer	Σ	0..*	Reference(Organization)	Manufacturer, representative or officially responsible for the product
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)
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..*	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 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
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 detailed nutrients and ingredients in a specific food product --></code>
 <status value="[code]"/><!-- 1..1 active | inactive | entered-in-error -->
 <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>
 <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 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>

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

@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: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: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: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: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: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
]

This resource did not exist in Release 3

This analysis is available 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 detailed nutrients and ingredients in a specific food product Types of Edible Substances (Example)
status	?!Σ	1..1	code	active | inactive | entered-in-error NutritionProductStatus (Required)
category	Σ	0..*	CodeableConcept	Broad product groups or categories used to classify the product, such as Legume and Legume Products, Beverages, or Beef Products Categories of Nutrition Products (Example)
manufacturer	Σ	0..*	Reference(Organization)	Manufacturer, representative or officially responsible for the product
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)
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..*	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 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
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 detailed nutrients and ingredients in a specific food product --></code>
 <status value="[code]"/><!-- 1..1 active | inactive | entered-in-error -->
 <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>
 <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 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>

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

@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: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: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: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: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: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
]

This resource did not exist in Release 3

This analysis is available as XML or JSON.