
Package org.hl7.fhir.dstu3.model
Class NutritionOrder.NutritionOrderEnteralFormulaComponent
- java.lang.Object
-
- org.hl7.fhir.dstu3.model.Base
-
- org.hl7.fhir.dstu3.model.Element
-
- org.hl7.fhir.dstu3.model.BackboneElement
-
- org.hl7.fhir.dstu3.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:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected StringType
additiveProductName
The product or brand name of the type of modular component to be added to the formula.protected 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.protected List<NutritionOrder.NutritionOrderEnteralFormulaAdministrationComponent>
administration
Formula administration instructions as structured data.protected StringType
administrationInstruction
Free text formula administration, feeding instructions or additional instructions or information.protected StringType
baseFormulaProductName
The product or brand name of the enteral or infant formula product such as "ACME Adult Standard Formula".protected CodeableConcept
baseFormulaType
The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula.protected SimpleQuantity
caloricDensity
The amount of energy (calories) that the formula should provide per specified volume, typically per mL or fluid oz.protected SimpleQuantity
maxVolumeToDeliver
The maximum total quantity of formula that may be administered to a subject over the period of time, e.g.protected CodeableConcept
routeofAdministration
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.dstu3.model.BackboneElement
modifierExtension
-
-
Constructor Summary
Constructors Constructor Description NutritionOrderEnteralFormulaComponent()
Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu3.model.BackboneElement
addModifierExtension, addModifierExtension, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtension
-
Methods inherited from class org.hl7.fhir.dstu3.model.Element
addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setExtension, setId, setIdBase, setIdElement
-
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, 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
-
-
-
-
Field Detail
-
baseFormulaType
protected CodeableConcept baseFormulaType
The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula.
-
baseFormulaProductName
protected StringType baseFormulaProductName
The product or brand name of the enteral or infant formula product such as "ACME Adult Standard Formula".
-
additiveType
protected 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.
-
additiveProductName
protected StringType additiveProductName
The product or brand name of the type of modular component to be added to the formula.
-
caloricDensity
protected 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.
-
routeofAdministration
protected 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.
-
administration
protected List<NutritionOrder.NutritionOrderEnteralFormulaAdministrationComponent> 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
protected 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.
-
administrationInstruction
protected StringType administrationInstruction
Free text formula administration, feeding instructions or additional instructions or information.
-
-
Constructor Detail
-
NutritionOrderEnteralFormulaComponent
public NutritionOrderEnteralFormulaComponent()
Constructor
-
-
Method Detail
-
getBaseFormulaType
public CodeableConcept 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
public boolean 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
public StringType 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
public boolean hasBaseFormulaProductNameElement()
-
hasBaseFormulaProductName
public boolean 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
public String getBaseFormulaProductName()
- Returns:
- The product or brand name of the enteral or infant formula product such as "ACME Adult Standard Formula".
-
setBaseFormulaProductName
public NutritionOrder.NutritionOrderEnteralFormulaComponent setBaseFormulaProductName(String value)
- Parameters:
value
- The product or brand name of the enteral or infant formula product such as "ACME Adult Standard Formula".
-
getAdditiveType
public CodeableConcept 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
public boolean hasAdditiveType()
-
setAdditiveType
public NutritionOrder.NutritionOrderEnteralFormulaComponent setAdditiveType(CodeableConcept value)
- 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
public StringType 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
public boolean hasAdditiveProductNameElement()
-
hasAdditiveProductName
public boolean 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
public String getAdditiveProductName()
- Returns:
- The product or brand name of the type of modular component to be added to the formula.
-
setAdditiveProductName
public NutritionOrder.NutritionOrderEnteralFormulaComponent setAdditiveProductName(String value)
- Parameters:
value
- The product or brand name of the type of modular component to be added to the formula.
-
getCaloricDensity
public SimpleQuantity 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
public boolean hasCaloricDensity()
-
setCaloricDensity
public NutritionOrder.NutritionOrderEnteralFormulaComponent setCaloricDensity(SimpleQuantity value)
- 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
public CodeableConcept 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
public boolean 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
public List<NutritionOrder.NutritionOrderEnteralFormulaAdministrationComponent> 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
public boolean hasAdministration()
-
addAdministration
public NutritionOrder.NutritionOrderEnteralFormulaAdministrationComponent addAdministration()
-
addAdministration
public NutritionOrder.NutritionOrderEnteralFormulaComponent addAdministration(NutritionOrder.NutritionOrderEnteralFormulaAdministrationComponent t)
-
getAdministrationFirstRep
public NutritionOrder.NutritionOrderEnteralFormulaAdministrationComponent getAdministrationFirstRep()
- Returns:
- The first repetition of repeating field
administration
, creating it if it does not already exist
-
getMaxVolumeToDeliver
public SimpleQuantity 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
public boolean hasMaxVolumeToDeliver()
-
setMaxVolumeToDeliver
public NutritionOrder.NutritionOrderEnteralFormulaComponent setMaxVolumeToDeliver(SimpleQuantity value)
- 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
public StringType 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
public boolean hasAdministrationInstructionElement()
-
hasAdministrationInstruction
public boolean 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
public String 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
protected void listChildren(List<Property> children)
- 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
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- 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
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChild
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
copy
public NutritionOrder.NutritionOrderEnteralFormulaComponent copy()
- Specified by:
copy
in classBackboneElement
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeep
in classBackboneElement
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallow
in classBackboneElement
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classBackboneElement
-
fhirType
public String fhirType()
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classBackboneElement
-
-