com.ibm.fhir.model.resource.Contract Maven / Gradle / Ivy
/*
* (C) Copyright IBM Corp. 2019, 2021
*
* SPDX-License-Identifier: Apache-2.0
*/
package com.ibm.fhir.model.resource;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import javax.annotation.Generated;
import com.ibm.fhir.model.annotation.Binding;
import com.ibm.fhir.model.annotation.Choice;
import com.ibm.fhir.model.annotation.Constraint;
import com.ibm.fhir.model.annotation.Maturity;
import com.ibm.fhir.model.annotation.ReferenceTarget;
import com.ibm.fhir.model.annotation.Required;
import com.ibm.fhir.model.annotation.Summary;
import com.ibm.fhir.model.type.Annotation;
import com.ibm.fhir.model.type.Attachment;
import com.ibm.fhir.model.type.BackboneElement;
import com.ibm.fhir.model.type.Boolean;
import com.ibm.fhir.model.type.Code;
import com.ibm.fhir.model.type.CodeableConcept;
import com.ibm.fhir.model.type.Coding;
import com.ibm.fhir.model.type.Date;
import com.ibm.fhir.model.type.DateTime;
import com.ibm.fhir.model.type.Decimal;
import com.ibm.fhir.model.type.Element;
import com.ibm.fhir.model.type.Extension;
import com.ibm.fhir.model.type.Identifier;
import com.ibm.fhir.model.type.Integer;
import com.ibm.fhir.model.type.Markdown;
import com.ibm.fhir.model.type.Meta;
import com.ibm.fhir.model.type.Money;
import com.ibm.fhir.model.type.Narrative;
import com.ibm.fhir.model.type.Period;
import com.ibm.fhir.model.type.Quantity;
import com.ibm.fhir.model.type.Reference;
import com.ibm.fhir.model.type.Signature;
import com.ibm.fhir.model.type.SimpleQuantity;
import com.ibm.fhir.model.type.String;
import com.ibm.fhir.model.type.Time;
import com.ibm.fhir.model.type.Timing;
import com.ibm.fhir.model.type.UnsignedInt;
import com.ibm.fhir.model.type.Uri;
import com.ibm.fhir.model.type.code.BindingStrength;
import com.ibm.fhir.model.type.code.ContractPublicationStatus;
import com.ibm.fhir.model.type.code.ContractStatus;
import com.ibm.fhir.model.type.code.StandardsStatus;
import com.ibm.fhir.model.util.ValidationSupport;
import com.ibm.fhir.model.visitor.Visitor;
/**
* Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
*
* Maturity level: FMM1 (Trial Use)
*/
@Maturity(
level = 1,
status = StandardsStatus.Value.TRIAL_USE
)
@Constraint(
id = "contract-0",
level = "Warning",
location = "(base)",
description = "SHALL, if possible, contain a code from value set http://hl7.org/fhir/ValueSet/contract-legalstate",
expression = "legalState.exists() implies (legalState.memberOf('http://hl7.org/fhir/ValueSet/contract-legalstate', 'extensible'))",
generated = true
)
@Constraint(
id = "contract-1",
level = "Warning",
location = "term.offer.decision",
description = "SHALL, if possible, contain a code from value set http://terminology.hl7.org/ValueSet/v3-ActConsentDirective",
expression = "$this.memberOf('http://terminology.hl7.org/ValueSet/v3-ActConsentDirective', 'extensible')",
generated = true
)
@Constraint(
id = "contract-2",
level = "Warning",
location = "term.asset.relationship",
description = "SHALL, if possible, contain a code from value set http://hl7.org/fhir/ValueSet/consent-content-class",
expression = "$this.memberOf('http://hl7.org/fhir/ValueSet/consent-content-class', 'extensible')",
generated = true
)
@Constraint(
id = "contract-3",
level = "Warning",
location = "signer.type",
description = "SHOULD contain a code from value set http://hl7.org/fhir/ValueSet/contract-signer-type",
expression = "$this.memberOf('http://hl7.org/fhir/ValueSet/contract-signer-type', 'preferred')",
generated = true
)
@Generated("com.ibm.fhir.tools.CodeGenerator")
public class Contract extends DomainResource {
@Summary
private final List identifier;
private final Uri url;
@Summary
private final String version;
@Summary
@Binding(
bindingName = "ContractStatus",
strength = BindingStrength.Value.REQUIRED,
description = "A code specifying the state of the resource instance.",
valueSet = "http://hl7.org/fhir/ValueSet/contract-status|4.0.1"
)
private final ContractStatus status;
@Binding(
bindingName = "ContractLegalState",
strength = BindingStrength.Value.EXTENSIBLE,
description = "Detailed codes for the legal state of a contract.",
valueSet = "http://hl7.org/fhir/ValueSet/contract-legalstate"
)
private final CodeableConcept legalState;
@ReferenceTarget({ "Contract" })
private final Reference instantiatesCanonical;
private final Uri instantiatesUri;
@Binding(
bindingName = "ContractContentDerivative",
strength = BindingStrength.Value.EXAMPLE,
description = "This is an example set of Content Derivative type codes, which represent the minimal content derived from the basal information source.",
valueSet = "http://hl7.org/fhir/ValueSet/contract-content-derivative"
)
private final CodeableConcept contentDerivative;
@Summary
private final DateTime issued;
@Summary
private final Period applies;
@Binding(
bindingName = "ContractExpiration",
strength = BindingStrength.Value.EXAMPLE,
description = "Codes for the Cessation of Contracts.",
valueSet = "http://hl7.org/fhir/ValueSet/contract-expiration-type"
)
private final CodeableConcept expirationType;
@Summary
private final List subject;
@ReferenceTarget({ "Organization" })
private final List authority;
@ReferenceTarget({ "Location" })
private final List domain;
@ReferenceTarget({ "Location" })
private final List site;
@Summary
private final String name;
@Summary
private final String title;
private final String subtitle;
private final List alias;
@ReferenceTarget({ "Patient", "Practitioner", "PractitionerRole", "Organization" })
private final Reference author;
@Binding(
bindingName = "ContractScope",
strength = BindingStrength.Value.EXAMPLE,
description = "Codes for the range of legal concerns.",
valueSet = "http://hl7.org/fhir/ValueSet/contract-scope"
)
private final CodeableConcept scope;
@Choice({ CodeableConcept.class, Reference.class })
private final Element topic;
@Summary
@Binding(
bindingName = "ContractType",
strength = BindingStrength.Value.EXAMPLE,
description = "List of overall contract codes.",
valueSet = "http://hl7.org/fhir/ValueSet/contract-type"
)
private final CodeableConcept type;
@Summary
@Binding(
bindingName = "ContractSubtype",
strength = BindingStrength.Value.EXAMPLE,
description = "Detailed codes within the above.",
valueSet = "http://hl7.org/fhir/ValueSet/contract-subtype"
)
private final List subType;
private final ContentDefinition contentDefinition;
private final List term;
private final List supportingInfo;
@ReferenceTarget({ "Provenance" })
private final List relevantHistory;
private final List signer;
private final List friendly;
private final List legal;
private final List rule;
@ReferenceTarget({ "Composition", "DocumentReference", "QuestionnaireResponse", "Contract" })
@Choice({ Attachment.class, Reference.class })
private final Element legallyBinding;
private Contract(Builder builder) {
super(builder);
identifier = Collections.unmodifiableList(builder.identifier);
url = builder.url;
version = builder.version;
status = builder.status;
legalState = builder.legalState;
instantiatesCanonical = builder.instantiatesCanonical;
instantiatesUri = builder.instantiatesUri;
contentDerivative = builder.contentDerivative;
issued = builder.issued;
applies = builder.applies;
expirationType = builder.expirationType;
subject = Collections.unmodifiableList(builder.subject);
authority = Collections.unmodifiableList(builder.authority);
domain = Collections.unmodifiableList(builder.domain);
site = Collections.unmodifiableList(builder.site);
name = builder.name;
title = builder.title;
subtitle = builder.subtitle;
alias = Collections.unmodifiableList(builder.alias);
author = builder.author;
scope = builder.scope;
topic = builder.topic;
type = builder.type;
subType = Collections.unmodifiableList(builder.subType);
contentDefinition = builder.contentDefinition;
term = Collections.unmodifiableList(builder.term);
supportingInfo = Collections.unmodifiableList(builder.supportingInfo);
relevantHistory = Collections.unmodifiableList(builder.relevantHistory);
signer = Collections.unmodifiableList(builder.signer);
friendly = Collections.unmodifiableList(builder.friendly);
legal = Collections.unmodifiableList(builder.legal);
rule = Collections.unmodifiableList(builder.rule);
legallyBinding = builder.legallyBinding;
}
/**
* Unique identifier for this Contract or a derivative that references a Source Contract.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Identifier} that may be empty.
*/
public List getIdentifier() {
return identifier;
}
/**
* Canonical identifier for this contract, represented as a URI (globally unique).
*
* @return
* An immutable object of type {@link Uri} that may be null.
*/
public Uri getUrl() {
return url;
}
/**
* An edition identifier used for business purposes to label business significant variants.
*
* @return
* An immutable object of type {@link String} that may be null.
*/
public String getVersion() {
return version;
}
/**
* The status of the resource instance.
*
* @return
* An immutable object of type {@link ContractStatus} that may be null.
*/
public ContractStatus getStatus() {
return 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.
*
* @return
* An immutable object of type {@link CodeableConcept} that may be null.
*/
public CodeableConcept getLegalState() {
return legalState;
}
/**
* The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract.
*
* @return
* An immutable object of type {@link Reference} that may be null.
*/
public Reference getInstantiatesCanonical() {
return instantiatesCanonical;
}
/**
* The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract.
*
* @return
* An immutable object of type {@link Uri} that may be null.
*/
public Uri getInstantiatesUri() {
return instantiatesUri;
}
/**
* The minimal content derived from the basal information source at a specific stage in its lifecycle.
*
* @return
* An immutable object of type {@link CodeableConcept} that may be null.
*/
public CodeableConcept getContentDerivative() {
return contentDerivative;
}
/**
* When this Contract was issued.
*
* @return
* An immutable object of type {@link DateTime} that may be null.
*/
public DateTime getIssued() {
return issued;
}
/**
* Relevant time or time-period when this Contract is applicable.
*
* @return
* An immutable object of type {@link Period} that may be null.
*/
public Period getApplies() {
return applies;
}
/**
* Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract.
*
* @return
* An immutable object of type {@link CodeableConcept} that may be null.
*/
public CodeableConcept getExpirationType() {
return expirationType;
}
/**
* The target entity impacted by or of interest to parties to the agreement.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Reference} that may be empty.
*/
public List getSubject() {
return subject;
}
/**
* 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.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Reference} that may be empty.
*/
public List getAuthority() {
return authority;
}
/**
* 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.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Reference} that may be empty.
*/
public List getDomain() {
return domain;
}
/**
* Sites in which the contract is complied with, exercised, or in force.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Reference} that may be empty.
*/
public List getSite() {
return site;
}
/**
* 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.
*
* @return
* An immutable object of type {@link String} that may be null.
*/
public String getName() {
return name;
}
/**
* A short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state.t
* giving additional information about its content.
*
* @return
* An immutable object of type {@link String} that may be null.
*/
public String getTitle() {
return title;
}
/**
* 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.
*
* @return
* An immutable object of type {@link String} that may be null.
*/
public String getSubtitle() {
return subtitle;
}
/**
* 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.
*
* @return
* An unmodifiable list containing immutable objects of type {@link String} that may be empty.
*/
public List getAlias() {
return alias;
}
/**
* The individual or organization that authored the Contract definition, derivative, or instance in any legal state.
*
* @return
* An immutable object of type {@link Reference} that may be null.
*/
public Reference getAuthor() {
return author;
}
/**
* A selector of legal concerns for this Contract definition, derivative, or instance in any legal state.
*
* @return
* An immutable object of type {@link CodeableConcept} that may be null.
*/
public CodeableConcept getScope() {
return scope;
}
/**
* Narrows the range of legal concerns to focus on the achievement of specific contractual objectives.
*
* @return
* An immutable object of type {@link Element} that may be null.
*/
public Element getTopic() {
return topic;
}
/**
* 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.
*
* @return
* An immutable object of type {@link CodeableConcept} that may be null.
*/
public CodeableConcept getType() {
return 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.
*
* @return
* An unmodifiable list containing immutable objects of type {@link CodeableConcept} that may be empty.
*/
public List getSubType() {
return subType;
}
/**
* 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.
*
* @return
* An immutable object of type {@link ContentDefinition} that may be null.
*/
public ContentDefinition getContentDefinition() {
return contentDefinition;
}
/**
* One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Term} that may be empty.
*/
public List getTerm() {
return term;
}
/**
* Information that may be needed by/relevant to the performer in their execution of this term action.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Reference} that may be empty.
*/
public List getSupportingInfo() {
return supportingInfo;
}
/**
* 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.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Reference} that may be empty.
*/
public List getRelevantHistory() {
return relevantHistory;
}
/**
* 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.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Signer} that may be empty.
*/
public List getSigner() {
return signer;
}
/**
* 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.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Friendly} that may be empty.
*/
public List getFriendly() {
return friendly;
}
/**
* List of Legal expressions or representations of this Contract.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Legal} that may be empty.
*/
public List getLegal() {
return legal;
}
/**
* List of Computable Policy Rule Language Representations of this Contract.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Rule} that may be empty.
*/
public List getRule() {
return rule;
}
/**
* 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.
*
* @return
* An immutable object of type {@link Element} that may be null.
*/
public Element getLegallyBinding() {
return legallyBinding;
}
@Override
public boolean hasChildren() {
return super.hasChildren() ||
!identifier.isEmpty() ||
(url != null) ||
(version != null) ||
(status != null) ||
(legalState != null) ||
(instantiatesCanonical != null) ||
(instantiatesUri != null) ||
(contentDerivative != null) ||
(issued != null) ||
(applies != null) ||
(expirationType != null) ||
!subject.isEmpty() ||
!authority.isEmpty() ||
!domain.isEmpty() ||
!site.isEmpty() ||
(name != null) ||
(title != null) ||
(subtitle != null) ||
!alias.isEmpty() ||
(author != null) ||
(scope != null) ||
(topic != null) ||
(type != null) ||
!subType.isEmpty() ||
(contentDefinition != null) ||
!term.isEmpty() ||
!supportingInfo.isEmpty() ||
!relevantHistory.isEmpty() ||
!signer.isEmpty() ||
!friendly.isEmpty() ||
!legal.isEmpty() ||
!rule.isEmpty() ||
(legallyBinding != null);
}
@Override
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor) {
if (visitor.preVisit(this)) {
visitor.visitStart(elementName, elementIndex, this);
if (visitor.visit(elementName, elementIndex, this)) {
// visit children
accept(id, "id", visitor);
accept(meta, "meta", visitor);
accept(implicitRules, "implicitRules", visitor);
accept(language, "language", visitor);
accept(text, "text", visitor);
accept(contained, "contained", visitor, Resource.class);
accept(extension, "extension", visitor, Extension.class);
accept(modifierExtension, "modifierExtension", visitor, Extension.class);
accept(identifier, "identifier", visitor, Identifier.class);
accept(url, "url", visitor);
accept(version, "version", visitor);
accept(status, "status", visitor);
accept(legalState, "legalState", visitor);
accept(instantiatesCanonical, "instantiatesCanonical", visitor);
accept(instantiatesUri, "instantiatesUri", visitor);
accept(contentDerivative, "contentDerivative", visitor);
accept(issued, "issued", visitor);
accept(applies, "applies", visitor);
accept(expirationType, "expirationType", visitor);
accept(subject, "subject", visitor, Reference.class);
accept(authority, "authority", visitor, Reference.class);
accept(domain, "domain", visitor, Reference.class);
accept(site, "site", visitor, Reference.class);
accept(name, "name", visitor);
accept(title, "title", visitor);
accept(subtitle, "subtitle", visitor);
accept(alias, "alias", visitor, String.class);
accept(author, "author", visitor);
accept(scope, "scope", visitor);
accept(topic, "topic", visitor);
accept(type, "type", visitor);
accept(subType, "subType", visitor, CodeableConcept.class);
accept(contentDefinition, "contentDefinition", visitor);
accept(term, "term", visitor, Term.class);
accept(supportingInfo, "supportingInfo", visitor, Reference.class);
accept(relevantHistory, "relevantHistory", visitor, Reference.class);
accept(signer, "signer", visitor, Signer.class);
accept(friendly, "friendly", visitor, Friendly.class);
accept(legal, "legal", visitor, Legal.class);
accept(rule, "rule", visitor, Rule.class);
accept(legallyBinding, "legallyBinding", visitor);
}
visitor.visitEnd(elementName, elementIndex, this);
visitor.postVisit(this);
}
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
Contract other = (Contract) obj;
return Objects.equals(id, other.id) &&
Objects.equals(meta, other.meta) &&
Objects.equals(implicitRules, other.implicitRules) &&
Objects.equals(language, other.language) &&
Objects.equals(text, other.text) &&
Objects.equals(contained, other.contained) &&
Objects.equals(extension, other.extension) &&
Objects.equals(modifierExtension, other.modifierExtension) &&
Objects.equals(identifier, other.identifier) &&
Objects.equals(url, other.url) &&
Objects.equals(version, other.version) &&
Objects.equals(status, other.status) &&
Objects.equals(legalState, other.legalState) &&
Objects.equals(instantiatesCanonical, other.instantiatesCanonical) &&
Objects.equals(instantiatesUri, other.instantiatesUri) &&
Objects.equals(contentDerivative, other.contentDerivative) &&
Objects.equals(issued, other.issued) &&
Objects.equals(applies, other.applies) &&
Objects.equals(expirationType, other.expirationType) &&
Objects.equals(subject, other.subject) &&
Objects.equals(authority, other.authority) &&
Objects.equals(domain, other.domain) &&
Objects.equals(site, other.site) &&
Objects.equals(name, other.name) &&
Objects.equals(title, other.title) &&
Objects.equals(subtitle, other.subtitle) &&
Objects.equals(alias, other.alias) &&
Objects.equals(author, other.author) &&
Objects.equals(scope, other.scope) &&
Objects.equals(topic, other.topic) &&
Objects.equals(type, other.type) &&
Objects.equals(subType, other.subType) &&
Objects.equals(contentDefinition, other.contentDefinition) &&
Objects.equals(term, other.term) &&
Objects.equals(supportingInfo, other.supportingInfo) &&
Objects.equals(relevantHistory, other.relevantHistory) &&
Objects.equals(signer, other.signer) &&
Objects.equals(friendly, other.friendly) &&
Objects.equals(legal, other.legal) &&
Objects.equals(rule, other.rule) &&
Objects.equals(legallyBinding, other.legallyBinding);
}
@Override
public int hashCode() {
int result = hashCode;
if (result == 0) {
result = Objects.hash(id,
meta,
implicitRules,
language,
text,
contained,
extension,
modifierExtension,
identifier,
url,
version,
status,
legalState,
instantiatesCanonical,
instantiatesUri,
contentDerivative,
issued,
applies,
expirationType,
subject,
authority,
domain,
site,
name,
title,
subtitle,
alias,
author,
scope,
topic,
type,
subType,
contentDefinition,
term,
supportingInfo,
relevantHistory,
signer,
friendly,
legal,
rule,
legallyBinding);
hashCode = result;
}
return result;
}
@Override
public Builder toBuilder() {
return new Builder().from(this);
}
public static Builder builder() {
return new Builder();
}
public static class Builder extends DomainResource.Builder {
private List identifier = new ArrayList<>();
private Uri url;
private String version;
private ContractStatus status;
private CodeableConcept legalState;
private Reference instantiatesCanonical;
private Uri instantiatesUri;
private CodeableConcept contentDerivative;
private DateTime issued;
private Period applies;
private CodeableConcept expirationType;
private List subject = new ArrayList<>();
private List authority = new ArrayList<>();
private List domain = new ArrayList<>();
private List site = new ArrayList<>();
private String name;
private String title;
private String subtitle;
private List alias = new ArrayList<>();
private Reference author;
private CodeableConcept scope;
private Element topic;
private CodeableConcept type;
private List subType = new ArrayList<>();
private ContentDefinition contentDefinition;
private List term = new ArrayList<>();
private List supportingInfo = new ArrayList<>();
private List relevantHistory = new ArrayList<>();
private List signer = new ArrayList<>();
private List friendly = new ArrayList<>();
private List legal = new ArrayList<>();
private List rule = new ArrayList<>();
private Element legallyBinding;
private Builder() {
super();
}
/**
* The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
*
* @param id
* Logical id of this artifact
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder id(java.lang.String id) {
return (Builder) super.id(id);
}
/**
* 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.
*
* @param meta
* Metadata about the resource
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder meta(Meta meta) {
return (Builder) super.meta(meta);
}
/**
* 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.
*
* @param implicitRules
* A set of rules under which this content was created
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder implicitRules(Uri implicitRules) {
return (Builder) super.implicitRules(implicitRules);
}
/**
* The base language in which the resource is written.
*
* @param language
* Language of the resource content
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder language(Code language) {
return (Builder) super.language(language);
}
/**
* 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.
*
* @param text
* Text summary of the resource, for human interpretation
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder text(Narrative text) {
return (Builder) super.text(text);
}
/**
* 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
*
* @param contained
* Contained, inline Resources
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder contained(Resource... contained) {
return (Builder) super.contained(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
*
* @param contained
* Contained, inline Resources
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder contained(Collection contained) {
return (Builder) super.contained(contained);
}
/**
* 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
*
* @param extension
* Additional content defined by implementations
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder extension(Extension... extension) {
return (Builder) super.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
*
* @param extension
* Additional content defined by implementations
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder extension(Collection extension) {
return (Builder) super.extension(extension);
}
/**
* 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
*
* @param modifierExtension
* Extensions that cannot be ignored
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder modifierExtension(Extension... modifierExtension) {
return (Builder) super.modifierExtension(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
*
* @param modifierExtension
* Extensions that cannot be ignored
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder modifierExtension(Collection modifierExtension) {
return (Builder) super.modifierExtension(modifierExtension);
}
/**
* Unique identifier for this Contract or a derivative that references a Source Contract.
*
* Adds new element(s) to the existing list
*
* @param identifier
* Contract number
*
* @return
* A reference to this Builder instance
*/
public Builder identifier(Identifier... identifier) {
for (Identifier value : identifier) {
this.identifier.add(value);
}
return this;
}
/**
* 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
*
* @param identifier
* Contract number
*
* @return
* A reference to this Builder instance
*/
public Builder identifier(Collection identifier) {
this.identifier = new ArrayList<>(identifier);
return this;
}
/**
* Canonical identifier for this contract, represented as a URI (globally unique).
*
* @param url
* Basal definition
*
* @return
* A reference to this Builder instance
*/
public Builder url(Uri url) {
this.url = url;
return this;
}
/**
* An edition identifier used for business purposes to label business significant variants.
*
* @param version
* Business edition
*
* @return
* A reference to this Builder instance
*/
public Builder version(String version) {
this.version = version;
return this;
}
/**
* The status of the resource instance.
*
* @param status
* amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy |
* rejected | renewed | revoked | resolved | terminated
*
* @return
* A reference to this Builder instance
*/
public Builder status(ContractStatus status) {
this.status = status;
return this;
}
/**
* 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.
*
* @param legalState
* Negotiation status
*
* @return
* A reference to this Builder instance
*/
public Builder legalState(CodeableConcept legalState) {
this.legalState = legalState;
return this;
}
/**
* 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:
*
* - {@link Contract}
*
*
* @param instantiatesCanonical
* Source Contract Definition
*
* @return
* A reference to this Builder instance
*/
public Builder instantiatesCanonical(Reference instantiatesCanonical) {
this.instantiatesCanonical = instantiatesCanonical;
return this;
}
/**
* The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract.
*
* @param instantiatesUri
* External Contract Definition
*
* @return
* A reference to this Builder instance
*/
public Builder instantiatesUri(Uri instantiatesUri) {
this.instantiatesUri = instantiatesUri;
return this;
}
/**
* The minimal content derived from the basal information source at a specific stage in its lifecycle.
*
* @param contentDerivative
* Content derived from the basal information
*
* @return
* A reference to this Builder instance
*/
public Builder contentDerivative(CodeableConcept contentDerivative) {
this.contentDerivative = contentDerivative;
return this;
}
/**
* When this Contract was issued.
*
* @param issued
* When this Contract was issued
*
* @return
* A reference to this Builder instance
*/
public Builder issued(DateTime issued) {
this.issued = issued;
return this;
}
/**
* Relevant time or time-period when this Contract is applicable.
*
* @param applies
* Effective time
*
* @return
* A reference to this Builder instance
*/
public Builder applies(Period applies) {
this.applies = applies;
return this;
}
/**
* Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract.
*
* @param expirationType
* Contract cessation cause
*
* @return
* A reference to this Builder instance
*/
public Builder expirationType(CodeableConcept expirationType) {
this.expirationType = expirationType;
return this;
}
/**
* The target entity impacted by or of interest to parties to the agreement.
*
* Adds new element(s) to the existing list
*
* @param subject
* Contract Target Entity
*
* @return
* A reference to this Builder instance
*/
public Builder subject(Reference... subject) {
for (Reference value : subject) {
this.subject.add(value);
}
return this;
}
/**
* 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
*
* @param subject
* Contract Target Entity
*
* @return
* A reference to this Builder instance
*/
public Builder subject(Collection subject) {
this.subject = new ArrayList<>(subject);
return this;
}
/**
* 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
*
*
Allowed resource types for the references:
*
* - {@link Organization}
*
*
* @param authority
* Authority under which this Contract has standing
*
* @return
* A reference to this Builder instance
*/
public Builder authority(Reference... authority) {
for (Reference value : authority) {
this.authority.add(value);
}
return this;
}
/**
* 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
*
*
Allowed resource types for the references:
*
* - {@link Organization}
*
*
* @param authority
* Authority under which this Contract has standing
*
* @return
* A reference to this Builder instance
*/
public Builder authority(Collection authority) {
this.authority = new ArrayList<>(authority);
return this;
}
/**
* 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
*
*
Allowed resource types for the references:
*
* - {@link Location}
*
*
* @param domain
* A sphere of control governed by an authoritative jurisdiction, organization, or person
*
* @return
* A reference to this Builder instance
*/
public Builder domain(Reference... domain) {
for (Reference value : domain) {
this.domain.add(value);
}
return this;
}
/**
* 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
*
*
Allowed resource types for the references:
*
* - {@link Location}
*
*
* @param domain
* A sphere of control governed by an authoritative jurisdiction, organization, or person
*
* @return
* A reference to this Builder instance
*/
public Builder domain(Collection domain) {
this.domain = new ArrayList<>(domain);
return this;
}
/**
* Sites in which the contract is complied with, exercised, or in force.
*
* Adds new element(s) to the existing list
*
*
Allowed resource types for the references:
*
* - {@link Location}
*
*
* @param site
* Specific Location
*
* @return
* A reference to this Builder instance
*/
public Builder site(Reference... site) {
for (Reference value : site) {
this.site.add(value);
}
return this;
}
/**
* 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
*
*
Allowed resource types for the references:
*
* - {@link Location}
*
*
* @param site
* Specific Location
*
* @return
* A reference to this Builder instance
*/
public Builder site(Collection site) {
this.site = new ArrayList<>(site);
return this;
}
/**
* 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.
*
* @param name
* Computer friendly designation
*
* @return
* A reference to this Builder instance
*/
public Builder name(String name) {
this.name = name;
return this;
}
/**
* A short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state.t
* giving additional information about its content.
*
* @param title
* Human Friendly name
*
* @return
* A reference to this Builder instance
*/
public Builder title(String title) {
this.title = title;
return this;
}
/**
* 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.
*
* @param subtitle
* Subordinate Friendly name
*
* @return
* A reference to this Builder instance
*/
public Builder subtitle(String subtitle) {
this.subtitle = subtitle;
return this;
}
/**
* 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
*
* @param alias
* Acronym or short name
*
* @return
* A reference to this Builder instance
*/
public Builder alias(String... alias) {
for (String value : alias) {
this.alias.add(value);
}
return this;
}
/**
* 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
*
* @param alias
* Acronym or short name
*
* @return
* A reference to this Builder instance
*/
public Builder alias(Collection alias) {
this.alias = new ArrayList<>(alias);
return this;
}
/**
* The individual or organization that authored the Contract definition, derivative, or instance in any legal state.
*
* Allowed resource types for this reference:
*
* - {@link Patient}
* - {@link Practitioner}
* - {@link PractitionerRole}
* - {@link Organization}
*
*
* @param author
* Source of Contract
*
* @return
* A reference to this Builder instance
*/
public Builder author(Reference author) {
this.author = author;
return this;
}
/**
* A selector of legal concerns for this Contract definition, derivative, or instance in any legal state.
*
* @param scope
* Range of Legal Concerns
*
* @return
* A reference to this Builder instance
*/
public Builder scope(CodeableConcept scope) {
this.scope = scope;
return this;
}
/**
* 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:
*
* - {@link CodeableConcept}
* - {@link Reference}
*
*
* @param topic
* Focus of contract interest
*
* @return
* A reference to this Builder instance
*/
public Builder topic(Element topic) {
this.topic = topic;
return this;
}
/**
* 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.
*
* @param type
* Legal instrument category
*
* @return
* A reference to this Builder instance
*/
public Builder type(CodeableConcept type) {
this.type = type;
return this;
}
/**
* 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
*
* @param subType
* Subtype within the context of type
*
* @return
* A reference to this Builder instance
*/
public Builder subType(CodeableConcept... subType) {
for (CodeableConcept value : subType) {
this.subType.add(value);
}
return this;
}
/**
* 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
*
* @param subType
* Subtype within the context of type
*
* @return
* A reference to this Builder instance
*/
public Builder subType(Collection subType) {
this.subType = new ArrayList<>(subType);
return this;
}
/**
* 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.
*
* @param contentDefinition
* Contract precursor content
*
* @return
* A reference to this Builder instance
*/
public Builder contentDefinition(ContentDefinition contentDefinition) {
this.contentDefinition = contentDefinition;
return this;
}
/**
* 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
*
* @param term
* Contract Term List
*
* @return
* A reference to this Builder instance
*/
public Builder term(Term... term) {
for (Term value : term) {
this.term.add(value);
}
return this;
}
/**
* 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
*
* @param term
* Contract Term List
*
* @return
* A reference to this Builder instance
*/
public Builder term(Collection term) {
this.term = new ArrayList<>(term);
return this;
}
/**
* 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
*
* @param supportingInfo
* Extra Information
*
* @return
* A reference to this Builder instance
*/
public Builder supportingInfo(Reference... supportingInfo) {
for (Reference value : supportingInfo) {
this.supportingInfo.add(value);
}
return this;
}
/**
* 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
*
* @param supportingInfo
* Extra Information
*
* @return
* A reference to this Builder instance
*/
public Builder supportingInfo(Collection supportingInfo) {
this.supportingInfo = new ArrayList<>(supportingInfo);
return this;
}
/**
* 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
*
*
Allowed resource types for the references:
*
* - {@link Provenance}
*
*
* @param relevantHistory
* Key event in Contract History
*
* @return
* A reference to this Builder instance
*/
public Builder relevantHistory(Reference... relevantHistory) {
for (Reference value : relevantHistory) {
this.relevantHistory.add(value);
}
return this;
}
/**
* 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
*
*
Allowed resource types for the references:
*
* - {@link Provenance}
*
*
* @param relevantHistory
* Key event in Contract History
*
* @return
* A reference to this Builder instance
*/
public Builder relevantHistory(Collection relevantHistory) {
this.relevantHistory = new ArrayList<>(relevantHistory);
return this;
}
/**
* 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
*
* @param signer
* Contract Signatory
*
* @return
* A reference to this Builder instance
*/
public Builder signer(Signer... signer) {
for (Signer value : signer) {
this.signer.add(value);
}
return this;
}
/**
* 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
*
* @param signer
* Contract Signatory
*
* @return
* A reference to this Builder instance
*/
public Builder signer(Collection signer) {
this.signer = new ArrayList<>(signer);
return this;
}
/**
* 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
*
* @param friendly
* Contract Friendly Language
*
* @return
* A reference to this Builder instance
*/
public Builder friendly(Friendly... friendly) {
for (Friendly value : friendly) {
this.friendly.add(value);
}
return this;
}
/**
* 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
*
* @param friendly
* Contract Friendly Language
*
* @return
* A reference to this Builder instance
*/
public Builder friendly(Collection friendly) {
this.friendly = new ArrayList<>(friendly);
return this;
}
/**
* List of Legal expressions or representations of this Contract.
*
* Adds new element(s) to the existing list
*
* @param legal
* Contract Legal Language
*
* @return
* A reference to this Builder instance
*/
public Builder legal(Legal... legal) {
for (Legal value : legal) {
this.legal.add(value);
}
return this;
}
/**
* List of Legal expressions or representations of this Contract.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param legal
* Contract Legal Language
*
* @return
* A reference to this Builder instance
*/
public Builder legal(Collection legal) {
this.legal = new ArrayList<>(legal);
return this;
}
/**
* List of Computable Policy Rule Language Representations of this Contract.
*
* Adds new element(s) to the existing list
*
* @param rule
* Computable Contract Language
*
* @return
* A reference to this Builder instance
*/
public Builder rule(Rule... rule) {
for (Rule value : rule) {
this.rule.add(value);
}
return this;
}
/**
* List of Computable Policy Rule Language Representations of this Contract.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param rule
* Computable Contract Language
*
* @return
* A reference to this Builder instance
*/
public Builder rule(Collection rule) {
this.rule = new ArrayList<>(rule);
return this;
}
/**
* 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:
*
* - {@link Attachment}
* - {@link Reference}
*
*
* When of type {@link Reference}, the allowed resource types for this reference are:
*
* - {@link Composition}
* - {@link DocumentReference}
* - {@link QuestionnaireResponse}
* - {@link Contract}
*
*
* @param legallyBinding
* Binding Contract
*
* @return
* A reference to this Builder instance
*/
public Builder legallyBinding(Element legallyBinding) {
this.legallyBinding = legallyBinding;
return this;
}
/**
* Build the {@link Contract}
*
* @return
* An immutable object of type {@link Contract}
* @throws IllegalStateException
* if the current state cannot be built into a valid Contract per the base specification
*/
@Override
public Contract build() {
Contract contract = new Contract(this);
if (validating) {
validate(contract);
}
return contract;
}
protected void validate(Contract contract) {
super.validate(contract);
ValidationSupport.checkList(contract.identifier, "identifier", Identifier.class);
ValidationSupport.checkList(contract.subject, "subject", Reference.class);
ValidationSupport.checkList(contract.authority, "authority", Reference.class);
ValidationSupport.checkList(contract.domain, "domain", Reference.class);
ValidationSupport.checkList(contract.site, "site", Reference.class);
ValidationSupport.checkList(contract.alias, "alias", String.class);
ValidationSupport.choiceElement(contract.topic, "topic", CodeableConcept.class, Reference.class);
ValidationSupport.checkList(contract.subType, "subType", CodeableConcept.class);
ValidationSupport.checkList(contract.term, "term", Term.class);
ValidationSupport.checkList(contract.supportingInfo, "supportingInfo", Reference.class);
ValidationSupport.checkList(contract.relevantHistory, "relevantHistory", Reference.class);
ValidationSupport.checkList(contract.signer, "signer", Signer.class);
ValidationSupport.checkList(contract.friendly, "friendly", Friendly.class);
ValidationSupport.checkList(contract.legal, "legal", Legal.class);
ValidationSupport.checkList(contract.rule, "rule", Rule.class);
ValidationSupport.choiceElement(contract.legallyBinding, "legallyBinding", Attachment.class, Reference.class);
ValidationSupport.checkReferenceType(contract.instantiatesCanonical, "instantiatesCanonical", "Contract");
ValidationSupport.checkReferenceType(contract.authority, "authority", "Organization");
ValidationSupport.checkReferenceType(contract.domain, "domain", "Location");
ValidationSupport.checkReferenceType(contract.site, "site", "Location");
ValidationSupport.checkReferenceType(contract.author, "author", "Patient", "Practitioner", "PractitionerRole", "Organization");
ValidationSupport.checkReferenceType(contract.relevantHistory, "relevantHistory", "Provenance");
ValidationSupport.checkReferenceType(contract.legallyBinding, "legallyBinding", "Composition", "DocumentReference", "QuestionnaireResponse", "Contract");
}
protected Builder from(Contract contract) {
super.from(contract);
identifier.addAll(contract.identifier);
url = contract.url;
version = contract.version;
status = contract.status;
legalState = contract.legalState;
instantiatesCanonical = contract.instantiatesCanonical;
instantiatesUri = contract.instantiatesUri;
contentDerivative = contract.contentDerivative;
issued = contract.issued;
applies = contract.applies;
expirationType = contract.expirationType;
subject.addAll(contract.subject);
authority.addAll(contract.authority);
domain.addAll(contract.domain);
site.addAll(contract.site);
name = contract.name;
title = contract.title;
subtitle = contract.subtitle;
alias.addAll(contract.alias);
author = contract.author;
scope = contract.scope;
topic = contract.topic;
type = contract.type;
subType.addAll(contract.subType);
contentDefinition = contract.contentDefinition;
term.addAll(contract.term);
supportingInfo.addAll(contract.supportingInfo);
relevantHistory.addAll(contract.relevantHistory);
signer.addAll(contract.signer);
friendly.addAll(contract.friendly);
legal.addAll(contract.legal);
rule.addAll(contract.rule);
legallyBinding = contract.legallyBinding;
return this;
}
}
/**
* 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.
*/
public static class ContentDefinition extends BackboneElement {
@Binding(
bindingName = "ContractDefinitionType",
strength = BindingStrength.Value.EXAMPLE,
description = "Detailed codes for the definition of contracts.",
valueSet = "http://hl7.org/fhir/ValueSet/contract-definition-type"
)
@Required
private final CodeableConcept type;
@Binding(
bindingName = "ContractDefinitionSubtype",
strength = BindingStrength.Value.EXAMPLE,
description = "Detailed codes for the additional definition of contracts.",
valueSet = "http://hl7.org/fhir/ValueSet/contract-definition-subtype"
)
private final CodeableConcept subType;
@ReferenceTarget({ "Practitioner", "PractitionerRole", "Organization" })
private final Reference publisher;
private final DateTime publicationDate;
@Binding(
bindingName = "ContractPublicationStatus",
strength = BindingStrength.Value.REQUIRED,
description = "Status of the publication of contract content.",
valueSet = "http://hl7.org/fhir/ValueSet/contract-publicationstatus|4.0.1"
)
@Required
private final ContractPublicationStatus publicationStatus;
private final Markdown copyright;
private ContentDefinition(Builder builder) {
super(builder);
type = builder.type;
subType = builder.subType;
publisher = builder.publisher;
publicationDate = builder.publicationDate;
publicationStatus = builder.publicationStatus;
copyright = builder.copyright;
}
/**
* Precusory content structure and use, i.e., a boilerplate, template, application for a contract such as an insurance
* policy or benefits under a program, e.g., workers compensation.
*
* @return
* An immutable object of type {@link CodeableConcept} that is non-null.
*/
public CodeableConcept getType() {
return type;
}
/**
* Detailed Precusory content type.
*
* @return
* An immutable object of type {@link CodeableConcept} that may be null.
*/
public CodeableConcept getSubType() {
return subType;
}
/**
* The individual or organization that published the Contract precursor content.
*
* @return
* An immutable object of type {@link Reference} that may be null.
*/
public Reference getPublisher() {
return publisher;
}
/**
* The date (and optionally time) when the contract was published. The date must change when the business version changes
* and it must change if the status code changes. In addition, it should change when the substantive content of the
* contract changes.
*
* @return
* An immutable object of type {@link DateTime} that may be null.
*/
public DateTime getPublicationDate() {
return publicationDate;
}
/**
* amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy |
* rejected | renewed | revoked | resolved | terminated.
*
* @return
* An immutable object of type {@link ContractPublicationStatus} that is non-null.
*/
public ContractPublicationStatus getPublicationStatus() {
return publicationStatus;
}
/**
* A copyright statement relating to Contract precursor content. Copyright statements are generally legal restrictions on
* the use and publishing of the Contract precursor content.
*
* @return
* An immutable object of type {@link Markdown} that may be null.
*/
public Markdown getCopyright() {
return copyright;
}
@Override
public boolean hasChildren() {
return super.hasChildren() ||
(type != null) ||
(subType != null) ||
(publisher != null) ||
(publicationDate != null) ||
(publicationStatus != null) ||
(copyright != null);
}
@Override
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor) {
if (visitor.preVisit(this)) {
visitor.visitStart(elementName, elementIndex, this);
if (visitor.visit(elementName, elementIndex, this)) {
// visit children
accept(id, "id", visitor);
accept(extension, "extension", visitor, Extension.class);
accept(modifierExtension, "modifierExtension", visitor, Extension.class);
accept(type, "type", visitor);
accept(subType, "subType", visitor);
accept(publisher, "publisher", visitor);
accept(publicationDate, "publicationDate", visitor);
accept(publicationStatus, "publicationStatus", visitor);
accept(copyright, "copyright", visitor);
}
visitor.visitEnd(elementName, elementIndex, this);
visitor.postVisit(this);
}
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
ContentDefinition other = (ContentDefinition) obj;
return Objects.equals(id, other.id) &&
Objects.equals(extension, other.extension) &&
Objects.equals(modifierExtension, other.modifierExtension) &&
Objects.equals(type, other.type) &&
Objects.equals(subType, other.subType) &&
Objects.equals(publisher, other.publisher) &&
Objects.equals(publicationDate, other.publicationDate) &&
Objects.equals(publicationStatus, other.publicationStatus) &&
Objects.equals(copyright, other.copyright);
}
@Override
public int hashCode() {
int result = hashCode;
if (result == 0) {
result = Objects.hash(id,
extension,
modifierExtension,
type,
subType,
publisher,
publicationDate,
publicationStatus,
copyright);
hashCode = result;
}
return result;
}
@Override
public Builder toBuilder() {
return new Builder().from(this);
}
public static Builder builder() {
return new Builder();
}
public static class Builder extends BackboneElement.Builder {
private CodeableConcept type;
private CodeableConcept subType;
private Reference publisher;
private DateTime publicationDate;
private ContractPublicationStatus publicationStatus;
private Markdown copyright;
private Builder() {
super();
}
/**
* Unique id for the element within a resource (for internal references). This may be any string value that does not
* contain spaces.
*
* @param id
* Unique id for inter-element referencing
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder id(java.lang.String id) {
return (Builder) super.id(id);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element. 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
*
* @param extension
* Additional content defined by implementations
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder extension(Extension... extension) {
return (Builder) super.extension(extension);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element. 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
*
* @param extension
* Additional content defined by implementations
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder extension(Collection extension) {
return (Builder) super.extension(extension);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element and that
* modifies the understanding of the element in which it is contained 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 can 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
*
* @param modifierExtension
* Extensions that cannot be ignored even if unrecognized
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder modifierExtension(Extension... modifierExtension) {
return (Builder) super.modifierExtension(modifierExtension);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element and that
* modifies the understanding of the element in which it is contained 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 can 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
*
* @param modifierExtension
* Extensions that cannot be ignored even if unrecognized
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder modifierExtension(Collection modifierExtension) {
return (Builder) super.modifierExtension(modifierExtension);
}
/**
* Precusory content structure and use, i.e., a boilerplate, template, application for a contract such as an insurance
* policy or benefits under a program, e.g., workers compensation.
*
* This element is required.
*
* @param type
* Content structure and use
*
* @return
* A reference to this Builder instance
*/
public Builder type(CodeableConcept type) {
this.type = type;
return this;
}
/**
* Detailed Precusory content type.
*
* @param subType
* Detailed Content Type Definition
*
* @return
* A reference to this Builder instance
*/
public Builder subType(CodeableConcept subType) {
this.subType = subType;
return this;
}
/**
* The individual or organization that published the Contract precursor content.
*
*
Allowed resource types for this reference:
*
* - {@link Practitioner}
* - {@link PractitionerRole}
* - {@link Organization}
*
*
* @param publisher
* Publisher Entity
*
* @return
* A reference to this Builder instance
*/
public Builder publisher(Reference publisher) {
this.publisher = publisher;
return this;
}
/**
* The date (and optionally time) when the contract was published. The date must change when the business version changes
* and it must change if the status code changes. In addition, it should change when the substantive content of the
* contract changes.
*
* @param publicationDate
* When published
*
* @return
* A reference to this Builder instance
*/
public Builder publicationDate(DateTime publicationDate) {
this.publicationDate = publicationDate;
return this;
}
/**
* amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy |
* rejected | renewed | revoked | resolved | terminated.
*
* This element is required.
*
* @param publicationStatus
* amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy |
* rejected | renewed | revoked | resolved | terminated
*
* @return
* A reference to this Builder instance
*/
public Builder publicationStatus(ContractPublicationStatus publicationStatus) {
this.publicationStatus = publicationStatus;
return this;
}
/**
* A copyright statement relating to Contract precursor content. Copyright statements are generally legal restrictions on
* the use and publishing of the Contract precursor content.
*
* @param copyright
* Publication Ownership
*
* @return
* A reference to this Builder instance
*/
public Builder copyright(Markdown copyright) {
this.copyright = copyright;
return this;
}
/**
* Build the {@link ContentDefinition}
*
*
Required elements:
*
* - type
* - publicationStatus
*
*
* @return
* An immutable object of type {@link ContentDefinition}
* @throws IllegalStateException
* if the current state cannot be built into a valid ContentDefinition per the base specification
*/
@Override
public ContentDefinition build() {
ContentDefinition contentDefinition = new ContentDefinition(this);
if (validating) {
validate(contentDefinition);
}
return contentDefinition;
}
protected void validate(ContentDefinition contentDefinition) {
super.validate(contentDefinition);
ValidationSupport.requireNonNull(contentDefinition.type, "type");
ValidationSupport.requireNonNull(contentDefinition.publicationStatus, "publicationStatus");
ValidationSupport.checkReferenceType(contentDefinition.publisher, "publisher", "Practitioner", "PractitionerRole", "Organization");
ValidationSupport.requireValueOrChildren(contentDefinition);
}
protected Builder from(ContentDefinition contentDefinition) {
super.from(contentDefinition);
type = contentDefinition.type;
subType = contentDefinition.subType;
publisher = contentDefinition.publisher;
publicationDate = contentDefinition.publicationDate;
publicationStatus = contentDefinition.publicationStatus;
copyright = contentDefinition.copyright;
return this;
}
}
}
/**
* One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.
*/
public static class Term extends BackboneElement {
@Summary
private final Identifier identifier;
@Summary
private final DateTime issued;
@Summary
private final Period applies;
@Choice({ CodeableConcept.class, Reference.class })
private final Element topic;
@Binding(
bindingName = "ContractTermType",
strength = BindingStrength.Value.EXAMPLE,
description = "Detailed codes for the types of contract provisions.",
valueSet = "http://hl7.org/fhir/ValueSet/contract-term-type"
)
private final CodeableConcept type;
@Binding(
bindingName = "ContractTermSubType",
strength = BindingStrength.Value.EXAMPLE,
description = "Detailed codes for the subtypes of contract provisions.",
valueSet = "http://hl7.org/fhir/ValueSet/contract-term-subtype"
)
private final CodeableConcept subType;
@Summary
private final String text;
private final List securityLabel;
@Required
private final Offer offer;
private final List asset;
private final List action;
private final List group;
private Term(Builder builder) {
super(builder);
identifier = builder.identifier;
issued = builder.issued;
applies = builder.applies;
topic = builder.topic;
type = builder.type;
subType = builder.subType;
text = builder.text;
securityLabel = Collections.unmodifiableList(builder.securityLabel);
offer = builder.offer;
asset = Collections.unmodifiableList(builder.asset);
action = Collections.unmodifiableList(builder.action);
group = Collections.unmodifiableList(builder.group);
}
/**
* Unique identifier for this particular Contract Provision.
*
* @return
* An immutable object of type {@link Identifier} that may be null.
*/
public Identifier getIdentifier() {
return identifier;
}
/**
* When this Contract Provision was issued.
*
* @return
* An immutable object of type {@link DateTime} that may be null.
*/
public DateTime getIssued() {
return issued;
}
/**
* Relevant time or time-period when this Contract Provision is applicable.
*
* @return
* An immutable object of type {@link Period} that may be null.
*/
public Period getApplies() {
return applies;
}
/**
* The entity that the term applies to.
*
* @return
* An immutable object of type {@link Element} that may be null.
*/
public Element getTopic() {
return topic;
}
/**
* A legal clause or condition contained within a contract that requires one or both parties to perform a particular
* requirement by some specified time or prevents one or both parties from performing a particular requirement by some
* specified time.
*
* @return
* An immutable object of type {@link CodeableConcept} that may be null.
*/
public CodeableConcept getType() {
return type;
}
/**
* A specialized legal clause or condition based on overarching contract type.
*
* @return
* An immutable object of type {@link CodeableConcept} that may be null.
*/
public CodeableConcept getSubType() {
return subType;
}
/**
* Statement of a provision in a policy or a contract.
*
* @return
* An immutable object of type {@link String} that may be null.
*/
public String getText() {
return text;
}
/**
* Security labels that protect the handling of information about the term and its elements, which may be specifically
* identified..
*
* @return
* An unmodifiable list containing immutable objects of type {@link SecurityLabel} that may be empty.
*/
public List getSecurityLabel() {
return securityLabel;
}
/**
* The matter of concern in the context of this provision of the agrement.
*
* @return
* An immutable object of type {@link Offer} that is non-null.
*/
public Offer getOffer() {
return offer;
}
/**
* Contract Term Asset List.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Asset} that may be empty.
*/
public List getAsset() {
return asset;
}
/**
* An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity
* taking place.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Action} that may be empty.
*/
public List getAction() {
return action;
}
/**
* Nested group of Contract Provisions.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Term} that may be empty.
*/
public List getGroup() {
return group;
}
@Override
public boolean hasChildren() {
return super.hasChildren() ||
(identifier != null) ||
(issued != null) ||
(applies != null) ||
(topic != null) ||
(type != null) ||
(subType != null) ||
(text != null) ||
!securityLabel.isEmpty() ||
(offer != null) ||
!asset.isEmpty() ||
!action.isEmpty() ||
!group.isEmpty();
}
@Override
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor) {
if (visitor.preVisit(this)) {
visitor.visitStart(elementName, elementIndex, this);
if (visitor.visit(elementName, elementIndex, this)) {
// visit children
accept(id, "id", visitor);
accept(extension, "extension", visitor, Extension.class);
accept(modifierExtension, "modifierExtension", visitor, Extension.class);
accept(identifier, "identifier", visitor);
accept(issued, "issued", visitor);
accept(applies, "applies", visitor);
accept(topic, "topic", visitor);
accept(type, "type", visitor);
accept(subType, "subType", visitor);
accept(text, "text", visitor);
accept(securityLabel, "securityLabel", visitor, SecurityLabel.class);
accept(offer, "offer", visitor);
accept(asset, "asset", visitor, Asset.class);
accept(action, "action", visitor, Action.class);
accept(group, "group", visitor, Contract.Term.class);
}
visitor.visitEnd(elementName, elementIndex, this);
visitor.postVisit(this);
}
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
Term other = (Term) obj;
return Objects.equals(id, other.id) &&
Objects.equals(extension, other.extension) &&
Objects.equals(modifierExtension, other.modifierExtension) &&
Objects.equals(identifier, other.identifier) &&
Objects.equals(issued, other.issued) &&
Objects.equals(applies, other.applies) &&
Objects.equals(topic, other.topic) &&
Objects.equals(type, other.type) &&
Objects.equals(subType, other.subType) &&
Objects.equals(text, other.text) &&
Objects.equals(securityLabel, other.securityLabel) &&
Objects.equals(offer, other.offer) &&
Objects.equals(asset, other.asset) &&
Objects.equals(action, other.action) &&
Objects.equals(group, other.group);
}
@Override
public int hashCode() {
int result = hashCode;
if (result == 0) {
result = Objects.hash(id,
extension,
modifierExtension,
identifier,
issued,
applies,
topic,
type,
subType,
text,
securityLabel,
offer,
asset,
action,
group);
hashCode = result;
}
return result;
}
@Override
public Builder toBuilder() {
return new Builder().from(this);
}
public static Builder builder() {
return new Builder();
}
public static class Builder extends BackboneElement.Builder {
private Identifier identifier;
private DateTime issued;
private Period applies;
private Element topic;
private CodeableConcept type;
private CodeableConcept subType;
private String text;
private List securityLabel = new ArrayList<>();
private Offer offer;
private List asset = new ArrayList<>();
private List action = new ArrayList<>();
private List group = new ArrayList<>();
private Builder() {
super();
}
/**
* Unique id for the element within a resource (for internal references). This may be any string value that does not
* contain spaces.
*
* @param id
* Unique id for inter-element referencing
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder id(java.lang.String id) {
return (Builder) super.id(id);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element. 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
*
* @param extension
* Additional content defined by implementations
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder extension(Extension... extension) {
return (Builder) super.extension(extension);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element. 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
*
* @param extension
* Additional content defined by implementations
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder extension(Collection extension) {
return (Builder) super.extension(extension);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element and that
* modifies the understanding of the element in which it is contained 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 can 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
*
* @param modifierExtension
* Extensions that cannot be ignored even if unrecognized
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder modifierExtension(Extension... modifierExtension) {
return (Builder) super.modifierExtension(modifierExtension);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element and that
* modifies the understanding of the element in which it is contained 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 can 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
*
* @param modifierExtension
* Extensions that cannot be ignored even if unrecognized
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder modifierExtension(Collection modifierExtension) {
return (Builder) super.modifierExtension(modifierExtension);
}
/**
* Unique identifier for this particular Contract Provision.
*
* @param identifier
* Contract Term Number
*
* @return
* A reference to this Builder instance
*/
public Builder identifier(Identifier identifier) {
this.identifier = identifier;
return this;
}
/**
* When this Contract Provision was issued.
*
* @param issued
* Contract Term Issue Date Time
*
* @return
* A reference to this Builder instance
*/
public Builder issued(DateTime issued) {
this.issued = issued;
return this;
}
/**
* Relevant time or time-period when this Contract Provision is applicable.
*
* @param applies
* Contract Term Effective Time
*
* @return
* A reference to this Builder instance
*/
public Builder applies(Period applies) {
this.applies = applies;
return this;
}
/**
* The entity that the term applies to.
*
* This is a choice element with the following allowed types:
*
* - {@link CodeableConcept}
* - {@link Reference}
*
*
* @param topic
* Term Concern
*
* @return
* A reference to this Builder instance
*/
public Builder topic(Element topic) {
this.topic = topic;
return this;
}
/**
* A legal clause or condition contained within a contract that requires one or both parties to perform a particular
* requirement by some specified time or prevents one or both parties from performing a particular requirement by some
* specified time.
*
* @param type
* Contract Term Type or Form
*
* @return
* A reference to this Builder instance
*/
public Builder type(CodeableConcept type) {
this.type = type;
return this;
}
/**
* A specialized legal clause or condition based on overarching contract type.
*
* @param subType
* Contract Term Type specific classification
*
* @return
* A reference to this Builder instance
*/
public Builder subType(CodeableConcept subType) {
this.subType = subType;
return this;
}
/**
* Statement of a provision in a policy or a contract.
*
* @param text
* Term Statement
*
* @return
* A reference to this Builder instance
*/
public Builder text(String text) {
this.text = text;
return this;
}
/**
* Security labels that protect the handling of information about the term and its elements, which may be specifically
* identified..
*
* Adds new element(s) to the existing list
*
* @param securityLabel
* Protection for the Term
*
* @return
* A reference to this Builder instance
*/
public Builder securityLabel(SecurityLabel... securityLabel) {
for (SecurityLabel value : securityLabel) {
this.securityLabel.add(value);
}
return this;
}
/**
* Security labels that protect the handling of information about the term and its elements, which may be specifically
* identified..
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param securityLabel
* Protection for the Term
*
* @return
* A reference to this Builder instance
*/
public Builder securityLabel(Collection securityLabel) {
this.securityLabel = new ArrayList<>(securityLabel);
return this;
}
/**
* The matter of concern in the context of this provision of the agrement.
*
* This element is required.
*
* @param offer
* Context of the Contract term
*
* @return
* A reference to this Builder instance
*/
public Builder offer(Offer offer) {
this.offer = offer;
return this;
}
/**
* Contract Term Asset List.
*
*
Adds new element(s) to the existing list
*
* @param asset
* Contract Term Asset List
*
* @return
* A reference to this Builder instance
*/
public Builder asset(Asset... asset) {
for (Asset value : asset) {
this.asset.add(value);
}
return this;
}
/**
* Contract Term Asset List.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param asset
* Contract Term Asset List
*
* @return
* A reference to this Builder instance
*/
public Builder asset(Collection asset) {
this.asset = new ArrayList<>(asset);
return this;
}
/**
* An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity
* taking place.
*
* Adds new element(s) to the existing list
*
* @param action
* Entity being ascribed responsibility
*
* @return
* A reference to this Builder instance
*/
public Builder action(Action... action) {
for (Action value : action) {
this.action.add(value);
}
return this;
}
/**
* An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity
* taking place.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param action
* Entity being ascribed responsibility
*
* @return
* A reference to this Builder instance
*/
public Builder action(Collection action) {
this.action = new ArrayList<>(action);
return this;
}
/**
* Nested group of Contract Provisions.
*
* Adds new element(s) to the existing list
*
* @param group
* Nested Contract Term Group
*
* @return
* A reference to this Builder instance
*/
public Builder group(Contract.Term... group) {
for (Contract.Term value : group) {
this.group.add(value);
}
return this;
}
/**
* Nested group of Contract Provisions.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param group
* Nested Contract Term Group
*
* @return
* A reference to this Builder instance
*/
public Builder group(Collection group) {
this.group = new ArrayList<>(group);
return this;
}
/**
* Build the {@link Term}
*
* Required elements:
*
* - offer
*
*
* @return
* An immutable object of type {@link Term}
* @throws IllegalStateException
* if the current state cannot be built into a valid Term per the base specification
*/
@Override
public Term build() {
Term term = new Term(this);
if (validating) {
validate(term);
}
return term;
}
protected void validate(Term term) {
super.validate(term);
ValidationSupport.choiceElement(term.topic, "topic", CodeableConcept.class, Reference.class);
ValidationSupport.checkList(term.securityLabel, "securityLabel", SecurityLabel.class);
ValidationSupport.requireNonNull(term.offer, "offer");
ValidationSupport.checkList(term.asset, "asset", Asset.class);
ValidationSupport.checkList(term.action, "action", Action.class);
ValidationSupport.checkList(term.group, "group", Contract.Term.class);
ValidationSupport.requireValueOrChildren(term);
}
protected Builder from(Term term) {
super.from(term);
identifier = term.identifier;
issued = term.issued;
applies = term.applies;
topic = term.topic;
type = term.type;
subType = term.subType;
text = term.text;
securityLabel.addAll(term.securityLabel);
offer = term.offer;
asset.addAll(term.asset);
action.addAll(term.action);
group.addAll(term.group);
return this;
}
}
/**
* Security labels that protect the handling of information about the term and its elements, which may be specifically
* identified..
*/
public static class SecurityLabel extends BackboneElement {
private final List number;
@Binding(
bindingName = "ContractSecurityClassification",
strength = BindingStrength.Value.EXAMPLE,
description = "Codes for confidentiality protection.",
valueSet = "http://hl7.org/fhir/ValueSet/contract-security-classification"
)
@Required
private final Coding classification;
@Binding(
bindingName = "ContractSecurityCategory",
strength = BindingStrength.Value.EXAMPLE,
description = "Codes for policy category.",
valueSet = "http://hl7.org/fhir/ValueSet/contract-security-category"
)
private final List category;
@Binding(
bindingName = "ContractSecurityControl",
strength = BindingStrength.Value.EXAMPLE,
description = "Codes for handling instructions.",
valueSet = "http://hl7.org/fhir/ValueSet/contract-security-control"
)
private final List control;
private SecurityLabel(Builder builder) {
super(builder);
number = Collections.unmodifiableList(builder.number);
classification = builder.classification;
category = Collections.unmodifiableList(builder.category);
control = Collections.unmodifiableList(builder.control);
}
/**
* Number used to link this term or term element to the applicable Security Label.
*
* @return
* An unmodifiable list containing immutable objects of type {@link UnsignedInt} that may be empty.
*/
public List getNumber() {
return number;
}
/**
* Security label privacy tag that species the level of confidentiality protection required for this term and/or term
* elements.
*
* @return
* An immutable object of type {@link Coding} that is non-null.
*/
public Coding getClassification() {
return classification;
}
/**
* Security label privacy tag that species the applicable privacy and security policies governing this term and/or term
* elements.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Coding} that may be empty.
*/
public List getCategory() {
return category;
}
/**
* Security label privacy tag that species the manner in which term and/or term elements are to be protected.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Coding} that may be empty.
*/
public List getControl() {
return control;
}
@Override
public boolean hasChildren() {
return super.hasChildren() ||
!number.isEmpty() ||
(classification != null) ||
!category.isEmpty() ||
!control.isEmpty();
}
@Override
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor) {
if (visitor.preVisit(this)) {
visitor.visitStart(elementName, elementIndex, this);
if (visitor.visit(elementName, elementIndex, this)) {
// visit children
accept(id, "id", visitor);
accept(extension, "extension", visitor, Extension.class);
accept(modifierExtension, "modifierExtension", visitor, Extension.class);
accept(number, "number", visitor, UnsignedInt.class);
accept(classification, "classification", visitor);
accept(category, "category", visitor, Coding.class);
accept(control, "control", visitor, Coding.class);
}
visitor.visitEnd(elementName, elementIndex, this);
visitor.postVisit(this);
}
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
SecurityLabel other = (SecurityLabel) obj;
return Objects.equals(id, other.id) &&
Objects.equals(extension, other.extension) &&
Objects.equals(modifierExtension, other.modifierExtension) &&
Objects.equals(number, other.number) &&
Objects.equals(classification, other.classification) &&
Objects.equals(category, other.category) &&
Objects.equals(control, other.control);
}
@Override
public int hashCode() {
int result = hashCode;
if (result == 0) {
result = Objects.hash(id,
extension,
modifierExtension,
number,
classification,
category,
control);
hashCode = result;
}
return result;
}
@Override
public Builder toBuilder() {
return new Builder().from(this);
}
public static Builder builder() {
return new Builder();
}
public static class Builder extends BackboneElement.Builder {
private List number = new ArrayList<>();
private Coding classification;
private List category = new ArrayList<>();
private List control = new ArrayList<>();
private Builder() {
super();
}
/**
* Unique id for the element within a resource (for internal references). This may be any string value that does not
* contain spaces.
*
* @param id
* Unique id for inter-element referencing
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder id(java.lang.String id) {
return (Builder) super.id(id);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element. 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
*
* @param extension
* Additional content defined by implementations
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder extension(Extension... extension) {
return (Builder) super.extension(extension);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element. 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
*
* @param extension
* Additional content defined by implementations
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder extension(Collection extension) {
return (Builder) super.extension(extension);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element and that
* modifies the understanding of the element in which it is contained 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 can 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
*
* @param modifierExtension
* Extensions that cannot be ignored even if unrecognized
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder modifierExtension(Extension... modifierExtension) {
return (Builder) super.modifierExtension(modifierExtension);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element and that
* modifies the understanding of the element in which it is contained 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 can 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
*
* @param modifierExtension
* Extensions that cannot be ignored even if unrecognized
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder modifierExtension(Collection modifierExtension) {
return (Builder) super.modifierExtension(modifierExtension);
}
/**
* Number used to link this term or term element to the applicable Security Label.
*
* Adds new element(s) to the existing list
*
* @param number
* Link to Security Labels
*
* @return
* A reference to this Builder instance
*/
public Builder number(UnsignedInt... number) {
for (UnsignedInt value : number) {
this.number.add(value);
}
return this;
}
/**
* Number used to link this term or term element to the applicable Security Label.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param number
* Link to Security Labels
*
* @return
* A reference to this Builder instance
*/
public Builder number(Collection number) {
this.number = new ArrayList<>(number);
return this;
}
/**
* Security label privacy tag that species the level of confidentiality protection required for this term and/or term
* elements.
*
* This element is required.
*
* @param classification
* Confidentiality Protection
*
* @return
* A reference to this Builder instance
*/
public Builder classification(Coding classification) {
this.classification = classification;
return this;
}
/**
* Security label privacy tag that species the applicable privacy and security policies governing this term and/or term
* elements.
*
*
Adds new element(s) to the existing list
*
* @param category
* Applicable Policy
*
* @return
* A reference to this Builder instance
*/
public Builder category(Coding... category) {
for (Coding value : category) {
this.category.add(value);
}
return this;
}
/**
* Security label privacy tag that species the applicable privacy and security policies governing this term and/or term
* elements.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param category
* Applicable Policy
*
* @return
* A reference to this Builder instance
*/
public Builder category(Collection category) {
this.category = new ArrayList<>(category);
return this;
}
/**
* Security label privacy tag that species the manner in which term and/or term elements are to be protected.
*
* Adds new element(s) to the existing list
*
* @param control
* Handling Instructions
*
* @return
* A reference to this Builder instance
*/
public Builder control(Coding... control) {
for (Coding value : control) {
this.control.add(value);
}
return this;
}
/**
* Security label privacy tag that species the manner in which term and/or term elements are to be protected.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param control
* Handling Instructions
*
* @return
* A reference to this Builder instance
*/
public Builder control(Collection control) {
this.control = new ArrayList<>(control);
return this;
}
/**
* Build the {@link SecurityLabel}
*
* Required elements:
*
* - classification
*
*
* @return
* An immutable object of type {@link SecurityLabel}
* @throws IllegalStateException
* if the current state cannot be built into a valid SecurityLabel per the base specification
*/
@Override
public SecurityLabel build() {
SecurityLabel securityLabel = new SecurityLabel(this);
if (validating) {
validate(securityLabel);
}
return securityLabel;
}
protected void validate(SecurityLabel securityLabel) {
super.validate(securityLabel);
ValidationSupport.checkList(securityLabel.number, "number", UnsignedInt.class);
ValidationSupport.requireNonNull(securityLabel.classification, "classification");
ValidationSupport.checkList(securityLabel.category, "category", Coding.class);
ValidationSupport.checkList(securityLabel.control, "control", Coding.class);
ValidationSupport.requireValueOrChildren(securityLabel);
}
protected Builder from(SecurityLabel securityLabel) {
super.from(securityLabel);
number.addAll(securityLabel.number);
classification = securityLabel.classification;
category.addAll(securityLabel.category);
control.addAll(securityLabel.control);
return this;
}
}
}
/**
* The matter of concern in the context of this provision of the agrement.
*/
public static class Offer extends BackboneElement {
private final List identifier;
private final List party;
@Summary
private final Reference topic;
@Binding(
bindingName = "ContractTermType",
strength = BindingStrength.Value.EXAMPLE,
description = "Detailed codes for the types of contract provisions.",
valueSet = "http://hl7.org/fhir/ValueSet/contract-term-type"
)
private final CodeableConcept type;
@Binding(
bindingName = "ContractDecisionType",
strength = BindingStrength.Value.EXTENSIBLE,
description = "The type of decision made by a grantor with respect to an offer made by a grantee.",
valueSet = "http://terminology.hl7.org/ValueSet/v3-ActConsentDirective"
)
private final CodeableConcept decision;
@Binding(
bindingName = "ContractDecisionMode",
strength = BindingStrength.Value.EXAMPLE,
description = "Codes for conveying a decision.",
valueSet = "http://hl7.org/fhir/ValueSet/contract-decision-mode"
)
private final List decisionMode;
private final List answer;
private final String text;
private final List linkId;
private final List securityLabelNumber;
private Offer(Builder builder) {
super(builder);
identifier = Collections.unmodifiableList(builder.identifier);
party = Collections.unmodifiableList(builder.party);
topic = builder.topic;
type = builder.type;
decision = builder.decision;
decisionMode = Collections.unmodifiableList(builder.decisionMode);
answer = Collections.unmodifiableList(builder.answer);
text = builder.text;
linkId = Collections.unmodifiableList(builder.linkId);
securityLabelNumber = Collections.unmodifiableList(builder.securityLabelNumber);
}
/**
* Unique identifier for this particular Contract Provision.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Identifier} that may be empty.
*/
public List getIdentifier() {
return identifier;
}
/**
* Offer Recipient.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Party} that may be empty.
*/
public List getParty() {
return party;
}
/**
* The owner of an asset has the residual control rights over the asset: the right to decide all usages of the asset in
* any way not inconsistent with a prior contract, custom, or law (Hart, 1995, p. 30).
*
* @return
* An immutable object of type {@link Reference} that may be null.
*/
public Reference getTopic() {
return topic;
}
/**
* Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life
* time maximum benefit.
*
* @return
* An immutable object of type {@link CodeableConcept} that may be null.
*/
public CodeableConcept getType() {
return type;
}
/**
* Type of choice made by accepting party with respect to an offer made by an offeror/ grantee.
*
* @return
* An immutable object of type {@link CodeableConcept} that may be null.
*/
public CodeableConcept getDecision() {
return decision;
}
/**
* How the decision about a Contract was conveyed.
*
* @return
* An unmodifiable list containing immutable objects of type {@link CodeableConcept} that may be empty.
*/
public List getDecisionMode() {
return decisionMode;
}
/**
* Response to offer text.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Answer} that may be empty.
*/
public List getAnswer() {
return answer;
}
/**
* Human readable form of this Contract Offer.
*
* @return
* An immutable object of type {@link String} that may be null.
*/
public String getText() {
return text;
}
/**
* The id of the clause or question text of the offer in the referenced questionnaire/response.
*
* @return
* An unmodifiable list containing immutable objects of type {@link String} that may be empty.
*/
public List getLinkId() {
return linkId;
}
/**
* Security labels that protects the offer.
*
* @return
* An unmodifiable list containing immutable objects of type {@link UnsignedInt} that may be empty.
*/
public List getSecurityLabelNumber() {
return securityLabelNumber;
}
@Override
public boolean hasChildren() {
return super.hasChildren() ||
!identifier.isEmpty() ||
!party.isEmpty() ||
(topic != null) ||
(type != null) ||
(decision != null) ||
!decisionMode.isEmpty() ||
!answer.isEmpty() ||
(text != null) ||
!linkId.isEmpty() ||
!securityLabelNumber.isEmpty();
}
@Override
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor) {
if (visitor.preVisit(this)) {
visitor.visitStart(elementName, elementIndex, this);
if (visitor.visit(elementName, elementIndex, this)) {
// visit children
accept(id, "id", visitor);
accept(extension, "extension", visitor, Extension.class);
accept(modifierExtension, "modifierExtension", visitor, Extension.class);
accept(identifier, "identifier", visitor, Identifier.class);
accept(party, "party", visitor, Party.class);
accept(topic, "topic", visitor);
accept(type, "type", visitor);
accept(decision, "decision", visitor);
accept(decisionMode, "decisionMode", visitor, CodeableConcept.class);
accept(answer, "answer", visitor, Answer.class);
accept(text, "text", visitor);
accept(linkId, "linkId", visitor, String.class);
accept(securityLabelNumber, "securityLabelNumber", visitor, UnsignedInt.class);
}
visitor.visitEnd(elementName, elementIndex, this);
visitor.postVisit(this);
}
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
Offer other = (Offer) obj;
return Objects.equals(id, other.id) &&
Objects.equals(extension, other.extension) &&
Objects.equals(modifierExtension, other.modifierExtension) &&
Objects.equals(identifier, other.identifier) &&
Objects.equals(party, other.party) &&
Objects.equals(topic, other.topic) &&
Objects.equals(type, other.type) &&
Objects.equals(decision, other.decision) &&
Objects.equals(decisionMode, other.decisionMode) &&
Objects.equals(answer, other.answer) &&
Objects.equals(text, other.text) &&
Objects.equals(linkId, other.linkId) &&
Objects.equals(securityLabelNumber, other.securityLabelNumber);
}
@Override
public int hashCode() {
int result = hashCode;
if (result == 0) {
result = Objects.hash(id,
extension,
modifierExtension,
identifier,
party,
topic,
type,
decision,
decisionMode,
answer,
text,
linkId,
securityLabelNumber);
hashCode = result;
}
return result;
}
@Override
public Builder toBuilder() {
return new Builder().from(this);
}
public static Builder builder() {
return new Builder();
}
public static class Builder extends BackboneElement.Builder {
private List identifier = new ArrayList<>();
private List party = new ArrayList<>();
private Reference topic;
private CodeableConcept type;
private CodeableConcept decision;
private List decisionMode = new ArrayList<>();
private List answer = new ArrayList<>();
private String text;
private List linkId = new ArrayList<>();
private List securityLabelNumber = new ArrayList<>();
private Builder() {
super();
}
/**
* Unique id for the element within a resource (for internal references). This may be any string value that does not
* contain spaces.
*
* @param id
* Unique id for inter-element referencing
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder id(java.lang.String id) {
return (Builder) super.id(id);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element. 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
*
* @param extension
* Additional content defined by implementations
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder extension(Extension... extension) {
return (Builder) super.extension(extension);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element. 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
*
* @param extension
* Additional content defined by implementations
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder extension(Collection extension) {
return (Builder) super.extension(extension);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element and that
* modifies the understanding of the element in which it is contained 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 can 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
*
* @param modifierExtension
* Extensions that cannot be ignored even if unrecognized
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder modifierExtension(Extension... modifierExtension) {
return (Builder) super.modifierExtension(modifierExtension);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element and that
* modifies the understanding of the element in which it is contained 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 can 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
*
* @param modifierExtension
* Extensions that cannot be ignored even if unrecognized
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder modifierExtension(Collection modifierExtension) {
return (Builder) super.modifierExtension(modifierExtension);
}
/**
* Unique identifier for this particular Contract Provision.
*
* Adds new element(s) to the existing list
*
* @param identifier
* Offer business ID
*
* @return
* A reference to this Builder instance
*/
public Builder identifier(Identifier... identifier) {
for (Identifier value : identifier) {
this.identifier.add(value);
}
return this;
}
/**
* Unique identifier for this particular Contract Provision.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param identifier
* Offer business ID
*
* @return
* A reference to this Builder instance
*/
public Builder identifier(Collection identifier) {
this.identifier = new ArrayList<>(identifier);
return this;
}
/**
* Offer Recipient.
*
* Adds new element(s) to the existing list
*
* @param party
* Offer Recipient
*
* @return
* A reference to this Builder instance
*/
public Builder party(Party... party) {
for (Party value : party) {
this.party.add(value);
}
return this;
}
/**
* Offer Recipient.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param party
* Offer Recipient
*
* @return
* A reference to this Builder instance
*/
public Builder party(Collection party) {
this.party = new ArrayList<>(party);
return this;
}
/**
* The owner of an asset has the residual control rights over the asset: the right to decide all usages of the asset in
* any way not inconsistent with a prior contract, custom, or law (Hart, 1995, p. 30).
*
* @param topic
* Negotiable offer asset
*
* @return
* A reference to this Builder instance
*/
public Builder topic(Reference topic) {
this.topic = topic;
return this;
}
/**
* Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life
* time maximum benefit.
*
* @param type
* Contract Offer Type or Form
*
* @return
* A reference to this Builder instance
*/
public Builder type(CodeableConcept type) {
this.type = type;
return this;
}
/**
* Type of choice made by accepting party with respect to an offer made by an offeror/ grantee.
*
* @param decision
* Accepting party choice
*
* @return
* A reference to this Builder instance
*/
public Builder decision(CodeableConcept decision) {
this.decision = decision;
return this;
}
/**
* How the decision about a Contract was conveyed.
*
* Adds new element(s) to the existing list
*
* @param decisionMode
* How decision is conveyed
*
* @return
* A reference to this Builder instance
*/
public Builder decisionMode(CodeableConcept... decisionMode) {
for (CodeableConcept value : decisionMode) {
this.decisionMode.add(value);
}
return this;
}
/**
* How the decision about a Contract was conveyed.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param decisionMode
* How decision is conveyed
*
* @return
* A reference to this Builder instance
*/
public Builder decisionMode(Collection decisionMode) {
this.decisionMode = new ArrayList<>(decisionMode);
return this;
}
/**
* Response to offer text.
*
* Adds new element(s) to the existing list
*
* @param answer
* Response to offer text
*
* @return
* A reference to this Builder instance
*/
public Builder answer(Answer... answer) {
for (Answer value : answer) {
this.answer.add(value);
}
return this;
}
/**
* Response to offer text.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param answer
* Response to offer text
*
* @return
* A reference to this Builder instance
*/
public Builder answer(Collection answer) {
this.answer = new ArrayList<>(answer);
return this;
}
/**
* Human readable form of this Contract Offer.
*
* @param text
* Human readable offer text
*
* @return
* A reference to this Builder instance
*/
public Builder text(String text) {
this.text = text;
return this;
}
/**
* The id of the clause or question text of the offer in the referenced questionnaire/response.
*
* Adds new element(s) to the existing list
*
* @param linkId
* Pointer to text
*
* @return
* A reference to this Builder instance
*/
public Builder linkId(String... linkId) {
for (String value : linkId) {
this.linkId.add(value);
}
return this;
}
/**
* The id of the clause or question text of the offer in the referenced questionnaire/response.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param linkId
* Pointer to text
*
* @return
* A reference to this Builder instance
*/
public Builder linkId(Collection linkId) {
this.linkId = new ArrayList<>(linkId);
return this;
}
/**
* Security labels that protects the offer.
*
* Adds new element(s) to the existing list
*
* @param securityLabelNumber
* Offer restriction numbers
*
* @return
* A reference to this Builder instance
*/
public Builder securityLabelNumber(UnsignedInt... securityLabelNumber) {
for (UnsignedInt value : securityLabelNumber) {
this.securityLabelNumber.add(value);
}
return this;
}
/**
* Security labels that protects the offer.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param securityLabelNumber
* Offer restriction numbers
*
* @return
* A reference to this Builder instance
*/
public Builder securityLabelNumber(Collection securityLabelNumber) {
this.securityLabelNumber = new ArrayList<>(securityLabelNumber);
return this;
}
/**
* Build the {@link Offer}
*
* @return
* An immutable object of type {@link Offer}
* @throws IllegalStateException
* if the current state cannot be built into a valid Offer per the base specification
*/
@Override
public Offer build() {
Offer offer = new Offer(this);
if (validating) {
validate(offer);
}
return offer;
}
protected void validate(Offer offer) {
super.validate(offer);
ValidationSupport.checkList(offer.identifier, "identifier", Identifier.class);
ValidationSupport.checkList(offer.party, "party", Party.class);
ValidationSupport.checkList(offer.decisionMode, "decisionMode", CodeableConcept.class);
ValidationSupport.checkList(offer.answer, "answer", Answer.class);
ValidationSupport.checkList(offer.linkId, "linkId", String.class);
ValidationSupport.checkList(offer.securityLabelNumber, "securityLabelNumber", UnsignedInt.class);
ValidationSupport.requireValueOrChildren(offer);
}
protected Builder from(Offer offer) {
super.from(offer);
identifier.addAll(offer.identifier);
party.addAll(offer.party);
topic = offer.topic;
type = offer.type;
decision = offer.decision;
decisionMode.addAll(offer.decisionMode);
answer.addAll(offer.answer);
text = offer.text;
linkId.addAll(offer.linkId);
securityLabelNumber.addAll(offer.securityLabelNumber);
return this;
}
}
/**
* Offer Recipient.
*/
public static class Party extends BackboneElement {
@ReferenceTarget({ "Patient", "RelatedPerson", "Practitioner", "PractitionerRole", "Device", "Group", "Organization" })
@Required
private final List reference;
@Binding(
bindingName = "ContractPartyRole",
strength = BindingStrength.Value.EXAMPLE,
description = "Codes for offer participant roles.",
valueSet = "http://hl7.org/fhir/ValueSet/contract-party-role"
)
@Required
private final CodeableConcept role;
private Party(Builder builder) {
super(builder);
reference = Collections.unmodifiableList(builder.reference);
role = builder.role;
}
/**
* Participant in the offer.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Reference} that is non-empty.
*/
public List getReference() {
return reference;
}
/**
* How the party participates in the offer.
*
* @return
* An immutable object of type {@link CodeableConcept} that is non-null.
*/
public CodeableConcept getRole() {
return role;
}
@Override
public boolean hasChildren() {
return super.hasChildren() ||
!reference.isEmpty() ||
(role != null);
}
@Override
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor) {
if (visitor.preVisit(this)) {
visitor.visitStart(elementName, elementIndex, this);
if (visitor.visit(elementName, elementIndex, this)) {
// visit children
accept(id, "id", visitor);
accept(extension, "extension", visitor, Extension.class);
accept(modifierExtension, "modifierExtension", visitor, Extension.class);
accept(reference, "reference", visitor, Reference.class);
accept(role, "role", visitor);
}
visitor.visitEnd(elementName, elementIndex, this);
visitor.postVisit(this);
}
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
Party other = (Party) obj;
return Objects.equals(id, other.id) &&
Objects.equals(extension, other.extension) &&
Objects.equals(modifierExtension, other.modifierExtension) &&
Objects.equals(reference, other.reference) &&
Objects.equals(role, other.role);
}
@Override
public int hashCode() {
int result = hashCode;
if (result == 0) {
result = Objects.hash(id,
extension,
modifierExtension,
reference,
role);
hashCode = result;
}
return result;
}
@Override
public Builder toBuilder() {
return new Builder().from(this);
}
public static Builder builder() {
return new Builder();
}
public static class Builder extends BackboneElement.Builder {
private List reference = new ArrayList<>();
private CodeableConcept role;
private Builder() {
super();
}
/**
* Unique id for the element within a resource (for internal references). This may be any string value that does not
* contain spaces.
*
* @param id
* Unique id for inter-element referencing
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder id(java.lang.String id) {
return (Builder) super.id(id);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element. 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
*
* @param extension
* Additional content defined by implementations
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder extension(Extension... extension) {
return (Builder) super.extension(extension);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element. 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
*
* @param extension
* Additional content defined by implementations
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder extension(Collection extension) {
return (Builder) super.extension(extension);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element and that
* modifies the understanding of the element in which it is contained 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 can 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
*
* @param modifierExtension
* Extensions that cannot be ignored even if unrecognized
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder modifierExtension(Extension... modifierExtension) {
return (Builder) super.modifierExtension(modifierExtension);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element and that
* modifies the understanding of the element in which it is contained 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 can 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
*
* @param modifierExtension
* Extensions that cannot be ignored even if unrecognized
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder modifierExtension(Collection modifierExtension) {
return (Builder) super.modifierExtension(modifierExtension);
}
/**
* Participant in the offer.
*
* Adds new element(s) to the existing list
*
*
This element is required.
*
*
Allowed resource types for the references:
*
* - {@link Patient}
* - {@link RelatedPerson}
* - {@link Practitioner}
* - {@link PractitionerRole}
* - {@link Device}
* - {@link Group}
* - {@link Organization}
*
*
* @param reference
* Referenced entity
*
* @return
* A reference to this Builder instance
*/
public Builder reference(Reference... reference) {
for (Reference value : reference) {
this.reference.add(value);
}
return this;
}
/**
* Participant in the offer.
*
* Replaces the existing list with a new one containing elements from the Collection
*
*
This element is required.
*
*
Allowed resource types for the references:
*
* - {@link Patient}
* - {@link RelatedPerson}
* - {@link Practitioner}
* - {@link PractitionerRole}
* - {@link Device}
* - {@link Group}
* - {@link Organization}
*
*
* @param reference
* Referenced entity
*
* @return
* A reference to this Builder instance
*/
public Builder reference(Collection reference) {
this.reference = new ArrayList<>(reference);
return this;
}
/**
* How the party participates in the offer.
*
* This element is required.
*
* @param role
* Participant engagement type
*
* @return
* A reference to this Builder instance
*/
public Builder role(CodeableConcept role) {
this.role = role;
return this;
}
/**
* Build the {@link Party}
*
*
Required elements:
*
* - reference
* - role
*
*
* @return
* An immutable object of type {@link Party}
* @throws IllegalStateException
* if the current state cannot be built into a valid Party per the base specification
*/
@Override
public Party build() {
Party party = new Party(this);
if (validating) {
validate(party);
}
return party;
}
protected void validate(Party party) {
super.validate(party);
ValidationSupport.checkNonEmptyList(party.reference, "reference", Reference.class);
ValidationSupport.requireNonNull(party.role, "role");
ValidationSupport.checkReferenceType(party.reference, "reference", "Patient", "RelatedPerson", "Practitioner", "PractitionerRole", "Device", "Group", "Organization");
ValidationSupport.requireValueOrChildren(party);
}
protected Builder from(Party party) {
super.from(party);
reference.addAll(party.reference);
role = party.role;
return this;
}
}
}
/**
* Response to offer text.
*/
public static class Answer extends BackboneElement {
@Choice({ Boolean.class, Decimal.class, Integer.class, Date.class, DateTime.class, Time.class, String.class, Uri.class, Attachment.class, Coding.class, Quantity.class, Reference.class })
@Required
private final Element value;
private Answer(Builder builder) {
super(builder);
value = builder.value;
}
/**
* Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of
* participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further
* research.
*
* @return
* An immutable object of type {@link Element} that is non-null.
*/
public Element getValue() {
return value;
}
@Override
public boolean hasChildren() {
return super.hasChildren() ||
(value != null);
}
@Override
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor) {
if (visitor.preVisit(this)) {
visitor.visitStart(elementName, elementIndex, this);
if (visitor.visit(elementName, elementIndex, this)) {
// visit children
accept(id, "id", visitor);
accept(extension, "extension", visitor, Extension.class);
accept(modifierExtension, "modifierExtension", visitor, Extension.class);
accept(value, "value", visitor);
}
visitor.visitEnd(elementName, elementIndex, this);
visitor.postVisit(this);
}
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
Answer other = (Answer) obj;
return Objects.equals(id, other.id) &&
Objects.equals(extension, other.extension) &&
Objects.equals(modifierExtension, other.modifierExtension) &&
Objects.equals(value, other.value);
}
@Override
public int hashCode() {
int result = hashCode;
if (result == 0) {
result = Objects.hash(id,
extension,
modifierExtension,
value);
hashCode = result;
}
return result;
}
@Override
public Builder toBuilder() {
return new Builder().from(this);
}
public static Builder builder() {
return new Builder();
}
public static class Builder extends BackboneElement.Builder {
private Element value;
private Builder() {
super();
}
/**
* Unique id for the element within a resource (for internal references). This may be any string value that does not
* contain spaces.
*
* @param id
* Unique id for inter-element referencing
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder id(java.lang.String id) {
return (Builder) super.id(id);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element. 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
*
* @param extension
* Additional content defined by implementations
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder extension(Extension... extension) {
return (Builder) super.extension(extension);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element. 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
*
* @param extension
* Additional content defined by implementations
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder extension(Collection extension) {
return (Builder) super.extension(extension);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element and that
* modifies the understanding of the element in which it is contained 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 can 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
*
* @param modifierExtension
* Extensions that cannot be ignored even if unrecognized
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder modifierExtension(Extension... modifierExtension) {
return (Builder) super.modifierExtension(modifierExtension);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element and that
* modifies the understanding of the element in which it is contained 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 can 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
*
* @param modifierExtension
* Extensions that cannot be ignored even if unrecognized
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder modifierExtension(Collection modifierExtension) {
return (Builder) super.modifierExtension(modifierExtension);
}
/**
* Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of
* participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further
* research.
*
* This element is required.
*
*
This is a choice element with the following allowed types:
*
* - {@link Boolean}
* - {@link Decimal}
* - {@link Integer}
* - {@link Date}
* - {@link DateTime}
* - {@link Time}
* - {@link String}
* - {@link Uri}
* - {@link Attachment}
* - {@link Coding}
* - {@link Quantity}
* - {@link Reference}
*
*
* @param value
* The actual answer response
*
* @return
* A reference to this Builder instance
*/
public Builder value(Element value) {
this.value = value;
return this;
}
/**
* Build the {@link Answer}
*
* Required elements:
*
* - value
*
*
* @return
* An immutable object of type {@link Answer}
* @throws IllegalStateException
* if the current state cannot be built into a valid Answer per the base specification
*/
@Override
public Answer build() {
Answer answer = new Answer(this);
if (validating) {
validate(answer);
}
return answer;
}
protected void validate(Answer answer) {
super.validate(answer);
ValidationSupport.requireChoiceElement(answer.value, "value", Boolean.class, Decimal.class, Integer.class, Date.class, DateTime.class, Time.class, String.class, Uri.class, Attachment.class, Coding.class, Quantity.class, Reference.class);
ValidationSupport.requireValueOrChildren(answer);
}
protected Builder from(Answer answer) {
super.from(answer);
value = answer.value;
return this;
}
}
}
}
/**
* Contract Term Asset List.
*/
public static class Asset extends BackboneElement {
@Binding(
bindingName = "ContractAssetScope",
strength = BindingStrength.Value.EXAMPLE,
description = "Codes for scoping an asset.",
valueSet = "http://hl7.org/fhir/ValueSet/contract-assetscope"
)
private final CodeableConcept scope;
@Binding(
bindingName = "ContractAssetType",
strength = BindingStrength.Value.EXAMPLE,
description = "Condes for the type of an asset.",
valueSet = "http://hl7.org/fhir/ValueSet/contract-assettype"
)
private final List type;
private final List typeReference;
@Binding(
bindingName = "ContractAssetSubtype",
strength = BindingStrength.Value.EXAMPLE,
description = "Condes for the sub-type of an asset.",
valueSet = "http://hl7.org/fhir/ValueSet/contract-assetsubtype"
)
private final List subtype;
@Binding(
bindingName = "ConsentContentClass",
strength = BindingStrength.Value.EXTENSIBLE,
description = "The class (type) of information a consent rule covers.",
valueSet = "http://hl7.org/fhir/ValueSet/consent-content-class"
)
private final Coding relationship;
private final List context;
private final String condition;
@Binding(
bindingName = "AssetAvailabilityType",
strength = BindingStrength.Value.EXAMPLE,
description = "Codes for asset availability.",
valueSet = "http://hl7.org/fhir/ValueSet/asset-availability"
)
private final List periodType;
private final List period;
private final List usePeriod;
private final String text;
private final List linkId;
private final List answer;
private final List securityLabelNumber;
private final List valuedItem;
private Asset(Builder builder) {
super(builder);
scope = builder.scope;
type = Collections.unmodifiableList(builder.type);
typeReference = Collections.unmodifiableList(builder.typeReference);
subtype = Collections.unmodifiableList(builder.subtype);
relationship = builder.relationship;
context = Collections.unmodifiableList(builder.context);
condition = builder.condition;
periodType = Collections.unmodifiableList(builder.periodType);
period = Collections.unmodifiableList(builder.period);
usePeriod = Collections.unmodifiableList(builder.usePeriod);
text = builder.text;
linkId = Collections.unmodifiableList(builder.linkId);
answer = Collections.unmodifiableList(builder.answer);
securityLabelNumber = Collections.unmodifiableList(builder.securityLabelNumber);
valuedItem = Collections.unmodifiableList(builder.valuedItem);
}
/**
* Differentiates the kind of the asset .
*
* @return
* An immutable object of type {@link CodeableConcept} that may be null.
*/
public CodeableConcept getScope() {
return scope;
}
/**
* Target entity type about which the term may be concerned.
*
* @return
* An unmodifiable list containing immutable objects of type {@link CodeableConcept} that may be empty.
*/
public List getType() {
return type;
}
/**
* Associated entities.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Reference} that may be empty.
*/
public List getTypeReference() {
return typeReference;
}
/**
* May be a subtype or part of an offered asset.
*
* @return
* An unmodifiable list containing immutable objects of type {@link CodeableConcept} that may be empty.
*/
public List getSubtype() {
return subtype;
}
/**
* Specifies the applicability of the term to an asset resource instance, and instances it refers to orinstances that
* refer to it, and/or are owned by the offeree.
*
* @return
* An immutable object of type {@link Coding} that may be null.
*/
public Coding getRelationship() {
return relationship;
}
/**
* Circumstance of the asset.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Context} that may be empty.
*/
public List getContext() {
return context;
}
/**
* Description of the quality and completeness of the asset that imay be a factor in its valuation.
*
* @return
* An immutable object of type {@link String} that may be null.
*/
public String getCondition() {
return condition;
}
/**
* Type of Asset availability for use or ownership.
*
* @return
* An unmodifiable list containing immutable objects of type {@link CodeableConcept} that may be empty.
*/
public List getPeriodType() {
return periodType;
}
/**
* Asset relevant contractual time period.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Period} that may be empty.
*/
public List getPeriod() {
return period;
}
/**
* Time period of asset use.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Period} that may be empty.
*/
public List getUsePeriod() {
return usePeriod;
}
/**
* Clause or question text (Prose Object) concerning the asset in a linked form, such as a QuestionnaireResponse used in
* the formation of the contract.
*
* @return
* An immutable object of type {@link String} that may be null.
*/
public String getText() {
return text;
}
/**
* Id [identifier??] of the clause or question text about the asset in the referenced form or QuestionnaireResponse.
*
* @return
* An unmodifiable list containing immutable objects of type {@link String} that may be empty.
*/
public List getLinkId() {
return linkId;
}
/**
* Response to assets.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Answer} that may be empty.
*/
public List getAnswer() {
return answer;
}
/**
* Security labels that protects the asset.
*
* @return
* An unmodifiable list containing immutable objects of type {@link UnsignedInt} that may be empty.
*/
public List getSecurityLabelNumber() {
return securityLabelNumber;
}
/**
* Contract Valued Item List.
*
* @return
* An unmodifiable list containing immutable objects of type {@link ValuedItem} that may be empty.
*/
public List getValuedItem() {
return valuedItem;
}
@Override
public boolean hasChildren() {
return super.hasChildren() ||
(scope != null) ||
!type.isEmpty() ||
!typeReference.isEmpty() ||
!subtype.isEmpty() ||
(relationship != null) ||
!context.isEmpty() ||
(condition != null) ||
!periodType.isEmpty() ||
!period.isEmpty() ||
!usePeriod.isEmpty() ||
(text != null) ||
!linkId.isEmpty() ||
!answer.isEmpty() ||
!securityLabelNumber.isEmpty() ||
!valuedItem.isEmpty();
}
@Override
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor) {
if (visitor.preVisit(this)) {
visitor.visitStart(elementName, elementIndex, this);
if (visitor.visit(elementName, elementIndex, this)) {
// visit children
accept(id, "id", visitor);
accept(extension, "extension", visitor, Extension.class);
accept(modifierExtension, "modifierExtension", visitor, Extension.class);
accept(scope, "scope", visitor);
accept(type, "type", visitor, CodeableConcept.class);
accept(typeReference, "typeReference", visitor, Reference.class);
accept(subtype, "subtype", visitor, CodeableConcept.class);
accept(relationship, "relationship", visitor);
accept(context, "context", visitor, Context.class);
accept(condition, "condition", visitor);
accept(periodType, "periodType", visitor, CodeableConcept.class);
accept(period, "period", visitor, Period.class);
accept(usePeriod, "usePeriod", visitor, Period.class);
accept(text, "text", visitor);
accept(linkId, "linkId", visitor, String.class);
accept(answer, "answer", visitor, Contract.Term.Offer.Answer.class);
accept(securityLabelNumber, "securityLabelNumber", visitor, UnsignedInt.class);
accept(valuedItem, "valuedItem", visitor, ValuedItem.class);
}
visitor.visitEnd(elementName, elementIndex, this);
visitor.postVisit(this);
}
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
Asset other = (Asset) obj;
return Objects.equals(id, other.id) &&
Objects.equals(extension, other.extension) &&
Objects.equals(modifierExtension, other.modifierExtension) &&
Objects.equals(scope, other.scope) &&
Objects.equals(type, other.type) &&
Objects.equals(typeReference, other.typeReference) &&
Objects.equals(subtype, other.subtype) &&
Objects.equals(relationship, other.relationship) &&
Objects.equals(context, other.context) &&
Objects.equals(condition, other.condition) &&
Objects.equals(periodType, other.periodType) &&
Objects.equals(period, other.period) &&
Objects.equals(usePeriod, other.usePeriod) &&
Objects.equals(text, other.text) &&
Objects.equals(linkId, other.linkId) &&
Objects.equals(answer, other.answer) &&
Objects.equals(securityLabelNumber, other.securityLabelNumber) &&
Objects.equals(valuedItem, other.valuedItem);
}
@Override
public int hashCode() {
int result = hashCode;
if (result == 0) {
result = Objects.hash(id,
extension,
modifierExtension,
scope,
type,
typeReference,
subtype,
relationship,
context,
condition,
periodType,
period,
usePeriod,
text,
linkId,
answer,
securityLabelNumber,
valuedItem);
hashCode = result;
}
return result;
}
@Override
public Builder toBuilder() {
return new Builder().from(this);
}
public static Builder builder() {
return new Builder();
}
public static class Builder extends BackboneElement.Builder {
private CodeableConcept scope;
private List type = new ArrayList<>();
private List typeReference = new ArrayList<>();
private List subtype = new ArrayList<>();
private Coding relationship;
private List context = new ArrayList<>();
private String condition;
private List periodType = new ArrayList<>();
private List period = new ArrayList<>();
private List usePeriod = new ArrayList<>();
private String text;
private List linkId = new ArrayList<>();
private List answer = new ArrayList<>();
private List securityLabelNumber = new ArrayList<>();
private List valuedItem = new ArrayList<>();
private Builder() {
super();
}
/**
* Unique id for the element within a resource (for internal references). This may be any string value that does not
* contain spaces.
*
* @param id
* Unique id for inter-element referencing
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder id(java.lang.String id) {
return (Builder) super.id(id);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element. 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
*
* @param extension
* Additional content defined by implementations
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder extension(Extension... extension) {
return (Builder) super.extension(extension);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element. 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
*
* @param extension
* Additional content defined by implementations
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder extension(Collection extension) {
return (Builder) super.extension(extension);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element and that
* modifies the understanding of the element in which it is contained 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 can 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
*
* @param modifierExtension
* Extensions that cannot be ignored even if unrecognized
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder modifierExtension(Extension... modifierExtension) {
return (Builder) super.modifierExtension(modifierExtension);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element and that
* modifies the understanding of the element in which it is contained 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 can 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
*
* @param modifierExtension
* Extensions that cannot be ignored even if unrecognized
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder modifierExtension(Collection modifierExtension) {
return (Builder) super.modifierExtension(modifierExtension);
}
/**
* Differentiates the kind of the asset .
*
* @param scope
* Range of asset
*
* @return
* A reference to this Builder instance
*/
public Builder scope(CodeableConcept scope) {
this.scope = scope;
return this;
}
/**
* Target entity type about which the term may be concerned.
*
* Adds new element(s) to the existing list
*
* @param type
* Asset category
*
* @return
* A reference to this Builder instance
*/
public Builder type(CodeableConcept... type) {
for (CodeableConcept value : type) {
this.type.add(value);
}
return this;
}
/**
* Target entity type about which the term may be concerned.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param type
* Asset category
*
* @return
* A reference to this Builder instance
*/
public Builder type(Collection type) {
this.type = new ArrayList<>(type);
return this;
}
/**
* Associated entities.
*
* Adds new element(s) to the existing list
*
* @param typeReference
* Associated entities
*
* @return
* A reference to this Builder instance
*/
public Builder typeReference(Reference... typeReference) {
for (Reference value : typeReference) {
this.typeReference.add(value);
}
return this;
}
/**
* Associated entities.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param typeReference
* Associated entities
*
* @return
* A reference to this Builder instance
*/
public Builder typeReference(Collection typeReference) {
this.typeReference = new ArrayList<>(typeReference);
return this;
}
/**
* May be a subtype or part of an offered asset.
*
* Adds new element(s) to the existing list
*
* @param subtype
* Asset sub-category
*
* @return
* A reference to this Builder instance
*/
public Builder subtype(CodeableConcept... subtype) {
for (CodeableConcept value : subtype) {
this.subtype.add(value);
}
return this;
}
/**
* May be a subtype or part of an offered asset.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param subtype
* Asset sub-category
*
* @return
* A reference to this Builder instance
*/
public Builder subtype(Collection subtype) {
this.subtype = new ArrayList<>(subtype);
return this;
}
/**
* Specifies the applicability of the term to an asset resource instance, and instances it refers to orinstances that
* refer to it, and/or are owned by the offeree.
*
* @param relationship
* Kinship of the asset
*
* @return
* A reference to this Builder instance
*/
public Builder relationship(Coding relationship) {
this.relationship = relationship;
return this;
}
/**
* Circumstance of the asset.
*
* Adds new element(s) to the existing list
*
* @param context
* Circumstance of the asset
*
* @return
* A reference to this Builder instance
*/
public Builder context(Context... context) {
for (Context value : context) {
this.context.add(value);
}
return this;
}
/**
* Circumstance of the asset.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param context
* Circumstance of the asset
*
* @return
* A reference to this Builder instance
*/
public Builder context(Collection context) {
this.context = new ArrayList<>(context);
return this;
}
/**
* Description of the quality and completeness of the asset that imay be a factor in its valuation.
*
* @param condition
* Quality desctiption of asset
*
* @return
* A reference to this Builder instance
*/
public Builder condition(String condition) {
this.condition = condition;
return this;
}
/**
* Type of Asset availability for use or ownership.
*
* Adds new element(s) to the existing list
*
* @param periodType
* Asset availability types
*
* @return
* A reference to this Builder instance
*/
public Builder periodType(CodeableConcept... periodType) {
for (CodeableConcept value : periodType) {
this.periodType.add(value);
}
return this;
}
/**
* Type of Asset availability for use or ownership.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param periodType
* Asset availability types
*
* @return
* A reference to this Builder instance
*/
public Builder periodType(Collection periodType) {
this.periodType = new ArrayList<>(periodType);
return this;
}
/**
* Asset relevant contractual time period.
*
* Adds new element(s) to the existing list
*
* @param period
* Time period of the asset
*
* @return
* A reference to this Builder instance
*/
public Builder period(Period... period) {
for (Period value : period) {
this.period.add(value);
}
return this;
}
/**
* Asset relevant contractual time period.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param period
* Time period of the asset
*
* @return
* A reference to this Builder instance
*/
public Builder period(Collection period) {
this.period = new ArrayList<>(period);
return this;
}
/**
* Time period of asset use.
*
* Adds new element(s) to the existing list
*
* @param usePeriod
* Time period
*
* @return
* A reference to this Builder instance
*/
public Builder usePeriod(Period... usePeriod) {
for (Period value : usePeriod) {
this.usePeriod.add(value);
}
return this;
}
/**
* Time period of asset use.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param usePeriod
* Time period
*
* @return
* A reference to this Builder instance
*/
public Builder usePeriod(Collection usePeriod) {
this.usePeriod = new ArrayList<>(usePeriod);
return this;
}
/**
* Clause or question text (Prose Object) concerning the asset in a linked form, such as a QuestionnaireResponse used in
* the formation of the contract.
*
* @param text
* Asset clause or question text
*
* @return
* A reference to this Builder instance
*/
public Builder text(String text) {
this.text = text;
return this;
}
/**
* Id [identifier??] of the clause or question text about the asset in the referenced form or QuestionnaireResponse.
*
* Adds new element(s) to the existing list
*
* @param linkId
* Pointer to asset text
*
* @return
* A reference to this Builder instance
*/
public Builder linkId(String... linkId) {
for (String value : linkId) {
this.linkId.add(value);
}
return this;
}
/**
* Id [identifier??] of the clause or question text about the asset in the referenced form or QuestionnaireResponse.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param linkId
* Pointer to asset text
*
* @return
* A reference to this Builder instance
*/
public Builder linkId(Collection linkId) {
this.linkId = new ArrayList<>(linkId);
return this;
}
/**
* Response to assets.
*
* Adds new element(s) to the existing list
*
* @param answer
* Response to assets
*
* @return
* A reference to this Builder instance
*/
public Builder answer(Contract.Term.Offer.Answer... answer) {
for (Contract.Term.Offer.Answer value : answer) {
this.answer.add(value);
}
return this;
}
/**
* Response to assets.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param answer
* Response to assets
*
* @return
* A reference to this Builder instance
*/
public Builder answer(Collection answer) {
this.answer = new ArrayList<>(answer);
return this;
}
/**
* Security labels that protects the asset.
*
* Adds new element(s) to the existing list
*
* @param securityLabelNumber
* Asset restriction numbers
*
* @return
* A reference to this Builder instance
*/
public Builder securityLabelNumber(UnsignedInt... securityLabelNumber) {
for (UnsignedInt value : securityLabelNumber) {
this.securityLabelNumber.add(value);
}
return this;
}
/**
* Security labels that protects the asset.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param securityLabelNumber
* Asset restriction numbers
*
* @return
* A reference to this Builder instance
*/
public Builder securityLabelNumber(Collection securityLabelNumber) {
this.securityLabelNumber = new ArrayList<>(securityLabelNumber);
return this;
}
/**
* Contract Valued Item List.
*
* Adds new element(s) to the existing list
*
* @param valuedItem
* Contract Valued Item List
*
* @return
* A reference to this Builder instance
*/
public Builder valuedItem(ValuedItem... valuedItem) {
for (ValuedItem value : valuedItem) {
this.valuedItem.add(value);
}
return this;
}
/**
* Contract Valued Item List.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param valuedItem
* Contract Valued Item List
*
* @return
* A reference to this Builder instance
*/
public Builder valuedItem(Collection valuedItem) {
this.valuedItem = new ArrayList<>(valuedItem);
return this;
}
/**
* Build the {@link Asset}
*
* @return
* An immutable object of type {@link Asset}
* @throws IllegalStateException
* if the current state cannot be built into a valid Asset per the base specification
*/
@Override
public Asset build() {
Asset asset = new Asset(this);
if (validating) {
validate(asset);
}
return asset;
}
protected void validate(Asset asset) {
super.validate(asset);
ValidationSupport.checkList(asset.type, "type", CodeableConcept.class);
ValidationSupport.checkList(asset.typeReference, "typeReference", Reference.class);
ValidationSupport.checkList(asset.subtype, "subtype", CodeableConcept.class);
ValidationSupport.checkList(asset.context, "context", Context.class);
ValidationSupport.checkList(asset.periodType, "periodType", CodeableConcept.class);
ValidationSupport.checkList(asset.period, "period", Period.class);
ValidationSupport.checkList(asset.usePeriod, "usePeriod", Period.class);
ValidationSupport.checkList(asset.linkId, "linkId", String.class);
ValidationSupport.checkList(asset.answer, "answer", Contract.Term.Offer.Answer.class);
ValidationSupport.checkList(asset.securityLabelNumber, "securityLabelNumber", UnsignedInt.class);
ValidationSupport.checkList(asset.valuedItem, "valuedItem", ValuedItem.class);
ValidationSupport.requireValueOrChildren(asset);
}
protected Builder from(Asset asset) {
super.from(asset);
scope = asset.scope;
type.addAll(asset.type);
typeReference.addAll(asset.typeReference);
subtype.addAll(asset.subtype);
relationship = asset.relationship;
context.addAll(asset.context);
condition = asset.condition;
periodType.addAll(asset.periodType);
period.addAll(asset.period);
usePeriod.addAll(asset.usePeriod);
text = asset.text;
linkId.addAll(asset.linkId);
answer.addAll(asset.answer);
securityLabelNumber.addAll(asset.securityLabelNumber);
valuedItem.addAll(asset.valuedItem);
return this;
}
}
/**
* Circumstance of the asset.
*/
public static class Context extends BackboneElement {
private final Reference reference;
@Binding(
bindingName = "ContractAssetContext",
strength = BindingStrength.Value.EXAMPLE,
description = "Codes for the context of the asset.",
valueSet = "http://hl7.org/fhir/ValueSet/contract-assetcontext"
)
private final List code;
private final String text;
private Context(Builder builder) {
super(builder);
reference = builder.reference;
code = Collections.unmodifiableList(builder.code);
text = builder.text;
}
/**
* Asset context reference may include the creator, custodian, or owning Person or Organization (e.g., bank, repository),
* location held, e.g., building, jurisdiction.
*
* @return
* An immutable object of type {@link Reference} that may be null.
*/
public Reference getReference() {
return reference;
}
/**
* Coded representation of the context generally or of the Referenced entity, such as the asset holder type or location.
*
* @return
* An unmodifiable list containing immutable objects of type {@link CodeableConcept} that may be empty.
*/
public List getCode() {
return code;
}
/**
* Context description.
*
* @return
* An immutable object of type {@link String} that may be null.
*/
public String getText() {
return text;
}
@Override
public boolean hasChildren() {
return super.hasChildren() ||
(reference != null) ||
!code.isEmpty() ||
(text != null);
}
@Override
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor) {
if (visitor.preVisit(this)) {
visitor.visitStart(elementName, elementIndex, this);
if (visitor.visit(elementName, elementIndex, this)) {
// visit children
accept(id, "id", visitor);
accept(extension, "extension", visitor, Extension.class);
accept(modifierExtension, "modifierExtension", visitor, Extension.class);
accept(reference, "reference", visitor);
accept(code, "code", visitor, CodeableConcept.class);
accept(text, "text", visitor);
}
visitor.visitEnd(elementName, elementIndex, this);
visitor.postVisit(this);
}
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
Context other = (Context) obj;
return Objects.equals(id, other.id) &&
Objects.equals(extension, other.extension) &&
Objects.equals(modifierExtension, other.modifierExtension) &&
Objects.equals(reference, other.reference) &&
Objects.equals(code, other.code) &&
Objects.equals(text, other.text);
}
@Override
public int hashCode() {
int result = hashCode;
if (result == 0) {
result = Objects.hash(id,
extension,
modifierExtension,
reference,
code,
text);
hashCode = result;
}
return result;
}
@Override
public Builder toBuilder() {
return new Builder().from(this);
}
public static Builder builder() {
return new Builder();
}
public static class Builder extends BackboneElement.Builder {
private Reference reference;
private List code = new ArrayList<>();
private String text;
private Builder() {
super();
}
/**
* Unique id for the element within a resource (for internal references). This may be any string value that does not
* contain spaces.
*
* @param id
* Unique id for inter-element referencing
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder id(java.lang.String id) {
return (Builder) super.id(id);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element. 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
*
* @param extension
* Additional content defined by implementations
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder extension(Extension... extension) {
return (Builder) super.extension(extension);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element. 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
*
* @param extension
* Additional content defined by implementations
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder extension(Collection extension) {
return (Builder) super.extension(extension);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element and that
* modifies the understanding of the element in which it is contained 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 can 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
*
* @param modifierExtension
* Extensions that cannot be ignored even if unrecognized
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder modifierExtension(Extension... modifierExtension) {
return (Builder) super.modifierExtension(modifierExtension);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element and that
* modifies the understanding of the element in which it is contained 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 can 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
*
* @param modifierExtension
* Extensions that cannot be ignored even if unrecognized
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder modifierExtension(Collection modifierExtension) {
return (Builder) super.modifierExtension(modifierExtension);
}
/**
* Asset context reference may include the creator, custodian, or owning Person or Organization (e.g., bank, repository),
* location held, e.g., building, jurisdiction.
*
* @param reference
* Creator,custodian or owner
*
* @return
* A reference to this Builder instance
*/
public Builder reference(Reference reference) {
this.reference = reference;
return this;
}
/**
* Coded representation of the context generally or of the Referenced entity, such as the asset holder type or location.
*
* Adds new element(s) to the existing list
*
* @param code
* Codeable asset context
*
* @return
* A reference to this Builder instance
*/
public Builder code(CodeableConcept... code) {
for (CodeableConcept value : code) {
this.code.add(value);
}
return this;
}
/**
* Coded representation of the context generally or of the Referenced entity, such as the asset holder type or location.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param code
* Codeable asset context
*
* @return
* A reference to this Builder instance
*/
public Builder code(Collection code) {
this.code = new ArrayList<>(code);
return this;
}
/**
* Context description.
*
* @param text
* Context description
*
* @return
* A reference to this Builder instance
*/
public Builder text(String text) {
this.text = text;
return this;
}
/**
* Build the {@link Context}
*
* @return
* An immutable object of type {@link Context}
* @throws IllegalStateException
* if the current state cannot be built into a valid Context per the base specification
*/
@Override
public Context build() {
Context context = new Context(this);
if (validating) {
validate(context);
}
return context;
}
protected void validate(Context context) {
super.validate(context);
ValidationSupport.checkList(context.code, "code", CodeableConcept.class);
ValidationSupport.requireValueOrChildren(context);
}
protected Builder from(Context context) {
super.from(context);
reference = context.reference;
code.addAll(context.code);
text = context.text;
return this;
}
}
}
/**
* Contract Valued Item List.
*/
public static class ValuedItem extends BackboneElement {
@Choice({ CodeableConcept.class, Reference.class })
private final Element entity;
private final Identifier identifier;
private final DateTime effectiveTime;
private final SimpleQuantity quantity;
private final Money unitPrice;
private final Decimal factor;
private final Decimal points;
private final Money net;
private final String payment;
private final DateTime paymentDate;
@ReferenceTarget({ "Organization", "Patient", "Practitioner", "PractitionerRole", "RelatedPerson" })
private final Reference responsible;
@ReferenceTarget({ "Organization", "Patient", "Practitioner", "PractitionerRole", "RelatedPerson" })
private final Reference recipient;
private final List linkId;
private final List securityLabelNumber;
private ValuedItem(Builder builder) {
super(builder);
entity = builder.entity;
identifier = builder.identifier;
effectiveTime = builder.effectiveTime;
quantity = builder.quantity;
unitPrice = builder.unitPrice;
factor = builder.factor;
points = builder.points;
net = builder.net;
payment = builder.payment;
paymentDate = builder.paymentDate;
responsible = builder.responsible;
recipient = builder.recipient;
linkId = Collections.unmodifiableList(builder.linkId);
securityLabelNumber = Collections.unmodifiableList(builder.securityLabelNumber);
}
/**
* Specific type of Contract Valued Item that may be priced.
*
* @return
* An immutable object of type {@link Element} that may be null.
*/
public Element getEntity() {
return entity;
}
/**
* Identifies a Contract Valued Item instance.
*
* @return
* An immutable object of type {@link Identifier} that may be null.
*/
public Identifier getIdentifier() {
return identifier;
}
/**
* Indicates the time during which this Contract ValuedItem information is effective.
*
* @return
* An immutable object of type {@link DateTime} that may be null.
*/
public DateTime getEffectiveTime() {
return effectiveTime;
}
/**
* Specifies the units by which the Contract Valued Item is measured or counted, and quantifies the countable or
* measurable Contract Valued Item instances.
*
* @return
* An immutable object of type {@link SimpleQuantity} that may be null.
*/
public SimpleQuantity getQuantity() {
return quantity;
}
/**
* A Contract Valued Item unit valuation measure.
*
* @return
* An immutable object of type {@link Money} that may be null.
*/
public Money getUnitPrice() {
return unitPrice;
}
/**
* A real number that represents a multiplier used in determining the overall value of the Contract Valued Item
* delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
*
* @return
* An immutable object of type {@link Decimal} that may be null.
*/
public Decimal getFactor() {
return factor;
}
/**
* An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the
* Contract Valued Item delivered. The concept of Points allows for assignment of point values for a Contract Valued
* Item, such that a monetary amount can be assigned to each point.
*
* @return
* An immutable object of type {@link Decimal} that may be null.
*/
public Decimal getPoints() {
return points;
}
/**
* Expresses the product of the Contract Valued Item unitQuantity and the unitPriceAmt. For example, the formula: unit
* Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed
* to be 1 if not supplied.
*
* @return
* An immutable object of type {@link Money} that may be null.
*/
public Money getNet() {
return net;
}
/**
* Terms of valuation.
*
* @return
* An immutable object of type {@link String} that may be null.
*/
public String getPayment() {
return payment;
}
/**
* When payment is due.
*
* @return
* An immutable object of type {@link DateTime} that may be null.
*/
public DateTime getPaymentDate() {
return paymentDate;
}
/**
* Who will make payment.
*
* @return
* An immutable object of type {@link Reference} that may be null.
*/
public Reference getResponsible() {
return responsible;
}
/**
* Who will receive payment.
*
* @return
* An immutable object of type {@link Reference} that may be null.
*/
public Reference getRecipient() {
return recipient;
}
/**
* Id of the clause or question text related to the context of this valuedItem in the referenced form or
* QuestionnaireResponse.
*
* @return
* An unmodifiable list containing immutable objects of type {@link String} that may be empty.
*/
public List getLinkId() {
return linkId;
}
/**
* A set of security labels that define which terms are controlled by this condition.
*
* @return
* An unmodifiable list containing immutable objects of type {@link UnsignedInt} that may be empty.
*/
public List getSecurityLabelNumber() {
return securityLabelNumber;
}
@Override
public boolean hasChildren() {
return super.hasChildren() ||
(entity != null) ||
(identifier != null) ||
(effectiveTime != null) ||
(quantity != null) ||
(unitPrice != null) ||
(factor != null) ||
(points != null) ||
(net != null) ||
(payment != null) ||
(paymentDate != null) ||
(responsible != null) ||
(recipient != null) ||
!linkId.isEmpty() ||
!securityLabelNumber.isEmpty();
}
@Override
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor) {
if (visitor.preVisit(this)) {
visitor.visitStart(elementName, elementIndex, this);
if (visitor.visit(elementName, elementIndex, this)) {
// visit children
accept(id, "id", visitor);
accept(extension, "extension", visitor, Extension.class);
accept(modifierExtension, "modifierExtension", visitor, Extension.class);
accept(entity, "entity", visitor);
accept(identifier, "identifier", visitor);
accept(effectiveTime, "effectiveTime", visitor);
accept(quantity, "quantity", visitor);
accept(unitPrice, "unitPrice", visitor);
accept(factor, "factor", visitor);
accept(points, "points", visitor);
accept(net, "net", visitor);
accept(payment, "payment", visitor);
accept(paymentDate, "paymentDate", visitor);
accept(responsible, "responsible", visitor);
accept(recipient, "recipient", visitor);
accept(linkId, "linkId", visitor, String.class);
accept(securityLabelNumber, "securityLabelNumber", visitor, UnsignedInt.class);
}
visitor.visitEnd(elementName, elementIndex, this);
visitor.postVisit(this);
}
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
ValuedItem other = (ValuedItem) obj;
return Objects.equals(id, other.id) &&
Objects.equals(extension, other.extension) &&
Objects.equals(modifierExtension, other.modifierExtension) &&
Objects.equals(entity, other.entity) &&
Objects.equals(identifier, other.identifier) &&
Objects.equals(effectiveTime, other.effectiveTime) &&
Objects.equals(quantity, other.quantity) &&
Objects.equals(unitPrice, other.unitPrice) &&
Objects.equals(factor, other.factor) &&
Objects.equals(points, other.points) &&
Objects.equals(net, other.net) &&
Objects.equals(payment, other.payment) &&
Objects.equals(paymentDate, other.paymentDate) &&
Objects.equals(responsible, other.responsible) &&
Objects.equals(recipient, other.recipient) &&
Objects.equals(linkId, other.linkId) &&
Objects.equals(securityLabelNumber, other.securityLabelNumber);
}
@Override
public int hashCode() {
int result = hashCode;
if (result == 0) {
result = Objects.hash(id,
extension,
modifierExtension,
entity,
identifier,
effectiveTime,
quantity,
unitPrice,
factor,
points,
net,
payment,
paymentDate,
responsible,
recipient,
linkId,
securityLabelNumber);
hashCode = result;
}
return result;
}
@Override
public Builder toBuilder() {
return new Builder().from(this);
}
public static Builder builder() {
return new Builder();
}
public static class Builder extends BackboneElement.Builder {
private Element entity;
private Identifier identifier;
private DateTime effectiveTime;
private SimpleQuantity quantity;
private Money unitPrice;
private Decimal factor;
private Decimal points;
private Money net;
private String payment;
private DateTime paymentDate;
private Reference responsible;
private Reference recipient;
private List linkId = new ArrayList<>();
private List securityLabelNumber = new ArrayList<>();
private Builder() {
super();
}
/**
* Unique id for the element within a resource (for internal references). This may be any string value that does not
* contain spaces.
*
* @param id
* Unique id for inter-element referencing
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder id(java.lang.String id) {
return (Builder) super.id(id);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element. 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
*
* @param extension
* Additional content defined by implementations
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder extension(Extension... extension) {
return (Builder) super.extension(extension);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element. 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
*
* @param extension
* Additional content defined by implementations
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder extension(Collection extension) {
return (Builder) super.extension(extension);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element and that
* modifies the understanding of the element in which it is contained 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 can 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
*
* @param modifierExtension
* Extensions that cannot be ignored even if unrecognized
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder modifierExtension(Extension... modifierExtension) {
return (Builder) super.modifierExtension(modifierExtension);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element and that
* modifies the understanding of the element in which it is contained 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 can 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
*
* @param modifierExtension
* Extensions that cannot be ignored even if unrecognized
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder modifierExtension(Collection modifierExtension) {
return (Builder) super.modifierExtension(modifierExtension);
}
/**
* Specific type of Contract Valued Item that may be priced.
*
* This is a choice element with the following allowed types:
*
* - {@link CodeableConcept}
* - {@link Reference}
*
*
* @param entity
* Contract Valued Item Type
*
* @return
* A reference to this Builder instance
*/
public Builder entity(Element entity) {
this.entity = entity;
return this;
}
/**
* Identifies a Contract Valued Item instance.
*
* @param identifier
* Contract Valued Item Number
*
* @return
* A reference to this Builder instance
*/
public Builder identifier(Identifier identifier) {
this.identifier = identifier;
return this;
}
/**
* Indicates the time during which this Contract ValuedItem information is effective.
*
* @param effectiveTime
* Contract Valued Item Effective Tiem
*
* @return
* A reference to this Builder instance
*/
public Builder effectiveTime(DateTime effectiveTime) {
this.effectiveTime = effectiveTime;
return this;
}
/**
* Specifies the units by which the Contract Valued Item is measured or counted, and quantifies the countable or
* measurable Contract Valued Item instances.
*
* @param quantity
* Count of Contract Valued Items
*
* @return
* A reference to this Builder instance
*/
public Builder quantity(SimpleQuantity quantity) {
this.quantity = quantity;
return this;
}
/**
* A Contract Valued Item unit valuation measure.
*
* @param unitPrice
* Contract Valued Item fee, charge, or cost
*
* @return
* A reference to this Builder instance
*/
public Builder unitPrice(Money unitPrice) {
this.unitPrice = unitPrice;
return this;
}
/**
* A real number that represents a multiplier used in determining the overall value of the Contract Valued Item
* delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
*
* @param factor
* Contract Valued Item Price Scaling Factor
*
* @return
* A reference to this Builder instance
*/
public Builder factor(Decimal factor) {
this.factor = factor;
return this;
}
/**
* An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the
* Contract Valued Item delivered. The concept of Points allows for assignment of point values for a Contract Valued
* Item, such that a monetary amount can be assigned to each point.
*
* @param points
* Contract Valued Item Difficulty Scaling Factor
*
* @return
* A reference to this Builder instance
*/
public Builder points(Decimal points) {
this.points = points;
return this;
}
/**
* Expresses the product of the Contract Valued Item unitQuantity and the unitPriceAmt. For example, the formula: unit
* Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed
* to be 1 if not supplied.
*
* @param net
* Total Contract Valued Item Value
*
* @return
* A reference to this Builder instance
*/
public Builder net(Money net) {
this.net = net;
return this;
}
/**
* Terms of valuation.
*
* @param payment
* Terms of valuation
*
* @return
* A reference to this Builder instance
*/
public Builder payment(String payment) {
this.payment = payment;
return this;
}
/**
* When payment is due.
*
* @param paymentDate
* When payment is due
*
* @return
* A reference to this Builder instance
*/
public Builder paymentDate(DateTime paymentDate) {
this.paymentDate = paymentDate;
return this;
}
/**
* Who will make payment.
*
* Allowed resource types for this reference:
*
* - {@link Organization}
* - {@link Patient}
* - {@link Practitioner}
* - {@link PractitionerRole}
* - {@link RelatedPerson}
*
*
* @param responsible
* Who will make payment
*
* @return
* A reference to this Builder instance
*/
public Builder responsible(Reference responsible) {
this.responsible = responsible;
return this;
}
/**
* Who will receive payment.
*
* Allowed resource types for this reference:
*
* - {@link Organization}
* - {@link Patient}
* - {@link Practitioner}
* - {@link PractitionerRole}
* - {@link RelatedPerson}
*
*
* @param recipient
* Who will receive payment
*
* @return
* A reference to this Builder instance
*/
public Builder recipient(Reference recipient) {
this.recipient = recipient;
return this;
}
/**
* Id of the clause or question text related to the context of this valuedItem in the referenced form or
* QuestionnaireResponse.
*
* Adds new element(s) to the existing list
*
* @param linkId
* Pointer to specific item
*
* @return
* A reference to this Builder instance
*/
public Builder linkId(String... linkId) {
for (String value : linkId) {
this.linkId.add(value);
}
return this;
}
/**
* Id of the clause or question text related to the context of this valuedItem in the referenced form or
* QuestionnaireResponse.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param linkId
* Pointer to specific item
*
* @return
* A reference to this Builder instance
*/
public Builder linkId(Collection linkId) {
this.linkId = new ArrayList<>(linkId);
return this;
}
/**
* A set of security labels that define which terms are controlled by this condition.
*
* Adds new element(s) to the existing list
*
* @param securityLabelNumber
* Security Labels that define affected terms
*
* @return
* A reference to this Builder instance
*/
public Builder securityLabelNumber(UnsignedInt... securityLabelNumber) {
for (UnsignedInt value : securityLabelNumber) {
this.securityLabelNumber.add(value);
}
return this;
}
/**
* A set of security labels that define which terms are controlled by this condition.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param securityLabelNumber
* Security Labels that define affected terms
*
* @return
* A reference to this Builder instance
*/
public Builder securityLabelNumber(Collection securityLabelNumber) {
this.securityLabelNumber = new ArrayList<>(securityLabelNumber);
return this;
}
/**
* Build the {@link ValuedItem}
*
* @return
* An immutable object of type {@link ValuedItem}
* @throws IllegalStateException
* if the current state cannot be built into a valid ValuedItem per the base specification
*/
@Override
public ValuedItem build() {
ValuedItem valuedItem = new ValuedItem(this);
if (validating) {
validate(valuedItem);
}
return valuedItem;
}
protected void validate(ValuedItem valuedItem) {
super.validate(valuedItem);
ValidationSupport.choiceElement(valuedItem.entity, "entity", CodeableConcept.class, Reference.class);
ValidationSupport.checkList(valuedItem.linkId, "linkId", String.class);
ValidationSupport.checkList(valuedItem.securityLabelNumber, "securityLabelNumber", UnsignedInt.class);
ValidationSupport.checkReferenceType(valuedItem.responsible, "responsible", "Organization", "Patient", "Practitioner", "PractitionerRole", "RelatedPerson");
ValidationSupport.checkReferenceType(valuedItem.recipient, "recipient", "Organization", "Patient", "Practitioner", "PractitionerRole", "RelatedPerson");
ValidationSupport.requireValueOrChildren(valuedItem);
}
protected Builder from(ValuedItem valuedItem) {
super.from(valuedItem);
entity = valuedItem.entity;
identifier = valuedItem.identifier;
effectiveTime = valuedItem.effectiveTime;
quantity = valuedItem.quantity;
unitPrice = valuedItem.unitPrice;
factor = valuedItem.factor;
points = valuedItem.points;
net = valuedItem.net;
payment = valuedItem.payment;
paymentDate = valuedItem.paymentDate;
responsible = valuedItem.responsible;
recipient = valuedItem.recipient;
linkId.addAll(valuedItem.linkId);
securityLabelNumber.addAll(valuedItem.securityLabelNumber);
return this;
}
}
}
}
/**
* An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity
* taking place.
*/
public static class Action extends BackboneElement {
private final Boolean doNotPerform;
@Binding(
bindingName = "ContractAction",
strength = BindingStrength.Value.EXAMPLE,
description = "Detailed codes for the contract action.",
valueSet = "http://hl7.org/fhir/ValueSet/contract-action"
)
@Required
private final CodeableConcept type;
private final List subject;
@Binding(
bindingName = "ContractActionReason",
strength = BindingStrength.Value.EXAMPLE,
description = "Detailed codes for the contract action reason.",
valueSet = "http://terminology.hl7.org/ValueSet/v3-PurposeOfUse"
)
@Required
private final CodeableConcept intent;
private final List linkId;
@Binding(
bindingName = "ContractActionStatus",
strength = BindingStrength.Value.EXAMPLE,
description = "Codes for the status of an term action.",
valueSet = "http://hl7.org/fhir/ValueSet/contract-actionstatus"
)
@Required
private final CodeableConcept status;
@ReferenceTarget({ "Encounter", "EpisodeOfCare" })
private final Reference context;
private final List