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 classIngredient.IngredientSpecifiedSubstanceComponentstatic classIngredient.IngredientSpecifiedSubstanceStrengthComponentstatic classIngredient.IngredientSpecifiedSubstanceStrengthReferenceStrengthComponentstatic classIngredient.IngredientSubstanceComponent
-
Field Summary
Fields Modifier and Type Field Description protected BooleanTypeallergenicIndicatorIf the ingredient is a known or suspected allergen.protected IdentifieridentifierThe 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.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierprotected List<Reference>manufacturerThe organization that manufactures this ingredient.protected CodeableConceptroleIngredient role e.g.static StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_SPECIFIED_SUBSTANCESearch parameter: specified-substancestatic StringSP_SUBSTANCESearch parameter: substancestatic ca.uhn.fhir.rest.gclient.TokenClientParamSPECIFIED_SUBSTANCEFluent Client search parameter constant for specified-substanceprotected List<Ingredient.IngredientSpecifiedSubstanceComponent>specifiedSubstanceA specified substance that comprises this ingredient.protected Ingredient.IngredientSubstanceComponentsubstanceThe substance that comprises this ingredient.static ca.uhn.fhir.rest.gclient.TokenClientParamSUBSTANCEFluent 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
-
-
Constructor Summary
Constructors Constructor Description Ingredient()ConstructorIngredient(CodeableConcept role)Constructor
-
Method Summary
-
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
-
-
-
-
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 e.g. Active ingredient, excipient.
-
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: identifierDescription: 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 identifierDescription: 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-substanceDescription: 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-substanceDescription: 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: substanceDescription: 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 substanceDescription: 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 e.g. Active ingredient, excipient.)
-
hasRole
public boolean hasRole()
-
setRole
public Ingredient setRole(CodeableConcept value)
- Parameters:
value-role(Ingredient role e.g. Active ingredient, excipient.)
-
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
thisfor 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
thisfor 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:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public Ingredient copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(Ingredient dst)
-
typedCopy
protected Ingredient typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-