
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
A formal agreement between parties regarding the conduct of business,
exchange of information or other matters.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic class -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected List<CodeableConcept> Action stipulated by this Contract.protected List<CodeableConcept> Reason for action stipulated by this Contract.protected List<Contract.ActorComponent> List of Contract actors.protected PeriodRelevant time or time-period when this Contract is applicable.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 List<Organization> 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 TypeLegally 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.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.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> The "patient friendly language" versionof the Contract in whole or in parts.protected IdentifierUnique identifier for this Contract.protected DateTimeTypeWhen this Contract was issued.protected List<Contract.LegalLanguageComponent> List of Legal expressions or representations of this Contract.protected List<Contract.ComputableLanguageComponent> List of Computable Policy Rule Language Representations of this Contract.protected List<Contract.SignatoryComponent> Party signing this Contract.static final Stringstatic final Stringstatic final Stringstatic final Stringstatic final StringWho and/or what this Contract is about: typically a Patient, Organization, or valued items such as goods and services.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.)protected List<CodeableConcept> 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> One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.protected CodeableConceptType 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> Contract Valued Item List.Fields inherited from class org.hl7.fhir.dstu2.model.DomainResource
contained, extension, modifierExtension, textFields inherited from class org.hl7.fhir.dstu2.model.Resource
id, implicitRules, language, metaFields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAGFields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddActor()addLegal()addRule()addTerm()copy()booleanequalsDeep(Base other) booleanequalsShallow(Base other) fhirType()getActor()getLegal()getRule()getTerm()getType()booleanbooleanbooleanhasActor()booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanhasLegal()booleanhasRule()booleanbooleanbooleanbooleanhasTerm()booleanhasType()booleanbooleanisEmpty()protected voidlistChildren(List<Property> childrenList) setApplies(Period value) setBinding(Type value) setIdentifier(Identifier value) setIssuedElement(DateTimeType value) voidsetProperty(String name, Base value) setType(CodeableConcept value) protected ContractMethods inherited from class org.hl7.fhir.dstu2.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getModifierExtension, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setTextMethods 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, setMetaMethods inherited from class org.hl7.fhir.dstu2.model.BaseResource
getStructureFhirVersionEnum, setIdMethods 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, setUserDataINNMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserDataMethods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatCommentMethods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
identifier
Unique identifier for this Contract. -
issued
When this Contract was issued. -
applies
Relevant time or time-period when this Contract is applicable. -
subject
Who and/or what this Contract is about: typically a Patient, Organization, or valued items such as goods and services. -
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
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
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
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
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
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
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
Action stipulated by this Contract. -
actionReason
Reason for action stipulated by this Contract. -
actor
List of Contract actors. -
valuedItem
Contract Valued Item List. -
signer
Party signing this Contract. -
term
One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups. -
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
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
List of Legal expressions or representations of this Contract. -
rule
List of Computable Policy Rule Language Representations of this Contract. -
SP_ACTOR
- See Also:
-
SP_IDENTIFIER
- See Also:
-
SP_SUBJECT
- See Also:
-
SP_PATIENT
- See Also:
-
SP_SIGNER
- See Also:
-
-
Constructor Details
-
Contract
public Contract()
-
-
Method Details
-
getIdentifier
- Returns:
identifier(Unique identifier for this Contract.)
-
hasIdentifier
-
setIdentifier
- Parameters:
value-identifier(Unique identifier for this Contract.)
-
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
-
hasIssued
-
setIssuedElement
- 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
- Returns:
- When this Contract was issued.
-
setIssued
- Parameters:
value- When this Contract was issued.
-
getApplies
- Returns:
applies(Relevant time or time-period when this Contract is applicable.)
-
hasApplies
-
setApplies
- Parameters:
value-applies(Relevant time or time-period when this Contract is applicable.)
-
getSubject
- Returns:
subject(Who and/or what this Contract is about: typically a Patient, Organization, or valued items such as goods and services.)
-
hasSubject
-
addSubject
- Returns:
subject(Who and/or what this Contract is about: typically a Patient, Organization, or valued items such as goods and services.)
-
addSubject
-
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
- 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
-
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
-
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
- 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
- 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
-
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
-
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
- 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
- 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
-
setType
- 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
- 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
-
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
-
getAction
- Returns:
action(Action stipulated by this Contract.)
-
hasAction
-
addAction
- Returns:
action(Action stipulated by this Contract.)
-
addAction
-
getActionReason
- Returns:
actionReason(Reason for action stipulated by this Contract.)
-
hasActionReason
-
addActionReason
- Returns:
actionReason(Reason for action stipulated by this Contract.)
-
addActionReason
-
getActor
- Returns:
actor(List of Contract actors.)
-
hasActor
-
addActor
- Returns:
actor(List of Contract actors.)
-
addActor
-
getValuedItem
- Returns:
valuedItem(Contract Valued Item List.)
-
hasValuedItem
-
addValuedItem
- Returns:
valuedItem(Contract Valued Item List.)
-
addValuedItem
-
getSigner
- Returns:
signer(Party signing this Contract.)
-
hasSigner
-
addSigner
- Returns:
signer(Party signing this Contract.)
-
addSigner
-
getTerm
- Returns:
term(One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.)
-
hasTerm
-
addTerm
- Returns:
term(One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.)
-
addTerm
-
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
- 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
-
getBindingReference
- 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
-
hasBinding
-
setBinding
- 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
- 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
-
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
-
getLegal
- Returns:
legal(List of Legal expressions or representations of this Contract.)
-
hasLegal
-
addLegal
- Returns:
legal(List of Legal expressions or representations of this Contract.)
-
addLegal
-
getRule
- Returns:
rule(List of Computable Policy Rule Language Representations of this Contract.)
-
hasRule
-
addRule
- Returns:
rule(List of Computable Policy Rule Language Representations of this Contract.)
-
addRule
-
listChildren
- Overrides:
listChildrenin classDomainResource
-
setProperty
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
- Specified by:
copyin classDomainResource
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
- Specified by:
getResourceTypein classResource
-