Quantity (org.hl7.fhir.r4 5.4.0 API)

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.Quantity

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, 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.ICompositeType, ICoding

Direct Known Subclasses:

Age, Count, Distance, Duration, MoneyQuantity, SimpleQuantity
```
public class Quantity
extends Type
implements org.hl7.fhir.instance.model.api.ICompositeType, ICoding
```
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Quantity.QuantityComparator

static class Quantity.QuantityComparatorEnumFactory

Nested Classes
Modifier and Type	Class and Description
`static class`	`Quantity.QuantityComparator`
`static class`	`Quantity.QuantityComparatorEnumFactory`

Field Summary

Fields
Modifier and Type	Field and Description
`protected CodeType`	`code` A computer processable form of the unit in some unit representation system.
`protected Enumeration<Quantity.QuantityComparator>`	`comparator` How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g.
`protected UriType`	`system` The identification of the system that provides the coded form of the unit.
`protected StringType`	`unit` A human-readable form of the unit.
`protected DecimalType`	`value` The value of the measured amount.

Fields inherited from class org.hl7.fhir.r4.model.Element
extension, id

Constructor Summary

Constructors
Constructor and Description
`Quantity()` Constructor
`Quantity(double theValue)` Convenience constructor
`Quantity(long theValue)` Convenience constructor
`Quantity(Quantity.QuantityComparator theComparator, double theValue, String theSystem, String theCode, String theUnit)` Convenience constructor
`Quantity(Quantity.QuantityComparator theComparator, long theValue, String theSystem, String theCode, String theUnit)` Convenience constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`Quantity`	`copy()`
`void`	`copyValues(Quantity dst)`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`static Quantity`	`fromUcum(String v, String code)`
`String`	`getCode()`
`CodeType`	`getCodeElement()`
`Quantity.QuantityComparator`	`getComparator()`
`Enumeration<Quantity.QuantityComparator>`	`getComparatorElement()`
`String`	`getDisplay()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`String`	`getSystem()`
`UriType`	`getSystemElement()`
`String[]`	`getTypesForProperty(int hash, String name)`
`String`	`getUnit()`
`StringType`	`getUnitElement()`
`BigDecimal`	`getValue()`
`DecimalType`	`getValueElement()`
`String`	`getVersion()`
`boolean`	`hasCode()`
`boolean`	`hasCodeElement()`
`boolean`	`hasComparator()`
`boolean`	`hasComparatorElement()`
`boolean`	`hasDisplay()`
`boolean`	`hasSystem()`
`boolean`	`hasSystemElement()`
`boolean`	`hasUnit()`
`boolean`	`hasUnitElement()`
`boolean`	`hasValue()`
`boolean`	`hasValueElement()`
`boolean`	`hasVersion()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`Quantity`	`setCode(String value)`
`Quantity`	`setCodeElement(CodeType value)`
`Quantity`	`setComparator(Quantity.QuantityComparator value)`
`Quantity`	`setComparatorElement(Enumeration<Quantity.QuantityComparator> value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`Quantity`	`setSystem(String value)`
`Quantity`	`setSystemElement(UriType value)`
`Quantity`	`setUnit(String value)`
`Quantity`	`setUnitElement(StringType value)`
`Quantity`	`setValue(BigDecimal value)`
`Quantity`	`setValue(double value)`
`Quantity`	`setValue(long value)`
`Quantity`	`setValueElement(DecimalType value)`
`boolean`	`supportsDisplay()`
`boolean`	`supportsVersion()`
`protected Quantity`	`typedCopy()`

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.IBaseElement
getUserData, setUserData

- Field Detail
  - value
```
protected DecimalType value
```
    The value of the measured amount. The value includes an implicit precision in the presentation of the value.
  - comparator
```
protected Enumeration<Quantity.QuantityComparator> comparator
```
    How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
  - unit
```
protected StringType unit
```
    A human-readable form of the unit.
  - system
```
protected UriType system
```
    The identification of the system that provides the coded form of the unit.
  - code
```
protected CodeType code
```
    A computer processable form of the unit in some unit representation system.
- Constructor Detail
  - Quantity
```
public Quantity()
```
    Constructor
  - Quantity
```
public Quantity(double theValue)
```
    Convenience constructor
    
    Parameters:
    
    theValue - The value
  - Quantity
```
public Quantity(long theValue)
```
    Convenience constructor
    
    Parameters:
    
    theValue - The value
  - Quantity
```
public Quantity(Quantity.QuantityComparator theComparator,
                double theValue,
                String theSystem,
                String theCode,
                String theUnit)
```
    Convenience constructor
    
    Parameters:
    
    theComparator - The comparator
    
    theValue - The value
    
    theSystem - The setSystem(String) (the code system for the units}
    
    theCode - The setCode(String) (the code for the units}
    
    theUnit - The setUnit(String) (the human readable display name for the units}
  - Quantity
```
public Quantity(Quantity.QuantityComparator theComparator,
                long theValue,
                String theSystem,
                String theCode,
                String theUnit)
```
    Convenience constructor
    
    Parameters:
    
    theComparator - The comparator
    
    theValue - The value
    
    theSystem - The setSystem(String) (the code system for the units}
    
    theCode - The setCode(String) (the code for the units}
    
    theUnit - The setUnit(String) (the human readable display name for the units}
- Method Detail
  - getValueElement
```
public DecimalType getValueElement()
```
    Returns:
    
    value (The value of the measured amount. The value includes an implicit precision in the presentation of the value.). This is the underlying object with id, value and extensions. The accessor "getValue" gives direct access to the value
  - hasValueElement
```
public boolean hasValueElement()
```
  - hasValue
```
public boolean hasValue()
```
  - setValueElement
```
public Quantity setValueElement(DecimalType value)
```
    Parameters:
    
    value - value (The value of the measured amount. The value includes an implicit precision in the presentation of the value.). This is the underlying object with id, value and extensions. The accessor "getValue" gives direct access to the value
  - getValue
```
public BigDecimal getValue()
```
    Returns:
    
    The value of the measured amount. The value includes an implicit precision in the presentation of the value.
  - setValue
```
public Quantity setValue(BigDecimal value)
```
    Parameters:
    
    value - The value of the measured amount. The value includes an implicit precision in the presentation of the value.
  - setValue
```
public Quantity setValue(long value)
```
    Parameters:
    
    value - The value of the measured amount. The value includes an implicit precision in the presentation of the value.
  - setValue
```
public Quantity setValue(double value)
```
    Parameters:
    
    value - The value of the measured amount. The value includes an implicit precision in the presentation of the value.
  - getComparatorElement
```
public Enumeration<Quantity.QuantityComparator> getComparatorElement()
```
    Returns:
    
    comparator (How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.). This is the underlying object with id, value and extensions. The accessor "getComparator" gives direct access to the value
  - hasComparatorElement
```
public boolean hasComparatorElement()
```
  - hasComparator
```
public boolean hasComparator()
```
  - setComparatorElement
```
public Quantity setComparatorElement(Enumeration<Quantity.QuantityComparator> value)
```
    Parameters:
    
    value - comparator (How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.). This is the underlying object with id, value and extensions. The accessor "getComparator" gives direct access to the value
  - getComparator
```
public Quantity.QuantityComparator getComparator()
```
    Returns:
    
    How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
  - setComparator
```
public Quantity setComparator(Quantity.QuantityComparator value)
```
    Parameters:
    
    value - How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
  - getUnitElement
```
public StringType getUnitElement()
```
    Returns:
    
    unit (A human-readable form of the unit.). This is the underlying object with id, value and extensions. The accessor "getUnit" gives direct access to the value
  - hasUnitElement
```
public boolean hasUnitElement()
```
  - hasUnit
```
public boolean hasUnit()
```
  - setUnitElement
```
public Quantity setUnitElement(StringType value)
```
    Parameters:
    
    value - unit (A human-readable form of the unit.). This is the underlying object with id, value and extensions. The accessor "getUnit" gives direct access to the value
  - getUnit
```
public String getUnit()
```
    Returns:
    
    A human-readable form of the unit.
  - setUnit
```
public Quantity setUnit(String value)
```
    Parameters:
    
    value - A human-readable form of the unit.
  - getSystemElement
```
public UriType getSystemElement()
```
    Returns:
    
    system (The identification of the system that provides the coded form of the unit.). This is the underlying object with id, value and extensions. The accessor "getSystem" gives direct access to the value
  - hasSystemElement
```
public boolean hasSystemElement()
```
  - hasSystem
```
public boolean hasSystem()
```
    Specified by:
    
    hasSystem in interface ICoding
  - setSystemElement
```
public Quantity setSystemElement(UriType value)
```
    Parameters:
    
    value - system (The identification of the system that provides the coded form of the unit.). This is the underlying object with id, value and extensions. The accessor "getSystem" gives direct access to the value
  - getSystem
```
public String getSystem()
```
    Specified by:
    
    getSystem in interface ICoding
    
    Returns:
    
    The identification of the system that provides the coded form of the unit.
  - setSystem
```
public Quantity setSystem(String value)
```
    Parameters:
    
    value - The identification of the system that provides the coded form of the unit.
  - getCodeElement
```
public CodeType getCodeElement()
```
    Returns:
    
    code (A computer processable form of the unit in some unit representation system.). This is the underlying object with id, value and extensions. The accessor "getCode" gives direct access to the value
  - hasCodeElement
```
public boolean hasCodeElement()
```
  - hasCode
```
public boolean hasCode()
```
    Specified by:
    
    hasCode in interface ICoding
  - setCodeElement
```
public Quantity setCodeElement(CodeType value)
```
    Parameters:
    
    value - code (A computer processable form of the unit in some unit representation system.). This is the underlying object with id, value and extensions. The accessor "getCode" gives direct access to the value
  - getCode
```
public String getCode()
```
    Specified by:
    
    getCode in interface ICoding
    
    Returns:
    
    A computer processable form of the unit in some unit representation system.
  - setCode
```
public Quantity setCode(String value)
```
    Parameters:
    
    value - A computer processable form of the unit in some unit representation system.
  - listChildren
```
protected void listChildren(List<Property> children)
```
    Overrides:
    
    listChildren in class Element
  - getNamedProperty
```
public Property getNamedProperty(int _hash,
                                 String _name,
                                 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getNamedProperty in class Element
    
    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 Element
    
    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 Element
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class Element
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty in class Element
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getTypesForProperty in class Element
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class Element
    
    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 Element
  - copy
```
public Quantity copy()
```
    Overrides:
    
    copy in class Type
  - copyValues
```
public void copyValues(Quantity dst)
```
  - typedCopy
```
protected Quantity typedCopy()
```
    Specified by:
    
    typedCopy in class Type
  - equalsDeep
```
public boolean equalsDeep(Base other_)
```
    Overrides:
    
    equalsDeep in class Element
  - equalsShallow
```
public boolean equalsShallow(Base other_)
```
    Overrides:
    
    equalsShallow in class Element
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class Element
  - getVersion
```
public String getVersion()
```
    Specified by:
    
    getVersion in interface ICoding
  - hasVersion
```
public boolean hasVersion()
```
    Specified by:
    
    hasVersion in interface ICoding
  - supportsVersion
```
public boolean supportsVersion()
```
    Specified by:
    
    supportsVersion in interface ICoding
  - getDisplay
```
public String getDisplay()
```
    Specified by:
    
    getDisplay in interface ICoding
  - hasDisplay
```
public boolean hasDisplay()
```
    Specified by:
    
    hasDisplay in interface ICoding
  - supportsDisplay
```
public boolean supportsDisplay()
```
    Specified by:
    
    supportsDisplay in interface ICoding
  - fromUcum
```
public static Quantity fromUcum(String v,
                                String code)
```

Class Quantity

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

Field Detail

value

comparator

unit

system

code

Constructor Detail

Quantity

Quantity

Quantity

Quantity

Quantity

Method Detail

getValueElement

hasValueElement

hasValue

setValueElement

getValue

setValue

setValue

setValue

getComparatorElement

hasComparatorElement

hasComparator

setComparatorElement

getComparator

setComparator

getUnitElement

hasUnitElement

hasUnit

setUnitElement

getUnit

setUnit

getSystemElement

hasSystemElement

hasSystem

setSystemElement

getSystem

setSystem

getCodeElement

hasCodeElement

hasCode

setCodeElement

getCode

setCode

listChildren

getNamedProperty

getProperty

setProperty

setProperty

makeProperty

getTypesForProperty

addChild

fhirType

copy

copyValues

typedCopy

equalsDeep

equalsShallow

isEmpty

getVersion

hasVersion

supportsVersion

getDisplay

hasDisplay

supportsDisplay

fromUcum