Package org.hl7.fhir.dstu3.model

Class Contract

java.lang.Object

org.hl7.fhir.dstu3.model.Base

org.hl7.fhir.dstu3.model.BaseResource

org.hl7.fhir.dstu3.model.Resource

org.hl7.fhir.dstu3.model.DomainResource

org.hl7.fhir.dstu3.model.Contract

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.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	Description
static class	Contract.AgentComponent
static class	Contract.ComputableLanguageComponent
static enum	Contract.ContractStatus
static class	Contract.ContractStatusEnumFactory
static class	Contract.FriendlyLanguageComponent
static class	Contract.LegalLanguageComponent
static class	Contract.SignatoryComponent
static class	Contract.TermAgentComponent
static class	Contract.TermComponent
static class	Contract.TermValuedItemComponent
static class	Contract.ValuedItemComponent

Field Summary

Fields

Modifier and Type	Field	Description
protected List<CodeableConcept>	action	Action stipulated by this Contract.
protected List<CodeableConcept>	actionReason	Reason for action stipulated by this Contract.
protected List<Contract.AgentComponent>	agent	An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	AGENT	Fluent Client search parameter constant for agent
protected Period	applies	Relevant time or time-period when this Contract is applicable.
protected List<Reference>	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.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	AUTHORITY	Fluent Client search parameter constant for authority
protected List<Organization>	authorityTarget	The actual objects that are the target of the reference (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.)
protected Type	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.
protected CodeableConcept	contentDerivative	The minimal content derived from the basal information source at a specific stage in its lifecycle.
protected CodeableConcept	decisionType	The type of decision made by a grantor with respect to an offer made by a grantee.
protected List<Reference>	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.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	DOMAIN	Fluent Client search parameter constant for domain
protected List<Location>	domainTarget	The actual objects that are the target of the reference (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.)
protected List<Contract.FriendlyLanguageComponent>	friendly	The "patient friendly language" versionof the Contract in whole or in parts.
protected Identifier	identifier	Unique identifier for this Contract.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_AGENT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_AUTHORITY	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_DOMAIN	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PATIENT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SIGNER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SUBJECT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_TERM_TOPIC	Constant for fluent queries to be used to add include statements.
protected DateTimeType	issued	When this Contract was issued.
static final ca.uhn.fhir.rest.gclient.DateClientParam	ISSUED	Fluent Client search parameter constant for issued
protected List<Contract.LegalLanguageComponent>	legal	List of Legal expressions or representations of this Contract.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PATIENT	Fluent Client search parameter constant for patient
protected List<Contract.ComputableLanguageComponent>	rule	List of Computable Policy Rule Language Representations of this Contract.
protected List<Coding>	securityLabel	A set of security labels that define which resources are controlled by this consent.
protected List<Contract.SignatoryComponent>	signer	Parties with legal standing in the Contract, including the principal parties, the grantor(s) and grantee(s), which are any person or organization bound by the contract, and any ancillary parties, which facilitate the execution of the contract such as a notary or witness.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SIGNER	Fluent Client search parameter constant for signer
static final String	SP_AGENT	Search parameter: agent
static final String	SP_AUTHORITY	Search parameter: authority
static final String	SP_DOMAIN	Search parameter: domain
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_ISSUED	Search parameter: issued
static final String	SP_PATIENT	Search parameter: patient
static final String	SP_SIGNER	Search parameter: signer
static final String	SP_SUBJECT	Search parameter: subject
static final String	SP_TERM_TOPIC	Search parameter: term-topic
protected Enumeration<Contract.ContractStatus>	status	The status of the resource instance.
protected List<Reference>	subject	The target entity impacted by or of interest to parties to the agreement.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SUBJECT	Fluent Client search parameter constant for subject
protected List<Resource>	subjectTarget	The actual objects that are the target of the reference (The target entity impacted by or of interest to parties to the agreement.)
protected List<CodeableConcept>	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.
protected List<Contract.TermComponent>	term	One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	TERM_TOPIC	Fluent Client search parameter constant for term-topic
protected List<Reference>	topic	The matter of concern in the context of this agreement.
protected List<Resource>	topicTarget	The actual objects that are the target of the reference (The matter of concern in the context of this agreement.)
protected CodeableConcept	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.
protected List<Contract.ValuedItemComponent>	valuedItem	Contract Valued Item List.

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

contained, extension, modifierExtension, text

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

id, implicitRules, language, meta

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

RES_ID, SP_RES_ID

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
Contract()	Constructor

Method Summary

Modifier and Type	Method	Description
CodeableConcept	addAction()
Contract	addAction(CodeableConcept t)
CodeableConcept	addActionReason()
Contract	addActionReason(CodeableConcept t)
Contract.AgentComponent	addAgent()
Contract	addAgent(Contract.AgentComponent t)
Reference	addAuthority()
Contract	addAuthority(Reference t)
Organization	addAuthorityTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
Base	addChild(String name)
Reference	addDomain()
Contract	addDomain(Reference t)
Location	addDomainTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
Contract.FriendlyLanguageComponent	addFriendly()
Contract	addFriendly(Contract.FriendlyLanguageComponent t)
Contract.LegalLanguageComponent	addLegal()
Contract	addLegal(Contract.LegalLanguageComponent t)
Contract.ComputableLanguageComponent	addRule()
Contract	addRule(Contract.ComputableLanguageComponent t)
Coding	addSecurityLabel()
Contract	addSecurityLabel(Coding 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)
Reference	addTopic()
Contract	addTopic(Reference t)
Contract.ValuedItemComponent	addValuedItem()
Contract	addValuedItem(Contract.ValuedItemComponent t)
Contract	copy()
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<CodeableConcept>	getAction()
CodeableConcept	getActionFirstRep()
List<CodeableConcept>	getActionReason()
CodeableConcept	getActionReasonFirstRep()
List<Contract.AgentComponent>	getAgent()
Contract.AgentComponent	getAgentFirstRep()
Period	getApplies()
List<Reference>	getAuthority()
Reference	getAuthorityFirstRep()
List<Organization>	getAuthorityTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
Type	getBinding()
Attachment	getBindingAttachment()
Reference	getBindingReference()
CodeableConcept	getContentDerivative()
CodeableConcept	getDecisionType()
List<Reference>	getDomain()
Reference	getDomainFirstRep()
List<Location>	getDomainTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
List<Contract.FriendlyLanguageComponent>	getFriendly()
Contract.FriendlyLanguageComponent	getFriendlyFirstRep()
Identifier	getIdentifier()
Date	getIssued()
DateTimeType	getIssuedElement()
List<Contract.LegalLanguageComponent>	getLegal()
Contract.LegalLanguageComponent	getLegalFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
List<Contract.ComputableLanguageComponent>	getRule()
Contract.ComputableLanguageComponent	getRuleFirstRep()
List<Coding>	getSecurityLabel()
Coding	getSecurityLabelFirstRep()
List<Contract.SignatoryComponent>	getSigner()
Contract.SignatoryComponent	getSignerFirstRep()
Contract.ContractStatus	getStatus()
Enumeration<Contract.ContractStatus>	getStatusElement()
List<Reference>	getSubject()
Reference	getSubjectFirstRep()
List<Resource>	getSubjectTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
List<CodeableConcept>	getSubType()
CodeableConcept	getSubTypeFirstRep()
List<Contract.TermComponent>	getTerm()
Contract.TermComponent	getTermFirstRep()
List<Reference>	getTopic()
Reference	getTopicFirstRep()
List<Resource>	getTopicTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
CodeableConcept	getType()
String[]	getTypesForProperty(int hash, String name)
List<Contract.ValuedItemComponent>	getValuedItem()
Contract.ValuedItemComponent	getValuedItemFirstRep()
boolean	hasAction()
boolean	hasActionReason()
boolean	hasAgent()
boolean	hasApplies()
boolean	hasAuthority()
boolean	hasBinding()
boolean	hasBindingAttachment()
boolean	hasBindingReference()
boolean	hasContentDerivative()
boolean	hasDecisionType()
boolean	hasDomain()
boolean	hasFriendly()
boolean	hasIdentifier()
boolean	hasIssued()
boolean	hasIssuedElement()
boolean	hasLegal()
boolean	hasRule()
boolean	hasSecurityLabel()
boolean	hasSigner()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasSubject()
boolean	hasSubType()
boolean	hasTerm()
boolean	hasTopic()
boolean	hasType()
boolean	hasValuedItem()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
Contract	setAction(List<CodeableConcept> theAction)
Contract	setActionReason(List<CodeableConcept> theActionReason)
Contract	setAgent(List<Contract.AgentComponent> theAgent)
Contract	setApplies(Period value)
Contract	setAuthority(List<Reference> theAuthority)
Contract	setBinding(Type value)
Contract	setContentDerivative(CodeableConcept value)
Contract	setDecisionType(CodeableConcept value)
Contract	setDomain(List<Reference> theDomain)
Contract	setFriendly(List<Contract.FriendlyLanguageComponent> theFriendly)
Contract	setIdentifier(Identifier value)
Contract	setIssued(Date value)
Contract	setIssuedElement(DateTimeType value)
Contract	setLegal(List<Contract.LegalLanguageComponent> theLegal)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Contract	setRule(List<Contract.ComputableLanguageComponent> theRule)
Contract	setSecurityLabel(List<Coding> theSecurityLabel)
Contract	setSigner(List<Contract.SignatoryComponent> theSigner)
Contract	setStatus(Contract.ContractStatus value)
Contract	setStatusElement(Enumeration<Contract.ContractStatus> value)
Contract	setSubject(List<Reference> theSubject)
Contract	setSubType(List<CodeableConcept> theSubType)
Contract	setTerm(List<Contract.TermComponent> theTerm)
Contract	setTopic(List<Reference> theTopic)
Contract	setType(CodeableConcept value)
Contract	setValuedItem(List<Contract.ValuedItemComponent> theValuedItem)
protected Contract	typedCopy()

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

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

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

copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

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

getStructureFhirVersionEnum, isResource, setId

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, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, 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.IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

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

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

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

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

identifier

protected Identifier identifier

Unique identifier for this Contract.

status

protected Enumeration<Contract.ContractStatus> status

The status of the resource instance.

issued

protected DateTimeType issued

When this Contract was issued.

applies

protected Period applies

Relevant time or time-period when this Contract is applicable.

subject

protected List<Reference> subject

The target entity impacted by or of interest to parties to the agreement.

subjectTarget

protected List<Resource> subjectTarget

The actual objects that are the target of the reference (The target entity impacted by or of interest to parties to the agreement.)

topic

protected List<Reference> topic

The matter of concern in the context of this agreement.

topicTarget

protected List<Resource> topicTarget

The actual objects that are the target of the reference (The matter of concern in the context of this agreement.)

authority

protected List<Reference> 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.

authorityTarget

protected List<Organization> authorityTarget

The actual objects that are the target of the reference (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.)

domain

protected List<Reference> 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.

domainTarget

protected List<Location> domainTarget

The actual objects that are the target of the reference (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.)

type

protected CodeableConcept 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.

subType

protected List<CodeableConcept> 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.

action

protected List<CodeableConcept> action

Action stipulated by this Contract.

actionReason

protected List<CodeableConcept> actionReason

Reason for action stipulated by this Contract.

decisionType

protected CodeableConcept decisionType

The type of decision made by a grantor with respect to an offer made by a grantee.

contentDerivative

protected CodeableConcept contentDerivative

The minimal content derived from the basal information source at a specific stage in its lifecycle.

securityLabel

protected List<Coding> securityLabel

A set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels.

agent

protected List<Contract.AgentComponent> agent

An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.

signer

protected List<Contract.SignatoryComponent> signer

Parties with legal standing in the Contract, including the principal parties, the grantor(s) and grantee(s), which are any person or organization bound by the contract, and any ancillary parties, which facilitate the execution of the contract such as a notary or witness.

valuedItem

protected List<Contract.ValuedItemComponent> valuedItem

Contract Valued Item List.

term

protected List<Contract.TermComponent> term

One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.

binding

protected Type 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.

friendly

protected List<Contract.FriendlyLanguageComponent> 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.

legal

protected List<Contract.LegalLanguageComponent> legal

List of Legal expressions or representations of this Contract.

rule

protected List<Contract.ComputableLanguageComponent> rule

List of Computable Policy Rule Language Representations of this Contract.

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: The identity of the contract
Type: token
Path: Contract.identifier

See Also:

• Constant Field Values

IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: The identity of the contract
Type: token
Path: Contract.identifier

SP_AGENT

public static final String SP_AGENT

Search parameter: agent

Description: Agent to the Contact
Type: reference
Path: Contract.agent.actor

See Also:

• Constant Field Values

AGENT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam AGENT

Fluent Client search parameter constant for agent

Description: Agent to the Contact
Type: reference
Path: Contract.agent.actor

INCLUDE_AGENT

public static final ca.uhn.fhir.model.api.Include INCLUDE_AGENT

Constant for fluent queries to be used to add include statements. Specifies the path value of "Contract:agent".

SP_PATIENT

public static final String SP_PATIENT

Search parameter: patient

Description: The identity of the subject of the contract (if a patient)
Type: reference
Path: Contract.subject

See Also:

• Constant Field Values

PATIENT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT

Fluent Client search parameter constant for patient

Description: The identity of the subject of the contract (if a patient)
Type: reference
Path: Contract.subject

INCLUDE_PATIENT

public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT

Constant for fluent queries to be used to add include statements. Specifies the path value of "Contract:patient".

SP_SUBJECT

public static final String SP_SUBJECT

Search parameter: subject

Description: The identity of the subject of the contract
Type: reference
Path: Contract.subject

See Also:

• Constant Field Values

SUBJECT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT

Fluent Client search parameter constant for subject

Description: The identity of the subject of the contract
Type: reference
Path: Contract.subject

INCLUDE_SUBJECT

public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT

Constant for fluent queries to be used to add include statements. Specifies the path value of "Contract:subject".

SP_AUTHORITY

public static final String SP_AUTHORITY

Search parameter: authority

Description: The authority of the contract
Type: reference
Path: Contract.authority

See Also:

• Constant Field Values

AUTHORITY

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam AUTHORITY

Fluent Client search parameter constant for authority

Description: The authority of the contract
Type: reference
Path: Contract.authority

INCLUDE_AUTHORITY

public static final ca.uhn.fhir.model.api.Include INCLUDE_AUTHORITY

Constant for fluent queries to be used to add include statements. Specifies the path value of "Contract:authority".

SP_DOMAIN

public static final String SP_DOMAIN

Search parameter: domain

Description: The domain of the contract
Type: reference
Path: Contract.domain

See Also:

• Constant Field Values

DOMAIN

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DOMAIN

Fluent Client search parameter constant for domain

Description: The domain of the contract
Type: reference
Path: Contract.domain

INCLUDE_DOMAIN

public static final ca.uhn.fhir.model.api.Include INCLUDE_DOMAIN

Constant for fluent queries to be used to add include statements. Specifies the path value of "Contract:domain".

SP_TERM_TOPIC

public static final String SP_TERM_TOPIC

Search parameter: term-topic

Description: The identity of the topic of the contract terms
Type: reference
Path: Contract.term.topic

See Also:

• Constant Field Values

TERM_TOPIC

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam TERM_TOPIC

Fluent Client search parameter constant for term-topic

Description: The identity of the topic of the contract terms
Type: reference
Path: Contract.term.topic

INCLUDE_TERM_TOPIC

public static final ca.uhn.fhir.model.api.Include INCLUDE_TERM_TOPIC

Constant for fluent queries to be used to add include statements. Specifies the path value of "Contract:term-topic".

SP_ISSUED

public static final String SP_ISSUED

Search parameter: issued

Description: The date/time the contract was issued
Type: date
Path: Contract.issued

See Also:

• Constant Field Values

ISSUED

public static final ca.uhn.fhir.rest.gclient.DateClientParam ISSUED

Fluent Client search parameter constant for issued

Description: The date/time the contract was issued
Type: date
Path: Contract.issued

SP_SIGNER

public static final String SP_SIGNER

Search parameter: signer

Description: Contract Signatory Party
Type: reference
Path: Contract.signer.party

See Also:

• Constant Field Values

SIGNER

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SIGNER

Fluent Client search parameter constant for signer

Description: Contract Signatory Party
Type: reference
Path: Contract.signer.party

INCLUDE_SIGNER

public static final ca.uhn.fhir.model.api.Include INCLUDE_SIGNER

Constant for fluent queries to be used to add include statements. Specifies the path value of "Contract:signer".

Constructor Details

Contract

public Contract()

Constructor

Method Details

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

getStatusElement

public Enumeration<Contract.ContractStatus> getStatusElement()

Returns:

status (The status of the resource instance.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

hasStatusElement

public boolean hasStatusElement()

hasStatus

public boolean hasStatus()

setStatusElement

public Contract setStatusElement(Enumeration<Contract.ContractStatus> value)

Parameters:

value - status (The status of the resource instance.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

getStatus

public Contract.ContractStatus getStatus()

Returns:

The status of the resource instance.

setStatus

public Contract setStatus(Contract.ContractStatus value)

Parameters:

value - The status of the resource instance.

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 (The target entity impacted by or of interest to parties to the agreement.)

setSubject

public Contract setSubject(List<Reference> theSubject)

Returns:

Returns a reference to this for easy method chaining

hasSubject

public boolean hasSubject()

addSubject

public Reference addSubject()

addSubject

public Contract addSubject(Reference t)

getSubjectFirstRep

public Reference getSubjectFirstRep()

Returns:

The first repetition of repeating field subject, creating it if it does not already exist

getSubjectTarget

@Deprecated
public List<Resource> getSubjectTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getTopic

public List<Reference> getTopic()

Returns:

topic (The matter of concern in the context of this agreement.)

setTopic

public Contract 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 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

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

setAuthority

public Contract setAuthority(List<Reference> theAuthority)

Returns:

Returns a reference to this for easy method chaining

hasAuthority

public boolean hasAuthority()

addAuthority

public Reference addAuthority()

addAuthority

public Contract addAuthority(Reference t)

getAuthorityFirstRep

public Reference getAuthorityFirstRep()

Returns:

The first repetition of repeating field authority, creating it if it does not already exist

getAuthorityTarget

@Deprecated
public List<Organization> getAuthorityTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

addAuthorityTarget

@Deprecated
public Organization addAuthorityTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

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

setDomain

public Contract setDomain(List<Reference> theDomain)

Returns:

Returns a reference to this for easy method chaining

hasDomain

public boolean hasDomain()

addDomain

public Reference addDomain()

addDomain

public Contract addDomain(Reference t)

getDomainFirstRep

public Reference getDomainFirstRep()

Returns:

The first repetition of repeating field domain, creating it if it does not already exist

getDomainTarget

@Deprecated
public List<Location> getDomainTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

addDomainTarget

@Deprecated
public Location addDomainTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

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

setSubType

public Contract setSubType(List<CodeableConcept> theSubType)

Returns:

Returns a reference to this for easy method chaining

hasSubType

public boolean hasSubType()

addSubType

public CodeableConcept addSubType()

addSubType

public Contract addSubType(CodeableConcept t)

getSubTypeFirstRep

public CodeableConcept getSubTypeFirstRep()

Returns:

The first repetition of repeating field subType, creating it if it does not already exist

getAction

public List<CodeableConcept> getAction()

Returns:

action (Action stipulated by this Contract.)

setAction

public Contract 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 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 for action stipulated by this Contract.)

setActionReason

public Contract 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 addActionReason(CodeableConcept t)

getActionReasonFirstRep

public CodeableConcept getActionReasonFirstRep()

Returns:

The first repetition of repeating field actionReason, creating it if it does not already exist

getDecisionType

public CodeableConcept getDecisionType()

Returns:

decisionType (The type of decision made by a grantor with respect to an offer made by a grantee.)

hasDecisionType

public boolean hasDecisionType()

setDecisionType

public Contract setDecisionType(CodeableConcept value)

Parameters:

value - decisionType (The type of decision made by a grantor with respect to an offer made by a grantee.)

getContentDerivative

public CodeableConcept getContentDerivative()

Returns:

contentDerivative (The minimal content derived from the basal information source at a specific stage in its lifecycle.)

hasContentDerivative

public boolean hasContentDerivative()

setContentDerivative

public Contract setContentDerivative(CodeableConcept value)

Parameters:

value - contentDerivative (The minimal content derived from the basal information source at a specific stage in its lifecycle.)

getSecurityLabel

public List<Coding> getSecurityLabel()

Returns:

securityLabel (A set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels.)

setSecurityLabel

public Contract 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 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.AgentComponent> 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 setAgent(List<Contract.AgentComponent> theAgent)

Returns:

Returns a reference to this for easy method chaining

hasAgent

public boolean hasAgent()

addAgent

public Contract.AgentComponent addAgent()

addAgent

public Contract addAgent(Contract.AgentComponent t)

getAgentFirstRep

public Contract.AgentComponent getAgentFirstRep()

Returns:

The first repetition of repeating field agent, creating it if it does not already exist

getSigner

public List<Contract.SignatoryComponent> getSigner()

Returns:

signer (Parties with legal standing in the Contract, including the principal parties, the grantor(s) and grantee(s), which are any person or organization bound by the contract, and any ancillary parties, which facilitate the execution of the contract such as a notary or witness.)

setSigner

public Contract setSigner(List<Contract.SignatoryComponent> theSigner)

Returns:

Returns a reference to this for easy method chaining

hasSigner

public boolean hasSigner()

addSigner

public Contract.SignatoryComponent addSigner()

addSigner

public Contract addSigner(Contract.SignatoryComponent t)

getSignerFirstRep

public Contract.SignatoryComponent getSignerFirstRep()

Returns:

The first repetition of repeating field signer, creating it if it does not already exist

getValuedItem

public List<Contract.ValuedItemComponent> getValuedItem()

Returns:

valuedItem (Contract Valued Item List.)

setValuedItem

public Contract setValuedItem(List<Contract.ValuedItemComponent> theValuedItem)

Returns:

Returns a reference to this for easy method chaining

hasValuedItem

public boolean hasValuedItem()

addValuedItem

public Contract.ValuedItemComponent addValuedItem()

addValuedItem

public Contract addValuedItem(Contract.ValuedItemComponent t)

getValuedItemFirstRep

public Contract.ValuedItemComponent getValuedItemFirstRep()

Returns:

The first repetition of repeating field valuedItem, creating it if it does not already exist

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

setTerm

public Contract setTerm(List<Contract.TermComponent> theTerm)

Returns:

Returns a reference to this for easy method chaining

hasTerm

public boolean hasTerm()

addTerm

public Contract.TermComponent addTerm()

addTerm

public Contract addTerm(Contract.TermComponent t)

getTermFirstRep

public Contract.TermComponent getTermFirstRep()

Returns:

The first repetition of repeating field term, creating it if it does not already exist

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 org.hl7.fhir.exceptions.FHIRException

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:

org.hl7.fhir.exceptions.FHIRException

hasBindingAttachment

public boolean hasBindingAttachment()

getBindingReference

public Reference getBindingReference()
                              throws org.hl7.fhir.exceptions.FHIRException

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:

org.hl7.fhir.exceptions.FHIRException

hasBindingReference

public boolean hasBindingReference()

hasBinding

public boolean hasBinding()

setBinding

public Contract setBinding(Type value)
                    throws org.hl7.fhir.exceptions.FHIRFormatError

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

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

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

setFriendly

public Contract setFriendly(List<Contract.FriendlyLanguageComponent> theFriendly)

Returns:

Returns a reference to this for easy method chaining

hasFriendly

public boolean hasFriendly()

addFriendly

public Contract.FriendlyLanguageComponent addFriendly()

addFriendly

public Contract addFriendly(Contract.FriendlyLanguageComponent t)

getFriendlyFirstRep

public Contract.FriendlyLanguageComponent getFriendlyFirstRep()

Returns:

The first repetition of repeating field friendly, creating it if it does not already exist

getLegal

public List<Contract.LegalLanguageComponent> getLegal()

Returns:

legal (List of Legal expressions or representations of this Contract.)

setLegal

public Contract setLegal(List<Contract.LegalLanguageComponent> theLegal)

Returns:

Returns a reference to this for easy method chaining

hasLegal

public boolean hasLegal()

addLegal

public Contract.LegalLanguageComponent addLegal()

addLegal

public Contract addLegal(Contract.LegalLanguageComponent t)

getLegalFirstRep

public Contract.LegalLanguageComponent getLegalFirstRep()

Returns:

The first repetition of repeating field legal, creating it if it does not already exist

getRule

public List<Contract.ComputableLanguageComponent> getRule()

Returns:

rule (List of Computable Policy Rule Language Representations of this Contract.)

setRule

public Contract setRule(List<Contract.ComputableLanguageComponent> theRule)

Returns:

Returns a reference to this for easy method chaining

hasRule

public boolean hasRule()

addRule

public Contract.ComputableLanguageComponent addRule()

addRule

public Contract addRule(Contract.ComputableLanguageComponent t)

getRuleFirstRep

public Contract.ComputableLanguageComponent getRuleFirstRep()

Returns:

The first repetition of repeating field rule, creating it if it does not already exist

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

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 DomainResource

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 DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

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 DomainResource

copy

public Contract copy()

Specified by:

copy in class DomainResource

typedCopy

protected Contract typedCopy()

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 org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource