R4 Ballot #1 (Mixed Normative/Trial use)
WorkflowThis page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4
| Orders and Observations Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Encounter, Patient, Practitioner |
This is a representation of the json schema for NutritionOrder, which is just a part of the full JSON Schema.
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "http://hl7.org/fhir/json-schema/NutritionOrder",
"$ref": "#/definitions/NutritionOrder",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"NutritionOrder": {
"description": "A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.",
"properties": {
"resourceType": {
"description": "This is a NutritionOrder resource",
"const": "NutritionOrder"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "id.schema.json#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "Meta.schema.json#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "Element.schema.json#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "Element.schema.json#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "Narrative.schema.json#/definitions/Narrative"
},
"contained": {
"description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"items": {
"$ref": "ResourceList.schema.json#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "Identifiers assigned to this order by the order sender or by the order receiver.",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": "array"
},
"instantiates": {
"description": "The URL pointing to a protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.",
"items": {
"$ref": "#/definitions/uri"
},
"type": "array"
},
"_instantiates": {
"description": "Extensions for instantiates",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"status": {
"description": "The workflow status of the nutrition order/request.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"intent": {
"description": "Indicates the level of authority/intentionality associated with the NutrionOrder and where the request fits into the workflow chain.",
"$ref": "#/definitions/code"
},
"_intent": {
"description": "Extensions for intent",
"$ref": "Element.schema.json#/definitions/Element"
},
"patient": {
"description": "The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"context": {
"description": "An encounter that provides additional information about the healthcare context in which this request is made.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"dateTime": {
"description": "The date and time that this nutrition order was requested.",
"$ref": "#/definitions/dateTime"
},
"_dateTime": {
"description": "Extensions for dateTime",
"$ref": "Element.schema.json#/definitions/Element"
},
"orderer": {
"description": "The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"allergyIntolerance": {
"description": "A link to a record of allergies or intolerances which should be included in the nutrition order.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"foodPreferenceModifier": {
"description": "This modifier is used to convey order-specific modifiers about the type of food that should be given. These can be derived from patient allergies, intolerances, or preferences such as Halal, Vegan or Kosher. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"excludeFoodModifier": {
"description": "This modifier is used to convey Order-specific modifier about the type of oral food or oral fluids that should not be given. These can be derived from patient allergies, intolerances, or preferences such as No Red Meat, No Soy or No Wheat or Gluten-Free. While it should not be necessary to repeat allergy or intolerance information captured in the referenced AllergyIntolerance resource in the excludeFoodModifier, this element may be used to convey additional specificity related to foods that should be eliminated from the patient’s diet for any reason. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"oralDiet": {
"description": "Diet given orally in contrast to enteral (tube) feeding.",
"$ref": "#/definitions/NutritionOrder_OralDiet"
},
"supplement": {
"description": "Oral nutritional products given in order to add further nutritional value to the patient\u0027s diet.",
"items": {
"$ref": "#/definitions/NutritionOrder_Supplement"
},
"type": "array"
},
"enteralFormula": {
"description": "Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.",
"$ref": "#/definitions/NutritionOrder_EnteralFormula"
},
"note": {
"description": "Comments made about the {{title}} by the requester, performer, subject or other participants.",
"items": {
"$ref": "Annotation.schema.json#/definitions/Annotation"
},
"type": "array"
}
},
"additionalProperties": false,
"required": [
"patient",
"resourceType"
]
},
"NutritionOrder_OralDiet": {
"description": "A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "The kind of diet or dietary restriction such as fiber restricted diet or diabetic diet.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"schedule": {
"description": "The time period and frequency at which the diet should be given. The diet should be given for the combination of all schedules if more than one schedule is present.",
"items": {
"$ref": "Timing.schema.json#/definitions/Timing"
},
"type": "array"
},
"nutrient": {
"description": "Class that defines the quantity and type of nutrient modifications (for example carbohydrate, fiber or sodium) required for the oral diet.",
"items": {
"$ref": "#/definitions/NutritionOrder_Nutrient"
},
"type": "array"
},
"texture": {
"description": "Class that describes any texture modifications required for the patient to safely consume various types of solid foods.",
"items": {
"$ref": "#/definitions/NutritionOrder_Texture"
},
"type": "array"
},
"fluidConsistencyType": {
"description": "The required consistency (e.g. honey-thick, nectar-thick, thin, thickened.) of liquids or fluids served to the patient.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"instruction": {
"description": "Free text or additional instructions or information pertaining to the oral diet.",
"$ref": "#/definitions/string"
},
"_instruction": {
"description": "Extensions for instruction",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"additionalProperties": false
},
"NutritionOrder_Nutrient": {
"description": "A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifier": {
"description": "The nutrient that is being modified such as carbohydrate or sodium.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"amount": {
"description": "The quantity of the specified nutrient to include in diet.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
}
},
"additionalProperties": false
},
"NutritionOrder_Texture": {
"description": "A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifier": {
"description": "Any texture modifications (for solid foods) that should be made, e.g. easy to chew, chopped, ground, and pureed.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"foodType": {
"description": "The food type(s) (e.g. meats, all foods) that the texture modification applies to. This could be all foods types.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
}
},
"additionalProperties": false
},
"NutritionOrder_Supplement": {
"description": "A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "The kind of nutritional supplement product required such as a high protein or pediatric clear liquid supplement.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"productName": {
"description": "The product or brand name of the nutritional supplement such as \"Acme Protein Shake\".",
"$ref": "#/definitions/string"
},
"_productName": {
"description": "Extensions for productName",
"$ref": "Element.schema.json#/definitions/Element"
},
"schedule": {
"description": "The time period and frequency at which the supplement(s) should be given. The supplement should be given for the combination of all schedules if more than one schedule is present.",
"items": {
"$ref": "Timing.schema.json#/definitions/Timing"
},
"type": "array"
},
"quantity": {
"description": "The amount of the nutritional supplement to be given.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"instruction": {
"description": "Free text or additional instructions or information pertaining to the oral supplement.",
"$ref": "#/definitions/string"
},
"_instruction": {
"description": "Extensions for instruction",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"additionalProperties": false
},
"NutritionOrder_EnteralFormula": {
"description": "A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"baseFormulaType": {
"description": "The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"baseFormulaProductName": {
"description": "The product or brand name of the enteral or infant formula product such as \"ACME Adult Standard Formula\".",
"$ref": "#/definitions/string"
},
"_baseFormulaProductName": {
"description": "Extensions for baseFormulaProductName",
"$ref": "Element.schema.json#/definitions/Element"
},
"additiveType": {
"description": "Indicates the type of modular component such as protein, carbohydrate, fat or fiber to be provided in addition to or mixed with the base formula.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"additiveProductName": {
"description": "The product or brand name of the type of modular component to be added to the formula.",
"$ref": "#/definitions/string"
},
"_additiveProductName": {
"description": "Extensions for additiveProductName",
"$ref": "Element.schema.json#/definitions/Element"
},
"caloricDensity": {
"description": "The amount of energy (calories) that the formula should provide per specified volume, typically per mL or fluid oz. For example, an infant may require a formula that provides 24 calories per fluid ounce or an adult may require an enteral formula that provides 1.5 calorie/mL.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"routeofAdministration": {
"description": "The route or physiological path of administration into the patient\u0027s gastrointestinal tract for purposes of providing the formula feeding, e.g. nasogastric tube.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"administration": {
"description": "Formula administration instructions as structured data. This repeating structure allows for changing the administration rate or volume over time for both bolus and continuous feeding. An example of this would be an instruction to increase the rate of continuous feeding every 2 hours.",
"items": {
"$ref": "#/definitions/NutritionOrder_Administration"
},
"type": "array"
},
"maxVolumeToDeliver": {
"description": "The maximum total quantity of formula that may be administered to a subject over the period of time, e.g. 1440 mL over 24 hours.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"administrationInstruction": {
"description": "Free text formula administration, feeding instructions or additional instructions or information.",
"$ref": "#/definitions/string"
},
"_administrationInstruction": {
"description": "Extensions for administrationInstruction",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"additionalProperties": false
},
"NutritionOrder_Administration": {
"description": "A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"schedule": {
"description": "The time period and frequency at which the enteral formula should be delivered to the patient.",
"$ref": "Timing.schema.json#/definitions/Timing"
},
"quantity": {
"description": "The volume of formula to provide to the patient per the specified administration schedule.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"rateQuantity": {
"description": "The rate of administration of formula via a feeding pump, e.g. 60 mL per hour, according to the specified schedule.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"rateRatio": {
"description": "The rate of administration of formula via a feeding pump, e.g. 60 mL per hour, according to the specified schedule.",
"$ref": "Ratio.schema.json#/definitions/Ratio"
}
},
"additionalProperties": false
}
}
}
®© HL7.org 2011+. FHIR Mixed Nomative/Trial Use Ballot (v3.3.0-13671) generated on Tue, Apr 3, 2018 12:16+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change