Class Contract
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.resource.Resource
-
- org.linuxforhealth.fhir.model.resource.DomainResource
-
- org.linuxforhealth.fhir.model.resource.Contract
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.fhir.tools.CodeGenerator") public class Contract extends DomainResource
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.Maturity level: FMM1 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Contract.Builder
static class
Contract.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.static class
Contract.Friendly
The "patient friendly language" versionof the Contract in whole or in parts.static class
Contract.Legal
List of Legal expressions or representations of this Contract.static class
Contract.Rule
List of Computable Policy Rule Language Representations of this Contract.static class
Contract.Signer
Parties with legal standing in the Contract, including the principal parties, the grantor(s) and grantee(s), which are any person or organization bound by the contract, and any ancillary parties, which facilitate the execution of the contract such as a notary or witness.static class
Contract.Term
One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static Contract.Builder
builder()
boolean
equals(java.lang.Object obj)
java.util.List<String>
getAlias()
Alternative representation of the title for this Contract definition, derivative, or instance in any legal state., e.Period
getApplies()
Relevant time or time-period when this Contract is applicable.Reference
getAuthor()
The individual or organization that authored the Contract definition, derivative, or instance in any legal state.java.util.List<Reference>
getAuthority()
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.Contract.ContentDefinition
getContentDefinition()
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.CodeableConcept
getContentDerivative()
The minimal content derived from the basal information source at a specific stage in its lifecycle.java.util.List<Reference>
getDomain()
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.CodeableConcept
getExpirationType()
Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract.java.util.List<Contract.Friendly>
getFriendly()
The "patient friendly language" versionof the Contract in whole or in parts.java.util.List<Identifier>
getIdentifier()
Unique identifier for this Contract or a derivative that references a Source Contract.Reference
getInstantiatesCanonical()
The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract.Uri
getInstantiatesUri()
The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract.DateTime
getIssued()
When this Contract was issued.java.util.List<Contract.Legal>
getLegal()
List of Legal expressions or representations of this Contract.Element
getLegallyBinding()
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.CodeableConcept
getLegalState()
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.String
getName()
A natural language name identifying this Contract definition, derivative, or instance in any legal state.java.util.List<Reference>
getRelevantHistory()
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.java.util.List<Contract.Rule>
getRule()
List of Computable Policy Rule Language Representations of this Contract.CodeableConcept
getScope()
A selector of legal concerns for this Contract definition, derivative, or instance in any legal state.java.util.List<Contract.Signer>
getSigner()
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.java.util.List<Reference>
getSite()
Sites in which the contract is complied with, exercised, or in force.ContractStatus
getStatus()
The status of the resource instance.java.util.List<Reference>
getSubject()
The target entity impacted by or of interest to parties to the agreement.String
getSubtitle()
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.java.util.List<CodeableConcept>
getSubType()
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.java.util.List<Reference>
getSupportingInfo()
Information that may be needed by/relevant to the performer in their execution of this term action.java.util.List<Contract.Term>
getTerm()
One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.String
getTitle()
A short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content.Element
getTopic()
Narrows the range of legal concerns to focus on the achievement of specific contractual objectives.CodeableConcept
getType()
A high-level category for the legal instrument, whether constructed as a Contract definition, derivative, or instance in any legal state.Uri
getUrl()
Canonical identifier for this contract, represented as a URI (globally unique).String
getVersion()
An edition identifier used for business purposes to label business significant variants.boolean
hasChildren()
int
hashCode()
Contract.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getIdentifier
public java.util.List<Identifier> getIdentifier()
Unique identifier for this Contract or a derivative that references a Source Contract.- Returns:
- An unmodifiable list containing immutable objects of type
Identifier
that may be empty.
-
getUrl
public Uri getUrl()
Canonical identifier for this contract, represented as a URI (globally unique).- Returns:
- An immutable object of type
Uri
that may be null.
-
getVersion
public String getVersion()
An edition identifier used for business purposes to label business significant variants.- Returns:
- An immutable object of type
String
that may be null.
-
getStatus
public ContractStatus getStatus()
The status of the resource instance.- Returns:
- An immutable object of type
ContractStatus
that may be null.
-
getLegalState
public CodeableConcept getLegalState()
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.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getInstantiatesCanonical
public Reference getInstantiatesCanonical()
The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract.- Returns:
- An immutable object of type
Reference
that may be null.
-
getInstantiatesUri
public Uri getInstantiatesUri()
The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract.- Returns:
- An immutable object of type
Uri
that may be null.
-
getContentDerivative
public CodeableConcept getContentDerivative()
The minimal content derived from the basal information source at a specific stage in its lifecycle.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getIssued
public DateTime getIssued()
When this Contract was issued.- Returns:
- An immutable object of type
DateTime
that may be null.
-
getApplies
public Period getApplies()
Relevant time or time-period when this Contract is applicable.- Returns:
- An immutable object of type
Period
that may be null.
-
getExpirationType
public CodeableConcept getExpirationType()
Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getSubject
public java.util.List<Reference> getSubject()
The target entity impacted by or of interest to parties to the agreement.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getAuthority
public java.util.List<Reference> getAuthority()
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.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getDomain
public java.util.List<Reference> getDomain()
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.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getSite
public java.util.List<Reference> getSite()
Sites in which the contract is complied with, exercised, or in force.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getName
public String getName()
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.- Returns:
- An immutable object of type
String
that may be null.
-
getTitle
public String getTitle()
A short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content.- Returns:
- An immutable object of type
String
that may be null.
-
getSubtitle
public String getSubtitle()
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.- Returns:
- An immutable object of type
String
that may be null.
-
getAlias
public java.util.List<String> getAlias()
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.- Returns:
- An unmodifiable list containing immutable objects of type
String
that may be empty.
-
getAuthor
public Reference getAuthor()
The individual or organization that authored the Contract definition, derivative, or instance in any legal state.- Returns:
- An immutable object of type
Reference
that may be null.
-
getScope
public CodeableConcept getScope()
A selector of legal concerns for this Contract definition, derivative, or instance in any legal state.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getTopic
public Element getTopic()
Narrows the range of legal concerns to focus on the achievement of specific contractual objectives.- Returns:
- An immutable object of type
CodeableConcept
orReference
that may be null.
-
getType
public CodeableConcept getType()
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.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getSubType
public java.util.List<CodeableConcept> getSubType()
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.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getContentDefinition
public Contract.ContentDefinition getContentDefinition()
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.- Returns:
- An immutable object of type
Contract.ContentDefinition
that may be null.
-
getTerm
public java.util.List<Contract.Term> getTerm()
One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.- Returns:
- An unmodifiable list containing immutable objects of type
Contract.Term
that may be empty.
-
getSupportingInfo
public java.util.List<Reference> getSupportingInfo()
Information that may be needed by/relevant to the performer in their execution of this term action.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getRelevantHistory
public java.util.List<Reference> getRelevantHistory()
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.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getSigner
public java.util.List<Contract.Signer> getSigner()
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.- Returns:
- An unmodifiable list containing immutable objects of type
Contract.Signer
that may be empty.
-
getFriendly
public java.util.List<Contract.Friendly> getFriendly()
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.- Returns:
- An unmodifiable list containing immutable objects of type
Contract.Friendly
that may be empty.
-
getLegal
public java.util.List<Contract.Legal> getLegal()
List of Legal expressions or representations of this Contract.- Returns:
- An unmodifiable list containing immutable objects of type
Contract.Legal
that may be empty.
-
getRule
public java.util.List<Contract.Rule> getRule()
List of Computable Policy Rule Language Representations of this Contract.- Returns:
- An unmodifiable list containing immutable objects of type
Contract.Rule
that may be empty.
-
getLegallyBinding
public Element getLegallyBinding()
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.- Returns:
- An immutable object of type
Attachment
orReference
that may be null.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public Contract.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static Contract.Builder builder()
-
-