Class AppointmentResponse.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.AppointmentResponse.Builder
-
- Enclosing class:
- AppointmentResponse
public static class AppointmentResponse.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 AppointmentResponse.Builder
actor(Reference actor)
A Person, Location, HealthcareService, or Device that is participating in the appointment.AppointmentResponse.Builder
appointment(Reference appointment)
Appointment that this response is replying to.AppointmentResponse
build()
Build theAppointmentResponse
AppointmentResponse.Builder
comment(java.lang.String comment)
Convenience method for settingcomment
.AppointmentResponse.Builder
comment(String comment)
Additional comments about the appointment.AppointmentResponse.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.AppointmentResponse.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.AppointmentResponse.Builder
end(java.time.ZonedDateTime end)
Convenience method for settingend
.AppointmentResponse.Builder
end(Instant end)
This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.AppointmentResponse.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.AppointmentResponse.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource.protected AppointmentResponse.Builder
from(AppointmentResponse appointmentResponse)
AppointmentResponse.Builder
id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource.AppointmentResponse.Builder
identifier(java.util.Collection<Identifier> identifier)
This records identifiers associated with this appointment response concern that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate.AppointmentResponse.Builder
identifier(Identifier... identifier)
This records identifiers associated with this appointment response concern that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate.AppointmentResponse.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.AppointmentResponse.Builder
language(Code language)
The base language in which the resource is written.AppointmentResponse.Builder
meta(Meta meta)
The metadata about the resource.AppointmentResponse.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.AppointmentResponse.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.AppointmentResponse.Builder
participantStatus(ParticipantStatus participantStatus)
Participation status of the participant.AppointmentResponse.Builder
participantType(java.util.Collection<CodeableConcept> participantType)
Role of participant in the appointment.AppointmentResponse.Builder
participantType(CodeableConcept... participantType)
Role of participant in the appointment.AppointmentResponse.Builder
start(java.time.ZonedDateTime start)
Convenience method for settingstart
.AppointmentResponse.Builder
start(Instant start)
Date/Time that the appointment is to take place, or requested new start time.AppointmentResponse.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(AppointmentResponse appointmentResponse)
-
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 AppointmentResponse.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 AppointmentResponse.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 AppointmentResponse.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 AppointmentResponse.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 AppointmentResponse.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 AppointmentResponse.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 AppointmentResponse.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 AppointmentResponse.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 AppointmentResponse.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 AppointmentResponse.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 AppointmentResponse.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 AppointmentResponse.Builder identifier(Identifier... identifier)
This records identifiers associated with this appointment response concern that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate.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 AppointmentResponse.Builder identifier(java.util.Collection<Identifier> identifier)
This records identifiers associated with this appointment response concern that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate.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
-
appointment
public AppointmentResponse.Builder appointment(Reference appointment)
Appointment that this response is replying to.This element is required.
Allowed resource types for this reference:
- Parameters:
appointment
- Appointment this response relates to- Returns:
- A reference to this Builder instance
-
start
public AppointmentResponse.Builder start(java.time.ZonedDateTime start)
Convenience method for settingstart
.- Parameters:
start
- Time from appointment, or requested new start time- Returns:
- A reference to this Builder instance
- See Also:
start(org.linuxforhealth.fhir.model.type.Instant)
-
start
public AppointmentResponse.Builder start(Instant start)
Date/Time that the appointment is to take place, or requested new start time.- Parameters:
start
- Time from appointment, or requested new start time- Returns:
- A reference to this Builder instance
-
end
public AppointmentResponse.Builder end(java.time.ZonedDateTime end)
Convenience method for settingend
.- Parameters:
end
- Time from appointment, or requested new end time- Returns:
- A reference to this Builder instance
- See Also:
end(org.linuxforhealth.fhir.model.type.Instant)
-
end
public AppointmentResponse.Builder end(Instant end)
This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.- Parameters:
end
- Time from appointment, or requested new end time- Returns:
- A reference to this Builder instance
-
participantType
public AppointmentResponse.Builder participantType(CodeableConcept... participantType)
Role of participant in the appointment.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
participantType
- Role of participant in the appointment- Returns:
- A reference to this Builder instance
-
participantType
public AppointmentResponse.Builder participantType(java.util.Collection<CodeableConcept> participantType)
Role of participant in the 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:
participantType
- Role of participant in the appointment- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
actor
public AppointmentResponse.Builder actor(Reference actor)
A Person, Location, HealthcareService, or Device that is participating in the appointment.Allowed resource types for this reference:
- Parameters:
actor
- Person, Location, HealthcareService, or Device- Returns:
- A reference to this Builder instance
-
participantStatus
public AppointmentResponse.Builder participantStatus(ParticipantStatus participantStatus)
Participation status of the participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty.This element is required.
- Parameters:
participantStatus
- accepted | declined | tentative | needs-action- Returns:
- A reference to this Builder instance
-
comment
public AppointmentResponse.Builder comment(java.lang.String comment)
Convenience method for settingcomment
.- Parameters:
comment
- Additional comments- Returns:
- A reference to this Builder instance
- See Also:
comment(org.linuxforhealth.fhir.model.type.String)
-
comment
public AppointmentResponse.Builder comment(String comment)
Additional comments about the appointment.- Parameters:
comment
- Additional comments- Returns:
- A reference to this Builder instance
-
build
public AppointmentResponse build()
- Specified by:
build
in interfaceBuilder<Resource>
- Specified by:
build
in classDomainResource.Builder
- Returns:
- An immutable object of type
AppointmentResponse
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid AppointmentResponse per the base specification
-
validate
protected void validate(AppointmentResponse appointmentResponse)
-
from
protected AppointmentResponse.Builder from(AppointmentResponse appointmentResponse)
-
-