Package org.hl7.fhir.r5.model

Class NutritionProduct

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.BaseResource

org.hl7.fhir.r5.model.Resource

org.hl7.fhir.r5.model.DomainResource

org.hl7.fhir.r5.model.NutritionProduct

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class NutritionProduct
extends DomainResource

A food or fluid product that is consumed by patients.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NutritionProduct.NutritionProductIngredientComponent
static class	NutritionProduct.NutritionProductInstanceComponent
static class	NutritionProduct.NutritionProductNutrientComponent
static class	NutritionProduct.NutritionProductProductCharacteristicComponent
static enum	NutritionProduct.NutritionProductStatus
static class	NutritionProduct.NutritionProductStatusEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final ca.uhn.fhir.rest.gclient.TokenClientParam	BIOLOGICAL_SOURCE	Fluent Client search parameter constant for biological-source
protected List<CodeableConcept>	category	Nutrition products can have different classifications - according to its nutritional properties, preparation methods, etc.
protected CodeableConcept	code	The code assigned to the product, for example a manufacturer number or other terminology.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
protected List<NutritionProduct.NutritionProductIngredientComponent>	ingredient	Ingredients contained in this product.
protected NutritionProduct.NutritionProductInstanceComponent	instance	Conveys instance-level information about this product item.
protected List<CodeableReference>	knownAllergen	Allergens that are known or suspected to be a part of this nutrition product.
protected List<Reference>	manufacturer	The organisation (manufacturer, representative or legal authorisation holder) that is responsible for the device.
protected List<Annotation>	note	Comments made about the product.
protected List<NutritionProduct.NutritionProductNutrientComponent>	nutrient	The product's nutritional information expressed by the nutrients.
protected List<NutritionProduct.NutritionProductProductCharacteristicComponent>	productCharacteristic	Specifies descriptive properties of the nutrition product.
static final String	SP_BIOLOGICAL_SOURCE	Search parameter: biological-source
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_STATUS	Search parameter: status
protected Enumeration<NutritionProduct.NutritionProductStatus>	status	The current state of the product.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status

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

contained, extension, modifierExtension, SP_TEXT, text, TEXT

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

id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, SP_RES_ID

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
NutritionProduct()	Constructor
NutritionProduct(NutritionProduct.NutritionProductStatus status)	Constructor

Method Summary

Modifier and Type	Method	Description
CodeableConcept	addCategory()
NutritionProduct	addCategory(CodeableConcept t)
Base	addChild(String name)
NutritionProduct.NutritionProductIngredientComponent	addIngredient()
NutritionProduct	addIngredient(NutritionProduct.NutritionProductIngredientComponent t)
CodeableReference	addKnownAllergen()
NutritionProduct	addKnownAllergen(CodeableReference t)
Reference	addManufacturer()
NutritionProduct	addManufacturer(Reference t)
Annotation	addNote()
NutritionProduct	addNote(Annotation t)
NutritionProduct.NutritionProductNutrientComponent	addNutrient()
NutritionProduct	addNutrient(NutritionProduct.NutritionProductNutrientComponent t)
NutritionProduct.NutritionProductProductCharacteristicComponent	addProductCharacteristic()
NutritionProduct	addProductCharacteristic(NutritionProduct.NutritionProductProductCharacteristicComponent t)
NutritionProduct	copy()
void	copyValues(NutritionProduct dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<CodeableConcept>	getCategory()
CodeableConcept	getCategoryFirstRep()
CodeableConcept	getCode()
List<NutritionProduct.NutritionProductIngredientComponent>	getIngredient()
NutritionProduct.NutritionProductIngredientComponent	getIngredientFirstRep()
NutritionProduct.NutritionProductInstanceComponent	getInstance()
List<CodeableReference>	getKnownAllergen()
CodeableReference	getKnownAllergenFirstRep()
List<Reference>	getManufacturer()
Reference	getManufacturerFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<Annotation>	getNote()
Annotation	getNoteFirstRep()
List<NutritionProduct.NutritionProductNutrientComponent>	getNutrient()
NutritionProduct.NutritionProductNutrientComponent	getNutrientFirstRep()
List<NutritionProduct.NutritionProductProductCharacteristicComponent>	getProductCharacteristic()
NutritionProduct.NutritionProductProductCharacteristicComponent	getProductCharacteristicFirstRep()
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
NutritionProduct.NutritionProductStatus	getStatus()
Enumeration<NutritionProduct.NutritionProductStatus>	getStatusElement()
String[]	getTypesForProperty(int hash, String name)
boolean	hasCategory()
boolean	hasCode()
boolean	hasIngredient()
boolean	hasInstance()
boolean	hasKnownAllergen()
boolean	hasManufacturer()
boolean	hasNote()
boolean	hasNutrient()
boolean	hasProductCharacteristic()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
NutritionProduct	setCategory(List<CodeableConcept> theCategory)
NutritionProduct	setCode(CodeableConcept value)
NutritionProduct	setIngredient(List<NutritionProduct.NutritionProductIngredientComponent> theIngredient)
NutritionProduct	setInstance(NutritionProduct.NutritionProductInstanceComponent value)
NutritionProduct	setKnownAllergen(List<CodeableReference> theKnownAllergen)
NutritionProduct	setManufacturer(List<Reference> theManufacturer)
NutritionProduct	setNote(List<Annotation> theNote)
NutritionProduct	setNutrient(List<NutritionProduct.NutritionProductNutrientComponent> theNutrient)
NutritionProduct	setProductCharacteristic(List<NutritionProduct.NutritionProductProductCharacteristicComponent> theProductCharacteristic)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
NutritionProduct	setStatus(NutritionProduct.NutritionProductStatus value)
NutritionProduct	setStatusElement(Enumeration<NutritionProduct.NutritionProductStatus> value)
protected NutritionProduct	typedCopy()

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

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

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

copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

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

getStructureFhirVersionEnum, isResource, setId

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

children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, 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.IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getMeta, getStructureFhirVersionEnum, setId

Field Details

status

protected Enumeration<NutritionProduct.NutritionProductStatus> status

The current state of the product.

category

protected List<CodeableConcept> category

Nutrition products can have different classifications - according to its nutritional properties, preparation methods, etc.

code

protected CodeableConcept code

The code assigned to the product, for example a manufacturer number or other terminology.

manufacturer

protected List<Reference> manufacturer

The organisation (manufacturer, representative or legal authorisation holder) that is responsible for the device.

nutrient

protected List<NutritionProduct.NutritionProductNutrientComponent> nutrient

The product's nutritional information expressed by the nutrients.

ingredient

protected List<NutritionProduct.NutritionProductIngredientComponent> ingredient

Ingredients contained in this product.

knownAllergen

protected List<CodeableReference> knownAllergen

Allergens that are known or suspected to be a part of this nutrition product.

productCharacteristic

protected List<NutritionProduct.NutritionProductProductCharacteristicComponent> productCharacteristic

Specifies descriptive properties of the nutrition product.

instance

protected NutritionProduct.NutritionProductInstanceComponent instance

Conveys instance-level information about this product item. One or several physical, countable instances or occurrences of the product.

note

protected List<Annotation> note

Comments made about the product.

SP_BIOLOGICAL_SOURCE

public static final String SP_BIOLOGICAL_SOURCE

Search parameter: biological-source

Description: The biological source for the nutrition product
Type: token
Path: NutritionProduct.instance.biologicalSource

See Also:

• Constant Field Values

BIOLOGICAL_SOURCE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam BIOLOGICAL_SOURCE

Fluent Client search parameter constant for biological-source

Description: The biological source for the nutrition product
Type: token
Path: NutritionProduct.instance.biologicalSource

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: The identifier for the physical instance, typically a serial number
Type: token
Path: NutritionProduct.instance.identifier

See Also:

• Constant Field Values

IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: The identifier for the physical instance, typically a serial number
Type: token
Path: NutritionProduct.instance.identifier

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: active | inactive | entered-in-error
Type: token
Path: NutritionProduct.status

See Also:

• Constant Field Values

STATUS

public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS

Fluent Client search parameter constant for status

Description: active | inactive | entered-in-error
Type: token
Path: NutritionProduct.status

Constructor Details

NutritionProduct

public NutritionProduct()

Constructor

NutritionProduct

public NutritionProduct(NutritionProduct.NutritionProductStatus status)

Constructor

Method Details

getStatusElement

public Enumeration<NutritionProduct.NutritionProductStatus> getStatusElement()

Returns:

status (The current state of the product.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

hasStatusElement

public boolean hasStatusElement()

hasStatus

public boolean hasStatus()

setStatusElement

public NutritionProduct setStatusElement(Enumeration<NutritionProduct.NutritionProductStatus> value)

Parameters:

value - status (The current state of the product.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

getStatus

public NutritionProduct.NutritionProductStatus getStatus()

Returns:

The current state of the product.

setStatus

public NutritionProduct setStatus(NutritionProduct.NutritionProductStatus value)

Parameters:

value - The current state of the product.

getCategory

public List<CodeableConcept> getCategory()

Returns:

category (Nutrition products can have different classifications - according to its nutritional properties, preparation methods, etc.)

setCategory

public NutritionProduct setCategory(List<CodeableConcept> theCategory)

Returns:

Returns a reference to this for easy method chaining

hasCategory

public boolean hasCategory()

addCategory

public CodeableConcept addCategory()

addCategory

public NutritionProduct addCategory(CodeableConcept t)

getCategoryFirstRep

public CodeableConcept getCategoryFirstRep()

Returns:

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

getCode

public CodeableConcept getCode()

Returns:

code (The code assigned to the product, for example a manufacturer number or other terminology.)

hasCode

public boolean hasCode()

setCode

public NutritionProduct setCode(CodeableConcept value)

Parameters:

value - code (The code assigned to the product, for example a manufacturer number or other terminology.)

getManufacturer

public List<Reference> getManufacturer()

Returns:

manufacturer (The organisation (manufacturer, representative or legal authorisation holder) that is responsible for the device.)

setManufacturer

public NutritionProduct setManufacturer(List<Reference> theManufacturer)

Returns:

Returns a reference to this for easy method chaining

hasManufacturer

public boolean hasManufacturer()

addManufacturer

public Reference addManufacturer()

addManufacturer

public NutritionProduct addManufacturer(Reference t)

getManufacturerFirstRep

public Reference getManufacturerFirstRep()

Returns:

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

getNutrient

public List<NutritionProduct.NutritionProductNutrientComponent> getNutrient()

Returns:

nutrient (The product's nutritional information expressed by the nutrients.)

setNutrient

public NutritionProduct setNutrient(List<NutritionProduct.NutritionProductNutrientComponent> theNutrient)

Returns:

Returns a reference to this for easy method chaining

hasNutrient

public boolean hasNutrient()

addNutrient

public NutritionProduct.NutritionProductNutrientComponent addNutrient()

addNutrient

public NutritionProduct addNutrient(NutritionProduct.NutritionProductNutrientComponent t)

getNutrientFirstRep

public NutritionProduct.NutritionProductNutrientComponent getNutrientFirstRep()

Returns:

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

getIngredient

public List<NutritionProduct.NutritionProductIngredientComponent> getIngredient()

Returns:

ingredient (Ingredients contained in this product.)

setIngredient

public NutritionProduct setIngredient(List<NutritionProduct.NutritionProductIngredientComponent> theIngredient)

Returns:

Returns a reference to this for easy method chaining

hasIngredient

public boolean hasIngredient()

addIngredient

public NutritionProduct.NutritionProductIngredientComponent addIngredient()

addIngredient

public NutritionProduct addIngredient(NutritionProduct.NutritionProductIngredientComponent t)

getIngredientFirstRep

public NutritionProduct.NutritionProductIngredientComponent getIngredientFirstRep()

Returns:

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

getKnownAllergen

public List<CodeableReference> getKnownAllergen()

Returns:

knownAllergen (Allergens that are known or suspected to be a part of this nutrition product.)

setKnownAllergen

public NutritionProduct setKnownAllergen(List<CodeableReference> theKnownAllergen)

Returns:

Returns a reference to this for easy method chaining

hasKnownAllergen

public boolean hasKnownAllergen()

addKnownAllergen

public CodeableReference addKnownAllergen()

addKnownAllergen

public NutritionProduct addKnownAllergen(CodeableReference t)

getKnownAllergenFirstRep

public CodeableReference getKnownAllergenFirstRep()

Returns:

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

getProductCharacteristic

public List<NutritionProduct.NutritionProductProductCharacteristicComponent> getProductCharacteristic()

Returns:

productCharacteristic (Specifies descriptive properties of the nutrition product.)

setProductCharacteristic

public NutritionProduct setProductCharacteristic(List<NutritionProduct.NutritionProductProductCharacteristicComponent> theProductCharacteristic)

Returns:

Returns a reference to this for easy method chaining

hasProductCharacteristic

public boolean hasProductCharacteristic()

addProductCharacteristic

public NutritionProduct.NutritionProductProductCharacteristicComponent addProductCharacteristic()

addProductCharacteristic

public NutritionProduct addProductCharacteristic(NutritionProduct.NutritionProductProductCharacteristicComponent t)

getProductCharacteristicFirstRep

public NutritionProduct.NutritionProductProductCharacteristicComponent getProductCharacteristicFirstRep()

Returns:

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

getInstance

public NutritionProduct.NutritionProductInstanceComponent getInstance()

Returns:

instance (Conveys instance-level information about this product item. One or several physical, countable instances or occurrences of the product.)

hasInstance

public boolean hasInstance()

setInstance

public NutritionProduct setInstance(NutritionProduct.NutritionProductInstanceComponent value)

Parameters:

value - instance (Conveys instance-level information about this product item. One or several physical, countable instances or occurrences of the product.)

getNote

public List<Annotation> getNote()

Returns:

note (Comments made about the product.)

setNote

public NutritionProduct setNote(List<Annotation> theNote)

Returns:

Returns a reference to this for easy method chaining

hasNote

public boolean hasNote()

addNote

public Annotation addNote()

addNote

public NutritionProduct addNote(Annotation t)

getNoteFirstRep

public Annotation getNoteFirstRep()

Returns:

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

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

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

Overrides:

getNamedProperty in class DomainResource

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 DomainResource

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 DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

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

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

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

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

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

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

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

Overrides:

fhirType in class DomainResource

copy

public NutritionProduct copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(NutritionProduct dst)

typedCopy

protected NutritionProduct typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource