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.29 Resource NutritionProduct - Content

Orders and Observations icon Work GroupMaturity Level: 1 Trial UseSecurity Category: Business Compartments: Not linked to any defined compartments

A food or supplement that is consumed by patients.

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.

  • 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

Structure

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. NutritionProduct TUDomainResourceA product used for nutritional purposes (i.e. food or supplement)

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... code Σ0..1CodeableConceptA code that can identify the detailed nutrients and ingredients in a specific food product
Types of Edible Substances (Example)
... status ?!Σ1..1codeactive | inactive | entered-in-error
NutritionProductStatus (Required)
... category Σ0..*CodeableConceptBroad product groups or categories used to classify the product, such as Legume and Legume Products, Beverages, or Beef Products
Categories of Nutrition Products (Example)

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

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

... ingredient 0..*BackboneElementIngredients contained in this product

.... item Σ1..1CodeableReference(NutritionProduct)The ingredient contained in the product
.... amount Σ0..*RatioThe 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..*BackboneElementSpecifies descriptive properties of the nutrition product

.... type 1..1CodeableConceptCode specifying the type of characteristic
Codes for Product Characteristics (Example)
.... value[x] 1..1The value of the characteristic
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueQuantitySimpleQuantity
..... valueBase64Binarybase64Binary
..... valueAttachmentAttachment
..... valueBooleanboolean
... instance 0..*BackboneElementOne or several physical instances or occurrences of the nutrition product

.... quantity 0..1SimpleQuantityThe amount of items or instances
.... identifier 0..*IdentifierThe identifier for the physical instance, typically a serial number or manufacturer number

.... name 0..1stringThe name for the specific product
.... lotNumber 0..1stringThe identification of the batch or lot of the product
.... expiry 0..1dateTimeThe expiry date or date and time for the product
.... useBy 0..1dateTimeThe date until which the product is expected to be good for consumption
.... biologicalSourceEvent 0..1IdentifierAn 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..*AnnotationComments 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 codecode : 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, etccategory : CodeableConcept [0..*] « null (Strength=Example)CategoriesOfNutritionProducts?? »The organisation (manufacturer, representative or legal authorisation holder) that is responsible for the devicemanufacturer : Reference [0..*] « Organization »Allergens that are known or suspected to be a part of this nutrition productknownAllergen : CodeableReference [0..*] « Substance; null (Strength=Example) CodesForAllergenClasses?? »Comments made about the productnote : Annotation [0..*]NutrientThe (relevant) nutrients in the productitem : CodeableReference [0..1] « Substance; null (Strength=Example) CodesForNutritionProductNutri...?? »The amount of nutrient expressed in one or more units: X per pack / per serving / per doseamount : Ratio [0..*]IngredientThe ingredient contained in the productitem : CodeableReference [1..1] « NutritionProduct »The amount of ingredient that is in the productamount : Ratio [0..*]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 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 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>

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

Changes since R4

This resource did not exist in Release 3

This analysis is available as XML or JSON.

Structure

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. NutritionProduct TUDomainResourceA product used for nutritional purposes (i.e. food or supplement)

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... code Σ0..1CodeableConceptA code that can identify the detailed nutrients and ingredients in a specific food product
Types of Edible Substances (Example)
... status ?!Σ1..1codeactive | inactive | entered-in-error
NutritionProductStatus (Required)
... category Σ0..*CodeableConceptBroad product groups or categories used to classify the product, such as Legume and Legume Products, Beverages, or Beef Products
Categories of Nutrition Products (Example)

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

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

... ingredient 0..*BackboneElementIngredients contained in this product

.... item Σ1..1CodeableReference(NutritionProduct)The ingredient contained in the product
.... amount Σ0..*RatioThe 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..*BackboneElementSpecifies descriptive properties of the nutrition product

.... type 1..1CodeableConceptCode specifying the type of characteristic
Codes for Product Characteristics (Example)
.... value[x] 1..1The value of the characteristic
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueQuantitySimpleQuantity
..... valueBase64Binarybase64Binary
..... valueAttachmentAttachment
..... valueBooleanboolean
... instance 0..*BackboneElementOne or several physical instances or occurrences of the nutrition product

.... quantity 0..1SimpleQuantityThe amount of items or instances
.... identifier 0..*IdentifierThe identifier for the physical instance, typically a serial number or manufacturer number

.... name 0..1stringThe name for the specific product
.... lotNumber 0..1stringThe identification of the batch or lot of the product
.... expiry 0..1dateTimeThe expiry date or date and time for the product
.... useBy 0..1dateTimeThe date until which the product is expected to be good for consumption
.... biologicalSourceEvent 0..1IdentifierAn 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..*AnnotationComments 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 codecode : 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, etccategory : CodeableConcept [0..*] « null (Strength=Example)CategoriesOfNutritionProducts?? »The organisation (manufacturer, representative or legal authorisation holder) that is responsible for the devicemanufacturer : Reference [0..*] « Organization »Allergens that are known or suspected to be a part of this nutrition productknownAllergen : CodeableReference [0..*] « Substance; null (Strength=Example) CodesForAllergenClasses?? »Comments made about the productnote : Annotation [0..*]NutrientThe (relevant) nutrients in the productitem : CodeableReference [0..1] « Substance; null (Strength=Example) CodesForNutritionProductNutri...?? »The amount of nutrient expressed in one or more units: X per pack / per serving / per doseamount : Ratio [0..*]IngredientThe ingredient contained in the productitem : CodeableReference [1..1] « NutritionProduct »The amount of ingredient that is in the productamount : Ratio [0..*]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 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 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>

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

Changes since Release 4

This resource did not exist in Release 3

This analysis is available 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

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

ExampleTypesOfEdibleSubstances
NutritionProduct.status

Codes identifying the lifecycle stage of a product.

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

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

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

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

ExampleCodesForProductCharacteristics

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
code NtokenThe code identifying a specific nutrition productNutritionProduct.code
identifiertokenThe identifier for the physical instance, typically a serial numberNutritionProduct.instance.identifier
status NtokenThe broad product group or category of the nutrition productNutritionProduct.category