HL7 PT FHIR Implementation Guide: Example IG Release 1 | STU1
0.0.1 - STU1
HL7 PT FHIR Implementation Guide: Example IG Release 1 | STU1, published by HL7 Portugal. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-pt/core/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.pt/fhir/core/StructureDefinition/PTNutritionOrder | Version: 0.0.1 | |||
Active as of 2024-09-23 | Computable Name: PT_NutritionOrder |
A generic NutritionOrder resource for Portugal
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 | |
identifier | 0..* | Identifier | Identifiers assigned to this order | |
patient | 1..1 | Reference(PT_Patient) | The person who requires the diet, formula or nutritional supplement | |
encounter | 0..1 | Reference(PT_Encounter) | The encounter associated with this nutrition order | |
orderer | 0..1 | Reference(PT_Practitioner | PT_PractitionerRole) | Who ordered the diet, formula or nutritional supplement | |
allergyIntolerance | 0..* | Reference(PT_AllergyIntolerance) | List of the patient's food and nutrition-related allergies and intolerances | |
foodPreferenceModifier | ||||
coding | ||||
system | 0..1 | uri | Identity of the terminology system | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
oralDiet | ||||
type | ||||
coding | ||||
system | 0..1 | uri | Identity of the terminology system | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
supplement | ||||
type | ||||
coding | ||||
system | 0..1 | uri | Identity of the terminology system | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
note | ||||
author[x] | 0..1 | Individual responsible for the annotation | ||
authorReference | Reference(PT_Practitioner | PT_Patient | PT_RelatedPerson | PT_Organization) | |||
authorString | string | |||
text | 1..1 | markdown | The annotation - text content (as markdown) | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
NutritionOrder | C | 0..* | NutritionOrder | Diet, formula or nutritional supplement request nor-1: Nutrition Order SHALL contain either Oral Diet , Supplement, or Enteral Formula class |
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 | |
status | ?!Σ | 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. |
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(PT_Patient) | The person who requires the diet, formula or nutritional supplement |
encounter | 0..1 | Reference(PT_Encounter) | The encounter associated with this nutrition order | |
dateTime | Σ | 1..1 | dateTime | Date and time the nutrition order was requested |
orderer | Σ | 0..1 | Reference(PT_Practitioner | PT_PractitionerRole) | Who ordered the diet, formula or nutritional supplement |
allergyIntolerance | 0..* | Reference(PT_AllergyIntolerance) | List of the patient's food and nutrition-related allergies and intolerances | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
NutritionOrder.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | |
NutritionOrder.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 nor-1: Nutrition Order SHALL contain either Oral Diet , Supplement, or Enteral Formula class | ||||
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 | |||||
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 | 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(PT_Patient) | The person who requires the diet, formula or nutritional supplement | ||||
encounter | 0..1 | Reference(PT_Encounter) | The encounter associated with this nutrition order | |||||
dateTime | Σ | 1..1 | dateTime | Date and time the nutrition order was requested | ||||
orderer | Σ | 0..1 | Reference(PT_Practitioner | PT_PractitionerRole) | Who ordered the diet, formula or nutritional supplement | ||||
allergyIntolerance | 0..* | Reference(PT_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. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
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 | 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. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
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 | 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 | 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. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
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 | Amount of the nutritional supplement | |||||
instruction | Σ | 0..1 | string | Instructions or additional information about the oral supplement | ||||
enteralFormula | C | 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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
authorReference | Reference(PT_Practitioner | PT_Patient | PT_RelatedPerson | PT_Organization) | |||||||
authorString | string | |||||||
time | Σ | 0..1 | dateTime | When the annotation was made | ||||
text | Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
NutritionOrder.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
NutritionOrder.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | ||||
NutritionOrder.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard | ||||
NutritionOrder.foodPreferenceModifier | example | Diethttp://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard | ||||
NutritionOrder.excludeFoodModifier | example | FoodTypeCodeshttp://hl7.org/fhir/ValueSet/food-type from the FHIR Standard | ||||
NutritionOrder.oralDiet.type | example | DietCodeshttp://hl7.org/fhir/ValueSet/diet-type from the FHIR Standard | ||||
NutritionOrder.oralDiet.nutrient.modifier | example | NutrientModifierCodeshttp://hl7.org/fhir/ValueSet/nutrient-code from the FHIR Standard | ||||
NutritionOrder.oralDiet.texture.modifier | example | TextureModifierCodeshttp://hl7.org/fhir/ValueSet/texture-code from the FHIR Standard | ||||
NutritionOrder.oralDiet.texture.foodType | example | TextureModifiedFoodTypeCodeshttp://hl7.org/fhir/ValueSet/modified-foodtype from the FHIR Standard | ||||
NutritionOrder.oralDiet.fluidConsistencyType | example | FluidConsistencyTypeCodeshttp://hl7.org/fhir/ValueSet/consistency-type from the FHIR Standard | ||||
NutritionOrder.supplement.type | example | SupplementTypeCodeshttp://hl7.org/fhir/ValueSet/supplement-type from the FHIR Standard | ||||
NutritionOrder.enteralFormula.baseFormulaType | example | EnteralFormulaTypeCodeshttp://hl7.org/fhir/ValueSet/entformula-type from the FHIR Standard | ||||
NutritionOrder.enteralFormula.additiveType | example | EnteralFormulaAdditiveTypeCodehttp://hl7.org/fhir/ValueSet/entformula-additive from the FHIR Standard | ||||
NutritionOrder.enteralFormula.routeofAdministration | extensible | EnteralRouteCodeshttp://hl7.org/fhir/ValueSet/enteral-route from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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
Structures
This structure refers to these other structures:
Differential View
This structure is derived from NutritionOrder
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
NutritionOrder | 0..* | NutritionOrder | Diet, formula or nutritional supplement request | |
identifier | 0..* | Identifier | Identifiers assigned to this order | |
patient | 1..1 | Reference(PT_Patient) | The person who requires the diet, formula or nutritional supplement | |
encounter | 0..1 | Reference(PT_Encounter) | The encounter associated with this nutrition order | |
orderer | 0..1 | Reference(PT_Practitioner | PT_PractitionerRole) | Who ordered the diet, formula or nutritional supplement | |
allergyIntolerance | 0..* | Reference(PT_AllergyIntolerance) | List of the patient's food and nutrition-related allergies and intolerances | |
foodPreferenceModifier | ||||
coding | ||||
system | 0..1 | uri | Identity of the terminology system | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
oralDiet | ||||
type | ||||
coding | ||||
system | 0..1 | uri | Identity of the terminology system | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
supplement | ||||
type | ||||
coding | ||||
system | 0..1 | uri | Identity of the terminology system | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
note | ||||
author[x] | 0..1 | Individual responsible for the annotation | ||
authorReference | Reference(PT_Practitioner | PT_Patient | PT_RelatedPerson | PT_Organization) | |||
authorString | string | |||
text | 1..1 | markdown | The annotation - text content (as markdown) | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
NutritionOrder | C | 0..* | NutritionOrder | Diet, formula or nutritional supplement request nor-1: Nutrition Order SHALL contain either Oral Diet , Supplement, or Enteral Formula class |
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 | |
status | ?!Σ | 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. |
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(PT_Patient) | The person who requires the diet, formula or nutritional supplement |
encounter | 0..1 | Reference(PT_Encounter) | The encounter associated with this nutrition order | |
dateTime | Σ | 1..1 | dateTime | Date and time the nutrition order was requested |
orderer | Σ | 0..1 | Reference(PT_Practitioner | PT_PractitionerRole) | Who ordered the diet, formula or nutritional supplement |
allergyIntolerance | 0..* | Reference(PT_AllergyIntolerance) | List of the patient's food and nutrition-related allergies and intolerances | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
NutritionOrder.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | |
NutritionOrder.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 nor-1: Nutrition Order SHALL contain either Oral Diet , Supplement, or Enteral Formula class | ||||
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 | |||||
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 | 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(PT_Patient) | The person who requires the diet, formula or nutritional supplement | ||||
encounter | 0..1 | Reference(PT_Encounter) | The encounter associated with this nutrition order | |||||
dateTime | Σ | 1..1 | dateTime | Date and time the nutrition order was requested | ||||
orderer | Σ | 0..1 | Reference(PT_Practitioner | PT_PractitionerRole) | Who ordered the diet, formula or nutritional supplement | ||||
allergyIntolerance | 0..* | Reference(PT_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. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
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 | 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. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
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 | 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 | 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. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
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 | Amount of the nutritional supplement | |||||
instruction | Σ | 0..1 | string | Instructions or additional information about the oral supplement | ||||
enteralFormula | C | 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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
authorReference | Reference(PT_Practitioner | PT_Patient | PT_RelatedPerson | PT_Organization) | |||||||
authorString | string | |||||||
time | Σ | 0..1 | dateTime | When the annotation was made | ||||
text | Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
NutritionOrder.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
NutritionOrder.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | ||||
NutritionOrder.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard | ||||
NutritionOrder.foodPreferenceModifier | example | Diethttp://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard | ||||
NutritionOrder.excludeFoodModifier | example | FoodTypeCodeshttp://hl7.org/fhir/ValueSet/food-type from the FHIR Standard | ||||
NutritionOrder.oralDiet.type | example | DietCodeshttp://hl7.org/fhir/ValueSet/diet-type from the FHIR Standard | ||||
NutritionOrder.oralDiet.nutrient.modifier | example | NutrientModifierCodeshttp://hl7.org/fhir/ValueSet/nutrient-code from the FHIR Standard | ||||
NutritionOrder.oralDiet.texture.modifier | example | TextureModifierCodeshttp://hl7.org/fhir/ValueSet/texture-code from the FHIR Standard | ||||
NutritionOrder.oralDiet.texture.foodType | example | TextureModifiedFoodTypeCodeshttp://hl7.org/fhir/ValueSet/modified-foodtype from the FHIR Standard | ||||
NutritionOrder.oralDiet.fluidConsistencyType | example | FluidConsistencyTypeCodeshttp://hl7.org/fhir/ValueSet/consistency-type from the FHIR Standard | ||||
NutritionOrder.supplement.type | example | SupplementTypeCodeshttp://hl7.org/fhir/ValueSet/supplement-type from the FHIR Standard | ||||
NutritionOrder.enteralFormula.baseFormulaType | example | EnteralFormulaTypeCodeshttp://hl7.org/fhir/ValueSet/entformula-type from the FHIR Standard | ||||
NutritionOrder.enteralFormula.additiveType | example | EnteralFormulaAdditiveTypeCodehttp://hl7.org/fhir/ValueSet/entformula-additive from the FHIR Standard | ||||
NutritionOrder.enteralFormula.routeofAdministration | extensible | EnteralRouteCodeshttp://hl7.org/fhir/ValueSet/enteral-route from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron