Package org.hl7.fhir.r4.model

Class Contract

java.lang.Object
org.hl7.fhir.r4.model.Base
org.hl7.fhir.r4.model.BaseResource
org.hl7.fhir.r4.model.Resource
org.hl7.fhir.r4.model.DomainResource
org.hl7.fhir.r4.model.Contract
All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource
public class Contract extends DomainResource
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
See Also:
Serialized Form

  • Field Details

    • identifier

      protected List<Identifier> identifier
      Unique identifier for this Contract or a derivative that references a Source Contract.

    • url

      protected UriType url
      Canonical identifier for this contract, represented as a URI (globally unique).

    • version

      protected StringType version
      An edition identifier used for business purposes to label business significant variants.

    • status

      protected Enumeration<Contract.ContractStatus> status
      The status of the resource instance.

    • legalState

      protected CodeableConcept 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

      protected Reference instantiatesCanonical
      The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract.

    • instantiatesCanonicalTarget

      protected 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

      protected UriType instantiatesUri
      The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract.

    • contentDerivative

      protected CodeableConcept contentDerivative
      The minimal content derived from the basal information source at a specific stage in its lifecycle.

    • issued

      protected DateTimeType issued
      When this Contract was issued.

    • applies

      protected Period applies
      Relevant time or time-period when this Contract is applicable.

    • expirationType

      protected CodeableConcept expirationType
      Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract.

    • subject

      protected List<Reference> subject
      The target entity impacted by or of interest to parties to the agreement.

    • subjectTarget

      protected List<Resource> 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

      protected List<Reference> authority
      A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies.

    • authorityTarget

      protected List<Organization> authorityTarget
      The actual objects that are the target of the reference (A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies.)

    • domain

      protected List<Reference> domain
      Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.

    • domainTarget

      protected List<Location> domainTarget
      The actual objects that are the target of the reference (Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.)

    • site

      protected List<Reference> site
      Sites in which the contract is complied with, exercised, or in force.

    • siteTarget

      protected List<Location> siteTarget
      The actual objects that are the target of the reference (Sites in which the contract is complied with, exercised, or in force.)

    • name

      protected StringType 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

      protected StringType 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

      protected StringType 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

      protected List<StringType> 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

      protected Reference author
      The individual or organization that authored the Contract definition, derivative, or instance in any legal state.

    • authorTarget

      protected Resource 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

      protected CodeableConcept scope
      A selector of legal concerns for this Contract definition, derivative, or instance in any legal state.

    • topic

      protected Type topic
      Narrows the range of legal concerns to focus on the achievement of specific contractual objectives.

    • type

      protected CodeableConcept 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

      protected List<CodeableConcept> 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

      protected Contract.ContentDefinitionComponent 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

      protected List<Contract.TermComponent> term
      One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.

    • supportingInfo

      protected List<Reference> supportingInfo
      Information that may be needed by/relevant to the performer in their execution of this term action.

    • supportingInfoTarget

      protected List<Resource> 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

      protected List<Reference> 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

      protected List<Provenance> 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

      protected List<Contract.SignatoryComponent> 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

      protected List<Contract.FriendlyLanguageComponent> friendly
      The "patient friendly language" versionof the Contract in whole or in parts. "Patient friendly language" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.

    • rule

      protected List<Contract.ComputableLanguageComponent> rule
      List of Computable Policy Rule Language Representations of this Contract.

    • legallyBinding

      protected Type 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

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: The identity of the contract
      Type: token
      Path: Contract.identifier

      See Also:
      Constant Field Values

    • IDENTIFIER

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
      Fluent Client search parameter constant for identifier

      Description: The identity of the contract
      Type: token
      Path: Contract.identifier

    • SP_INSTANTIATES

      public static final String SP_INSTANTIATES
      Search parameter: instantiates

      Description: A source definition of the contract
      Type: uri
      Path: Contract.instantiatesUri

      See Also:
      Constant Field Values

    • INSTANTIATES

      public static final ca.uhn.fhir.rest.gclient.UriClientParam INSTANTIATES
      Fluent Client search parameter constant for instantiates

      Description: A source definition of the contract
      Type: uri
      Path: Contract.instantiatesUri

    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter: patient

      Description: The identity of the subject of the contract (if a patient)
      Type: reference
      Path: Contract.subject

      See Also:
      Constant Field Values

    • PATIENT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
      Fluent Client search parameter constant for patient

      Description: The identity of the subject of the contract (if a patient)
      Type: reference
      Path: Contract.subject

    • INCLUDE_PATIENT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Contract:patient".

    • SP_SUBJECT

      public static final String SP_SUBJECT
      Search parameter: subject

      Description: The identity of the subject of the contract
      Type: reference
      Path: Contract.subject

      See Also:
      Constant Field Values

    • SUBJECT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
      Fluent Client search parameter constant for subject

      Description: The identity of the subject of the contract
      Type: reference
      Path: Contract.subject

    • INCLUDE_SUBJECT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Contract:subject".

    • SP_AUTHORITY

      public static final String SP_AUTHORITY
      Search parameter: authority

      Description: The authority of the contract
      Type: reference
      Path: Contract.authority

      See Also:
      Constant Field Values

    • AUTHORITY

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam AUTHORITY
      Fluent Client search parameter constant for authority

      Description: The authority of the contract
      Type: reference
      Path: Contract.authority

    • INCLUDE_AUTHORITY

      public static final ca.uhn.fhir.model.api.Include INCLUDE_AUTHORITY
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Contract:authority".

    • SP_DOMAIN

      public static final String SP_DOMAIN
      Search parameter: domain

      Description: The domain of the contract
      Type: reference
      Path: Contract.domain

      See Also:
      Constant Field Values

    • DOMAIN

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DOMAIN
      Fluent Client search parameter constant for domain

      Description: The domain of the contract
      Type: reference
      Path: Contract.domain

    • INCLUDE_DOMAIN

      public static final ca.uhn.fhir.model.api.Include INCLUDE_DOMAIN
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Contract:domain".

    • SP_ISSUED

      public static final String SP_ISSUED
      Search parameter: issued

      Description: The date/time the contract was issued
      Type: date
      Path: Contract.issued

      See Also:
      Constant Field Values

    • ISSUED

      public static final ca.uhn.fhir.rest.gclient.DateClientParam ISSUED
      Fluent Client search parameter constant for issued

      Description: The date/time the contract was issued
      Type: date
      Path: Contract.issued

    • SP_URL

      public static final String SP_URL
      Search parameter: url

      Description: The basal contract definition
      Type: uri
      Path: Contract.url

      See Also:
      Constant Field Values

    • URL

      public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
      Fluent Client search parameter constant for url

      Description: The basal contract definition
      Type: uri
      Path: Contract.url

    • SP_SIGNER

      public static final String SP_SIGNER
      Search parameter: signer

      Description: Contract Signatory Party
      Type: reference
      Path: Contract.signer.party

      See Also:
      Constant Field Values

    • SIGNER

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SIGNER
      Fluent Client search parameter constant for signer

      Description: Contract Signatory Party
      Type: reference
      Path: Contract.signer.party

    • INCLUDE_SIGNER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_SIGNER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Contract:signer".

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: The status of the contract
      Type: token
      Path: Contract.status

      See Also:
      Constant Field Values

    • STATUS

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
      Fluent Client search parameter constant for status

      Description: The status of the contract
      Type: token
      Path: Contract.status

  • Constructor Details

    • Contract

      public Contract()
      Constructor

  • Method Details

    • getIdentifier

      public List<Identifier> getIdentifier()
      Returns:
      identifier (Unique identifier for this Contract or a derivative that references a Source Contract.)

    • setIdentifier

      public Contract setIdentifier​(List<Identifier> theIdentifier)
      Returns:
      Returns a reference to this for easy method chaining

    • hasIdentifier

      public boolean hasIdentifier()

    • addIdentifier

      public Identifier addIdentifier()

    • addIdentifier

      public Contract addIdentifier​(Identifier t)

    • getIdentifierFirstRep

      public Identifier getIdentifierFirstRep()
      Returns:
      The first repetition of repeating field identifier, creating it if it does not already exist

    • getUrlElement

      public UriType 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

      public boolean hasUrlElement()

    • hasUrl

      public boolean hasUrl()

    • setUrlElement

      public Contract setUrlElement​(UriType value)
      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

      public String getUrl()
      Returns:
      Canonical identifier for this contract, represented as a URI (globally unique).

    • setUrl

      public Contract setUrl​(String value)
      Parameters:
      value - Canonical identifier for this contract, represented as a URI (globally unique).

    • getVersionElement

      public StringType 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

      public boolean hasVersionElement()

    • hasVersion

      public boolean hasVersion()

    • setVersionElement

      public Contract setVersionElement​(StringType value)
      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

      public String getVersion()
      Returns:
      An edition identifier used for business purposes to label business significant variants.

    • setVersion

      public Contract setVersion​(String value)
      Parameters:
      value - An edition identifier used for business purposes to label business significant variants.

    • getStatusElement

      public Enumeration<Contract.ContractStatus> 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

      public boolean hasStatusElement()

    • hasStatus

      public boolean hasStatus()

    • setStatusElement

      public Contract setStatusElement​(Enumeration<Contract.ContractStatus> value)
      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

      public Contract.ContractStatus getStatus()
      Returns:
      The status of the resource instance.

    • setStatus

      public Contract setStatus​(Contract.ContractStatus value)
      Parameters:
      value - The status of the resource instance.

    • getLegalState

      public CodeableConcept 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

      public boolean hasLegalState()

    • setLegalState

      public Contract setLegalState​(CodeableConcept value)
      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

      public Reference getInstantiatesCanonical()
      Returns:
      instantiatesCanonical (The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract.)

    • hasInstantiatesCanonical

      public boolean hasInstantiatesCanonical()

    • setInstantiatesCanonical

      public Contract setInstantiatesCanonical​(Reference value)
      Parameters:
      value - instantiatesCanonical (The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract.)

    • getInstantiatesCanonicalTarget

      public 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

      public Contract setInstantiatesCanonicalTarget​(Contract value)
      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

      public UriType 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

      public boolean hasInstantiatesUriElement()

    • hasInstantiatesUri

      public boolean hasInstantiatesUri()

    • setInstantiatesUriElement

      public Contract setInstantiatesUriElement​(UriType value)
      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

      public String getInstantiatesUri()
      Returns:
      The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract.

    • setInstantiatesUri

      public Contract setInstantiatesUri​(String value)
      Parameters:
      value - The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract.

    • getContentDerivative

      public CodeableConcept getContentDerivative()
      Returns:
      contentDerivative (The minimal content derived from the basal information source at a specific stage in its lifecycle.)

    • hasContentDerivative

      public boolean hasContentDerivative()

    • setContentDerivative

      public Contract setContentDerivative​(CodeableConcept value)
      Parameters:
      value - contentDerivative (The minimal content derived from the basal information source at a specific stage in its lifecycle.)

    • getIssuedElement

      public DateTimeType getIssuedElement()
      Returns:
      issued (When this Contract was issued.). This is the underlying object with id, value and extensions. The accessor "getIssued" gives direct access to the value

    • hasIssuedElement

      public boolean hasIssuedElement()

    • hasIssued

      public boolean hasIssued()

    • setIssuedElement

      public Contract setIssuedElement​(DateTimeType value)
      Parameters:
      value - issued (When this Contract was issued.). This is the underlying object with id, value and extensions. The accessor "getIssued" gives direct access to the value

    • getIssued

      public Date getIssued()
      Returns:
      When this Contract was issued.

    • setIssued

      public Contract setIssued​(Date value)
      Parameters:
      value - When this Contract was issued.

    • getApplies

      public Period getApplies()
      Returns:
      applies (Relevant time or time-period when this Contract is applicable.)

    • hasApplies

      public boolean hasApplies()

    • setApplies

      public Contract setApplies​(Period value)
      Parameters:
      value - applies (Relevant time or time-period when this Contract is applicable.)

    • getExpirationType

      public CodeableConcept getExpirationType()
      Returns:
      expirationType (Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract.)

    • hasExpirationType

      public boolean hasExpirationType()

    • setExpirationType

      public Contract setExpirationType​(CodeableConcept value)
      Parameters:
      value - expirationType (Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract.)

    • getSubject

      public List<Reference> getSubject()
      Returns:
      subject (The target entity impacted by or of interest to parties to the agreement.)

    • setSubject

      public Contract setSubject​(List<Reference> theSubject)
      Returns:
      Returns a reference to this for easy method chaining

    • hasSubject

      public boolean hasSubject()

    • addSubject

      public Reference addSubject()

    • addSubject

      public Contract addSubject​(Reference t)

    • getSubjectFirstRep

      public Reference getSubjectFirstRep()
      Returns:
      The first repetition of repeating field subject, creating it if it does not already exist

    • getSubjectTarget

      @Deprecated public List<Resource> getSubjectTarget()
      Deprecated.
      Use Reference#setResource(IBaseResource) instead

    • getAuthority

      public List<Reference> getAuthority()
      Returns:
      authority (A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies.)

    • setAuthority

      public Contract setAuthority​(List<Reference> theAuthority)
      Returns:
      Returns a reference to this for easy method chaining

    • hasAuthority

      public boolean hasAuthority()

    • addAuthority

      public Reference addAuthority()

    • addAuthority

      public Contract addAuthority​(Reference t)

    • getAuthorityFirstRep

      public Reference getAuthorityFirstRep()
      Returns:
      The first repetition of repeating field authority, creating it if it does not already exist

    • getAuthorityTarget

      @Deprecated public List<Organization> getAuthorityTarget()
      Deprecated.
      Use Reference#setResource(IBaseResource) instead

    • addAuthorityTarget

      @Deprecated public Organization addAuthorityTarget()
      Deprecated.
      Use Reference#setResource(IBaseResource) instead

    • getDomain

      public List<Reference> getDomain()
      Returns:
      domain (Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.)

    • setDomain

      public Contract setDomain​(List<Reference> theDomain)
      Returns:
      Returns a reference to this for easy method chaining

    • hasDomain

      public boolean hasDomain()

    • addDomain

      public Reference addDomain()

    • addDomain

      public Contract addDomain​(Reference t)

    • getDomainFirstRep

      public Reference getDomainFirstRep()
      Returns:
      The first repetition of repeating field domain, creating it if it does not already exist

    • getDomainTarget

      @Deprecated public List<Location> getDomainTarget()
      Deprecated.
      Use Reference#setResource(IBaseResource) instead

    • addDomainTarget

      @Deprecated public Location addDomainTarget()
      Deprecated.
      Use Reference#setResource(IBaseResource) instead

    • getSite

      public List<Reference> getSite()
      Returns:
      site (Sites in which the contract is complied with, exercised, or in force.)

    • setSite

      public Contract setSite​(List<Reference> theSite)
      Returns:
      Returns a reference to this for easy method chaining

    • hasSite

      public boolean hasSite()

    • addSite

      public Reference addSite()

    • addSite

      public Contract addSite​(Reference t)

    • getSiteFirstRep

      public Reference getSiteFirstRep()
      Returns:
      The first repetition of repeating field site, creating it if it does not already exist

    • getSiteTarget

      @Deprecated public List<Location> getSiteTarget()
      Deprecated.
      Use Reference#setResource(IBaseResource) instead

    • addSiteTarget

      @Deprecated public Location addSiteTarget()
      Deprecated.
      Use Reference#setResource(IBaseResource) instead

    • getNameElement

      public StringType 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

      public boolean hasNameElement()

    • hasName

      public boolean hasName()

    • setNameElement

      public Contract setNameElement​(StringType value)
      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

      public String 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

      public Contract setName​(String value)
      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

      public StringType 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

      public boolean hasTitleElement()

    • hasTitle

      public boolean hasTitle()

    • setTitleElement

      public Contract setTitleElement​(StringType value)
      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

      public String 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

      public Contract setTitle​(String value)
      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

      public StringType 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

      public boolean hasSubtitleElement()

    • hasSubtitle

      public boolean hasSubtitle()

    • setSubtitleElement

      public Contract setSubtitleElement​(StringType value)
      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

      public String 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

      public Contract setSubtitle​(String value)
      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

      public List<StringType> 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

      public Contract setAlias​(List<StringType> theAlias)
      Returns:
      Returns a reference to this for easy method chaining

    • hasAlias

      public boolean hasAlias()

    • addAliasElement

      public StringType 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

      public Contract addAlias​(String value)
      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

      public boolean hasAlias​(String value)
      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

      public Reference getAuthor()
      Returns:
      author (The individual or organization that authored the Contract definition, derivative, or instance in any legal state.)

    • hasAuthor

      public boolean hasAuthor()

    • setAuthor

      public Contract setAuthor​(Reference value)
      Parameters:
      value - author (The individual or organization that authored the Contract definition, derivative, or instance in any legal state.)

    • getAuthorTarget

      public Resource 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

      public Contract setAuthorTarget​(Resource value)
      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

      public CodeableConcept getScope()
      Returns:
      scope (A selector of legal concerns for this Contract definition, derivative, or instance in any legal state.)

    • hasScope

      public boolean hasScope()

    • setScope

      public Contract setScope​(CodeableConcept value)
      Parameters:
      value - scope (A selector of legal concerns for this Contract definition, derivative, or instance in any legal state.)

    • getTopic

      public Type getTopic()
      Returns:
      topic (Narrows the range of legal concerns to focus on the achievement of specific contractual objectives.)

    • getTopicCodeableConcept

      public CodeableConcept getTopicCodeableConcept() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      topic (Narrows the range of legal concerns to focus on the achievement of specific contractual objectives.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasTopicCodeableConcept

      public boolean hasTopicCodeableConcept()

    • getTopicReference

      public Reference getTopicReference() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      topic (Narrows the range of legal concerns to focus on the achievement of specific contractual objectives.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasTopicReference

      public boolean hasTopicReference()

    • hasTopic

      public boolean hasTopic()

    • setTopic

      public Contract setTopic​(Type value)
      Parameters:
      value - topic (Narrows the range of legal concerns to focus on the achievement of specific contractual objectives.)

    • getType

      public CodeableConcept 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

      public boolean hasType()

    • setType

      public Contract setType​(CodeableConcept value)
      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

      public List<CodeableConcept> 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

      public Contract setSubType​(List<CodeableConcept> theSubType)
      Returns:
      Returns a reference to this for easy method chaining

    • hasSubType

      public boolean hasSubType()

    • addSubType

      public CodeableConcept addSubType()

    • addSubType

      public Contract addSubType​(CodeableConcept t)

    • getSubTypeFirstRep

      public CodeableConcept getSubTypeFirstRep()
      Returns:
      The first repetition of repeating field subType, creating it if it does not already exist

    • getContentDefinition

      public Contract.ContentDefinitionComponent 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

      public boolean hasContentDefinition()

    • setContentDefinition

      public Contract setContentDefinition​(Contract.ContentDefinitionComponent value)
      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

      public List<Contract.TermComponent> getTerm()
      Returns:
      term (One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.)

    • setTerm

      public Contract setTerm​(List<Contract.TermComponent> theTerm)
      Returns:
      Returns a reference to this for easy method chaining

    • hasTerm

      public boolean hasTerm()

    • addTerm

      public Contract.TermComponent addTerm()

    • addTerm

      public Contract addTerm​(Contract.TermComponent t)

    • getTermFirstRep

      public Contract.TermComponent getTermFirstRep()
      Returns:
      The first repetition of repeating field term, creating it if it does not already exist

    • getSupportingInfo

      public List<Reference> getSupportingInfo()
      Returns:
      supportingInfo (Information that may be needed by/relevant to the performer in their execution of this term action.)

    • setSupportingInfo

      public Contract setSupportingInfo​(List<Reference> theSupportingInfo)
      Returns:
      Returns a reference to this for easy method chaining

    • hasSupportingInfo

      public boolean hasSupportingInfo()

    • addSupportingInfo

      public Reference addSupportingInfo()

    • addSupportingInfo

      public Contract addSupportingInfo​(Reference t)

    • getSupportingInfoFirstRep

      public Reference getSupportingInfoFirstRep()
      Returns:
      The first repetition of repeating field supportingInfo, creating it if it does not already exist

    • getSupportingInfoTarget

      @Deprecated public List<Resource> getSupportingInfoTarget()
      Deprecated.
      Use Reference#setResource(IBaseResource) instead

    • getRelevantHistory

      public List<Reference> 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

      public Contract setRelevantHistory​(List<Reference> theRelevantHistory)
      Returns:
      Returns a reference to this for easy method chaining

    • hasRelevantHistory

      public boolean hasRelevantHistory()

    • addRelevantHistory

      public Reference addRelevantHistory()

    • addRelevantHistory

      public Contract addRelevantHistory​(Reference t)

    • getRelevantHistoryFirstRep

      public Reference getRelevantHistoryFirstRep()
      Returns:
      The first repetition of repeating field relevantHistory, creating it if it does not already exist

    • getRelevantHistoryTarget

      @Deprecated public List<Provenance> getRelevantHistoryTarget()
      Deprecated.
      Use Reference#setResource(IBaseResource) instead

    • addRelevantHistoryTarget

      @Deprecated public Provenance addRelevantHistoryTarget()
      Deprecated.
      Use Reference#setResource(IBaseResource) instead

    • getSigner

      public List<Contract.SignatoryComponent> 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

      public Contract setSigner​(List<Contract.SignatoryComponent> theSigner)
      Returns:
      Returns a reference to this for easy method chaining

    • hasSigner

      public boolean hasSigner()

    • addSigner

      public Contract.SignatoryComponent addSigner()

    • addSigner

      public Contract addSigner​(Contract.SignatoryComponent t)

    • getSignerFirstRep

      public Contract.SignatoryComponent getSignerFirstRep()
      Returns:
      The first repetition of repeating field signer, creating it if it does not already exist

    • getFriendly

      public List<Contract.FriendlyLanguageComponent> getFriendly()
      Returns:
      friendly (The "patient friendly language" versionof the Contract in whole or in parts. "Patient friendly language" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.)

    • setFriendly

      public Contract setFriendly​(List<Contract.FriendlyLanguageComponent> theFriendly)
      Returns:
      Returns a reference to this for easy method chaining

    • hasFriendly

      public boolean hasFriendly()

    • addFriendly

      public Contract.FriendlyLanguageComponent addFriendly()

    • addFriendly

      public Contract addFriendly​(Contract.FriendlyLanguageComponent t)

    • getFriendlyFirstRep

      public Contract.FriendlyLanguageComponent getFriendlyFirstRep()
      Returns:
      The first repetition of repeating field friendly, creating it if it does not already exist

    • getLegal

      public List<Contract.LegalLanguageComponent> getLegal()
      Returns:
      legal (List of Legal expressions or representations of this Contract.)

    • setLegal

      public Contract setLegal​(List<Contract.LegalLanguageComponent> theLegal)
      Returns:
      Returns a reference to this for easy method chaining

    • hasLegal

      public boolean hasLegal()

    • addLegal

      public Contract.LegalLanguageComponent addLegal()

    • addLegal

      public Contract addLegal​(Contract.LegalLanguageComponent t)

    • getLegalFirstRep

      public Contract.LegalLanguageComponent getLegalFirstRep()
      Returns:
      The first repetition of repeating field legal, creating it if it does not already exist

    • getRule

      public List<Contract.ComputableLanguageComponent> getRule()
      Returns:
      rule (List of Computable Policy Rule Language Representations of this Contract.)

    • setRule

      public Contract setRule​(List<Contract.ComputableLanguageComponent> theRule)
      Returns:
      Returns a reference to this for easy method chaining

    • hasRule

      public boolean hasRule()

    • addRule

      public Contract.ComputableLanguageComponent addRule()

    • addRule

      public Contract addRule​(Contract.ComputableLanguageComponent t)

    • getRuleFirstRep

      public Contract.ComputableLanguageComponent getRuleFirstRep()
      Returns:
      The first repetition of repeating field rule, creating it if it does not already exist

    • getLegallyBinding

      public Type 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

      public Attachment getLegallyBindingAttachment() throws org.hl7.fhir.exceptions.FHIRException
      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

      public boolean hasLegallyBindingAttachment()

    • getLegallyBindingReference

      public Reference getLegallyBindingReference() throws org.hl7.fhir.exceptions.FHIRException
      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

      public boolean hasLegallyBindingReference()

    • hasLegallyBinding

      public boolean hasLegallyBinding()

    • setLegallyBinding

      public Contract setLegallyBinding​(Type value)
      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

      protected void listChildren​(List<Property> children)
      Overrides:
      listChildren in class DomainResource

    • getNamedProperty

      public Property getNamedProperty​(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getNamedProperty in class DomainResource
      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 class DomainResource
      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 class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setProperty

      public Base setProperty​(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • makeProperty

      public Base makeProperty​(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      makeProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getTypesForProperty

      public String[] getTypesForProperty​(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getTypesForProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addChild

      public Base addChild​(String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      addChild in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • fhirType

      public String fhirType()
      Specified by:
      fhirType in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      fhirType in class DomainResource

    • copy

      public Contract copy()
      Specified by:
      copy in class DomainResource

    • copyValues

      public void copyValues​(Contract dst)

    • typedCopy

      protected Contract typedCopy()

    • equalsDeep

      public boolean equalsDeep​(Base other_)
      Overrides:
      equalsDeep in class DomainResource

    • equalsShallow

      public boolean equalsShallow​(Base other_)
      Overrides:
      equalsShallow in class DomainResource

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      isEmpty in class DomainResource

    • getResourceType

      public ResourceType getResourceType()
      Specified by:
      getResourceType in class Resource