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

    public class Contract
    extends DomainResource
    Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
    See Also:
    Serialized Form
    • Field Detail

      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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 Detail

      • Contract

        public Contract()
        Constructor