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
    A formal agreement between parties regarding the conduct of business, exchange of information or other matters.
    See Also:
    Serialized Form
    • Field Detail

      • applies

        protected Period applies
        Relevant time or time-period when this Contract is applicable.
      • 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.)
      • topic

        protected List<Reference> topic
        The matter of concern in the context of this agreement.
      • topicTarget

        protected List<Resource> topicTarget
        The actual objects that are the target of the reference (The matter of concern in the context of this 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.)
      • type

        protected CodeableConcept type
        Type of Contract such as an insurance policy, real estate contract, a will, power of attorny, Privacy or Security policy , trust framework agreement, etc.
      • subType

        protected List<CodeableConcept> subType
        More specific type or specialization of an overarching or more general contract such as auto insurance, home owner insurance, prenupial agreement, Advanced-Directive, or privacy consent.
      • agent

        protected List<Contract.AgentComponent> agent
        An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
      • 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.
      • 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.
      • binding

        protected Type binding
        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.
      • 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.
      • SP_TOPIC

        public static final String SP_TOPIC
        Search parameter: topic

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

        See Also:
        Constant Field Values
      • TOPIC

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

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

      • INCLUDE_TOPIC

        public static final ca.uhn.fhir.model.api.Include INCLUDE_TOPIC
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Contract:topic".
      • 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_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_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_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_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_TTOPIC

        public static final String SP_TTOPIC
        Search parameter: ttopic

        Description: The identity of the topic of the contract terms
        Type: reference
        Path: Contract.term.topic

        See Also:
        Constant Field Values
      • TTOPIC

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

        Description: The identity of the topic of the contract terms
        Type: reference
        Path: Contract.term.topic

      • INCLUDE_TTOPIC

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

        public static final String SP_AGENT
        Search parameter: agent

        Description: Agent to the Contact
        Type: reference
        Path: Contract.agent.actor

        See Also:
        Constant Field Values
      • AGENT

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

        Description: Agent to the Contact
        Type: reference
        Path: Contract.agent.actor

      • INCLUDE_AGENT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_AGENT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Contract:agent".
      • 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

    • Constructor Detail

      • Contract

        public Contract()
        Constructor
    • Method Detail

      • 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
      • 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.)
      • addSubject

        public Reference addSubject()
        Returns:
        subject (The target entity impacted by or of interest to parties to the agreement.)
      • getSubjectTarget

        public List<ResourcegetSubjectTarget()
        Returns:
        subject (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. The target entity impacted by or of interest to parties to the agreement.)
      • addTopic

        public Reference addTopic()
        Returns:
        topic (The matter of concern in the context of this agreement.)
      • getTopicTarget

        public List<ResourcegetTopicTarget()
        Returns:
        topic (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. The matter of concern in the context of this agreement.)
      • getAuthority

        public List<ReferencegetAuthority()
        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.)
      • addAuthority

        public Reference addAuthority()
        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.)
      • getAuthorityTarget

        public List<OrganizationgetAuthorityTarget()
        Returns:
        authority (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. 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.)
      • addAuthorityTarget

        public Organization addAuthorityTarget()
        Returns:
        authority (Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. 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.)
      • getDomain

        public List<ReferencegetDomain()
        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.)
      • addDomain

        public Reference addDomain()
        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.)
      • getDomainTarget

        public List<LocationgetDomainTarget()
        Returns:
        domain (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. 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.)
      • addDomainTarget

        public Location addDomainTarget()
        Returns:
        domain (Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. 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.)
      • getType

        public CodeableConcept getType()
        Returns:
        type (Type of Contract such as an insurance policy, real estate contract, a will, power of attorny, Privacy or Security policy , trust framework agreement, etc.)
      • hasType

        public boolean hasType()
      • setType

        public Contract setType​(CodeableConcept value)
        Parameters:
        value - type (Type of Contract such as an insurance policy, real estate contract, a will, power of attorny, Privacy or Security policy , trust framework agreement, etc.)
      • getSubType

        public List<CodeableConceptgetSubType()
        Returns:
        subType (More specific type or specialization of an overarching or more general contract such as auto insurance, home owner insurance, prenupial agreement, Advanced-Directive, or privacy consent.)
      • addSubType

        public CodeableConcept addSubType()
        Returns:
        subType (More specific type or specialization of an overarching or more general contract such as auto insurance, home owner insurance, prenupial agreement, Advanced-Directive, or privacy consent.)
      • getAgent

        public List<Contract.AgentComponentgetAgent()
        Returns:
        agent (An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.)
      • addAgent

        public Contract.AgentComponent addAgent()
        Returns:
        agent (An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.)
      • getSigner

        public List<Contract.SignatoryComponentgetSigner()
        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.)
      • addSigner

        public Contract.SignatoryComponent addSigner()
        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.)
      • hasTerm

        public boolean hasTerm()
      • addTerm

        public Contract.TermComponent addTerm()
        Returns:
        term (One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.)
      • getBinding

        public Type getBinding()
        Returns:
        binding (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.)
      • getBindingAttachment

        public Attachment getBindingAttachment()
                                        throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        binding (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
      • getBindingReference

        public Reference getBindingReference()
                                      throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        binding (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
      • setBinding

        public Contract setBinding​(Type value)
        Parameters:
        value - binding (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.)
      • getFriendly

        public List<Contract.FriendlyLanguageComponentgetFriendly()
        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.)
      • addFriendly

        public Contract.FriendlyLanguageComponent addFriendly()
        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.)
      • hasRule

        public boolean hasRule()
      • 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
      • makeProperty

        public Base makeProperty​(int hash,
                                 String name)
                          throws org.hl7.fhir.exceptions.FHIRException
        Description copied from class: Base
        make an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property
        Overrides:
        makeProperty in class DomainResource
        Returns:
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • isEmpty

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