Release 5 Ballot
WorkflowThis page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
| Orders and Observations Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Encounter, Patient, Practitioner, RelatedPerson |
This is a representation of the json schema for NutritionIntake, 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/NutritionIntake",
"$ref": "#/definitions/NutritionIntake",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"NutritionIntake": {
"description": "A record of food or fluid that is being consumed by a patient. A NutritionIntake may indicate that the patient may be consuming the food or fluid now or has consumed the food or fluid in the past. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay or through an app that tracks food or fluids consumed. The consumption information may come from sources such as the patient\u0027s memory, from a nutrition label, or from a clinician documenting observed intake.",
"properties": {
"resourceType": {
"description": "This is a NutritionIntake resource",
"const": "NutritionIntake"
},
"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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
"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 and/or the understanding of the containing element\u0027s descendants. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "Identifiers associated with this Nutrition Intake that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": "array"
},
"instantiatesCanonical": {
"description": "Instantiates FHIR protocol or definition.",
"items": {
"$ref": "canonical.schema.json#/definitions/canonical"
},
"type": "array"
},
"instantiatesUri": {
"description": "Instantiates external protocol or definition.",
"items": {
"$ref": "#/definitions/uri"
},
"type": "array"
},
"_instantiatesUri": {
"description": "Extensions for instantiatesUri",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"basedOn": {
"description": "A plan, proposal or order that is fulfilled in whole or in part by this event.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"partOf": {
"description": "A larger event of which this particular event is a component or step.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"status": {
"description": "A code representing the patient or other source\u0027s judgment about the state of the intake that this assertion is about. Generally, this will be active or completed.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"statusReason": {
"description": "Captures the reason for the current state of the NutritionIntake.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"code": {
"description": "Overall type of nutrition intake.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"subject": {
"description": "The person, animal or group who is/was consuming the food or fluid.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"encounter": {
"description": "The encounter that establishes the context for this NutritionIntake.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"occurrenceDateTime": {
"description": "The interval of time during which it is being asserted that the patient is/was consuming the food or fluid.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?$",
"type": "string"
},
"_occurrenceDateTime": {
"description": "Extensions for occurrenceDateTime",
"$ref": "Element.schema.json#/definitions/Element"
},
"occurrencePeriod": {
"description": "The interval of time during which it is being asserted that the patient is/was consuming the food or fluid.",
"$ref": "Period.schema.json#/definitions/Period"
},
"recorded": {
"description": "The date when the Nutrition Intake was asserted by the information source.",
"$ref": "#/definitions/dateTime"
},
"_recorded": {
"description": "Extensions for recorded",
"$ref": "Element.schema.json#/definitions/Element"
},
"reportedBoolean": {
"description": "The person or organization that provided the information about the consumption of this food or fluid. Note: Use derivedFrom when a NutritionIntake is derived from other resources.",
"pattern": "^true|false$",
"type": "boolean"
},
"_reportedBoolean": {
"description": "Extensions for reportedBoolean",
"$ref": "Element.schema.json#/definitions/Element"
},
"reportedReference": {
"description": "The person or organization that provided the information about the consumption of this food or fluid. Note: Use derivedFrom when a NutritionIntake is derived from other resources.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"consumedItem": {
"description": "What food or fluid product or item was consumed.",
"items": {
"$ref": "#/definitions/NutritionIntake_ConsumedItem"
},
"type": "array"
},
"ingredientLabel": {
"description": "Total nutrient amounts for the whole meal, product, serving, etc.",
"items": {
"$ref": "#/definitions/NutritionIntake_IngredientLabel"
},
"type": "array"
},
"performer": {
"description": "Who performed the intake and how they were involved.",
"items": {
"$ref": "#/definitions/NutritionIntake_Performer"
},
"type": "array"
},
"location": {
"description": "Where the intake occurred.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"derivedFrom": {
"description": "Allows linking the NutritionIntake to the underlying NutritionOrder, or to other information, such as AllergyIntolerance, that supports or is used to derive the NutritionIntake.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"reason": {
"description": "A reason, Condition or observation for why the food or fluid is /was consumed.",
"items": {
"$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
},
"type": "array"
},
"note": {
"description": "Provides extra information about the Nutrition Intake that is not conveyed by the other attributes.",
"items": {
"$ref": "Annotation.schema.json#/definitions/Annotation"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"subject",
"consumedItem",
"resourceType"
]
},
"NutritionIntake_ConsumedItem": {
"description": "A record of food or fluid that is being consumed by a patient. A NutritionIntake may indicate that the patient may be consuming the food or fluid now or has consumed the food or fluid in the past. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay or through an app that tracks food or fluids consumed. The consumption information may come from sources such as the patient\u0027s memory, from a nutrition label, or from a clinician documenting observed intake.",
"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 and/or the understanding of the containing element\u0027s descendants. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "Indicates what a category of item that was consumed: eg., food, fluid, enteral, etc.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"nutritionProduct": {
"description": "Identifies the food or fluid product that was consumed. This is potentially a link to a resource representing the details of the food product (TBD) or a simple attribute carrying a code that identifies the food from a known list of foods.",
"$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
},
"schedule": {
"description": "Scheduled frequency of consumption.",
"$ref": "Timing.schema.json#/definitions/Timing"
},
"amount": {
"description": "Quantity of the specified food.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"rate": {
"description": "Rate at which enteral feeding was administered.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"notConsumed": {
"description": "Indicator when a patient is in a setting where it is helpful to know if food was not consumed, such as it was refused, held (as in tube feedings), or otherwise not provided. If a consumption is being recorded from an app, such as MyFitnessPal, this indicator will likely not be used.",
"$ref": "#/definitions/boolean"
},
"_notConsumed": {
"description": "Extensions for notConsumed",
"$ref": "Element.schema.json#/definitions/Element"
},
"notConsumedReason": {
"description": "Document the reason the food or fluid was not consumed, such as refused, held, etc.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"nutritionProduct",
"type"
]
},
"NutritionIntake_IngredientLabel": {
"description": "A record of food or fluid that is being consumed by a patient. A NutritionIntake may indicate that the patient may be consuming the food or fluid now or has consumed the food or fluid in the past. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay or through an app that tracks food or fluids consumed. The consumption information may come from sources such as the patient\u0027s memory, from a nutrition label, or from a clinician documenting observed intake.",
"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 and/or the understanding of the containing element\u0027s descendants. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"nutrient": {
"description": "Total nutrient consumed. This could be a macronutrient (protein, fat, carbohydrate), or a vitamin and mineral.",
"$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
},
"amount": {
"description": "Total amount of nutrient consumed.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"nutrient"
]
},
"NutritionIntake_Performer": {
"description": "A record of food or fluid that is being consumed by a patient. A NutritionIntake may indicate that the patient may be consuming the food or fluid now or has consumed the food or fluid in the past. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay or through an app that tracks food or fluids consumed. The consumption information may come from sources such as the patient\u0027s memory, from a nutrition label, or from a clinician documenting observed intake.",
"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 and/or the understanding of the containing element\u0027s descendants. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"function": {
"description": "Type of performer.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"actor": {
"description": "Who performed the intake.",
"$ref": "Reference.schema.json#/definitions/Reference"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"actor"
]
}
}
}
FHIR ®© HL7.org 2011+. FHIR R5 Ballot hl7.fhir.core#5.0.0-ballot generated on Sat, Sep 10, 2022 05:05+1000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4B |
Compare to R5 Draft |
|
Propose a change