Package org.hl7.fhir.r5.model

Class NutritionOrder.NutritionOrderEnteralFormulaComponent

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.BackboneElement

org.hl7.fhir.r5.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

Nested Class Summary

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected List<NutritionOrder.NutritionOrderEnteralFormulaAdditiveComponent>	additive	Indicates modular components to be provided in addition or mixed with the base formula.
protected List<NutritionOrder.NutritionOrderEnteralFormulaAdministrationComponent>	administration	Formula administration instructions as structured data.
protected MarkdownType	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 CodeableReference	baseFormulaType	The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula.
protected Quantity	caloricDensity	The amount of energy (calories) that the formula should provide per specified volume, typically per mL or fluid oz.
protected List<CodeableReference>	deliveryDevice	The intended type of device that is to be used for the administration of the enteral formula.
protected Quantity	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.r5.model.BackboneElement

modifierExtension

Fields inherited from class org.hl7.fhir.r5.model.Element

extension, id

Constructor Summary

Constructors

Constructor	Description
NutritionOrderEnteralFormulaComponent()	Constructor

Method Summary

Modifier and Type	Method	Description
NutritionOrder.NutritionOrderEnteralFormulaAdditiveComponent	addAdditive()
NutritionOrder.NutritionOrderEnteralFormulaComponent	addAdditive(NutritionOrder.NutritionOrderEnteralFormulaAdditiveComponent t)
NutritionOrder.NutritionOrderEnteralFormulaAdministrationComponent	addAdministration()
NutritionOrder.NutritionOrderEnteralFormulaComponent	addAdministration(NutritionOrder.NutritionOrderEnteralFormulaAdministrationComponent t)
Base	addChild(String name)
CodeableReference	addDeliveryDevice()
NutritionOrder.NutritionOrderEnteralFormulaComponent	addDeliveryDevice(CodeableReference t)
NutritionOrder.NutritionOrderEnteralFormulaComponent	copy()
void	copyValues(NutritionOrder.NutritionOrderEnteralFormulaComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<NutritionOrder.NutritionOrderEnteralFormulaAdditiveComponent>	getAdditive()
NutritionOrder.NutritionOrderEnteralFormulaAdditiveComponent	getAdditiveFirstRep()
List<NutritionOrder.NutritionOrderEnteralFormulaAdministrationComponent>	getAdministration()
NutritionOrder.NutritionOrderEnteralFormulaAdministrationComponent	getAdministrationFirstRep()
String	getAdministrationInstruction()
MarkdownType	getAdministrationInstructionElement()
String	getBaseFormulaProductName()
StringType	getBaseFormulaProductNameElement()
CodeableReference	getBaseFormulaType()
Quantity	getCaloricDensity()
List<CodeableReference>	getDeliveryDevice()
CodeableReference	getDeliveryDeviceFirstRep()
Quantity	getMaxVolumeToDeliver()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
CodeableConcept	getRouteOfAdministration()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAdditive()
boolean	hasAdministration()
boolean	hasAdministrationInstruction()
boolean	hasAdministrationInstructionElement()
boolean	hasBaseFormulaProductName()
boolean	hasBaseFormulaProductNameElement()
boolean	hasBaseFormulaType()
boolean	hasCaloricDensity()
boolean	hasDeliveryDevice()
boolean	hasMaxVolumeToDeliver()
boolean	hasRouteOfAdministration()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
NutritionOrder.NutritionOrderEnteralFormulaComponent	setAdditive(List<NutritionOrder.NutritionOrderEnteralFormulaAdditiveComponent> theAdditive)
NutritionOrder.NutritionOrderEnteralFormulaComponent	setAdministration(List<NutritionOrder.NutritionOrderEnteralFormulaAdministrationComponent> theAdministration)
NutritionOrder.NutritionOrderEnteralFormulaComponent	setAdministrationInstruction(String value)
NutritionOrder.NutritionOrderEnteralFormulaComponent	setAdministrationInstructionElement(MarkdownType value)
NutritionOrder.NutritionOrderEnteralFormulaComponent	setBaseFormulaProductName(String value)
NutritionOrder.NutritionOrderEnteralFormulaComponent	setBaseFormulaProductNameElement(StringType value)
NutritionOrder.NutritionOrderEnteralFormulaComponent	setBaseFormulaType(CodeableReference value)
NutritionOrder.NutritionOrderEnteralFormulaComponent	setCaloricDensity(Quantity value)
NutritionOrder.NutritionOrderEnteralFormulaComponent	setDeliveryDevice(List<CodeableReference> theDeliveryDevice)
NutritionOrder.NutritionOrderEnteralFormulaComponent	setMaxVolumeToDeliver(Quantity value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
NutritionOrder.NutritionOrderEnteralFormulaComponent	setRouteOfAdministration(CodeableConcept value)

Methods inherited from class org.hl7.fhir.r5.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.r5.model.Element

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionFirstRep, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus

Methods inherited from class org.hl7.fhir.r5.model.Base

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, 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

protected CodeableReference 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".

deliveryDevice

protected List<CodeableReference> deliveryDevice

The intended type of device that is to be used for the administration of the enteral formula.

additive

protected List<NutritionOrder.NutritionOrderEnteralFormulaAdditiveComponent> additive

Indicates modular components to be provided in addition or mixed with the base formula.

caloricDensity

protected Quantity 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 Quantity 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 MarkdownType administrationInstruction

Free text formula administration, feeding instructions or additional instructions or information.

Constructor Details

NutritionOrderEnteralFormulaComponent

public NutritionOrderEnteralFormulaComponent()

Constructor

Method Details

getBaseFormulaType

public CodeableReference 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(CodeableReference 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".

getDeliveryDevice

public List<CodeableReference> getDeliveryDevice()

Returns:

deliveryDevice (The intended type of device that is to be used for the administration of the enteral formula.)

setDeliveryDevice

public NutritionOrder.NutritionOrderEnteralFormulaComponent setDeliveryDevice(List<CodeableReference> theDeliveryDevice)

Returns:

Returns a reference to this for easy method chaining

hasDeliveryDevice

public boolean hasDeliveryDevice()

addDeliveryDevice

public CodeableReference addDeliveryDevice()

addDeliveryDevice

public NutritionOrder.NutritionOrderEnteralFormulaComponent addDeliveryDevice(CodeableReference t)

getDeliveryDeviceFirstRep

public CodeableReference getDeliveryDeviceFirstRep()

Returns:

The first repetition of repeating field deliveryDevice, creating it if it does not already exist {3}

getAdditive

public List<NutritionOrder.NutritionOrderEnteralFormulaAdditiveComponent> getAdditive()

Returns:

additive (Indicates modular components to be provided in addition or mixed with the base formula.)

setAdditive

public NutritionOrder.NutritionOrderEnteralFormulaComponent setAdditive(List<NutritionOrder.NutritionOrderEnteralFormulaAdditiveComponent> theAdditive)

Returns:

Returns a reference to this for easy method chaining

hasAdditive

public boolean hasAdditive()

addAdditive

public NutritionOrder.NutritionOrderEnteralFormulaAdditiveComponent addAdditive()

addAdditive

public NutritionOrder.NutritionOrderEnteralFormulaComponent addAdditive(NutritionOrder.NutritionOrderEnteralFormulaAdditiveComponent t)

getAdditiveFirstRep

public NutritionOrder.NutritionOrderEnteralFormulaAdditiveComponent getAdditiveFirstRep()

Returns:

The first repetition of repeating field additive, creating it if it does not already exist {3}

getCaloricDensity

public Quantity 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(Quantity 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 {3}

getMaxVolumeToDeliver

public Quantity 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(Quantity 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 MarkdownType 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(MarkdownType 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 class BackboneElement

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class BackboneElement

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 class BackboneElement

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 class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

copy

public NutritionOrder.NutritionOrderEnteralFormulaComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(NutritionOrder.NutritionOrderEnteralFormulaComponent dst)

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class BackboneElement

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class BackboneElement

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class BackboneElement

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class BackboneElement

Returns:

the FHIR type name of the instance (not the java class name)