Struct ContractBuilder

pub struct ContractBuilder { /* private fields */ }

Builder for ContractInner.

Implementations

impl ContractBuilder

pub fn id(self, value: String) -> ContractBuilder

Logical id of this artifact

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

pub fn meta(self, value: Meta) -> ContractBuilder

Metadata about the resource

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.

pub fn implicit_rules(self, value: String) -> ContractBuilder

A set of rules under which this content was created

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.

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

pub fn language(self, value: String) -> ContractBuilder

Language; Language of the resource content

The base language in which the resource is written.

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

pub fn text(self, value: Narrative) -> ContractBuilder

Text summary of the resource, for human interpretation

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.

Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a “text blob” or where text is additionally entered raw or narrated and encoded information is added later.

pub fn contained(self, value: Vec<Resource>) -> ContractBuilder

Contained, inline Resources

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

pub fn extension(self, value: Vec<Extension>) -> ContractBuilder

Additional content defined by implementations

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 managable, 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.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

pub fn modifier_extension(self, value: Vec<Extension>) -> ContractBuilder

Extensions that cannot be ignored

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 managable, 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).

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

pub fn identifier(self, value: Vec<Option<Identifier>>) -> ContractBuilder

Contract number

Unique identifier for this Contract or a derivative that references a Source Contract.

pub fn identifier_ext( self, value: Vec<Option<FieldExtension>>, ) -> ContractBuilder

Extension field.

pub fn url(self, value: String) -> ContractBuilder

Basal definition

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

Used in a domain that uses a supplied contract repository.

pub fn url_ext(self, value: FieldExtension) -> ContractBuilder

Extension field.

pub fn version(self, value: String) -> ContractBuilder

Business edition

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

Note - This is a business versionId, not a resource version id (see discussion at Versioning) Comments - There may be different contract instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the plan definition with the format [url]|[version]. The version SHOULD NOT contain a ‘#’ - see Business Version.

pub fn version_ext(self, value: FieldExtension) -> ContractBuilder

Extension field.

pub fn status(self, value: ContractStatus) -> ContractBuilder

ContractStatus; amended | appended | cancelled | disputed | entered-in-error | executable +

The status of the resource instance.

This element is labeled as a modifier because the status contains codes that mark the contract as not currently valid or active.

pub fn status_ext(self, value: FieldExtension) -> ContractBuilder

Extension field.

pub fn legal_state(self, value: CodeableConcept) -> ContractBuilder

ContractLegalState; Negotiation status

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.

pub fn legal_state_ext(self, value: FieldExtension) -> ContractBuilder

Extension field.

pub fn instantiates_canonical(self, value: Reference) -> ContractBuilder

Source Contract Definition

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

pub fn instantiates_canonical_ext( self, value: FieldExtension, ) -> ContractBuilder

Extension field.

pub fn instantiates_uri(self, value: String) -> ContractBuilder

External Contract Definition

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

pub fn instantiates_uri_ext(self, value: FieldExtension) -> ContractBuilder

Extension field.

pub fn content_derivative(self, value: CodeableConcept) -> ContractBuilder

ContractContentDerivative; Content derived from the basal information

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

pub fn content_derivative_ext(self, value: FieldExtension) -> ContractBuilder

Extension field.

pub fn issued(self, value: DateTime) -> ContractBuilder

When this Contract was issued

When this Contract was issued.

pub fn issued_ext(self, value: FieldExtension) -> ContractBuilder

Extension field.

pub fn applies(self, value: Period) -> ContractBuilder

Effective time

Relevant time or time-period when this Contract is applicable.

pub fn applies_ext(self, value: FieldExtension) -> ContractBuilder

Extension field.

pub fn expiration_type(self, value: CodeableConcept) -> ContractBuilder

ContractExpiration; Contract cessation cause

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

pub fn expiration_type_ext(self, value: FieldExtension) -> ContractBuilder

Extension field.

pub fn subject(self, value: Vec<Option<Reference>>) -> ContractBuilder

Contract Target Entity

The target entity impacted by or of interest to parties to the agreement.

The Contract.subject is an entity that has some role with respect to the Contract.topic and Contract.topic.term, which is of focal interest to the parties to the contract and likely impacted in a significant way by the Contract.action/Contract.action.reason and the Contract.term.action/Contract.action.reason. In many cases, the Contract.subject is a Contract.signer if the subject is an adult; has a legal interest in the contract; and incompetent to participate in the contract agreement.

pub fn subject_ext(self, value: Vec<Option<FieldExtension>>) -> ContractBuilder

Extension field.

pub fn authority(self, value: Vec<Option<Reference>>) -> ContractBuilder

Authority under which this Contract has standing

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.

pub fn authority_ext( self, value: Vec<Option<FieldExtension>>, ) -> ContractBuilder

Extension field.

pub fn domain(self, value: Vec<Option<Reference>>) -> ContractBuilder

A sphere of control governed by an authoritative jurisdiction, organization, or person

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.

pub fn domain_ext(self, value: Vec<Option<FieldExtension>>) -> ContractBuilder

Extension field.

pub fn site(self, value: Vec<Option<Reference>>) -> ContractBuilder

Specific Location

Sites in which the contract is complied with, exercised, or in force.

pub fn site_ext(self, value: Vec<Option<FieldExtension>>) -> ContractBuilder

Extension field.

pub fn name(self, value: String) -> ContractBuilder

Computer friendly designation

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.

The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

pub fn name_ext(self, value: FieldExtension) -> ContractBuilder

Extension field.

pub fn title(self, value: String) -> ContractBuilder

Human Friendly name

A short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state.

pub fn title_ext(self, value: FieldExtension) -> ContractBuilder

Extension field.

pub fn subtitle(self, value: String) -> ContractBuilder

Subordinate Friendly name

A more detailed or qualifying explanatory or alternate user-friendly title for this Contract definition, derivative, or instance in any legal state.

pub fn subtitle_ext(self, value: FieldExtension) -> ContractBuilder

Extension field.

pub fn alias(self, value: Vec<Option<String>>) -> ContractBuilder

Acronym or short name

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.

pub fn alias_ext(self, value: Vec<Option<FieldExtension>>) -> ContractBuilder

Extension field.

pub fn author(self, value: Reference) -> ContractBuilder

Source of Contract

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

pub fn author_ext(self, value: FieldExtension) -> ContractBuilder

Extension field.

pub fn scope(self, value: CodeableConcept) -> ContractBuilder

ContractScope; Range of Legal Concerns

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

pub fn scope_ext(self, value: FieldExtension) -> ContractBuilder

Extension field.

pub fn topic(self, value: ContractTopic) -> ContractBuilder

Focus of contract interest

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

Contractual areas of concern are very broad. This element supports narrowing the area of concern to more specific term topics within this Contract. Given the wide range of contract topics, implementers need to be cognizant of the business use case for which they are designing a FHIR Contract, and narrowly specify the topic being represented with respect to the Contract.type and any specializing Contract.subtype. The same topic, e.g., an asset such as a good or service, such as a real property, medical supply, insurance, information, a procedure or employment, or a manner of conduct, such adherence to a privacy, trust, or security policy, may be the topic of multiple types of contracts. One way to determine the Contract.topic is to answer the question: “What is the overall objective of this legal instrument?”. The Contract.topic is described with more detail by the terms of the Contract.

pub fn topic_ext(self, value: ContractTopicExtension) -> ContractBuilder

Extension field.

pub fn type(self, value: CodeableConcept) -> ContractBuilder

ContractType; Legal instrument category

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.

pub fn type_ext(self, value: FieldExtension) -> ContractBuilder

Extension field.

pub fn sub_type(self, value: Vec<Option<CodeableConcept>>) -> ContractBuilder

ContractSubtype; Subtype within the context of type

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.

pub fn sub_type_ext(self, value: Vec<Option<FieldExtension>>) -> ContractBuilder

Extension field.

pub fn content_definition( self, value: ContractContentDefinition, ) -> ContractBuilder

Contract precursor content

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.

pub fn content_definition_ext(self, value: FieldExtension) -> ContractBuilder

Extension field.

pub fn term(self, value: Vec<Option<ContractTerm>>) -> ContractBuilder

Contract Term List

One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.

pub fn term_ext(self, value: Vec<Option<FieldExtension>>) -> ContractBuilder

Extension field.

pub fn supporting_info(self, value: Vec<Option<Reference>>) -> ContractBuilder

Extra Information

Information that may be needed by/relevant to the performer in their execution of this term action.

pub fn supporting_info_ext( self, value: Vec<Option<FieldExtension>>, ) -> ContractBuilder

Extension field.

pub fn relevant_history(self, value: Vec<Option<Reference>>) -> ContractBuilder

Key event in Contract History

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 Provenance.entity indicates the target that was changed in the update (see Provenance.entity).

pub fn relevant_history_ext( self, value: Vec<Option<FieldExtension>>, ) -> ContractBuilder

Extension field.

pub fn signer(self, value: Vec<Option<ContractSigner>>) -> ContractBuilder

Contract Signatory

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.

Signers who are principal parties to the contract are bound by the Contract.activity related to the Contract.topic, and the Contract.term(s), which either extend or restrict the overall action on the topic by, for example, stipulating specific policies or obligations constraining actions, action reason, or agents with respect to some or all of the topic. For example, specifying how policies or obligations shall constrain actions and action reasons permitted or denied on all or a subset of the Contract.topic (e.g., all or a portion of property being transferred by the contract), agents (e.g., who can resell, assign interests, or alter the property being transferred by the contract), actions, and action reasons; or with respect to Contract.terms, stipulating, extending, or limiting the Contract.period of applicability or valuation of items under consideration.

pub fn signer_ext(self, value: Vec<Option<FieldExtension>>) -> ContractBuilder

Extension field.

pub fn friendly(self, value: Vec<Option<ContractFriendly>>) -> ContractBuilder

Contract Friendly Language

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.

pub fn friendly_ext(self, value: Vec<Option<FieldExtension>>) -> ContractBuilder

Extension field.

pub fn legal(self, value: Vec<Option<ContractLegal>>) -> ContractBuilder

Contract Legal Language

List of Legal expressions or representations of this Contract.

pub fn legal_ext(self, value: Vec<Option<FieldExtension>>) -> ContractBuilder

Extension field.

pub fn rule(self, value: Vec<Option<ContractRule>>) -> ContractBuilder

Computable Contract Language

List of Computable Policy Rule Language Representations of this Contract.

pub fn rule_ext(self, value: Vec<Option<FieldExtension>>) -> ContractBuilder

Extension field.

pub fn legally_binding(self, value: ContractLegallyBinding) -> ContractBuilder

Binding Contract

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.

pub fn legally_binding_ext( self, value: ContractLegallyBindingExtension, ) -> ContractBuilder

Extension field.

pub fn build_inner(self) -> Result<ContractInner, BuilderError>

Builds a new ContractInner.

Errors

If a required field has not been initialized.

impl ContractBuilder

pub fn build(self) -> Result<Contract, BuilderError>

Finalize building Contract.

Trait Implementations

impl Default for ContractBuilder

fn default() -> ContractBuilder

Returns the “default value” for a type.