Skip to main content

HS.FHIR.DTL.vDSTU2.Model.Element.NutritionOrder.enteralFormula

class HS.FHIR.DTL.vDSTU2.Model.Element.NutritionOrder.enteralFormula extends HS.FHIR.DTL.vDSTU2.Model.Base.BackboneElement

Enteral formula components.

Property 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.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 XMLPROJECTION = ELEMENT;
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 %String (MAXLEN = 1000000, XMLNAME = "additiveProductName", XMLPROJECTION = "ATTRIBUTE");
string

Product or brand name of the modular additive.

Property methods: additiveProductNameDisplayToLogical(), additiveProductNameGet(), additiveProductNameIsValid(), additiveProductNameLogicalToDisplay(), additiveProductNameLogicalToOdbc(), additiveProductNameNormalize(), additiveProductNameSet()
property additiveType as HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "additiveType", XMLPROJECTION = "ELEMENT");
CodeableConcept

Type of modular component to add to the feeding.

any FHIR2 code may be used; entformula-additive shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: additiveTypeGet(), additiveTypeGetSwizzled(), additiveTypeIsValid(), additiveTypeNewObject(), additiveTypeSet()
property administration as list of HS.FHIR.DTL.vDSTU2.Model.Element.NutritionOrder.enteralFormula.administration (XMLNAME = "administration", XMLPROJECTION = "ELEMENT");
BackboneElement

Formula feeding instruction as structured data.

Property methods: administrationBuildValueArray(), administrationCollectionToDisplay(), administrationCollectionToOdbc(), administrationDisplayToCollection(), administrationGet(), administrationGetObject(), administrationGetObjectId(), administrationGetSwizzled(), administrationInstructionDisplayToLogical(), administrationInstructionGet(), administrationInstructionIsValid(), administrationInstructionLogicalToDisplay(), administrationInstructionLogicalToOdbc(), administrationInstructionNormalize(), administrationInstructionSet(), administrationIsValid(), administrationOdbcToCollection(), administrationSet(), administrationSetObject(), administrationSetObjectId()
property administrationInstruction as %String (MAXLEN = 1000000, XMLNAME = "administrationInstruction", XMLPROJECTION = "ATTRIBUTE");
string

Formula feeding instructions expressed as text.

Property methods: administrationInstructionDisplayToLogical(), administrationInstructionGet(), administrationInstructionIsValid(), administrationInstructionLogicalToDisplay(), administrationInstructionLogicalToOdbc(), administrationInstructionNormalize(), administrationInstructionSet()
property baseFormulaProductName as %String (MAXLEN = 1000000, XMLNAME = "baseFormulaProductName", XMLPROJECTION = "ATTRIBUTE");
string

Product or brand name of the enteral or infant formula.

Property methods: baseFormulaProductNameDisplayToLogical(), baseFormulaProductNameGet(), baseFormulaProductNameIsValid(), baseFormulaProductNameLogicalToDisplay(), baseFormulaProductNameLogicalToOdbc(), baseFormulaProductNameNormalize(), baseFormulaProductNameSet()
property baseFormulaType as HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "baseFormulaType", XMLPROJECTION = "ELEMENT");
CodeableConcept

Type of enteral or infant formula.

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

Property methods: baseFormulaTypeGet(), baseFormulaTypeGetSwizzled(), baseFormulaTypeIsValid(), baseFormulaTypeNewObject(), baseFormulaTypeSet()
property caloricDensity as HS.FHIR.DTL.vDSTU2.Model.Datatype.SimpleQuantity (XMLNAME = "caloricDensity", XMLPROJECTION = "ELEMENT");
SimpleQuantity

Amount of energy per specified volume that is required.

Property methods: caloricDensityGet(), caloricDensityGetSwizzled(), caloricDensityIsValid(), caloricDensityNewObject(), caloricDensitySet()
property maxVolumeToDeliver as HS.FHIR.DTL.vDSTU2.Model.Datatype.SimpleQuantity (XMLNAME = "maxVolumeToDeliver", XMLPROJECTION = "ELEMENT");
SimpleQuantity

Upper limit on formula volume per unit of time.

Property methods: maxVolumeToDeliverGet(), maxVolumeToDeliverGetSwizzled(), maxVolumeToDeliverIsValid(), maxVolumeToDeliverNewObject(), maxVolumeToDeliverSet()
property routeofAdministration as HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "routeofAdministration", XMLPROJECTION = "ELEMENT");
CodeableConcept

How the formula should enter the patient's gastrointestinal tract.

enteral-route is the REQUIRED FHIR2 ValueSet for codes, but if you need to express meanings not found in enteral-route, you may formally EXTEND enteral-route to add codes to it.

Property methods: routeofAdministrationGet(), routeofAdministrationGetSwizzled(), routeofAdministrationIsValid(), routeofAdministrationNewObject(), routeofAdministrationSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab