Package com.ibm.fhir.model.resource

Class Contract.Builder

    • Method Detail

      • id

        public Contract.Builder id​(String id)
        The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
        Overrides:
        id in class DomainResource.Builder
        Parameters:
        id - Logical id of this artifact
        Returns:
        A reference to this Builder instance

      • meta

        public Contract.Builder meta​(Meta meta)
        The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
        Overrides:
        meta in class DomainResource.Builder
        Parameters:
        meta - Metadata about the resource
        Returns:
        A reference to this Builder instance

      • implicitRules

        public Contract.Builder implicitRules​(Uri implicitRules)
        A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
        Overrides:
        implicitRules in class DomainResource.Builder
        Parameters:
        implicitRules - A set of rules under which this content was created
        Returns:
        A reference to this Builder instance

      • language

        public Contract.Builder language​(Code language)
        The base language in which the resource is written.
        Overrides:
        language in class DomainResource.Builder
        Parameters:
        language - Language of the resource content
        Returns:
        A reference to this Builder instance

      • text

        public Contract.Builder text​(Narrative text)
        A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
        Overrides:
        text in class DomainResource.Builder
        Parameters:
        text - Text summary of the resource, for human interpretation
        Returns:
        A reference to this Builder instance

      • contained

        public Contract.Builder contained​(Resource... contained)
        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

        Adds new element(s) to the existing list

        Overrides:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance

      • contained

        public Contract.Builder contained​(Collection<Resource> contained)
        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

        Replaces the existing list with a new one containing elements from the Collection

        Overrides:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance

      • extension

        public Contract.Builder extension​(Extension... extension)
        May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        Adds new element(s) to the existing list

        Overrides:
        extension in class DomainResource.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • extension

        public Contract.Builder extension​(Collection<Extension> extension)
        May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        Replaces the existing list with a new one containing elements from the Collection

        Overrides:
        extension in class DomainResource.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public Contract.Builder modifierExtension​(Extension... modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        Adds new element(s) to the existing list

        Overrides:
        modifierExtension in class DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public Contract.Builder modifierExtension​(Collection<Extension> modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        Replaces the existing list with a new one containing elements from the Collection

        Overrides:
        modifierExtension in class DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance

      • identifier

        public Contract.Builder identifier​(Identifier... identifier)
        Unique identifier for this Contract or a derivative that references a Source Contract.

        Adds new element(s) to the existing list

        Parameters:
        identifier - Contract number
        Returns:
        A reference to this Builder instance

      • identifier

        public Contract.Builder identifier​(Collection<Identifier> identifier)
        Unique identifier for this Contract or a derivative that references a Source Contract.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        identifier - Contract number
        Returns:
        A reference to this Builder instance

      • url

        public Contract.Builder url​(Uri url)
        Canonical identifier for this contract, represented as a URI (globally unique).
        Parameters:
        url - Basal definition
        Returns:
        A reference to this Builder instance

      • version

        public Contract.Builder version​(String version)
        An edition identifier used for business purposes to label business significant variants.
        Parameters:
        version - Business edition
        Returns:
        A reference to this Builder instance

      • status

        public Contract.Builder status​(ContractStatus status)
        The status of the resource instance.
        Parameters:
        status - amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated
        Returns:
        A reference to this Builder instance

      • legalState

        public Contract.Builder legalState​(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.
        Parameters:
        legalState - Negotiation status
        Returns:
        A reference to this Builder instance

      • instantiatesCanonical

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

        Allowed resource types for this reference:

        Parameters:
        instantiatesCanonical - Source Contract Definition
        Returns:
        A reference to this Builder instance

      • instantiatesUri

        public Contract.Builder instantiatesUri​(Uri instantiatesUri)
        The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract.
        Parameters:
        instantiatesUri - External Contract Definition
        Returns:
        A reference to this Builder instance

      • contentDerivative

        public Contract.Builder contentDerivative​(CodeableConcept contentDerivative)
        The minimal content derived from the basal information source at a specific stage in its lifecycle.
        Parameters:
        contentDerivative - Content derived from the basal information
        Returns:
        A reference to this Builder instance

      • issued

        public Contract.Builder issued​(DateTime issued)
        When this Contract was issued.
        Parameters:
        issued - When this Contract was issued
        Returns:
        A reference to this Builder instance

      • applies

        public Contract.Builder applies​(Period applies)
        Relevant time or time-period when this Contract is applicable.
        Parameters:
        applies - Effective time
        Returns:
        A reference to this Builder instance

      • expirationType

        public Contract.Builder expirationType​(CodeableConcept expirationType)
        Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract.
        Parameters:
        expirationType - Contract cessation cause
        Returns:
        A reference to this Builder instance

      • subject

        public Contract.Builder subject​(Reference... subject)
        The target entity impacted by or of interest to parties to the agreement.

        Adds new element(s) to the existing list

        Parameters:
        subject - Contract Target Entity
        Returns:
        A reference to this Builder instance

      • subject

        public Contract.Builder subject​(Collection<Reference> subject)
        The target entity impacted by or of interest to parties to the agreement.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        subject - Contract Target Entity
        Returns:
        A reference to this Builder instance

      • authority

        public Contract.Builder authority​(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.

        Adds new element(s) to the existing list

        Parameters:
        authority - Authority under which this Contract has standing
        Returns:
        A reference to this Builder instance

      • authority

        public Contract.Builder authority​(Collection<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.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        authority - Authority under which this Contract has standing
        Returns:
        A reference to this Builder instance

      • domain

        public Contract.Builder domain​(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.

        Adds new element(s) to the existing list

        Parameters:
        domain - A sphere of control governed by an authoritative jurisdiction, organization, or person
        Returns:
        A reference to this Builder instance

      • domain

        public Contract.Builder domain​(Collection<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.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        domain - A sphere of control governed by an authoritative jurisdiction, organization, or person
        Returns:
        A reference to this Builder instance

      • site

        public Contract.Builder site​(Reference... site)
        Sites in which the contract is complied with, exercised, or in force.

        Adds new element(s) to the existing list

        Parameters:
        site - Specific Location
        Returns:
        A reference to this Builder instance

      • site

        public Contract.Builder site​(Collection<Reference> site)
        Sites in which the contract is complied with, exercised, or in force.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        site - Specific Location
        Returns:
        A reference to this Builder instance

      • name

        public Contract.Builder name​(String 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.
        Parameters:
        name - Computer friendly designation
        Returns:
        A reference to this Builder instance

      • title

        public Contract.Builder title​(String 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.
        Parameters:
        title - Human Friendly name
        Returns:
        A reference to this Builder instance

      • subtitle

        public Contract.Builder subtitle​(String 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.
        Parameters:
        subtitle - Subordinate Friendly name
        Returns:
        A reference to this Builder instance

      • alias

        public Contract.Builder alias​(String... 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.

        Adds new element(s) to the existing list

        Parameters:
        alias - Acronym or short name
        Returns:
        A reference to this Builder instance

      • alias

        public Contract.Builder alias​(Collection<String> 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.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        alias - Acronym or short name
        Returns:
        A reference to this Builder instance

      • scope

        public Contract.Builder scope​(CodeableConcept scope)
        A selector of legal concerns for this Contract definition, derivative, or instance in any legal state.
        Parameters:
        scope - Range of Legal Concerns
        Returns:
        A reference to this Builder instance

      • topic

        public Contract.Builder topic​(Element topic)
        Narrows the range of legal concerns to focus on the achievement of specific contractual objectives.

        This is a choice element with the following allowed types:

        Parameters:
        topic - Focus of contract interest
        Returns:
        A reference to this Builder instance

      • type

        public Contract.Builder type​(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.
        Parameters:
        type - Legal instrument category
        Returns:
        A reference to this Builder instance

      • subType

        public Contract.Builder subType​(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.

        Adds new element(s) to the existing list

        Parameters:
        subType - Subtype within the context of type
        Returns:
        A reference to this Builder instance

      • subType

        public Contract.Builder subType​(Collection<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.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        subType - Subtype within the context of type
        Returns:
        A reference to this Builder instance

      • contentDefinition

        public Contract.Builder contentDefinition​(Contract.ContentDefinition 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.
        Parameters:
        contentDefinition - Contract precursor content
        Returns:
        A reference to this Builder instance

      • term

        public Contract.Builder term​(Contract.Term... term)
        One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.

        Adds new element(s) to the existing list

        Parameters:
        term - Contract Term List
        Returns:
        A reference to this Builder instance

      • term

        public Contract.Builder term​(Collection<Contract.Term> term)
        One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        term - Contract Term List
        Returns:
        A reference to this Builder instance

      • supportingInfo

        public Contract.Builder supportingInfo​(Reference... supportingInfo)
        Information that may be needed by/relevant to the performer in their execution of this term action.

        Adds new element(s) to the existing list

        Parameters:
        supportingInfo - Extra Information
        Returns:
        A reference to this Builder instance

      • supportingInfo

        public Contract.Builder supportingInfo​(Collection<Reference> supportingInfo)
        Information that may be needed by/relevant to the performer in their execution of this term action.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        supportingInfo - Extra Information
        Returns:
        A reference to this Builder instance

      • relevantHistory

        public Contract.Builder relevantHistory​(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.

        Adds new element(s) to the existing list

        Parameters:
        relevantHistory - Key event in Contract History
        Returns:
        A reference to this Builder instance

      • relevantHistory

        public Contract.Builder relevantHistory​(Collection<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.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        relevantHistory - Key event in Contract History
        Returns:
        A reference to this Builder instance

      • signer

        public Contract.Builder signer​(Contract.Signer... 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.

        Adds new element(s) to the existing list

        Parameters:
        signer - Contract Signatory
        Returns:
        A reference to this Builder instance

      • signer

        public Contract.Builder signer​(Collection<Contract.Signer> 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.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        signer - Contract Signatory
        Returns:
        A reference to this Builder instance

      • friendly

        public Contract.Builder friendly​(Contract.Friendly... 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.

        Adds new element(s) to the existing list

        Parameters:
        friendly - Contract Friendly Language
        Returns:
        A reference to this Builder instance

      • friendly

        public Contract.Builder friendly​(Collection<Contract.Friendly> 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.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        friendly - Contract Friendly Language
        Returns:
        A reference to this Builder instance

      • legal

        public Contract.Builder legal​(Contract.Legal... legal)
        List of Legal expressions or representations of this Contract.

        Adds new element(s) to the existing list

        Parameters:
        legal - Contract Legal Language
        Returns:
        A reference to this Builder instance

      • legal

        public Contract.Builder legal​(Collection<Contract.Legal> legal)
        List of Legal expressions or representations of this Contract.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        legal - Contract Legal Language
        Returns:
        A reference to this Builder instance

      • rule

        public Contract.Builder rule​(Contract.Rule... rule)
        List of Computable Policy Rule Language Representations of this Contract.

        Adds new element(s) to the existing list

        Parameters:
        rule - Computable Contract Language
        Returns:
        A reference to this Builder instance

      • rule

        public Contract.Builder rule​(Collection<Contract.Rule> rule)
        List of Computable Policy Rule Language Representations of this Contract.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        rule - Computable Contract Language
        Returns:
        A reference to this Builder instance

      • legallyBinding

        public Contract.Builder legallyBinding​(Element 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.

        This is a choice element with the following allowed types:

        Parameters:
        legallyBinding - Binding Contract
        Returns:
        A reference to this Builder instance