Class 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
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static class
static class
static class
static class
static class
static class
static class
static class
static enum
static class
static enum
static class
static class
static class
static class
static class
static class
static class
-
Field Summary
Modifier and TypeFieldDescriptionprotected List
<StringType> Alternative representation of the title for this Contract definition, derivative, or instance in any legal state., e.g., a domain specific contract number related to legislation.protected Period
Relevant time or time-period when this Contract is applicable.protected Reference
The individual or organization that authored the Contract definition, derivative, or instance in any legal state.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
Fluent Client search parameter constant for authorityprotected 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 Resource
The actual object that is the target of the reference (The individual or organization that authored the Contract definition, derivative, or instance in any legal state.)protected Contract.ContentDefinitionComponent
Precusory content developed with a focus and intent of supporting the formation a Contract instance, which may be associated with and transformable into a Contract.protected CodeableConcept
The minimal content derived from the basal information source at a specific stage in its lifecycle.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
Fluent Client search parameter constant for domainThe 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 CodeableConcept
Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract.protected List
<Contract.FriendlyLanguageComponent> The "patient friendly language" versionof the Contract in whole or in parts.protected List
<Identifier> Unique identifier for this Contract or a derivative that references a Source Contract.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.rest.gclient.UriClientParam
Fluent Client search parameter constant for instantiatesprotected Reference
The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract.protected Contract
The actual object that is the target of the reference (The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract.)protected UriType
The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract.protected DateTimeType
When this Contract was issued.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for issuedprotected List
<Contract.LegalLanguageComponent> List of Legal expressions or representations of this Contract.protected Type
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
Legal states of the formation of a legal instrument, which is a formally executed written document that can be formally attributed to its author, records and formally expresses a legally enforceable act, process, or contractual duty, obligation, or right, and therefore evidences that act, process, or agreement.protected StringType
A natural language name identifying this Contract definition, derivative, or instance in any legal state.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for patientLinks to Provenance records for past versions of this Contract definition, derivative, or instance, which identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the Contract.protected List
<Provenance> The actual objects that are the target of the reference (Links to Provenance records for past versions of this Contract definition, derivative, or instance, which identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the Contract.protected List
<Contract.ComputableLanguageComponent> List of Computable Policy Rule Language Representations of this Contract.protected CodeableConcept
A selector of legal concerns for this Contract definition, derivative, or instance in any legal state.protected List
<Contract.SignatoryComponent> 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
Fluent Client search parameter constant for signerSites in which the contract is complied with, exercised, or in force.The actual objects that are the target of the reference (Sites in which the contract is complied with, exercised, or in force.)static final String
Search parameter: authoritystatic final String
Search parameter: domainstatic final String
Search parameter: identifierstatic final String
Search parameter: instantiatesstatic final String
Search parameter: issuedstatic final String
Search parameter: patientstatic final String
Search parameter: signerstatic final String
Search parameter: statusstatic final String
Search parameter: subjectstatic final String
Search parameter: urlprotected Enumeration
<Contract.ContractStatus> The status of the resource instance.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusThe target entity impacted by or of interest to parties to the agreement.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for subjectThe actual objects that are the target of the reference (The target entity impacted by or of interest to parties to the agreement.)protected StringType
An explanatory or alternate user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content.protected List
<CodeableConcept> Sub-category for the Contract that distinguishes the kinds of systems that would be interested in the Contract within the context of the Contract's scope.Information that may be needed by/relevant to the performer in their execution of this term action.The actual objects that are the target of the reference (Information that may be needed by/relevant to the performer in their execution of this term action.)protected List
<Contract.TermComponent> One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.protected StringType
A short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content.protected Type
Narrows the range of legal concerns to focus on the achievement of specific contractual objectives.protected CodeableConcept
A high-level category for the legal instrument, whether constructed as a Contract definition, derivative, or instance in any legal state.protected UriType
Canonical identifier for this contract, represented as a URI (globally unique).static final ca.uhn.fhir.rest.gclient.UriClientParam
Fluent Client search parameter constant for urlprotected StringType
An edition identifier used for business purposes to label business significant variants.Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
Fields 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_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadaddLegal()
Deprecated.Use Reference#setResource(IBaseResource) insteadaddRule()
addSite()
Deprecated.Use Reference#setResource(IBaseResource) insteadaddTerm()
copy()
void
copyValues
(Contract dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getAlias()
Deprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadgetLegal()
getName()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) Deprecated.Use Reference#setResource(IBaseResource) insteadgetRule()
getScope()
getSite()
Deprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadgetTerm()
getTitle()
getTopic()
getType()
String[]
getTypesForProperty
(int hash, String name) getUrl()
boolean
hasAlias()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasLegal()
boolean
boolean
boolean
boolean
boolean
hasName()
boolean
boolean
boolean
hasRule()
boolean
hasScope()
boolean
boolean
hasSite()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasTerm()
boolean
hasTitle()
boolean
boolean
hasTopic()
boolean
boolean
boolean
hasType()
boolean
hasUrl()
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setAlias
(List<StringType> theAlias) setApplies
(Period value) setAuthority
(List<Reference> theAuthority) setAuthorTarget
(Resource value) setExpirationType
(CodeableConcept value) setFriendly
(List<Contract.FriendlyLanguageComponent> theFriendly) setIdentifier
(List<Identifier> theIdentifier) setInstantiatesUri
(String value) setInstantiatesUriElement
(UriType value) setIssuedElement
(DateTimeType value) setLegal
(List<Contract.LegalLanguageComponent> theLegal) setLegallyBinding
(Type value) setLegalState
(CodeableConcept value) setNameElement
(StringType value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setRelevantHistory
(List<Reference> theRelevantHistory) setRule
(List<Contract.ComputableLanguageComponent> theRule) setScope
(CodeableConcept value) setSigner
(List<Contract.SignatoryComponent> theSigner) setStatus
(Contract.ContractStatus value) setSubject
(List<Reference> theSubject) setSubtitle
(String value) setSubtitleElement
(StringType value) setSubType
(List<CodeableConcept> theSubType) setSupportingInfo
(List<Reference> theSupportingInfo) setTerm
(List<Contract.TermComponent> theTerm) setTitleElement
(StringType value) setType
(CodeableConcept value) setUrlElement
(UriType value) setVersion
(String value) setVersionElement
(StringType value) protected Contract
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, 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.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, 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
Unique identifier for this Contract or a derivative that references a Source Contract. -
url
Canonical identifier for this contract, represented as a URI (globally unique). -
version
An edition identifier used for business purposes to label business significant variants. -
status
The status of the resource instance. -
legalState
Legal states of the formation of a legal instrument, which is a formally executed written document that can be formally attributed to its author, records and formally expresses a legally enforceable act, process, or contractual duty, obligation, or right, and therefore evidences that act, process, or agreement. -
instantiatesCanonical
The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract. -
instantiatesCanonicalTarget
The actual object that is the target of the reference (The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract.) -
instantiatesUri
The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract. -
contentDerivative
The minimal content derived from the basal information source at a specific stage in its lifecycle. -
issued
When this Contract was issued. -
applies
Relevant time or time-period when this Contract is applicable. -
expirationType
Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract. -
subject
The target entity impacted by or of interest to parties to the agreement. -
subjectTarget
The actual objects that are the target of the reference (The target entity impacted by or of interest to parties to the agreement.) -
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.) -
site
Sites in which the contract is complied with, exercised, or in force. -
siteTarget
The actual objects that are the target of the reference (Sites in which the contract is complied with, exercised, or in force.) -
name
A natural language name identifying this Contract definition, derivative, or instance in any legal state. Provides additional information about its content. This name should be usable as an identifier for the module by machine processing applications such as code generation. -
title
A short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content. -
subtitle
An explanatory or alternate user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content. -
alias
Alternative representation of the title for this Contract definition, derivative, or instance in any legal state., e.g., a domain specific contract number related to legislation. -
author
The individual or organization that authored the Contract definition, derivative, or instance in any legal state. -
authorTarget
The actual object that is the target of the reference (The individual or organization that authored the Contract definition, derivative, or instance in any legal state.) -
scope
A selector of legal concerns for this Contract definition, derivative, or instance in any legal state. -
topic
Narrows the range of legal concerns to focus on the achievement of specific contractual objectives. -
type
A high-level category for the legal instrument, whether constructed as a Contract definition, derivative, or instance in any legal state. Provides additional information about its content within the context of the Contract's scope to distinguish the kinds of systems that would be interested in the contract. -
subType
Sub-category for the Contract that distinguishes the kinds of systems that would be interested in the Contract within the context of the Contract's scope. -
contentDefinition
Precusory content developed with a focus and intent of supporting the formation a Contract instance, which may be associated with and transformable into a Contract. -
term
One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups. -
supportingInfo
Information that may be needed by/relevant to the performer in their execution of this term action. -
supportingInfoTarget
The actual objects that are the target of the reference (Information that may be needed by/relevant to the performer in their execution of this term action.) -
relevantHistory
Links to Provenance records for past versions of this Contract definition, derivative, or instance, which identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the Contract. The Provence.entity indicates the target that was changed in the update. http://build.fhir.org/provenance-definitions.html#Provenance.entity. -
relevantHistoryTarget
The actual objects that are the target of the reference (Links to Provenance records for past versions of this Contract definition, derivative, or instance, which identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the Contract. The Provence.entity indicates the target that was changed in the update. http://build.fhir.org/provenance-definitions.html#Provenance.entity.) -
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. -
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. -
legallyBinding
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. -
SP_IDENTIFIER
Search parameter: identifierDescription: The identity of the contract
Type: token
Path: Contract.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: The identity of the contract
Type: token
Path: Contract.identifier
-
SP_INSTANTIATES
Search parameter: instantiatesDescription: A source definition of the contract
Type: uri
Path: Contract.instantiatesUri
- See Also:
-
INSTANTIATES
Fluent Client search parameter constant for instantiatesDescription: A source definition of the contract
Type: uri
Path: Contract.instantiatesUri
-
SP_PATIENT
Search parameter: patientDescription: The identity of the subject of the contract (if a patient)
Type: reference
Path: Contract.subject
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: The identity of the subject of the contract (if a patient)
Type: reference
Path: Contract.subject
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Contract:patient". -
SP_SUBJECT
Search parameter: subjectDescription: The identity of the subject of the contract
Type: reference
Path: Contract.subject
- See Also:
-
SUBJECT
Fluent Client search parameter constant for subjectDescription: The identity of the subject of the contract
Type: reference
Path: Contract.subject
-
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Contract:subject". -
SP_AUTHORITY
Search parameter: authorityDescription: The authority of the contract
Type: reference
Path: Contract.authority
- See Also:
-
AUTHORITY
Fluent Client search parameter constant for authorityDescription: The authority of the contract
Type: reference
Path: Contract.authority
-
INCLUDE_AUTHORITY
Constant for fluent queries to be used to add include statements. Specifies the path value of "Contract:authority". -
SP_DOMAIN
Search parameter: domainDescription: The domain of the contract
Type: reference
Path: Contract.domain
- See Also:
-
DOMAIN
Fluent Client search parameter constant for domainDescription: The domain of the contract
Type: reference
Path: Contract.domain
-
INCLUDE_DOMAIN
Constant for fluent queries to be used to add include statements. Specifies the path value of "Contract:domain". -
SP_ISSUED
Search parameter: issuedDescription: The date/time the contract was issued
Type: date
Path: Contract.issued
- See Also:
-
ISSUED
Fluent Client search parameter constant for issuedDescription: The date/time the contract was issued
Type: date
Path: Contract.issued
-
SP_URL
Search parameter: urlDescription: The basal contract definition
Type: uri
Path: Contract.url
- See Also:
-
URL
Fluent Client search parameter constant for urlDescription: The basal contract definition
Type: uri
Path: Contract.url
-
SP_SIGNER
Search parameter: signerDescription: Contract Signatory Party
Type: reference
Path: Contract.signer.party
- See Also:
-
SIGNER
Fluent Client search parameter constant for signerDescription: Contract Signatory Party
Type: reference
Path: Contract.signer.party
-
INCLUDE_SIGNER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Contract:signer". -
SP_STATUS
Search parameter: statusDescription: The status of the contract
Type: token
Path: Contract.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: The status of the contract
Type: token
Path: Contract.status
-
-
Constructor Details
-
Contract
public Contract()Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(Unique identifier for this Contract or a derivative that references a Source Contract.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
getUrlElement
- Returns:
url
(Canonical identifier for this contract, represented as a URI (globally unique).). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
hasUrlElement
-
hasUrl
-
setUrlElement
- Parameters:
value
-url
(Canonical identifier for this contract, represented as a URI (globally unique).). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
getUrl
- Returns:
- Canonical identifier for this contract, represented as a URI (globally unique).
-
setUrl
- Parameters:
value
- Canonical identifier for this contract, represented as a URI (globally unique).
-
getVersionElement
- Returns:
version
(An edition identifier used for business purposes to label business significant variants.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
hasVersionElement
-
hasVersion
-
setVersionElement
- Parameters:
value
-version
(An edition identifier used for business purposes to label business significant variants.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
getVersion
- Returns:
- An edition identifier used for business purposes to label business significant variants.
-
setVersion
- Parameters:
value
- An edition identifier used for business purposes to label business significant variants.
-
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
-
hasStatus
-
setStatusElement
- 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
- Returns:
- The status of the resource instance.
-
setStatus
- Parameters:
value
- The status of the resource instance.
-
getLegalState
- Returns:
legalState
(Legal states of the formation of a legal instrument, which is a formally executed written document that can be formally attributed to its author, records and formally expresses a legally enforceable act, process, or contractual duty, obligation, or right, and therefore evidences that act, process, or agreement.)
-
hasLegalState
-
setLegalState
- Parameters:
value
-legalState
(Legal states of the formation of a legal instrument, which is a formally executed written document that can be formally attributed to its author, records and formally expresses a legally enforceable act, process, or contractual duty, obligation, or right, and therefore evidences that act, process, or agreement.)
-
getInstantiatesCanonical
- Returns:
instantiatesCanonical
(The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract.)
-
hasInstantiatesCanonical
-
setInstantiatesCanonical
- Parameters:
value
-instantiatesCanonical
(The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract.)
-
getInstantiatesCanonicalTarget
- Returns:
instantiatesCanonical
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract.)
-
setInstantiatesCanonicalTarget
- Parameters:
value
-instantiatesCanonical
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract.)
-
getInstantiatesUriElement
- Returns:
instantiatesUri
(The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract.). This is the underlying object with id, value and extensions. The accessor "getInstantiatesUri" gives direct access to the value
-
hasInstantiatesUriElement
-
hasInstantiatesUri
-
setInstantiatesUriElement
- Parameters:
value
-instantiatesUri
(The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract.). This is the underlying object with id, value and extensions. The accessor "getInstantiatesUri" gives direct access to the value
-
getInstantiatesUri
- Returns:
- The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract.
-
setInstantiatesUri
- Parameters:
value
- The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract.
-
getContentDerivative
- Returns:
contentDerivative
(The minimal content derived from the basal information source at a specific stage in its lifecycle.)
-
hasContentDerivative
-
setContentDerivative
- Parameters:
value
-contentDerivative
(The minimal content derived from the basal information source at a specific stage in its lifecycle.)
-
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.)
-
getExpirationType
- Returns:
expirationType
(Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract.)
-
hasExpirationType
-
setExpirationType
- Parameters:
value
-expirationType
(Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract.)
-
getSubject
- Returns:
subject
(The target entity impacted by or of interest to parties to the agreement.)
-
setSubject
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSubject
-
addSubject
-
addSubject
-
getSubjectFirstRep
- Returns:
- The first repetition of repeating field
subject
, creating it if it does not already exist
-
getSubjectTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAuthority
-
addAuthority
-
addAuthority
-
getAuthorityFirstRep
- Returns:
- The first repetition of repeating field
authority
, creating it if it does not already exist
-
getAuthorityTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addAuthorityTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasDomain
-
addDomain
-
addDomain
-
getDomainFirstRep
- Returns:
- The first repetition of repeating field
domain
, creating it if it does not already exist
-
getDomainTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addDomainTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getSite
- Returns:
site
(Sites in which the contract is complied with, exercised, or in force.)
-
setSite
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSite
-
addSite
-
addSite
-
getSiteFirstRep
- Returns:
- The first repetition of repeating field
site
, creating it if it does not already exist
-
getSiteTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addSiteTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getNameElement
- Returns:
name
(A natural language name identifying this Contract definition, derivative, or instance in any legal state. Provides additional information about its content. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
hasNameElement
-
hasName
-
setNameElement
- Parameters:
value
-name
(A natural language name identifying this Contract definition, derivative, or instance in any legal state. Provides additional information about its content. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
getName
- Returns:
- A natural language name identifying this Contract definition, derivative, or instance in any legal state. Provides additional information about its content. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
setName
- Parameters:
value
- A natural language name identifying this Contract definition, derivative, or instance in any legal state. Provides additional information about its content. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
getTitleElement
- Returns:
title
(A short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
hasTitleElement
-
hasTitle
-
setTitleElement
- Parameters:
value
-title
(A short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
getTitle
- Returns:
- A short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content.
-
setTitle
- Parameters:
value
- A short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content.
-
getSubtitleElement
- Returns:
subtitle
(An explanatory or alternate user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content.). This is the underlying object with id, value and extensions. The accessor "getSubtitle" gives direct access to the value
-
hasSubtitleElement
-
hasSubtitle
-
setSubtitleElement
- Parameters:
value
-subtitle
(An explanatory or alternate user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content.). This is the underlying object with id, value and extensions. The accessor "getSubtitle" gives direct access to the value
-
getSubtitle
- Returns:
- An explanatory or alternate user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content.
-
setSubtitle
- Parameters:
value
- An explanatory or alternate user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content.
-
getAlias
- Returns:
alias
(Alternative representation of the title for this Contract definition, derivative, or instance in any legal state., e.g., a domain specific contract number related to legislation.)
-
setAlias
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAlias
-
addAliasElement
- Returns:
alias
(Alternative representation of the title for this Contract definition, derivative, or instance in any legal state., e.g., a domain specific contract number related to legislation.)
-
addAlias
- Parameters:
value
-alias
(Alternative representation of the title for this Contract definition, derivative, or instance in any legal state., e.g., a domain specific contract number related to legislation.)
-
hasAlias
- Parameters:
value
-alias
(Alternative representation of the title for this Contract definition, derivative, or instance in any legal state., e.g., a domain specific contract number related to legislation.)
-
getAuthor
- Returns:
author
(The individual or organization that authored the Contract definition, derivative, or instance in any legal state.)
-
hasAuthor
-
setAuthor
- Parameters:
value
-author
(The individual or organization that authored the Contract definition, derivative, or instance in any legal state.)
-
getAuthorTarget
- Returns:
author
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The individual or organization that authored the Contract definition, derivative, or instance in any legal state.)
-
setAuthorTarget
- Parameters:
value
-author
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The individual or organization that authored the Contract definition, derivative, or instance in any legal state.)
-
getScope
- Returns:
scope
(A selector of legal concerns for this Contract definition, derivative, or instance in any legal state.)
-
hasScope
-
setScope
- Parameters:
value
-scope
(A selector of legal concerns for this Contract definition, derivative, or instance in any legal state.)
-
getTopic
- Returns:
topic
(Narrows the range of legal concerns to focus on the achievement of specific contractual objectives.)
-
getTopicCodeableConcept
- Returns:
topic
(Narrows the range of legal concerns to focus on the achievement of specific contractual objectives.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTopicCodeableConcept
-
getTopicReference
- Returns:
topic
(Narrows the range of legal concerns to focus on the achievement of specific contractual objectives.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTopicReference
-
hasTopic
-
setTopic
- Parameters:
value
-topic
(Narrows the range of legal concerns to focus on the achievement of specific contractual objectives.)
-
getType
- Returns:
type
(A high-level category for the legal instrument, whether constructed as a Contract definition, derivative, or instance in any legal state. Provides additional information about its content within the context of the Contract's scope to distinguish the kinds of systems that would be interested in the contract.)
-
hasType
-
setType
- Parameters:
value
-type
(A high-level category for the legal instrument, whether constructed as a Contract definition, derivative, or instance in any legal state. Provides additional information about its content within the context of the Contract's scope to distinguish the kinds of systems that would be interested in the contract.)
-
getSubType
- Returns:
subType
(Sub-category for the Contract that distinguishes the kinds of systems that would be interested in the Contract within the context of the Contract's scope.)
-
setSubType
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSubType
-
addSubType
-
addSubType
-
getSubTypeFirstRep
- Returns:
- The first repetition of repeating field
subType
, creating it if it does not already exist
-
getContentDefinition
- Returns:
contentDefinition
(Precusory content developed with a focus and intent of supporting the formation a Contract instance, which may be associated with and transformable into a Contract.)
-
hasContentDefinition
-
setContentDefinition
- Parameters:
value
-contentDefinition
(Precusory content developed with a focus and intent of supporting the formation a Contract instance, which may be associated with and transformable into a Contract.)
-
getTerm
- Returns:
term
(One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.)
-
setTerm
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasTerm
-
addTerm
-
addTerm
-
getTermFirstRep
- Returns:
- The first repetition of repeating field
term
, creating it if it does not already exist
-
getSupportingInfo
- Returns:
supportingInfo
(Information that may be needed by/relevant to the performer in their execution of this term action.)
-
setSupportingInfo
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSupportingInfo
-
addSupportingInfo
-
addSupportingInfo
-
getSupportingInfoFirstRep
- Returns:
- The first repetition of repeating field
supportingInfo
, creating it if it does not already exist
-
getSupportingInfoTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getRelevantHistory
- Returns:
relevantHistory
(Links to Provenance records for past versions of this Contract definition, derivative, or instance, which identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the Contract. The Provence.entity indicates the target that was changed in the update. http://build.fhir.org/provenance-definitions.html#Provenance.entity.)
-
setRelevantHistory
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasRelevantHistory
-
addRelevantHistory
-
addRelevantHistory
-
getRelevantHistoryFirstRep
- Returns:
- The first repetition of repeating field
relevantHistory
, creating it if it does not already exist
-
getRelevantHistoryTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addRelevantHistoryTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSigner
-
addSigner
-
addSigner
-
getSignerFirstRep
- Returns:
- The first repetition of repeating field
signer
, creating it if it does not already exist
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasFriendly
-
addFriendly
-
addFriendly
-
getFriendlyFirstRep
- Returns:
- The first repetition of repeating field
friendly
, creating it if it does not already exist
-
getLegal
- Returns:
legal
(List of Legal expressions or representations of this Contract.)
-
setLegal
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasLegal
-
addLegal
-
addLegal
-
getLegalFirstRep
- Returns:
- The first repetition of repeating field
legal
, creating it if it does not already exist
-
getRule
- Returns:
rule
(List of Computable Policy Rule Language Representations of this Contract.)
-
setRule
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasRule
-
addRule
-
addRule
-
getRuleFirstRep
- Returns:
- The first repetition of repeating field
rule
, creating it if it does not already exist
-
getLegallyBinding
- Returns:
legallyBinding
(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.)
-
getLegallyBindingAttachment
- Returns:
legallyBinding
(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
-
hasLegallyBindingAttachment
-
getLegallyBindingReference
- Returns:
legallyBinding
(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
-
hasLegallyBindingReference
-
hasLegallyBinding
-
setLegallyBinding
- Parameters:
value
-legallyBinding
(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.)
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- 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 classDomainResource
- 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 classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-