public class Contract extends BaseResource implements IResource
Definition: A formal agreement between parties regarding the conduct of business, exchange of information or other matters.
Requirements:
Profile Definition: http://hl7.org/fhir/profiles/Contract
| Modifier and Type | Class and Description |
|---|---|
static class |
Contract.Actor
Block class for child element: Contract.actor ()
|
static class |
Contract.Friendly
Block class for child element: Contract.friendly ()
|
static class |
Contract.Legal
Block class for child element: Contract.legal ()
|
static class |
Contract.Rule
Block class for child element: Contract.rule ()
|
static class |
Contract.Signer
Block class for child element: Contract.signer ()
|
static class |
Contract.Term
Block class for child element: Contract.term ()
|
static class |
Contract.TermActor
Block class for child element: Contract.term.actor ()
|
static class |
Contract.TermValuedItem
Block class for child element: Contract.term.valuedItem ()
|
static class |
Contract.ValuedItem
Block class for child element: Contract.valuedItem ()
|
| Modifier and Type | Field and Description |
|---|---|
static ReferenceClientParam |
ACTOR
Fluent Client search parameter constant for actor
|
static TokenClientParam |
IDENTIFIER
Fluent Client search parameter constant for identifier
|
static Include |
INCLUDE_ACTOR
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_SIGNER
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements.
|
static ReferenceClientParam |
PATIENT
Fluent Client search parameter constant for patient
|
static ReferenceClientParam |
SIGNER
Fluent Client search parameter constant for signer
|
static String |
SP_ACTOR
Search parameter constant for actor
|
static String |
SP_IDENTIFIER
Search parameter constant for identifier
|
static String |
SP_PATIENT
Search parameter constant for patient
|
static String |
SP_SIGNER
Search parameter constant for signer
|
static String |
SP_SUBJECT
Search parameter constant for subject
|
static ReferenceClientParam |
SUBJECT
Fluent Client search parameter constant for subject
|
RES_ID, SP_RES_ID, SP_RES_LANGUAGEINCLUDE_ALL, WILDCARD_ALL_SET| Constructor and Description |
|---|
Contract() |
| Modifier and Type | Method and Description |
|---|---|
BoundCodeableConceptDt<ContractActionCodesEnum> |
addAction()
Add a value for action ()
|
BoundCodeableConceptDt<ContractActionCodesEnum> |
addAction(ContractActionCodesEnum theValue)
Add a value for action () using an enumerated type.
|
CodeableConceptDt |
addActionReason()
Adds and returns a new value for actionReason ()
|
Contract |
addActionReason(CodeableConceptDt theValue)
Adds a given new value for actionReason ()
|
Contract.Actor |
addActor()
Adds and returns a new value for actor ()
|
Contract |
addActor(Contract.Actor theValue)
Adds a given new value for actor ()
|
ResourceReferenceDt |
addAuthority()
Adds and returns a new value for authority ()
|
ResourceReferenceDt |
addDomain()
Adds and returns a new value for domain ()
|
Contract.Friendly |
addFriendly()
Adds and returns a new value for friendly ()
|
Contract |
addFriendly(Contract.Friendly theValue)
Adds a given new value for friendly ()
|
Contract.Legal |
addLegal()
Adds and returns a new value for legal ()
|
Contract |
addLegal(Contract.Legal theValue)
Adds a given new value for legal ()
|
Contract.Rule |
addRule()
Adds and returns a new value for rule ()
|
Contract |
addRule(Contract.Rule theValue)
Adds a given new value for rule ()
|
Contract.Signer |
addSigner()
Adds and returns a new value for signer ()
|
Contract |
addSigner(Contract.Signer theValue)
Adds a given new value for signer ()
|
ResourceReferenceDt |
addSubject()
Adds and returns a new value for subject ()
|
BoundCodeableConceptDt<ContractSubtypeCodesEnum> |
addSubType()
Add a value for subType ()
|
BoundCodeableConceptDt<ContractSubtypeCodesEnum> |
addSubType(ContractSubtypeCodesEnum theValue)
Add a value for subType () using an enumerated type.
|
Contract.Term |
addTerm()
Adds and returns a new value for term ()
|
Contract |
addTerm(Contract.Term theValue)
Adds a given new value for term ()
|
Contract.ValuedItem |
addValuedItem()
Adds and returns a new value for valuedItem ()
|
Contract |
addValuedItem(Contract.ValuedItem theValue)
Adds a given new value for valuedItem ()
|
List<BoundCodeableConceptDt<ContractActionCodesEnum>> |
getAction()
Gets the value(s) for action ().
|
BoundCodeableConceptDt<ContractActionCodesEnum> |
getActionFirstRep()
Gets the first repetition for action (),
creating it if it does not already exist.
|
List<CodeableConceptDt> |
getActionReason()
Gets the value(s) for actionReason ().
|
CodeableConceptDt |
getActionReasonFirstRep()
Gets the first repetition for actionReason (),
creating it if it does not already exist.
|
List<Contract.Actor> |
getActor()
Gets the value(s) for actor ().
|
Contract.Actor |
getActorFirstRep()
Gets the first repetition for actor (),
creating it if it does not already exist.
|
<T extends IElement> |
getAllPopulatedChildElementsOfType(Class<T> theType) |
PeriodDt |
getApplies()
Gets the value(s) for applies ().
|
List<ResourceReferenceDt> |
getAuthority()
Gets the value(s) for authority ().
|
IDatatype |
getBinding()
Gets the value(s) for binding[x] ().
|
List<ResourceReferenceDt> |
getDomain()
Gets the value(s) for domain ().
|
List<Contract.Friendly> |
getFriendly()
Gets the value(s) for friendly ().
|
Contract.Friendly |
getFriendlyFirstRep()
Gets the first repetition for friendly (),
creating it if it does not already exist.
|
IdentifierDt |
getIdentifier()
Gets the value(s) for identifier ().
|
Date |
getIssued()
Gets the value(s) for issued ().
|
DateTimeDt |
getIssuedElement()
Gets the value(s) for issued ().
|
List<Contract.Legal> |
getLegal()
Gets the value(s) for legal ().
|
Contract.Legal |
getLegalFirstRep()
Gets the first repetition for legal (),
creating it if it does not already exist.
|
String |
getResourceName() |
List<Contract.Rule> |
getRule()
Gets the value(s) for rule ().
|
Contract.Rule |
getRuleFirstRep()
Gets the first repetition for rule (),
creating it if it does not already exist.
|
List<Contract.Signer> |
getSigner()
Gets the value(s) for signer ().
|
Contract.Signer |
getSignerFirstRep()
Gets the first repetition for signer (),
creating it if it does not already exist.
|
FhirVersionEnum |
getStructureFhirVersionEnum() |
List<ResourceReferenceDt> |
getSubject()
Gets the value(s) for subject ().
|
List<BoundCodeableConceptDt<ContractSubtypeCodesEnum>> |
getSubType()
Gets the value(s) for subType ().
|
BoundCodeableConceptDt<ContractSubtypeCodesEnum> |
getSubTypeFirstRep()
Gets the first repetition for subType (),
creating it if it does not already exist.
|
List<Contract.Term> |
getTerm()
Gets the value(s) for term ().
|
Contract.Term |
getTermFirstRep()
Gets the first repetition for term (),
creating it if it does not already exist.
|
BoundCodeableConceptDt<ContractTypeCodesEnum> |
getType()
Gets the value(s) for type ().
|
List<Contract.ValuedItem> |
getValuedItem()
Gets the value(s) for valuedItem ().
|
Contract.ValuedItem |
getValuedItemFirstRep()
Gets the first repetition for valuedItem (),
creating it if it does not already exist.
|
boolean |
isEmpty() |
Contract |
setAction(ContractActionCodesEnum theValue)
Sets the value(s), and clears any existing value(s) for action ()
|
Contract |
setAction(List<BoundCodeableConceptDt<ContractActionCodesEnum>> theValue)
Sets the value(s) for action ()
|
Contract |
setActionReason(List<CodeableConceptDt> theValue)
Sets the value(s) for actionReason ()
|
Contract |
setActor(List<Contract.Actor> theValue)
Sets the value(s) for actor ()
|
Contract |
setApplies(PeriodDt theValue)
Sets the value(s) for applies ()
|
Contract |
setAuthority(List<ResourceReferenceDt> theValue)
Sets the value(s) for authority ()
|
Contract |
setBinding(IDatatype theValue)
Sets the value(s) for binding[x] ()
|
Contract |
setDomain(List<ResourceReferenceDt> theValue)
Sets the value(s) for domain ()
|
Contract |
setFriendly(List<Contract.Friendly> theValue)
Sets the value(s) for friendly ()
|
Contract |
setIdentifier(IdentifierDt theValue)
Sets the value(s) for identifier ()
|
Contract |
setIssued(Date theDate,
TemporalPrecisionEnum thePrecision)
Sets the value for issued ()
|
Contract |
setIssued(DateTimeDt theValue)
Sets the value(s) for issued ()
|
Contract |
setIssuedWithSecondsPrecision(Date theDate)
Sets the value for issued ()
|
Contract |
setLegal(List<Contract.Legal> theValue)
Sets the value(s) for legal ()
|
Contract |
setRule(List<Contract.Rule> theValue)
Sets the value(s) for rule ()
|
Contract |
setSigner(List<Contract.Signer> theValue)
Sets the value(s) for signer ()
|
Contract |
setSubject(List<ResourceReferenceDt> theValue)
Sets the value(s) for subject ()
|
Contract |
setSubType(ContractSubtypeCodesEnum theValue)
Sets the value(s), and clears any existing value(s) for subType ()
|
Contract |
setSubType(List<BoundCodeableConceptDt<ContractSubtypeCodesEnum>> theValue)
Sets the value(s) for subType ()
|
Contract |
setTerm(List<Contract.Term> theValue)
Sets the value(s) for term ()
|
Contract |
setType(BoundCodeableConceptDt<ContractTypeCodesEnum> theValue)
Sets the value(s) for type ()
|
Contract |
setType(ContractTypeCodesEnum theValue)
Sets the value(s) for type ()
|
Contract |
setValuedItem(List<Contract.ValuedItem> theValue)
Sets the value(s) for valuedItem ()
|
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toStringaddUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensionsclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadatagetIdElement, setId, setIdpublic static final String SP_SUBJECT
Description: The identity of the target of the contract
Type: reference
Path: Contract.subject
public static final ReferenceClientParam SUBJECT
Description: The identity of the target of the contract
Type: reference
Path: Contract.subject
public static final String SP_PATIENT
Description: The identity of the target of the contract (if a patient)
Type: reference
Path: Contract.subject
public static final ReferenceClientParam PATIENT
Description: The identity of the target of the contract (if a patient)
Type: reference
Path: Contract.subject
public static final String SP_IDENTIFIER
Description: The identity of the contract
Type: token
Path: Contract.identifier
public static final TokenClientParam IDENTIFIER
Description: The identity of the contract
Type: token
Path: Contract.identifier
public static final String SP_ACTOR
Description:
Type: reference
Path: Contract.actor.entity
public static final ReferenceClientParam ACTOR
Description:
Type: reference
Path: Contract.actor.entity
public static final String SP_SIGNER
Description:
Type: reference
Path: Contract.signer.party
public static final ReferenceClientParam SIGNER
Description:
Type: reference
Path: Contract.signer.party
public static final Include INCLUDE_ACTOR
public static final Include INCLUDE_PATIENT
public static final Include INCLUDE_SIGNER
public static final Include INCLUDE_SUBJECT
public Contract()
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
getAllPopulatedChildElementsOfType in interface ICompositeElementpublic IdentifierDt getIdentifier()
null.
Definition: Unique identifier for this Contract.
public Contract setIdentifier(IdentifierDt theValue)
Definition: Unique identifier for this Contract.
public DateTimeDt getIssuedElement()
null.
Definition: When this Contract was issued.
public Date getIssued()
null.
Definition: When this Contract was issued.
public Contract setIssued(DateTimeDt theValue)
Definition: When this Contract was issued.
public Contract setIssued(Date theDate, TemporalPrecisionEnum thePrecision)
Definition: When this Contract was issued.
public Contract setIssuedWithSecondsPrecision(Date theDate)
Definition: When this Contract was issued.
public PeriodDt getApplies()
null.
Definition: Relevant time or time-period when this Contract is applicable
public Contract setApplies(PeriodDt theValue)
Definition: Relevant time or time-period when this Contract is applicable
public List<ResourceReferenceDt> getSubject()
null.
Definition: Who and/or what this Contract is about: typically a Patient, Organization, or valued items such as goods and services.
public Contract setSubject(List<ResourceReferenceDt> theValue)
Definition: Who and/or what this Contract is about: typically a Patient, Organization, or valued items such as goods and services.
public ResourceReferenceDt addSubject()
Definition: Who and/or what this Contract is about: typically a Patient, Organization, or valued items such as goods and services.
public List<ResourceReferenceDt> getAuthority()
null.
Definition: 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.
public Contract setAuthority(List<ResourceReferenceDt> theValue)
Definition: 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.
public ResourceReferenceDt addAuthority()
Definition: 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.
public List<ResourceReferenceDt> getDomain()
null.
Definition: 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.
public Contract setDomain(List<ResourceReferenceDt> theValue)
Definition: 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.
public ResourceReferenceDt addDomain()
Definition: 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.
public BoundCodeableConceptDt<ContractTypeCodesEnum> getType()
null.
Definition: Type of Contract such as an insurance policy, real estate contract, a will, power of attorny, Privacy or Security policy , trust framework agreement, etc.
public Contract setType(BoundCodeableConceptDt<ContractTypeCodesEnum> theValue)
Definition: Type of Contract such as an insurance policy, real estate contract, a will, power of attorny, Privacy or Security policy , trust framework agreement, etc.
public Contract setType(ContractTypeCodesEnum theValue)
Definition: Type of Contract such as an insurance policy, real estate contract, a will, power of attorny, Privacy or Security policy , trust framework agreement, etc.
public List<BoundCodeableConceptDt<ContractSubtypeCodesEnum>> getSubType()
null.
Definition: 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.
public Contract setSubType(List<BoundCodeableConceptDt<ContractSubtypeCodesEnum>> theValue)
Definition: 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.
public BoundCodeableConceptDt<ContractSubtypeCodesEnum> addSubType(ContractSubtypeCodesEnum theValue)
addSubType() method.
Definition: 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.
public BoundCodeableConceptDt<ContractSubtypeCodesEnum> getSubTypeFirstRep()
Definition: 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.
public BoundCodeableConceptDt<ContractSubtypeCodesEnum> addSubType()
Definition: 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.
public Contract setSubType(ContractSubtypeCodesEnum theValue)
Definition: 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.
public List<BoundCodeableConceptDt<ContractActionCodesEnum>> getAction()
null.
Definition: Action stipulated by this Contract.
public Contract setAction(List<BoundCodeableConceptDt<ContractActionCodesEnum>> theValue)
Definition: Action stipulated by this Contract.
public BoundCodeableConceptDt<ContractActionCodesEnum> addAction(ContractActionCodesEnum theValue)
addAction() method.
Definition: Action stipulated by this Contract.
public BoundCodeableConceptDt<ContractActionCodesEnum> getActionFirstRep()
Definition: Action stipulated by this Contract.
public BoundCodeableConceptDt<ContractActionCodesEnum> addAction()
Definition: Action stipulated by this Contract.
public Contract setAction(ContractActionCodesEnum theValue)
Definition: Action stipulated by this Contract.
public List<CodeableConceptDt> getActionReason()
null.
Definition: Reason for action stipulated by this Contract.
public Contract setActionReason(List<CodeableConceptDt> theValue)
Definition: Reason for action stipulated by this Contract.
public CodeableConceptDt addActionReason()
Definition: Reason for action stipulated by this Contract.
public Contract addActionReason(CodeableConceptDt theValue)
Definition: Reason for action stipulated by this Contract.
theValue - The actionReason to add (must not be null)public CodeableConceptDt getActionReasonFirstRep()
Definition: Reason for action stipulated by this Contract.
public List<Contract.Actor> getActor()
null.
Definition: List of Contract actors
public Contract setActor(List<Contract.Actor> theValue)
Definition: List of Contract actors
public Contract.Actor addActor()
Definition: List of Contract actors
public Contract addActor(Contract.Actor theValue)
Definition: List of Contract actors
theValue - The actor to add (must not be null)public Contract.Actor getActorFirstRep()
Definition: List of Contract actors
public List<Contract.ValuedItem> getValuedItem()
null.
Definition: Contract Valued Item List
public Contract setValuedItem(List<Contract.ValuedItem> theValue)
Definition: Contract Valued Item List
public Contract.ValuedItem addValuedItem()
Definition: Contract Valued Item List
public Contract addValuedItem(Contract.ValuedItem theValue)
Definition: Contract Valued Item List
theValue - The valuedItem to add (must not be null)public Contract.ValuedItem getValuedItemFirstRep()
Definition: Contract Valued Item List
public List<Contract.Signer> getSigner()
null.
Definition: Party signing this Contract.
public Contract setSigner(List<Contract.Signer> theValue)
Definition: Party signing this Contract.
public Contract.Signer addSigner()
Definition: Party signing this Contract.
public Contract addSigner(Contract.Signer theValue)
Definition: Party signing this Contract.
theValue - The signer to add (must not be null)public Contract.Signer getSignerFirstRep()
Definition: Party signing this Contract.
public List<Contract.Term> getTerm()
null.
Definition: One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.
public Contract setTerm(List<Contract.Term> theValue)
Definition: One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.
public Contract.Term addTerm()
Definition: One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.
public Contract addTerm(Contract.Term theValue)
Definition: One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.
theValue - The term to add (must not be null)public Contract.Term getTermFirstRep()
Definition: One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.
public IDatatype getBinding()
null.
Definition: 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.
public Contract setBinding(IDatatype theValue)
Definition: 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.
public List<Contract.Friendly> getFriendly()
null.
Definition: 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.
public Contract setFriendly(List<Contract.Friendly> theValue)
Definition: 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.
public Contract.Friendly addFriendly()
Definition: 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.
public Contract addFriendly(Contract.Friendly theValue)
Definition: 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.
theValue - The friendly to add (must not be null)public Contract.Friendly getFriendlyFirstRep()
Definition: 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.
public List<Contract.Legal> getLegal()
null.
Definition: List of Legal expressions or representations of this Contract.
public Contract setLegal(List<Contract.Legal> theValue)
Definition: List of Legal expressions or representations of this Contract.
public Contract.Legal addLegal()
Definition: List of Legal expressions or representations of this Contract.
public Contract addLegal(Contract.Legal theValue)
Definition: List of Legal expressions or representations of this Contract.
theValue - The legal to add (must not be null)public Contract.Legal getLegalFirstRep()
Definition: List of Legal expressions or representations of this Contract.
public List<Contract.Rule> getRule()
null.
Definition: List of Computable Policy Rule Language Representations of this Contract.
public Contract setRule(List<Contract.Rule> theValue)
Definition: List of Computable Policy Rule Language Representations of this Contract.
public Contract.Rule addRule()
Definition: List of Computable Policy Rule Language Representations of this Contract.
public Contract addRule(Contract.Rule theValue)
Definition: List of Computable Policy Rule Language Representations of this Contract.
theValue - The rule to add (must not be null)public Contract.Rule getRuleFirstRep()
Definition: List of Computable Policy Rule Language Representations of this Contract.
public String getResourceName()
getResourceName in interface IResourcepublic FhirVersionEnum getStructureFhirVersionEnum()
getStructureFhirVersionEnum in interface IResourcegetStructureFhirVersionEnum in interface IBaseResourceCopyright © 2014–2016 University Health Network. All rights reserved.