com.ibm.fhir.model.resource.Schedule 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.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.Boolean;
import com.ibm.fhir.model.type.Code;
import com.ibm.fhir.model.type.CodeableConcept;
import com.ibm.fhir.model.type.Extension;
import com.ibm.fhir.model.type.Identifier;
import com.ibm.fhir.model.type.Meta;
import com.ibm.fhir.model.type.Narrative;
import com.ibm.fhir.model.type.Period;
import com.ibm.fhir.model.type.Reference;
import com.ibm.fhir.model.type.String;
import com.ibm.fhir.model.type.Uri;
import com.ibm.fhir.model.type.code.BindingStrength;
import com.ibm.fhir.model.type.code.StandardsStatus;
import com.ibm.fhir.model.util.ValidationSupport;
import com.ibm.fhir.model.visitor.Visitor;
/**
* A container for slots of time that may be available for booking appointments.
*
* Maturity level: FMM3 (Trial Use)
*/
@Maturity(
level = 3,
status = StandardsStatus.Value.TRIAL_USE
)
@Constraint(
id = "schedule-0",
level = "Warning",
location = "(base)",
description = "SHOULD contain a code from value set http://hl7.org/fhir/ValueSet/c80-practice-codes",
expression = "specialty.exists() implies (specialty.all(memberOf('http://hl7.org/fhir/ValueSet/c80-practice-codes', 'preferred')))",
generated = true
)
@Generated("com.ibm.fhir.tools.CodeGenerator")
public class Schedule extends DomainResource {
@Summary
private final List identifier;
@Summary
private final Boolean active;
@Summary
@Binding(
bindingName = "service-category",
strength = BindingStrength.Value.EXAMPLE,
valueSet = "http://hl7.org/fhir/ValueSet/service-category"
)
private final List serviceCategory;
@Summary
@Binding(
bindingName = "service-type",
strength = BindingStrength.Value.EXAMPLE,
valueSet = "http://hl7.org/fhir/ValueSet/service-type"
)
private final List serviceType;
@Summary
@Binding(
bindingName = "specialty",
strength = BindingStrength.Value.PREFERRED,
description = "Additional details about where the content was created (e.g. clinical specialty).",
valueSet = "http://hl7.org/fhir/ValueSet/c80-practice-codes"
)
private final List specialty;
@Summary
@ReferenceTarget({ "Patient", "Practitioner", "PractitionerRole", "RelatedPerson", "Device", "HealthcareService", "Location" })
@Required
private final List actor;
@Summary
private final Period planningHorizon;
private final String comment;
private Schedule(Builder builder) {
super(builder);
identifier = Collections.unmodifiableList(builder.identifier);
active = builder.active;
serviceCategory = Collections.unmodifiableList(builder.serviceCategory);
serviceType = Collections.unmodifiableList(builder.serviceType);
specialty = Collections.unmodifiableList(builder.specialty);
actor = Collections.unmodifiableList(builder.actor);
planningHorizon = builder.planningHorizon;
comment = builder.comment;
}
/**
* External Ids for this item.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Identifier} that may be empty.
*/
public List getIdentifier() {
return identifier;
}
/**
* Whether this schedule record is in active use or should not be used (such as was entered in error).
*
* @return
* An immutable object of type {@link Boolean} that may be null.
*/
public Boolean getActive() {
return active;
}
/**
* A broad categorization of the service that is to be performed during this appointment.
*
* @return
* An unmodifiable list containing immutable objects of type {@link CodeableConcept} that may be empty.
*/
public List getServiceCategory() {
return serviceCategory;
}
/**
* The specific service that is to be performed during this appointment.
*
* @return
* An unmodifiable list containing immutable objects of type {@link CodeableConcept} that may be empty.
*/
public List getServiceType() {
return serviceType;
}
/**
* The specialty of a practitioner that would be required to perform the service requested in this appointment.
*
* @return
* An unmodifiable list containing immutable objects of type {@link CodeableConcept} that may be empty.
*/
public List getSpecialty() {
return specialty;
}
/**
* Slots that reference this schedule resource provide the availability details to these referenced resource(s).
*
* @return
* An unmodifiable list containing immutable objects of type {@link Reference} that is non-empty.
*/
public List getActor() {
return actor;
}
/**
* The period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the
* amount of time that an organization's planning horizon; the interval for which they are currently accepting
* appointments. This does not define a "template" for planning outside these dates.
*
* @return
* An immutable object of type {@link Period} that may be null.
*/
public Period getPlanningHorizon() {
return planningHorizon;
}
/**
* Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be
* associated.
*
* @return
* An immutable object of type {@link String} that may be null.
*/
public String getComment() {
return comment;
}
@Override
public boolean hasChildren() {
return super.hasChildren() ||
!identifier.isEmpty() ||
(active != null) ||
!serviceCategory.isEmpty() ||
!serviceType.isEmpty() ||
!specialty.isEmpty() ||
!actor.isEmpty() ||
(planningHorizon != null) ||
(comment != 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(active, "active", visitor);
accept(serviceCategory, "serviceCategory", visitor, CodeableConcept.class);
accept(serviceType, "serviceType", visitor, CodeableConcept.class);
accept(specialty, "specialty", visitor, CodeableConcept.class);
accept(actor, "actor", visitor, Reference.class);
accept(planningHorizon, "planningHorizon", visitor);
accept(comment, "comment", 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;
}
Schedule other = (Schedule) 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(active, other.active) &&
Objects.equals(serviceCategory, other.serviceCategory) &&
Objects.equals(serviceType, other.serviceType) &&
Objects.equals(specialty, other.specialty) &&
Objects.equals(actor, other.actor) &&
Objects.equals(planningHorizon, other.planningHorizon) &&
Objects.equals(comment, other.comment);
}
@Override
public int hashCode() {
int result = hashCode;
if (result == 0) {
result = Objects.hash(id,
meta,
implicitRules,
language,
text,
contained,
extension,
modifierExtension,
identifier,
active,
serviceCategory,
serviceType,
specialty,
actor,
planningHorizon,
comment);
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 Boolean active;
private List serviceCategory = new ArrayList<>();
private List serviceType = new ArrayList<>();
private List specialty = new ArrayList<>();
private List actor = new ArrayList<>();
private Period planningHorizon;
private String comment;
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);
}
/**
* External Ids for this item.
*
* Adds new element(s) to the existing list
*
* @param identifier
* External Ids for this item
*
* @return
* A reference to this Builder instance
*/
public Builder identifier(Identifier... identifier) {
for (Identifier value : identifier) {
this.identifier.add(value);
}
return this;
}
/**
* External Ids for this item.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param identifier
* External Ids for this item
*
* @return
* A reference to this Builder instance
*/
public Builder identifier(Collection identifier) {
this.identifier = new ArrayList<>(identifier);
return this;
}
/**
* Whether this schedule record is in active use or should not be used (such as was entered in error).
*
* @param active
* Whether this schedule is in active use
*
* @return
* A reference to this Builder instance
*/
public Builder active(Boolean active) {
this.active = active;
return this;
}
/**
* A broad categorization of the service that is to be performed during this appointment.
*
* Adds new element(s) to the existing list
*
* @param serviceCategory
* High-level category
*
* @return
* A reference to this Builder instance
*/
public Builder serviceCategory(CodeableConcept... serviceCategory) {
for (CodeableConcept value : serviceCategory) {
this.serviceCategory.add(value);
}
return this;
}
/**
* A broad categorization of the service that is to be performed during this appointment.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param serviceCategory
* High-level category
*
* @return
* A reference to this Builder instance
*/
public Builder serviceCategory(Collection serviceCategory) {
this.serviceCategory = new ArrayList<>(serviceCategory);
return this;
}
/**
* The specific service that is to be performed during this appointment.
*
* Adds new element(s) to the existing list
*
* @param serviceType
* Specific service
*
* @return
* A reference to this Builder instance
*/
public Builder serviceType(CodeableConcept... serviceType) {
for (CodeableConcept value : serviceType) {
this.serviceType.add(value);
}
return this;
}
/**
* The specific service that is to be performed during this appointment.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param serviceType
* Specific service
*
* @return
* A reference to this Builder instance
*/
public Builder serviceType(Collection serviceType) {
this.serviceType = new ArrayList<>(serviceType);
return this;
}
/**
* The specialty of a practitioner that would be required to perform the service requested in this appointment.
*
* Adds new element(s) to the existing list
*
* @param specialty
* Type of specialty needed
*
* @return
* A reference to this Builder instance
*/
public Builder specialty(CodeableConcept... specialty) {
for (CodeableConcept value : specialty) {
this.specialty.add(value);
}
return this;
}
/**
* The specialty of a practitioner that would be required to perform the service requested in this appointment.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param specialty
* Type of specialty needed
*
* @return
* A reference to this Builder instance
*/
public Builder specialty(Collection specialty) {
this.specialty = new ArrayList<>(specialty);
return this;
}
/**
* Slots that reference this schedule resource provide the availability details to these referenced resource(s).
*
* Adds new element(s) to the existing list
*
*
This element is required.
*
*
Allowed resource types for the references:
*
* - {@link Patient}
* - {@link Practitioner}
* - {@link PractitionerRole}
* - {@link RelatedPerson}
* - {@link Device}
* - {@link HealthcareService}
* - {@link Location}
*
*
* @param actor
* Resource(s) that availability information is being provided for
*
* @return
* A reference to this Builder instance
*/
public Builder actor(Reference... actor) {
for (Reference value : actor) {
this.actor.add(value);
}
return this;
}
/**
* Slots that reference this schedule resource provide the availability details to these referenced resource(s).
*
* 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 Practitioner}
* - {@link PractitionerRole}
* - {@link RelatedPerson}
* - {@link Device}
* - {@link HealthcareService}
* - {@link Location}
*
*
* @param actor
* Resource(s) that availability information is being provided for
*
* @return
* A reference to this Builder instance
*/
public Builder actor(Collection actor) {
this.actor = new ArrayList<>(actor);
return this;
}
/**
* The period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the
* amount of time that an organization's planning horizon; the interval for which they are currently accepting
* appointments. This does not define a "template" for planning outside these dates.
*
* @param planningHorizon
* Period of time covered by schedule
*
* @return
* A reference to this Builder instance
*/
public Builder planningHorizon(Period planningHorizon) {
this.planningHorizon = planningHorizon;
return this;
}
/**
* Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be
* associated.
*
* @param comment
* Comments on availability
*
* @return
* A reference to this Builder instance
*/
public Builder comment(String comment) {
this.comment = comment;
return this;
}
/**
* Build the {@link Schedule}
*
* Required elements:
*
* - actor
*
*
* @return
* An immutable object of type {@link Schedule}
* @throws IllegalStateException
* if the current state cannot be built into a valid Schedule per the base specification
*/
@Override
public Schedule build() {
Schedule schedule = new Schedule(this);
if (validating) {
validate(schedule);
}
return schedule;
}
protected void validate(Schedule schedule) {
super.validate(schedule);
ValidationSupport.checkList(schedule.identifier, "identifier", Identifier.class);
ValidationSupport.checkList(schedule.serviceCategory, "serviceCategory", CodeableConcept.class);
ValidationSupport.checkList(schedule.serviceType, "serviceType", CodeableConcept.class);
ValidationSupport.checkList(schedule.specialty, "specialty", CodeableConcept.class);
ValidationSupport.checkNonEmptyList(schedule.actor, "actor", Reference.class);
ValidationSupport.checkReferenceType(schedule.actor, "actor", "Patient", "Practitioner", "PractitionerRole", "RelatedPerson", "Device", "HealthcareService", "Location");
}
protected Builder from(Schedule schedule) {
super.from(schedule);
identifier.addAll(schedule.identifier);
active = schedule.active;
serviceCategory.addAll(schedule.serviceCategory);
serviceType.addAll(schedule.serviceType);
specialty.addAll(schedule.specialty);
actor.addAll(schedule.actor);
planningHorizon = schedule.planningHorizon;
comment = schedule.comment;
return this;
}
}
}