Package org.hl7.fhir.r5.model

Class Ingredient.IngredientSubstanceStrengthComponent

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.BackboneElement

org.hl7.fhir.r5.model.Ingredient.IngredientSubstanceStrengthComponent

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Enclosing class:

Ingredient

public static class Ingredient.IngredientSubstanceStrengthComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected CodeableConcept	basis	A code that indicates if the strength is, for example, based on the ingredient substance as stated or on the substance base (when the ingredient is a salt).
protected DataType	concentration	The strength per unitary volume (or mass).
protected List<CodeableConcept>	country	The country or countries for which the strength range applies.
protected StringType	measurementPoint	For when strength is measured at a particular point or distance.
protected DataType	presentation	The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item.
protected List<Ingredient.IngredientSubstanceStrengthReferenceStrengthComponent>	referenceStrength	Strength expressed in terms of a reference substance.
protected StringType	textConcentration	A textual represention of either the whole of the concentration strength or a part of it - with the rest being in Strength.concentration as a ratio.
protected StringType	textPresentation	A textual represention of either the whole of the presentation strength or a part of it - with the rest being in Strength.presentation as a ratio.

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

modifierExtension

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

extension, id

Constructor Summary

Constructors

Constructor	Description
IngredientSubstanceStrengthComponent()	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
CodeableConcept	addCountry()
Ingredient.IngredientSubstanceStrengthComponent	addCountry(CodeableConcept t)
Ingredient.IngredientSubstanceStrengthReferenceStrengthComponent	addReferenceStrength()
Ingredient.IngredientSubstanceStrengthComponent	addReferenceStrength(Ingredient.IngredientSubstanceStrengthReferenceStrengthComponent t)
Ingredient.IngredientSubstanceStrengthComponent	copy()
void	copyValues(Ingredient.IngredientSubstanceStrengthComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
CodeableConcept	getBasis()
DataType	getConcentration()
CodeableConcept	getConcentrationCodeableConcept()
Quantity	getConcentrationQuantity()
Ratio	getConcentrationRatio()
RatioRange	getConcentrationRatioRange()
List<CodeableConcept>	getCountry()
CodeableConcept	getCountryFirstRep()
String	getMeasurementPoint()
StringType	getMeasurementPointElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
DataType	getPresentation()
CodeableConcept	getPresentationCodeableConcept()
Quantity	getPresentationQuantity()
Ratio	getPresentationRatio()
RatioRange	getPresentationRatioRange()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<Ingredient.IngredientSubstanceStrengthReferenceStrengthComponent>	getReferenceStrength()
Ingredient.IngredientSubstanceStrengthReferenceStrengthComponent	getReferenceStrengthFirstRep()
String	getTextConcentration()
StringType	getTextConcentrationElement()
String	getTextPresentation()
StringType	getTextPresentationElement()
String[]	getTypesForProperty(int hash, String name)
boolean	hasBasis()
boolean	hasConcentration()
boolean	hasConcentrationCodeableConcept()
boolean	hasConcentrationQuantity()
boolean	hasConcentrationRatio()
boolean	hasConcentrationRatioRange()
boolean	hasCountry()
boolean	hasMeasurementPoint()
boolean	hasMeasurementPointElement()
boolean	hasPresentation()
boolean	hasPresentationCodeableConcept()
boolean	hasPresentationQuantity()
boolean	hasPresentationRatio()
boolean	hasPresentationRatioRange()
boolean	hasReferenceStrength()
boolean	hasTextConcentration()
boolean	hasTextConcentrationElement()
boolean	hasTextPresentation()
boolean	hasTextPresentationElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
Ingredient.IngredientSubstanceStrengthComponent	setBasis(CodeableConcept value)
Ingredient.IngredientSubstanceStrengthComponent	setConcentration(DataType value)
Ingredient.IngredientSubstanceStrengthComponent	setCountry(List<CodeableConcept> theCountry)
Ingredient.IngredientSubstanceStrengthComponent	setMeasurementPoint(String value)
Ingredient.IngredientSubstanceStrengthComponent	setMeasurementPointElement(StringType value)
Ingredient.IngredientSubstanceStrengthComponent	setPresentation(DataType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Ingredient.IngredientSubstanceStrengthComponent	setReferenceStrength(List<Ingredient.IngredientSubstanceStrengthReferenceStrengthComponent> theReferenceStrength)
Ingredient.IngredientSubstanceStrengthComponent	setTextConcentration(String value)
Ingredient.IngredientSubstanceStrengthComponent	setTextConcentrationElement(StringType value)
Ingredient.IngredientSubstanceStrengthComponent	setTextPresentation(String value)
Ingredient.IngredientSubstanceStrengthComponent	setTextPresentationElement(StringType value)

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

addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyExtensions, copyNewExtensions, copyValues, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, removeExtension, setModifierExtension

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

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionFirstRep, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus

Methods 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, 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, isResource, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, 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.IBase

getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

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

getUserData, setUserData

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

addExtension, getExtension, hasExtension

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

addModifierExtension, getModifierExtension, hasModifierExtension

Field Details

presentation

protected DataType presentation

The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. Unit of presentation refers to the quantity that the item occurs in e.g. a strength per tablet size, perhaps 'per 20mg' (the size of the tablet). It is not generally normalized as a unitary unit, which would be 'per mg').

textPresentation

protected StringType textPresentation

A textual represention of either the whole of the presentation strength or a part of it - with the rest being in Strength.presentation as a ratio.

concentration

protected DataType concentration

The strength per unitary volume (or mass).

textConcentration

protected StringType textConcentration

A textual represention of either the whole of the concentration strength or a part of it - with the rest being in Strength.concentration as a ratio.

basis

protected CodeableConcept basis

A code that indicates if the strength is, for example, based on the ingredient substance as stated or on the substance base (when the ingredient is a salt).

measurementPoint

protected StringType measurementPoint

For when strength is measured at a particular point or distance. There are products where strength is measured at a particular point. For example, the strength of the ingredient in some inhalers is measured at a particular position relative to the point of aerosolization.

country

protected List<CodeableConcept> country

The country or countries for which the strength range applies.

referenceStrength

protected List<Ingredient.IngredientSubstanceStrengthReferenceStrengthComponent> referenceStrength

Strength expressed in terms of a reference substance. For when the ingredient strength is additionally expressed as equivalent to the strength of some other closely related substance (e.g. salt vs. base). Reference strength represents the strength (quantitative composition) of the active moiety of the active substance. There are situations when the active substance and active moiety are different, therefore both a strength and a reference strength are needed.

Constructor Details

IngredientSubstanceStrengthComponent

public IngredientSubstanceStrengthComponent()

Constructor

Method Details

getPresentation

public DataType getPresentation()

Returns:

presentation (The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. Unit of presentation refers to the quantity that the item occurs in e.g. a strength per tablet size, perhaps 'per 20mg' (the size of the tablet). It is not generally normalized as a unitary unit, which would be 'per mg').)

getPresentationRatio

public Ratio getPresentationRatio()
                           throws org.hl7.fhir.exceptions.FHIRException

Returns:

presentation (The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. Unit of presentation refers to the quantity that the item occurs in e.g. a strength per tablet size, perhaps 'per 20mg' (the size of the tablet). It is not generally normalized as a unitary unit, which would be 'per mg').)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasPresentationRatio

public boolean hasPresentationRatio()

getPresentationRatioRange

public RatioRange getPresentationRatioRange()
                                     throws org.hl7.fhir.exceptions.FHIRException

Returns:

presentation (The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. Unit of presentation refers to the quantity that the item occurs in e.g. a strength per tablet size, perhaps 'per 20mg' (the size of the tablet). It is not generally normalized as a unitary unit, which would be 'per mg').)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasPresentationRatioRange

public boolean hasPresentationRatioRange()

getPresentationCodeableConcept

public CodeableConcept getPresentationCodeableConcept()
                                               throws org.hl7.fhir.exceptions.FHIRException

Returns:

presentation (The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. Unit of presentation refers to the quantity that the item occurs in e.g. a strength per tablet size, perhaps 'per 20mg' (the size of the tablet). It is not generally normalized as a unitary unit, which would be 'per mg').)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasPresentationCodeableConcept

public boolean hasPresentationCodeableConcept()

getPresentationQuantity

public Quantity getPresentationQuantity()
                                 throws org.hl7.fhir.exceptions.FHIRException

Returns:

presentation (The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. Unit of presentation refers to the quantity that the item occurs in e.g. a strength per tablet size, perhaps 'per 20mg' (the size of the tablet). It is not generally normalized as a unitary unit, which would be 'per mg').)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasPresentationQuantity

public boolean hasPresentationQuantity()

hasPresentation

public boolean hasPresentation()

setPresentation

public Ingredient.IngredientSubstanceStrengthComponent setPresentation(DataType value)

Parameters:

value - presentation (The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. Unit of presentation refers to the quantity that the item occurs in e.g. a strength per tablet size, perhaps 'per 20mg' (the size of the tablet). It is not generally normalized as a unitary unit, which would be 'per mg').)

getTextPresentationElement

public StringType getTextPresentationElement()

Returns:

textPresentation (A textual represention of either the whole of the presentation strength or a part of it - with the rest being in Strength.presentation as a ratio.). This is the underlying object with id, value and extensions. The accessor "getTextPresentation" gives direct access to the value

hasTextPresentationElement

public boolean hasTextPresentationElement()

hasTextPresentation

public boolean hasTextPresentation()

setTextPresentationElement

public Ingredient.IngredientSubstanceStrengthComponent setTextPresentationElement(StringType value)

Parameters:

value - textPresentation (A textual represention of either the whole of the presentation strength or a part of it - with the rest being in Strength.presentation as a ratio.). This is the underlying object with id, value and extensions. The accessor "getTextPresentation" gives direct access to the value

getTextPresentation

public String getTextPresentation()

Returns:

A textual represention of either the whole of the presentation strength or a part of it - with the rest being in Strength.presentation as a ratio.

setTextPresentation

public Ingredient.IngredientSubstanceStrengthComponent setTextPresentation(String value)

Parameters:

value - A textual represention of either the whole of the presentation strength or a part of it - with the rest being in Strength.presentation as a ratio.

getConcentration

public DataType getConcentration()

Returns:

concentration (The strength per unitary volume (or mass).)

getConcentrationRatio

public Ratio getConcentrationRatio()
                            throws org.hl7.fhir.exceptions.FHIRException

Returns:

concentration (The strength per unitary volume (or mass).)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasConcentrationRatio

public boolean hasConcentrationRatio()

getConcentrationRatioRange

public RatioRange getConcentrationRatioRange()
                                      throws org.hl7.fhir.exceptions.FHIRException

Returns:

concentration (The strength per unitary volume (or mass).)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasConcentrationRatioRange

public boolean hasConcentrationRatioRange()

getConcentrationCodeableConcept

public CodeableConcept getConcentrationCodeableConcept()
                                                throws org.hl7.fhir.exceptions.FHIRException

Returns:

concentration (The strength per unitary volume (or mass).)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasConcentrationCodeableConcept

public boolean hasConcentrationCodeableConcept()

getConcentrationQuantity

public Quantity getConcentrationQuantity()
                                  throws org.hl7.fhir.exceptions.FHIRException

Returns:

concentration (The strength per unitary volume (or mass).)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasConcentrationQuantity

public boolean hasConcentrationQuantity()

hasConcentration

public boolean hasConcentration()

setConcentration

public Ingredient.IngredientSubstanceStrengthComponent setConcentration(DataType value)

Parameters:

value - concentration (The strength per unitary volume (or mass).)

getTextConcentrationElement

public StringType getTextConcentrationElement()

Returns:

textConcentration (A textual represention of either the whole of the concentration strength or a part of it - with the rest being in Strength.concentration as a ratio.). This is the underlying object with id, value and extensions. The accessor "getTextConcentration" gives direct access to the value

hasTextConcentrationElement

public boolean hasTextConcentrationElement()

hasTextConcentration

public boolean hasTextConcentration()

setTextConcentrationElement

public Ingredient.IngredientSubstanceStrengthComponent setTextConcentrationElement(StringType value)

Parameters:

value - textConcentration (A textual represention of either the whole of the concentration strength or a part of it - with the rest being in Strength.concentration as a ratio.). This is the underlying object with id, value and extensions. The accessor "getTextConcentration" gives direct access to the value

getTextConcentration

public String getTextConcentration()

Returns:

A textual represention of either the whole of the concentration strength or a part of it - with the rest being in Strength.concentration as a ratio.

setTextConcentration

public Ingredient.IngredientSubstanceStrengthComponent setTextConcentration(String value)

Parameters:

value - A textual represention of either the whole of the concentration strength or a part of it - with the rest being in Strength.concentration as a ratio.

getBasis

public CodeableConcept getBasis()

Returns:

basis (A code that indicates if the strength is, for example, based on the ingredient substance as stated or on the substance base (when the ingredient is a salt).)

hasBasis

public boolean hasBasis()

setBasis

public Ingredient.IngredientSubstanceStrengthComponent setBasis(CodeableConcept value)

Parameters:

value - basis (A code that indicates if the strength is, for example, based on the ingredient substance as stated or on the substance base (when the ingredient is a salt).)

getMeasurementPointElement

public StringType getMeasurementPointElement()

Returns:

measurementPoint (For when strength is measured at a particular point or distance. There are products where strength is measured at a particular point. For example, the strength of the ingredient in some inhalers is measured at a particular position relative to the point of aerosolization.). This is the underlying object with id, value and extensions. The accessor "getMeasurementPoint" gives direct access to the value

hasMeasurementPointElement

public boolean hasMeasurementPointElement()

hasMeasurementPoint

public boolean hasMeasurementPoint()

setMeasurementPointElement

public Ingredient.IngredientSubstanceStrengthComponent setMeasurementPointElement(StringType value)

Parameters:

value - measurementPoint (For when strength is measured at a particular point or distance. There are products where strength is measured at a particular point. For example, the strength of the ingredient in some inhalers is measured at a particular position relative to the point of aerosolization.). This is the underlying object with id, value and extensions. The accessor "getMeasurementPoint" gives direct access to the value

getMeasurementPoint

public String getMeasurementPoint()

Returns:

For when strength is measured at a particular point or distance. There are products where strength is measured at a particular point. For example, the strength of the ingredient in some inhalers is measured at a particular position relative to the point of aerosolization.

setMeasurementPoint

public Ingredient.IngredientSubstanceStrengthComponent setMeasurementPoint(String value)

Parameters:

value - For when strength is measured at a particular point or distance. There are products where strength is measured at a particular point. For example, the strength of the ingredient in some inhalers is measured at a particular position relative to the point of aerosolization.

getCountry

public List<CodeableConcept> getCountry()

Returns:

country (The country or countries for which the strength range applies.)

setCountry

public Ingredient.IngredientSubstanceStrengthComponent setCountry(List<CodeableConcept> theCountry)

Returns:

Returns a reference to this for easy method chaining

hasCountry

public boolean hasCountry()

addCountry

public CodeableConcept addCountry()

addCountry

public Ingredient.IngredientSubstanceStrengthComponent addCountry(CodeableConcept t)

getCountryFirstRep

public CodeableConcept getCountryFirstRep()

Returns:

The first repetition of repeating field country, creating it if it does not already exist {3}

getReferenceStrength

public List<Ingredient.IngredientSubstanceStrengthReferenceStrengthComponent> getReferenceStrength()

Returns:

referenceStrength (Strength expressed in terms of a reference substance. For when the ingredient strength is additionally expressed as equivalent to the strength of some other closely related substance (e.g. salt vs. base). Reference strength represents the strength (quantitative composition) of the active moiety of the active substance. There are situations when the active substance and active moiety are different, therefore both a strength and a reference strength are needed.)

setReferenceStrength

public Ingredient.IngredientSubstanceStrengthComponent setReferenceStrength(List<Ingredient.IngredientSubstanceStrengthReferenceStrengthComponent> theReferenceStrength)

Returns:

Returns a reference to this for easy method chaining

hasReferenceStrength

public boolean hasReferenceStrength()

addReferenceStrength

public Ingredient.IngredientSubstanceStrengthReferenceStrengthComponent addReferenceStrength()

addReferenceStrength

public Ingredient.IngredientSubstanceStrengthComponent addReferenceStrength(Ingredient.IngredientSubstanceStrengthReferenceStrengthComponent t)

getReferenceStrengthFirstRep

public Ingredient.IngredientSubstanceStrengthReferenceStrengthComponent getReferenceStrengthFirstRep()

Returns:

The first repetition of repeating field referenceStrength, creating it if it does not already exist {3}

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class BackboneElement

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class BackboneElement

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 BackboneElement

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 BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

copy

public Ingredient.IngredientSubstanceStrengthComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(Ingredient.IngredientSubstanceStrengthComponent dst)

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class BackboneElement

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class BackboneElement

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class BackboneElement

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class BackboneElement

Returns:

the FHIR type name of the instance (not the java class name)