Contract.TermComponent (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.TermComponent

All Implemented Interfaces:

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

Enclosing class:

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

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<CodeableConcept>`	`action` Action stipulated by this Contract Provision.
`protected List<CodeableConcept>`	`actionReason` Reason or purpose for the action stipulated by this Contract Provision.
`protected List<Contract.TermAgentComponent>`	`agent` An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
`protected Period`	`applies` Relevant time or time-period when this Contract Provision is applicable.
`protected List<Contract.TermComponent>`	`group` Nested group of Contract Provisions.
`protected Identifier`	`identifier` Unique identifier for this particular Contract Provision.
`protected DateTimeType`	`issued` When this Contract Provision was issued.
`protected List<Coding>`	`securityLabel` A set of security labels that define which terms are controlled by this condition.
`protected CodeableConcept`	`subType` Subtype of this Contract Provision, e.g.
`protected StringType`	`text` Human readable form of this Contract Provision.
`protected List<Reference>`	`topic` The matter of concern in the context of this provision of the agrement.
`protected List<Resource>`	`topicTarget` The actual objects that are the target of the reference (The matter of concern in the context of this provision of the agrement.)
`protected CodeableConcept`	`type` Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g.
`protected List<Contract.TermValuedItemComponent>`	`valuedItem` Contract Provision Valued Item List.

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

TermComponent()
Constructor

Constructors
Constructor and Description
`TermComponent()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`CodeableConcept`	`addAction()`
`Contract.TermComponent`	`addAction(CodeableConcept t)`
`CodeableConcept`	`addActionReason()`
`Contract.TermComponent`	`addActionReason(CodeableConcept t)`
`Contract.TermAgentComponent`	`addAgent()`
`Contract.TermComponent`	`addAgent(Contract.TermAgentComponent t)`
`Base`	`addChild(String name)`
`Contract.TermComponent`	`addGroup()`
`Contract.TermComponent`	`addGroup(Contract.TermComponent t)`
`Coding`	`addSecurityLabel()`
`Contract.TermComponent`	`addSecurityLabel(Coding t)`
`Reference`	`addTopic()`
`Contract.TermComponent`	`addTopic(Reference t)`
`Contract.TermValuedItemComponent`	`addValuedItem()`
`Contract.TermComponent`	`addValuedItem(Contract.TermValuedItemComponent t)`
`Contract.TermComponent`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`List<CodeableConcept>`	`getAction()`
`CodeableConcept`	`getActionFirstRep()`
`List<CodeableConcept>`	`getActionReason()`
`CodeableConcept`	`getActionReasonFirstRep()`
`List<Contract.TermAgentComponent>`	`getAgent()`
`Contract.TermAgentComponent`	`getAgentFirstRep()`
`Period`	`getApplies()`
`List<Contract.TermComponent>`	`getGroup()`
`Contract.TermComponent`	`getGroupFirstRep()`
`Identifier`	`getIdentifier()`
`Date`	`getIssued()`
`DateTimeType`	`getIssuedElement()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`List<Coding>`	`getSecurityLabel()`
`Coding`	`getSecurityLabelFirstRep()`
`CodeableConcept`	`getSubType()`
`String`	`getText()`
`StringType`	`getTextElement()`
`List<Reference>`	`getTopic()`
`Reference`	`getTopicFirstRep()`
`List<Resource>`	`getTopicTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`CodeableConcept`	`getType()`
`String[]`	`getTypesForProperty(int hash, String name)`
`List<Contract.TermValuedItemComponent>`	`getValuedItem()`
`Contract.TermValuedItemComponent`	`getValuedItemFirstRep()`
`boolean`	`hasAction()`
`boolean`	`hasActionReason()`
`boolean`	`hasAgent()`
`boolean`	`hasApplies()`
`boolean`	`hasGroup()`
`boolean`	`hasIdentifier()`
`boolean`	`hasIssued()`
`boolean`	`hasIssuedElement()`
`boolean`	`hasSecurityLabel()`
`boolean`	`hasSubType()`
`boolean`	`hasText()`
`boolean`	`hasTextElement()`
`boolean`	`hasTopic()`
`boolean`	`hasType()`
`boolean`	`hasValuedItem()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`Contract.TermComponent`	`setAction(List<CodeableConcept> theAction)`
`Contract.TermComponent`	`setActionReason(List<CodeableConcept> theActionReason)`
`Contract.TermComponent`	`setAgent(List<Contract.TermAgentComponent> theAgent)`
`Contract.TermComponent`	`setApplies(Period value)`
`Contract.TermComponent`	`setGroup(List<Contract.TermComponent> theGroup)`
`Contract.TermComponent`	`setIdentifier(Identifier value)`
`Contract.TermComponent`	`setIssued(Date value)`
`Contract.TermComponent`	`setIssuedElement(DateTimeType value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`Contract.TermComponent`	`setSecurityLabel(List<Coding> theSecurityLabel)`
`Contract.TermComponent`	`setSubType(CodeableConcept value)`
`Contract.TermComponent`	`setText(String value)`
`Contract.TermComponent`	`setTextElement(StringType value)`
`Contract.TermComponent`	`setTopic(List<Reference> theTopic)`
`Contract.TermComponent`	`setType(CodeableConcept value)`
`Contract.TermComponent`	`setValuedItem(List<Contract.TermValuedItemComponent> theValuedItem)`

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
  - identifier
```
protected Identifier identifier
```
    Unique identifier for this particular Contract Provision.
  - issued
```
protected DateTimeType issued
```
    When this Contract Provision was issued.
  - applies
```
protected Period applies
```
    Relevant time or time-period when this Contract Provision is applicable.
  - type
```
protected CodeableConcept type
```
    Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life time maximum benefit.
  - subType
```
protected CodeableConcept subType
```
    Subtype of this Contract Provision, e.g. life time maximum payment for a contract term for specific valued item, e.g. disability payment.
  - topic
```
protected List<Reference> topic
```
    The matter of concern in the context of this provision of the agrement.
  - topicTarget
```
protected List<Resource> topicTarget
```
    The actual objects that are the target of the reference (The matter of concern in the context of this provision of the agrement.)
  - action
```
protected List<CodeableConcept> action
```
    Action stipulated by this Contract Provision.
  - actionReason
```
protected List<CodeableConcept> actionReason
```
    Reason or purpose for the action stipulated by this Contract Provision.
  - securityLabel
```
protected List<Coding> securityLabel
```
    A set of security labels that define which terms are controlled by this condition.
  - agent
```
protected List<Contract.TermAgentComponent> agent
```
    An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
  - text
```
protected StringType text
```
    Human readable form of this Contract Provision.
  - valuedItem
```
protected List<Contract.TermValuedItemComponent> valuedItem
```
    Contract Provision Valued Item List.
  - group
```
protected List<Contract.TermComponent> group
```
    Nested group of Contract Provisions.
- Constructor Detail
  - TermComponent
```
public TermComponent()
```
    Constructor
- Method Detail
  - getIdentifier
```
public Identifier getIdentifier()
```
    Returns:
    
    identifier (Unique identifier for this particular Contract Provision.)
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - setIdentifier
```
public Contract.TermComponent setIdentifier(Identifier value)
```
    Parameters:
    
    value - identifier (Unique identifier for this particular Contract Provision.)
  - getIssuedElement
```
public DateTimeType getIssuedElement()
```
    Returns:
    
    issued (When this Contract Provision was issued.). This is the underlying object with id, value and extensions. The accessor "getIssued" gives direct access to the value
  - hasIssuedElement
```
public boolean hasIssuedElement()
```
  - hasIssued
```
public boolean hasIssued()
```
  - setIssuedElement
```
public Contract.TermComponent setIssuedElement(DateTimeType value)
```
    Parameters:
    
    value - issued (When this Contract Provision was issued.). This is the underlying object with id, value and extensions. The accessor "getIssued" gives direct access to the value
  - getIssued
```
public Date getIssued()
```
    Returns:
    
    When this Contract Provision was issued.
  - setIssued
```
public Contract.TermComponent setIssued(Date value)
```
    Parameters:
    
    value - When this Contract Provision was issued.
  - getApplies
```
public Period getApplies()
```
    Returns:
    
    applies (Relevant time or time-period when this Contract Provision is applicable.)
  - hasApplies
```
public boolean hasApplies()
```
  - setApplies
```
public Contract.TermComponent setApplies(Period value)
```
    Parameters:
    
    value - applies (Relevant time or time-period when this Contract Provision is applicable.)
  - getType
```
public CodeableConcept getType()
```
    Returns:
    
    type (Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life time maximum benefit.)
  - hasType
```
public boolean hasType()
```
  - setType
```
public Contract.TermComponent setType(CodeableConcept value)
```
    Parameters:
    
    value - type (Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life time maximum benefit.)
  - getSubType
```
public CodeableConcept getSubType()
```
    Returns:
    
    subType (Subtype of this Contract Provision, e.g. life time maximum payment for a contract term for specific valued item, e.g. disability payment.)
  - hasSubType
```
public boolean hasSubType()
```
  - setSubType
```
public Contract.TermComponent setSubType(CodeableConcept value)
```
    Parameters:
    
    value - subType (Subtype of this Contract Provision, e.g. life time maximum payment for a contract term for specific valued item, e.g. disability payment.)
  - getTopic
```
public List<Reference> getTopic()
```
    Returns:
    
    topic (The matter of concern in the context of this provision of the agrement.)
  - setTopic
```
public Contract.TermComponent setTopic(List<Reference> theTopic)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasTopic
```
public boolean hasTopic()
```
  - addTopic
```
public Reference addTopic()
```
  - addTopic
```
public Contract.TermComponent addTopic(Reference t)
```
  - getTopicFirstRep
```
public Reference getTopicFirstRep()
```
    Returns:
    
    The first repetition of repeating field topic, creating it if it does not already exist
  - getTopicTarget
```
@Deprecated
public List<Resource> getTopicTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - getAction
```
public List<CodeableConcept> getAction()
```
    Returns:
    
    action (Action stipulated by this Contract Provision.)
  - setAction
```
public Contract.TermComponent setAction(List<CodeableConcept> theAction)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasAction
```
public boolean hasAction()
```
  - addAction
```
public CodeableConcept addAction()
```
  - addAction
```
public Contract.TermComponent addAction(CodeableConcept t)
```
  - getActionFirstRep
```
public CodeableConcept getActionFirstRep()
```
    Returns:
    
    The first repetition of repeating field action, creating it if it does not already exist
  - getActionReason
```
public List<CodeableConcept> getActionReason()
```
    Returns:
    
    actionReason (Reason or purpose for the action stipulated by this Contract Provision.)
  - setActionReason
```
public Contract.TermComponent setActionReason(List<CodeableConcept> theActionReason)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasActionReason
```
public boolean hasActionReason()
```
  - addActionReason
```
public CodeableConcept addActionReason()
```
  - addActionReason
```
public Contract.TermComponent addActionReason(CodeableConcept t)
```
  - getActionReasonFirstRep
```
public CodeableConcept getActionReasonFirstRep()
```
    Returns:
    
    The first repetition of repeating field actionReason, creating it if it does not already exist
  - getSecurityLabel
```
public List<Coding> getSecurityLabel()
```
    Returns:
    
    securityLabel (A set of security labels that define which terms are controlled by this condition.)
  - setSecurityLabel
```
public Contract.TermComponent setSecurityLabel(List<Coding> theSecurityLabel)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasSecurityLabel
```
public boolean hasSecurityLabel()
```
  - addSecurityLabel
```
public Coding addSecurityLabel()
```
  - addSecurityLabel
```
public Contract.TermComponent addSecurityLabel(Coding t)
```
  - getSecurityLabelFirstRep
```
public Coding getSecurityLabelFirstRep()
```
    Returns:
    
    The first repetition of repeating field securityLabel, creating it if it does not already exist
  - getAgent
```
public List<Contract.TermAgentComponent> getAgent()
```
    Returns:
    
    agent (An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.)
  - setAgent
```
public Contract.TermComponent setAgent(List<Contract.TermAgentComponent> theAgent)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasAgent
```
public boolean hasAgent()
```
  - addAgent
```
public Contract.TermAgentComponent addAgent()
```
  - addAgent
```
public Contract.TermComponent addAgent(Contract.TermAgentComponent t)
```
  - getAgentFirstRep
```
public Contract.TermAgentComponent getAgentFirstRep()
```
    Returns:
    
    The first repetition of repeating field agent, creating it if it does not already exist
  - getTextElement
```
public StringType getTextElement()
```
    Returns:
    
    text (Human readable form of this Contract Provision.). This is the underlying object with id, value and extensions. The accessor "getText" gives direct access to the value
  - hasTextElement
```
public boolean hasTextElement()
```
  - hasText
```
public boolean hasText()
```
  - setTextElement
```
public Contract.TermComponent setTextElement(StringType value)
```
    Parameters:
    
    value - text (Human readable form of this Contract Provision.). This is the underlying object with id, value and extensions. The accessor "getText" gives direct access to the value
  - getText
```
public String getText()
```
    Returns:
    
    Human readable form of this Contract Provision.
  - setText
```
public Contract.TermComponent setText(String value)
```
    Parameters:
    
    value - Human readable form of this Contract Provision.
  - getValuedItem
```
public List<Contract.TermValuedItemComponent> getValuedItem()
```
    Returns:
    
    valuedItem (Contract Provision Valued Item List.)
  - setValuedItem
```
public Contract.TermComponent setValuedItem(List<Contract.TermValuedItemComponent> theValuedItem)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasValuedItem
```
public boolean hasValuedItem()
```
  - addValuedItem
```
public Contract.TermValuedItemComponent addValuedItem()
```
  - addValuedItem
```
public Contract.TermComponent addValuedItem(Contract.TermValuedItemComponent t)
```
  - getValuedItemFirstRep
```
public Contract.TermValuedItemComponent getValuedItemFirstRep()
```
    Returns:
    
    The first repetition of repeating field valuedItem, creating it if it does not already exist
  - getGroup
```
public List<Contract.TermComponent> getGroup()
```
    Returns:
    
    group (Nested group of Contract Provisions.)
  - setGroup
```
public Contract.TermComponent setGroup(List<Contract.TermComponent> theGroup)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasGroup
```
public boolean hasGroup()
```
  - addGroup
```
public Contract.TermComponent addGroup()
```
  - addGroup
```
public Contract.TermComponent addGroup(Contract.TermComponent t)
```
  - getGroupFirstRep
```
public Contract.TermComponent getGroupFirstRep()
```
    Returns:
    
    The first repetition of repeating field group, creating it if it does not already exist
  - 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.TermComponent 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.TermComponent

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

identifier

issued

applies

type

subType

topic

topicTarget

action

actionReason

securityLabel

agent

text

valuedItem

group

Constructor Detail

TermComponent

Method Detail

getIdentifier

hasIdentifier

setIdentifier

getIssuedElement

hasIssuedElement

hasIssued

setIssuedElement

getIssued

setIssued

getApplies

hasApplies

setApplies

getType

hasType

setType

getSubType

hasSubType

setSubType

getTopic

setTopic

hasTopic

addTopic

addTopic

getTopicFirstRep

getTopicTarget

getAction

setAction

hasAction

addAction

addAction

getActionFirstRep

getActionReason

setActionReason

hasActionReason

addActionReason

addActionReason

getActionReasonFirstRep

getSecurityLabel

setSecurityLabel

hasSecurityLabel

addSecurityLabel

addSecurityLabel

getSecurityLabelFirstRep

getAgent

setAgent

hasAgent

addAgent

addAgent

getAgentFirstRep