This page is part of the FHIR Specification (v4.4.0: R5 Preview #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B
Orders and Observations Work Group | Maturity Level: 0 | Trial Use | Security Category: Business | Compartments: Not linked to any defined compartments |
A food or fluid product 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.
No resources refer to this resource directly.
This resource does not implement any patterns.
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
NutritionProduct | TU | DomainResource | A product used for nutritional purposes Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
status | ?!Σ | 1..1 | code | active | inactive | entered-in-error NutritionProductStatus (Required) |
category | Σ | 0..* | CodeableConcept | A category or class of the nutrition product (halal, kosher, gluten free, vegan, etc) |
code | Σ | 0..1 | CodeableConcept | A code designating a specific type of nutritional product |
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 | |
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) | Allergens that are known to be a part of this nutrition product | |
productCharacteristic | 0..* | BackboneElement | Specifies descriptive properties of the nutrition product | |
type | 1..1 | CodeableConcept | Code specifying the type of characteristic | |
value[x] | 1..1 | The value of the characteristic | ||
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
valueQuantity | SimpleQuantity | |||
valueBase64Binary | base64Binary | |||
valueAttachment | Attachment | |||
valueBoolean | boolean | |||
instance | 0..1 | 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 | |
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 | |
note | 0..* | Annotation | Comments made about the product | |
Documentation for this format |
UML Diagram (Legend)
XML Template
<NutritionProduct xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <status value="[code]"/><!-- 1..1 active | inactive | entered-in-error --> <category><!-- 0..* CodeableConcept A category or class of the nutrition product (halal, kosher, gluten free, vegan, etc) --></category> <code><!-- 0..1 CodeableConcept A code designating a specific type of nutritional product --></code> <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) Allergens that are known to be a part of this nutrition product --></knownAllergen> <productCharacteristic> <!-- 0..* Specifies descriptive properties of the nutrition product --> <type><!-- 1..1 CodeableConcept Code specifying the type of characteristic --></type> <value[x]><!-- 1..1 CodeableConcept|string|Quantity(SimpleQuantity)| base64Binary|Attachment|boolean The value of the characteristic --></value[x]> </productCharacteristic> <instance> <!-- 0..1 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 --></identifier> <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 --> </instance> <note><!-- 0..* Annotation Comments made about the product --></note> </NutritionProduct>
JSON Template
{ "resourceType" : "NutritionProduct", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "status" : "<code>", // R! active | inactive | entered-in-error "category" : [{ CodeableConcept }], // A category or class of the nutrition product (halal, kosher, gluten free, vegan, etc) "code" : { CodeableConcept }, // A code designating a specific type of nutritional product "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) }], // Allergens that are known to be a part of this nutrition product "productCharacteristic" : [{ // 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 "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 }, "note" : [{ Annotation }] // Comments made about the product }
Turtle Template
@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.status [ code ]; # 1..1 active | inactive | entered-in-error fhir:NutritionProduct.category [ CodeableConcept ], ... ; # 0..* A category or class of the nutrition product (halal, kosher, gluten free, vegan, etc) fhir:NutritionProduct.code [ CodeableConcept ]; # 0..1 A code designating a specific type of nutritional product 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..* Allergens that are known to be a part of this nutrition product fhir:NutritionProduct.productCharacteristic [ # 0..* Specifies descriptive properties of the nutrition product fhir:NutritionProduct.productCharacteristic.type [ CodeableConcept ]; # 1..1 Code specifying the type of characteristic # NutritionProduct.productCharacteristic.value[x] : 1..1 The value of the characteristic. One of these 6 fhir:NutritionProduct.productCharacteristic.valueCodeableConcept [ CodeableConcept ] fhir:NutritionProduct.productCharacteristic.valueString [ string ] fhir:NutritionProduct.productCharacteristic.valueSimpleQuantity [ Quantity(SimpleQuantity) ] fhir:NutritionProduct.productCharacteristic.valueBase64Binary [ base64Binary ] fhir:NutritionProduct.productCharacteristic.valueAttachment [ Attachment ] fhir:NutritionProduct.productCharacteristic.valueBoolean [ boolean ] ], ...; fhir:NutritionProduct.instance [ # 0..1 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 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.note [ Annotation ], ... ; # 0..* Comments made about the product ]
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
NutritionProduct | TU | DomainResource | A product used for nutritional purposes Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
status | ?!Σ | 1..1 | code | active | inactive | entered-in-error NutritionProductStatus (Required) |
category | Σ | 0..* | CodeableConcept | A category or class of the nutrition product (halal, kosher, gluten free, vegan, etc) |
code | Σ | 0..1 | CodeableConcept | A code designating a specific type of nutritional product |
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 | |
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) | Allergens that are known to be a part of this nutrition product | |
productCharacteristic | 0..* | BackboneElement | Specifies descriptive properties of the nutrition product | |
type | 1..1 | CodeableConcept | Code specifying the type of characteristic | |
value[x] | 1..1 | The value of the characteristic | ||
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
valueQuantity | SimpleQuantity | |||
valueBase64Binary | base64Binary | |||
valueAttachment | Attachment | |||
valueBoolean | boolean | |||
instance | 0..1 | 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 | |
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 | |
note | 0..* | Annotation | Comments made about the product | |
Documentation for this format |
XML Template
<NutritionProduct xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <status value="[code]"/><!-- 1..1 active | inactive | entered-in-error --> <category><!-- 0..* CodeableConcept A category or class of the nutrition product (halal, kosher, gluten free, vegan, etc) --></category> <code><!-- 0..1 CodeableConcept A code designating a specific type of nutritional product --></code> <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) Allergens that are known to be a part of this nutrition product --></knownAllergen> <productCharacteristic> <!-- 0..* Specifies descriptive properties of the nutrition product --> <type><!-- 1..1 CodeableConcept Code specifying the type of characteristic --></type> <value[x]><!-- 1..1 CodeableConcept|string|Quantity(SimpleQuantity)| base64Binary|Attachment|boolean The value of the characteristic --></value[x]> </productCharacteristic> <instance> <!-- 0..1 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 --></identifier> <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 --> </instance> <note><!-- 0..* Annotation Comments made about the product --></note> </NutritionProduct>
JSON Template
{ "resourceType" : "NutritionProduct", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "status" : "<code>", // R! active | inactive | entered-in-error "category" : [{ CodeableConcept }], // A category or class of the nutrition product (halal, kosher, gluten free, vegan, etc) "code" : { CodeableConcept }, // A code designating a specific type of nutritional product "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) }], // Allergens that are known to be a part of this nutrition product "productCharacteristic" : [{ // 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 "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 }, "note" : [{ Annotation }] // Comments made about the product }
Turtle Template
@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.status [ code ]; # 1..1 active | inactive | entered-in-error fhir:NutritionProduct.category [ CodeableConcept ], ... ; # 0..* A category or class of the nutrition product (halal, kosher, gluten free, vegan, etc) fhir:NutritionProduct.code [ CodeableConcept ]; # 0..1 A code designating a specific type of nutritional product 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..* Allergens that are known to be a part of this nutrition product fhir:NutritionProduct.productCharacteristic [ # 0..* Specifies descriptive properties of the nutrition product fhir:NutritionProduct.productCharacteristic.type [ CodeableConcept ]; # 1..1 Code specifying the type of characteristic # NutritionProduct.productCharacteristic.value[x] : 1..1 The value of the characteristic. One of these 6 fhir:NutritionProduct.productCharacteristic.valueCodeableConcept [ CodeableConcept ] fhir:NutritionProduct.productCharacteristic.valueString [ string ] fhir:NutritionProduct.productCharacteristic.valueSimpleQuantity [ Quantity(SimpleQuantity) ] fhir:NutritionProduct.productCharacteristic.valueBase64Binary [ base64Binary ] fhir:NutritionProduct.productCharacteristic.valueAttachment [ Attachment ] fhir:NutritionProduct.productCharacteristic.valueBoolean [ boolean ] ], ...; fhir:NutritionProduct.instance [ # 0..1 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 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.note [ Annotation ], ... ; # 0..* Comments made about the product ]
See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis a
Path | Definition | Type | Reference |
---|---|---|---|
NutritionProduct.status | Codes identifying the lifecycle stage of a product. | Required | NutritionProductStatus |
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Expression | In Common |
identifier | token | The identifier for the physical instance, typically a serial number | NutritionProduct.instance.identifier | |
status N | token | active | inactive | entered-in-error | NutritionProduct.status |