Package org.hl7.fhir.r4.model

Class MedicinalProductIngredient

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.BaseResource

org.hl7.fhir.r4.model.Resource

org.hl7.fhir.r4.model.DomainResource

org.hl7.fhir.r4.model.MedicinalProductIngredient

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 MedicinalProductIngredient
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	MedicinalProductIngredient.MedicinalProductIngredientSpecifiedSubstanceComponent
static class	MedicinalProductIngredient.MedicinalProductIngredientSpecifiedSubstanceStrengthComponent
static class	MedicinalProductIngredient.MedicinalProductIngredientSpecifiedSubstanceStrengthReferenceStrengthComponent
static class	MedicinalProductIngredient.MedicinalProductIngredientSubstanceComponent

Field Summary

Fields

Modifier and Type	Field	Description
protected BooleanType	allergenicIndicator	If the ingredient is a known or suspected allergen.
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.
protected List<Reference>	manufacturer	Manufacturer of this Ingredient.
protected List<Organization>	manufacturerTarget	The actual objects that are the target of the reference (Manufacturer of this Ingredient.)
protected CodeableConcept	role	Ingredient role e.g.
protected List<MedicinalProductIngredient.MedicinalProductIngredientSpecifiedSubstanceComponent>	specifiedSubstance	A specified substance that comprises this ingredient.
protected MedicinalProductIngredient.MedicinalProductIngredientSubstanceComponent	substance	The ingredient substance.

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

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.r4.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
MedicinalProductIngredient()	Constructor
MedicinalProductIngredient(CodeableConcept role)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Reference	addManufacturer()
MedicinalProductIngredient	addManufacturer(Reference t)
Organization	addManufacturerTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
MedicinalProductIngredient.MedicinalProductIngredientSpecifiedSubstanceComponent	addSpecifiedSubstance()
MedicinalProductIngredient	addSpecifiedSubstance(MedicinalProductIngredient.MedicinalProductIngredientSpecifiedSubstanceComponent t)
MedicinalProductIngredient	copy()
void	copyValues(MedicinalProductIngredient dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
boolean	getAllergenicIndicator()
BooleanType	getAllergenicIndicatorElement()
Identifier	getIdentifier()
List<Reference>	getManufacturer()
Reference	getManufacturerFirstRep()
List<Organization>	getManufacturerTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
CodeableConcept	getRole()
List<MedicinalProductIngredient.MedicinalProductIngredientSpecifiedSubstanceComponent>	getSpecifiedSubstance()
MedicinalProductIngredient.MedicinalProductIngredientSpecifiedSubstanceComponent	getSpecifiedSubstanceFirstRep()
MedicinalProductIngredient.MedicinalProductIngredientSubstanceComponent	getSubstance()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAllergenicIndicator()
boolean	hasAllergenicIndicatorElement()
boolean	hasIdentifier()
boolean	hasManufacturer()
boolean	hasRole()
boolean	hasSpecifiedSubstance()
boolean	hasSubstance()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
MedicinalProductIngredient	setAllergenicIndicator(boolean value)
MedicinalProductIngredient	setAllergenicIndicatorElement(BooleanType value)
MedicinalProductIngredient	setIdentifier(Identifier value)
MedicinalProductIngredient	setManufacturer(List<Reference> theManufacturer)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
MedicinalProductIngredient	setRole(CodeableConcept value)
MedicinalProductIngredient	setSpecifiedSubstance(List<MedicinalProductIngredient.MedicinalProductIngredientSpecifiedSubstanceComponent> theSpecifiedSubstance)
MedicinalProductIngredient	setSubstance(MedicinalProductIngredient.MedicinalProductIngredientSubstanceComponent value)
protected MedicinalProductIngredient	typedCopy()

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

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.r4.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.r4.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, 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 e.g. Active ingredient, excipient.

allergenicIndicator

protected BooleanType allergenicIndicator

If the ingredient is a known or suspected allergen.

manufacturer

protected List<Reference> manufacturer

Manufacturer of this Ingredient.

manufacturerTarget

protected List<Organization> manufacturerTarget

The actual objects that are the target of the reference (Manufacturer of this Ingredient.)

specifiedSubstance

protected List<MedicinalProductIngredient.MedicinalProductIngredientSpecifiedSubstanceComponent> specifiedSubstance

A specified substance that comprises this ingredient.

substance

protected MedicinalProductIngredient.MedicinalProductIngredientSubstanceComponent substance

The ingredient substance.

Constructor Detail

MedicinalProductIngredient

public MedicinalProductIngredient()

Constructor

MedicinalProductIngredient

public MedicinalProductIngredient(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 MedicinalProductIngredient 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 MedicinalProductIngredient 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 MedicinalProductIngredient 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 MedicinalProductIngredient setAllergenicIndicator(boolean value)

Parameters:

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

getManufacturer

public List<Reference> getManufacturer()

Returns:

manufacturer (Manufacturer of this Ingredient.)

setManufacturer

public MedicinalProductIngredient setManufacturer(List<Reference> theManufacturer)

Returns:

Returns a reference to this for easy method chaining

hasManufacturer

public boolean hasManufacturer()

addManufacturer

public Reference addManufacturer()

addManufacturer

public MedicinalProductIngredient addManufacturer(Reference t)

getManufacturerFirstRep

public Reference getManufacturerFirstRep()

Returns:

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

getManufacturerTarget

@Deprecated
public List<Organization> getManufacturerTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

addManufacturerTarget

@Deprecated
public Organization addManufacturerTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getSpecifiedSubstance

public List<MedicinalProductIngredient.MedicinalProductIngredientSpecifiedSubstanceComponent> getSpecifiedSubstance()

Returns:

specifiedSubstance (A specified substance that comprises this ingredient.)

setSpecifiedSubstance

public MedicinalProductIngredient setSpecifiedSubstance(List<MedicinalProductIngredient.MedicinalProductIngredientSpecifiedSubstanceComponent> theSpecifiedSubstance)

Returns:

Returns a reference to this for easy method chaining

hasSpecifiedSubstance

public boolean hasSpecifiedSubstance()

addSpecifiedSubstance

public MedicinalProductIngredient.MedicinalProductIngredientSpecifiedSubstanceComponent addSpecifiedSubstance()

addSpecifiedSubstance

public MedicinalProductIngredient addSpecifiedSubstance(MedicinalProductIngredient.MedicinalProductIngredientSpecifiedSubstanceComponent t)

getSpecifiedSubstanceFirstRep

public MedicinalProductIngredient.MedicinalProductIngredientSpecifiedSubstanceComponent getSpecifiedSubstanceFirstRep()

Returns:

The first repetition of repeating field specifiedSubstance, creating it if it does not already exist

getSubstance

public MedicinalProductIngredient.MedicinalProductIngredientSubstanceComponent getSubstance()

Returns:

substance (The ingredient substance.)

hasSubstance

public boolean hasSubstance()

setSubstance

public MedicinalProductIngredient setSubstance(MedicinalProductIngredient.MedicinalProductIngredientSubstanceComponent value)

Parameters:

value - substance (The ingredient substance.)

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

Specified by:

copy in class DomainResource

copyValues

public void copyValues(MedicinalProductIngredient dst)

typedCopy

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