Skip to main content

HS.FHIR.vSTU3.Model.Resource.NutritionOrder.EnteralFormula

deprecated class HS.FHIR.vSTU3.Model.Resource.NutritionOrder.EnteralFormula extends HS.FHIR.vSTU3.Model.Base.BackboneElement

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.

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 JSONTYPEFIELD;
Inherited description: Type property name for JSON export.
parameter XMLNAME = NutritionOrder.EnteralFormula;
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.EnteralFormula;
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.

Properties

property additiveProductName as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "additiveProductName", XMLPROJECTION = "ELEMENT");
The product or brand name of the type of modular component to be added to the formula.
Property methods: additiveProductNameGet(), additiveProductNameGetSwizzled(), additiveProductNameIsValid(), additiveProductNameNewObject(), additiveProductNameSet()
property additiveType as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "additiveType", XMLPROJECTION = "ELEMENT");
Indicates the type of modular component such as protein, carbohydrate, fat or fiber to be provided in addition to or mixed with the base formula.
Property methods: additiveTypeGet(), additiveTypeGetSwizzled(), additiveTypeIsValid(), additiveTypeNewObject(), additiveTypeSet()
property administration as list of HS.FHIR.vSTU3.Model.Resource.NutritionOrder.Administration (XMLNAME = "administration", XMLPROJECTION = "ELEMENT");
Formula administration instructions as structured data. This repeating structure allows for changing the administration rate or volume over time for both bolus and continuous feeding. An example of this would be an instruction to increase the rate of continuous feeding every 2 hours.
Property methods: administrationBuildValueArray(), administrationCollectionToDisplay(), administrationCollectionToOdbc(), administrationDisplayToCollection(), administrationGet(), administrationGetObject(), administrationGetObjectId(), administrationGetSwizzled(), administrationInstructionGet(), administrationInstructionGetSwizzled(), administrationInstructionIsValid(), administrationInstructionNewObject(), administrationInstructionSet(), administrationIsValid(), administrationOdbcToCollection(), administrationSet(), administrationSetObject(), administrationSetObjectId()
property administrationInstruction as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "administrationInstruction", XMLPROJECTION = "ELEMENT");
Free text formula administration, feeding instructions or additional instructions or information.
Property methods: administrationInstructionGet(), administrationInstructionGetSwizzled(), administrationInstructionIsValid(), administrationInstructionNewObject(), administrationInstructionSet()
property baseFormulaProductName as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "baseFormulaProductName", XMLPROJECTION = "ELEMENT");
The product or brand name of the enteral or infant formula product such as "ACME Adult Standard Formula".
Property methods: baseFormulaProductNameGet(), baseFormulaProductNameGetSwizzled(), baseFormulaProductNameIsValid(), baseFormulaProductNameNewObject(), baseFormulaProductNameSet()
property baseFormulaType as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "baseFormulaType", XMLPROJECTION = "ELEMENT");
The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula.
Property methods: baseFormulaTypeGet(), baseFormulaTypeGetSwizzled(), baseFormulaTypeIsValid(), baseFormulaTypeNewObject(), baseFormulaTypeSet()
property caloricDensity as HS.FHIR.vSTU3.Model.Base.Quantity (XMLNAME = "caloricDensity", XMLPROJECTION = "ELEMENT");
The amount of energy (calories) that the formula should provide per specified volume, typically per mL or fluid oz. For example, an infant may require a formula that provides 24 calories per fluid ounce or an adult may require an enteral formula that provides 1.5 calorie/mL.
Property methods: caloricDensityGet(), caloricDensityGetSwizzled(), caloricDensityIsValid(), caloricDensityNewObject(), caloricDensitySet()
property maxVolumeToDeliver as HS.FHIR.vSTU3.Model.Base.Quantity (XMLNAME = "maxVolumeToDeliver", XMLPROJECTION = "ELEMENT");
The maximum total quantity of formula that may be administered to a subject over the period of time, e.g. 1440 mL over 24 hours.
Property methods: maxVolumeToDeliverGet(), maxVolumeToDeliverGetSwizzled(), maxVolumeToDeliverIsValid(), maxVolumeToDeliverNewObject(), maxVolumeToDeliverSet()
property routeofAdministration as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "routeofAdministration", XMLPROJECTION = "ELEMENT");
The route or physiological path of administration into the patient's gastrointestinal tract for purposes of providing the formula feeding, e.g. nasogastric tube.
Property methods: routeofAdministrationGet(), routeofAdministrationGetSwizzled(), routeofAdministrationIsValid(), routeofAdministrationNewObject(), routeofAdministrationSet()

Methods

deprecated method SetAdditiveProductName(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 "additiveProductName" property.
deprecated method SetAdditiveType(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.
Set method for the "additiveType" property.
deprecated method SetAdministrationInstruction(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 "administrationInstruction" property.
deprecated method SetBaseFormulaProductName(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 "baseFormulaProductName" property.
deprecated method SetBaseFormulaType(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.
Set method for the "baseFormulaType" property.
deprecated method SetCaloricDensity(pValue As %String = "", pComparator As %String = "", pUnit As %String = "", pSystem As %String = "", pCode As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "caloricDensity" property.
deprecated method SetMaxVolumeToDeliver(pValue As %String = "", pComparator As %String = "", pUnit As %String = "", pSystem As %String = "", pCode As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "maxVolumeToDeliver" property.
deprecated method SetRouteofAdministration(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.
Set method for the "routeofAdministration" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab