FHIR Clincal Guidelines (v0.1.0) (STU1 Ballot)

This page is part of the Clinical Guidelines (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: cpg-nutritionorder

Examples:

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-nutritionorder

Profile of NutritionOrder for use with CPG Implementation Guide

This profile builds on NutritionOrder.

This profile was published on Thu Jun 06 00:00:00 EDT 2019 as a draft by Health Level Seven, Inc. - CDS WG.

Description of Profiles, Differentials, and Snapshots.

NameFlagsCard.TypeDescription & Constraintsdoco
.. NutritionOrder I0..*Diet, 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
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cqf-strengthOfRecommendation SI0..*CodeableConceptThe strength of the recommendation
URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation
Binding: StrengthOfRecommendationRating (example)
... cqf-qualityOfEvidence SI0..*CodeableConceptThe quality of the evidence
URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence
Binding: QualityOfEvidenceRating (example)
... workflow-supportingInfo SI0..*Reference(Resource)Other information that may be relevant to this event.
URL: http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..*IdentifierIdentifiers assigned to this order
... instantiatesCanonical SΣ0..*canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... instantiates 0..*uriInstantiates protocol or definition
... status ?!SΣ1..1codeproposed | draft | planned | requested | active | on-hold | completed | cancelled | entered-in-error
Binding: RequestStatus (required)
... intent ?!SΣ1..1codeproposal | plan | order
Binding: RequestIntent (required)
... patient SΣ1..1Reference(Patient)The person who requires the diet, formula or nutritional supplement
... encounter S0..1Reference(Encounter)The encounter associated with this nutrition order
... dateTime SΣ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)
... excludeFoodModifier 0..*CodeableConceptOrder-specific modifier about the type of food that should not be given
Binding: FoodTypeCodes (example)
... oralDiet I0..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)
.... schedule 0..*TimingScheduled frequency of diet
.... nutrient I0..*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)
..... amount 0..1SimpleQuantityQuantity of the specified nutrient
.... texture I0..*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)
..... foodType 0..1CodeableConceptConcepts that are used to identify an entity that is ingested for nutritional purposes
Binding: TextureModifiedFoodTypeCodes (example)
.... fluidConsistencyType 0..*CodeableConceptThe required consistency of fluids and liquids provided to the patient
Binding: FluidConsistencyTypeCodes (example)
.... instruction Σ0..1stringInstructions or additional information about the oral diet
... supplement I0..*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)
.... 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 I0..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)
.... 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)
.... 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)
.... administration I0..*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
...... 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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. NutritionOrder I0..*Diet, 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
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cqf-strengthOfRecommendation SI0..*CodeableConceptThe strength of the recommendation
URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation
Binding: StrengthOfRecommendationRating (example)
... cqf-qualityOfEvidence SI0..*CodeableConceptThe quality of the evidence
URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence
Binding: QualityOfEvidenceRating (example)
... workflow-supportingInfo SI0..*Reference(Resource)Other information that may be relevant to this event.
URL: http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..*IdentifierIdentifiers assigned to this order
... instantiatesCanonical SΣ0..*canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... instantiates 0..*uriInstantiates protocol or definition
... status ?!SΣ1..1codeproposed | draft | planned | requested | active | on-hold | completed | cancelled | entered-in-error
Binding: RequestStatus (required)
... intent ?!SΣ1..1codeproposal | plan | order
Binding: RequestIntent (required)
... patient SΣ1..1Reference(Patient)The person who requires the diet, formula or nutritional supplement
... encounter S0..1Reference(Encounter)The encounter associated with this nutrition order
... dateTime SΣ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)
... excludeFoodModifier 0..*CodeableConceptOrder-specific modifier about the type of food that should not be given
Binding: FoodTypeCodes (example)
... oralDiet I0..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)
.... schedule 0..*TimingScheduled frequency of diet
.... nutrient I0..*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)
..... amount 0..1SimpleQuantityQuantity of the specified nutrient
.... texture I0..*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)
..... foodType 0..1CodeableConceptConcepts that are used to identify an entity that is ingested for nutritional purposes
Binding: TextureModifiedFoodTypeCodes (example)
.... fluidConsistencyType 0..*CodeableConceptThe required consistency of fluids and liquids provided to the patient
Binding: FluidConsistencyTypeCodes (example)
.... instruction Σ0..1stringInstructions or additional information about the oral diet
... supplement I0..*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)
.... 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 I0..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)
.... 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)
.... 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)
.... administration I0..*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
...... 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

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet
NutritionOrder.languagepreferredCommonLanguages
Max Binding: AllLanguages
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

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2NutritionOrderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4NutritionOrderIf 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-3NutritionOrderIf 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-6NutritionOrderA resource should have narrative for robust management
: text.div.exists()
dom-5NutritionOrderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
nor-1NutritionOrderNutrition Order SHALL contain either Oral Diet , Supplement, or Enteral Formula class
: oralDiet.exists() or supplement.exists() or enteralFormula.exists()
ele-1NutritionOrder.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1NutritionOrder.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1NutritionOrder.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1NutritionOrder.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1NutritionOrder.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1NutritionOrder.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1NutritionOrder.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1NutritionOrder.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1NutritionOrder.oralDietAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1NutritionOrder.oralDiet.nutrientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1NutritionOrder.oralDiet.textureAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1NutritionOrder.supplementAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1NutritionOrder.enteralFormulaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1NutritionOrder.enteralFormula.administrationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())