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.IngredientSpecifiedSubstanceComponent`
`static class`	`Ingredient.IngredientSpecifiedSubstanceStrengthComponent`
`static class`	`Ingredient.IngredientSpecifiedSubstanceStrengthReferenceStrengthComponent`
`static class`	`Ingredient.IngredientSubstanceComponent`

Field Summary

Fields
Modifier and Type	Field	Description
`protected BooleanType`	`allergenicIndicator`	If the ingredient is a known or suspected allergen.
`protected MarkdownType`	`description`	A general description of the ingredient, or any supporting text.
`protected List<CodeableConcept>`	`function`	A classification of the ingredient identifying its precise purpose(s) in the drug product.
`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 ca.uhn.fhir.rest.gclient.TokenClientParam`	`IDENTIFIER`	Fluent Client search parameter constant for identifier
`protected List<Reference>`	`manufacturer`	The organization that manufactures this ingredient.
`protected CodeableConcept`	`role`	Ingredient role within a drug product e.g.
`static String`	`SP_IDENTIFIER`	Search parameter: identifier
`static String`	`SP_SPECIFIED_SUBSTANCE`	Search parameter: specified-substance
`static String`	`SP_SUBSTANCE`	Search parameter: substance
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`SPECIFIED_SUBSTANCE`	Fluent Client search parameter constant for specified-substance
`protected List<Ingredient.IngredientSpecifiedSubstanceComponent>`	`specifiedSubstance`	A specified substance that comprises this ingredient.
`protected Ingredient.IngredientSubstanceComponent`	`substance`	The substance that comprises this ingredient.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`SUBSTANCE`	Fluent Client search parameter constant for substance

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, SP_RES_LANGUAGE

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

Constructor Summary

Constructors
Constructor Description

Ingredient()
Constructor

Ingredient(CodeableConcept role)
Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Base`	`addChild(String name)`
`CodeableConcept`	`addFunction()`
`Ingredient`	`addFunction(CodeableConcept t)`
`Reference`	`addManufacturer()`
`Ingredient`	`addManufacturer(Reference t)`
`Ingredient.IngredientSpecifiedSubstanceComponent`	`addSpecifiedSubstance()`
`Ingredient`	`addSpecifiedSubstance(Ingredient.IngredientSpecifiedSubstanceComponent t)`
`Ingredient`	`copy()`
`void`	`copyValues(Ingredient dst)`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`boolean`	`getAllergenicIndicator()`
`BooleanType`	`getAllergenicIndicatorElement()`
`String`	`getDescription()`
`MarkdownType`	`getDescriptionElement()`
`List<CodeableConcept>`	`getFunction()`
`CodeableConcept`	`getFunctionFirstRep()`
`Identifier`	`getIdentifier()`
`List<Reference>`	`getManufacturer()`
`Reference`	`getManufacturerFirstRep()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`ResourceType`	`getResourceType()`
`CodeableConcept`	`getRole()`
`List<Ingredient.IngredientSpecifiedSubstanceComponent>`	`getSpecifiedSubstance()`
`Ingredient.IngredientSpecifiedSubstanceComponent`	`getSpecifiedSubstanceFirstRep()`
`Ingredient.IngredientSubstanceComponent`	`getSubstance()`
`String[]`	`getTypesForProperty(int hash, String name)`
`boolean`	`hasAllergenicIndicator()`
`boolean`	`hasAllergenicIndicatorElement()`
`boolean`	`hasDescription()`
`boolean`	`hasDescriptionElement()`
`boolean`	`hasFunction()`
`boolean`	`hasIdentifier()`
`boolean`	`hasManufacturer()`
`boolean`	`hasRole()`
`boolean`	`hasSpecifiedSubstance()`
`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`	`setDescription(String value)`
`Ingredient`	`setDescriptionElement(MarkdownType value)`
`Ingredient`	`setFunction(List<CodeableConcept> theFunction)`
`Ingredient`	`setIdentifier(Identifier value)`
`Ingredient`	`setManufacturer(List<Reference> theManufacturer)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`Ingredient`	`setRole(CodeableConcept value)`
`Ingredient`	`setSpecifiedSubstance(List<Ingredient.IngredientSpecifiedSubstanceComponent> theSpecifiedSubstance)`
`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, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, 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 Detail
  - 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.
  - role
```
protected CodeableConcept role
```
    Ingredient role within a drug product e.g. Active ingredient, Excipient.
  - 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.
  - description
```
protected MarkdownType description
```
    A general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients.
  - allergenicIndicator
```
protected BooleanType allergenicIndicator
```
    If the ingredient is a known or suspected allergen.
  - manufacturer
```
protected List<Reference> manufacturer
```
    The organization that manufactures this ingredient.
  - specifiedSubstance
```
protected List<Ingredient.IngredientSpecifiedSubstanceComponent> specifiedSubstance
```
    A specified substance that comprises this ingredient.
  - substance
```
protected Ingredient.IngredientSubstanceComponent substance
```
    The substance that comprises this ingredient.
  - 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_SPECIFIED_SUBSTANCE
```
public static final String SP_SPECIFIED_SUBSTANCE
```
    Search parameter: specified-substance
    Description: Substance as a 'specified substance', implying extra substance related characteristics
    Type: token
    Path: (Ingredient.specifiedSubstance.code as CodeableConcept)
    
    See Also:
    
    Constant Field Values
  - SPECIFIED_SUBSTANCE
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam SPECIFIED_SUBSTANCE
```
    Fluent Client search parameter constant for specified-substance
    Description: Substance as a 'specified substance', implying extra substance related characteristics
    Type: token
    Path: (Ingredient.specifiedSubstance.code as CodeableConcept)
  - SP_SUBSTANCE
```
public static final String SP_SUBSTANCE
```
    Search parameter: substance
    Description: A code that represents the ingredient substance
    Type: token
    Path: (Ingredient.substance.code as CodeableConcept)
    
    See Also:
    
    Constant Field Values
  - SUBSTANCE
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam SUBSTANCE
```
    Fluent Client search parameter constant for substance
    Description: A code that represents the ingredient substance
    Type: token
    Path: (Ingredient.substance.code as CodeableConcept)
- Constructor Detail
  - Ingredient
```
public Ingredient()
```
    Constructor
  - Ingredient
```
public Ingredient(CodeableConcept role)
```
    Constructor
- Method Detail
  - 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.)
  - getRole
```
public CodeableConcept getRole()
```
    Returns:
    
    role (Ingredient role within a drug product e.g. Active ingredient, Excipient.)
  - hasRole
```
public boolean hasRole()
```
  - setRole
```
public Ingredient setRole(CodeableConcept value)
```
    Parameters:
    
    value - role (Ingredient role within a drug product e.g. Active ingredient, Excipient.)
  - 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}
  - getDescriptionElement
```
public MarkdownType getDescriptionElement()
```
    Returns:
    
    description (A general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
  - hasDescriptionElement
```
public boolean hasDescriptionElement()
```
  - hasDescription
```
public boolean hasDescription()
```
  - setDescriptionElement
```
public Ingredient setDescriptionElement(MarkdownType value)
```
    Parameters:
    
    value - description (A general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
  - getDescription
```
public String getDescription()
```
    Returns:
    
    A general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients.
  - setDescription
```
public Ingredient setDescription(String value)
```
    Parameters:
    
    value - A general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients.
  - 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<Reference> getManufacturer()
```
    Returns:
    
    manufacturer (The organization that manufactures this ingredient.)
  - setManufacturer
```
public Ingredient setManufacturer(List<Reference> theManufacturer)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasManufacturer
```
public boolean hasManufacturer()
```
  - addManufacturer
```
public Reference addManufacturer()
```
  - addManufacturer
```
public Ingredient addManufacturer(Reference t)
```
  - getManufacturerFirstRep
```
public Reference getManufacturerFirstRep()
```
    Returns:
    
    The first repetition of repeating field manufacturer, creating it if it does not already exist {3}
  - getSpecifiedSubstance
```
public List<Ingredient.IngredientSpecifiedSubstanceComponent> getSpecifiedSubstance()
```
    Returns:
    
    specifiedSubstance (A specified substance that comprises this ingredient.)
  - setSpecifiedSubstance
```
public Ingredient setSpecifiedSubstance(List<Ingredient.IngredientSpecifiedSubstanceComponent> theSpecifiedSubstance)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasSpecifiedSubstance
```
public boolean hasSpecifiedSubstance()
```
  - addSpecifiedSubstance
```
public Ingredient.IngredientSpecifiedSubstanceComponent addSpecifiedSubstance()
```
  - addSpecifiedSubstance
```
public Ingredient addSpecifiedSubstance(Ingredient.IngredientSpecifiedSubstanceComponent t)
```
  - getSpecifiedSubstanceFirstRep
```
public Ingredient.IngredientSpecifiedSubstanceComponent getSpecifiedSubstanceFirstRep()
```
    Returns:
    
    The first repetition of repeating field specifiedSubstance, 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

Constructor	Description
`Ingredient()`	Constructor
`Ingredient(CodeableConcept role)`	Constructor

Class Ingredient

Nested Class Summary

Field Summary

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

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

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

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

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

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

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

Field Detail

identifier

role

function

description

allergenicIndicator

manufacturer

specifiedSubstance

substance

SP_IDENTIFIER

IDENTIFIER

SP_SPECIFIED_SUBSTANCE

SPECIFIED_SUBSTANCE

SP_SUBSTANCE

SUBSTANCE

Constructor Detail

Ingredient

Ingredient

Method Detail

getIdentifier

hasIdentifier

setIdentifier

getRole

hasRole

setRole

getFunction

setFunction

hasFunction

addFunction

addFunction

getFunctionFirstRep

getDescriptionElement

hasDescriptionElement

hasDescription

setDescriptionElement

getDescription

setDescription

getAllergenicIndicatorElement

hasAllergenicIndicatorElement

hasAllergenicIndicator

setAllergenicIndicatorElement

getAllergenicIndicator

setAllergenicIndicator

getManufacturer

setManufacturer

hasManufacturer

addManufacturer

addManufacturer

getManufacturerFirstRep

getSpecifiedSubstance

setSpecifiedSubstance

hasSpecifiedSubstance

addSpecifiedSubstance

addSpecifiedSubstance

getSpecifiedSubstanceFirstRep

getSubstance

hasSubstance

setSubstance

listChildren

getNamedProperty

getProperty

setProperty

setProperty