NutritionOrder - FHIR Resource (r4)
This NutritionOrder Resource uses the FHIR API standard for access and structure.
Validate an NutritionOrder FHIR Resource (r4)
NutritionOrder Attributes
AttributeField is listTypeDescription
Description: Identifiers assigned to this order
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": [
{
"system": "http://goodhealthhospital.org/nutrition-requests",
"value": "123"
}
]Learn more about the (NutritionOrder) identifier FHIR attribute
Description: Instantiates FHIR protocol or definition
FHIR Version: r4
Attribute Type : canonical(ActivityDefinition | PlanDefinition)
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"instantiatesCanonical": Learn more about the (NutritionOrder) instantiatesCanonical FHIR attribute
Description: Instantiates external protocol or definition
FHIR Version: r4
Attribute Type : uri
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"instantiatesUri": Learn more about the (NutritionOrder) instantiatesUri FHIR attribute
Description: Instantiates protocol or definition
FHIR Version: r4
Attribute Type : uri
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"instantiates": Learn more about the (NutritionOrder) instantiates FHIR attribute
Description: draft | active | on-hold | revoked | completed | entered-in-error | unknown
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "active"Learn more about the (NutritionOrder) status FHIR attribute
Description: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"intent": "order"Learn more about the (NutritionOrder) intent FHIR attribute
Description: The person who requires the diet, formula or nutritional supplement
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"patient": {
"reference": "Patient/example",
"display": "Peter Chalmers"
}Learn more about the (NutritionOrder) patient FHIR attribute
Description: The encounter associated with this nutrition order
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"encounter": Learn more about the (NutritionOrder) encounter FHIR attribute
Description: Date and time the nutrition order was requested
FHIR Version: r4
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"dateTime": "2014-09-17"Learn more about the (NutritionOrder) dateTime FHIR attribute
Description: Who ordered the diet, formula or nutritional supplement
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"orderer": {
"reference": "Practitioner/example",
"display": "Dr Adam Careful"
}Learn more about the (NutritionOrder) orderer FHIR attribute
Description: List of the patient's food and nutrition-related allergies and intolerances
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"allergyIntolerance": Learn more about the (NutritionOrder) allergyIntolerance FHIR attribute
Description: Order-specific modifier about the type of food that should be given
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"foodPreferenceModifier": Learn more about the (NutritionOrder) foodPreferenceModifier FHIR attribute
Description: Order-specific modifier about the type of food that should not be given
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"excludeFoodModifier": Learn more about the (NutritionOrder) excludeFoodModifier FHIR attribute
Description: C? Oral diet components
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"oralDiet": {
"type": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "226211001",
"display": "Pureed diet"
},
{
"system": "http://goodhealthhospital.org/diet-type-codes",
"code": "1010",
"display": "Pureed diet"
}
],
"text": "Pureed diet"
}
],
"schedule": [
{
"repeat": {
"boundsPeriod": {
"start": "2015-02-10"
},
"frequency": 3,
"period": 1,
"periodUnit": "d"
}
}
],
"texture": [
{
"modifier": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "228055009",
"display": "Liquidized food"
}
],
"text": "Pureed"
}
}
],
"fluidConsistencyType": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "439021000124105",
"display": "Dietary liquid consistency - nectar thick liquid"
}
],
"text": "Nectar thick liquids"
}
]
}Learn more about the (NutritionOrder) oralDiet FHIR attribute
Description: C? Supplement components
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"supplement": [
{
"type": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "442971000124100",
"display": "Adult high energy formula"
},
{
"system": "http://goodhealthhospital.org/supplement-type-codes",
"code": "1040",
"display": "Adult high energy pudding"
}
],
"text": "Adult high energy pudding"
},
"productName": "Ensure Pudding 4 oz container",
"instruction": "Ensure Pudding at breakfast, lunch, supper"
}
]Learn more about the (NutritionOrder) supplement FHIR attribute
Description: C? Enteral formula components
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"enteralFormula": Learn more about the (NutritionOrder) enteralFormula FHIR attribute
Description: Comments
FHIR Version: r4
Attribute Type : Annotation
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"note": Learn more about the (NutritionOrder) note FHIR attribute
NutritionOrder Example
{
"resourceType": "NutritionOrder",
"id": "pureeddiet-simple",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: pureeddiet-simple</p><p><b>identifier</b>: 123</p><p><b>status</b>: active</p><p><b>intent</b>: order</p><p><b>patient</b>: <a>Peter Chalmers</a></p><p><b>dateTime</b>: 17/09/2014</p><p><b>orderer</b>: <a>Dr Adam Careful</a></p><blockquote><p><b>oralDiet</b></p><p><b>type</b>: Pureed diet <span>(Details : {SNOMED CT code '226211001' = 'Pureed diet', given as 'Pureed diet'}; {http://goodhealthhospital.org/diet-type-codes code '1010' = '1010', given as 'Pureed diet'})</span></p><p><b>schedule</b>: Starting 10/02/2015, Do 3 per 1 days</p><h3>Textures</h3><table><tr><td>-</td><td><b>Modifier</b></td></tr><tr><td>*</td><td>Pureed <span>(Details : {SNOMED CT code '228055009' = 'Liquidized food', given as 'Liquidized food'})</span></td></tr></table><p><b>fluidConsistencyType</b>: Nectar thick liquids <span>(Details : {SNOMED CT code '439021000124105' = 'Dietary liquid consistency - nectar thick liquid (regime/therapy)', given as 'Dietary liquid consistency - nectar thick liquid'})</span></p></blockquote><h3>Supplements</h3><table><tr><td>-</td><td><b>Type</b></td><td><b>ProductName</b></td><td><b>Instruction</b></td></tr><tr><td>*</td><td>Adult high energy pudding <span>(Details : {SNOMED CT code '442971000124100' = 'Adult high energy formula (product)', given as 'Adult high energy formula'}; {http://goodhealthhospital.org/supplement-type-codes code '1040' = '1040', given as 'Adult high energy pudding'})</span></td><td>Ensure Pudding 4 oz container</td><td>Ensure Pudding at breakfast, lunch, supper</td></tr></table></div>"
},
"identifier": [
{
"system": "http://goodhealthhospital.org/nutrition-requests",
"value": "123"
}
],
"status": "active",
"intent": "order",
"patient": {
"reference": "Patient/example",
"display": "Peter Chalmers"
},
"dateTime": "2014-09-17",
"orderer": {
"reference": "Practitioner/example",
"display": "Dr Adam Careful"
},
"oralDiet": {
"type": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "226211001",
"display": "Pureed diet"
},
{
"system": "http://goodhealthhospital.org/diet-type-codes",
"code": "1010",
"display": "Pureed diet"
}
],
"text": "Pureed diet"
}
],
"schedule": [
{
"repeat": {
"boundsPeriod": {
"start": "2015-02-10"
},
"frequency": 3,
"period": 1,
"periodUnit": "d"
}
}
],
"texture": [
{
"modifier": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "228055009",
"display": "Liquidized food"
}
],
"text": "Pureed"
}
}
],
"fluidConsistencyType": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "439021000124105",
"display": "Dietary liquid consistency - nectar thick liquid"
}
],
"text": "Nectar thick liquids"
}
]
},
"supplement": [
{
"type": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "442971000124100",
"display": "Adult high energy formula"
},
{
"system": "http://goodhealthhospital.org/supplement-type-codes",
"code": "1040",
"display": "Adult high energy pudding"
}
],
"text": "Adult high energy pudding"
},
"productName": "Ensure Pudding 4 oz container",
"instruction": "Ensure Pudding at breakfast, lunch, supper"
}
]
}NutritionOrder Structure
{
"resourceType" : "NutritionOrder",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Identifiers assigned to this order
"instantiatesCanonical" : [{ canonical(ActivityDefinition|PlanDefinition) }], // Instantiates FHIR protocol or definition
"instantiatesUri" : ["<uri>"], // Instantiates external protocol or definition
"instantiates" : ["<uri>"], // Instantiates protocol or definition
"status" : "<code>", // R! draft | active | on-hold | revoked | completed | entered-in-error | unknown
"intent" : "<code>", // R! proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
"patient" : { Reference(Patient) }, // R! The person who requires the diet, formula or nutritional supplement
"encounter" : { Reference(Encounter) }, // The encounter associated with this nutrition order
"dateTime" : "<dateTime>", // R! Date and time the nutrition order was requested
"orderer" : { Reference(Practitioner|PractitionerRole) }, // Who ordered the diet, formula or nutritional supplement
"allergyIntolerance" : [{ Reference(AllergyIntolerance) }], // List of the patient's food and nutrition-related allergies and intolerances
"foodPreferenceModifier" : [{ CodeableConcept }], // Order-specific modifier about the type of food that should be given
"excludeFoodModifier" : [{ CodeableConcept }], // Order-specific modifier about the type of food that should not be given
"oralDiet" : { // C? Oral diet components
"type" : [{ CodeableConcept }], // Type of oral diet or diet restrictions that describe what can be consumed orally
"schedule" : [{ Timing }], // Scheduled frequency of diet
"nutrient" : [{ // Required nutrient modifications
"modifier" : { CodeableConcept }, // Type of nutrient that is being modified
"amount" : { Quantity(SimpleQuantity) } // Quantity of the specified nutrient
}],
"texture" : [{ // Required texture modifications
"modifier" : { CodeableConcept }, // Code to indicate how to alter the texture of the foods, e.g. pureed
"foodType" : { CodeableConcept } // Concepts that are used to identify an entity that is ingested for nutritional purposes
}],
"fluidConsistencyType" : [{ CodeableConcept }], // The required consistency of fluids and liquids provided to the patient
"instruction" : "<string>" // Instructions or additional information about the oral diet
},
"supplement" : [{ // C? Supplement components
"type" : { CodeableConcept }, // Type of supplement product requested
"productName" : "<string>", // Product or brand name of the nutritional supplement
"schedule" : [{ Timing }], // Scheduled frequency of supplement
"quantity" : { Quantity(SimpleQuantity) }, // Amount of the nutritional supplement
"instruction" : "<string>" // Instructions or additional information about the oral supplement
}],
"enteralFormula" : { // C? Enteral formula components
"baseFormulaType" : { CodeableConcept }, // Type of enteral or infant formula
"baseFormulaProductName" : "<string>", // Product or brand name of the enteral or infant formula
"additiveType" : { CodeableConcept }, // Type of modular component to add to the feeding
"additiveProductName" : "<string>", // Product or brand name of the modular additive
"caloricDensity" : { Quantity(SimpleQuantity) }, // Amount of energy per specified volume that is required
"routeofAdministration" : { CodeableConcept }, // How the formula should enter the patient's gastrointestinal tract
"administration" : [{ // Formula feeding instruction as structured data
"schedule" : { Timing }, // Scheduled frequency of enteral feeding
"quantity" : { Quantity(SimpleQuantity) }, // The volume of formula to provide
// rate[x]: Speed with which the formula is provided per period of time. One of these 2:
"rateQuantity" : { Quantity(SimpleQuantity) }
"rateRatio" : { Ratio }
}],
"maxVolumeToDeliver" : { Quantity(SimpleQuantity) }, // Upper limit on formula volume per unit of time
"administrationInstruction" : "<string>" // Formula feeding instructions expressed as text
},
"note" : [{ Annotation }] // Comments
}
NutritionOrder Search Parameters
The following search parameters can be used to query NutritionOrder resources. Just submit them like so:
https://api.1up.health/fhir/r4/NutritionOrder?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
additive | text | enteralFormula.additiveType |
datetime | date | dateTime |
encounter | reference | encounter |
formula | text | enteralFormula.baseFormulaType |
identifier | text | identifier |
instantiates-canonical | reference | instantiatesCanonical |
instantiates-uri | uri | instantiatesUri |
oraldiet | text | oralDiet.type |
patient | reference | patient |
provider | reference | orderer |
status | text | status |
supplement | text | supplement.type |
