Extensions for Using Data Elements from FHIR STU3 in FHIR R4B
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR STU3 in FHIR R4B - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R3_NutritionOrder_R4B

Official URL: http://hl7.org/fhir/3.0/StructureDefinition/profile-NutritionOrder Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R3_NutritionOrder_R4B

This cross-version profile allows STU3 NutritionOrder content to be represented via FHIR R4B NutritionOrder resources.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. NutritionOrder C 0..* NutritionOrder(4.3.0) Diet, formula or nutritional supplement request
Constraints: nor-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... 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.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:status 0..1 code STU3: proposed | draft | planned | requested | active | on-hold | completed | cancelled | entered-in-error additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.status
Binding: R3NutritionRequestStatusForR4BRequestStatus (0.1.0) (required): Codes specifying the state of the request. Describes the lifecycle of the nutrition order.
Constraints: ext-1
... patient Σ 1..1 Reference(Patient) The person who requires the diet, formula or nutritional supplement
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:patient 0..1 Reference(Resource) STU3: patient additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
... dateTime Σ 1..1 dateTime Date and time the nutrition order was requested

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
NutritionOrder.status Base required RequestStatus 📍4.3.0 FHIR Std.
NutritionOrder.intent Base required RequestIntent 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error NutritionOrder If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error NutritionOrder If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+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(uri) = '#').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 NutritionOrder.implicitRules, NutritionOrder.modifierExtension, NutritionOrder.status, NutritionOrder.status.extension, NutritionOrder.status.extension:status, NutritionOrder.intent, NutritionOrder.patient, NutritionOrder.patient.extension, NutritionOrder.patient.extension:patient, NutritionOrder.dateTime All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error NutritionOrder.modifierExtension, NutritionOrder.status.extension, NutritionOrder.status.extension:status, NutritionOrder.patient.extension, NutritionOrder.patient.extension:patient 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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. NutritionOrder 0..* NutritionOrder(4.3.0) Diet, formula or nutritional supplement request
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.text
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:status 0..1 code STU3: proposed | draft | planned | requested | active | on-hold | completed | cancelled | entered-in-error additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.status
Binding: R3NutritionRequestStatusForR4BRequestStatus (0.1.0) (required): Codes specifying the state of the request. Describes the lifecycle of the nutrition order.
... patient
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:patient 0..1 Reference(Resource) STU3: patient additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... encounter
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:encounter 0..1 Reference(Resource) STU3: encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... orderer
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:orderer 0..1 Reference(Resource) STU3: orderer additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... allergyIntolerance
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:allergyIntolerance 0..* Reference(Resource) STU3: allergyIntolerance additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... oralDiet
.... schedule
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:schedule 0..* Timing STU3: schedule additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.oralDiet.schedule
... supplement
.... schedule
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:schedule 0..* Timing STU3: schedule additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.supplement.schedule
... enteralFormula
.... administration
..... schedule
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:schedule 0..1 Timing STU3: schedule additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.enteralFormula.administration.schedule

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. NutritionOrder C 0..* NutritionOrder(4.3.0) Diet, formula or nutritional supplement request
Constraints: nor-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required)
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier 0..* Identifier Identifiers assigned to this order
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... 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.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:status 0..1 code STU3: proposed | draft | planned | requested | active | on-hold | completed | cancelled | entered-in-error additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.status
Binding: R3NutritionRequestStatusForR4BRequestStatus (0.1.0) (required): Codes specifying the state of the request. Describes the lifecycle of the nutrition order.
Constraints: ext-1
.... value 0..1 code Primitive value for code
... 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(Patient) The person who requires the diet, formula or nutritional supplement
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:patient 0..1 Reference(Resource) STU3: patient additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter 0..1 Reference(Encounter) The encounter associated with this nutrition order
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:encounter 0..1 Reference(Resource) STU3: encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... dateTime Σ 1..1 dateTime Date and time the nutrition order was requested
... orderer Σ 0..1 Reference(Practitioner | PractitionerRole) Who ordered the diet, formula or nutritional supplement
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:orderer 0..1 Reference(Resource) STU3: orderer additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... allergyIntolerance 0..* Reference(AllergyIntolerance) List of the patient's food and nutrition-related allergies and intolerances
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:allergyIntolerance 0..1 Reference(Resource) STU3: allergyIntolerance additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... foodPreferenceModifier 0..* CodeableConcept Order-specific modifier about the type of food that should be given
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
... excludeFoodModifier 0..* CodeableConcept Order-specific modifier about the type of food that should not be given
Binding: FoodTypeCodes (example): Codes used to indicate the type of food that should NOT be given to the patient.
... oralDiet C 0..1 BackboneElement Oral diet components
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:schedule 0..* Timing STU3: schedule additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.oralDiet.schedule
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... event Σ 0..* dateTime When the event occurs
..... repeat ΣC 0..1 Element When the event is to occur
Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... bounds[x] Σ 0..1 Length/Range of lengths, or (Start and/or end) limits
....... boundsDuration Duration
....... boundsRange Range
....... boundsPeriod Period
...... count Σ 0..1 positiveInt Number of times to repeat
...... countMax Σ 0..1 positiveInt Maximum number of times to repeat
...... duration Σ 0..1 decimal How long when it happens
...... durationMax Σ 0..1 decimal How long when it happens (Max)
...... durationUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
...... frequency Σ 0..1 positiveInt Event occurs frequency times per period
...... frequencyMax Σ 0..1 positiveInt Event occurs up to frequencyMax times per period
...... period Σ 0..1 decimal Event occurs frequency times per period
...... periodMax Σ 0..1 decimal Upper limit of period (3-4 hours)
...... periodUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
...... dayOfWeek Σ 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
...... timeOfDay Σ 0..* time Time of day for action
...... when Σ 0..* code Code for time period of occurrence
Binding: EventTiming (required)
...... offset Σ 0..1 unsignedInt Minutes from event (before or after)
..... code Σ 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred)
.... nutrient 0..* BackboneElement Required nutrient modifications
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... modifier 0..1 CodeableConcept Type of nutrient that is being modified
Binding: NutrientModifierCodes (example): Codes for types of nutrients that are being modified such as carbohydrate or sodium.
..... amount 0..1 SimpleQuantity(4.3.0) 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
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:schedule 0..* Timing STU3: schedule additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.supplement.schedule
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... event Σ 0..* dateTime When the event occurs
..... repeat ΣC 0..1 Element When the event is to occur
Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... bounds[x] Σ 0..1 Length/Range of lengths, or (Start and/or end) limits
....... boundsDuration Duration
....... boundsRange Range
....... boundsPeriod Period
...... count Σ 0..1 positiveInt Number of times to repeat
...... countMax Σ 0..1 positiveInt Maximum number of times to repeat
...... duration Σ 0..1 decimal How long when it happens
...... durationMax Σ 0..1 decimal How long when it happens (Max)
...... durationUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
...... frequency Σ 0..1 positiveInt Event occurs frequency times per period
...... frequencyMax Σ 0..1 positiveInt Event occurs up to frequencyMax times per period
...... period Σ 0..1 decimal Event occurs frequency times per period
...... periodMax Σ 0..1 decimal Upper limit of period (3-4 hours)
...... periodUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
...... dayOfWeek Σ 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
...... timeOfDay Σ 0..* time Time of day for action
...... when Σ 0..* code Code for time period of occurrence
Binding: EventTiming (required)
...... offset Σ 0..1 unsignedInt Minutes from event (before or after)
..... code Σ 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred)
.... quantity 0..1 SimpleQuantity(4.3.0) 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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(4.3.0) 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
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... schedule 0..1 Timing Scheduled frequency of enteral feeding
...... id 0..1 id Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... extension:schedule 0..1 Timing STU3: schedule additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.enteralFormula.administration.schedule
Constraints: ext-1
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
...... event Σ 0..* dateTime When the event occurs
...... repeat ΣC 0..1 Element When the event is to occur
Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... bounds[x] Σ 0..1 Length/Range of lengths, or (Start and/or end) limits
........ boundsDuration Duration
........ boundsRange Range
........ boundsPeriod Period
....... count Σ 0..1 positiveInt Number of times to repeat
....... countMax Σ 0..1 positiveInt Maximum number of times to repeat
....... duration Σ 0..1 decimal How long when it happens
....... durationMax Σ 0..1 decimal How long when it happens (Max)
....... durationUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
....... frequency Σ 0..1 positiveInt Event occurs frequency times per period
....... frequencyMax Σ 0..1 positiveInt Event occurs up to frequencyMax times per period
....... period Σ 0..1 decimal Event occurs frequency times per period
....... periodMax Σ 0..1 decimal Upper limit of period (3-4 hours)
....... periodUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
....... dayOfWeek Σ 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
....... timeOfDay Σ 0..* time Time of day for action
....... when Σ 0..* code Code for time period of occurrence
Binding: EventTiming (required)
....... offset Σ 0..1 unsignedInt Minutes from event (before or after)
...... code Σ 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred)
..... quantity 0..1 SimpleQuantity(4.3.0) The volume of formula to provide
..... rate[x] 0..1 Speed with which the formula is provided per period of time
...... rateQuantity Quantity(SimpleQuantity)
...... rateRatio Ratio
.... maxVolumeToDeliver 0..1 SimpleQuantity(4.3.0) Upper limit on formula volume per unit of time
.... administrationInstruction Σ 0..1 string Formula feeding instructions expressed as text
... note 0..* Annotation Comments

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
NutritionOrder.meta.​security Base extensible SecurityLabels 📍4.3.0 FHIR Std.
NutritionOrder.meta.​tag Base example Common Tags 📍4.3.0 FHIR Std.
NutritionOrder.language Base preferred Common Languages 📍4.3.0 FHIR Std.
NutritionOrder.text.​status Base required NarrativeStatus 📍4.3.0 FHIR Std.
NutritionOrder.identifier.​use Base required IdentifierUse 📍4.3.0 FHIR Std.
NutritionOrder.identifier.​type Base extensible IdentifierType 📍4.3.0 FHIR Std.
NutritionOrder.status Base required RequestStatus 📍4.3.0 FHIR Std.
NutritionOrder.intent Base required RequestIntent 📍4.3.0 FHIR Std.
NutritionOrder.patient.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
NutritionOrder.encounter.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
NutritionOrder.orderer.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
NutritionOrder.allergyIntolerance.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
NutritionOrder.foodPreferenceModifier Base example Diet 📍4.3.0 FHIR Std.
NutritionOrder.excludeFoodModifier Base example Food Type Codes 📍4.3.0 FHIR Std.
NutritionOrder.oralDiet.​type Base example Diet Codes 📍4.3.0 FHIR Std.
NutritionOrder.oralDiet.​schedule.repeat.durationUnit Base required UnitsOfTime 📍4.3.0 FHIR Std.
NutritionOrder.oralDiet.​schedule.repeat.periodUnit Base required UnitsOfTime 📍4.3.0 FHIR Std.
NutritionOrder.oralDiet.​schedule.repeat.dayOfWeek Base required DaysOfWeek 📍4.3.0 FHIR Std.
NutritionOrder.oralDiet.​schedule.repeat.when Base required EventTiming 📍4.3.0 FHIR Std.
NutritionOrder.oralDiet.​schedule.code Base preferred TimingAbbreviation 📍4.3.0 FHIR Std.
NutritionOrder.oralDiet.​nutrient.modifier Base example Nutrient Modifier Codes 📍4.3.0 FHIR Std.
NutritionOrder.oralDiet.​texture.modifier Base example Texture Modifier Codes 📍4.3.0 FHIR Std.
NutritionOrder.oralDiet.​texture.foodType Base example Texture Modified Food Type Codes 📍4.3.0 FHIR Std.
NutritionOrder.oralDiet.​fluidConsistencyType Base example Fluid Consistency Type Codes 📍4.3.0 FHIR Std.
NutritionOrder.supplement.​type Base example Supplement Type Codes 📍4.3.0 FHIR Std.
NutritionOrder.supplement.​schedule.repeat.durationUnit Base required UnitsOfTime 📍4.3.0 FHIR Std.
NutritionOrder.supplement.​schedule.repeat.periodUnit Base required UnitsOfTime 📍4.3.0 FHIR Std.
NutritionOrder.supplement.​schedule.repeat.dayOfWeek Base required DaysOfWeek 📍4.3.0 FHIR Std.
NutritionOrder.supplement.​schedule.repeat.when Base required EventTiming 📍4.3.0 FHIR Std.
NutritionOrder.supplement.​schedule.code Base preferred TimingAbbreviation 📍4.3.0 FHIR Std.
NutritionOrder.enteralFormula.​baseFormulaType Base example Enteral Formula Type Codes 📍4.3.0 FHIR Std.
NutritionOrder.enteralFormula.​additiveType Base example Enteral Formula Additive Type Code 📍4.3.0 FHIR Std.
NutritionOrder.enteralFormula.​routeofAdministration Base extensible Enteral Route Codes 📍4.3.0 FHIR Std.
NutritionOrder.enteralFormula.​administration.schedule.​repeat.durationUnit Base required UnitsOfTime 📍4.3.0 FHIR Std.
NutritionOrder.enteralFormula.​administration.schedule.​repeat.periodUnit Base required UnitsOfTime 📍4.3.0 FHIR Std.
NutritionOrder.enteralFormula.​administration.schedule.​repeat.dayOfWeek Base required DaysOfWeek 📍4.3.0 FHIR Std.
NutritionOrder.enteralFormula.​administration.schedule.​repeat.when Base required EventTiming 📍4.3.0 FHIR Std.
NutritionOrder.enteralFormula.​administration.schedule.​code Base preferred TimingAbbreviation 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error NutritionOrder If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error NutritionOrder If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+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(uri) = '#').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()
dom-r4b warning NutritionOrder.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error NutritionOrder.meta, NutritionOrder.meta.extension, NutritionOrder.meta.extension:meta, NutritionOrder.meta.versionId, NutritionOrder.meta.lastUpdated, NutritionOrder.meta.source, NutritionOrder.meta.profile, NutritionOrder.meta.security, NutritionOrder.meta.tag, NutritionOrder.implicitRules, NutritionOrder.language, NutritionOrder.text, NutritionOrder.text.extension, NutritionOrder.text.extension:text, NutritionOrder.text.status, NutritionOrder.text.div, NutritionOrder.extension, NutritionOrder.modifierExtension, NutritionOrder.identifier, NutritionOrder.identifier.extension, NutritionOrder.identifier.extension:identifier, NutritionOrder.identifier.use, NutritionOrder.identifier.type, NutritionOrder.identifier.system, NutritionOrder.identifier.value, NutritionOrder.identifier.period, NutritionOrder.identifier.assigner, NutritionOrder.instantiatesCanonical, NutritionOrder.instantiatesUri, NutritionOrder.instantiates, NutritionOrder.status, NutritionOrder.status.extension, NutritionOrder.status.extension:status, NutritionOrder.intent, NutritionOrder.patient, NutritionOrder.patient.extension, NutritionOrder.patient.extension:patient, NutritionOrder.patient.reference, NutritionOrder.patient.type, NutritionOrder.patient.identifier, NutritionOrder.patient.display, NutritionOrder.encounter, NutritionOrder.encounter.extension, NutritionOrder.encounter.extension:encounter, NutritionOrder.encounter.reference, NutritionOrder.encounter.type, NutritionOrder.encounter.identifier, NutritionOrder.encounter.display, NutritionOrder.dateTime, NutritionOrder.orderer, NutritionOrder.orderer.extension, NutritionOrder.orderer.extension:orderer, NutritionOrder.orderer.reference, NutritionOrder.orderer.type, NutritionOrder.orderer.identifier, NutritionOrder.orderer.display, NutritionOrder.allergyIntolerance, NutritionOrder.allergyIntolerance.extension, NutritionOrder.allergyIntolerance.extension:allergyIntolerance, NutritionOrder.allergyIntolerance.reference, NutritionOrder.allergyIntolerance.type, NutritionOrder.allergyIntolerance.identifier, NutritionOrder.allergyIntolerance.display, NutritionOrder.foodPreferenceModifier, NutritionOrder.excludeFoodModifier, NutritionOrder.oralDiet, NutritionOrder.oralDiet.extension, NutritionOrder.oralDiet.modifierExtension, NutritionOrder.oralDiet.type, NutritionOrder.oralDiet.schedule, NutritionOrder.oralDiet.schedule.extension, NutritionOrder.oralDiet.schedule.extension:schedule, NutritionOrder.oralDiet.schedule.modifierExtension, NutritionOrder.oralDiet.schedule.event, NutritionOrder.oralDiet.schedule.repeat, NutritionOrder.oralDiet.schedule.repeat.extension, NutritionOrder.oralDiet.schedule.repeat.bounds[x], NutritionOrder.oralDiet.schedule.repeat.count, NutritionOrder.oralDiet.schedule.repeat.countMax, NutritionOrder.oralDiet.schedule.repeat.duration, NutritionOrder.oralDiet.schedule.repeat.durationMax, NutritionOrder.oralDiet.schedule.repeat.durationUnit, NutritionOrder.oralDiet.schedule.repeat.frequency, NutritionOrder.oralDiet.schedule.repeat.frequencyMax, NutritionOrder.oralDiet.schedule.repeat.period, NutritionOrder.oralDiet.schedule.repeat.periodMax, NutritionOrder.oralDiet.schedule.repeat.periodUnit, NutritionOrder.oralDiet.schedule.repeat.dayOfWeek, NutritionOrder.oralDiet.schedule.repeat.timeOfDay, NutritionOrder.oralDiet.schedule.repeat.when, NutritionOrder.oralDiet.schedule.repeat.offset, NutritionOrder.oralDiet.schedule.code, NutritionOrder.oralDiet.nutrient, NutritionOrder.oralDiet.nutrient.extension, NutritionOrder.oralDiet.nutrient.modifierExtension, NutritionOrder.oralDiet.nutrient.modifier, NutritionOrder.oralDiet.nutrient.amount, NutritionOrder.oralDiet.texture, NutritionOrder.oralDiet.texture.extension, NutritionOrder.oralDiet.texture.modifierExtension, NutritionOrder.oralDiet.texture.modifier, NutritionOrder.oralDiet.texture.foodType, NutritionOrder.oralDiet.fluidConsistencyType, NutritionOrder.oralDiet.instruction, NutritionOrder.supplement, NutritionOrder.supplement.extension, NutritionOrder.supplement.modifierExtension, NutritionOrder.supplement.type, NutritionOrder.supplement.productName, NutritionOrder.supplement.schedule, NutritionOrder.supplement.schedule.extension, NutritionOrder.supplement.schedule.extension:schedule, NutritionOrder.supplement.schedule.modifierExtension, NutritionOrder.supplement.schedule.event, NutritionOrder.supplement.schedule.repeat, NutritionOrder.supplement.schedule.repeat.extension, NutritionOrder.supplement.schedule.repeat.bounds[x], NutritionOrder.supplement.schedule.repeat.count, NutritionOrder.supplement.schedule.repeat.countMax, NutritionOrder.supplement.schedule.repeat.duration, NutritionOrder.supplement.schedule.repeat.durationMax, NutritionOrder.supplement.schedule.repeat.durationUnit, NutritionOrder.supplement.schedule.repeat.frequency, NutritionOrder.supplement.schedule.repeat.frequencyMax, NutritionOrder.supplement.schedule.repeat.period, NutritionOrder.supplement.schedule.repeat.periodMax, NutritionOrder.supplement.schedule.repeat.periodUnit, NutritionOrder.supplement.schedule.repeat.dayOfWeek, NutritionOrder.supplement.schedule.repeat.timeOfDay, NutritionOrder.supplement.schedule.repeat.when, NutritionOrder.supplement.schedule.repeat.offset, NutritionOrder.supplement.schedule.code, NutritionOrder.supplement.quantity, NutritionOrder.supplement.instruction, NutritionOrder.enteralFormula, NutritionOrder.enteralFormula.extension, NutritionOrder.enteralFormula.modifierExtension, NutritionOrder.enteralFormula.baseFormulaType, NutritionOrder.enteralFormula.baseFormulaProductName, NutritionOrder.enteralFormula.additiveType, NutritionOrder.enteralFormula.additiveProductName, NutritionOrder.enteralFormula.caloricDensity, NutritionOrder.enteralFormula.routeofAdministration, NutritionOrder.enteralFormula.administration, NutritionOrder.enteralFormula.administration.extension, NutritionOrder.enteralFormula.administration.modifierExtension, NutritionOrder.enteralFormula.administration.schedule, NutritionOrder.enteralFormula.administration.schedule.extension, NutritionOrder.enteralFormula.administration.schedule.extension:schedule, NutritionOrder.enteralFormula.administration.schedule.modifierExtension, NutritionOrder.enteralFormula.administration.schedule.event, NutritionOrder.enteralFormula.administration.schedule.repeat, NutritionOrder.enteralFormula.administration.schedule.repeat.extension, NutritionOrder.enteralFormula.administration.schedule.repeat.bounds[x], NutritionOrder.enteralFormula.administration.schedule.repeat.count, NutritionOrder.enteralFormula.administration.schedule.repeat.countMax, NutritionOrder.enteralFormula.administration.schedule.repeat.duration, NutritionOrder.enteralFormula.administration.schedule.repeat.durationMax, NutritionOrder.enteralFormula.administration.schedule.repeat.durationUnit, NutritionOrder.enteralFormula.administration.schedule.repeat.frequency, NutritionOrder.enteralFormula.administration.schedule.repeat.frequencyMax, NutritionOrder.enteralFormula.administration.schedule.repeat.period, NutritionOrder.enteralFormula.administration.schedule.repeat.periodMax, NutritionOrder.enteralFormula.administration.schedule.repeat.periodUnit, NutritionOrder.enteralFormula.administration.schedule.repeat.dayOfWeek, NutritionOrder.enteralFormula.administration.schedule.repeat.timeOfDay, NutritionOrder.enteralFormula.administration.schedule.repeat.when, NutritionOrder.enteralFormula.administration.schedule.repeat.offset, NutritionOrder.enteralFormula.administration.schedule.code, NutritionOrder.enteralFormula.administration.quantity, NutritionOrder.enteralFormula.administration.rate[x], NutritionOrder.enteralFormula.maxVolumeToDeliver, NutritionOrder.enteralFormula.administrationInstruction, NutritionOrder.note All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error NutritionOrder.meta.extension, NutritionOrder.meta.extension:meta, NutritionOrder.text.extension, NutritionOrder.text.extension:text, NutritionOrder.extension, NutritionOrder.modifierExtension, NutritionOrder.identifier.extension, NutritionOrder.identifier.extension:identifier, NutritionOrder.status.extension, NutritionOrder.status.extension:status, NutritionOrder.patient.extension, NutritionOrder.patient.extension:patient, NutritionOrder.encounter.extension, NutritionOrder.encounter.extension:encounter, NutritionOrder.orderer.extension, NutritionOrder.orderer.extension:orderer, NutritionOrder.allergyIntolerance.extension, NutritionOrder.allergyIntolerance.extension:allergyIntolerance, NutritionOrder.oralDiet.extension, NutritionOrder.oralDiet.modifierExtension, NutritionOrder.oralDiet.schedule.extension, NutritionOrder.oralDiet.schedule.extension:schedule, NutritionOrder.oralDiet.schedule.modifierExtension, NutritionOrder.oralDiet.schedule.repeat.extension, NutritionOrder.oralDiet.nutrient.extension, NutritionOrder.oralDiet.nutrient.modifierExtension, NutritionOrder.oralDiet.texture.extension, NutritionOrder.oralDiet.texture.modifierExtension, NutritionOrder.supplement.extension, NutritionOrder.supplement.modifierExtension, NutritionOrder.supplement.schedule.extension, NutritionOrder.supplement.schedule.extension:schedule, NutritionOrder.supplement.schedule.modifierExtension, NutritionOrder.supplement.schedule.repeat.extension, NutritionOrder.enteralFormula.extension, NutritionOrder.enteralFormula.modifierExtension, NutritionOrder.enteralFormula.administration.extension, NutritionOrder.enteralFormula.administration.modifierExtension, NutritionOrder.enteralFormula.administration.schedule.extension, NutritionOrder.enteralFormula.administration.schedule.extension:schedule, NutritionOrder.enteralFormula.administration.schedule.modifierExtension, NutritionOrder.enteralFormula.administration.schedule.repeat.extension 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()
tim-1 error NutritionOrder.oralDiet.schedule.repeat, NutritionOrder.supplement.schedule.repeat, NutritionOrder.enteralFormula.administration.schedule.repeat if there's a duration, there needs to be duration units duration.empty() or durationUnit.exists()
tim-2 error NutritionOrder.oralDiet.schedule.repeat, NutritionOrder.supplement.schedule.repeat, NutritionOrder.enteralFormula.administration.schedule.repeat if there's a period, there needs to be period units period.empty() or periodUnit.exists()
tim-4 error NutritionOrder.oralDiet.schedule.repeat, NutritionOrder.supplement.schedule.repeat, NutritionOrder.enteralFormula.administration.schedule.repeat duration SHALL be a non-negative value duration.exists() implies duration >= 0
tim-5 error NutritionOrder.oralDiet.schedule.repeat, NutritionOrder.supplement.schedule.repeat, NutritionOrder.enteralFormula.administration.schedule.repeat period SHALL be a non-negative value period.exists() implies period >= 0
tim-6 error NutritionOrder.oralDiet.schedule.repeat, NutritionOrder.supplement.schedule.repeat, NutritionOrder.enteralFormula.administration.schedule.repeat If there's a periodMax, there must be a period periodMax.empty() or period.exists()
tim-7 error NutritionOrder.oralDiet.schedule.repeat, NutritionOrder.supplement.schedule.repeat, NutritionOrder.enteralFormula.administration.schedule.repeat If there's a durationMax, there must be a duration durationMax.empty() or duration.exists()
tim-8 error NutritionOrder.oralDiet.schedule.repeat, NutritionOrder.supplement.schedule.repeat, NutritionOrder.enteralFormula.administration.schedule.repeat If there's a countMax, there must be a count countMax.empty() or count.exists()
tim-9 error NutritionOrder.oralDiet.schedule.repeat, NutritionOrder.supplement.schedule.repeat, NutritionOrder.enteralFormula.administration.schedule.repeat If there's an offset, there must be a when (and not C, CM, CD, CV) offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
tim-10 error NutritionOrder.oralDiet.schedule.repeat, NutritionOrder.supplement.schedule.repeat, NutritionOrder.enteralFormula.administration.schedule.repeat If there's a timeOfDay, there cannot be a when, or vice versa timeOfDay.empty() or when.empty()
txt-1 error NutritionOrder.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error NutritionOrder.text.div The narrative SHALL have some non-whitespace content htmlChecks()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. NutritionOrder C 0..* NutritionOrder(4.3.0) Diet, formula or nutritional supplement request
Constraints: nor-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... 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.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:status 0..1 code STU3: proposed | draft | planned | requested | active | on-hold | completed | cancelled | entered-in-error additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.status
Binding: R3NutritionRequestStatusForR4BRequestStatus (0.1.0) (required): Codes specifying the state of the request. Describes the lifecycle of the nutrition order.
Constraints: ext-1
... patient Σ 1..1 Reference(Patient) The person who requires the diet, formula or nutritional supplement
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:patient 0..1 Reference(Resource) STU3: patient additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
... dateTime Σ 1..1 dateTime Date and time the nutrition order was requested

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
NutritionOrder.status Base required RequestStatus 📍4.3.0 FHIR Std.
NutritionOrder.intent Base required RequestIntent 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error NutritionOrder If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error NutritionOrder If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+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(uri) = '#').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 NutritionOrder.implicitRules, NutritionOrder.modifierExtension, NutritionOrder.status, NutritionOrder.status.extension, NutritionOrder.status.extension:status, NutritionOrder.intent, NutritionOrder.patient, NutritionOrder.patient.extension, NutritionOrder.patient.extension:patient, NutritionOrder.dateTime All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error NutritionOrder.modifierExtension, NutritionOrder.status.extension, NutritionOrder.status.extension:status, NutritionOrder.patient.extension, NutritionOrder.patient.extension:patient Must have either extensions or value[x], not both extension.exists() != value.exists()
nor-1 warning NutritionOrder Nutrition Order SHALL contain either Oral Diet , Supplement, or Enteral Formula class oralDiet.exists() or supplement.exists() or enteralFormula.exists()

Differential View

This structure is derived from NutritionOrder

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. NutritionOrder 0..* NutritionOrder(4.3.0) Diet, formula or nutritional supplement request
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.text
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:status 0..1 code STU3: proposed | draft | planned | requested | active | on-hold | completed | cancelled | entered-in-error additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.status
Binding: R3NutritionRequestStatusForR4BRequestStatus (0.1.0) (required): Codes specifying the state of the request. Describes the lifecycle of the nutrition order.
... patient
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:patient 0..1 Reference(Resource) STU3: patient additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... encounter
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:encounter 0..1 Reference(Resource) STU3: encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... orderer
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:orderer 0..1 Reference(Resource) STU3: orderer additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... allergyIntolerance
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:allergyIntolerance 0..* Reference(Resource) STU3: allergyIntolerance additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... oralDiet
.... schedule
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:schedule 0..* Timing STU3: schedule additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.oralDiet.schedule
... supplement
.... schedule
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:schedule 0..* Timing STU3: schedule additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.supplement.schedule
... enteralFormula
.... administration
..... schedule
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:schedule 0..1 Timing STU3: schedule additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.enteralFormula.administration.schedule

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. NutritionOrder C 0..* NutritionOrder(4.3.0) Diet, formula or nutritional supplement request
Constraints: nor-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required)
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier 0..* Identifier Identifiers assigned to this order
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... 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.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:status 0..1 code STU3: proposed | draft | planned | requested | active | on-hold | completed | cancelled | entered-in-error additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.status
Binding: R3NutritionRequestStatusForR4BRequestStatus (0.1.0) (required): Codes specifying the state of the request. Describes the lifecycle of the nutrition order.
Constraints: ext-1
.... value 0..1 code Primitive value for code
... 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(Patient) The person who requires the diet, formula or nutritional supplement
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:patient 0..1 Reference(Resource) STU3: patient additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter 0..1 Reference(Encounter) The encounter associated with this nutrition order
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:encounter 0..1 Reference(Resource) STU3: encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... dateTime Σ 1..1 dateTime Date and time the nutrition order was requested
... orderer Σ 0..1 Reference(Practitioner | PractitionerRole) Who ordered the diet, formula or nutritional supplement
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:orderer 0..1 Reference(Resource) STU3: orderer additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... allergyIntolerance 0..* Reference(AllergyIntolerance) List of the patient's food and nutrition-related allergies and intolerances
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:allergyIntolerance 0..1 Reference(Resource) STU3: allergyIntolerance additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... foodPreferenceModifier 0..* CodeableConcept Order-specific modifier about the type of food that should be given
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
... excludeFoodModifier 0..* CodeableConcept Order-specific modifier about the type of food that should not be given
Binding: FoodTypeCodes (example): Codes used to indicate the type of food that should NOT be given to the patient.
... oralDiet C 0..1 BackboneElement Oral diet components
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:schedule 0..* Timing STU3: schedule additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.oralDiet.schedule
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... event Σ 0..* dateTime When the event occurs
..... repeat ΣC 0..1 Element When the event is to occur
Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... bounds[x] Σ 0..1 Length/Range of lengths, or (Start and/or end) limits
....... boundsDuration Duration
....... boundsRange Range
....... boundsPeriod Period
...... count Σ 0..1 positiveInt Number of times to repeat
...... countMax Σ 0..1 positiveInt Maximum number of times to repeat
...... duration Σ 0..1 decimal How long when it happens
...... durationMax Σ 0..1 decimal How long when it happens (Max)
...... durationUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
...... frequency Σ 0..1 positiveInt Event occurs frequency times per period
...... frequencyMax Σ 0..1 positiveInt Event occurs up to frequencyMax times per period
...... period Σ 0..1 decimal Event occurs frequency times per period
...... periodMax Σ 0..1 decimal Upper limit of period (3-4 hours)
...... periodUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
...... dayOfWeek Σ 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
...... timeOfDay Σ 0..* time Time of day for action
...... when Σ 0..* code Code for time period of occurrence
Binding: EventTiming (required)
...... offset Σ 0..1 unsignedInt Minutes from event (before or after)
..... code Σ 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred)
.... nutrient 0..* BackboneElement Required nutrient modifications
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... modifier 0..1 CodeableConcept Type of nutrient that is being modified
Binding: NutrientModifierCodes (example): Codes for types of nutrients that are being modified such as carbohydrate or sodium.
..... amount 0..1 SimpleQuantity(4.3.0) 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
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:schedule 0..* Timing STU3: schedule additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.supplement.schedule
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... event Σ 0..* dateTime When the event occurs
..... repeat ΣC 0..1 Element When the event is to occur
Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... bounds[x] Σ 0..1 Length/Range of lengths, or (Start and/or end) limits
....... boundsDuration Duration
....... boundsRange Range
....... boundsPeriod Period
...... count Σ 0..1 positiveInt Number of times to repeat
...... countMax Σ 0..1 positiveInt Maximum number of times to repeat
...... duration Σ 0..1 decimal How long when it happens
...... durationMax Σ 0..1 decimal How long when it happens (Max)
...... durationUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
...... frequency Σ 0..1 positiveInt Event occurs frequency times per period
...... frequencyMax Σ 0..1 positiveInt Event occurs up to frequencyMax times per period
...... period Σ 0..1 decimal Event occurs frequency times per period
...... periodMax Σ 0..1 decimal Upper limit of period (3-4 hours)
...... periodUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
...... dayOfWeek Σ 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
...... timeOfDay Σ 0..* time Time of day for action
...... when Σ 0..* code Code for time period of occurrence
Binding: EventTiming (required)
...... offset Σ 0..1 unsignedInt Minutes from event (before or after)
..... code Σ 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred)
.... quantity 0..1 SimpleQuantity(4.3.0) 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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(4.3.0) 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
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... schedule 0..1 Timing Scheduled frequency of enteral feeding
...... id 0..1 id Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... extension:schedule 0..1 Timing STU3: schedule additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NutritionOrder.enteralFormula.administration.schedule
Constraints: ext-1
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
...... event Σ 0..* dateTime When the event occurs
...... repeat ΣC 0..1 Element When the event is to occur
Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... bounds[x] Σ 0..1 Length/Range of lengths, or (Start and/or end) limits
........ boundsDuration Duration
........ boundsRange Range
........ boundsPeriod Period
....... count Σ 0..1 positiveInt Number of times to repeat
....... countMax Σ 0..1 positiveInt Maximum number of times to repeat
....... duration Σ 0..1 decimal How long when it happens
....... durationMax Σ 0..1 decimal How long when it happens (Max)
....... durationUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
....... frequency Σ 0..1 positiveInt Event occurs frequency times per period
....... frequencyMax Σ 0..1 positiveInt Event occurs up to frequencyMax times per period
....... period Σ 0..1 decimal Event occurs frequency times per period
....... periodMax Σ 0..1 decimal Upper limit of period (3-4 hours)
....... periodUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
....... dayOfWeek Σ 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
....... timeOfDay Σ 0..* time Time of day for action
....... when Σ 0..* code Code for time period of occurrence
Binding: EventTiming (required)
....... offset Σ 0..1 unsignedInt Minutes from event (before or after)
...... code Σ 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred)
..... quantity 0..1 SimpleQuantity(4.3.0) The volume of formula to provide
..... rate[x] 0..1 Speed with which the formula is provided per period of time
...... rateQuantity Quantity(SimpleQuantity)
...... rateRatio Ratio
.... maxVolumeToDeliver 0..1 SimpleQuantity(4.3.0) Upper limit on formula volume per unit of time
.... administrationInstruction Σ 0..1 string Formula feeding instructions expressed as text
... note 0..* Annotation Comments

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
NutritionOrder.meta.​security Base extensible SecurityLabels 📍4.3.0 FHIR Std.
NutritionOrder.meta.​tag Base example Common Tags 📍4.3.0 FHIR Std.
NutritionOrder.language Base preferred Common Languages 📍4.3.0 FHIR Std.
NutritionOrder.text.​status Base required NarrativeStatus 📍4.3.0 FHIR Std.
NutritionOrder.identifier.​use Base required IdentifierUse 📍4.3.0 FHIR Std.
NutritionOrder.identifier.​type Base extensible IdentifierType 📍4.3.0 FHIR Std.
NutritionOrder.status Base required RequestStatus 📍4.3.0 FHIR Std.
NutritionOrder.intent Base required RequestIntent 📍4.3.0 FHIR Std.
NutritionOrder.patient.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
NutritionOrder.encounter.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
NutritionOrder.orderer.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
NutritionOrder.allergyIntolerance.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
NutritionOrder.foodPreferenceModifier Base example Diet 📍4.3.0 FHIR Std.
NutritionOrder.excludeFoodModifier Base example Food Type Codes 📍4.3.0 FHIR Std.
NutritionOrder.oralDiet.​type Base example Diet Codes 📍4.3.0 FHIR Std.
NutritionOrder.oralDiet.​schedule.repeat.durationUnit Base required UnitsOfTime 📍4.3.0 FHIR Std.
NutritionOrder.oralDiet.​schedule.repeat.periodUnit Base required UnitsOfTime 📍4.3.0 FHIR Std.
NutritionOrder.oralDiet.​schedule.repeat.dayOfWeek Base required DaysOfWeek 📍4.3.0 FHIR Std.
NutritionOrder.oralDiet.​schedule.repeat.when Base required EventTiming 📍4.3.0 FHIR Std.
NutritionOrder.oralDiet.​schedule.code Base preferred TimingAbbreviation 📍4.3.0 FHIR Std.
NutritionOrder.oralDiet.​nutrient.modifier Base example Nutrient Modifier Codes 📍4.3.0 FHIR Std.
NutritionOrder.oralDiet.​texture.modifier Base example Texture Modifier Codes 📍4.3.0 FHIR Std.
NutritionOrder.oralDiet.​texture.foodType Base example Texture Modified Food Type Codes 📍4.3.0 FHIR Std.
NutritionOrder.oralDiet.​fluidConsistencyType Base example Fluid Consistency Type Codes 📍4.3.0 FHIR Std.
NutritionOrder.supplement.​type Base example Supplement Type Codes 📍4.3.0 FHIR Std.
NutritionOrder.supplement.​schedule.repeat.durationUnit Base required UnitsOfTime 📍4.3.0 FHIR Std.
NutritionOrder.supplement.​schedule.repeat.periodUnit Base required UnitsOfTime 📍4.3.0 FHIR Std.
NutritionOrder.supplement.​schedule.repeat.dayOfWeek Base required DaysOfWeek 📍4.3.0 FHIR Std.
NutritionOrder.supplement.​schedule.repeat.when Base required EventTiming 📍4.3.0 FHIR Std.
NutritionOrder.supplement.​schedule.code Base preferred TimingAbbreviation 📍4.3.0 FHIR Std.
NutritionOrder.enteralFormula.​baseFormulaType Base example Enteral Formula Type Codes 📍4.3.0 FHIR Std.
NutritionOrder.enteralFormula.​additiveType Base example Enteral Formula Additive Type Code 📍4.3.0 FHIR Std.
NutritionOrder.enteralFormula.​routeofAdministration Base extensible Enteral Route Codes 📍4.3.0 FHIR Std.
NutritionOrder.enteralFormula.​administration.schedule.​repeat.durationUnit Base required UnitsOfTime 📍4.3.0 FHIR Std.
NutritionOrder.enteralFormula.​administration.schedule.​repeat.periodUnit Base required UnitsOfTime 📍4.3.0 FHIR Std.
NutritionOrder.enteralFormula.​administration.schedule.​repeat.dayOfWeek Base required DaysOfWeek 📍4.3.0 FHIR Std.
NutritionOrder.enteralFormula.​administration.schedule.​repeat.when Base required EventTiming 📍4.3.0 FHIR Std.
NutritionOrder.enteralFormula.​administration.schedule.​code Base preferred TimingAbbreviation 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error NutritionOrder If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error NutritionOrder If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+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(uri) = '#').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()
dom-r4b warning NutritionOrder.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error NutritionOrder.meta, NutritionOrder.meta.extension, NutritionOrder.meta.extension:meta, NutritionOrder.meta.versionId, NutritionOrder.meta.lastUpdated, NutritionOrder.meta.source, NutritionOrder.meta.profile, NutritionOrder.meta.security, NutritionOrder.meta.tag, NutritionOrder.implicitRules, NutritionOrder.language, NutritionOrder.text, NutritionOrder.text.extension, NutritionOrder.text.extension:text, NutritionOrder.text.status, NutritionOrder.text.div, NutritionOrder.extension, NutritionOrder.modifierExtension, NutritionOrder.identifier, NutritionOrder.identifier.extension, NutritionOrder.identifier.extension:identifier, NutritionOrder.identifier.use, NutritionOrder.identifier.type, NutritionOrder.identifier.system, NutritionOrder.identifier.value, NutritionOrder.identifier.period, NutritionOrder.identifier.assigner, NutritionOrder.instantiatesCanonical, NutritionOrder.instantiatesUri, NutritionOrder.instantiates, NutritionOrder.status, NutritionOrder.status.extension, NutritionOrder.status.extension:status, NutritionOrder.intent, NutritionOrder.patient, NutritionOrder.patient.extension, NutritionOrder.patient.extension:patient, NutritionOrder.patient.reference, NutritionOrder.patient.type, NutritionOrder.patient.identifier, NutritionOrder.patient.display, NutritionOrder.encounter, NutritionOrder.encounter.extension, NutritionOrder.encounter.extension:encounter, NutritionOrder.encounter.reference, NutritionOrder.encounter.type, NutritionOrder.encounter.identifier, NutritionOrder.encounter.display, NutritionOrder.dateTime, NutritionOrder.orderer, NutritionOrder.orderer.extension, NutritionOrder.orderer.extension:orderer, NutritionOrder.orderer.reference, NutritionOrder.orderer.type, NutritionOrder.orderer.identifier, NutritionOrder.orderer.display, NutritionOrder.allergyIntolerance, NutritionOrder.allergyIntolerance.extension, NutritionOrder.allergyIntolerance.extension:allergyIntolerance, NutritionOrder.allergyIntolerance.reference, NutritionOrder.allergyIntolerance.type, NutritionOrder.allergyIntolerance.identifier, NutritionOrder.allergyIntolerance.display, NutritionOrder.foodPreferenceModifier, NutritionOrder.excludeFoodModifier, NutritionOrder.oralDiet, NutritionOrder.oralDiet.extension, NutritionOrder.oralDiet.modifierExtension, NutritionOrder.oralDiet.type, NutritionOrder.oralDiet.schedule, NutritionOrder.oralDiet.schedule.extension, NutritionOrder.oralDiet.schedule.extension:schedule, NutritionOrder.oralDiet.schedule.modifierExtension, NutritionOrder.oralDiet.schedule.event, NutritionOrder.oralDiet.schedule.repeat, NutritionOrder.oralDiet.schedule.repeat.extension, NutritionOrder.oralDiet.schedule.repeat.bounds[x], NutritionOrder.oralDiet.schedule.repeat.count, NutritionOrder.oralDiet.schedule.repeat.countMax, NutritionOrder.oralDiet.schedule.repeat.duration, NutritionOrder.oralDiet.schedule.repeat.durationMax, NutritionOrder.oralDiet.schedule.repeat.durationUnit, NutritionOrder.oralDiet.schedule.repeat.frequency, NutritionOrder.oralDiet.schedule.repeat.frequencyMax, NutritionOrder.oralDiet.schedule.repeat.period, NutritionOrder.oralDiet.schedule.repeat.periodMax, NutritionOrder.oralDiet.schedule.repeat.periodUnit, NutritionOrder.oralDiet.schedule.repeat.dayOfWeek, NutritionOrder.oralDiet.schedule.repeat.timeOfDay, NutritionOrder.oralDiet.schedule.repeat.when, NutritionOrder.oralDiet.schedule.repeat.offset, NutritionOrder.oralDiet.schedule.code, NutritionOrder.oralDiet.nutrient, NutritionOrder.oralDiet.nutrient.extension, NutritionOrder.oralDiet.nutrient.modifierExtension, NutritionOrder.oralDiet.nutrient.modifier, NutritionOrder.oralDiet.nutrient.amount, NutritionOrder.oralDiet.texture, NutritionOrder.oralDiet.texture.extension, NutritionOrder.oralDiet.texture.modifierExtension, NutritionOrder.oralDiet.texture.modifier, NutritionOrder.oralDiet.texture.foodType, NutritionOrder.oralDiet.fluidConsistencyType, NutritionOrder.oralDiet.instruction, NutritionOrder.supplement, NutritionOrder.supplement.extension, NutritionOrder.supplement.modifierExtension, NutritionOrder.supplement.type, NutritionOrder.supplement.productName, NutritionOrder.supplement.schedule, NutritionOrder.supplement.schedule.extension, NutritionOrder.supplement.schedule.extension:schedule, NutritionOrder.supplement.schedule.modifierExtension, NutritionOrder.supplement.schedule.event, NutritionOrder.supplement.schedule.repeat, NutritionOrder.supplement.schedule.repeat.extension, NutritionOrder.supplement.schedule.repeat.bounds[x], NutritionOrder.supplement.schedule.repeat.count, NutritionOrder.supplement.schedule.repeat.countMax, NutritionOrder.supplement.schedule.repeat.duration, NutritionOrder.supplement.schedule.repeat.durationMax, NutritionOrder.supplement.schedule.repeat.durationUnit, NutritionOrder.supplement.schedule.repeat.frequency, NutritionOrder.supplement.schedule.repeat.frequencyMax, NutritionOrder.supplement.schedule.repeat.period, NutritionOrder.supplement.schedule.repeat.periodMax, NutritionOrder.supplement.schedule.repeat.periodUnit, NutritionOrder.supplement.schedule.repeat.dayOfWeek, NutritionOrder.supplement.schedule.repeat.timeOfDay, NutritionOrder.supplement.schedule.repeat.when, NutritionOrder.supplement.schedule.repeat.offset, NutritionOrder.supplement.schedule.code, NutritionOrder.supplement.quantity, NutritionOrder.supplement.instruction, NutritionOrder.enteralFormula, NutritionOrder.enteralFormula.extension, NutritionOrder.enteralFormula.modifierExtension, NutritionOrder.enteralFormula.baseFormulaType, NutritionOrder.enteralFormula.baseFormulaProductName, NutritionOrder.enteralFormula.additiveType, NutritionOrder.enteralFormula.additiveProductName, NutritionOrder.enteralFormula.caloricDensity, NutritionOrder.enteralFormula.routeofAdministration, NutritionOrder.enteralFormula.administration, NutritionOrder.enteralFormula.administration.extension, NutritionOrder.enteralFormula.administration.modifierExtension, NutritionOrder.enteralFormula.administration.schedule, NutritionOrder.enteralFormula.administration.schedule.extension, NutritionOrder.enteralFormula.administration.schedule.extension:schedule, NutritionOrder.enteralFormula.administration.schedule.modifierExtension, NutritionOrder.enteralFormula.administration.schedule.event, NutritionOrder.enteralFormula.administration.schedule.repeat, NutritionOrder.enteralFormula.administration.schedule.repeat.extension, NutritionOrder.enteralFormula.administration.schedule.repeat.bounds[x], NutritionOrder.enteralFormula.administration.schedule.repeat.count, NutritionOrder.enteralFormula.administration.schedule.repeat.countMax, NutritionOrder.enteralFormula.administration.schedule.repeat.duration, NutritionOrder.enteralFormula.administration.schedule.repeat.durationMax, NutritionOrder.enteralFormula.administration.schedule.repeat.durationUnit, NutritionOrder.enteralFormula.administration.schedule.repeat.frequency, NutritionOrder.enteralFormula.administration.schedule.repeat.frequencyMax, NutritionOrder.enteralFormula.administration.schedule.repeat.period, NutritionOrder.enteralFormula.administration.schedule.repeat.periodMax, NutritionOrder.enteralFormula.administration.schedule.repeat.periodUnit, NutritionOrder.enteralFormula.administration.schedule.repeat.dayOfWeek, NutritionOrder.enteralFormula.administration.schedule.repeat.timeOfDay, NutritionOrder.enteralFormula.administration.schedule.repeat.when, NutritionOrder.enteralFormula.administration.schedule.repeat.offset, NutritionOrder.enteralFormula.administration.schedule.code, NutritionOrder.enteralFormula.administration.quantity, NutritionOrder.enteralFormula.administration.rate[x], NutritionOrder.enteralFormula.maxVolumeToDeliver, NutritionOrder.enteralFormula.administrationInstruction, NutritionOrder.note All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error NutritionOrder.meta.extension, NutritionOrder.meta.extension:meta, NutritionOrder.text.extension, NutritionOrder.text.extension:text, NutritionOrder.extension, NutritionOrder.modifierExtension, NutritionOrder.identifier.extension, NutritionOrder.identifier.extension:identifier, NutritionOrder.status.extension, NutritionOrder.status.extension:status, NutritionOrder.patient.extension, NutritionOrder.patient.extension:patient, NutritionOrder.encounter.extension, NutritionOrder.encounter.extension:encounter, NutritionOrder.orderer.extension, NutritionOrder.orderer.extension:orderer, NutritionOrder.allergyIntolerance.extension, NutritionOrder.allergyIntolerance.extension:allergyIntolerance, NutritionOrder.oralDiet.extension, NutritionOrder.oralDiet.modifierExtension, NutritionOrder.oralDiet.schedule.extension, NutritionOrder.oralDiet.schedule.extension:schedule, NutritionOrder.oralDiet.schedule.modifierExtension, NutritionOrder.oralDiet.schedule.repeat.extension, NutritionOrder.oralDiet.nutrient.extension, NutritionOrder.oralDiet.nutrient.modifierExtension, NutritionOrder.oralDiet.texture.extension, NutritionOrder.oralDiet.texture.modifierExtension, NutritionOrder.supplement.extension, NutritionOrder.supplement.modifierExtension, NutritionOrder.supplement.schedule.extension, NutritionOrder.supplement.schedule.extension:schedule, NutritionOrder.supplement.schedule.modifierExtension, NutritionOrder.supplement.schedule.repeat.extension, NutritionOrder.enteralFormula.extension, NutritionOrder.enteralFormula.modifierExtension, NutritionOrder.enteralFormula.administration.extension, NutritionOrder.enteralFormula.administration.modifierExtension, NutritionOrder.enteralFormula.administration.schedule.extension, NutritionOrder.enteralFormula.administration.schedule.extension:schedule, NutritionOrder.enteralFormula.administration.schedule.modifierExtension, NutritionOrder.enteralFormula.administration.schedule.repeat.extension 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()
tim-1 error NutritionOrder.oralDiet.schedule.repeat, NutritionOrder.supplement.schedule.repeat, NutritionOrder.enteralFormula.administration.schedule.repeat if there's a duration, there needs to be duration units duration.empty() or durationUnit.exists()
tim-2 error NutritionOrder.oralDiet.schedule.repeat, NutritionOrder.supplement.schedule.repeat, NutritionOrder.enteralFormula.administration.schedule.repeat if there's a period, there needs to be period units period.empty() or periodUnit.exists()
tim-4 error NutritionOrder.oralDiet.schedule.repeat, NutritionOrder.supplement.schedule.repeat, NutritionOrder.enteralFormula.administration.schedule.repeat duration SHALL be a non-negative value duration.exists() implies duration >= 0
tim-5 error NutritionOrder.oralDiet.schedule.repeat, NutritionOrder.supplement.schedule.repeat, NutritionOrder.enteralFormula.administration.schedule.repeat period SHALL be a non-negative value period.exists() implies period >= 0
tim-6 error NutritionOrder.oralDiet.schedule.repeat, NutritionOrder.supplement.schedule.repeat, NutritionOrder.enteralFormula.administration.schedule.repeat If there's a periodMax, there must be a period periodMax.empty() or period.exists()
tim-7 error NutritionOrder.oralDiet.schedule.repeat, NutritionOrder.supplement.schedule.repeat, NutritionOrder.enteralFormula.administration.schedule.repeat If there's a durationMax, there must be a duration durationMax.empty() or duration.exists()
tim-8 error NutritionOrder.oralDiet.schedule.repeat, NutritionOrder.supplement.schedule.repeat, NutritionOrder.enteralFormula.administration.schedule.repeat If there's a countMax, there must be a count countMax.empty() or count.exists()
tim-9 error NutritionOrder.oralDiet.schedule.repeat, NutritionOrder.supplement.schedule.repeat, NutritionOrder.enteralFormula.administration.schedule.repeat If there's an offset, there must be a when (and not C, CM, CD, CV) offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
tim-10 error NutritionOrder.oralDiet.schedule.repeat, NutritionOrder.supplement.schedule.repeat, NutritionOrder.enteralFormula.administration.schedule.repeat If there's a timeOfDay, there cannot be a when, or vice versa timeOfDay.empty() or when.empty()
txt-1 error NutritionOrder.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error NutritionOrder.text.div The narrative SHALL have some non-whitespace content htmlChecks()

 

Other representations of profile: CSV, Excel, Schematron