Package org.hl7.fhir.r5.model

Class Ingredient

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.Ingredient

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 Ingredient
extends DomainResource

An ingredient of a manufactured item or pharmaceutical product.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Ingredient.IngredientManufacturerComponent
static class	Ingredient.IngredientSubstanceComponent
static class	Ingredient.IngredientSubstanceStrengthComponent
static class	Ingredient.IngredientSubstanceStrengthReferenceStrengthComponent

Field Summary

Fields

Modifier and Type	Field	Description
protected BooleanType	allergenicIndicator	If the ingredient is a known or suspected allergen.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	FOR	Fluent Client search parameter constant for for
protected List<Reference>	for_	The product which this ingredient is a constituent part of.
protected List<CodeableConcept>	function	A classification of the ingredient identifying its precise purpose(s) in the drug product.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	FUNCTION	Fluent Client search parameter constant for function
protected CodeableConcept	group	A classification of the ingredient according to where in the physical item it tends to be used, such the outer shell of a tablet, inner body or ink.
protected Identifier	identifier	The identifier(s) of this Ingredient that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_FOR	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_MANUFACTURER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SUBSTANCE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SUBSTANCE_DEFINITION	Constant for fluent queries to be used to add include statements.
protected List<Ingredient.IngredientManufacturerComponent>	manufacturer	An organization that manufactures this ingredient.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	MANUFACTURER	Fluent Client search parameter constant for manufacturer
protected CodeableConcept	role	A classification of the ingredient identifying its purpose within the product, e.g.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	ROLE	Fluent Client search parameter constant for role
static final String	SP_FOR	Search parameter: for
static final String	SP_FUNCTION	Search parameter: function
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_MANUFACTURER	Search parameter: manufacturer
static final String	SP_ROLE	Search parameter: role
static final String	SP_SUBSTANCE	Search parameter: substance
static final String	SP_SUBSTANCE_CODE	Search parameter: substance-code
static final String	SP_SUBSTANCE_DEFINITION	Search parameter: substance-definition
protected Enumeration<Enumerations.PublicationStatus>	status	The status of this ingredient.
protected Ingredient.IngredientSubstanceComponent	substance	The substance that comprises this ingredient.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SUBSTANCE	Fluent Client search parameter constant for substance
static final ca.uhn.fhir.rest.gclient.TokenClientParam	SUBSTANCE_CODE	Fluent Client search parameter constant for substance-code
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SUBSTANCE_DEFINITION	Fluent Client search parameter constant for substance-definition

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
Ingredient()	Constructor
Ingredient(Enumerations.PublicationStatus status, CodeableConcept role, Ingredient.IngredientSubstanceComponent substance)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Reference	addFor()
Ingredient	addFor(Reference t)
CodeableConcept	addFunction()
Ingredient	addFunction(CodeableConcept t)
Ingredient.IngredientManufacturerComponent	addManufacturer()
Ingredient	addManufacturer(Ingredient.IngredientManufacturerComponent t)
Ingredient	copy()
void	copyValues(Ingredient dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
boolean	getAllergenicIndicator()
BooleanType	getAllergenicIndicatorElement()
List<Reference>	getFor()
Reference	getForFirstRep()
List<CodeableConcept>	getFunction()
CodeableConcept	getFunctionFirstRep()
CodeableConcept	getGroup()
Identifier	getIdentifier()
List<Ingredient.IngredientManufacturerComponent>	getManufacturer()
Ingredient.IngredientManufacturerComponent	getManufacturerFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
CodeableConcept	getRole()
Enumerations.PublicationStatus	getStatus()
Enumeration<Enumerations.PublicationStatus>	getStatusElement()
Ingredient.IngredientSubstanceComponent	getSubstance()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAllergenicIndicator()
boolean	hasAllergenicIndicatorElement()
boolean	hasFor()
boolean	hasFunction()
boolean	hasGroup()
boolean	hasIdentifier()
boolean	hasManufacturer()
boolean	hasRole()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasSubstance()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
Ingredient	setAllergenicIndicator(boolean value)
Ingredient	setAllergenicIndicatorElement(BooleanType value)
Ingredient	setFor(List<Reference> theFor)
Ingredient	setFunction(List<CodeableConcept> theFunction)
Ingredient	setGroup(CodeableConcept value)
Ingredient	setIdentifier(Identifier value)
Ingredient	setManufacturer(List<Ingredient.IngredientManufacturerComponent> theManufacturer)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Ingredient	setRole(CodeableConcept value)
Ingredient	setStatus(Enumerations.PublicationStatus value)
Ingredient	setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
Ingredient	setSubstance(Ingredient.IngredientSubstanceComponent value)
protected Ingredient	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

identifier

protected Identifier identifier

The identifier(s) of this Ingredient that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.

status

protected Enumeration<Enumerations.PublicationStatus> status

The status of this ingredient. Enables tracking the life-cycle of the content.

for_

protected List<Reference> for_

The product which this ingredient is a constituent part of.

role

protected CodeableConcept role

A classification of the ingredient identifying its purpose within the product, e.g. active, inactive.

function

protected List<CodeableConcept> function

A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: Antioxidant, Alkalizing Agent.

group

protected CodeableConcept group

A classification of the ingredient according to where in the physical item it tends to be used, such the outer shell of a tablet, inner body or ink.

allergenicIndicator

protected BooleanType allergenicIndicator

If the ingredient is a known or suspected allergen.

manufacturer

protected List<Ingredient.IngredientManufacturerComponent> manufacturer

An organization that manufactures this ingredient.

substance

protected Ingredient.IngredientSubstanceComponent substance

The substance that comprises this ingredient.

SP_FOR

public static final String SP_FOR

Search parameter: for

Description: The product which this ingredient is a constituent part of
Type: reference
Path: Ingredient.for

See Also:

• Constant Field Values

FOR

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam FOR

Fluent Client search parameter constant for for

Description: The product which this ingredient is a constituent part of
Type: reference
Path: Ingredient.for

INCLUDE_FOR

public static final ca.uhn.fhir.model.api.Include INCLUDE_FOR

Constant for fluent queries to be used to add include statements. Specifies the path value of "Ingredient:for".

SP_FUNCTION

public static final String SP_FUNCTION

Search parameter: function

Description: A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: Antioxidant, Alkalizing Agent
Type: token
Path: Ingredient.function

See Also:

• Constant Field Values

FUNCTION

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

Fluent Client search parameter constant for function

Description: A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: Antioxidant, Alkalizing Agent
Type: token
Path: Ingredient.function

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: An identifier or code by which the ingredient can be referenced
Type: token
Path: Ingredient.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: An identifier or code by which the ingredient can be referenced
Type: token
Path: Ingredient.identifier

SP_MANUFACTURER

public static final String SP_MANUFACTURER

Search parameter: manufacturer

Description: The organization that manufactures this ingredient
Type: reference
Path: Ingredient.manufacturer

See Also:

• Constant Field Values

MANUFACTURER

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam MANUFACTURER

Fluent Client search parameter constant for manufacturer

Description: The organization that manufactures this ingredient
Type: reference
Path: Ingredient.manufacturer

INCLUDE_MANUFACTURER

public static final ca.uhn.fhir.model.api.Include INCLUDE_MANUFACTURER

Constant for fluent queries to be used to add include statements. Specifies the path value of "Ingredient:manufacturer".

SP_ROLE

public static final String SP_ROLE

Search parameter: role

Description: A classification of the ingredient identifying its purpose within the product, e.g. active, inactive
Type: token
Path: Ingredient.role

See Also:

• Constant Field Values

ROLE

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

Fluent Client search parameter constant for role

Description: A classification of the ingredient identifying its purpose within the product, e.g. active, inactive
Type: token
Path: Ingredient.role

SP_SUBSTANCE_CODE

public static final String SP_SUBSTANCE_CODE

Search parameter: substance-code

Description: Reference to a concept (by class)
Type: token
Path: Ingredient.substance.code.concept

See Also:

• Constant Field Values

SUBSTANCE_CODE

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

Fluent Client search parameter constant for substance-code

Description: Reference to a concept (by class)
Type: token
Path: Ingredient.substance.code.concept

SP_SUBSTANCE_DEFINITION

public static final String SP_SUBSTANCE_DEFINITION

Search parameter: substance-definition

Description: Reference to a resource (by instance)
Type: reference
Path: Ingredient.substance.code.reference

See Also:

• Constant Field Values

SUBSTANCE_DEFINITION

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBSTANCE_DEFINITION

Fluent Client search parameter constant for substance-definition

Description: Reference to a resource (by instance)
Type: reference
Path: Ingredient.substance.code.reference

INCLUDE_SUBSTANCE_DEFINITION

public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBSTANCE_DEFINITION

Constant for fluent queries to be used to add include statements. Specifies the path value of "Ingredient:substance-definition".

SP_SUBSTANCE

public static final String SP_SUBSTANCE

Search parameter: substance

Description: Reference to a resource (by instance)
Type: reference
Path: Ingredient.substance.code.reference

See Also:

• Constant Field Values

SUBSTANCE

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBSTANCE

Fluent Client search parameter constant for substance

Description: Reference to a resource (by instance)
Type: reference
Path: Ingredient.substance.code.reference

INCLUDE_SUBSTANCE

public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBSTANCE

Constant for fluent queries to be used to add include statements. Specifies the path value of "Ingredient:substance".

Constructor Details

Ingredient

public Ingredient()

Constructor

Ingredient

public Ingredient(Enumerations.PublicationStatus status,
 CodeableConcept role,
 Ingredient.IngredientSubstanceComponent substance)

Constructor

Method Details

getIdentifier

public Identifier getIdentifier()

Returns:

identifier (The identifier(s) of this Ingredient that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.)

hasIdentifier

public boolean hasIdentifier()

setIdentifier

public Ingredient setIdentifier(Identifier value)

Parameters:

value - identifier (The identifier(s) of this Ingredient that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.)

getStatusElement

public Enumeration<Enumerations.PublicationStatus> getStatusElement()

Returns:

status (The status of this ingredient. Enables tracking the life-cycle of the content.). 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 Ingredient setStatusElement(Enumeration<Enumerations.PublicationStatus> value)

Parameters:

value - status (The status of this ingredient. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

getStatus

public Enumerations.PublicationStatus getStatus()

Returns:

The status of this ingredient. Enables tracking the life-cycle of the content.

setStatus

public Ingredient setStatus(Enumerations.PublicationStatus value)

Parameters:

value - The status of this ingredient. Enables tracking the life-cycle of the content.

getFor

public List<Reference> getFor()

Returns:

for_ (The product which this ingredient is a constituent part of.)

setFor

public Ingredient setFor(List<Reference> theFor)

Returns:

Returns a reference to this for easy method chaining

hasFor

public boolean hasFor()

addFor

public Reference addFor()

addFor

public Ingredient addFor(Reference t)

getForFirstRep

public Reference getForFirstRep()

Returns:

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

getRole

public CodeableConcept getRole()

Returns:

role (A classification of the ingredient identifying its purpose within the product, e.g. active, inactive.)

hasRole

public boolean hasRole()

setRole

public Ingredient setRole(CodeableConcept value)

Parameters:

value - role (A classification of the ingredient identifying its purpose within the product, e.g. active, inactive.)

getFunction

public List<CodeableConcept> getFunction()

Returns:

function (A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: Antioxidant, Alkalizing Agent.)

setFunction

public Ingredient setFunction(List<CodeableConcept> theFunction)

Returns:

Returns a reference to this for easy method chaining

hasFunction

public boolean hasFunction()

addFunction

public CodeableConcept addFunction()

addFunction

public Ingredient addFunction(CodeableConcept t)

getFunctionFirstRep

public CodeableConcept getFunctionFirstRep()

Returns:

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

getGroup

public CodeableConcept getGroup()

Returns:

group (A classification of the ingredient according to where in the physical item it tends to be used, such the outer shell of a tablet, inner body or ink.)

hasGroup

public boolean hasGroup()

setGroup

public Ingredient setGroup(CodeableConcept value)

Parameters:

value - group (A classification of the ingredient according to where in the physical item it tends to be used, such the outer shell of a tablet, inner body or ink.)

getAllergenicIndicatorElement

public BooleanType getAllergenicIndicatorElement()

Returns:

allergenicIndicator (If the ingredient is a known or suspected allergen.). This is the underlying object with id, value and extensions. The accessor "getAllergenicIndicator" gives direct access to the value

hasAllergenicIndicatorElement

public boolean hasAllergenicIndicatorElement()

hasAllergenicIndicator

public boolean hasAllergenicIndicator()

setAllergenicIndicatorElement

public Ingredient setAllergenicIndicatorElement(BooleanType value)

Parameters:

value - allergenicIndicator (If the ingredient is a known or suspected allergen.). This is the underlying object with id, value and extensions. The accessor "getAllergenicIndicator" gives direct access to the value

getAllergenicIndicator

public boolean getAllergenicIndicator()

Returns:

If the ingredient is a known or suspected allergen.

setAllergenicIndicator

public Ingredient setAllergenicIndicator(boolean value)

Parameters:

value - If the ingredient is a known or suspected allergen.

getManufacturer

public List<Ingredient.IngredientManufacturerComponent> getManufacturer()

Returns:

manufacturer (An organization that manufactures this ingredient.)

setManufacturer

public Ingredient setManufacturer(List<Ingredient.IngredientManufacturerComponent> theManufacturer)

Returns:

Returns a reference to this for easy method chaining

hasManufacturer

public boolean hasManufacturer()

addManufacturer

public Ingredient.IngredientManufacturerComponent addManufacturer()

addManufacturer

public Ingredient addManufacturer(Ingredient.IngredientManufacturerComponent t)

getManufacturerFirstRep

public Ingredient.IngredientManufacturerComponent getManufacturerFirstRep()

Returns:

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

getSubstance

public Ingredient.IngredientSubstanceComponent getSubstance()

Returns:

substance (The substance that comprises this ingredient.)

hasSubstance

public boolean hasSubstance()

setSubstance

public Ingredient setSubstance(Ingredient.IngredientSubstanceComponent value)

Parameters:

value - substance (The substance that comprises this ingredient.)

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 Ingredient copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(Ingredient dst)

typedCopy

protected Ingredient 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