This page is part of the FHIR Specification (v4.4.0: R5 Preview #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
Orders and Observations Work Group | Maturity Level: 0 | Trial Use | Security Category: Patient | Compartments: Encounter, Patient, Practitioner, RelatedPerson |
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's memory, from a nutrition label, or from a clinician documenting observed intake.
This resource is an event resource from a FHIR workflow perspective - see Workflow. It is the intent of the Orders and Observation Workgroup to align this resource with the workflow pattern for event resources.
The Nutrition Intake resource in conjunction with the Nutrition Product resource will be utilized to capture details about the consumption of foods, fluids, and enteral nutrition. In addition to these uses, it can also be used to capture the event of food being delivered to a patient in an inpatient setting so that a second event can record the actual consumption; thus, a dietitian and other clinicians can use the data to calculate how much nutrition a patient has taken in. Nutrition Intake represents the event of consuming food, fluid, etc. and Nutrition Product represents the actual food items.
Nutrition Intake can also be used to record a person’s intake through uses of food tracking apps (e.g.MyFitnessPal), SNAP or any grocery store purchases, or a student’s meal purchases and consumption in a school district. Because recipes are a combination of nutrition products and Nutrition Intake represents that combination, Nutrition Intake can also be used to share menus across facilities (hospitals, long term care, etc.). On a larger scale, the data from the Nutrition Intake resource could be used for public health/research needs, similar to NHANES.
Nutrition Intake can be utilized in many environments where food is served, consumed or purchased: hospitals/acute care, meal tracking systems, school districts, grocery stores, outpatient settings, LTC, etc. Nutrition Intake should be general enough to capture intake regardless of country or region.
Parenteral nutrition is out of scope as this ordering is handled through MedicationRequest, thusadministration should also be captured through Medication Administration.
As a dietitian, it is important to be able to know what a person is consuming and assess the adequacy of the patient’s diet. Capturing a patient’s intake is important to establish a baseline, determine care, track trends, and see improvement of that patient. Dietitians might use intake data to see patterns, such as when a diabetic patient’s blood glucose is consistently high due to over consumption of carbohydrates.Other clinicians have the need to monitor intake as well; for example, a nurse might need to know intake for administering insulin prior to meals or a physician may need to ensure a patient on a fluid restriction is following orders.
Having intake documented within its own resource allows for consistency in documentation acrossmultiple disciplines and settings. In some instances, the Observation resource has been extended to capture intake; while this allows for a quick way to document intake, the Observation resource does not provide all the detail necessary, such as capturing all the nutrients ( including calories, vitamins, minerals, carbohydrates, etc.). Previous implementation attempts of using the Observation resourcehave noted this is cumbersome and has required too many extensions without being able to documentall the necessary details tied to ingredients in food and fluid products.
This resource is referenced by itself.
This resource implements the Event pattern.
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
NutritionIntake | TU | DomainResource | Record of food or fluid being taken by a patient Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
identifier | Σ | 0..* | Identifier | External identifier |
instantiatesCanonical | 0..* | canonical(Definition) | Instantiates FHIR protocol or definition | |
instantiatesUri | 0..* | uri | Instantiates external protocol or definition | |
basedOn | Σ | 0..* | Reference(NutritionOrder | CarePlan | ServiceRequest) | Fulfils plan, proposal or order |
partOf | Σ | 0..* | Reference(NutritionIntake | Procedure | Observation) | Part of referenced event |
status | ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown EventStatus (Required) |
statusReason | 0..* | CodeableConcept | Reason for current status SNOMED CT Drug Therapy Status codes (Example) | |
code | Σ | 0..1 | CodeableConcept | Type of nutrition intake setting/reporting Diet Codes (Example) |
subject | Σ | 1..1 | Reference(Patient | Group) | Who is/was consuming the food or fluid |
encounter | Σ | 0..1 | Reference(Encounter) | Encounter associated with NutritionIntake |
occurrence[x] | Σ | 0..1 | The date/time or interval when the food or fluid is/was consumed | |
occurrenceDateTime | dateTime | |||
occurrencePeriod | Period | |||
recorded | Σ | 0..1 | dateTime | When the intake was recorded |
reported[x] | 0..1 | Person or organization that provided the information about the consumption of this food or fluid | ||
reportedBoolean | boolean | |||
reportedReference | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | |||
consumedItem | 1..* | BackboneElement | What food or fluid product or item was consumed | |
type | Σ | 1..1 | CodeableConcept | The type of food or fluid product Types of edible substances (Example) |
nutritionProduct | Σ | 1..1 | CodeableReference(NutritionProduct) | Code that identifies the food or fluid product that was consumed Food Type Codes (Example) |
schedule | 0..1 | Timing | Scheduled frequency of consumption | |
amount | Σ | 0..1 | SimpleQuantity | Quantity of the specified food |
rate | Σ | 0..1 | SimpleQuantity | Rate at which enteral feeding was administered |
notConsumed | 0..1 | boolean | Flag to indicate if the food or fluid item was refused or otherwise not consumed | |
notConsumedReason | 0..1 | CodeableConcept | Reason food or fluid was not consumed Reasons for why a food item was not consumed (Example) | |
ingredientLabel | 0..* | BackboneElement | Total nutrient for the whole meal, product, serving | |
nutrient | 1..1 | CodeableReference(Substance) | Total nutrient consumed Nutrient Modifier Codes (Example) | |
amount | 1..1 | SimpleQuantity | Total amount of nutrient consumed | |
performer | 0..* | BackboneElement | Who was performed in the intake | |
function | 0..1 | CodeableConcept | Type of performer Procedure Performer Role Codes (Example) | |
actor | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Who performed the intake | |
location | 0..1 | Reference(Location) | Where the intake occurred | |
derivedFrom | 0..* | Reference(Any) | Additional supporting information | |
reason | 0..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) | Reason for why the food or fluid is /was consumed Condition/Problem/Diagnosis Codes (Example) | |
note | 0..* | Annotation | Further information about the consumption | |
Documentation for this format |
UML Diagram (Legend)
XML Template
<NutritionIntake xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier External identifier --></identifier> <instantiatesCanonical><!-- 0..* canonical(ActivityDefinition|EventDefinition| EvidenceVariable|Measure|OperationDefinition|PlanDefinition|Questionnaire| SubscriptionTopic) Instantiates FHIR protocol or definition --></instantiatesCanonical> <instantiatesUri value="[uri]"/><!-- 0..* Instantiates external protocol or definition --> <basedOn><!-- 0..* Reference(CarePlan|NutritionOrder|ServiceRequest) Fulfils plan, proposal or order --></basedOn> <partOf><!-- 0..* Reference(NutritionIntake|Observation|Procedure) Part of referenced event --></partOf> <status value="[code]"/><!-- 1..1 preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown --> <statusReason><!-- 0..* CodeableConcept Reason for current status --></statusReason> <code><!-- 0..1 CodeableConcept Type of nutrition intake setting/reporting --></code> <subject><!-- 1..1 Reference(Group|Patient) Who is/was consuming the food or fluid --></subject> <encounter><!-- 0..1 Reference(Encounter) Encounter associated with NutritionIntake --></encounter> <occurrence[x]><!-- 0..1 dateTime|Period The date/time or interval when the food or fluid is/was consumed --></occurrence[x]> <recorded value="[dateTime]"/><!-- 0..1 When the intake was recorded --> <reported[x]><!-- 0..1 boolean|Reference(Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) Person or organization that provided the information about the consumption of this food or fluid --></reported[x]> <consumedItem> <!-- 1..* What food or fluid product or item was consumed --> <type><!-- 1..1 CodeableConcept The type of food or fluid product --></type> <nutritionProduct><!-- 1..1 CodeableReference(NutritionProduct) Code that identifies the food or fluid product that was consumed --></nutritionProduct> <schedule><!-- 0..1 Timing Scheduled frequency of consumption --></schedule> <amount><!-- 0..1 Quantity(SimpleQuantity) Quantity of the specified food --></amount> <rate><!-- 0..1 Quantity(SimpleQuantity) Rate at which enteral feeding was administered --></rate> <notConsumed value="[boolean]"/><!-- 0..1 Flag to indicate if the food or fluid item was refused or otherwise not consumed --> <notConsumedReason><!-- 0..1 CodeableConcept Reason food or fluid was not consumed --></notConsumedReason> </consumedItem> <ingredientLabel> <!-- 0..* Total nutrient for the whole meal, product, serving --> <nutrient><!-- 1..1 CodeableReference(Substance) Total nutrient consumed --></nutrient> <amount><!-- 1..1 Quantity(SimpleQuantity) Total amount of nutrient consumed --></amount> </ingredientLabel> <performer> <!-- 0..* Who was performed in the intake --> <function><!-- 0..1 CodeableConcept Type of performer --></function> <actor><!-- 1..1 Reference(CareTeam|Device|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) Who performed the intake --></actor> </performer> <location><!-- 0..1 Reference(Location) Where the intake occurred --></location> <derivedFrom><!-- 0..* Reference(Any) Additional supporting information --></derivedFrom> <reason><!-- 0..* CodeableReference(Condition|DiagnosticReport|DocumentReference| Observation) Reason for why the food or fluid is /was consumed --></reason> <note><!-- 0..* Annotation Further information about the consumption --></note> </NutritionIntake>
JSON Template
{ "resourceType" : "NutritionIntake", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // External identifier "instantiatesCanonical" : [{ canonical(ActivityDefinition|EventDefinition| EvidenceVariable|Measure|OperationDefinition|PlanDefinition|Questionnaire| SubscriptionTopic) }], // Instantiates FHIR protocol or definition "instantiatesUri" : ["<uri>"], // Instantiates external protocol or definition "basedOn" : [{ Reference(CarePlan|NutritionOrder|ServiceRequest) }], // Fulfils plan, proposal or order "partOf" : [{ Reference(NutritionIntake|Observation|Procedure) }], // Part of referenced event "status" : "<code>", // R! preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown "statusReason" : [{ CodeableConcept }], // Reason for current status "code" : { CodeableConcept }, // Type of nutrition intake setting/reporting "subject" : { Reference(Group|Patient) }, // R! Who is/was consuming the food or fluid "encounter" : { Reference(Encounter) }, // Encounter associated with NutritionIntake // occurrence[x]: The date/time or interval when the food or fluid is/was consumed. One of these 2: "occurrenceDateTime" : "<dateTime>", "occurrencePeriod" : { Period }, "recorded" : "<dateTime>", // When the intake was recorded // reported[x]: Person or organization that provided the information about the consumption of this food or fluid. One of these 2: "reportedBoolean" : <boolean>, "reportedReference" : { Reference(Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) }, "consumedItem" : [{ // R! What food or fluid product or item was consumed "type" : { CodeableConcept }, // R! The type of food or fluid product "nutritionProduct" : { CodeableReference(NutritionProduct) }, // R! Code that identifies the food or fluid product that was consumed "schedule" : { Timing }, // Scheduled frequency of consumption "amount" : { Quantity(SimpleQuantity) }, // Quantity of the specified food "rate" : { Quantity(SimpleQuantity) }, // Rate at which enteral feeding was administered "notConsumed" : <boolean>, // Flag to indicate if the food or fluid item was refused or otherwise not consumed "notConsumedReason" : { CodeableConcept } // Reason food or fluid was not consumed }], "ingredientLabel" : [{ // Total nutrient for the whole meal, product, serving "nutrient" : { CodeableReference(Substance) }, // R! Total nutrient consumed "amount" : { Quantity(SimpleQuantity) } // R! Total amount of nutrient consumed }], "performer" : [{ // Who was performed in the intake "function" : { CodeableConcept }, // Type of performer "actor" : { Reference(CareTeam|Device|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) } // R! Who performed the intake }], "location" : { Reference(Location) }, // Where the intake occurred "derivedFrom" : [{ Reference(Any) }], // Additional supporting information "reason" : [{ CodeableReference(Condition|DiagnosticReport|DocumentReference| Observation) }], // Reason for why the food or fluid is /was consumed "note" : [{ Annotation }] // Further information about the consumption }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:NutritionIntake; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:NutritionIntake.identifier [ Identifier ], ... ; # 0..* External identifier fhir:NutritionIntake.instantiatesCanonical [ canonical(ActivityDefinition|EventDefinition|EvidenceVariable|Measure|OperationDefinition| PlanDefinition|Questionnaire|SubscriptionTopic) ], ... ; # 0..* Instantiates FHIR protocol or definition fhir:NutritionIntake.instantiatesUri [ uri ], ... ; # 0..* Instantiates external protocol or definition fhir:NutritionIntake.basedOn [ Reference(CarePlan|NutritionOrder|ServiceRequest) ], ... ; # 0..* Fulfils plan, proposal or order fhir:NutritionIntake.partOf [ Reference(NutritionIntake|Observation|Procedure) ], ... ; # 0..* Part of referenced event fhir:NutritionIntake.status [ code ]; # 1..1 preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown fhir:NutritionIntake.statusReason [ CodeableConcept ], ... ; # 0..* Reason for current status fhir:NutritionIntake.code [ CodeableConcept ]; # 0..1 Type of nutrition intake setting/reporting fhir:NutritionIntake.subject [ Reference(Group|Patient) ]; # 1..1 Who is/was consuming the food or fluid fhir:NutritionIntake.encounter [ Reference(Encounter) ]; # 0..1 Encounter associated with NutritionIntake # NutritionIntake.occurrence[x] : 0..1 The date/time or interval when the food or fluid is/was consumed. One of these 2 fhir:NutritionIntake.occurrenceDateTime [ dateTime ] fhir:NutritionIntake.occurrencePeriod [ Period ] fhir:NutritionIntake.recorded [ dateTime ]; # 0..1 When the intake was recorded # NutritionIntake.reported[x] : 0..1 Person or organization that provided the information about the consumption of this food or fluid. One of these 2 fhir:NutritionIntake.reportedBoolean [ boolean ] fhir:NutritionIntake.reportedReference [ Reference(Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] fhir:NutritionIntake.consumedItem [ # 1..* What food or fluid product or item was consumed fhir:NutritionIntake.consumedItem.type [ CodeableConcept ]; # 1..1 The type of food or fluid product fhir:NutritionIntake.consumedItem.nutritionProduct [ CodeableReference(NutritionProduct) ]; # 1..1 Code that identifies the food or fluid product that was consumed fhir:NutritionIntake.consumedItem.schedule [ Timing ]; # 0..1 Scheduled frequency of consumption fhir:NutritionIntake.consumedItem.amount [ Quantity(SimpleQuantity) ]; # 0..1 Quantity of the specified food fhir:NutritionIntake.consumedItem.rate [ Quantity(SimpleQuantity) ]; # 0..1 Rate at which enteral feeding was administered fhir:NutritionIntake.consumedItem.notConsumed [ boolean ]; # 0..1 Flag to indicate if the food or fluid item was refused or otherwise not consumed fhir:NutritionIntake.consumedItem.notConsumedReason [ CodeableConcept ]; # 0..1 Reason food or fluid was not consumed ], ...; fhir:NutritionIntake.ingredientLabel [ # 0..* Total nutrient for the whole meal, product, serving fhir:NutritionIntake.ingredientLabel.nutrient [ CodeableReference(Substance) ]; # 1..1 Total nutrient consumed fhir:NutritionIntake.ingredientLabel.amount [ Quantity(SimpleQuantity) ]; # 1..1 Total amount of nutrient consumed ], ...; fhir:NutritionIntake.performer [ # 0..* Who was performed in the intake fhir:NutritionIntake.performer.function [ CodeableConcept ]; # 0..1 Type of performer fhir:NutritionIntake.performer.actor [ Reference(CareTeam|Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 1..1 Who performed the intake ], ...; fhir:NutritionIntake.location [ Reference(Location) ]; # 0..1 Where the intake occurred fhir:NutritionIntake.derivedFrom [ Reference(Any) ], ... ; # 0..* Additional supporting information fhir:NutritionIntake.reason [ CodeableReference(Condition|DiagnosticReport|DocumentReference|Observation) ], ... ; # 0..* Reason for why the food or fluid is /was consumed fhir:NutritionIntake.note [ Annotation ], ... ; # 0..* Further information about the consumption ]
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
NutritionIntake | TU | DomainResource | Record of food or fluid being taken by a patient Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
identifier | Σ | 0..* | Identifier | External identifier |
instantiatesCanonical | 0..* | canonical(Definition) | Instantiates FHIR protocol or definition | |
instantiatesUri | 0..* | uri | Instantiates external protocol or definition | |
basedOn | Σ | 0..* | Reference(NutritionOrder | CarePlan | ServiceRequest) | Fulfils plan, proposal or order |
partOf | Σ | 0..* | Reference(NutritionIntake | Procedure | Observation) | Part of referenced event |
status | ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown EventStatus (Required) |
statusReason | 0..* | CodeableConcept | Reason for current status SNOMED CT Drug Therapy Status codes (Example) | |
code | Σ | 0..1 | CodeableConcept | Type of nutrition intake setting/reporting Diet Codes (Example) |
subject | Σ | 1..1 | Reference(Patient | Group) | Who is/was consuming the food or fluid |
encounter | Σ | 0..1 | Reference(Encounter) | Encounter associated with NutritionIntake |
occurrence[x] | Σ | 0..1 | The date/time or interval when the food or fluid is/was consumed | |
occurrenceDateTime | dateTime | |||
occurrencePeriod | Period | |||
recorded | Σ | 0..1 | dateTime | When the intake was recorded |
reported[x] | 0..1 | Person or organization that provided the information about the consumption of this food or fluid | ||
reportedBoolean | boolean | |||
reportedReference | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | |||
consumedItem | 1..* | BackboneElement | What food or fluid product or item was consumed | |
type | Σ | 1..1 | CodeableConcept | The type of food or fluid product Types of edible substances (Example) |
nutritionProduct | Σ | 1..1 | CodeableReference(NutritionProduct) | Code that identifies the food or fluid product that was consumed Food Type Codes (Example) |
schedule | 0..1 | Timing | Scheduled frequency of consumption | |
amount | Σ | 0..1 | SimpleQuantity | Quantity of the specified food |
rate | Σ | 0..1 | SimpleQuantity | Rate at which enteral feeding was administered |
notConsumed | 0..1 | boolean | Flag to indicate if the food or fluid item was refused or otherwise not consumed | |
notConsumedReason | 0..1 | CodeableConcept | Reason food or fluid was not consumed Reasons for why a food item was not consumed (Example) | |
ingredientLabel | 0..* | BackboneElement | Total nutrient for the whole meal, product, serving | |
nutrient | 1..1 | CodeableReference(Substance) | Total nutrient consumed Nutrient Modifier Codes (Example) | |
amount | 1..1 | SimpleQuantity | Total amount of nutrient consumed | |
performer | 0..* | BackboneElement | Who was performed in the intake | |
function | 0..1 | CodeableConcept | Type of performer Procedure Performer Role Codes (Example) | |
actor | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Who performed the intake | |
location | 0..1 | Reference(Location) | Where the intake occurred | |
derivedFrom | 0..* | Reference(Any) | Additional supporting information | |
reason | 0..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) | Reason for why the food or fluid is /was consumed Condition/Problem/Diagnosis Codes (Example) | |
note | 0..* | Annotation | Further information about the consumption | |
Documentation for this format |
XML Template
<NutritionIntake xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier External identifier --></identifier> <instantiatesCanonical><!-- 0..* canonical(ActivityDefinition|EventDefinition| EvidenceVariable|Measure|OperationDefinition|PlanDefinition|Questionnaire| SubscriptionTopic) Instantiates FHIR protocol or definition --></instantiatesCanonical> <instantiatesUri value="[uri]"/><!-- 0..* Instantiates external protocol or definition --> <basedOn><!-- 0..* Reference(CarePlan|NutritionOrder|ServiceRequest) Fulfils plan, proposal or order --></basedOn> <partOf><!-- 0..* Reference(NutritionIntake|Observation|Procedure) Part of referenced event --></partOf> <status value="[code]"/><!-- 1..1 preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown --> <statusReason><!-- 0..* CodeableConcept Reason for current status --></statusReason> <code><!-- 0..1 CodeableConcept Type of nutrition intake setting/reporting --></code> <subject><!-- 1..1 Reference(Group|Patient) Who is/was consuming the food or fluid --></subject> <encounter><!-- 0..1 Reference(Encounter) Encounter associated with NutritionIntake --></encounter> <occurrence[x]><!-- 0..1 dateTime|Period The date/time or interval when the food or fluid is/was consumed --></occurrence[x]> <recorded value="[dateTime]"/><!-- 0..1 When the intake was recorded --> <reported[x]><!-- 0..1 boolean|Reference(Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) Person or organization that provided the information about the consumption of this food or fluid --></reported[x]> <consumedItem> <!-- 1..* What food or fluid product or item was consumed --> <type><!-- 1..1 CodeableConcept The type of food or fluid product --></type> <nutritionProduct><!-- 1..1 CodeableReference(NutritionProduct) Code that identifies the food or fluid product that was consumed --></nutritionProduct> <schedule><!-- 0..1 Timing Scheduled frequency of consumption --></schedule> <amount><!-- 0..1 Quantity(SimpleQuantity) Quantity of the specified food --></amount> <rate><!-- 0..1 Quantity(SimpleQuantity) Rate at which enteral feeding was administered --></rate> <notConsumed value="[boolean]"/><!-- 0..1 Flag to indicate if the food or fluid item was refused or otherwise not consumed --> <notConsumedReason><!-- 0..1 CodeableConcept Reason food or fluid was not consumed --></notConsumedReason> </consumedItem> <ingredientLabel> <!-- 0..* Total nutrient for the whole meal, product, serving --> <nutrient><!-- 1..1 CodeableReference(Substance) Total nutrient consumed --></nutrient> <amount><!-- 1..1 Quantity(SimpleQuantity) Total amount of nutrient consumed --></amount> </ingredientLabel> <performer> <!-- 0..* Who was performed in the intake --> <function><!-- 0..1 CodeableConcept Type of performer --></function> <actor><!-- 1..1 Reference(CareTeam|Device|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) Who performed the intake --></actor> </performer> <location><!-- 0..1 Reference(Location) Where the intake occurred --></location> <derivedFrom><!-- 0..* Reference(Any) Additional supporting information --></derivedFrom> <reason><!-- 0..* CodeableReference(Condition|DiagnosticReport|DocumentReference| Observation) Reason for why the food or fluid is /was consumed --></reason> <note><!-- 0..* Annotation Further information about the consumption --></note> </NutritionIntake>
JSON Template
{ "resourceType" : "NutritionIntake", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // External identifier "instantiatesCanonical" : [{ canonical(ActivityDefinition|EventDefinition| EvidenceVariable|Measure|OperationDefinition|PlanDefinition|Questionnaire| SubscriptionTopic) }], // Instantiates FHIR protocol or definition "instantiatesUri" : ["<uri>"], // Instantiates external protocol or definition "basedOn" : [{ Reference(CarePlan|NutritionOrder|ServiceRequest) }], // Fulfils plan, proposal or order "partOf" : [{ Reference(NutritionIntake|Observation|Procedure) }], // Part of referenced event "status" : "<code>", // R! preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown "statusReason" : [{ CodeableConcept }], // Reason for current status "code" : { CodeableConcept }, // Type of nutrition intake setting/reporting "subject" : { Reference(Group|Patient) }, // R! Who is/was consuming the food or fluid "encounter" : { Reference(Encounter) }, // Encounter associated with NutritionIntake // occurrence[x]: The date/time or interval when the food or fluid is/was consumed. One of these 2: "occurrenceDateTime" : "<dateTime>", "occurrencePeriod" : { Period }, "recorded" : "<dateTime>", // When the intake was recorded // reported[x]: Person or organization that provided the information about the consumption of this food or fluid. One of these 2: "reportedBoolean" : <boolean>, "reportedReference" : { Reference(Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) }, "consumedItem" : [{ // R! What food or fluid product or item was consumed "type" : { CodeableConcept }, // R! The type of food or fluid product "nutritionProduct" : { CodeableReference(NutritionProduct) }, // R! Code that identifies the food or fluid product that was consumed "schedule" : { Timing }, // Scheduled frequency of consumption "amount" : { Quantity(SimpleQuantity) }, // Quantity of the specified food "rate" : { Quantity(SimpleQuantity) }, // Rate at which enteral feeding was administered "notConsumed" : <boolean>, // Flag to indicate if the food or fluid item was refused or otherwise not consumed "notConsumedReason" : { CodeableConcept } // Reason food or fluid was not consumed }], "ingredientLabel" : [{ // Total nutrient for the whole meal, product, serving "nutrient" : { CodeableReference(Substance) }, // R! Total nutrient consumed "amount" : { Quantity(SimpleQuantity) } // R! Total amount of nutrient consumed }], "performer" : [{ // Who was performed in the intake "function" : { CodeableConcept }, // Type of performer "actor" : { Reference(CareTeam|Device|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) } // R! Who performed the intake }], "location" : { Reference(Location) }, // Where the intake occurred "derivedFrom" : [{ Reference(Any) }], // Additional supporting information "reason" : [{ CodeableReference(Condition|DiagnosticReport|DocumentReference| Observation) }], // Reason for why the food or fluid is /was consumed "note" : [{ Annotation }] // Further information about the consumption }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:NutritionIntake; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:NutritionIntake.identifier [ Identifier ], ... ; # 0..* External identifier fhir:NutritionIntake.instantiatesCanonical [ canonical(ActivityDefinition|EventDefinition|EvidenceVariable|Measure|OperationDefinition| PlanDefinition|Questionnaire|SubscriptionTopic) ], ... ; # 0..* Instantiates FHIR protocol or definition fhir:NutritionIntake.instantiatesUri [ uri ], ... ; # 0..* Instantiates external protocol or definition fhir:NutritionIntake.basedOn [ Reference(CarePlan|NutritionOrder|ServiceRequest) ], ... ; # 0..* Fulfils plan, proposal or order fhir:NutritionIntake.partOf [ Reference(NutritionIntake|Observation|Procedure) ], ... ; # 0..* Part of referenced event fhir:NutritionIntake.status [ code ]; # 1..1 preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown fhir:NutritionIntake.statusReason [ CodeableConcept ], ... ; # 0..* Reason for current status fhir:NutritionIntake.code [ CodeableConcept ]; # 0..1 Type of nutrition intake setting/reporting fhir:NutritionIntake.subject [ Reference(Group|Patient) ]; # 1..1 Who is/was consuming the food or fluid fhir:NutritionIntake.encounter [ Reference(Encounter) ]; # 0..1 Encounter associated with NutritionIntake # NutritionIntake.occurrence[x] : 0..1 The date/time or interval when the food or fluid is/was consumed. One of these 2 fhir:NutritionIntake.occurrenceDateTime [ dateTime ] fhir:NutritionIntake.occurrencePeriod [ Period ] fhir:NutritionIntake.recorded [ dateTime ]; # 0..1 When the intake was recorded # NutritionIntake.reported[x] : 0..1 Person or organization that provided the information about the consumption of this food or fluid. One of these 2 fhir:NutritionIntake.reportedBoolean [ boolean ] fhir:NutritionIntake.reportedReference [ Reference(Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] fhir:NutritionIntake.consumedItem [ # 1..* What food or fluid product or item was consumed fhir:NutritionIntake.consumedItem.type [ CodeableConcept ]; # 1..1 The type of food or fluid product fhir:NutritionIntake.consumedItem.nutritionProduct [ CodeableReference(NutritionProduct) ]; # 1..1 Code that identifies the food or fluid product that was consumed fhir:NutritionIntake.consumedItem.schedule [ Timing ]; # 0..1 Scheduled frequency of consumption fhir:NutritionIntake.consumedItem.amount [ Quantity(SimpleQuantity) ]; # 0..1 Quantity of the specified food fhir:NutritionIntake.consumedItem.rate [ Quantity(SimpleQuantity) ]; # 0..1 Rate at which enteral feeding was administered fhir:NutritionIntake.consumedItem.notConsumed [ boolean ]; # 0..1 Flag to indicate if the food or fluid item was refused or otherwise not consumed fhir:NutritionIntake.consumedItem.notConsumedReason [ CodeableConcept ]; # 0..1 Reason food or fluid was not consumed ], ...; fhir:NutritionIntake.ingredientLabel [ # 0..* Total nutrient for the whole meal, product, serving fhir:NutritionIntake.ingredientLabel.nutrient [ CodeableReference(Substance) ]; # 1..1 Total nutrient consumed fhir:NutritionIntake.ingredientLabel.amount [ Quantity(SimpleQuantity) ]; # 1..1 Total amount of nutrient consumed ], ...; fhir:NutritionIntake.performer [ # 0..* Who was performed in the intake fhir:NutritionIntake.performer.function [ CodeableConcept ]; # 0..1 Type of performer fhir:NutritionIntake.performer.actor [ Reference(CareTeam|Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 1..1 Who performed the intake ], ...; fhir:NutritionIntake.location [ Reference(Location) ]; # 0..1 Where the intake occurred fhir:NutritionIntake.derivedFrom [ Reference(Any) ], ... ; # 0..* Additional supporting information fhir:NutritionIntake.reason [ CodeableReference(Condition|DiagnosticReport|DocumentReference|Observation) ], ... ; # 0..* Reason for why the food or fluid is /was consumed fhir:NutritionIntake.note [ Annotation ], ... ; # 0..* Further information about the consumption ]
See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis a
Path | Definition | Type | Reference |
---|---|---|---|
NutritionIntake.status | A coded concept indicating the current status of a NutritionIntake. | Required | EventStatus |
NutritionIntake.statusReason | A coded concept indicating the reason for the status of the statement. | Example | SNOMEDCTDrugTherapyStatusCodes |
NutritionIntake.code | A coded concept identifying where the medication included in the NutritionIntake is expected to be consumed or administered. | Example | DietCodes |
NutritionIntake.consumedItem.type | Types of food. | Example | Types of Edible Substances |
NutritionIntake.consumedItem.nutritionProduct | Specific food that can be consumed by a patient. | Example | FoodTypeCodes |
NutritionIntake.consumedItem.notConsumedReason | Reasons for why something was not consumed. | Example | Reasons for why a food item was not consumed |
NutritionIntake.ingredientLabel.nutrient | Types of nutrients that can be found in a nutrition product. | Example | NutrientModifierCodes |
NutritionIntake.performer.function | Type of performance. | Example | ProcedurePerformerRoleCodes |
NutritionIntake.reason | Reason for why something was ingested. | Example | Condition/Problem/DiagnosisCodes |
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Expression | In Common |
code | token | Returns statements of this code of NutritionIntake | NutritionIntake.code | |
date | date | Date when patient was taking (or not taking) the medication | NutritionIntake.occurrence | |
encounter | reference | Returns statements for a specific encounter | NutritionIntake.encounter (Encounter) | |
identifier | token | Return statements with this external identifier | NutritionIntake.identifier | |
nutrition D | token | Return statements of this medication reference | NutritionIntake.consumedItem.nutritionProduct | |
part-of | reference | Returns statements that are part of another event. | NutritionIntake.partOf (Observation, Procedure, NutritionIntake) | |
patient | reference | Returns statements for a specific patient. | NutritionIntake.subject.where(resolve() is Patient) (Patient) | |
source | reference | Who or where the information in the statement came from | (NutritionIntake.reported as Reference) (Practitioner, Organization, Patient, PractitionerRole, RelatedPerson) | |
status N | token | Return statements that match the given status | NutritionIntake.status | |
subject | reference | The identity of a patient, animal or group to list statements for | NutritionIntake.subject (Group, Patient) |