org.hl7.fhir.r4.model

Class SubstanceAmount

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.Element

org.hl7.fhir.r4.model.Type

org.hl7.fhir.r4.model.BackboneType

org.hl7.fhir.r4.model.SubstanceAmount

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.IBaseDatatype, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.ICompositeType

public class SubstanceAmount
extends BackboneType
implements org.hl7.fhir.instance.model.api.ICompositeType

Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of their complete covalent molecular structure; the presence of a salt (counter-ion) and/or solvates (water, alcohols) is also captured. Purity, grade, physical form or particle size are not taken into account in the definition of a chemical substance or in the assignment of a Substance ID.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubstanceAmount.SubstanceAmountReferenceRangeComponent

Field Summary

Fields

Modifier and Type	Field and Description
protected Type	amount Used to capture quantitative values for a variety of elements.
protected StringType	amountText A textual comment on a numeric value.
protected CodeableConcept	amountType Most elements that require a quantitative value will also have a field called amount type.
protected SubstanceAmount.SubstanceAmountReferenceRangeComponent	referenceRange Reference range of possible or expected values.

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

modifierExtension

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

extension, id

Constructor Summary

Constructors

Constructor and Description
SubstanceAmount() Constructor

Method Summary

Modifier and Type	Method and Description
Base	addChild(String name)
SubstanceAmount	copy()
void	copyValues(SubstanceAmount dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
Type	getAmount()
Quantity	getAmountQuantity()
Range	getAmountRange()
StringType	getAmountStringType()
String	getAmountText()
StringType	getAmountTextElement()
CodeableConcept	getAmountType()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
SubstanceAmount.SubstanceAmountReferenceRangeComponent	getReferenceRange()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAmount()
boolean	hasAmountQuantity()
boolean	hasAmountRange()
boolean	hasAmountStringType()
boolean	hasAmountText()
boolean	hasAmountTextElement()
boolean	hasAmountType()
boolean	hasReferenceRange()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
SubstanceAmount	setAmount(Type value)
SubstanceAmount	setAmountText(String value)
SubstanceAmount	setAmountTextElement(StringType value)
SubstanceAmount	setAmountType(CodeableConcept value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
SubstanceAmount	setReferenceRange(SubstanceAmount.SubstanceAmountReferenceRangeComponent value)
protected SubstanceAmount	typedCopy()

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

addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtension

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

addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement

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, isResource, 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.IBase

getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, 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.IBaseElement

getUserData, setUserData

Field Detail

amount

protected Type amount

Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.

amountType

protected CodeableConcept amountType

Most elements that require a quantitative value will also have a field called amount type. Amount type should always be specified because the actual value of the amount is often dependent on it. EXAMPLE: In capturing the actual relative amounts of substances or molecular fragments it is essential to indicate whether the amount refers to a mole ratio or weight ratio. For any given element an effort should be made to use same the amount type for all related definitional elements.

amountText

protected StringType amountText

A textual comment on a numeric value.

referenceRange

protected SubstanceAmount.SubstanceAmountReferenceRangeComponent referenceRange

Reference range of possible or expected values.

Constructor Detail

SubstanceAmount

public SubstanceAmount()

Constructor

Method Detail

getAmount

public Type getAmount()

Returns:

amount (Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.)

getAmountQuantity

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

Returns:

amount (Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasAmountQuantity

public boolean hasAmountQuantity()

getAmountRange

public Range getAmountRange()
                     throws org.hl7.fhir.exceptions.FHIRException

Returns:

amount (Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasAmountRange

public boolean hasAmountRange()

getAmountStringType

public StringType getAmountStringType()
                               throws org.hl7.fhir.exceptions.FHIRException

Returns:

amount (Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasAmountStringType

public boolean hasAmountStringType()

hasAmount

public boolean hasAmount()

setAmount

public SubstanceAmount setAmount(Type value)

Parameters:

value - amount (Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.)

getAmountType

public CodeableConcept getAmountType()

Returns:

amountType (Most elements that require a quantitative value will also have a field called amount type. Amount type should always be specified because the actual value of the amount is often dependent on it. EXAMPLE: In capturing the actual relative amounts of substances or molecular fragments it is essential to indicate whether the amount refers to a mole ratio or weight ratio. For any given element an effort should be made to use same the amount type for all related definitional elements.)

hasAmountType

public boolean hasAmountType()

setAmountType

public SubstanceAmount setAmountType(CodeableConcept value)

Parameters:

value - amountType (Most elements that require a quantitative value will also have a field called amount type. Amount type should always be specified because the actual value of the amount is often dependent on it. EXAMPLE: In capturing the actual relative amounts of substances or molecular fragments it is essential to indicate whether the amount refers to a mole ratio or weight ratio. For any given element an effort should be made to use same the amount type for all related definitional elements.)

getAmountTextElement

public StringType getAmountTextElement()

Returns:

amountText (A textual comment on a numeric value.). This is the underlying object with id, value and extensions. The accessor "getAmountText" gives direct access to the value

hasAmountTextElement

public boolean hasAmountTextElement()

hasAmountText

public boolean hasAmountText()

setAmountTextElement

public SubstanceAmount setAmountTextElement(StringType value)

Parameters:

value - amountText (A textual comment on a numeric value.). This is the underlying object with id, value and extensions. The accessor "getAmountText" gives direct access to the value

getAmountText

public String getAmountText()

Returns:

A textual comment on a numeric value.

setAmountText

public SubstanceAmount setAmountText(String value)

Parameters:

value - A textual comment on a numeric value.

getReferenceRange

public SubstanceAmount.SubstanceAmountReferenceRangeComponent getReferenceRange()

Returns:

referenceRange (Reference range of possible or expected values.)

hasReferenceRange

public boolean hasReferenceRange()

setReferenceRange

public SubstanceAmount setReferenceRange(SubstanceAmount.SubstanceAmountReferenceRangeComponent value)

Parameters:

value - referenceRange (Reference range of possible or expected values.)

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class BackboneType

getNamedProperty

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

Overrides:

getNamedProperty in class BackboneType

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 BackboneType

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 BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

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

Overrides:

makeProperty in class BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

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

Overrides:

getTypesForProperty in class BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

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

Overrides:

addChild in class BackboneType

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 BackboneType

copy

public SubstanceAmount copy()

Specified by:

copy in class BackboneType

copyValues

public void copyValues(SubstanceAmount dst)

typedCopy

protected SubstanceAmount typedCopy()

Specified by:

typedCopy in class Type

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class BackboneType

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class BackboneType

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class BackboneType