Skip to main content

HS.FHIRModel.R4.NutritionOrderX.EnteralFormula

class HS.FHIRModel.R4.NutritionOrderX.EnteralFormula extends HS.FHIRModel.FHIRClassSuper

*****************************************
** NutritionOrderX.EnteralFormula generated class schema
*****************************************
A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_NUTRITIONORDERX_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.FHIRModel.R4.Element;
Extensions for additiveProductName
Property methods: _additiveProductNameGet(), _additiveProductNameGetSwizzled(), _additiveProductNameIsValid(), _additiveProductNameNewObject(), _additiveProductNameSet()
property _administrationInstruction as HS.FHIRModel.R4.Element;
Extensions for administrationInstruction
Property methods: _administrationInstructionGet(), _administrationInstructionGetSwizzled(), _administrationInstructionIsValid(), _administrationInstructionNewObject(), _administrationInstructionSet()
property _baseFormulaProductName as HS.FHIRModel.R4.Element;
Extensions for baseFormulaProductName
Property methods: _baseFormulaProductNameGet(), _baseFormulaProductNameGetSwizzled(), _baseFormulaProductNameIsValid(), _baseFormulaProductNameNewObject(), _baseFormulaProductNameSet()
property additiveProductName as %String;
The product or brand name of the type of modular component to be added to the formula.
Property methods: additiveProductNameDisplayToLogical(), additiveProductNameGet(), additiveProductNameIsValid(), additiveProductNameLogicalToDisplay(), additiveProductNameLogicalToOdbc(), additiveProductNameNormalize(), additiveProductNameSet()
property additiveType as HS.FHIRModel.R4.CodeableConcept;
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()
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: administrationGet(), administrationGetSwizzled(), administrationIsValid(), administrationNewObject(), administrationSet()
property administrationInstruction as %String;
Free text formula administration, feeding instructions or additional instructions or information.
Property methods: administrationInstructionDisplayToLogical(), administrationInstructionGet(), administrationInstructionIsValid(), administrationInstructionLogicalToDisplay(), administrationInstructionLogicalToOdbc(), administrationInstructionNormalize(), administrationInstructionSet()
property baseFormulaProductName as %String;
The product or brand name of the enteral or infant formula product such as "ACME Adult Standard Formula".
Property methods: baseFormulaProductNameDisplayToLogical(), baseFormulaProductNameGet(), baseFormulaProductNameIsValid(), baseFormulaProductNameLogicalToDisplay(), baseFormulaProductNameLogicalToOdbc(), baseFormulaProductNameNormalize(), baseFormulaProductNameSet()
property baseFormulaType as HS.FHIRModel.R4.CodeableConcept;
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.FHIRModel.R4.Quantity;
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 extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property maxVolumeToDeliver as HS.FHIRModel.R4.Quantity;
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 modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property routeofAdministration as HS.FHIRModel.R4.CodeableConcept;
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

method IncludeAdditiveType()
method IncludeAdministration()
method IncludeBaseFormulaType()
method IncludeCaloricDensity()
method IncludeExtension()
method IncludeMaxVolumeToDeliver()
method IncludeModifierExtension()
method IncludeRouteofAdministration()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab