Package org.hl7.fhir.r4.model
Class NutritionOrder.NutritionOrderEnteralFormulaComponent
java.lang.Object
org.hl7.fhir.r4.model.Base
org.hl7.fhir.r4.model.Element
org.hl7.fhir.r4.model.BackboneElement
org.hl7.fhir.r4.model.NutritionOrder.NutritionOrderEnteralFormulaComponent
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement
,Serializable
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseBackboneElement
,org.hl7.fhir.instance.model.api.IBaseElement
,org.hl7.fhir.instance.model.api.IBaseHasExtensions
,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
- Enclosing class:
NutritionOrder
public static class NutritionOrder.NutritionOrderEnteralFormulaComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected StringType
The product or brand name of the type of modular component to be added to the formula.protected 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.Formula administration instructions as structured data.protected StringType
Free text formula administration, feeding instructions or additional instructions or information.protected StringType
The product or brand name of the enteral or infant formula product such as "ACME Adult Standard Formula".protected CodeableConcept
The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula.protected Quantity
The amount of energy (calories) that the formula should provide per specified volume, typically per mL or fluid oz.protected Quantity
The maximum total quantity of formula that may be administered to a subject over the period of time, e.g.protected CodeableConcept
The route or physiological path of administration into the patient's gastrointestinal tract for purposes of providing the formula feeding, e.g.Fields inherited from class org.hl7.fhir.r4.model.BackboneElement
modifierExtension
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptioncopy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setAdditiveProductName
(String value) setAdditiveType
(CodeableConcept value) setAdministration
(List<NutritionOrder.NutritionOrderEnteralFormulaAdministrationComponent> theAdministration) setBaseFormulaProductName
(String value) setCaloricDensity
(Quantity value) setMaxVolumeToDeliver
(Quantity value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) Methods inherited from class org.hl7.fhir.r4.model.BackboneElement
addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyExtensions, copyNewExtensions, copyValues, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, removeExtension, setModifierExtension
Methods inherited from class org.hl7.fhir.r4.model.Element
addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionFirstRep, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement
getUserData, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions
addExtension, getExtension, hasExtension
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
addModifierExtension, getModifierExtension, hasModifierExtension
-
Field Details
-
baseFormulaType
The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula. -
baseFormulaProductName
The product or brand name of the enteral or infant formula product such as "ACME Adult Standard Formula". -
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. -
additiveProductName
The product or brand name of the type of modular component to be added to the formula. -
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. -
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. -
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. -
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. -
administrationInstruction
Free text formula administration, feeding instructions or additional instructions or information.
-
-
Constructor Details
-
NutritionOrderEnteralFormulaComponent
Constructor
-
-
Method Details
-
getBaseFormulaType
- Returns:
baseFormulaType
(The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula.)
-
hasBaseFormulaType
-
setBaseFormulaType
public NutritionOrder.NutritionOrderEnteralFormulaComponent setBaseFormulaType(CodeableConcept value) - Parameters:
value
-baseFormulaType
(The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula.)
-
getBaseFormulaProductNameElement
- Returns:
baseFormulaProductName
(The product or brand name of the enteral or infant formula product such as "ACME Adult Standard Formula".). This is the underlying object with id, value and extensions. The accessor "getBaseFormulaProductName" gives direct access to the value
-
hasBaseFormulaProductNameElement
-
hasBaseFormulaProductName
-
setBaseFormulaProductNameElement
public NutritionOrder.NutritionOrderEnteralFormulaComponent setBaseFormulaProductNameElement(StringType value) - Parameters:
value
-baseFormulaProductName
(The product or brand name of the enteral or infant formula product such as "ACME Adult Standard Formula".). This is the underlying object with id, value and extensions. The accessor "getBaseFormulaProductName" gives direct access to the value
-
getBaseFormulaProductName
- Returns:
- The product or brand name of the enteral or infant formula product such as "ACME Adult Standard Formula".
-
setBaseFormulaProductName
- Parameters:
value
- The product or brand name of the enteral or infant formula product such as "ACME Adult Standard Formula".
-
getAdditiveType
- Returns:
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.)
-
hasAdditiveType
-
setAdditiveType
- Parameters:
value
-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.)
-
getAdditiveProductNameElement
- Returns:
additiveProductName
(The product or brand name of the type of modular component to be added to the formula.). This is the underlying object with id, value and extensions. The accessor "getAdditiveProductName" gives direct access to the value
-
hasAdditiveProductNameElement
-
hasAdditiveProductName
-
setAdditiveProductNameElement
public NutritionOrder.NutritionOrderEnteralFormulaComponent setAdditiveProductNameElement(StringType value) - Parameters:
value
-additiveProductName
(The product or brand name of the type of modular component to be added to the formula.). This is the underlying object with id, value and extensions. The accessor "getAdditiveProductName" gives direct access to the value
-
getAdditiveProductName
- Returns:
- The product or brand name of the type of modular component to be added to the formula.
-
setAdditiveProductName
- Parameters:
value
- The product or brand name of the type of modular component to be added to the formula.
-
getCaloricDensity
- Returns:
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.)
-
hasCaloricDensity
-
setCaloricDensity
- Parameters:
value
-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.)
-
getRouteofAdministration
- Returns:
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.)
-
hasRouteofAdministration
-
setRouteofAdministration
public NutritionOrder.NutritionOrderEnteralFormulaComponent setRouteofAdministration(CodeableConcept value) - Parameters:
value
-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.)
-
getAdministration
- Returns:
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.)
-
setAdministration
public NutritionOrder.NutritionOrderEnteralFormulaComponent setAdministration(List<NutritionOrder.NutritionOrderEnteralFormulaAdministrationComponent> theAdministration) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasAdministration
-
addAdministration
-
addAdministration
-
getAdministrationFirstRep
public NutritionOrder.NutritionOrderEnteralFormulaAdministrationComponent getAdministrationFirstRep()- Returns:
- The first repetition of repeating field
administration
, creating it if it does not already exist
-
getMaxVolumeToDeliver
- Returns:
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.)
-
hasMaxVolumeToDeliver
-
setMaxVolumeToDeliver
- Parameters:
value
-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.)
-
getAdministrationInstructionElement
- Returns:
administrationInstruction
(Free text formula administration, feeding instructions or additional instructions or information.). This is the underlying object with id, value and extensions. The accessor "getAdministrationInstruction" gives direct access to the value
-
hasAdministrationInstructionElement
-
hasAdministrationInstruction
-
setAdministrationInstructionElement
public NutritionOrder.NutritionOrderEnteralFormulaComponent setAdministrationInstructionElement(StringType value) - Parameters:
value
-administrationInstruction
(Free text formula administration, feeding instructions or additional instructions or information.). This is the underlying object with id, value and extensions. The accessor "getAdministrationInstruction" gives direct access to the value
-
getAdministrationInstruction
- Returns:
- Free text formula administration, feeding instructions or additional instructions or information.
-
setAdministrationInstruction
public NutritionOrder.NutritionOrderEnteralFormulaComponent setAdministrationInstruction(String value) - Parameters:
value
- Free text formula administration, feeding instructions or additional instructions or information.
-
listChildren
- Overrides:
listChildren
in classBackboneElement
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
copy
- Specified by:
copy
in classBackboneElement
-
copyValues
-
equalsDeep
- Overrides:
equalsDeep
in classBackboneElement
-
equalsShallow
- Overrides:
equalsShallow
in classBackboneElement
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classBackboneElement
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classBackboneElement
-