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.IngredientManufacturerComponentstatic classIngredient.IngredientSubstanceComponentstatic classIngredient.IngredientSubstanceStrengthComponentstatic classIngredient.IngredientSubstanceStrengthReferenceStrengthComponent
-
Field Summary
Fields Modifier and Type Field Description protected BooleanTypeallergenicIndicatorIf the ingredient is a known or suspected allergen.static ca.uhn.fhir.rest.gclient.ReferenceClientParamFORFluent Client search parameter constant for forprotected List<Reference>for_The product which this ingredient is a constituent part of.protected List<CodeableConcept>functionA classification of the ingredient identifying its precise purpose(s) in the drug product.static ca.uhn.fhir.rest.gclient.TokenClientParamFUNCTIONFluent Client search parameter constant for functionprotected CodeableConceptgroupA 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 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 identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_FORConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_MANUFACTURERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_SUBSTANCEConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_SUBSTANCE_DEFINITIONConstant for fluent queries to be used to add include statements.protected List<Ingredient.IngredientManufacturerComponent>manufacturerAn organization that manufactures this ingredient.static ca.uhn.fhir.rest.gclient.ReferenceClientParamMANUFACTURERFluent Client search parameter constant for manufacturerprotected CodeableConceptroleA classification of the ingredient identifying its purpose within the product, e.g.static ca.uhn.fhir.rest.gclient.TokenClientParamROLEFluent Client search parameter constant for rolestatic StringSP_FORSearch parameter: forstatic StringSP_FUNCTIONSearch parameter: functionstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_MANUFACTURERSearch parameter: manufacturerstatic StringSP_ROLESearch parameter: rolestatic StringSP_SUBSTANCESearch parameter: substancestatic StringSP_SUBSTANCE_CODESearch parameter: substance-codestatic StringSP_SUBSTANCE_DEFINITIONSearch parameter: substance-definitionprotected Enumeration<Enumerations.PublicationStatus>statusThe status of this ingredient.protected Ingredient.IngredientSubstanceComponentsubstanceThe substance that comprises this ingredient.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSUBSTANCEFluent Client search parameter constant for substancestatic ca.uhn.fhir.rest.gclient.TokenClientParamSUBSTANCE_CODEFluent Client search parameter constant for substance-codestatic ca.uhn.fhir.rest.gclient.ReferenceClientParamSUBSTANCE_DEFINITIONFluent 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
-
-
Constructor Summary
Constructors Constructor Description Ingredient()ConstructorIngredient(Enumerations.PublicationStatus status, CodeableConcept role, Ingredient.IngredientSubstanceComponent substance)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, 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
-
-
-
-
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.
-
status
protected Enumeration<Enumerations.PublicationStatus> status
The status of this ingredient. Enables tracking the life-cycle of the content.
-
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: forDescription: 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 forDescription: 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: functionDescription: 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 functionDescription: 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: 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_MANUFACTURER
public static final String SP_MANUFACTURER
Search parameter: manufacturerDescription: 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 manufacturerDescription: 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: roleDescription: 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 roleDescription: 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-codeDescription: 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-codeDescription: 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-definitionDescription: 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-definitionDescription: 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: substanceDescription: 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 substanceDescription: 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 Detail
-
Ingredient
public Ingredient()
Constructor
-
Ingredient
public Ingredient(Enumerations.PublicationStatus status, CodeableConcept role, Ingredient.IngredientSubstanceComponent substance)
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.)
-
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
thisfor easy method chaining
-
hasFor
public boolean hasFor()
-
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
thisfor 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
thisfor 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:
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
-
-