QI-Core Implementation Guide
6.0.0-ballot - ballot United States of America flag

This page is part of the Quality Improvement Core Framework (v6.0.0-ballot: STU6 (v6.0.0) Ballot 1) based on FHIR R4. The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: QICore NutritionOrder

Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-nutritionorder Version: 6.0.0-ballot
Active as of 2022-12-20 Computable Name: QICoreNutritionOrder

Defines constraints and extensions on the NutritionOrder resource for the minimal set of data to query and retrieve a patient’s Nutrition Order.

Usage

See the patterns page for implementation and usage patterns.

Examples

Diabetic diet example

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from NutritionOrder

NameFlagsCard.TypeDescription & Constraintsdoco
.. NutritionOrder 0..*NutritionOrderDiet, formula or nutritional supplement request
... identifier 0..*IdentifierIdentifiers assigned to this order
... patient S1..1Reference(QICore Patient)The person who requires the diet, formula or nutritional supplement

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. NutritionOrder C0..*NutritionOrderDiet, formula or nutritional supplement request
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierIdentifiers assigned to this order
... intent ?!Σ1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a nutrition order.

... patient SΣ1..1Reference(QICore Patient)The person who requires the diet, formula or nutritional supplement
... dateTime Σ1..1dateTimeDate and time the nutrition order was requested

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
NutritionOrder.statusrequiredRequestStatus
NutritionOrder.intentrequiredRequestIntent

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorNutritionOrderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorNutritionOrderIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorNutritionOrderIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorNutritionOrderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceNutritionOrderA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
nor-1warningNutritionOrderNutrition Order SHALL contain either Oral Diet , Supplement, or Enteral Formula class
: oralDiet.exists() or supplement.exists() or enteralFormula.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. NutritionOrder C0..*NutritionOrderDiet, formula or nutritional supplement request
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierIdentifiers assigned to this order
... instantiatesCanonical Σ0..*canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... instantiates 0..*uriInstantiates protocol or definition
... status ?!Σ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Codes identifying the lifecycle stage of the nutrition order.

... intent ?!Σ1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a nutrition order.

... patient SΣ1..1Reference(QICore Patient)The person who requires the diet, formula or nutritional supplement
... encounter 0..1Reference(Encounter)The encounter associated with this nutrition order
... dateTime Σ1..1dateTimeDate and time the nutrition order was requested
... orderer Σ0..1Reference(Practitioner | PractitionerRole)Who ordered the diet, formula or nutritional supplement
... allergyIntolerance 0..*Reference(AllergyIntolerance)List of the patient's food and nutrition-related allergies and intolerances
... foodPreferenceModifier 0..*CodeableConceptOrder-specific modifier about the type of food that should be given
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.


... excludeFoodModifier 0..*CodeableConceptOrder-specific modifier about the type of food that should not be given
Binding: FoodTypeCodes (example): Codes used to indicate the type of food that should NOT be given to the patient.


... oralDiet C0..1BackboneElementOral diet components
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..*CodeableConceptType of oral diet or diet restrictions that describe what can be consumed orally
Binding: DietCodes (example): Codes used to indicate the type of diet being ordered for a patient.


.... schedule 0..*TimingScheduled frequency of diet
.... nutrient 0..*BackboneElementRequired nutrient modifications
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... modifier 0..1CodeableConceptType of nutrient that is being modified
Binding: NutrientModifierCodes (example): Codes for types of nutrients that are being modified such as carbohydrate or sodium.

..... amount 0..1SimpleQuantityQuantity of the specified nutrient
.... texture 0..*BackboneElementRequired texture modifications
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... modifier 0..1CodeableConceptCode to indicate how to alter the texture of the foods, e.g. pureed
Binding: TextureModifierCodes (example): Codes for food consistency types or texture modifications to apply to foods.

..... foodType 0..1CodeableConceptConcepts that are used to identify an entity that is ingested for nutritional purposes
Binding: TextureModifiedFoodTypeCodes (example): Codes for types of foods that are texture-modified.

.... fluidConsistencyType 0..*CodeableConceptThe required consistency of fluids and liquids provided to the patient
Binding: FluidConsistencyTypeCodes (example): Codes used to represent the consistency of fluids and liquids provided to the patient.


.... instruction Σ0..1stringInstructions or additional information about the oral diet
... supplement C0..*BackboneElementSupplement components
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..1CodeableConceptType of supplement product requested
Binding: SupplementTypeCodes (example): Codes for nutritional supplements to be provided to the patient.

.... productName 0..1stringProduct or brand name of the nutritional supplement
.... schedule 0..*TimingScheduled frequency of supplement
.... quantity 0..1SimpleQuantityAmount of the nutritional supplement
.... instruction Σ0..1stringInstructions or additional information about the oral supplement
... enteralFormula C0..1BackboneElementEnteral formula components
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... baseFormulaType Σ0..1CodeableConceptType of enteral or infant formula
Binding: EnteralFormulaTypeCodes (example): Codes for type of enteral formula to be administered to patient.

.... baseFormulaProductName 0..1stringProduct or brand name of the enteral or infant formula
.... additiveType 0..1CodeableConceptType of modular component to add to the feeding
Binding: EnteralFormulaAdditiveTypeCode (example): Codes for the type of modular component such as protein, carbohydrate or fiber to be provided in addition to or mixed with the base formula.

.... additiveProductName 0..1stringProduct or brand name of the modular additive
.... caloricDensity 0..1SimpleQuantityAmount of energy per specified volume that is required
.... routeofAdministration 0..1CodeableConceptHow the formula should enter the patient's gastrointestinal tract
Binding: EnteralRouteCodes (extensible): Codes specifying the route of administration of enteral formula.

.... administration 0..*BackboneElementFormula feeding instruction as structured data
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... schedule 0..1TimingScheduled frequency of enteral feeding
..... quantity 0..1SimpleQuantityThe volume of formula to provide
..... rate[x] 0..1Speed with which the formula is provided per period of time
...... rateQuantityQuantity(SimpleQuantity)
...... rateRatioRatio
.... maxVolumeToDeliver 0..1SimpleQuantityUpper limit on formula volume per unit of time
.... administrationInstruction Σ0..1stringFormula feeding instructions expressed as text
... note 0..*AnnotationComments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
NutritionOrder.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
NutritionOrder.statusrequiredRequestStatus
NutritionOrder.intentrequiredRequestIntent
NutritionOrder.foodPreferenceModifierexampleDiet
NutritionOrder.excludeFoodModifierexampleFoodTypeCodes
NutritionOrder.oralDiet.typeexampleDietCodes
NutritionOrder.oralDiet.nutrient.modifierexampleNutrientModifierCodes
NutritionOrder.oralDiet.texture.modifierexampleTextureModifierCodes
NutritionOrder.oralDiet.texture.foodTypeexampleTextureModifiedFoodTypeCodes
NutritionOrder.oralDiet.fluidConsistencyTypeexampleFluidConsistencyTypeCodes
NutritionOrder.supplement.typeexampleSupplementTypeCodes
NutritionOrder.enteralFormula.baseFormulaTypeexampleEnteralFormulaTypeCodes
NutritionOrder.enteralFormula.additiveTypeexampleEnteralFormulaAdditiveTypeCode
NutritionOrder.enteralFormula.routeofAdministrationextensibleEnteralRouteCodes

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from NutritionOrder

Summary

Must-Support: 1 element

Structures

This structure refers to these other structures:

Differential View

This structure is derived from NutritionOrder

NameFlagsCard.TypeDescription & Constraintsdoco
.. NutritionOrder 0..*NutritionOrderDiet, formula or nutritional supplement request
... identifier 0..*IdentifierIdentifiers assigned to this order
... patient S1..1Reference(QICore Patient)The person who requires the diet, formula or nutritional supplement

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. NutritionOrder C0..*NutritionOrderDiet, formula or nutritional supplement request
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierIdentifiers assigned to this order
... intent ?!Σ1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a nutrition order.

... patient SΣ1..1Reference(QICore Patient)The person who requires the diet, formula or nutritional supplement
... dateTime Σ1..1dateTimeDate and time the nutrition order was requested

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
NutritionOrder.statusrequiredRequestStatus
NutritionOrder.intentrequiredRequestIntent

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorNutritionOrderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorNutritionOrderIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorNutritionOrderIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorNutritionOrderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceNutritionOrderA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
nor-1warningNutritionOrderNutrition Order SHALL contain either Oral Diet , Supplement, or Enteral Formula class
: oralDiet.exists() or supplement.exists() or enteralFormula.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. NutritionOrder C0..*NutritionOrderDiet, formula or nutritional supplement request
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierIdentifiers assigned to this order
... instantiatesCanonical Σ0..*canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... instantiates 0..*uriInstantiates protocol or definition
... status ?!Σ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Codes identifying the lifecycle stage of the nutrition order.

... intent ?!Σ1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a nutrition order.

... patient SΣ1..1Reference(QICore Patient)The person who requires the diet, formula or nutritional supplement
... encounter 0..1Reference(Encounter)The encounter associated with this nutrition order
... dateTime Σ1..1dateTimeDate and time the nutrition order was requested
... orderer Σ0..1Reference(Practitioner | PractitionerRole)Who ordered the diet, formula or nutritional supplement
... allergyIntolerance 0..*Reference(AllergyIntolerance)List of the patient's food and nutrition-related allergies and intolerances
... foodPreferenceModifier 0..*CodeableConceptOrder-specific modifier about the type of food that should be given
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.


... excludeFoodModifier 0..*CodeableConceptOrder-specific modifier about the type of food that should not be given
Binding: FoodTypeCodes (example): Codes used to indicate the type of food that should NOT be given to the patient.


... oralDiet C0..1BackboneElementOral diet components
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..*CodeableConceptType of oral diet or diet restrictions that describe what can be consumed orally
Binding: DietCodes (example): Codes used to indicate the type of diet being ordered for a patient.


.... schedule 0..*TimingScheduled frequency of diet
.... nutrient 0..*BackboneElementRequired nutrient modifications
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... modifier 0..1CodeableConceptType of nutrient that is being modified
Binding: NutrientModifierCodes (example): Codes for types of nutrients that are being modified such as carbohydrate or sodium.

..... amount 0..1SimpleQuantityQuantity of the specified nutrient
.... texture 0..*BackboneElementRequired texture modifications
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... modifier 0..1CodeableConceptCode to indicate how to alter the texture of the foods, e.g. pureed
Binding: TextureModifierCodes (example): Codes for food consistency types or texture modifications to apply to foods.

..... foodType 0..1CodeableConceptConcepts that are used to identify an entity that is ingested for nutritional purposes
Binding: TextureModifiedFoodTypeCodes (example): Codes for types of foods that are texture-modified.

.... fluidConsistencyType 0..*CodeableConceptThe required consistency of fluids and liquids provided to the patient
Binding: FluidConsistencyTypeCodes (example): Codes used to represent the consistency of fluids and liquids provided to the patient.


.... instruction Σ0..1stringInstructions or additional information about the oral diet
... supplement C0..*BackboneElementSupplement components
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..1CodeableConceptType of supplement product requested
Binding: SupplementTypeCodes (example): Codes for nutritional supplements to be provided to the patient.

.... productName 0..1stringProduct or brand name of the nutritional supplement
.... schedule 0..*TimingScheduled frequency of supplement
.... quantity 0..1SimpleQuantityAmount of the nutritional supplement
.... instruction Σ0..1stringInstructions or additional information about the oral supplement
... enteralFormula C0..1BackboneElementEnteral formula components
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... baseFormulaType Σ0..1CodeableConceptType of enteral or infant formula
Binding: EnteralFormulaTypeCodes (example): Codes for type of enteral formula to be administered to patient.

.... baseFormulaProductName 0..1stringProduct or brand name of the enteral or infant formula
.... additiveType 0..1CodeableConceptType of modular component to add to the feeding
Binding: EnteralFormulaAdditiveTypeCode (example): Codes for the type of modular component such as protein, carbohydrate or fiber to be provided in addition to or mixed with the base formula.

.... additiveProductName 0..1stringProduct or brand name of the modular additive
.... caloricDensity 0..1SimpleQuantityAmount of energy per specified volume that is required
.... routeofAdministration 0..1CodeableConceptHow the formula should enter the patient's gastrointestinal tract
Binding: EnteralRouteCodes (extensible): Codes specifying the route of administration of enteral formula.

.... administration 0..*BackboneElementFormula feeding instruction as structured data
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... schedule 0..1TimingScheduled frequency of enteral feeding
..... quantity 0..1SimpleQuantityThe volume of formula to provide
..... rate[x] 0..1Speed with which the formula is provided per period of time
...... rateQuantityQuantity(SimpleQuantity)
...... rateRatioRatio
.... maxVolumeToDeliver 0..1SimpleQuantityUpper limit on formula volume per unit of time
.... administrationInstruction Σ0..1stringFormula feeding instructions expressed as text
... note 0..*AnnotationComments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
NutritionOrder.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
NutritionOrder.statusrequiredRequestStatus
NutritionOrder.intentrequiredRequestIntent
NutritionOrder.foodPreferenceModifierexampleDiet
NutritionOrder.excludeFoodModifierexampleFoodTypeCodes
NutritionOrder.oralDiet.typeexampleDietCodes
NutritionOrder.oralDiet.nutrient.modifierexampleNutrientModifierCodes
NutritionOrder.oralDiet.texture.modifierexampleTextureModifierCodes
NutritionOrder.oralDiet.texture.foodTypeexampleTextureModifiedFoodTypeCodes
NutritionOrder.oralDiet.fluidConsistencyTypeexampleFluidConsistencyTypeCodes
NutritionOrder.supplement.typeexampleSupplementTypeCodes
NutritionOrder.enteralFormula.baseFormulaTypeexampleEnteralFormulaTypeCodes
NutritionOrder.enteralFormula.additiveTypeexampleEnteralFormulaAdditiveTypeCode
NutritionOrder.enteralFormula.routeofAdministrationextensibleEnteralRouteCodes

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from NutritionOrder

Summary

Must-Support: 1 element

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron