Class NutritionOrder.EnteralFormula.Builder
- java.lang.Object
-
- org.linuxforhealth.fhir.model.builder.AbstractBuilder<Element>
-
- org.linuxforhealth.fhir.model.type.Element.Builder
-
- org.linuxforhealth.fhir.model.type.BackboneElement.Builder
-
- org.linuxforhealth.fhir.model.resource.NutritionOrder.EnteralFormula.Builder
-
- Enclosing class:
- NutritionOrder.EnteralFormula
public static class NutritionOrder.EnteralFormula.Builder extends BackboneElement.Builder
-
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.type.BackboneElement.Builder
modifierExtension
-
Fields inherited from class org.linuxforhealth.fhir.model.type.Element.Builder
extension, id
-
Fields inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
validating
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NutritionOrder.EnteralFormula.Builder
additiveProductName(java.lang.String additiveProductName)
Convenience method for settingadditiveProductName
.NutritionOrder.EnteralFormula.Builder
additiveProductName(String additiveProductName)
The product or brand name of the type of modular component to be added to the formula.NutritionOrder.EnteralFormula.Builder
additiveType(CodeableConcept additiveType)
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.NutritionOrder.EnteralFormula.Builder
administration(java.util.Collection<NutritionOrder.EnteralFormula.Administration> administration)
Formula administration instructions as structured data.NutritionOrder.EnteralFormula.Builder
administration(NutritionOrder.EnteralFormula.Administration... administration)
Formula administration instructions as structured data.NutritionOrder.EnteralFormula.Builder
administrationInstruction(java.lang.String administrationInstruction)
Convenience method for settingadministrationInstruction
.NutritionOrder.EnteralFormula.Builder
administrationInstruction(String administrationInstruction)
Free text formula administration, feeding instructions or additional instructions or information.NutritionOrder.EnteralFormula.Builder
baseFormulaProductName(java.lang.String baseFormulaProductName)
Convenience method for settingbaseFormulaProductName
.NutritionOrder.EnteralFormula.Builder
baseFormulaProductName(String baseFormulaProductName)
The product or brand name of the enteral or infant formula product such as "ACME Adult Standard Formula".NutritionOrder.EnteralFormula.Builder
baseFormulaType(CodeableConcept baseFormulaType)
The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula.NutritionOrder.EnteralFormula
build()
Build theNutritionOrder.EnteralFormula
NutritionOrder.EnteralFormula.Builder
caloricDensity(SimpleQuantity caloricDensity)
The amount of energy (calories) that the formula should provide per specified volume, typically per mL or fluid oz.NutritionOrder.EnteralFormula.Builder
extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the element.NutritionOrder.EnteralFormula.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.protected NutritionOrder.EnteralFormula.Builder
from(NutritionOrder.EnteralFormula enteralFormula)
NutritionOrder.EnteralFormula.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).NutritionOrder.EnteralFormula.Builder
maxVolumeToDeliver(SimpleQuantity maxVolumeToDeliver)
The maximum total quantity of formula that may be administered to a subject over the period of time, e.g.NutritionOrder.EnteralFormula.Builder
modifierExtension(java.util.Collection<Extension> modifierExtension)
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.NutritionOrder.EnteralFormula.Builder
modifierExtension(Extension... modifierExtension)
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.NutritionOrder.EnteralFormula.Builder
routeofAdministration(CodeableConcept routeofAdministration)
The route or physiological path of administration into the patient's gastrointestinal tract for purposes of providing the formula feeding, e.g.protected void
validate(NutritionOrder.EnteralFormula enteralFormula)
-
Methods inherited from class org.linuxforhealth.fhir.model.type.BackboneElement.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.type.Element.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
isValidating, setValidating
-
-
-
-
Method Detail
-
id
public NutritionOrder.EnteralFormula.Builder id(java.lang.String id)
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.- Overrides:
id
in classBackboneElement.Builder
- Parameters:
id
- Unique id for inter-element referencing- Returns:
- A reference to this Builder instance
-
extension
public NutritionOrder.EnteralFormula.Builder extension(Extension... extension)
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.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classBackboneElement.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public NutritionOrder.EnteralFormula.Builder extension(java.util.Collection<Extension> extension)
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.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classBackboneElement.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
modifierExtension
public NutritionOrder.EnteralFormula.Builder modifierExtension(Extension... modifierExtension)
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).
Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classBackboneElement.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored even if unrecognized- Returns:
- A reference to this Builder instance
-
modifierExtension
public NutritionOrder.EnteralFormula.Builder modifierExtension(java.util.Collection<Extension> modifierExtension)
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).
Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classBackboneElement.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored even if unrecognized- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
baseFormulaType
public NutritionOrder.EnteralFormula.Builder baseFormulaType(CodeableConcept baseFormulaType)
The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula.- Parameters:
baseFormulaType
- Type of enteral or infant formula- Returns:
- A reference to this Builder instance
-
baseFormulaProductName
public NutritionOrder.EnteralFormula.Builder baseFormulaProductName(java.lang.String baseFormulaProductName)
Convenience method for settingbaseFormulaProductName
.- Parameters:
baseFormulaProductName
- Product or brand name of the enteral or infant formula- Returns:
- A reference to this Builder instance
- See Also:
baseFormulaProductName(org.linuxforhealth.fhir.model.type.String)
-
baseFormulaProductName
public NutritionOrder.EnteralFormula.Builder baseFormulaProductName(String baseFormulaProductName)
The product or brand name of the enteral or infant formula product such as "ACME Adult Standard Formula".- Parameters:
baseFormulaProductName
- Product or brand name of the enteral or infant formula- Returns:
- A reference to this Builder instance
-
additiveType
public NutritionOrder.EnteralFormula.Builder additiveType(CodeableConcept additiveType)
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.- Parameters:
additiveType
- Type of modular component to add to the feeding- Returns:
- A reference to this Builder instance
-
additiveProductName
public NutritionOrder.EnteralFormula.Builder additiveProductName(java.lang.String additiveProductName)
Convenience method for settingadditiveProductName
.- Parameters:
additiveProductName
- Product or brand name of the modular additive- Returns:
- A reference to this Builder instance
- See Also:
additiveProductName(org.linuxforhealth.fhir.model.type.String)
-
additiveProductName
public NutritionOrder.EnteralFormula.Builder additiveProductName(String additiveProductName)
The product or brand name of the type of modular component to be added to the formula.- Parameters:
additiveProductName
- Product or brand name of the modular additive- Returns:
- A reference to this Builder instance
-
caloricDensity
public NutritionOrder.EnteralFormula.Builder caloricDensity(SimpleQuantity caloricDensity)
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.- Parameters:
caloricDensity
- Amount of energy per specified volume that is required- Returns:
- A reference to this Builder instance
-
routeofAdministration
public NutritionOrder.EnteralFormula.Builder routeofAdministration(CodeableConcept routeofAdministration)
The route or physiological path of administration into the patient's gastrointestinal tract for purposes of providing the formula feeding, e.g. nasogastric tube.- Parameters:
routeofAdministration
- How the formula should enter the patient's gastrointestinal tract- Returns:
- A reference to this Builder instance
-
administration
public NutritionOrder.EnteralFormula.Builder administration(NutritionOrder.EnteralFormula.Administration... administration)
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.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
administration
- Formula feeding instruction as structured data- Returns:
- A reference to this Builder instance
-
administration
public NutritionOrder.EnteralFormula.Builder administration(java.util.Collection<NutritionOrder.EnteralFormula.Administration> administration)
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.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
administration
- Formula feeding instruction as structured data- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
maxVolumeToDeliver
public NutritionOrder.EnteralFormula.Builder maxVolumeToDeliver(SimpleQuantity maxVolumeToDeliver)
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.- Parameters:
maxVolumeToDeliver
- Upper limit on formula volume per unit of time- Returns:
- A reference to this Builder instance
-
administrationInstruction
public NutritionOrder.EnteralFormula.Builder administrationInstruction(java.lang.String administrationInstruction)
Convenience method for settingadministrationInstruction
.- Parameters:
administrationInstruction
- Formula feeding instructions expressed as text- Returns:
- A reference to this Builder instance
- See Also:
administrationInstruction(org.linuxforhealth.fhir.model.type.String)
-
administrationInstruction
public NutritionOrder.EnteralFormula.Builder administrationInstruction(String administrationInstruction)
Free text formula administration, feeding instructions or additional instructions or information.- Parameters:
administrationInstruction
- Formula feeding instructions expressed as text- Returns:
- A reference to this Builder instance
-
build
public NutritionOrder.EnteralFormula build()
Build theNutritionOrder.EnteralFormula
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
NutritionOrder.EnteralFormula
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid EnteralFormula per the base specification
-
validate
protected void validate(NutritionOrder.EnteralFormula enteralFormula)
-
from
protected NutritionOrder.EnteralFormula.Builder from(NutritionOrder.EnteralFormula enteralFormula)
-
-