nutrition orders

Create Nutrition Order

post

/organizations/{organizationId}/fhir/3/NutritionOrder

A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	NutritionOrder	This is a NutritionOrder resource
identifier	array(Identifier)		Identifiers assigned to this order by the order sender or by the order receiver.
status	string	proposed\|draft\|planned\|requested\|active\|on-hold\|completed\|cancelled\|entered-in-error	The workflow status of the nutrition order/request.
patient*	Reference		The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.
encounter	Reference		An encounter that provides additional information about the healthcare context in which this request is made.
dateTime	string		The date and time that this nutrition order was requested.
orderer	Reference		The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.
allergyIntolerance	array(Reference)		A link to a record of allergies or intolerances which should be included in the nutrition order.
foodPreferenceModifier	array(CodeableConcept)		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.
excludeFoodModifier	array(CodeableConcept)		This modifier is used to convey order-specific modifiers about the type of food 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.
oralDiet	NutritionOrder_OralDiet		Diet given orally in contrast to enteral (tube) feeding.
supplement	array(NutritionOrder_Supplement)		Oral nutritional products given in order to add further nutritional value to the patient's diet.
enteralFormula	NutritionOrder_EnteralFormula		Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.

Response

201 400 401 404

Patch Nutrition Order

patch

/organizations/{organizationId}/fhir/3/NutritionOrder/{resourceId}

A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.

Request

Headers


content-type*	string	application/json-patch+json	application/json-patch+json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	NutritionOrder	This is a NutritionOrder resource
identifier	array(Identifier)		Identifiers assigned to this order by the order sender or by the order receiver.
status	string	proposed\|draft\|planned\|requested\|active\|on-hold\|completed\|cancelled\|entered-in-error	The workflow status of the nutrition order/request.
patient*	Reference		The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.
encounter	Reference		An encounter that provides additional information about the healthcare context in which this request is made.
dateTime	string		The date and time that this nutrition order was requested.
orderer	Reference		The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.
allergyIntolerance	array(Reference)		A link to a record of allergies or intolerances which should be included in the nutrition order.
foodPreferenceModifier	array(CodeableConcept)		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.
excludeFoodModifier	array(CodeableConcept)		This modifier is used to convey order-specific modifiers about the type of food 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.
oralDiet	NutritionOrder_OralDiet		Diet given orally in contrast to enteral (tube) feeding.
supplement	array(NutritionOrder_Supplement)		Oral nutritional products given in order to add further nutritional value to the patient's diet.
enteralFormula	NutritionOrder_EnteralFormula		Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.

Response

200 201 400 401 404 409

Read Nutrition Order

get

/organizations/{organizationId}/fhir/3/NutritionOrder/{resourceId}

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read History Nutrition Order

get

/organizations/{organizationId}/fhir/3/NutritionOrder/{resourceId}/_history

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read Version Nutrition Order

get

/organizations/{organizationId}/fhir/3/NutritionOrder/{resourceId}/_history/{versionId}

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string	id\|slug
resourceId*
versionId*

Response

200 400 401 404

Remove Nutrition Order

delete

/organizations/{organizationId}/fhir/3/NutritionOrder/{resourceId}

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 204 400 401 404 409

Search Get Nutrition Order

get

/organizations/{organizationId}/fhir/3/NutritionOrder

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
additive	string
datetime	string
encounter	string
formula	string
identifier	string
oraldiet	string
patient	string
pertains-to	string
provider	string
status	string
supplement	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Nutrition Order

get

/organizations/{organizationId}/fhir/3/NutritionOrder/_history

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search Post Nutrition Order

post

/organizations/{organizationId}/fhir/3/NutritionOrder/_search

A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.

Request

Headers


content-type*	string	application/json\|application/x-www-form-urlencoded	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
additive	string
datetime	string
encounter	string
formula	string
identifier	string
oraldiet	string
patient	string
pertains-to	string
provider	string
status	string
supplement	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	NutritionOrder	This is a NutritionOrder resource
identifier	array(Identifier)		Identifiers assigned to this order by the order sender or by the order receiver.
status	string	proposed\|draft\|planned\|requested\|active\|on-hold\|completed\|cancelled\|entered-in-error	The workflow status of the nutrition order/request.
patient*	Reference		The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.
encounter	Reference		An encounter that provides additional information about the healthcare context in which this request is made.
dateTime	string		The date and time that this nutrition order was requested.
orderer	Reference		The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.
allergyIntolerance	array(Reference)		A link to a record of allergies or intolerances which should be included in the nutrition order.
foodPreferenceModifier	array(CodeableConcept)		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.
excludeFoodModifier	array(CodeableConcept)		This modifier is used to convey order-specific modifiers about the type of food 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.
oralDiet	NutritionOrder_OralDiet		Diet given orally in contrast to enteral (tube) feeding.
supplement	array(NutritionOrder_Supplement)		Oral nutritional products given in order to add further nutritional value to the patient's diet.
enteralFormula	NutritionOrder_EnteralFormula		Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.

Response

200 401 404

Update Nutrition Order

put

/organizations/{organizationId}/fhir/3/NutritionOrder/{resourceId}

A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	NutritionOrder	This is a NutritionOrder resource
identifier	array(Identifier)		Identifiers assigned to this order by the order sender or by the order receiver.
status	string	proposed\|draft\|planned\|requested\|active\|on-hold\|completed\|cancelled\|entered-in-error	The workflow status of the nutrition order/request.
patient*	Reference		The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.
encounter	Reference		An encounter that provides additional information about the healthcare context in which this request is made.
dateTime	string		The date and time that this nutrition order was requested.
orderer	Reference		The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.
allergyIntolerance	array(Reference)		A link to a record of allergies or intolerances which should be included in the nutrition order.
foodPreferenceModifier	array(CodeableConcept)		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.
excludeFoodModifier	array(CodeableConcept)		This modifier is used to convey order-specific modifiers about the type of food 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.
oralDiet	NutritionOrder_OralDiet		Diet given orally in contrast to enteral (tube) feeding.
supplement	array(NutritionOrder_Supplement)		Oral nutritional products given in order to add further nutritional value to the patient's diet.
enteralFormula	NutritionOrder_EnteralFormula		Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.

Response

200 201 400 401 404 409