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 supplement that is consumed by patients.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

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<CodeableConcept>	category	Nutrition products can have different classifications - according to its nutritional properties, preparation methods, etc.
protected List<NutritionProduct.NutritionProductCharacteristicComponent>	characteristic	Specifies descriptive properties of the nutrition product.
protected CodeableConcept	code	The code assigned to the product, for example a USDA NDB number, a USDA FDC ID number, or a Langual code.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CODE	Fluent Client search parameter constant for code
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 List<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.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	LOT_NUMBER	Fluent Client search parameter constant for lot-number
protected List<Reference>	manufacturer	The organisation (manufacturer, representative or legal authorization 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.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	SERIAL_NUMBER	Fluent Client search parameter constant for serial-number
static final String	SP_CODE	Search parameter: code
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_LOT_NUMBER	Search parameter: lot-number
static final String	SP_SERIAL_NUMBER	Search parameter: serial-number
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, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

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)
NutritionProduct.NutritionProductCharacteristicComponent	addCharacteristic()
NutritionProduct	addCharacteristic(NutritionProduct.NutritionProductCharacteristicComponent t)
Base	addChild(String name)
NutritionProduct.NutritionProductIngredientComponent	addIngredient()
NutritionProduct	addIngredient(NutritionProduct.NutritionProductIngredientComponent t)
NutritionProduct.NutritionProductInstanceComponent	addInstance()
NutritionProduct	addInstance(NutritionProduct.NutritionProductInstanceComponent 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	copy()
void	copyValues(NutritionProduct dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<CodeableConcept>	getCategory()
CodeableConcept	getCategoryFirstRep()
List<NutritionProduct.NutritionProductCharacteristicComponent>	getCharacteristic()
NutritionProduct.NutritionProductCharacteristicComponent	getCharacteristicFirstRep()
CodeableConcept	getCode()
List<NutritionProduct.NutritionProductIngredientComponent>	getIngredient()
NutritionProduct.NutritionProductIngredientComponent	getIngredientFirstRep()
List<NutritionProduct.NutritionProductInstanceComponent>	getInstance()
NutritionProduct.NutritionProductInstanceComponent	getInstanceFirstRep()
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()
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	hasCharacteristic()
boolean	hasCode()
boolean	hasIngredient()
boolean	hasInstance()
boolean	hasKnownAllergen()
boolean	hasManufacturer()
boolean	hasNote()
boolean	hasNutrient()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
NutritionProduct	setCategory(List<CodeableConcept> theCategory)
NutritionProduct	setCharacteristic(List<NutritionProduct.NutritionProductCharacteristicComponent> theCharacteristic)
NutritionProduct	setCode(CodeableConcept value)
NutritionProduct	setIngredient(List<NutritionProduct.NutritionProductIngredientComponent> theIngredient)
NutritionProduct	setInstance(List<NutritionProduct.NutritionProductInstanceComponent> theInstance)
NutritionProduct	setKnownAllergen(List<CodeableReference> theKnownAllergen)
NutritionProduct	setManufacturer(List<Reference> theManufacturer)
NutritionProduct	setNote(List<Annotation> theNote)
NutritionProduct	setNutrient(List<NutritionProduct.NutritionProductNutrientComponent> theNutrient)
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, getExtensionsByUrl, getExtensionString, getExtensionString, getModifierExtension, getModifierExtensionsByUrl, getStandardsStatus, getText, hasContained, hasExtension, hasExtension, hasExtension, hasModifierExtension, hasPrimitiveExtension, hasText, setContained, setExtension, setModifierExtension, setStandardsStatus, setText

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

copyValues, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPath

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

getStructureFhirVersionEnum, isResource, setId

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, executeFunction, 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, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN, setXhtml

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, isDeleted, setId

Field Details

code

protected CodeableConcept code

The code assigned to the product, for example a USDA NDB number, a USDA FDC ID number, or a Langual code.

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.

manufacturer

protected List<Reference> manufacturer

The organisation (manufacturer, representative or legal authorization 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.

characteristic

protected List<NutritionProduct.NutritionProductCharacteristicComponent> characteristic

Specifies descriptive properties of the nutrition product.

instance

protected List<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_CODE

public static final String SP_CODE

Search parameter: code

Description: The code identifying a specific nutrition product
Type: token
Path: NutritionProduct.code

See Also:

• Constant Field Values

CODE

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

Fluent Client search parameter constant for code

Description: The code identifying a specific nutrition product
Type: token
Path: NutritionProduct.code

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_LOT_NUMBER

public static final String SP_LOT_NUMBER

Search parameter: lot-number

Description: The lot number
Type: token
Path: NutritionProduct.instance.lotNumber

See Also:

• Constant Field Values

LOT_NUMBER

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

Fluent Client search parameter constant for lot-number

Description: The lot number
Type: token
Path: NutritionProduct.instance.lotNumber

SP_SERIAL_NUMBER

public static final String SP_SERIAL_NUMBER

Search parameter: serial-number

Description: The serial number
Type: token
Path: NutritionProduct.instance.identifier

See Also:

• Constant Field Values

SERIAL_NUMBER

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

Fluent Client search parameter constant for serial-number

Description: The serial number
Type: token
Path: NutritionProduct.instance.identifier

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: The broad product group or category of the nutrition product
Type: token
Path: NutritionProduct.category

See Also:

• Constant Field Values

STATUS

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

Fluent Client search parameter constant for status

Description: The broad product group or category of the nutrition product
Type: token
Path: NutritionProduct.category

Constructor Details

NutritionProduct

public NutritionProduct()

Constructor

NutritionProduct

public NutritionProduct(NutritionProduct.NutritionProductStatus status)

Constructor

Method Details

getCode

public CodeableConcept getCode()

Returns:

code (The code assigned to the product, for example a USDA NDB number, a USDA FDC ID number, or a Langual code.)

hasCode

public boolean hasCode()

setCode

public NutritionProduct setCode(CodeableConcept value)

Parameters:

value - code (The code assigned to the product, for example a USDA NDB number, a USDA FDC ID number, or a Langual code.)

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}

getManufacturer

public List<Reference> getManufacturer()

Returns:

manufacturer (The organisation (manufacturer, representative or legal authorization 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}

getCharacteristic

public List<NutritionProduct.NutritionProductCharacteristicComponent> getCharacteristic()

Returns:

characteristic (Specifies descriptive properties of the nutrition product.)

setCharacteristic

public NutritionProduct setCharacteristic(List<NutritionProduct.NutritionProductCharacteristicComponent> theCharacteristic)

Returns:

Returns a reference to this for easy method chaining

hasCharacteristic

public boolean hasCharacteristic()

addCharacteristic

public NutritionProduct.NutritionProductCharacteristicComponent addCharacteristic()

addCharacteristic

public NutritionProduct addCharacteristic(NutritionProduct.NutritionProductCharacteristicComponent t)

getCharacteristicFirstRep

public NutritionProduct.NutritionProductCharacteristicComponent getCharacteristicFirstRep()

Returns:

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

getInstance

public List<NutritionProduct.NutritionProductInstanceComponent> getInstance()

Returns:

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

setInstance

public NutritionProduct setInstance(List<NutritionProduct.NutritionProductInstanceComponent> theInstance)

Returns:

Returns a reference to this for easy method chaining

hasInstance

public boolean hasInstance()

addInstance

public NutritionProduct.NutritionProductInstanceComponent addInstance()

addInstance

public NutritionProduct addInstance(NutritionProduct.NutritionProductInstanceComponent t)

getInstanceFirstRep

public NutritionProduct.NutritionProductInstanceComponent getInstanceFirstRep()

Returns:

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

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

removeChild

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

Overrides:

removeChild 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

Returns:

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

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