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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringNutritionOrderThis is a NutritionOrder resource
identifierarray(Identifier)Identifiers assigned to this order by the order sender or by the order receiver.
statusstringproposed|draft|planned|requested|active|on-hold|completed|cancelled|entered-in-errorThe workflow status of the nutrition order/request.
patient*ReferenceThe person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.
encounterReferenceAn encounter that provides additional information about the healthcare context in which this request is made.
dateTimestringThe date and time that this nutrition order was requested.
ordererReferenceThe practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.
allergyIntolerancearray(Reference)A link to a record of allergies or intolerances which should be included in the nutrition order.
foodPreferenceModifierarray(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.
excludeFoodModifierarray(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.
oralDietNutritionOrder_OralDietDiet given orally in contrast to enteral (tube) feeding.
supplementarray(NutritionOrder_Supplement)Oral nutritional products given in order to add further nutritional value to the patient's diet.
enteralFormulaNutritionOrder_EnteralFormulaFeeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.

Response

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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringNutritionOrderThis is a NutritionOrder resource
identifierarray(Identifier)Identifiers assigned to this order by the order sender or by the order receiver.
statusstringproposed|draft|planned|requested|active|on-hold|completed|cancelled|entered-in-errorThe workflow status of the nutrition order/request.
patient*ReferenceThe person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.
encounterReferenceAn encounter that provides additional information about the healthcare context in which this request is made.
dateTimestringThe date and time that this nutrition order was requested.
ordererReferenceThe practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.
allergyIntolerancearray(Reference)A link to a record of allergies or intolerances which should be included in the nutrition order.
foodPreferenceModifierarray(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.
excludeFoodModifierarray(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.
oralDietNutritionOrder_OralDietDiet given orally in contrast to enteral (tube) feeding.
supplementarray(NutritionOrder_Supplement)Oral nutritional products given in order to add further nutritional value to the patient's diet.
enteralFormulaNutritionOrder_EnteralFormulaFeeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.

Response

Read Nutrition Order

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Nutrition Order

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Nutrition Order

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Nutrition Order

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Nutrition Order

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
additivestring
datetimestring
encounterstring
formulastring
identifierstring
oraldietstring
patientstring
pertains-tostring
providerstring
statusstring
supplementstring

Params

organizationId*string|stringid|slug

Response

Search History Nutrition Order

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
additivestring
datetimestring
encounterstring
formulastring
identifierstring
oraldietstring
patientstring
pertains-tostring
providerstring
statusstring
supplementstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringNutritionOrderThis is a NutritionOrder resource
identifierarray(Identifier)Identifiers assigned to this order by the order sender or by the order receiver.
statusstringproposed|draft|planned|requested|active|on-hold|completed|cancelled|entered-in-errorThe workflow status of the nutrition order/request.
patient*ReferenceThe person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.
encounterReferenceAn encounter that provides additional information about the healthcare context in which this request is made.
dateTimestringThe date and time that this nutrition order was requested.
ordererReferenceThe practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.
allergyIntolerancearray(Reference)A link to a record of allergies or intolerances which should be included in the nutrition order.
foodPreferenceModifierarray(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.
excludeFoodModifierarray(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.
oralDietNutritionOrder_OralDietDiet given orally in contrast to enteral (tube) feeding.
supplementarray(NutritionOrder_Supplement)Oral nutritional products given in order to add further nutritional value to the patient's diet.
enteralFormulaNutritionOrder_EnteralFormulaFeeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.

Response

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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringNutritionOrderThis is a NutritionOrder resource
identifierarray(Identifier)Identifiers assigned to this order by the order sender or by the order receiver.
statusstringproposed|draft|planned|requested|active|on-hold|completed|cancelled|entered-in-errorThe workflow status of the nutrition order/request.
patient*ReferenceThe person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.
encounterReferenceAn encounter that provides additional information about the healthcare context in which this request is made.
dateTimestringThe date and time that this nutrition order was requested.
ordererReferenceThe practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.
allergyIntolerancearray(Reference)A link to a record of allergies or intolerances which should be included in the nutrition order.
foodPreferenceModifierarray(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.
excludeFoodModifierarray(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.
oralDietNutritionOrder_OralDietDiet given orally in contrast to enteral (tube) feeding.
supplementarray(NutritionOrder_Supplement)Oral nutritional products given in order to add further nutritional value to the patient's diet.
enteralFormulaNutritionOrder_EnteralFormulaFeeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.

Response