Skip to main content


class HS.FHIR.DTL.vSTU3.Model.Resource.NutritionOrder extends HS.FHIR.DTL.vSTU3.Model.Base.DomainResource

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

Property Inventory


Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter XMLNAME = NutritionOrder;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = NutritionOrder;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.


property allergyIntolerance as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "allergyIntolerance", XMLPROJECTION = "ELEMENT");

List of the patient's food and nutrition-related allergies and intolerances.


Property methods: allergyIntoleranceBuildValueArray(), allergyIntoleranceCollectionToDisplay(), allergyIntoleranceCollectionToOdbc(), allergyIntoleranceDisplayToCollection(), allergyIntoleranceGet(), allergyIntoleranceGetObject(), allergyIntoleranceGetObjectId(), allergyIntoleranceGetSwizzled(), allergyIntoleranceIsValid(), allergyIntoleranceOdbcToCollection(), allergyIntoleranceSet(), allergyIntoleranceSetObject(), allergyIntoleranceSetObjectId()
property dateTime as %String (MAXLEN = 1000000, XMLNAME = "dateTime", XMLPROJECTION = "ATTRIBUTE") [ Required ];

Date and time the nutrition order was requested.

Property methods: dateTimeDisplayToLogical(), dateTimeGet(), dateTimeIsValid(), dateTimeLogicalToDisplay(), dateTimeLogicalToOdbc(), dateTimeNormalize(), dateTimeSet()
property encounter as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "encounter", XMLPROJECTION = "ELEMENT");

The encounter associated with this nutrition order.


Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property enteralFormula as HS.FHIR.DTL.vSTU3.Model.Element.NutritionOrder.enteralFormula (XMLNAME = "enteralFormula", XMLPROJECTION = "ELEMENT");

Enteral formula components.

Property methods: enteralFormulaGet(), enteralFormulaGetSwizzled(), enteralFormulaIsValid(), enteralFormulaNewObject(), enteralFormulaSet()
property excludeFoodModifier as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "excludeFoodModifier", XMLPROJECTION = "ELEMENT");

Order-specific modifier about the type of food that should not be given.

any FHIR3 code may be used; food-type shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: excludeFoodModifierBuildValueArray(), excludeFoodModifierCollectionToDisplay(), excludeFoodModifierCollectionToOdbc(), excludeFoodModifierDisplayToCollection(), excludeFoodModifierGet(), excludeFoodModifierGetObject(), excludeFoodModifierGetObjectId(), excludeFoodModifierGetSwizzled(), excludeFoodModifierIsValid(), excludeFoodModifierOdbcToCollection(), excludeFoodModifierSet(), excludeFoodModifierSetObject(), excludeFoodModifierSetObjectId()
property foodPreferenceModifier as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "foodPreferenceModifier", XMLPROJECTION = "ELEMENT");

Order-specific modifier about the type of food that should be given.

any FHIR3 code may be used; encounter-diet shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: foodPreferenceModifierBuildValueArray(), foodPreferenceModifierCollectionToDisplay(), foodPreferenceModifierCollectionToOdbc(), foodPreferenceModifierDisplayToCollection(), foodPreferenceModifierGet(), foodPreferenceModifierGetObject(), foodPreferenceModifierGetObjectId(), foodPreferenceModifierGetSwizzled(), foodPreferenceModifierIsValid(), foodPreferenceModifierOdbcToCollection(), foodPreferenceModifierSet(), foodPreferenceModifierSetObject(), foodPreferenceModifierSetObjectId()
property identifier as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Identifiers assigned to this order.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property oralDiet as HS.FHIR.DTL.vSTU3.Model.Element.NutritionOrder.oralDiet (XMLNAME = "oralDiet", XMLPROJECTION = "ELEMENT");

Oral diet components.

Property methods: oralDietGet(), oralDietGetSwizzled(), oralDietIsValid(), oralDietNewObject(), oralDietSet()
property orderer as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "orderer", XMLPROJECTION = "ELEMENT");

Who ordered the diet, formula or nutritional supplement.


Property methods: ordererGet(), ordererGetSwizzled(), ordererIsValid(), ordererNewObject(), ordererSet()
property patient as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT") [ Required ];

The person who requires the diet, formula or nutritional supplement.


Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE");

proposed | draft | planned | requested | active | on-hold | completed | cancelled | entered-in-error

nutrition-request-status is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend nutrition-request-status and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property supplement as list of HS.FHIR.DTL.vSTU3.Model.Element.NutritionOrder.supplement (XMLNAME = "supplement", XMLPROJECTION = "ELEMENT");

Supplement components.

Property methods: supplementBuildValueArray(), supplementCollectionToDisplay(), supplementCollectionToOdbc(), supplementDisplayToCollection(), supplementGet(), supplementGetObject(), supplementGetObjectId(), supplementGetSwizzled(), supplementIsValid(), supplementOdbcToCollection(), supplementSet(), supplementSetObject(), supplementSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab