Class Schedule.Builder
- java.lang.Object
-
- org.linuxforhealth.fhir.model.builder.AbstractBuilder<Resource>
-
- org.linuxforhealth.fhir.model.resource.Resource.Builder
-
- org.linuxforhealth.fhir.model.resource.DomainResource.Builder
-
- org.linuxforhealth.fhir.model.resource.Schedule.Builder
-
- Enclosing class:
- Schedule
public static class Schedule.Builder extends DomainResource.Builder
-
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource.Builder
contained, extension, modifierExtension, text
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.Resource.Builder
id, implicitRules, language, meta
-
Fields inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
validating
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Schedule.Builder
active(java.lang.Boolean active)
Convenience method for settingactive
.Schedule.Builder
active(Boolean active)
Whether this schedule record is in active use or should not be used (such as was entered in error).Schedule.Builder
actor(java.util.Collection<Reference> actor)
Slots that reference this schedule resource provide the availability details to these referenced resource(s).Schedule.Builder
actor(Reference... actor)
Slots that reference this schedule resource provide the availability details to these referenced resource(s).Schedule
build()
Build theSchedule
Schedule.Builder
comment(java.lang.String comment)
Convenience method for settingcomment
.Schedule.Builder
comment(String comment)
Comments on the availability to describe any extended information.Schedule.Builder
contained(java.util.Collection<Resource> contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.Schedule.Builder
contained(Resource... contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.Schedule.Builder
extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the resource.Schedule.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource.protected Schedule.Builder
from(Schedule schedule)
Schedule.Builder
id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource.Schedule.Builder
identifier(java.util.Collection<Identifier> identifier)
External Ids for this item.Schedule.Builder
identifier(Identifier... identifier)
External Ids for this item.Schedule.Builder
implicitRules(Uri implicitRules)
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.Schedule.Builder
language(Code language)
The base language in which the resource is written.Schedule.Builder
meta(Meta meta)
The metadata about the resource.Schedule.Builder
modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants.Schedule.Builder
modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants.Schedule.Builder
planningHorizon(Period planningHorizon)
The period of time that the slots that reference this Schedule resource cover (even if none exist).Schedule.Builder
serviceCategory(java.util.Collection<CodeableConcept> serviceCategory)
A broad categorization of the service that is to be performed during this appointment.Schedule.Builder
serviceCategory(CodeableConcept... serviceCategory)
A broad categorization of the service that is to be performed during this appointment.Schedule.Builder
serviceType(java.util.Collection<CodeableConcept> serviceType)
The specific service that is to be performed during this appointment.Schedule.Builder
serviceType(CodeableConcept... serviceType)
The specific service that is to be performed during this appointment.Schedule.Builder
specialty(java.util.Collection<CodeableConcept> specialty)
The specialty of a practitioner that would be required to perform the service requested in this appointment.Schedule.Builder
specialty(CodeableConcept... specialty)
The specialty of a practitioner that would be required to perform the service requested in this appointment.Schedule.Builder
text(Narrative text)
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human.protected void
validate(Schedule schedule)
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
isValidating, setValidating
-
-
-
-
Method Detail
-
id
public Schedule.Builder id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.- Overrides:
id
in classDomainResource.Builder
- Parameters:
id
- Logical id of this artifact- Returns:
- A reference to this Builder instance
-
meta
public Schedule.Builder meta(Meta meta)
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.- Overrides:
meta
in classDomainResource.Builder
- Parameters:
meta
- Metadata about the resource- Returns:
- A reference to this Builder instance
-
implicitRules
public Schedule.Builder implicitRules(Uri implicitRules)
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.- Overrides:
implicitRules
in classDomainResource.Builder
- Parameters:
implicitRules
- A set of rules under which this content was created- Returns:
- A reference to this Builder instance
-
language
public Schedule.Builder language(Code language)
The base language in which the resource is written.- Overrides:
language
in classDomainResource.Builder
- Parameters:
language
- Language of the resource content- Returns:
- A reference to this Builder instance
-
text
public Schedule.Builder text(Narrative text)
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.- Overrides:
text
in classDomainResource.Builder
- Parameters:
text
- Text summary of the resource, for human interpretation- Returns:
- A reference to this Builder instance
-
contained
public Schedule.Builder contained(Resource... contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
contained
in classDomainResource.Builder
- Parameters:
contained
- Contained, inline Resources- Returns:
- A reference to this Builder instance
-
contained
public Schedule.Builder contained(java.util.Collection<Resource> contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
contained
in classDomainResource.Builder
- Parameters:
contained
- Contained, inline Resources- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
extension
public Schedule.Builder extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classDomainResource.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public Schedule.Builder extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classDomainResource.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
modifierExtension
public Schedule.Builder modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classDomainResource.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored- Returns:
- A reference to this Builder instance
-
modifierExtension
public Schedule.Builder modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classDomainResource.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
identifier
public Schedule.Builder identifier(Identifier... identifier)
External Ids for this item.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
identifier
- External Ids for this item- Returns:
- A reference to this Builder instance
-
identifier
public Schedule.Builder identifier(java.util.Collection<Identifier> identifier)
External Ids for this item.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
identifier
- External Ids for this item- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
active
public Schedule.Builder active(java.lang.Boolean active)
Convenience method for settingactive
.- Parameters:
active
- Whether this schedule is in active use- Returns:
- A reference to this Builder instance
- See Also:
active(org.linuxforhealth.fhir.model.type.Boolean)
-
active
public Schedule.Builder active(Boolean active)
Whether this schedule record is in active use or should not be used (such as was entered in error).- Parameters:
active
- Whether this schedule is in active use- Returns:
- A reference to this Builder instance
-
serviceCategory
public Schedule.Builder serviceCategory(CodeableConcept... serviceCategory)
A broad categorization of the service that is to be performed during this appointment.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
serviceCategory
- High-level category- Returns:
- A reference to this Builder instance
-
serviceCategory
public Schedule.Builder serviceCategory(java.util.Collection<CodeableConcept> serviceCategory)
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. If any of the elements are null, calling
build()
will fail.- Parameters:
serviceCategory
- High-level category- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
serviceType
public Schedule.Builder serviceType(CodeableConcept... serviceType)
The specific service that is to be performed during this appointment.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
serviceType
- Specific service- Returns:
- A reference to this Builder instance
-
serviceType
public Schedule.Builder serviceType(java.util.Collection<CodeableConcept> serviceType)
The specific service that is to be performed during this appointment.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
serviceType
- Specific service- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
specialty
public Schedule.Builder specialty(CodeableConcept... specialty)
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. If any of the elements are null, calling
build()
will fail.- Parameters:
specialty
- Type of specialty needed- Returns:
- A reference to this Builder instance
-
specialty
public Schedule.Builder specialty(java.util.Collection<CodeableConcept> specialty)
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. If any of the elements are null, calling
build()
will fail.- Parameters:
specialty
- Type of specialty needed- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
actor
public Schedule.Builder actor(Reference... actor)
Slots that reference this schedule resource provide the availability details to these referenced resource(s).Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.This element is required.
Allowed resource types for the references:
- Parameters:
actor
- Resource(s) that availability information is being provided for- Returns:
- A reference to this Builder instance
-
actor
public Schedule.Builder actor(java.util.Collection<Reference> actor)
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. If any of the elements are null, calling
build()
will fail.This element is required.
Allowed resource types for the references:
- Parameters:
actor
- Resource(s) that availability information is being provided for- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
planningHorizon
public Schedule.Builder planningHorizon(Period planningHorizon)
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.- Parameters:
planningHorizon
- Period of time covered by schedule- Returns:
- A reference to this Builder instance
-
comment
public Schedule.Builder comment(java.lang.String comment)
Convenience method for settingcomment
.- Parameters:
comment
- Comments on availability- Returns:
- A reference to this Builder instance
- See Also:
comment(org.linuxforhealth.fhir.model.type.String)
-
comment
public Schedule.Builder comment(String comment)
Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.- Parameters:
comment
- Comments on availability- Returns:
- A reference to this Builder instance
-
build
public Schedule build()
-
validate
protected void validate(Schedule schedule)
-
from
protected Schedule.Builder from(Schedule schedule)
-
-