QI-Core Implementation Guide: STU Ballot (v3.3.0 for FHIR 4.0.0)
Quality Improvement Core Framework (v3.3.0: STU 4 Ballot 1). The current version is 3.2.0 based on FHIR R4. See the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-nutritionorder
Defines constraints and extensions on the NutritionOrder resource for the minimal set of data to query and retrieve a patient's Nutrition Order.
This profile builds on NutritionOrder.
This profile was published on Sun Jul 28 00:00:00 EDT 2019 as a draft by Health Level Seven, Inc. - CQI WG.
Description of Profiles, Differentials, and Snapshots.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  NutritionOrder | I | 0..* | Diet, formula or nutritional supplement request | |
  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 |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
 contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | S | 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 | proposed | draft | planned | requested | active | on-hold | completed | cancelled | entered-in-error Binding: RequestStatus (required) |
| intent | ?!Σ | 1..1 | code | proposal | plan | order Binding: RequestIntent (required) |
 patient | SΣ | 1..1 | Reference(QICorePatient) | 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) | 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) | |
| excludeFoodModifier | 0..* | CodeableConcept | Order-specific modifier about the type of food that should not be given Binding: FoodTypeCodes (example) | |
| oralDiet | I | 0..1 | BackboneElement | 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..* | CodeableConcept | Type of oral diet or diet restrictions that describe what can be consumed orally Binding: DietCodes (example) |
| schedule | 0..* | Timing | Scheduled frequency of diet | |
| nutrient | I | 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) | |
 amount | 0..1 | SimpleQuantity | Quantity of the specified nutrient | |
| texture | I | 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) | |
| foodType | 0..1 | CodeableConcept | Concepts that are used to identify an entity that is ingested for nutritional purposes Binding: TextureModifiedFoodTypeCodes (example) | |
| fluidConsistencyType | 0..* | CodeableConcept | The required consistency of fluids and liquids provided to the patient Binding: FluidConsistencyTypeCodes (example) | |
| instruction | Σ | 0..1 | string | Instructions or additional information about the oral diet |
| supplement | I | 0..* | BackboneElement | 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 | Type of supplement product requested Binding: SupplementTypeCodes (example) |
| productName | 0..1 | string | Product or brand name of the nutritional supplement | |
| schedule | 0..* | Timing | Scheduled frequency of supplement | |
| quantity | 0..1 | SimpleQuantity | Amount of the nutritional supplement | |
| instruction | Σ | 0..1 | string | Instructions or additional information about the oral supplement |
| enteralFormula | I | 0..1 | BackboneElement | 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 | Type of enteral or infant formula Binding: EnteralFormulaTypeCodes (example) |
| 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) | |
| additiveProductName | 0..1 | string | Product or brand name of the modular additive | |
| caloricDensity | 0..1 | SimpleQuantity | 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) | |
| administration | I | 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 | The volume of formula to provide | |
 rate[x] | 0..1 | Speed with which the formula is provided per period of time | ||
 rateQuantity | Quantity | |||
| rateRatio | Ratio | |||
| maxVolumeToDeliver | 0..1 | SimpleQuantity | Upper limit on formula volume per unit of time | |
| administrationInstruction | Σ | 0..1 | string | Formula feeding instructions expressed as text |
| note | 0..* | Annotation | Comments | |
| Documentation for this format | ||||
Differential View
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| NutritionOrder | I | 0..* | Diet, formula or nutritional supplement request | |
| 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 |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | S | 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 | proposed | draft | planned | requested | active | on-hold | completed | cancelled | entered-in-error Binding: RequestStatus (required) |
| intent | ?!Σ | 1..1 | code | proposal | plan | order Binding: RequestIntent (required) |
| patient | SΣ | 1..1 | Reference(QICorePatient) | 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) | 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) | |
| excludeFoodModifier | 0..* | CodeableConcept | Order-specific modifier about the type of food that should not be given Binding: FoodTypeCodes (example) | |
| oralDiet | I | 0..1 | BackboneElement | 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..* | CodeableConcept | Type of oral diet or diet restrictions that describe what can be consumed orally Binding: DietCodes (example) |
| schedule | 0..* | Timing | Scheduled frequency of diet | |
| nutrient | I | 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) | |
| amount | 0..1 | SimpleQuantity | Quantity of the specified nutrient | |
| texture | I | 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) | |
| foodType | 0..1 | CodeableConcept | Concepts that are used to identify an entity that is ingested for nutritional purposes Binding: TextureModifiedFoodTypeCodes (example) | |
| fluidConsistencyType | 0..* | CodeableConcept | The required consistency of fluids and liquids provided to the patient Binding: FluidConsistencyTypeCodes (example) | |
| instruction | Σ | 0..1 | string | Instructions or additional information about the oral diet |
| supplement | I | 0..* | BackboneElement | 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 | Type of supplement product requested Binding: SupplementTypeCodes (example) |
| productName | 0..1 | string | Product or brand name of the nutritional supplement | |
| schedule | 0..* | Timing | Scheduled frequency of supplement | |
| quantity | 0..1 | SimpleQuantity | Amount of the nutritional supplement | |
| instruction | Σ | 0..1 | string | Instructions or additional information about the oral supplement |
| enteralFormula | I | 0..1 | BackboneElement | 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 | Type of enteral or infant formula Binding: EnteralFormulaTypeCodes (example) |
| 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) | |
| additiveProductName | 0..1 | string | Product or brand name of the modular additive | |
| caloricDensity | 0..1 | SimpleQuantity | 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) | |
| administration | I | 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 | The volume of formula to provide | |
| rate[x] | 0..1 | Speed with which the formula is provided per period of time | ||
| rateQuantity | Quantity | |||
| rateRatio | Ratio | |||
| maxVolumeToDeliver | 0..1 | SimpleQuantity | Upper limit on formula volume per unit of time | |
| administrationInstruction | Σ | 0..1 | string | Formula feeding instructions expressed as text |
| note | 0..* | Annotation | Comments | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| NutritionOrder.language | preferred | CommonLanguages Max Binding: AllLanguages |
| NutritionOrder.status | required | RequestStatus |
| NutritionOrder.intent | required | RequestIntent |
| NutritionOrder.foodPreferenceModifier | example | Diet |
| NutritionOrder.excludeFoodModifier | example | FoodTypeCodes |
| NutritionOrder.oralDiet.type | example | DietCodes |
| NutritionOrder.oralDiet.nutrient.modifier | example | NutrientModifierCodes |
| NutritionOrder.oralDiet.texture.modifier | example | TextureModifierCodes |
| NutritionOrder.oralDiet.texture.foodType | example | TextureModifiedFoodTypeCodes |
| NutritionOrder.oralDiet.fluidConsistencyType | example | FluidConsistencyTypeCodes |
| NutritionOrder.supplement.type | example | SupplementTypeCodes |
| NutritionOrder.enteralFormula.baseFormulaType | example | EnteralFormulaTypeCodes |
| NutritionOrder.enteralFormula.additiveType | example | EnteralFormulaAdditiveTypeCode |
| NutritionOrder.enteralFormula.routeofAdministration | extensible | EnteralRouteCodes |
| Id | Path | Details | Requirements |
| dom-2 | NutritionOrder | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-4 | 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-3 | 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-6 | NutritionOrder | A resource should have narrative for robust management : text.div.exists() | |
| dom-5 | NutritionOrder | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| nor-1 | NutritionOrder | Nutrition Order SHALL contain either Oral Diet , Supplement, or Enteral Formula class : oralDiet.exists() or supplement.exists() or enteralFormula.exists() | |
| ele-1 | NutritionOrder.oralDiet | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | NutritionOrder.oralDiet.nutrient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | NutritionOrder.oralDiet.texture | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | NutritionOrder.supplement | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | NutritionOrder.enteralFormula | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | NutritionOrder.enteralFormula.administration | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
© HL7.org 2011+. (Clinical Quality Improvement WG). hl7.fhir.us.qicore#3.3.0 based on FHIR v4.0.0 generated 06/08/2019.
Links: Home
| QA Report | Search
| Version History
| 
| Propose a change 