Package com.ibm.fhir.model.resource
Class NutritionOrder.EnteralFormula
- java.lang.Object
-
- com.ibm.fhir.model.visitor.AbstractVisitable
-
- com.ibm.fhir.model.type.Element
-
- com.ibm.fhir.model.type.BackboneElement
-
- com.ibm.fhir.model.resource.NutritionOrder.EnteralFormula
-
- All Implemented Interfaces:
Visitable
- Enclosing class:
- NutritionOrder
public static class NutritionOrder.EnteralFormula extends BackboneElement
Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classNutritionOrder.EnteralFormula.AdministrationFormula administration instructions as structured data.static classNutritionOrder.EnteralFormula.Builder
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.type.BackboneElement
modifierExtension
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(String elementName, int elementIndex, Visitor visitor)Accept a Visitor and invoke the appropriate visit methods.static NutritionOrder.EnteralFormula.Builderbuilder()booleanequals(Object obj)StringgetAdditiveProductName()The product or brand name of the type of modular component to be added to the formula.CodeableConceptgetAdditiveType()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.List<NutritionOrder.EnteralFormula.Administration>getAdministration()Formula administration instructions as structured data.StringgetAdministrationInstruction()Free text formula administration, feeding instructions or additional instructions or information.StringgetBaseFormulaProductName()The product or brand name of the enteral or infant formula product such as "ACME Adult Standard Formula".CodeableConceptgetBaseFormulaType()The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula.SimpleQuantitygetCaloricDensity()The amount of energy (calories) that the formula should provide per specified volume, typically per mL or fluid oz.SimpleQuantitygetMaxVolumeToDeliver()The maximum total quantity of formula that may be administered to a subject over the period of time, e.g.CodeableConceptgetRouteofAdministration()The route or physiological path of administration into the patient's gastrointestinal tract for purposes of providing the formula feeding, e.g.booleanhasChildren()inthashCode()NutritionOrder.EnteralFormula.BuildertoBuilder()Create a new Builder from the contents of this Element-
Methods inherited from class com.ibm.fhir.model.type.BackboneElement
getModifierExtension
-
-
-
-
Method Detail
-
getBaseFormulaType
public CodeableConcept getBaseFormulaType()
The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula.- Returns:
- An immutable object of type
CodeableConceptthat may be null.
-
getBaseFormulaProductName
public String getBaseFormulaProductName()
The product or brand name of the enteral or infant formula product such as "ACME Adult Standard Formula".- Returns:
- An immutable object of type
Stringthat may be null.
-
getAdditiveType
public CodeableConcept getAdditiveType()
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.- Returns:
- An immutable object of type
CodeableConceptthat may be null.
-
getAdditiveProductName
public String getAdditiveProductName()
The product or brand name of the type of modular component to be added to the formula.- Returns:
- An immutable object of type
Stringthat may be null.
-
getCaloricDensity
public SimpleQuantity getCaloricDensity()
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.- Returns:
- An immutable object of type
SimpleQuantitythat may be null.
-
getRouteofAdministration
public CodeableConcept getRouteofAdministration()
The route or physiological path of administration into the patient's gastrointestinal tract for purposes of providing the formula feeding, e.g. nasogastric tube.- Returns:
- An immutable object of type
CodeableConceptthat may be null.
-
getAdministration
public List<NutritionOrder.EnteralFormula.Administration> getAdministration()
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.- Returns:
- An unmodifiable list containing immutable objects of type
NutritionOrder.EnteralFormula.Administrationthat may be empty.
-
getMaxVolumeToDeliver
public SimpleQuantity getMaxVolumeToDeliver()
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.- Returns:
- An immutable object of type
SimpleQuantitythat may be null.
-
getAdministrationInstruction
public String getAdministrationInstruction()
Free text formula administration, feeding instructions or additional instructions or information.- Returns:
- An immutable object of type
Stringthat may be null.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildrenin classBackboneElement
-
accept
public void accept(String elementName, int elementIndex, Visitor visitor)
Description copied from interface:VisitableAccept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }- Specified by:
acceptin interfaceVisitable- Specified by:
acceptin classAbstractVisitable- Parameters:
elementName- the name of the element in the context of this visitelementIndex- the index of the element in a list or -1 if it is not contained within a Listvisitor- the visitor to use
-
toBuilder
public NutritionOrder.EnteralFormula.Builder toBuilder()
Description copied from class:ElementCreate a new Builder from the contents of this Element- Specified by:
toBuilderin classBackboneElement
-
builder
public static NutritionOrder.EnteralFormula.Builder builder()
-
-