Package org.hl7.fhir.dstu2.model
Class Contract
- java.lang.Object
-
- org.hl7.fhir.dstu2.model.Base
-
- org.hl7.fhir.dstu2.model.BaseResource
-
- org.hl7.fhir.dstu2.model.Resource
-
- org.hl7.fhir.dstu2.model.DomainResource
-
- org.hl7.fhir.dstu2.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 classContract.ActorComponentstatic classContract.ComputableLanguageComponentstatic classContract.FriendlyLanguageComponentstatic classContract.LegalLanguageComponentstatic classContract.SignatoryComponentstatic classContract.TermActorComponentstatic classContract.TermComponentstatic classContract.TermValuedItemComponentstatic classContract.ValuedItemComponent
-
Field Summary
Fields Modifier and Type Field Description protected List<CodeableConcept>actionAction stipulated by this Contract.protected List<CodeableConcept>actionReasonReason for action stipulated by this Contract.protected List<Contract.ActorComponent>actorList of Contract actors.protected PeriodappliesRelevant time or time-period when this Contract is applicable.protected List<Reference>authorityA 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 List<Organization>authorityTargetThe 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 TypebindingLegally 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 List<Reference>domainRecognized 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<Location>domainTargetThe 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>friendlyThe "patient friendly language" versionof the Contract in whole or in parts.protected IdentifieridentifierUnique identifier for this Contract.protected DateTimeTypeissuedWhen this Contract was issued.protected List<Contract.LegalLanguageComponent>legalList of Legal expressions or representations of this Contract.protected List<Contract.ComputableLanguageComponent>ruleList of Computable Policy Rule Language Representations of this Contract.protected List<Contract.SignatoryComponent>signerParty signing this Contract.static StringSP_ACTORstatic StringSP_IDENTIFIERstatic StringSP_PATIENTstatic StringSP_SIGNERstatic StringSP_SUBJECTprotected List<Reference>subjectWho and/or what this Contract is about: typically a Patient, Organization, or valued items such as goods and services.protected List<Resource>subjectTargetThe actual objects that are the target of the reference (Who and/or what this Contract is about: typically a Patient, Organization, or valued items such as goods and services.)protected List<CodeableConcept>subTypeMore 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>termOne or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.protected CodeableConcepttypeType 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>valuedItemContract Valued Item List.-
Fields inherited from class org.hl7.fhir.dstu2.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu2.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description Contract()
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu2.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText
-
Methods inherited from class org.hl7.fhir.dstu2.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.dstu2.model.BaseResource
getStructureFhirVersionEnum, setId
-
Methods inherited from class org.hl7.fhir.dstu2.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, 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
-
-
-
-
Field Detail
-
identifier
protected Identifier identifier
Unique identifier for this Contract.
-
issued
protected DateTimeType issued
When this Contract was issued.
-
subject
protected List<Reference> subject
Who and/or what this Contract is about: typically a Patient, Organization, or valued items such as goods and services.
-
subjectTarget
protected List<Resource> subjectTarget
The actual objects that are the target of the reference (Who and/or what this Contract is about: typically a Patient, Organization, or valued items such as goods and services.)
-
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.
-
actor
protected List<Contract.ActorComponent> actor
List of Contract actors.
-
valuedItem
protected List<Contract.ValuedItemComponent> valuedItem
Contract Valued Item List.
-
signer
protected List<Contract.SignatoryComponent> signer
Party signing this Contract.
-
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_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
-
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.)
-
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 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)
- 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)
-
listChildren
protected void listChildren(List<Property> childrenList)
- Overrides:
listChildrenin classDomainResource
-
setProperty
public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public Contract copy()
- Specified by:
copyin classDomainResource
-
equalsDeep
public boolean equalsDeep(Base other)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-