The FHIR R4 NutritionOrder
resource captures diet, oral supplement, and enteral feeding instructions for a patient. It is used by providers, dietitians, and care teams to coordinate nutrition plans across care settings. Health Gorilla supports this resource for submitting, tracking, and retrieving nutrition-related orders.
Use Cases
- Document a prescribed therapeutic diet for a hospitalized or long-term care patient
- Record oral nutrition supplements or enteral feeding instructions
- Retrieve nutrition plans during transitions of care
Base URLs
- Production: https://api.healthgorilla.com/fhir/R4/NutritionOrder
- Sandbox: https://sandbox.healthgorilla.com/fhir/R4/NutritionOrder
Authentication
All requests require OAuth 2.0 authentication using a Bearer Token. Unauthorized requests return 401 Unauthorized
responses.
Required Scopes
nutritionorder.read
for GETnutritionorder.write
for POST, PUT, DELETE
For more information, go to: OAuth 2.0 Authentication.
Supported Methods
Method | Operation | Description |
---|---|---|
GET | Read NutritionOrder | Retrieves a specific NutritionOrder record by its FHIR ID. |
GET | Search NutritionOrder | Searches for NutritionOrder records for a specified patient. |
POST | Create NutritionOrder | Submits a new NutritionOrder record to the Health Gorilla FHIR server. |
PUT | Update NutritionOrder | Updates an existing NutritionOrder record by full resource replacement. |
DELETE | Delete NutritionOrder | Removes an existing NutritionOrder record from the system by full deletion. |
Frequently Used Search Parameters
Parameter | Description | FHIR Value Set / Example Values | FHIR Data Type | Required |
---|---|---|---|---|
patient | Filters by patient ID | Patient/{id} | Reference | Yes |
status | Filters by status of the order | NutritionOrderStatus (active , completed , on-hold ) | token | No |
date | Filters by date the nutrition order was requested | ge2023-01-01 , le2023-12-31 | date | No |
encounter | Filters by associated encounter | Encounter/{id} | Reference | No |
provider | Filters by the practitioner who authorized the order | Practitioner/{id} | Reference | No |
Commonly Returned Resource Attributes
Attribute | Description | Example Values | FHIR Data Type | Required |
---|---|---|---|---|
id | Unique FHIR ID for the nutrition order | no-12345 | id | Yes |
status | Current state of the nutrition order | active | code | Yes |
intent | Purpose of the order | order | code | Yes |
patient | Reference to the patient for whom the order was made | Patient/{id} | Reference(Patient) | Yes |
encounter | Associated encounter during which the order was made | Encounter/{id} | Reference(Encounter) | No |
dateTime | Date and time the order was entered | 2024-01-15T08:30:00-08:00 | dateTime | Yes |
orderer | Practitioner responsible for the order | Practitioner/{id} | Reference(Practitioner) | No |
foodPreferenceModifier | Modifiers related to food preferences | kosher , vegan | CodeableConcept[] | No |
excludeFoodModifier | Modifiers for food exclusions | peanut-free | CodeableConcept[] | No |
oralDiet | Oral diet instructions (type, schedule, texture, fluid intake) | low-sodium , pureed , soft | NutritionOrder.OralDiet | No |
supplement | Oral nutritional supplements | Ensure | NutritionOrder.Supplement[] | No |
enteralFormula | Enteral feeding instructions | Jevity 1.2 at 75 mL/hr via PEG | NutritionOrder.EnteralFormula | No |
Webhooks
Clients can subscribe to webhook notifications for new or updated NutritionOrder
records. These are typically triggered when clinical systems push structured nutrition data into the patient's chart.
For more information, go to: Webhooks & Polling.
Error Handling
All NutritionOrder
operations follow standard Health Gorilla error handling, including use of FHIR OperationOutcome
for structured responses.
For more information, go to: Error Handling.