Skip to main content

HS.FHIR.vSTU3.Model.Resource.NutritionOrder

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

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.
If the element is present, it must have either a @value, an @id, or extensions

Property Inventory

Method Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
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.

Properties

property allergyIntolerance as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "allergyIntolerance", XMLPROJECTION = "ELEMENT");
A link to a record of allergies or intolerances which should be included in the nutrition order.
Property methods: allergyIntoleranceBuildValueArray(), allergyIntoleranceCollectionToDisplay(), allergyIntoleranceCollectionToOdbc(), allergyIntoleranceDisplayToCollection(), allergyIntoleranceGet(), allergyIntoleranceGetObject(), allergyIntoleranceGetObjectId(), allergyIntoleranceGetSwizzled(), allergyIntoleranceIsValid(), allergyIntoleranceOdbcToCollection(), allergyIntoleranceSet(), allergyIntoleranceSetObject(), allergyIntoleranceSetObjectId()
property dateTime as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "dateTime", XMLPROJECTION = "ELEMENT") [ Required ];
The date and time that this nutrition order was requested.
Property methods: dateTimeGet(), dateTimeGetSwizzled(), dateTimeIsValid(), dateTimeNewObject(), dateTimeSet()
property encounter as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "encounter", XMLPROJECTION = "ELEMENT");
An encounter that provides additional information about the healthcare context in which this request is made.
Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property enteralFormula as HS.FHIR.vSTU3.Model.Resource.NutritionOrder.EnteralFormula (XMLNAME = "enteralFormula", XMLPROJECTION = "ELEMENT");
Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.
Property methods: enteralFormulaGet(), enteralFormulaGetSwizzled(), enteralFormulaIsValid(), enteralFormulaNewObject(), enteralFormulaSet()
property excludeFoodModifier as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "excludeFoodModifier", XMLPROJECTION = "ELEMENT");
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.
Property methods: excludeFoodModifierBuildValueArray(), excludeFoodModifierCollectionToDisplay(), excludeFoodModifierCollectionToOdbc(), excludeFoodModifierDisplayToCollection(), excludeFoodModifierGet(), excludeFoodModifierGetObject(), excludeFoodModifierGetObjectId(), excludeFoodModifierGetSwizzled(), excludeFoodModifierIsValid(), excludeFoodModifierOdbcToCollection(), excludeFoodModifierSet(), excludeFoodModifierSetObject(), excludeFoodModifierSetObjectId()
property foodPreferenceModifier as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "foodPreferenceModifier", XMLPROJECTION = "ELEMENT");
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.
Property methods: foodPreferenceModifierBuildValueArray(), foodPreferenceModifierCollectionToDisplay(), foodPreferenceModifierCollectionToOdbc(), foodPreferenceModifierDisplayToCollection(), foodPreferenceModifierGet(), foodPreferenceModifierGetObject(), foodPreferenceModifierGetObjectId(), foodPreferenceModifierGetSwizzled(), foodPreferenceModifierIsValid(), foodPreferenceModifierOdbcToCollection(), foodPreferenceModifierSet(), foodPreferenceModifierSetObject(), foodPreferenceModifierSetObjectId()
property identifier as list of HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifiers assigned to this order by the order sender or by the order receiver.
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property oralDiet as HS.FHIR.vSTU3.Model.Resource.NutritionOrder.OralDiet (XMLNAME = "oralDiet", XMLPROJECTION = "ELEMENT");
Diet given orally in contrast to enteral (tube) feeding.
Property methods: oralDietGet(), oralDietGetSwizzled(), oralDietIsValid(), oralDietNewObject(), oralDietSet()
property orderer as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "orderer", XMLPROJECTION = "ELEMENT");
The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.
Property methods: ordererGet(), ordererGetSwizzled(), ordererIsValid(), ordererNewObject(), ordererSet()
property patient as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT") [ Required ];
The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.
Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property status as HS.FHIR.vSTU3.Model.Base.NutritionOrderStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT");
The workflow status of the nutrition order/request.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property supplement as list of HS.FHIR.vSTU3.Model.Resource.NutritionOrder.Supplement (XMLNAME = "supplement", XMLPROJECTION = "ELEMENT");
Oral nutritional products given in order to add further nutritional value to the patient's diet.
Property methods: supplementBuildValueArray(), supplementCollectionToDisplay(), supplementCollectionToOdbc(), supplementDisplayToCollection(), supplementGet(), supplementGetObject(), supplementGetObjectId(), supplementGetSwizzled(), supplementIsValid(), supplementOdbcToCollection(), supplementSet(), supplementSetObject(), supplementSetObjectId()

Methods

deprecated method SetAllergyIntolerance(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "allergyIntolerance" property.
deprecated method SetDateTime(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "dateTime" property.
deprecated method SetEncounter(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "encounter" property.
deprecated method SetExcludeFoodModifier(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "excludeFoodModifier" property.
deprecated method SetFoodPreferenceModifier(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "foodPreferenceModifier" property.
deprecated method SetIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "identifier" property.
deprecated method SetOrderer(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "orderer" property.
deprecated method SetPatient(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "patient" property.
deprecated method SetStatus(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "status" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab