
Class 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
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic enumstatic classstatic classstatic classstatic classNested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base
Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected BooleanTypeIf the ingredient is a known or suspected allergen.protected MarkdownTypeA place for providing any notes that are relevant to the component, e.g. removed during process, adjusted for loss on drying.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for forThe product which this ingredient is a constituent part of.protected List<CodeableConcept> A classification of the ingredient identifying its precise purpose(s) in the drug product.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for functionprotected CodeableConceptA 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 IdentifierThe 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.TokenClientParamFluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.protected List<Ingredient.IngredientManufacturerComponent> The organization(s) that manufacture this ingredient.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for manufacturerprotected CodeableConceptA classification of the ingredient identifying its purpose within the product, e.g. active, inactive.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for rolestatic final StringSearch parameter: forstatic final StringSearch parameter: functionstatic final StringSearch parameter: identifierstatic final StringSearch parameter: manufacturerstatic final StringSearch parameter: rolestatic final StringSearch parameter: statusstatic final StringSearch parameter: strength-concentration-quantitystatic final StringSearch parameter: strength-presentation-quantitystatic final StringSearch parameter: substancestatic final StringSearch parameter: substance-codestatic final StringSearch parameter: substance-definitionprotected Enumeration<Enumerations.PublicationStatus> The status of this ingredient.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for statusstatic final ca.uhn.fhir.rest.gclient.QuantityClientParamFluent Client search parameter constant for strength-concentration-quantitystatic final ca.uhn.fhir.rest.gclient.QuantityClientParamFluent Client search parameter constant for strength-presentation-quantityprotected Ingredient.IngredientSubstanceComponentThe substance that comprises this ingredient.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for substancestatic final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for substance-codestatic final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for substance-definitionFields inherited from class org.hl7.fhir.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXTFields inherited from class org.hl7.fhir.r5.model.Resource
id, implicitRules, language, metaFields 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_TAGFields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET -
Constructor Summary
ConstructorsConstructorDescriptionConstructorIngredient(Enumerations.PublicationStatus status, CodeableConcept role, Ingredient.IngredientSubstanceComponent substance) Constructor -
Method Summary
Modifier and TypeMethodDescriptionaddFor()copy()voidcopyValues(Ingredient dst) booleanequalsDeep(Base other_) booleanequalsShallow(Base other_) fhirType()booleangetFor()getGroup()getNamedProperty(int _hash, String _name, boolean _checkValid) Base[]getProperty(int hash, String name, boolean checkValid) getRole()String[]getTypesForProperty(int hash, String name) booleanbooleanbooleanbooleanbooleanhasFor()booleanbooleanhasGroup()booleanbooleanbooleanhasRole()booleanbooleanbooleanbooleanisEmpty()protected voidlistChildren(List<Property> children) makeProperty(int hash, String name) voidremoveChild(String name, Base value) setAllergenicIndicator(boolean value) setComment(String value) setCommentElement(MarkdownType value) setFunction(List<CodeableConcept> theFunction) setGroup(CodeableConcept value) setIdentifier(Identifier value) setManufacturer(List<Ingredient.IngredientManufacturerComponent> theManufacturer) setProperty(int hash, String name, Base value) setProperty(String name, Base value) setRole(CodeableConcept value) protected IngredientMethods 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, setTextMethods 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, setWebPathMethods inherited from class org.hl7.fhir.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setIdMethods 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, setXhtmlMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserDataMethods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatCommentMethods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
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
The status of this ingredient. Enables tracking the life-cycle of the content. -
for_
The product which this ingredient is a constituent part of. -
role
A classification of the ingredient identifying its purpose within the product, e.g. active, inactive. -
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
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
If the ingredient is a known or suspected allergen. Note that this is a property of the substance, so if a reference to a SubstanceDefinition is used to decribe that (rather than just a code), the allergen information should go there, not here. -
comment
A place for providing any notes that are relevant to the component, e.g. removed during process, adjusted for loss on drying. -
manufacturer
The organization(s) that manufacture this ingredient. Can be used to indicate: 1) Organizations we are aware of that manufacture this ingredient 2) Specific Manufacturer(s) currently being used 3) Set of organisations allowed to manufacture this ingredient for this product Users must be clear on the application of context relevant to their use case. -
substance
The substance that comprises this ingredient. -
SP_FOR
Search parameter: forDescription: The product which this ingredient is a constituent part of
Type: reference
Path: Ingredient.for
- See Also:
-
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
Constant for fluent queries to be used to add include statements. Specifies the path value of "Ingredient:for". -
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:
-
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
Search parameter: identifierDescription: An identifier or code by which the ingredient can be referenced
Type: token
Path: Ingredient.identifier
- See Also:
-
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
Search parameter: manufacturerDescription: The organization that manufactures this ingredient
Type: reference
Path: Ingredient.manufacturer.manufacturer
- See Also:
-
MANUFACTURER
Fluent Client search parameter constant for manufacturerDescription: The organization that manufactures this ingredient
Type: reference
Path: Ingredient.manufacturer.manufacturer
-
INCLUDE_MANUFACTURER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Ingredient:manufacturer". -
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:
-
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_STATUS
Search parameter: statusDescription: The status of this ingredient. Enables tracking the life-cycle of the content
Type: token
Path: Ingredient.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: The status of this ingredient. Enables tracking the life-cycle of the content
Type: token
Path: Ingredient.status
-
SP_STRENGTH_CONCENTRATION_QUANTITY
Search parameter: strength-concentration-quantityDescription: Ingredient concentration strength as quantity
Type: quantity
Path: Ingredient.substance.strength.concentration.ofType(Quantity)
- See Also:
-
STRENGTH_CONCENTRATION_QUANTITY
Fluent Client search parameter constant for strength-concentration-quantityDescription: Ingredient concentration strength as quantity
Type: quantity
Path: Ingredient.substance.strength.concentration.ofType(Quantity)
-
SP_STRENGTH_PRESENTATION_QUANTITY
Search parameter: strength-presentation-quantityDescription: Ingredient presentation strength as quantity
Type: quantity
Path: Ingredient.substance.strength.presentation.ofType(Quantity)
- See Also:
-
STRENGTH_PRESENTATION_QUANTITY
Fluent Client search parameter constant for strength-presentation-quantityDescription: Ingredient presentation strength as quantity
Type: quantity
Path: Ingredient.substance.strength.presentation.ofType(Quantity)
-
SP_SUBSTANCE_CODE
Search parameter: substance-codeDescription: Reference to a concept (by class)
Type: token
Path: Ingredient.substance.code.concept
- See Also:
-
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
Search parameter: substance-definitionDescription: Reference to a resource (by instance)
Type: reference
Path: Ingredient.substance.code.reference
- See Also:
-
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
Constant for fluent queries to be used to add include statements. Specifies the path value of "Ingredient:substance-definition". -
SP_SUBSTANCE
Search parameter: substanceDescription: Reference to a resource (by instance)
Type: reference
Path: Ingredient.substance.code.reference
- See Also:
-
SUBSTANCE
Fluent Client search parameter constant for substanceDescription: Reference to a resource (by instance)
Type: reference
Path: Ingredient.substance.code.reference
-
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
- 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
-
setIdentifier
- 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
- 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
-
hasStatus
-
setStatusElement
- 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
- Returns:
- The status of this ingredient. Enables tracking the life-cycle of the content.
-
setStatus
- Parameters:
value- The status of this ingredient. Enables tracking the life-cycle of the content.
-
getFor
- Returns:
for_(The product which this ingredient is a constituent part of.)
-
setFor
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasFor
-
addFor
-
addFor
-
getForFirstRep
- Returns:
- The first repetition of repeating field
for_, creating it if it does not already exist {3}
-
getRole
- Returns:
role(A classification of the ingredient identifying its purpose within the product, e.g. active, inactive.)
-
hasRole
-
setRole
- Parameters:
value-role(A classification of the ingredient identifying its purpose within the product, e.g. active, inactive.)
-
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
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasFunction
-
addFunction
-
addFunction
-
getFunctionFirstRep
- Returns:
- The first repetition of repeating field
function, creating it if it does not already exist {3}
-
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
-
setGroup
- 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
- Returns:
allergenicIndicator(If the ingredient is a known or suspected allergen. Note that this is a property of the substance, so if a reference to a SubstanceDefinition is used to decribe that (rather than just a code), the allergen information should go there, not here.). This is the underlying object with id, value and extensions. The accessor "getAllergenicIndicator" gives direct access to the value
-
hasAllergenicIndicatorElement
-
hasAllergenicIndicator
-
setAllergenicIndicatorElement
- Parameters:
value-allergenicIndicator(If the ingredient is a known or suspected allergen. Note that this is a property of the substance, so if a reference to a SubstanceDefinition is used to decribe that (rather than just a code), the allergen information should go there, not here.). This is the underlying object with id, value and extensions. The accessor "getAllergenicIndicator" gives direct access to the value
-
getAllergenicIndicator
- Returns:
- If the ingredient is a known or suspected allergen. Note that this is a property of the substance, so if a reference to a SubstanceDefinition is used to decribe that (rather than just a code), the allergen information should go there, not here.
-
setAllergenicIndicator
- Parameters:
value- If the ingredient is a known or suspected allergen. Note that this is a property of the substance, so if a reference to a SubstanceDefinition is used to decribe that (rather than just a code), the allergen information should go there, not here.
-
getCommentElement
- Returns:
comment(A place for providing any notes that are relevant to the component, e.g. removed during process, adjusted for loss on drying.). This is the underlying object with id, value and extensions. The accessor "getComment" gives direct access to the value
-
hasCommentElement
-
hasComment
-
setCommentElement
- Parameters:
value-comment(A place for providing any notes that are relevant to the component, e.g. removed during process, adjusted for loss on drying.). This is the underlying object with id, value and extensions. The accessor "getComment" gives direct access to the value
-
getComment
- Returns:
- A place for providing any notes that are relevant to the component, e.g. removed during process, adjusted for loss on drying.
-
setComment
- Parameters:
value- A place for providing any notes that are relevant to the component, e.g. removed during process, adjusted for loss on drying.
-
getManufacturer
- Returns:
manufacturer(The organization(s) that manufacture this ingredient. Can be used to indicate: 1) Organizations we are aware of that manufacture this ingredient 2) Specific Manufacturer(s) currently being used 3) Set of organisations allowed to manufacture this ingredient for this product Users must be clear on the application of context relevant to their use case.)
-
setManufacturer
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasManufacturer
-
addManufacturer
-
addManufacturer
-
getManufacturerFirstRep
- Returns:
- The first repetition of repeating field
manufacturer, creating it if it does not already exist {3}
-
getSubstance
- Returns:
substance(The substance that comprises this ingredient.)
-
hasSubstance
-
setSubstance
- Parameters:
value-substance(The substance that comprises this ingredient.)
-
listChildren
- 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
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- 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
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource- Returns:
- the FHIR type name of the instance (not the java class name)
-
copy
- Specified by:
copyin classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
- Specified by:
getResourceTypein classResource
-