This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v2.0.1: STU 2.0) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-nutritionorder | Version: 2.0.1 | |||
Standards status: Trial-use | Maturity Level: 1 | Computable Name: NutritionOrder |
This profile specifies extensions and constraints on the NutritionOrder resource to support coverage requirements discovery.
CRD Clients SHALL use this profile to resolve references to NutritionOrder resources passed to CRD Servers (e.g. selections
context references) and to populate draftOrders
context objects when invoking the when invoking the following CDS Hooks:
Information provided in Must Support elements will commonly be required for CRD Servers to perform coverage requirements discovery.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from NutritionOrder
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
NutritionOrder | 0..* | NutritionOrder | Diet, formula or nutritional supplement request | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
Coverage-Information | S | 0..* | (Complex) | Coverage Info URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-coverage-information |
identifier | S | 0..* | Identifier | Identifiers assigned to this order |
status | S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Fixed Value: draft |
patient | S | 1..1 | Reference(CRD Patient) | The person who requires the diet, formula or nutritional supplement |
encounter | S | 0..1 | Reference(CRD Encounter) | The encounter associated with this nutrition order |
dateTime | S | 1..1 | dateTime | Date and time the nutrition order was requested |
orderer | S | 1..1 | Reference(CRD Practitioner | US Core PractitionerRole Profile) | Who ordered the diet, formula or nutritional supplement |
allergyIntolerance | S | 0..* | Reference(AllergyIntolerance) | List of the patient's food and nutrition-related allergies and intolerances |
foodPreferenceModifier | S | 0..* | CodeableConcept | Order-specific modifier about the type of food that should be given |
excludeFoodModifier | S | 0..* | CodeableConcept | Order-specific modifier about the type of food that should not be given |
oralDiet | S | 0..1 | BackboneElement | Oral diet components |
supplement | S | 0..* | BackboneElement | Supplement components |
enteralFormula | S | 0..1 | BackboneElement | Enteral formula components |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
NutritionOrder | C | 0..* | NutritionOrder | Diet, formula or nutritional supplement request |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
Coverage-Information | SC | 0..* | (Complex) | Coverage Info URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-coverage-information |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | S | 0..* | Identifier | Identifiers assigned to this order |
status | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Codes identifying the lifecycle stage of the nutrition order. Fixed Value: draft |
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 | SΣ | 1..1 | Reference(CRD Patient) | The person who requires the diet, formula or nutritional supplement |
encounter | S | 0..1 | Reference(CRD Encounter) | The encounter associated with this nutrition order |
dateTime | SΣ | 1..1 | dateTime | Date and time the nutrition order was requested |
orderer | SΣ | 1..1 | Reference(CRD Practitioner | US Core PractitionerRole Profile) | Who ordered the diet, formula or nutritional supplement |
allergyIntolerance | S | 0..* | Reference(AllergyIntolerance) | List of the patient's food and nutrition-related allergies and intolerances |
foodPreferenceModifier | S | 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 | S | 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 | SC | 0..1 | BackboneElement | Oral diet components |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
supplement | SC | 0..* | BackboneElement | Supplement components |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
enteralFormula | SC | 0..1 | BackboneElement | Enteral formula components |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Documentation for this format |
Path | Conformance | ValueSet / Code |
NutritionOrder.status | required | Fixed Value: draft |
NutritionOrder.intent | required | RequestIntent |
NutritionOrder.foodPreferenceModifier | example | Diet |
NutritionOrder.excludeFoodModifier | example | FoodTypeCodes |
Id | Grade | Path(s) | Details | Requirements |
crd-ci-q1 | error | NutritionOrder.extension:Coverage-Information | Questionnaire and QuestionnaireResponse are only allowed when doc-needed exists and not equal to 'no-doc' : extension.where(url='questionnaire' or url='response').exists() implies (extension.where(url = 'doc-needed').exists() and extension.where(url = 'doc-needed').all(value != 'no-doc')) | |
crd-ci-q2 | error | NutritionOrder.extension:Coverage-Information | If covered is set to 'not-covered', then 'pa-needed' should not exist. : extension.where(url = 'covered' and value != 'not-covered') implies extension.where(url = 'pa-needed').exists() | |
crd-ci-q3 | error | NutritionOrder.extension:Coverage-Information | If 'info-needed' exists, then at least one of 'covered', 'pa-needed', or 'doc-needed' must be 'conditional'. : extension.where(url = 'info-needed').exists() implies extension.where((url = 'covered' or url = 'pa-needed' or url = 'doc-needed') and value = 'conditional').count() >= 1 | |
crd-ci-q4 | error | NutritionOrder.extension:Coverage-Information | If 'pa-needed' is 'satisfied', then 'Doc-purpose' can't be 'PA'. : extension.where(url = 'pa-needed' and value = 'satisfied') and extension.where(url = 'doc-purpose').exists() implies extension.where(url = 'doc-purpose').all(value != 'PA') | |
crd-ci-q5 | error | NutritionOrder.extension:Coverage-Information | 'satisfied-pa-id' must exist if and only if 'pa-needed' is set to 'satisfied'. : extension.where(url = 'pa-needed' and value = 'satisfied').exists() = extension.where(url = 'satisfied-pa-id').exists() | |
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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
NutritionOrder | C | 0..* | NutritionOrder | 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): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
Coverage-Information | SC | 0..* | (Complex) | Coverage Info URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-coverage-information | ||||
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 | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Codes identifying the lifecycle stage of the nutrition order. Fixed Value: draft | ||||
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 | SΣ | 1..1 | Reference(CRD Patient) | The person who requires the diet, formula or nutritional supplement | ||||
encounter | S | 0..1 | Reference(CRD Encounter) | The encounter associated with this nutrition order | ||||
dateTime | SΣ | 1..1 | dateTime | Date and time the nutrition order was requested | ||||
orderer | SΣ | 1..1 | Reference(CRD Practitioner | US Core PractitionerRole Profile) | Who ordered the diet, formula or nutritional supplement | ||||
allergyIntolerance | S | 0..* | Reference(AllergyIntolerance) | List of the patient's food and nutrition-related allergies and intolerances | ||||
foodPreferenceModifier | S | 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 | S | 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 | SC | 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): Codes used to indicate the type of diet being ordered for a patient. | ||||
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 | 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 | SC | 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): Codes for nutritional supplements to be provided to the patient. | ||||
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 | SC | 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): Codes for type of enteral formula to be administered to patient. | ||||
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 | 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 | 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 | 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 / Code | ||||
NutritionOrder.language | preferred | CommonLanguages
| ||||
NutritionOrder.status | required | Fixed Value: draft | ||||
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 | Grade | Path(s) | Details | Requirements |
crd-ci-q1 | error | NutritionOrder.extension:Coverage-Information | Questionnaire and QuestionnaireResponse are only allowed when doc-needed exists and not equal to 'no-doc' : extension.where(url='questionnaire' or url='response').exists() implies (extension.where(url = 'doc-needed').exists() and extension.where(url = 'doc-needed').all(value != 'no-doc')) | |
crd-ci-q2 | error | NutritionOrder.extension:Coverage-Information | If covered is set to 'not-covered', then 'pa-needed' should not exist. : extension.where(url = 'covered' and value != 'not-covered') implies extension.where(url = 'pa-needed').exists() | |
crd-ci-q3 | error | NutritionOrder.extension:Coverage-Information | If 'info-needed' exists, then at least one of 'covered', 'pa-needed', or 'doc-needed' must be 'conditional'. : extension.where(url = 'info-needed').exists() implies extension.where((url = 'covered' or url = 'pa-needed' or url = 'doc-needed') and value = 'conditional').count() >= 1 | |
crd-ci-q4 | error | NutritionOrder.extension:Coverage-Information | If 'pa-needed' is 'satisfied', then 'Doc-purpose' can't be 'PA'. : extension.where(url = 'pa-needed' and value = 'satisfied') and extension.where(url = 'doc-purpose').exists() implies extension.where(url = 'doc-purpose').all(value != 'PA') | |
crd-ci-q5 | error | NutritionOrder.extension:Coverage-Information | 'satisfied-pa-id' must exist if and only if 'pa-needed' is set to 'satisfied'. : extension.where(url = 'pa-needed' and value = 'satisfied').exists() = extension.where(url = 'satisfied-pa-id').exists() | |
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() |
This structure is derived from NutritionOrder
Summary
Mandatory: 1 element
Must-Support: 13 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 1
Differential View
This structure is derived from NutritionOrder
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
NutritionOrder | 0..* | NutritionOrder | Diet, formula or nutritional supplement request | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
Coverage-Information | S | 0..* | (Complex) | Coverage Info URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-coverage-information |
identifier | S | 0..* | Identifier | Identifiers assigned to this order |
status | S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Fixed Value: draft |
patient | S | 1..1 | Reference(CRD Patient) | The person who requires the diet, formula or nutritional supplement |
encounter | S | 0..1 | Reference(CRD Encounter) | The encounter associated with this nutrition order |
dateTime | S | 1..1 | dateTime | Date and time the nutrition order was requested |
orderer | S | 1..1 | Reference(CRD Practitioner | US Core PractitionerRole Profile) | Who ordered the diet, formula or nutritional supplement |
allergyIntolerance | S | 0..* | Reference(AllergyIntolerance) | List of the patient's food and nutrition-related allergies and intolerances |
foodPreferenceModifier | S | 0..* | CodeableConcept | Order-specific modifier about the type of food that should be given |
excludeFoodModifier | S | 0..* | CodeableConcept | Order-specific modifier about the type of food that should not be given |
oralDiet | S | 0..1 | BackboneElement | Oral diet components |
supplement | S | 0..* | BackboneElement | Supplement components |
enteralFormula | S | 0..1 | BackboneElement | Enteral formula components |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
NutritionOrder | C | 0..* | NutritionOrder | Diet, formula or nutritional supplement request |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
Coverage-Information | SC | 0..* | (Complex) | Coverage Info URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-coverage-information |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | S | 0..* | Identifier | Identifiers assigned to this order |
status | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Codes identifying the lifecycle stage of the nutrition order. Fixed Value: draft |
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 | SΣ | 1..1 | Reference(CRD Patient) | The person who requires the diet, formula or nutritional supplement |
encounter | S | 0..1 | Reference(CRD Encounter) | The encounter associated with this nutrition order |
dateTime | SΣ | 1..1 | dateTime | Date and time the nutrition order was requested |
orderer | SΣ | 1..1 | Reference(CRD Practitioner | US Core PractitionerRole Profile) | Who ordered the diet, formula or nutritional supplement |
allergyIntolerance | S | 0..* | Reference(AllergyIntolerance) | List of the patient's food and nutrition-related allergies and intolerances |
foodPreferenceModifier | S | 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 | S | 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 | SC | 0..1 | BackboneElement | Oral diet components |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
supplement | SC | 0..* | BackboneElement | Supplement components |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
enteralFormula | SC | 0..1 | BackboneElement | Enteral formula components |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Documentation for this format |
Path | Conformance | ValueSet / Code |
NutritionOrder.status | required | Fixed Value: draft |
NutritionOrder.intent | required | RequestIntent |
NutritionOrder.foodPreferenceModifier | example | Diet |
NutritionOrder.excludeFoodModifier | example | FoodTypeCodes |
Id | Grade | Path(s) | Details | Requirements |
crd-ci-q1 | error | NutritionOrder.extension:Coverage-Information | Questionnaire and QuestionnaireResponse are only allowed when doc-needed exists and not equal to 'no-doc' : extension.where(url='questionnaire' or url='response').exists() implies (extension.where(url = 'doc-needed').exists() and extension.where(url = 'doc-needed').all(value != 'no-doc')) | |
crd-ci-q2 | error | NutritionOrder.extension:Coverage-Information | If covered is set to 'not-covered', then 'pa-needed' should not exist. : extension.where(url = 'covered' and value != 'not-covered') implies extension.where(url = 'pa-needed').exists() | |
crd-ci-q3 | error | NutritionOrder.extension:Coverage-Information | If 'info-needed' exists, then at least one of 'covered', 'pa-needed', or 'doc-needed' must be 'conditional'. : extension.where(url = 'info-needed').exists() implies extension.where((url = 'covered' or url = 'pa-needed' or url = 'doc-needed') and value = 'conditional').count() >= 1 | |
crd-ci-q4 | error | NutritionOrder.extension:Coverage-Information | If 'pa-needed' is 'satisfied', then 'Doc-purpose' can't be 'PA'. : extension.where(url = 'pa-needed' and value = 'satisfied') and extension.where(url = 'doc-purpose').exists() implies extension.where(url = 'doc-purpose').all(value != 'PA') | |
crd-ci-q5 | error | NutritionOrder.extension:Coverage-Information | 'satisfied-pa-id' must exist if and only if 'pa-needed' is set to 'satisfied'. : extension.where(url = 'pa-needed' and value = 'satisfied').exists() = extension.where(url = 'satisfied-pa-id').exists() | |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
NutritionOrder | C | 0..* | NutritionOrder | 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): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
Coverage-Information | SC | 0..* | (Complex) | Coverage Info URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-coverage-information | ||||
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 | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Codes identifying the lifecycle stage of the nutrition order. Fixed Value: draft | ||||
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 | SΣ | 1..1 | Reference(CRD Patient) | The person who requires the diet, formula or nutritional supplement | ||||
encounter | S | 0..1 | Reference(CRD Encounter) | The encounter associated with this nutrition order | ||||
dateTime | SΣ | 1..1 | dateTime | Date and time the nutrition order was requested | ||||
orderer | SΣ | 1..1 | Reference(CRD Practitioner | US Core PractitionerRole Profile) | Who ordered the diet, formula or nutritional supplement | ||||
allergyIntolerance | S | 0..* | Reference(AllergyIntolerance) | List of the patient's food and nutrition-related allergies and intolerances | ||||
foodPreferenceModifier | S | 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 | S | 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 | SC | 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): Codes used to indicate the type of diet being ordered for a patient. | ||||
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 | 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 | SC | 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): Codes for nutritional supplements to be provided to the patient. | ||||
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 | SC | 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): Codes for type of enteral formula to be administered to patient. | ||||
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 | 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 | 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 | 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 / Code | ||||
NutritionOrder.language | preferred | CommonLanguages
| ||||
NutritionOrder.status | required | Fixed Value: draft | ||||
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 | Grade | Path(s) | Details | Requirements |
crd-ci-q1 | error | NutritionOrder.extension:Coverage-Information | Questionnaire and QuestionnaireResponse are only allowed when doc-needed exists and not equal to 'no-doc' : extension.where(url='questionnaire' or url='response').exists() implies (extension.where(url = 'doc-needed').exists() and extension.where(url = 'doc-needed').all(value != 'no-doc')) | |
crd-ci-q2 | error | NutritionOrder.extension:Coverage-Information | If covered is set to 'not-covered', then 'pa-needed' should not exist. : extension.where(url = 'covered' and value != 'not-covered') implies extension.where(url = 'pa-needed').exists() | |
crd-ci-q3 | error | NutritionOrder.extension:Coverage-Information | If 'info-needed' exists, then at least one of 'covered', 'pa-needed', or 'doc-needed' must be 'conditional'. : extension.where(url = 'info-needed').exists() implies extension.where((url = 'covered' or url = 'pa-needed' or url = 'doc-needed') and value = 'conditional').count() >= 1 | |
crd-ci-q4 | error | NutritionOrder.extension:Coverage-Information | If 'pa-needed' is 'satisfied', then 'Doc-purpose' can't be 'PA'. : extension.where(url = 'pa-needed' and value = 'satisfied') and extension.where(url = 'doc-purpose').exists() implies extension.where(url = 'doc-purpose').all(value != 'PA') | |
crd-ci-q5 | error | NutritionOrder.extension:Coverage-Information | 'satisfied-pa-id' must exist if and only if 'pa-needed' is set to 'satisfied'. : extension.where(url = 'pa-needed' and value = 'satisfied').exists() = extension.where(url = 'satisfied-pa-id').exists() | |
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() |
This structure is derived from NutritionOrder
Summary
Mandatory: 1 element
Must-Support: 13 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron