NutritionOrder.EnteralFormula (HAPI FHIR Structures

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.api.BaseIdentifiableElement
  - - ca.uhn.fhir.model.dstu2.resource.NutritionOrder.EnteralFormula

All Implemented Interfaces:

ICompositeElement, IElement, IIdentifiableElement, IResourceBlock, ISupportsUndeclaredExtensions, Serializable, IBase

Enclosing class:

NutritionOrder
```
public static class NutritionOrder.EnteralFormula
extends BaseIdentifiableElement
implements IResourceBlock
```
Block class for child element: NutritionOrder.enteralFormula ()
Definition: Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

EnteralFormula()

Constructors
Constructor and Description
`EnteralFormula()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NutritionOrder.EnteralFormulaAdministration`	`addAdministration()` Adds and returns a new value for administration ()
`NutritionOrder.EnteralFormula`	`addAdministration(NutritionOrder.EnteralFormulaAdministration theValue)` Adds a given new value for administration ()
`String`	`getAdditiveProductName()` Gets the value(s) for additiveProductName ().
`StringDt`	`getAdditiveProductNameElement()` Gets the value(s) for additiveProductName ().
`CodeableConceptDt`	`getAdditiveType()` Gets the value(s) for additiveType ().
`List<NutritionOrder.EnteralFormulaAdministration>`	`getAdministration()` Gets the value(s) for administration ().
`NutritionOrder.EnteralFormulaAdministration`	`getAdministrationFirstRep()` Gets the first repetition for administration (), creating it if it does not already exist.
`String`	`getAdministrationInstruction()` Gets the value(s) for administrationInstruction ().
`StringDt`	`getAdministrationInstructionElement()` Gets the value(s) for administrationInstruction ().
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`String`	`getBaseFormulaProductName()` Gets the value(s) for baseFormulaProductName ().
`StringDt`	`getBaseFormulaProductNameElement()` Gets the value(s) for baseFormulaProductName ().
`BoundCodeableConceptDt<EnteralFormulaTypeCodesEnum>`	`getBaseFormulaType()` Gets the value(s) for baseFormulaType ().
`SimpleQuantityDt`	`getCaloricDensity()` Gets the value(s) for caloricDensity ().
`SimpleQuantityDt`	`getMaxVolumeToDeliver()` Gets the value(s) for maxVolumeToDeliver ().
`CodeableConceptDt`	`getRouteofAdministration()` Gets the value(s) for routeofAdministration ().
`boolean`	`isEmpty()`
`NutritionOrder.EnteralFormula`	`setAdditiveProductName(String theString)` Sets the value for additiveProductName ()
`NutritionOrder.EnteralFormula`	`setAdditiveProductName(StringDt theValue)` Sets the value(s) for additiveProductName ()
`NutritionOrder.EnteralFormula`	`setAdditiveType(CodeableConceptDt theValue)` Sets the value(s) for additiveType ()
`NutritionOrder.EnteralFormula`	`setAdministration(List<NutritionOrder.EnteralFormulaAdministration> theValue)` Sets the value(s) for administration ()
`NutritionOrder.EnteralFormula`	`setAdministrationInstruction(String theString)` Sets the value for administrationInstruction ()
`NutritionOrder.EnteralFormula`	`setAdministrationInstruction(StringDt theValue)` Sets the value(s) for administrationInstruction ()
`NutritionOrder.EnteralFormula`	`setBaseFormulaProductName(String theString)` Sets the value for baseFormulaProductName ()
`NutritionOrder.EnteralFormula`	`setBaseFormulaProductName(StringDt theValue)` Sets the value(s) for baseFormulaProductName ()
`NutritionOrder.EnteralFormula`	`setBaseFormulaType(BoundCodeableConceptDt<EnteralFormulaTypeCodesEnum> theValue)` Sets the value(s) for baseFormulaType ()
`NutritionOrder.EnteralFormula`	`setBaseFormulaType(EnteralFormulaTypeCodesEnum theValue)` Sets the value(s) for baseFormulaType ()
`NutritionOrder.EnteralFormula`	`setCaloricDensity(SimpleQuantityDt theValue)` Sets the value(s) for caloricDensity ()
`NutritionOrder.EnteralFormula`	`setMaxVolumeToDeliver(SimpleQuantityDt theValue)` Sets the value(s) for maxVolumeToDeliver ()
`NutritionOrder.EnteralFormula`	`setRouteofAdministration(CodeableConceptDt theValue)` Sets the value(s) for routeofAdministration ()

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement
getElementSpecificId, getId, setElementSpecificId, setId, setId

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, isBaseEmpty

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IIdentifiableElement
getElementSpecificId, getId, setElementSpecificId, setId, setId

- Constructor Detail
  - EnteralFormula
```
public EnteralFormula()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
  - getBaseFormulaType
```
public BoundCodeableConceptDt<EnteralFormulaTypeCodesEnum> getBaseFormulaType()
```
    Gets the value(s) for baseFormulaType (). creating it if it does not exist. Will not return null.
    Definition: The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula.
  - setBaseFormulaType
```
public NutritionOrder.EnteralFormula setBaseFormulaType(BoundCodeableConceptDt<EnteralFormulaTypeCodesEnum> theValue)
```
    Sets the value(s) for baseFormulaType ()
    Definition: The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula.
  - setBaseFormulaType
```
public NutritionOrder.EnteralFormula setBaseFormulaType(EnteralFormulaTypeCodesEnum theValue)
```
    Sets the value(s) for baseFormulaType ()
    Definition: The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula.
  - getBaseFormulaProductNameElement
```
public StringDt getBaseFormulaProductNameElement()
```
    Gets the value(s) for baseFormulaProductName (). creating it if it does not exist. Will not return null.
    Definition: The product or brand name of the enteral or infant formula product such as \"ACME Adult Standard Formula\".
  - getBaseFormulaProductName
```
public String getBaseFormulaProductName()
```
    Gets the value(s) for baseFormulaProductName (). creating it if it does not exist. Will not return null.
    Definition: The product or brand name of the enteral or infant formula product such as \"ACME Adult Standard Formula\".
  - setBaseFormulaProductName
```
public NutritionOrder.EnteralFormula setBaseFormulaProductName(StringDt theValue)
```
    Sets the value(s) for baseFormulaProductName ()
    Definition: The product or brand name of the enteral or infant formula product such as \"ACME Adult Standard Formula\".
  - setBaseFormulaProductName
```
public NutritionOrder.EnteralFormula setBaseFormulaProductName(String theString)
```
    Sets the value for baseFormulaProductName ()
    Definition: The product or brand name of the enteral or infant formula product such as \"ACME Adult Standard Formula\".
  - getAdditiveType
```
public CodeableConceptDt getAdditiveType()
```
    Gets the value(s) for additiveType (). creating it if it does not exist. Will not return null.
    Definition: 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.
  - setAdditiveType
```
public NutritionOrder.EnteralFormula setAdditiveType(CodeableConceptDt theValue)
```
    Sets the value(s) for additiveType ()
    Definition: 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.
  - getAdditiveProductNameElement
```
public StringDt getAdditiveProductNameElement()
```
    Gets the value(s) for additiveProductName (). creating it if it does not exist. Will not return null.
    Definition: The product or brand name of the type of modular component to be added to the formula.
  - getAdditiveProductName
```
public String getAdditiveProductName()
```
    Gets the value(s) for additiveProductName (). creating it if it does not exist. Will not return null.
    Definition: The product or brand name of the type of modular component to be added to the formula.
  - setAdditiveProductName
```
public NutritionOrder.EnteralFormula setAdditiveProductName(StringDt theValue)
```
    Sets the value(s) for additiveProductName ()
    Definition: The product or brand name of the type of modular component to be added to the formula.
  - setAdditiveProductName
```
public NutritionOrder.EnteralFormula setAdditiveProductName(String theString)
```
    Sets the value for additiveProductName ()
    Definition: The product or brand name of the type of modular component to be added to the formula.
  - getCaloricDensity
```
public SimpleQuantityDt getCaloricDensity()
```
    Gets the value(s) for caloricDensity (). creating it if it does not exist. Will not return null.
    Definition: 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.
  - setCaloricDensity
```
public NutritionOrder.EnteralFormula setCaloricDensity(SimpleQuantityDt theValue)
```
    Sets the value(s) for caloricDensity ()
    Definition: 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.
  - getRouteofAdministration
```
public CodeableConceptDt getRouteofAdministration()
```
    Gets the value(s) for routeofAdministration (). creating it if it does not exist. Will not return null.
    Definition: The route or physiological path of administration into the patient's gastrointestinal tract for purposes of providing the formula feeding, e.g. nasogastric tube.
  - setRouteofAdministration
```
public NutritionOrder.EnteralFormula setRouteofAdministration(CodeableConceptDt theValue)
```
    Sets the value(s) for routeofAdministration ()
    Definition: The route or physiological path of administration into the patient's gastrointestinal tract for purposes of providing the formula feeding, e.g. nasogastric tube.
  - getAdministration
```
public List<NutritionOrder.EnteralFormulaAdministration> getAdministration()
```
    Gets the value(s) for administration (). creating it if it does not exist. Will not return null.
    Definition: 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.
  - setAdministration
```
public NutritionOrder.EnteralFormula setAdministration(List<NutritionOrder.EnteralFormulaAdministration> theValue)
```
    Sets the value(s) for administration ()
    Definition: 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.
  - addAdministration
```
public NutritionOrder.EnteralFormulaAdministration addAdministration()
```
    Adds and returns a new value for administration ()
    Definition: 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.
  - addAdministration
```
public NutritionOrder.EnteralFormula addAdministration(NutritionOrder.EnteralFormulaAdministration theValue)
```
    Adds a given new value for administration ()
    Definition: 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.
    
    Parameters:
    
    theValue - The administration to add (must not be null)
  - getAdministrationFirstRep
```
public NutritionOrder.EnteralFormulaAdministration getAdministrationFirstRep()
```
    Gets the first repetition for administration (), creating it if it does not already exist.
    Definition: 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.
  - getMaxVolumeToDeliver
```
public SimpleQuantityDt getMaxVolumeToDeliver()
```
    Gets the value(s) for maxVolumeToDeliver (). creating it if it does not exist. Will not return null.
    Definition: 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.
  - setMaxVolumeToDeliver
```
public NutritionOrder.EnteralFormula setMaxVolumeToDeliver(SimpleQuantityDt theValue)
```
    Sets the value(s) for maxVolumeToDeliver ()
    Definition: 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.
  - getAdministrationInstructionElement
```
public StringDt getAdministrationInstructionElement()
```
    Gets the value(s) for administrationInstruction (). creating it if it does not exist. Will not return null.
    Definition: Free text formula administration, feeding instructions or additional instructions or information.
  - getAdministrationInstruction
```
public String getAdministrationInstruction()
```
    Gets the value(s) for administrationInstruction (). creating it if it does not exist. Will not return null.
    Definition: Free text formula administration, feeding instructions or additional instructions or information.
  - setAdministrationInstruction
```
public NutritionOrder.EnteralFormula setAdministrationInstruction(StringDt theValue)
```
    Sets the value(s) for administrationInstruction ()
    Definition: Free text formula administration, feeding instructions or additional instructions or information.
  - setAdministrationInstruction
```
public NutritionOrder.EnteralFormula setAdministrationInstruction(String theString)
```
    Sets the value for administrationInstruction ()
    Definition: Free text formula administration, feeding instructions or additional instructions or information.

Class NutritionOrder.EnteralFormula

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IIdentifiableElement

Constructor Detail

EnteralFormula

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getBaseFormulaType

setBaseFormulaType

setBaseFormulaType

getBaseFormulaProductNameElement

getBaseFormulaProductName

setBaseFormulaProductName

setBaseFormulaProductName

getAdditiveType

setAdditiveType

getAdditiveProductNameElement

getAdditiveProductName

setAdditiveProductName

setAdditiveProductName

getCaloricDensity

setCaloricDensity

getRouteofAdministration

setRouteofAdministration

getAdministration

setAdministration

addAdministration

addAdministration

getAdministrationFirstRep

getMaxVolumeToDeliver

setMaxVolumeToDeliver

getAdministrationInstructionElement

getAdministrationInstruction

setAdministrationInstruction

setAdministrationInstruction