Contract.TermValuedItemComponent (HAPI FHIR Structures

java.lang.Object
- org.hl7.fhir.dstu3.model.Base
- - org.hl7.fhir.dstu3.model.Element
  - - org.hl7.fhir.dstu3.model.BackboneElement
    - - org.hl7.fhir.dstu3.model.Contract.TermValuedItemComponent

All Implemented Interfaces:

IElement, Serializable, IBase, IBaseBackboneElement, IBaseElement, IBaseHasExtensions, IBaseHasModifierExtensions

Enclosing class:

Contract
```
public static class Contract.TermValuedItemComponent
extends BackboneElement
implements IBaseBackboneElement
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected DateTimeType`	`effectiveTime` Indicates the time during which this Contract Term ValuedItem information is effective.
`protected Type`	`entity` Specific type of Contract Provision Valued Item that may be priced.
`protected DecimalType`	`factor` A real number that represents a multiplier used in determining the overall value of the Contract Provision Valued Item delivered.
`protected Identifier`	`identifier` Identifies a Contract Provision Valued Item instance.
`protected Money`	`net` Expresses the product of the Contract Provision Valued Item unitQuantity and the unitPriceAmt.
`protected DecimalType`	`points` An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Provision Valued Item delivered.
`protected SimpleQuantity`	`quantity` Specifies the units by which the Contract Provision Valued Item is measured or counted, and quantifies the countable or measurable Contract Term Valued Item instances.
`protected Money`	`unitPrice` A Contract Provision Valued Item unit valuation measure.

Fields inherited from class org.hl7.fhir.dstu3.model.BackboneElement
modifierExtension

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

Constructor Summary

Constructors
Constructor and Description

TermValuedItemComponent()
Constructor

Constructors
Constructor and Description
`TermValuedItemComponent()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`Contract.TermValuedItemComponent`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`Date`	`getEffectiveTime()`
`DateTimeType`	`getEffectiveTimeElement()`
`Type`	`getEntity()`
`CodeableConcept`	`getEntityCodeableConcept()`
`Reference`	`getEntityReference()`
`BigDecimal`	`getFactor()`
`DecimalType`	`getFactorElement()`
`Identifier`	`getIdentifier()`
`Money`	`getNet()`
`BigDecimal`	`getPoints()`
`DecimalType`	`getPointsElement()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`SimpleQuantity`	`getQuantity()`
`String[]`	`getTypesForProperty(int hash, String name)`
`Money`	`getUnitPrice()`
`boolean`	`hasEffectiveTime()`
`boolean`	`hasEffectiveTimeElement()`
`boolean`	`hasEntity()`
`boolean`	`hasEntityCodeableConcept()`
`boolean`	`hasEntityReference()`
`boolean`	`hasFactor()`
`boolean`	`hasFactorElement()`
`boolean`	`hasIdentifier()`
`boolean`	`hasNet()`
`boolean`	`hasPoints()`
`boolean`	`hasPointsElement()`
`boolean`	`hasQuantity()`
`boolean`	`hasUnitPrice()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`Contract.TermValuedItemComponent`	`setEffectiveTime(Date value)`
`Contract.TermValuedItemComponent`	`setEffectiveTimeElement(DateTimeType value)`
`Contract.TermValuedItemComponent`	`setEntity(Type value)`
`Contract.TermValuedItemComponent`	`setFactor(BigDecimal value)`
`Contract.TermValuedItemComponent`	`setFactor(double value)`
`Contract.TermValuedItemComponent`	`setFactor(long value)`
`Contract.TermValuedItemComponent`	`setFactorElement(DecimalType value)`
`Contract.TermValuedItemComponent`	`setIdentifier(Identifier value)`
`Contract.TermValuedItemComponent`	`setNet(Money value)`
`Contract.TermValuedItemComponent`	`setPoints(BigDecimal value)`
`Contract.TermValuedItemComponent`	`setPoints(double value)`
`Contract.TermValuedItemComponent`	`setPoints(long value)`
`Contract.TermValuedItemComponent`	`setPointsElement(DecimalType value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`Contract.TermValuedItemComponent`	`setQuantity(SimpleQuantity value)`
`Contract.TermValuedItemComponent`	`setUnitPrice(Money value)`

Methods inherited from class org.hl7.fhir.dstu3.model.BackboneElement
addModifierExtension, addModifierExtension, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtension

Methods inherited from class org.hl7.fhir.dstu3.model.Element
addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setExtension, setId, setIdBase, setIdElement

Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, 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, hasFormatComment

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 Detail
  - entity
```
protected Type entity
```
    Specific type of Contract Provision Valued Item that may be priced.
  - identifier
```
protected Identifier identifier
```
    Identifies a Contract Provision Valued Item instance.
  - effectiveTime
```
protected DateTimeType effectiveTime
```
    Indicates the time during which this Contract Term ValuedItem information is effective.
  - quantity
```
protected SimpleQuantity quantity
```
    Specifies the units by which the Contract Provision Valued Item is measured or counted, and quantifies the countable or measurable Contract Term Valued Item instances.
  - unitPrice
```
protected Money unitPrice
```
    A Contract Provision Valued Item unit valuation measure.
  - factor
```
protected DecimalType factor
```
    A real number that represents a multiplier used in determining the overall value of the Contract Provision Valued Item delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
  - points
```
protected DecimalType points
```
    An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Provision Valued Item delivered. The concept of Points allows for assignment of point values for a Contract ProvisionValued Item, such that a monetary amount can be assigned to each point.
  - net
```
protected Money net
```
    Expresses the product of the Contract Provision Valued Item unitQuantity and the unitPriceAmt. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.
- Constructor Detail
  - TermValuedItemComponent
```
public TermValuedItemComponent()
```
    Constructor
- Method Detail
  - getEntity
```
public Type getEntity()
```
    Returns:
    
    entity (Specific type of Contract Provision Valued Item that may be priced.)
  - getEntityCodeableConcept
```
public CodeableConcept getEntityCodeableConcept()
                                         throws FHIRException
```
    Returns:
    
    entity (Specific type of Contract Provision Valued Item that may be priced.)
    
    Throws:
    
    FHIRException
  - hasEntityCodeableConcept
```
public boolean hasEntityCodeableConcept()
```
  - getEntityReference
```
public Reference getEntityReference()
                             throws FHIRException
```
    Returns:
    
    entity (Specific type of Contract Provision Valued Item that may be priced.)
    
    Throws:
    
    FHIRException
  - hasEntityReference
```
public boolean hasEntityReference()
```
  - hasEntity
```
public boolean hasEntity()
```
  - setEntity
```
public Contract.TermValuedItemComponent setEntity(Type value)
```
    Parameters:
    
    value - entity (Specific type of Contract Provision Valued Item that may be priced.)
  - getIdentifier
```
public Identifier getIdentifier()
```
    Returns:
    
    identifier (Identifies a Contract Provision Valued Item instance.)
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - setIdentifier
```
public Contract.TermValuedItemComponent setIdentifier(Identifier value)
```
    Parameters:
    
    value - identifier (Identifies a Contract Provision Valued Item instance.)
  - getEffectiveTimeElement
```
public DateTimeType getEffectiveTimeElement()
```
    Returns:
    
    effectiveTime (Indicates the time during which this Contract Term ValuedItem information is effective.). This is the underlying object with id, value and extensions. The accessor "getEffectiveTime" gives direct access to the value
  - hasEffectiveTimeElement
```
public boolean hasEffectiveTimeElement()
```
  - hasEffectiveTime
```
public boolean hasEffectiveTime()
```
  - setEffectiveTimeElement
```
public Contract.TermValuedItemComponent setEffectiveTimeElement(DateTimeType value)
```
    Parameters:
    
    value - effectiveTime (Indicates the time during which this Contract Term ValuedItem information is effective.). This is the underlying object with id, value and extensions. The accessor "getEffectiveTime" gives direct access to the value
  - getEffectiveTime
```
public Date getEffectiveTime()
```
    Returns:
    
    Indicates the time during which this Contract Term ValuedItem information is effective.
  - setEffectiveTime
```
public Contract.TermValuedItemComponent setEffectiveTime(Date value)
```
    Parameters:
    
    value - Indicates the time during which this Contract Term ValuedItem information is effective.
  - getQuantity
```
public SimpleQuantity getQuantity()
```
    Returns:
    
    quantity (Specifies the units by which the Contract Provision Valued Item is measured or counted, and quantifies the countable or measurable Contract Term Valued Item instances.)
  - hasQuantity
```
public boolean hasQuantity()
```
  - setQuantity
```
public Contract.TermValuedItemComponent setQuantity(SimpleQuantity value)
```
    Parameters:
    
    value - quantity (Specifies the units by which the Contract Provision Valued Item is measured or counted, and quantifies the countable or measurable Contract Term Valued Item instances.)
  - getUnitPrice
```
public Money getUnitPrice()
```
    Returns:
    
    unitPrice (A Contract Provision Valued Item unit valuation measure.)
  - hasUnitPrice
```
public boolean hasUnitPrice()
```
  - setUnitPrice
```
public Contract.TermValuedItemComponent setUnitPrice(Money value)
```
    Parameters:
    
    value - unitPrice (A Contract Provision Valued Item unit valuation measure.)
  - getFactorElement
```
public DecimalType getFactorElement()
```
    Returns:
    
    factor (A real number that represents a multiplier used in determining the overall value of the Contract Provision Valued Item delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.). This is the underlying object with id, value and extensions. The accessor "getFactor" gives direct access to the value
  - hasFactorElement
```
public boolean hasFactorElement()
```
  - hasFactor
```
public boolean hasFactor()
```
  - setFactorElement
```
public Contract.TermValuedItemComponent setFactorElement(DecimalType value)
```
    Parameters:
    
    value - factor (A real number that represents a multiplier used in determining the overall value of the Contract Provision Valued Item delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.). This is the underlying object with id, value and extensions. The accessor "getFactor" gives direct access to the value
  - getFactor
```
public BigDecimal getFactor()
```
    Returns:
    
    A real number that represents a multiplier used in determining the overall value of the Contract Provision Valued Item delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
  - setFactor
```
public Contract.TermValuedItemComponent setFactor(BigDecimal value)
```
    Parameters:
    
    value - A real number that represents a multiplier used in determining the overall value of the Contract Provision Valued Item delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
  - setFactor
```
public Contract.TermValuedItemComponent setFactor(long value)
```
    Parameters:
    
    value - A real number that represents a multiplier used in determining the overall value of the Contract Provision Valued Item delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
  - setFactor
```
public Contract.TermValuedItemComponent setFactor(double value)
```
    Parameters:
    
    value - A real number that represents a multiplier used in determining the overall value of the Contract Provision Valued Item delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
  - getPointsElement
```
public DecimalType getPointsElement()
```
    Returns:
    
    points (An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Provision Valued Item delivered. The concept of Points allows for assignment of point values for a Contract ProvisionValued Item, such that a monetary amount can be assigned to each point.). This is the underlying object with id, value and extensions. The accessor "getPoints" gives direct access to the value
  - hasPointsElement
```
public boolean hasPointsElement()
```
  - hasPoints
```
public boolean hasPoints()
```
  - setPointsElement
```
public Contract.TermValuedItemComponent setPointsElement(DecimalType value)
```
    Parameters:
    
    value - points (An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Provision Valued Item delivered. The concept of Points allows for assignment of point values for a Contract ProvisionValued Item, such that a monetary amount can be assigned to each point.). This is the underlying object with id, value and extensions. The accessor "getPoints" gives direct access to the value
  - getPoints
```
public BigDecimal getPoints()
```
    Returns:
    
    An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Provision Valued Item delivered. The concept of Points allows for assignment of point values for a Contract ProvisionValued Item, such that a monetary amount can be assigned to each point.
  - setPoints
```
public Contract.TermValuedItemComponent setPoints(BigDecimal value)
```
    Parameters:
    
    value - An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Provision Valued Item delivered. The concept of Points allows for assignment of point values for a Contract ProvisionValued Item, such that a monetary amount can be assigned to each point.
  - setPoints
```
public Contract.TermValuedItemComponent setPoints(long value)
```
    Parameters:
    
    value - An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Provision Valued Item delivered. The concept of Points allows for assignment of point values for a Contract ProvisionValued Item, such that a monetary amount can be assigned to each point.
  - setPoints
```
public Contract.TermValuedItemComponent setPoints(double value)
```
    Parameters:
    
    value - An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Provision Valued Item delivered. The concept of Points allows for assignment of point values for a Contract ProvisionValued Item, such that a monetary amount can be assigned to each point.
  - getNet
```
public Money getNet()
```
    Returns:
    
    net (Expresses the product of the Contract Provision Valued Item unitQuantity and the unitPriceAmt. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.)
  - hasNet
```
public boolean hasNet()
```
  - setNet
```
public Contract.TermValuedItemComponent setNet(Money value)
```
    Parameters:
    
    value - net (Expresses the product of the Contract Provision Valued Item unitQuantity and the unitPriceAmt. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.)
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class BackboneElement
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws FHIRException
```
    Overrides:
    
    getProperty in class BackboneElement
    
    Throws:
    
    FHIRException
  - setProperty
```
public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws FHIRException
```
    Overrides:
    
    setProperty in class BackboneElement
    
    Throws:
    
    FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws FHIRException
```
    Overrides:
    
    setProperty in class BackboneElement
    
    Throws:
    
    FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws FHIRException
```
    Overrides:
    
    makeProperty in class BackboneElement
    
    Throws:
    
    FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws FHIRException
```
    Overrides:
    
    getTypesForProperty in class BackboneElement
    
    Throws:
    
    FHIRException
  - addChild
```
public Base addChild(String name)
              throws FHIRException
```
    Overrides:
    
    addChild in class BackboneElement
    
    Throws:
    
    FHIRException
  - copy
```
public Contract.TermValuedItemComponent copy()
```
    Specified by:
    
    copy in class BackboneElement
  - 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 IBase
    
    Overrides:
    
    isEmpty in class BackboneElement
  - fhirType
```
public String fhirType()
```
    Overrides:
    
    fhirType in class BackboneElement

Class Contract.TermValuedItemComponent

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class org.hl7.fhir.dstu3.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.IBaseHasExtensions

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

Field Detail

entity

identifier

effectiveTime

quantity

unitPrice

factor

points

net

Constructor Detail

TermValuedItemComponent

Method Detail

getEntity

getEntityCodeableConcept

hasEntityCodeableConcept

getEntityReference

hasEntityReference

hasEntity

setEntity

getIdentifier

hasIdentifier

setIdentifier

getEffectiveTimeElement

hasEffectiveTimeElement

hasEffectiveTime

setEffectiveTimeElement

getEffectiveTime

setEffectiveTime

getQuantity

hasQuantity

setQuantity

getUnitPrice

hasUnitPrice

setUnitPrice

getFactorElement

hasFactorElement

hasFactor

setFactorElement

getFactor

setFactor

setFactor

setFactor

getPointsElement

hasPointsElement

hasPoints

setPointsElement

getPoints

setPoints

setPoints

setPoints

getNet

hasNet

setNet

listChildren

getProperty

setProperty

setProperty

makeProperty

getTypesForProperty

addChild

copy

equalsDeep

equalsShallow

isEmpty

fhirType