US Quality Core Implementation Guide
1.0.0-ballot - STU 1 - ballot United States of America flag

US Quality Core Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-quality-core/ and changes regularly. See the Directory of published versions

Resource Profile: US Quality Core NutritionOrder

Official URL: http://hl7.org/fhir/us/quality-core/StructureDefinition/us-quality-core-nutritionorder Version: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 4 Computable Name: USQualityCoreNutritionOrder
Other Identifiers: OID:2.16.840.1.113883.4.642.40.78.42.34

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

USCDI+ Quality Element Support Expectations

Systems are expected to support this profile as part of implementing USCDI+ Quality V2 in FHIR and meeting the conformance requirements of this guide.

The following elements are specifically relevant to USCDI+ Quality V2 data classes and elements. Systems are expected to support these elements as applicable to their role in US Quality Core data exchange. See the Must Support section of this guide for more information. These elements are flagged as (USCDI+ Quality) in the formal profile views.

USCDI+ Quality Elements:

Profile element Description USCDI+ Quality Data Element(s)
enteralFormula Enteral formula components Orders: Nutrition Order
enteralFormula.baseFormulaType Type of enteral or infant formula Orders: Nutrition Order
enteralFormula.baseFormulaType.extension:codeOptions Url of a value set of candidate enteral formulas Orders: Nutrition Order
oralDiet Oral diet components Orders: Nutrition Order
oralDiet.type Oral diet components Orders: Nutrition Order
oralDiet.type.extension:codeOptions Url of a value set of candidate oral diet types Orders: Nutrition Order
orderer Who ordered the diet, formula or nutritional supplement Provenance: Author
patient The person who requires the diet, formula or nutritional supplement Orders: Nutrition Order
status draft | active | on-hold | revoked | completed | entered-in-error | unknown Orders: Nutrition Order
supplement Supplement components Orders: Nutrition Order
supplement.type Type of supplement product requested Orders: Nutrition Order
supplement.type.extension:codeOptions Url of a value set of candidate nutritional supplements Orders: Nutrition Order

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. NutritionOrder C 0..* NutritionOrder Diet, formula or nutritional supplement request
Constraints: nor-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Identifiers assigned to this order
... intent ?!Σ 1..1 code proposal | 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 Σ 1..1 Reference(US Quality Core Patient) (USCDI+ Quality) The person who requires the diet, formula or nutritional supplement
... dateTime Σ 1..1 dateTime Date and time the nutrition order was requested
... orderer Σ 0..1 Reference(Practitioner | PractitionerRole) (USCDI+ Quality) Who ordered the diet, formula or nutritional supplement
... oralDiet C 0..1 BackboneElement (USCDI+ Quality) Oral diet components
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..1 CodeableConcept (USCDI+ Quality) Oral diet components
Binding: DietCodes (example): Codes used to indicate the type of diet being ordered for a patient.
..... Slices for extension Content/Rules for all slices
...... extension:codeOptions 0..1 canonical(ValueSet) (USCDI+ Quality) Url of a value set of candidate oral diet types
URL: http://hl7.org/fhir/StructureDefinition/codeOptions
... supplement C 0..* BackboneElement (USCDI+ Quality) Supplement components
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..1 CodeableConcept (USCDI+ Quality) Type of supplement product requested
Binding: SupplementTypeCodes (example): Codes for nutritional supplements to be provided to the patient.
..... Slices for extension Content/Rules for all slices
...... extension:codeOptions 0..1 canonical(ValueSet) (USCDI+ Quality) Url of a value set of candidate nutritional supplements
URL: http://hl7.org/fhir/StructureDefinition/codeOptions
... enteralFormula C 0..1 BackboneElement (USCDI+ Quality) Enteral formula components
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... baseFormulaType Σ 0..1 CodeableConcept (USCDI+ Quality) Type of enteral or infant formula
Binding: EnteralFormulaTypeCodes (example): Codes for type of enteral formula to be administered to patient.
..... Slices for extension Content/Rules for all slices
...... extension:codeOptions 0..1 canonical(ValueSet) (USCDI+ Quality) Url of a value set of candidate enteral formulas
URL: http://hl7.org/fhir/StructureDefinition/codeOptions

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
NutritionOrder.status Base required RequestStatus 📍4.0.1 FHIR Std.
NutritionOrder.intent Base required RequestIntent 📍4.0.1 FHIR Std.
NutritionOrder.oralDiet.​type Base example Diet Codes 📍4.0.1 FHIR Std.
NutritionOrder.supplement.​type Base example Supplement Type Codes 📍4.0.1 FHIR Std.
NutritionOrder.enteralFormula.​baseFormulaType Base example Enteral Formula Type Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error NutritionOrder If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error NutritionOrder If 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-4 error NutritionOrder If 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-5 error NutritionOrder If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice NutritionOrder A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
nor-1 warning NutritionOrder Nutrition Order SHALL contain either Oral Diet , Supplement, or Enteral Formula class oralDiet.exists() or supplement.exists() or enteralFormula.exists()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. NutritionOrder 0..* NutritionOrder Diet, formula or nutritional supplement request
... identifier 0..* Identifier Identifiers assigned to this order
... status 1..1 code (USCDI+ Quality) draft | active | on-hold | revoked | completed | entered-in-error | unknown
... patient 1..1 Reference(US Quality Core Patient) (USCDI+ Quality) The person who requires the diet, formula or nutritional supplement
... oralDiet 0..1 BackboneElement (USCDI+ Quality) Oral diet components
.... type 0..1 CodeableConcept (USCDI+ Quality) Oral diet components
..... Slices for extension Content/Rules for all slices
...... extension:codeOptions 0..1 canonical(ValueSet) (USCDI+ Quality) Url of a value set of candidate oral diet types
URL: http://hl7.org/fhir/StructureDefinition/codeOptions
... supplement 0..* BackboneElement (USCDI+ Quality) Supplement components
.... type 0..1 CodeableConcept (USCDI+ Quality) Type of supplement product requested
..... Slices for extension Content/Rules for all slices
...... extension:codeOptions 0..1 canonical(ValueSet) (USCDI+ Quality) Url of a value set of candidate nutritional supplements
URL: http://hl7.org/fhir/StructureDefinition/codeOptions
... enteralFormula 0..1 BackboneElement (USCDI+ Quality) Enteral formula components
.... baseFormulaType 0..1 CodeableConcept (USCDI+ Quality) Type of enteral or infant formula
..... Slices for extension Content/Rules for all slices
...... extension:codeOptions 0..1 canonical(ValueSet) (USCDI+ Quality) Url of a value set of candidate enteral formulas
URL: http://hl7.org/fhir/StructureDefinition/codeOptions

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. NutritionOrder C 0..* NutritionOrder Diet, formula or nutritional supplement request
Constraints: nor-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Identifiers assigned to this order
... instantiatesCanonical Σ 0..* canonical(ActivityDefinition | PlanDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... instantiates 0..* uri Instantiates protocol or definition
... status ?!Σ 1..1 code (USCDI+ Quality) draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Codes identifying the lifecycle stage of the nutrition order.
... intent ?!Σ 1..1 code proposal | 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 Σ 1..1 Reference(US Quality Core Patient) (USCDI+ Quality) The person who requires the diet, formula or nutritional supplement
... encounter 0..1 Reference(Encounter) The encounter associated with this nutrition order
... dateTime Σ 1..1 dateTime Date and time the nutrition order was requested
... orderer Σ 0..1 Reference(Practitioner | PractitionerRole) (USCDI+ Quality) 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..* CodeableConcept Order-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..* CodeableConcept Order-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 C 0..1 BackboneElement (USCDI+ Quality) Oral diet components
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..1 CodeableConcept (USCDI+ Quality) Oral diet components
Binding: DietCodes (example): Codes used to indicate the type of diet being ordered for a patient.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:codeOptions 0..1 canonical(ValueSet) (USCDI+ Quality) Url of a value set of candidate oral diet types
URL: http://hl7.org/fhir/StructureDefinition/codeOptions
..... coding Σ 0..* Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
.... schedule 0..* Timing Scheduled frequency of diet
.... nutrient 0..* BackboneElement Required nutrient modifications
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... modifier 0..1 CodeableConcept Type 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..1 SimpleQuantity(4.0.1) Quantity of the specified nutrient
.... texture 0..* BackboneElement Required texture modifications
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... modifier 0..1 CodeableConcept Code 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..1 CodeableConcept Concepts 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..* CodeableConcept The 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..1 string Instructions or additional information about the oral diet
... supplement C 0..* BackboneElement (USCDI+ Quality) Supplement components
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..1 CodeableConcept (USCDI+ Quality) Type of supplement product requested
Binding: SupplementTypeCodes (example): Codes for nutritional supplements to be provided to the patient.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:codeOptions 0..1 canonical(ValueSet) (USCDI+ Quality) Url of a value set of candidate nutritional supplements
URL: http://hl7.org/fhir/StructureDefinition/codeOptions
..... coding Σ 0..* Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
.... productName 0..1 string Product or brand name of the nutritional supplement
.... schedule 0..* Timing Scheduled frequency of supplement
.... quantity 0..1 SimpleQuantity(4.0.1) Amount of the nutritional supplement
.... instruction Σ 0..1 string Instructions or additional information about the oral supplement
... enteralFormula C 0..1 BackboneElement (USCDI+ Quality) Enteral formula components
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... baseFormulaType Σ 0..1 CodeableConcept (USCDI+ Quality) Type of enteral or infant formula
Binding: EnteralFormulaTypeCodes (example): Codes for type of enteral formula to be administered to patient.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:codeOptions 0..1 canonical(ValueSet) (USCDI+ Quality) Url of a value set of candidate enteral formulas
URL: http://hl7.org/fhir/StructureDefinition/codeOptions
..... coding Σ 0..* Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
.... baseFormulaProductName 0..1 string Product or brand name of the enteral or infant formula
.... additiveType 0..1 CodeableConcept Type 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..1 string Product or brand name of the modular additive
.... caloricDensity 0..1 SimpleQuantity(4.0.1) Amount of energy per specified volume that is required
.... routeofAdministration 0..1 CodeableConcept How the formula should enter the patient's gastrointestinal tract
Binding: EnteralRouteCodes (extensible): Codes specifying the route of administration of enteral formula.
.... administration 0..* BackboneElement Formula feeding instruction as structured data
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... schedule 0..1 Timing Scheduled frequency of enteral feeding
..... quantity 0..1 SimpleQuantity(4.0.1) The volume of formula to provide
..... rate[x] 0..1 Speed with which the formula is provided per period of time
...... rateQuantity Quantity(SimpleQuantity)
...... rateRatio Ratio
.... maxVolumeToDeliver 0..1 SimpleQuantity(4.0.1) Upper limit on formula volume per unit of time
.... administrationInstruction Σ 0..1 string Formula feeding instructions expressed as text
... note 0..* Annotation Comments

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
NutritionOrder.language Base preferred Common Languages 📍4.0.1 FHIR Std.
NutritionOrder.status Base required RequestStatus 📍4.0.1 FHIR Std.
NutritionOrder.intent Base required RequestIntent 📍4.0.1 FHIR Std.
NutritionOrder.foodPreferenceModifier Base example Diet 📍4.0.1 FHIR Std.
NutritionOrder.excludeFoodModifier Base example Food Type Codes 📍4.0.1 FHIR Std.
NutritionOrder.oralDiet.​type Base example Diet Codes 📍4.0.1 FHIR Std.
NutritionOrder.oralDiet.​nutrient.modifier Base example Nutrient Modifier Codes 📍4.0.1 FHIR Std.
NutritionOrder.oralDiet.​texture.modifier Base example Texture Modifier Codes 📍4.0.1 FHIR Std.
NutritionOrder.oralDiet.​texture.foodType Base example Texture Modified Food Type Codes 📍4.0.1 FHIR Std.
NutritionOrder.oralDiet.​fluidConsistencyType Base example Fluid Consistency Type Codes 📍4.0.1 FHIR Std.
NutritionOrder.supplement.​type Base example Supplement Type Codes 📍4.0.1 FHIR Std.
NutritionOrder.enteralFormula.​baseFormulaType Base example Enteral Formula Type Codes 📍4.0.1 FHIR Std.
NutritionOrder.enteralFormula.​additiveType Base example Enteral Formula Additive Type Code 📍4.0.1 FHIR Std.
NutritionOrder.enteralFormula.​routeofAdministration Base extensible Enteral Route Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error NutritionOrder If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error NutritionOrder If 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-4 error NutritionOrder If 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-5 error NutritionOrder If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice NutritionOrder A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
nor-1 warning NutritionOrder Nutrition Order SHALL contain either Oral Diet , Supplement, or Enteral Formula class oralDiet.exists() or supplement.exists() or enteralFormula.exists()

Summary

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Maturity: 4

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. NutritionOrder C 0..* NutritionOrder Diet, formula or nutritional supplement request
Constraints: nor-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Identifiers assigned to this order
... intent ?!Σ 1..1 code proposal | 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 Σ 1..1 Reference(US Quality Core Patient) (USCDI+ Quality) The person who requires the diet, formula or nutritional supplement
... dateTime Σ 1..1 dateTime Date and time the nutrition order was requested
... orderer Σ 0..1 Reference(Practitioner | PractitionerRole) (USCDI+ Quality) Who ordered the diet, formula or nutritional supplement
... oralDiet C 0..1 BackboneElement (USCDI+ Quality) Oral diet components
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..1 CodeableConcept (USCDI+ Quality) Oral diet components
Binding: DietCodes (example): Codes used to indicate the type of diet being ordered for a patient.
..... Slices for extension Content/Rules for all slices
...... extension:codeOptions 0..1 canonical(ValueSet) (USCDI+ Quality) Url of a value set of candidate oral diet types
URL: http://hl7.org/fhir/StructureDefinition/codeOptions
... supplement C 0..* BackboneElement (USCDI+ Quality) Supplement components
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..1 CodeableConcept (USCDI+ Quality) Type of supplement product requested
Binding: SupplementTypeCodes (example): Codes for nutritional supplements to be provided to the patient.
..... Slices for extension Content/Rules for all slices
...... extension:codeOptions 0..1 canonical(ValueSet) (USCDI+ Quality) Url of a value set of candidate nutritional supplements
URL: http://hl7.org/fhir/StructureDefinition/codeOptions
... enteralFormula C 0..1 BackboneElement (USCDI+ Quality) Enteral formula components
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... baseFormulaType Σ 0..1 CodeableConcept (USCDI+ Quality) Type of enteral or infant formula
Binding: EnteralFormulaTypeCodes (example): Codes for type of enteral formula to be administered to patient.
..... Slices for extension Content/Rules for all slices
...... extension:codeOptions 0..1 canonical(ValueSet) (USCDI+ Quality) Url of a value set of candidate enteral formulas
URL: http://hl7.org/fhir/StructureDefinition/codeOptions

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
NutritionOrder.status Base required RequestStatus 📍4.0.1 FHIR Std.
NutritionOrder.intent Base required RequestIntent 📍4.0.1 FHIR Std.
NutritionOrder.oralDiet.​type Base example Diet Codes 📍4.0.1 FHIR Std.
NutritionOrder.supplement.​type Base example Supplement Type Codes 📍4.0.1 FHIR Std.
NutritionOrder.enteralFormula.​baseFormulaType Base example Enteral Formula Type Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error NutritionOrder If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error NutritionOrder If 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-4 error NutritionOrder If 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-5 error NutritionOrder If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice NutritionOrder A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
nor-1 warning NutritionOrder Nutrition Order SHALL contain either Oral Diet , Supplement, or Enteral Formula class oralDiet.exists() or supplement.exists() or enteralFormula.exists()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. NutritionOrder 0..* NutritionOrder Diet, formula or nutritional supplement request
... identifier 0..* Identifier Identifiers assigned to this order
... status 1..1 code (USCDI+ Quality) draft | active | on-hold | revoked | completed | entered-in-error | unknown
... patient 1..1 Reference(US Quality Core Patient) (USCDI+ Quality) The person who requires the diet, formula or nutritional supplement
... oralDiet 0..1 BackboneElement (USCDI+ Quality) Oral diet components
.... type 0..1 CodeableConcept (USCDI+ Quality) Oral diet components
..... Slices for extension Content/Rules for all slices
...... extension:codeOptions 0..1 canonical(ValueSet) (USCDI+ Quality) Url of a value set of candidate oral diet types
URL: http://hl7.org/fhir/StructureDefinition/codeOptions
... supplement 0..* BackboneElement (USCDI+ Quality) Supplement components
.... type 0..1 CodeableConcept (USCDI+ Quality) Type of supplement product requested
..... Slices for extension Content/Rules for all slices
...... extension:codeOptions 0..1 canonical(ValueSet) (USCDI+ Quality) Url of a value set of candidate nutritional supplements
URL: http://hl7.org/fhir/StructureDefinition/codeOptions
... enteralFormula 0..1 BackboneElement (USCDI+ Quality) Enteral formula components
.... baseFormulaType 0..1 CodeableConcept (USCDI+ Quality) Type of enteral or infant formula
..... Slices for extension Content/Rules for all slices
...... extension:codeOptions 0..1 canonical(ValueSet) (USCDI+ Quality) Url of a value set of candidate enteral formulas
URL: http://hl7.org/fhir/StructureDefinition/codeOptions

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. NutritionOrder C 0..* NutritionOrder Diet, formula or nutritional supplement request
Constraints: nor-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Identifiers assigned to this order
... instantiatesCanonical Σ 0..* canonical(ActivityDefinition | PlanDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... instantiates 0..* uri Instantiates protocol or definition
... status ?!Σ 1..1 code (USCDI+ Quality) draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Codes identifying the lifecycle stage of the nutrition order.
... intent ?!Σ 1..1 code proposal | 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 Σ 1..1 Reference(US Quality Core Patient) (USCDI+ Quality) The person who requires the diet, formula or nutritional supplement
... encounter 0..1 Reference(Encounter) The encounter associated with this nutrition order
... dateTime Σ 1..1 dateTime Date and time the nutrition order was requested
... orderer Σ 0..1 Reference(Practitioner | PractitionerRole) (USCDI+ Quality) 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..* CodeableConcept Order-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..* CodeableConcept Order-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 C 0..1 BackboneElement (USCDI+ Quality) Oral diet components
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..1 CodeableConcept (USCDI+ Quality) Oral diet components
Binding: DietCodes (example): Codes used to indicate the type of diet being ordered for a patient.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:codeOptions 0..1 canonical(ValueSet) (USCDI+ Quality) Url of a value set of candidate oral diet types
URL: http://hl7.org/fhir/StructureDefinition/codeOptions
..... coding Σ 0..* Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
.... schedule 0..* Timing Scheduled frequency of diet
.... nutrient 0..* BackboneElement Required nutrient modifications
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... modifier 0..1 CodeableConcept Type 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..1 SimpleQuantity(4.0.1) Quantity of the specified nutrient
.... texture 0..* BackboneElement Required texture modifications
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... modifier 0..1 CodeableConcept Code 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..1 CodeableConcept Concepts 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..* CodeableConcept The 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..1 string Instructions or additional information about the oral diet
... supplement C 0..* BackboneElement (USCDI+ Quality) Supplement components
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..1 CodeableConcept (USCDI+ Quality) Type of supplement product requested
Binding: SupplementTypeCodes (example): Codes for nutritional supplements to be provided to the patient.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:codeOptions 0..1 canonical(ValueSet) (USCDI+ Quality) Url of a value set of candidate nutritional supplements
URL: http://hl7.org/fhir/StructureDefinition/codeOptions
..... coding Σ 0..* Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
.... productName 0..1 string Product or brand name of the nutritional supplement
.... schedule 0..* Timing Scheduled frequency of supplement
.... quantity 0..1 SimpleQuantity(4.0.1) Amount of the nutritional supplement
.... instruction Σ 0..1 string Instructions or additional information about the oral supplement
... enteralFormula C 0..1 BackboneElement (USCDI+ Quality) Enteral formula components
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... baseFormulaType Σ 0..1 CodeableConcept (USCDI+ Quality) Type of enteral or infant formula
Binding: EnteralFormulaTypeCodes (example): Codes for type of enteral formula to be administered to patient.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:codeOptions 0..1 canonical(ValueSet) (USCDI+ Quality) Url of a value set of candidate enteral formulas
URL: http://hl7.org/fhir/StructureDefinition/codeOptions
..... coding Σ 0..* Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
.... baseFormulaProductName 0..1 string Product or brand name of the enteral or infant formula
.... additiveType 0..1 CodeableConcept Type 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..1 string Product or brand name of the modular additive
.... caloricDensity 0..1 SimpleQuantity(4.0.1) Amount of energy per specified volume that is required
.... routeofAdministration 0..1 CodeableConcept How the formula should enter the patient's gastrointestinal tract
Binding: EnteralRouteCodes (extensible): Codes specifying the route of administration of enteral formula.
.... administration 0..* BackboneElement Formula feeding instruction as structured data
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... schedule 0..1 Timing Scheduled frequency of enteral feeding
..... quantity 0..1 SimpleQuantity(4.0.1) The volume of formula to provide
..... rate[x] 0..1 Speed with which the formula is provided per period of time
...... rateQuantity Quantity(SimpleQuantity)
...... rateRatio Ratio
.... maxVolumeToDeliver 0..1 SimpleQuantity(4.0.1) Upper limit on formula volume per unit of time
.... administrationInstruction Σ 0..1 string Formula feeding instructions expressed as text
... note 0..* Annotation Comments

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
NutritionOrder.language Base preferred Common Languages 📍4.0.1 FHIR Std.
NutritionOrder.status Base required RequestStatus 📍4.0.1 FHIR Std.
NutritionOrder.intent Base required RequestIntent 📍4.0.1 FHIR Std.
NutritionOrder.foodPreferenceModifier Base example Diet 📍4.0.1 FHIR Std.
NutritionOrder.excludeFoodModifier Base example Food Type Codes 📍4.0.1 FHIR Std.
NutritionOrder.oralDiet.​type Base example Diet Codes 📍4.0.1 FHIR Std.
NutritionOrder.oralDiet.​nutrient.modifier Base example Nutrient Modifier Codes 📍4.0.1 FHIR Std.
NutritionOrder.oralDiet.​texture.modifier Base example Texture Modifier Codes 📍4.0.1 FHIR Std.
NutritionOrder.oralDiet.​texture.foodType Base example Texture Modified Food Type Codes 📍4.0.1 FHIR Std.
NutritionOrder.oralDiet.​fluidConsistencyType Base example Fluid Consistency Type Codes 📍4.0.1 FHIR Std.
NutritionOrder.supplement.​type Base example Supplement Type Codes 📍4.0.1 FHIR Std.
NutritionOrder.enteralFormula.​baseFormulaType Base example Enteral Formula Type Codes 📍4.0.1 FHIR Std.
NutritionOrder.enteralFormula.​additiveType Base example Enteral Formula Additive Type Code 📍4.0.1 FHIR Std.
NutritionOrder.enteralFormula.​routeofAdministration Base extensible Enteral Route Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error NutritionOrder If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error NutritionOrder If 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-4 error NutritionOrder If 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-5 error NutritionOrder If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice NutritionOrder A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
nor-1 warning NutritionOrder Nutrition Order SHALL contain either Oral Diet , Supplement, or Enteral Formula class oralDiet.exists() or supplement.exists() or enteralFormula.exists()

Summary

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Element Conformance Indicators by Profile Layer

Badges identify the profile layer where each conformance indicator is first introduced. Indicators introduced in an earlier layer remain applicable in later derived profiles.

Element conformance indicators organized by the profile layer where they are first introduced
Profile element FHIR US Quality Core
status Mandatory USCDI+ Quality
intent Mandatory
patient Mandatory USCDI+ Quality
dateTime Mandatory
orderer USCDI+ Quality
oralDiet USCDI+ Quality
oralDiet.type USCDI+ Quality
oralDiet.type.extension:codeOptions USCDI+ Quality
supplement USCDI+ Quality
supplement.type USCDI+ Quality
supplement.type.extension:codeOptions USCDI+ Quality
enteralFormula USCDI+ Quality
enteralFormula.baseFormulaType USCDI+ Quality
enteralFormula.baseFormulaType.extension:codeOptions USCDI+ Quality

Cardinality note: “Mandatory” means the element has a minimum cardinality greater than zero. For nested elements, the cardinality indicator applies when the containing element is present.

Mandatory US Quality Core Server Search Parameters

The searches below are the focused set identified by US Quality Core as needed to retrieve USCDI+ Quality data for quality measurement and reporting. See the US Core FHIR RESTful Search API Requirements for detailed information on requirements by search parameter type.

See the US Quality Core Server CapabilityStatement for complete requirements for the underlying NutritionOrder resource and Search Requirement Selection for how this focused set was selected.

Servers supporting this profile SHALL support the following search parameters and search parameter combinations:

  1. SHALL support searching for all NutritionOrder resources for a patient using the patient search parameter.

    GET [base]/NutritionOrder?patient={Patient/}[id]

    Example:

    GET [base]/NutritionOrder?patient=Patient/example

    Implementation Notes: Fetches a bundle of US Quality Core NutritionOrder resources matching the specified search criteria. See how to search by reference.

    Rationale for inclusion: Supports patient-scoped retrieval of NutritionOrder resources for USCDI+ Quality workflows.