Contract.Term (HAPI FHIR Structures - DSTU2 (FHIR v1.0.0) 1.4 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.api.BaseIdentifiableElement
  - - ca.uhn.fhir.model.dstu2.resource.Contract.Term

All Implemented Interfaces:

ICompositeElement, IElement, IIdentifiableElement, IResourceBlock, ISupportsUndeclaredExtensions, Serializable, IBase

Enclosing class:

Contract
```
public static class Contract.Term
extends BaseIdentifiableElement
implements IResourceBlock
```
Block class for child element: Contract.term ()
Definition: One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Term()

Constructors
Constructor and Description
`Term()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BoundCodeableConceptDt<ContractActionCodesEnum>`	`addAction()` Add a value for action ()
`BoundCodeableConceptDt<ContractActionCodesEnum>`	`addAction(ContractActionCodesEnum theValue)` Add a value for action () using an enumerated type.
`CodeableConceptDt`	`addActionReason()` Adds and returns a new value for actionReason ()
`Contract.Term`	`addActionReason(CodeableConceptDt theValue)` Adds a given new value for actionReason ()
`Contract.TermActor`	`addActor()` Adds and returns a new value for actor ()
`Contract.Term`	`addActor(Contract.TermActor theValue)` Adds a given new value for actor ()
`Contract.Term`	`addGroup()` Adds and returns a new value for group ()
`Contract.Term`	`addGroup(Contract.Term theValue)` Adds a given new value for group ()
`Contract.TermValuedItem`	`addValuedItem()` Adds and returns a new value for valuedItem ()
`Contract.Term`	`addValuedItem(Contract.TermValuedItem theValue)` Adds a given new value for valuedItem ()
`List<BoundCodeableConceptDt<ContractActionCodesEnum>>`	`getAction()` Gets the value(s) for action ().
`BoundCodeableConceptDt<ContractActionCodesEnum>`	`getActionFirstRep()` Gets the first repetition for action (), creating it if it does not already exist.
`List<CodeableConceptDt>`	`getActionReason()` Gets the value(s) for actionReason ().
`CodeableConceptDt`	`getActionReasonFirstRep()` Gets the first repetition for actionReason (), creating it if it does not already exist.
`List<Contract.TermActor>`	`getActor()` Gets the value(s) for actor ().
`Contract.TermActor`	`getActorFirstRep()` Gets the first repetition for actor (), creating it if it does not already exist.
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`PeriodDt`	`getApplies()` Gets the value(s) for applies ().
`List<Contract.Term>`	`getGroup()` Gets the value(s) for group ().
`Contract.Term`	`getGroupFirstRep()` Gets the first repetition for group (), creating it if it does not already exist.
`IdentifierDt`	`getIdentifier()` Gets the value(s) for identifier ().
`Date`	`getIssued()` Gets the value(s) for issued ().
`DateTimeDt`	`getIssuedElement()` Gets the value(s) for issued ().
`ResourceReferenceDt`	`getSubject()` Gets the value(s) for subject ().
`CodeableConceptDt`	`getSubType()` Gets the value(s) for subType ().
`String`	`getText()` Gets the value(s) for text ().
`StringDt`	`getTextElement()` Gets the value(s) for text ().
`BoundCodeableConceptDt<ContractTermTypeCodesEnum>`	`getType()` Gets the value(s) for type ().
`List<Contract.TermValuedItem>`	`getValuedItem()` Gets the value(s) for valuedItem ().
`Contract.TermValuedItem`	`getValuedItemFirstRep()` Gets the first repetition for valuedItem (), creating it if it does not already exist.
`boolean`	`isEmpty()`
`Contract.Term`	`setAction(ContractActionCodesEnum theValue)` Sets the value(s), and clears any existing value(s) for action ()
`Contract.Term`	`setAction(List<BoundCodeableConceptDt<ContractActionCodesEnum>> theValue)` Sets the value(s) for action ()
`Contract.Term`	`setActionReason(List<CodeableConceptDt> theValue)` Sets the value(s) for actionReason ()
`Contract.Term`	`setActor(List<Contract.TermActor> theValue)` Sets the value(s) for actor ()
`Contract.Term`	`setApplies(PeriodDt theValue)` Sets the value(s) for applies ()
`Contract.Term`	`setGroup(List<Contract.Term> theValue)` Sets the value(s) for group ()
`Contract.Term`	`setIdentifier(IdentifierDt theValue)` Sets the value(s) for identifier ()
`Contract.Term`	`setIssued(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for issued ()
`Contract.Term`	`setIssued(DateTimeDt theValue)` Sets the value(s) for issued ()
`Contract.Term`	`setIssuedWithSecondsPrecision(Date theDate)` Sets the value for issued ()
`Contract.Term`	`setSubject(ResourceReferenceDt theValue)` Sets the value(s) for subject ()
`Contract.Term`	`setSubType(CodeableConceptDt theValue)` Sets the value(s) for subType ()
`Contract.Term`	`setText(String theString)` Sets the value for text ()
`Contract.Term`	`setText(StringDt theValue)` Sets the value(s) for text ()
`Contract.Term`	`setType(BoundCodeableConceptDt<ContractTermTypeCodesEnum> theValue)` Sets the value(s) for type ()
`Contract.Term`	`setType(ContractTermTypeCodesEnum theValue)` Sets the value(s) for type ()
`Contract.Term`	`setValuedItem(List<Contract.TermValuedItem> theValue)` Sets the value(s) for valuedItem ()

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement
getElementSpecificId, getId, setElementSpecificId, setId, setId

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, isBaseEmpty

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IIdentifiableElement
getElementSpecificId, getId, setElementSpecificId, setId, setId

- Constructor Detail
  - Term
```
public Term()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
  - getIdentifier
```
public IdentifierDt getIdentifier()
```
    Gets the value(s) for identifier (). creating it if it does not exist. Will not return null.
    Definition: Unique identifier for this particular Contract Provision.
  - setIdentifier
```
public Contract.Term setIdentifier(IdentifierDt theValue)
```
    Sets the value(s) for identifier ()
    Definition: Unique identifier for this particular Contract Provision.
  - getIssuedElement
```
public DateTimeDt getIssuedElement()
```
    Gets the value(s) for issued (). creating it if it does not exist. Will not return null.
    Definition: When this Contract Provision was issued.
  - getIssued
```
public Date getIssued()
```
    Gets the value(s) for issued (). creating it if it does not exist. Will not return null.
    Definition: When this Contract Provision was issued.
  - setIssued
```
public Contract.Term setIssued(DateTimeDt theValue)
```
    Sets the value(s) for issued ()
    Definition: When this Contract Provision was issued.
  - setIssued
```
public Contract.Term setIssued(Date theDate,
                               TemporalPrecisionEnum thePrecision)
```
    Sets the value for issued ()
    Definition: When this Contract Provision was issued.
  - setIssuedWithSecondsPrecision
```
public Contract.Term setIssuedWithSecondsPrecision(Date theDate)
```
    Sets the value for issued ()
    Definition: When this Contract Provision was issued.
  - getApplies
```
public PeriodDt getApplies()
```
    Gets the value(s) for applies (). creating it if it does not exist. Will not return null.
    Definition: Relevant time or time-period when this Contract Provision is applicable.
  - setApplies
```
public Contract.Term setApplies(PeriodDt theValue)
```
    Sets the value(s) for applies ()
    Definition: Relevant time or time-period when this Contract Provision is applicable.
  - getType
```
public BoundCodeableConceptDt<ContractTermTypeCodesEnum> getType()
```
    Gets the value(s) for type (). creating it if it does not exist. Will not return null.
    Definition: Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life time maximum benefit.
  - setType
```
public Contract.Term setType(BoundCodeableConceptDt<ContractTermTypeCodesEnum> theValue)
```
    Sets the value(s) for type ()
    Definition: Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life time maximum benefit.
  - setType
```
public Contract.Term setType(ContractTermTypeCodesEnum theValue)
```
    Sets the value(s) for type ()
    Definition: Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life time maximum benefit.
  - getSubType
```
public CodeableConceptDt getSubType()
```
    Gets the value(s) for subType (). creating it if it does not exist. Will not return null.
    Definition: Subtype of this Contract Provision, e.g. life time maximum payment for a contract term for specific valued item, e.g. disability payment.
  - setSubType
```
public Contract.Term setSubType(CodeableConceptDt theValue)
```
    Sets the value(s) for subType ()
    Definition: Subtype of this Contract Provision, e.g. life time maximum payment for a contract term for specific valued item, e.g. disability payment.
  - getSubject
```
public ResourceReferenceDt getSubject()
```
    Gets the value(s) for subject (). creating it if it does not exist. Will not return null.
    Definition: Who or what this Contract Provision is about.
  - setSubject
```
public Contract.Term setSubject(ResourceReferenceDt theValue)
```
    Sets the value(s) for subject ()
    Definition: Who or what this Contract Provision is about.
  - getAction
```
public List<BoundCodeableConceptDt<ContractActionCodesEnum>> getAction()
```
    Gets the value(s) for action (). creating it if it does not exist. Will not return null.
    Definition: Action stipulated by this Contract Provision.
  - setAction
```
public Contract.Term setAction(List<BoundCodeableConceptDt<ContractActionCodesEnum>> theValue)
```
    Sets the value(s) for action ()
    Definition: Action stipulated by this Contract Provision.
  - addAction
```
public BoundCodeableConceptDt<ContractActionCodesEnum> addAction(ContractActionCodesEnum theValue)
```
    Add a value for action () using an enumerated type. This is intended as a convenience method for situations where the FHIR defined ValueSets are mandatory or contain the desirable codes. If you wish to use codes other than those which are built-in, you may also use the addAction() method.
    Definition: Action stipulated by this Contract Provision.
  - getActionFirstRep
```
public BoundCodeableConceptDt<ContractActionCodesEnum> getActionFirstRep()
```
    Gets the first repetition for action (), creating it if it does not already exist.
    Definition: Action stipulated by this Contract Provision.
  - addAction
```
public BoundCodeableConceptDt<ContractActionCodesEnum> addAction()
```
    Add a value for action ()
    Definition: Action stipulated by this Contract Provision.
  - setAction
```
public Contract.Term setAction(ContractActionCodesEnum theValue)
```
    Sets the value(s), and clears any existing value(s) for action ()
    Definition: Action stipulated by this Contract Provision.
  - getActionReason
```
public List<CodeableConceptDt> getActionReason()
```
    Gets the value(s) for actionReason (). creating it if it does not exist. Will not return null.
    Definition: Reason or purpose for the action stipulated by this Contract Provision.
  - setActionReason
```
public Contract.Term setActionReason(List<CodeableConceptDt> theValue)
```
    Sets the value(s) for actionReason ()
    Definition: Reason or purpose for the action stipulated by this Contract Provision.
  - addActionReason
```
public CodeableConceptDt addActionReason()
```
    Adds and returns a new value for actionReason ()
    Definition: Reason or purpose for the action stipulated by this Contract Provision.
  - addActionReason
```
public Contract.Term addActionReason(CodeableConceptDt theValue)
```
    Adds a given new value for actionReason ()
    Definition: Reason or purpose for the action stipulated by this Contract Provision.
    
    Parameters:
    
    theValue - The actionReason to add (must not be null)
  - getActionReasonFirstRep
```
public CodeableConceptDt getActionReasonFirstRep()
```
    Gets the first repetition for actionReason (), creating it if it does not already exist.
    Definition: Reason or purpose for the action stipulated by this Contract Provision.
  - getActor
```
public List<Contract.TermActor> getActor()
```
    Gets the value(s) for actor (). creating it if it does not exist. Will not return null.
    Definition: List of actors participating in this Contract Provision.
  - setActor
```
public Contract.Term setActor(List<Contract.TermActor> theValue)
```
    Sets the value(s) for actor ()
    Definition: List of actors participating in this Contract Provision.
  - addActor
```
public Contract.TermActor addActor()
```
    Adds and returns a new value for actor ()
    Definition: List of actors participating in this Contract Provision.
  - addActor
```
public Contract.Term addActor(Contract.TermActor theValue)
```
    Adds a given new value for actor ()
    Definition: List of actors participating in this Contract Provision.
    
    Parameters:
    
    theValue - The actor to add (must not be null)
  - getActorFirstRep
```
public Contract.TermActor getActorFirstRep()
```
    Gets the first repetition for actor (), creating it if it does not already exist.
    Definition: List of actors participating in this Contract Provision.
  - getTextElement
```
public StringDt getTextElement()
```
    Gets the value(s) for text (). creating it if it does not exist. Will not return null.
    Definition: Human readable form of this Contract Provision.
  - getText
```
public String getText()
```
    Gets the value(s) for text (). creating it if it does not exist. Will not return null.
    Definition: Human readable form of this Contract Provision.
  - setText
```
public Contract.Term setText(StringDt theValue)
```
    Sets the value(s) for text ()
    Definition: Human readable form of this Contract Provision.
  - setText
```
public Contract.Term setText(String theString)
```
    Sets the value for text ()
    Definition: Human readable form of this Contract Provision.
  - getValuedItem
```
public List<Contract.TermValuedItem> getValuedItem()
```
    Gets the value(s) for valuedItem (). creating it if it does not exist. Will not return null.
    Definition: Contract Provision Valued Item List
  - setValuedItem
```
public Contract.Term setValuedItem(List<Contract.TermValuedItem> theValue)
```
    Sets the value(s) for valuedItem ()
    Definition: Contract Provision Valued Item List
  - addValuedItem
```
public Contract.TermValuedItem addValuedItem()
```
    Adds and returns a new value for valuedItem ()
    Definition: Contract Provision Valued Item List
  - addValuedItem
```
public Contract.Term addValuedItem(Contract.TermValuedItem theValue)
```
    Adds a given new value for valuedItem ()
    Definition: Contract Provision Valued Item List
    
    Parameters:
    
    theValue - The valuedItem to add (must not be null)
  - getValuedItemFirstRep
```
public Contract.TermValuedItem getValuedItemFirstRep()
```
    Gets the first repetition for valuedItem (), creating it if it does not already exist.
    Definition: Contract Provision Valued Item List
  - getGroup
```
public List<Contract.Term> getGroup()
```
    Gets the value(s) for group (). creating it if it does not exist. Will not return null.
    Definition: Nested group of Contract Provisions.
  - setGroup
```
public Contract.Term setGroup(List<Contract.Term> theValue)
```
    Sets the value(s) for group ()
    Definition: Nested group of Contract Provisions.
  - addGroup
```
public Contract.Term addGroup()
```
    Adds and returns a new value for group ()
    Definition: Nested group of Contract Provisions.
  - addGroup
```
public Contract.Term addGroup(Contract.Term theValue)
```
    Adds a given new value for group ()
    Definition: Nested group of Contract Provisions.
    
    Parameters:
    
    theValue - The group to add (must not be null)
  - getGroupFirstRep
```
public Contract.Term getGroupFirstRep()
```
    Gets the first repetition for group (), creating it if it does not already exist.
    Definition: Nested group of Contract Provisions.

Class Contract.Term

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IIdentifiableElement

Constructor Detail

Term

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

getIssuedElement

getIssued

setIssued

setIssued

setIssuedWithSecondsPrecision

getApplies

setApplies

getType

setType

setType

getSubType

setSubType

getSubject

setSubject

getAction

setAction

addAction

getActionFirstRep

addAction

setAction

getActionReason

setActionReason

addActionReason

addActionReason

getActionReasonFirstRep

getActor

setActor

addActor

addActor

getActorFirstRep

getTextElement

getText

setText

setText

getValuedItem

setValuedItem

addValuedItem

addValuedItem

getValuedItemFirstRep

getGroup

setGroup

addGroup

addGroup

getGroupFirstRep