Contract (HAPI FHIR Structures - HL7.org DSTU2 1.3 API)

java.lang.Object
- org.hl7.fhir.instance.model.Base
- - org.hl7.fhir.instance.model.BaseResource
  - - org.hl7.fhir.instance.model.Resource
    - - org.hl7.fhir.instance.model.DomainResource
      - org.hl7.fhir.instance.model.Contract

All Implemented Interfaces:

Serializable, IAnyResource, IBase, IBaseHasExtensions, IBaseHasModifierExtensions, IBaseResource, IDomainResource
```
public class Contract
extends DomainResource
```
A formal agreement between parties regarding the conduct of business, exchange of information or other matters.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Contract.ActorComponent`
`static class`	`Contract.ComputableLanguageComponent`
`static class`	`Contract.FriendlyLanguageComponent`
`static class`	`Contract.LegalLanguageComponent`
`static class`	`Contract.SignatoryComponent`
`static class`	`Contract.TermActorComponent`
`static class`	`Contract.TermComponent`
`static class`	`Contract.TermValuedItemComponent`
`static class`	`Contract.ValuedItemComponent`

Field Summary

Fields
Modifier and Type Field and Description

static String SP_ACTOR

static String SP_IDENTIFIER

static String SP_PATIENT

static String SP_SIGNER

static String SP_SUBJECT

Fields
Modifier and Type	Field and Description
`static String`	`SP_ACTOR`
`static String`	`SP_IDENTIFIER`
`static String`	`SP_PATIENT`
`static String`	`SP_SIGNER`
`static String`	`SP_SUBJECT`

Constructor Summary

Constructors
Constructor and Description

Contract()

Constructors
Constructor and Description
`Contract()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CodeableConcept`	`addAction()`
`Contract`	`addAction(CodeableConcept t)`
`CodeableConcept`	`addActionReason()`
`Contract`	`addActionReason(CodeableConcept t)`
`Contract.ActorComponent`	`addActor()`
`Contract`	`addActor(Contract.ActorComponent t)`
`Reference`	`addAuthority()`
`Contract`	`addAuthority(Reference t)`
`Organization`	`addAuthorityTarget()`
`Reference`	`addDomain()`
`Contract`	`addDomain(Reference t)`
`Location`	`addDomainTarget()`
`Contract.FriendlyLanguageComponent`	`addFriendly()`
`Contract`	`addFriendly(Contract.FriendlyLanguageComponent t)`
`Contract.LegalLanguageComponent`	`addLegal()`
`Contract`	`addLegal(Contract.LegalLanguageComponent t)`
`Contract.ComputableLanguageComponent`	`addRule()`
`Contract`	`addRule(Contract.ComputableLanguageComponent t)`
`Contract.SignatoryComponent`	`addSigner()`
`Contract`	`addSigner(Contract.SignatoryComponent t)`
`Reference`	`addSubject()`
`Contract`	`addSubject(Reference t)`
`CodeableConcept`	`addSubType()`
`Contract`	`addSubType(CodeableConcept t)`
`Contract.TermComponent`	`addTerm()`
`Contract`	`addTerm(Contract.TermComponent t)`
`Contract.ValuedItemComponent`	`addValuedItem()`
`Contract`	`addValuedItem(Contract.ValuedItemComponent t)`
`Contract`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`List<CodeableConcept>`	`getAction()`
`List<CodeableConcept>`	`getActionReason()`
`List<Contract.ActorComponent>`	`getActor()`
`Period`	`getApplies()`
`List<Reference>`	`getAuthority()`
`List<Organization>`	`getAuthorityTarget()`
`Type`	`getBinding()`
`Attachment`	`getBindingAttachment()`
`Reference`	`getBindingReference()`
`List<Reference>`	`getDomain()`
`List<Location>`	`getDomainTarget()`
`List<Contract.FriendlyLanguageComponent>`	`getFriendly()`
`Identifier`	`getIdentifier()`
`Date`	`getIssued()`
`DateTimeType`	`getIssuedElement()`
`List<Contract.LegalLanguageComponent>`	`getLegal()`
`ResourceType`	`getResourceType()`
`List<Contract.ComputableLanguageComponent>`	`getRule()`
`List<Contract.SignatoryComponent>`	`getSigner()`
`List<Reference>`	`getSubject()`
`List<Resource>`	`getSubjectTarget()`
`List<CodeableConcept>`	`getSubType()`
`List<Contract.TermComponent>`	`getTerm()`
`CodeableConcept`	`getType()`
`List<Contract.ValuedItemComponent>`	`getValuedItem()`
`boolean`	`hasAction()`
`boolean`	`hasActionReason()`
`boolean`	`hasActor()`
`boolean`	`hasApplies()`
`boolean`	`hasAuthority()`
`boolean`	`hasBinding()`
`boolean`	`hasBindingAttachment()`
`boolean`	`hasBindingReference()`
`boolean`	`hasDomain()`
`boolean`	`hasFriendly()`
`boolean`	`hasIdentifier()`
`boolean`	`hasIssued()`
`boolean`	`hasIssuedElement()`
`boolean`	`hasLegal()`
`boolean`	`hasRule()`
`boolean`	`hasSigner()`
`boolean`	`hasSubject()`
`boolean`	`hasSubType()`
`boolean`	`hasTerm()`
`boolean`	`hasType()`
`boolean`	`hasValuedItem()`
`boolean`	`isEmpty()`
`Contract`	`setApplies(Period value)`
`Contract`	`setBinding(Type value)`
`Contract`	`setIdentifier(Identifier value)`
`Contract`	`setIssued(Date value)`
`Contract`	`setIssuedElement(DateTimeType value)`
`Contract`	`setType(CodeableConcept value)`

Methods inherited from class org.hl7.fhir.instance.model.DomainResource
addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

Methods inherited from class org.hl7.fhir.instance.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.instance.model.BaseResource
setId

Methods inherited from class org.hl7.fhir.instance.model.Base
children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasUserData, listChildrenByName, setUserData, setUserDataINN

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

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getMeta, setId

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
setId

- Field Detail
  - SP_ACTOR
```
public static final String SP_ACTOR
```
    See Also:
    
    Constant Field Values
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    See Also:
    
    Constant Field Values
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    See Also:
    
    Constant Field Values
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    See Also:
    
    Constant Field Values
  - SP_SIGNER
```
public static final String SP_SIGNER
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Contract
```
public Contract()
```
- Method Detail
  - getIdentifier
```
public Identifier getIdentifier()
```
    Returns:
    
    identifier (Unique identifier for this Contract.)
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - setIdentifier
```
public Contract setIdentifier(Identifier value)
```
    Parameters:
    
    value - identifier (Unique identifier for this Contract.)
  - getIssuedElement
```
public DateTimeType getIssuedElement()
```
    Returns:
    
    issued (When this Contract 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 setIssuedElement(DateTimeType value)
```
    Parameters:
    
    value - issued (When this Contract 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 was issued.
  - setIssued
```
public Contract setIssued(Date value)
```
    Parameters:
    
    value - When this Contract was issued.
  - getApplies
```
public Period getApplies()
```
    Returns:
    
    applies (Relevant time or time-period when this Contract is applicable.)
  - hasApplies
```
public boolean hasApplies()
```
  - setApplies
```
public Contract setApplies(Period value)
```
    Parameters:
    
    value - applies (Relevant time or time-period when this Contract is applicable.)
  - getSubject
```
public List<Reference> getSubject()
```
    Returns:
    
    subject (Who and/or what this Contract is about: typically a Patient, Organization, or valued items such as goods and services.)
  - hasSubject
```
public boolean hasSubject()
```
  - addSubject
```
public Reference addSubject()
```
    Returns:
    
    subject (Who and/or what this Contract is about: typically a Patient, Organization, or valued items such as goods and services.)
  - addSubject
```
public Contract addSubject(Reference t)
```
  - getSubjectTarget
```
public List<Resource> getSubjectTarget()
```
    Returns:
    
    subject (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Who and/or what this Contract is about: typically a Patient, Organization, or valued items such as goods and services.)
  - getAuthority
```
public List<Reference> getAuthority()
```
    Returns:
    
    authority (A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies.)
  - hasAuthority
```
public boolean hasAuthority()
```
  - addAuthority
```
public Reference addAuthority()
```
    Returns:
    
    authority (A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies.)
  - addAuthority
```
public Contract addAuthority(Reference t)
```
  - getAuthorityTarget
```
public List<Organization> getAuthorityTarget()
```
    Returns:
    
    authority (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies.)
  - addAuthorityTarget
```
public Organization addAuthorityTarget()
```
    Returns:
    
    authority (Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies.)
  - getDomain
```
public List<Reference> getDomain()
```
    Returns:
    
    domain (Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.)
  - hasDomain
```
public boolean hasDomain()
```
  - addDomain
```
public Reference addDomain()
```
    Returns:
    
    domain (Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.)
  - addDomain
```
public Contract addDomain(Reference t)
```
  - getDomainTarget
```
public List<Location> getDomainTarget()
```
    Returns:
    
    domain (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.)
  - addDomainTarget
```
public Location addDomainTarget()
```
    Returns:
    
    domain (Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.)
  - getType
```
public CodeableConcept getType()
```
    Returns:
    
    type (Type of Contract such as an insurance policy, real estate contract, a will, power of attorny, Privacy or Security policy , trust framework agreement, etc.)
  - hasType
```
public boolean hasType()
```
  - setType
```
public Contract setType(CodeableConcept value)
```
    Parameters:
    
    value - type (Type of Contract such as an insurance policy, real estate contract, a will, power of attorny, Privacy or Security policy , trust framework agreement, etc.)
  - getSubType
```
public List<CodeableConcept> getSubType()
```
    Returns:
    
    subType (More specific type or specialization of an overarching or more general contract such as auto insurance, home owner insurance, prenupial agreement, Advanced-Directive, or privacy consent.)
  - hasSubType
```
public boolean hasSubType()
```
  - addSubType
```
public CodeableConcept addSubType()
```
    Returns:
    
    subType (More specific type or specialization of an overarching or more general contract such as auto insurance, home owner insurance, prenupial agreement, Advanced-Directive, or privacy consent.)
  - addSubType
```
public Contract addSubType(CodeableConcept t)
```
  - getAction
```
public List<CodeableConcept> getAction()
```
    Returns:
    
    action (Action stipulated by this Contract.)
  - hasAction
```
public boolean hasAction()
```
  - addAction
```
public CodeableConcept addAction()
```
    Returns:
    
    action (Action stipulated by this Contract.)
  - addAction
```
public Contract addAction(CodeableConcept t)
```
  - getActionReason
```
public List<CodeableConcept> getActionReason()
```
    Returns:
    
    actionReason (Reason for action stipulated by this Contract.)
  - hasActionReason
```
public boolean hasActionReason()
```
  - addActionReason
```
public CodeableConcept addActionReason()
```
    Returns:
    
    actionReason (Reason for action stipulated by this Contract.)
  - addActionReason
```
public Contract addActionReason(CodeableConcept t)
```
  - getActor
```
public List<Contract.ActorComponent> getActor()
```
    Returns:
    
    actor (List of Contract actors.)
  - hasActor
```
public boolean hasActor()
```
  - addActor
```
public Contract.ActorComponent addActor()
```
    Returns:
    
    actor (List of Contract actors.)
  - addActor
```
public Contract addActor(Contract.ActorComponent t)
```
  - getValuedItem
```
public List<Contract.ValuedItemComponent> getValuedItem()
```
    Returns:
    
    valuedItem (Contract Valued Item List.)
  - hasValuedItem
```
public boolean hasValuedItem()
```
  - addValuedItem
```
public Contract.ValuedItemComponent addValuedItem()
```
    Returns:
    
    valuedItem (Contract Valued Item List.)
  - addValuedItem
```
public Contract addValuedItem(Contract.ValuedItemComponent t)
```
  - getSigner
```
public List<Contract.SignatoryComponent> getSigner()
```
    Returns:
    
    signer (Party signing this Contract.)
  - hasSigner
```
public boolean hasSigner()
```
  - addSigner
```
public Contract.SignatoryComponent addSigner()
```
    Returns:
    
    signer (Party signing this Contract.)
  - addSigner
```
public Contract addSigner(Contract.SignatoryComponent t)
```
  - getTerm
```
public List<Contract.TermComponent> getTerm()
```
    Returns:
    
    term (One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.)
  - hasTerm
```
public boolean hasTerm()
```
  - addTerm
```
public Contract.TermComponent addTerm()
```
    Returns:
    
    term (One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.)
  - addTerm
```
public Contract addTerm(Contract.TermComponent t)
```
  - getBinding
```
public Type getBinding()
```
    Returns:
    
    binding (Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the "source of truth" and which would be the basis for legal action related to enforcement of this Contract.)
  - getBindingAttachment
```
public Attachment getBindingAttachment()
                                throws Exception
```
    Returns:
    
    binding (Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the "source of truth" and which would be the basis for legal action related to enforcement of this Contract.)
    
    Throws:
    
    Exception
  - hasBindingAttachment
```
public boolean hasBindingAttachment()
                             throws Exception
```
    Throws:
    
    Exception
  - getBindingReference
```
public Reference getBindingReference()
                              throws Exception
```
    Returns:
    
    binding (Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the "source of truth" and which would be the basis for legal action related to enforcement of this Contract.)
    
    Throws:
    
    Exception
  - hasBindingReference
```
public boolean hasBindingReference()
                            throws Exception
```
    Throws:
    
    Exception
  - hasBinding
```
public boolean hasBinding()
```
  - setBinding
```
public Contract setBinding(Type value)
```
    Parameters:
    
    value - binding (Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the "source of truth" and which would be the basis for legal action related to enforcement of this Contract.)
  - getFriendly
```
public List<Contract.FriendlyLanguageComponent> getFriendly()
```
    Returns:
    
    friendly (The "patient friendly language" versionof the Contract in whole or in parts. "Patient friendly language" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.)
  - hasFriendly
```
public boolean hasFriendly()
```
  - addFriendly
```
public Contract.FriendlyLanguageComponent addFriendly()
```
    Returns:
    
    friendly (The "patient friendly language" versionof the Contract in whole or in parts. "Patient friendly language" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.)
  - addFriendly
```
public Contract addFriendly(Contract.FriendlyLanguageComponent t)
```
  - getLegal
```
public List<Contract.LegalLanguageComponent> getLegal()
```
    Returns:
    
    legal (List of Legal expressions or representations of this Contract.)
  - hasLegal
```
public boolean hasLegal()
```
  - addLegal
```
public Contract.LegalLanguageComponent addLegal()
```
    Returns:
    
    legal (List of Legal expressions or representations of this Contract.)
  - addLegal
```
public Contract addLegal(Contract.LegalLanguageComponent t)
```
  - getRule
```
public List<Contract.ComputableLanguageComponent> getRule()
```
    Returns:
    
    rule (List of Computable Policy Rule Language Representations of this Contract.)
  - hasRule
```
public boolean hasRule()
```
  - addRule
```
public Contract.ComputableLanguageComponent addRule()
```
    Returns:
    
    rule (List of Computable Policy Rule Language Representations of this Contract.)
  - addRule
```
public Contract addRule(Contract.ComputableLanguageComponent t)
```
  - copy
```
public Contract copy()
```
    Specified by:
    
    copy in class DomainResource
  - equalsDeep
```
public boolean equalsDeep(Base other)
```
    Overrides:
    
    equalsDeep in class DomainResource
  - equalsShallow
```
public boolean equalsShallow(Base other)
```
    Overrides:
    
    equalsShallow in class DomainResource
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
    
    Overrides:
    
    isEmpty in class DomainResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Class Contract

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.instance.model.DomainResource

Methods inherited from class org.hl7.fhir.instance.model.Resource

Methods inherited from class org.hl7.fhir.instance.model.BaseResource

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

Methods inherited from class java.lang.Object

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

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

Field Detail

SP_ACTOR

SP_IDENTIFIER

SP_SUBJECT

SP_PATIENT

SP_SIGNER

Constructor Detail

Contract

Method Detail

getIdentifier

hasIdentifier

setIdentifier

getIssuedElement

hasIssuedElement

hasIssued

setIssuedElement

getIssued

setIssued

getApplies

hasApplies

setApplies

getSubject

hasSubject

addSubject

addSubject

getSubjectTarget

getAuthority

hasAuthority

addAuthority

addAuthority

getAuthorityTarget

addAuthorityTarget

getDomain

hasDomain

addDomain

addDomain

getDomainTarget

addDomainTarget

getType

hasType

setType

getSubType

hasSubType

addSubType

addSubType

getAction

hasAction

addAction

addAction

getActionReason

hasActionReason

addActionReason

addActionReason

getActor

hasActor

addActor

addActor

getValuedItem

hasValuedItem

addValuedItem

addValuedItem

getSigner

hasSigner

addSigner

addSigner

getTerm

hasTerm

addTerm