Package org.linuxforhealth.fhir.model.resource

Class Appointment.Participant.Builder

java.lang.Object

org.linuxforhealth.fhir.model.builder.AbstractBuilder<Element>

org.linuxforhealth.fhir.model.type.Element.Builder

org.linuxforhealth.fhir.model.type.BackboneElement.Builder

org.linuxforhealth.fhir.model.resource.Appointment.Participant.Builder

All Implemented Interfaces:

Builder<Element>

Enclosing class:

Appointment.Participant

public static class Appointment.Participant.Builder
extends BackboneElement.Builder

Field Summary

Fields inherited from class org.linuxforhealth.fhir.model.type.BackboneElement.Builder

modifierExtension

Fields inherited from class org.linuxforhealth.fhir.model.type.Element.Builder

extension, id

Fields inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder

validating

Method Summary

Modifier and Type	Method	Description
Appointment.Participant.Builder	actor(Reference actor)	A Person, Location/HealthcareService or Device that is participating in the appointment.
Appointment.Participant	build()	Build the Appointment.Participant
Appointment.Participant.Builder	extension(java.util.Collection<Extension> extension)	May be used to represent additional information that is not part of the basic definition of the element.
Appointment.Participant.Builder	extension(Extension... extension)	May be used to represent additional information that is not part of the basic definition of the element.
protected Appointment.Participant.Builder	from(Appointment.Participant participant)
Appointment.Participant.Builder	id(java.lang.String id)	Unique id for the element within a resource (for internal references).
Appointment.Participant.Builder	modifierExtension(java.util.Collection<Extension> 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.
Appointment.Participant.Builder	modifierExtension(Extension... 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.
Appointment.Participant.Builder	period(Period period)	Participation period of the actor.
Appointment.Participant.Builder	required(ParticipantRequired required)	Whether this participant is required to be present at the meeting.
Appointment.Participant.Builder	status(ParticipationStatus status)	Participation status of the actor.
Appointment.Participant.Builder	type(java.util.Collection<CodeableConcept> type)	Role of participant in the appointment.
Appointment.Participant.Builder	type(CodeableConcept... type)	Role of participant in the appointment.
protected void	validate(Appointment.Participant participant)

Methods inherited from class org.linuxforhealth.fhir.model.type.BackboneElement.Builder

from, validate

Methods inherited from class org.linuxforhealth.fhir.model.type.Element.Builder

from, validate

Methods inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder

isValidating, setValidating

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

id

public Appointment.Participant.Builder id(java.lang.String id)

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Overrides:

id in class BackboneElement.Builder

Parameters:

id - Unique id for inter-element referencing

Returns:

A reference to this Builder instance

extension

public Appointment.Participant.Builder extension(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.

Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

Overrides:

extension in class BackboneElement.Builder

Parameters:

extension - Additional content defined by implementations

Returns:

A reference to this Builder instance

extension

public Appointment.Participant.Builder extension(java.util.Collection<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. If any of the elements are null, calling build() will fail.

Overrides:

extension in class BackboneElement.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 Appointment.Participant.Builder modifierExtension(Extension... 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).

Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

Overrides:

modifierExtension in class BackboneElement.Builder

Parameters:

modifierExtension - Extensions that cannot be ignored even if unrecognized

Returns:

A reference to this Builder instance

modifierExtension

public Appointment.Participant.Builder modifierExtension(java.util.Collection<Extension> 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. If any of the elements are null, calling build() will fail.

Overrides:

modifierExtension in class BackboneElement.Builder

Parameters:

modifierExtension - Extensions that cannot be ignored even if unrecognized

Returns:

A reference to this Builder instance

Throws:

java.lang.NullPointerException - If the passed collection is null

type

public Appointment.Participant.Builder type(CodeableConcept... type)

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:

type - Role of participant in the appointment

Returns:

A reference to this Builder instance

type

public Appointment.Participant.Builder type(java.util.Collection<CodeableConcept> type)

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:

type - 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 Appointment.Participant.Builder actor(Reference actor)

A Person, Location/HealthcareService or Device that is participating in the appointment.

Allowed resource types for this reference:

• Patient
• Practitioner
• PractitionerRole
• RelatedPerson
• Device
• HealthcareService
• Location

Parameters:

actor - Person, Location/HealthcareService or Device

Returns:

A reference to this Builder instance

required

public Appointment.Participant.Builder required(ParticipantRequired required)

Whether this participant is required to be present at the meeting. This covers a use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present.

Parameters:

required - required | optional | information-only

Returns:

A reference to this Builder instance

status

public Appointment.Participant.Builder status(ParticipationStatus status)

Participation status of the actor.

This element is required.

Parameters:

status - accepted | declined | tentative | needs-action

Returns:

A reference to this Builder instance

period

public Appointment.Participant.Builder period(Period period)

Participation period of the actor.

Parameters:

period - Participation period of the actor

Returns:

A reference to this Builder instance

build

public Appointment.Participant build()

Build the Appointment.Participant

Required elements:

• status

Specified by:

build in interface Builder<Element>

Specified by:

build in class BackboneElement.Builder

Returns:

An immutable object of type Appointment.Participant

Throws:

java.lang.IllegalStateException - if the current state cannot be built into a valid Participant per the base specification

validate

protected void validate(Appointment.Participant participant)

from

protected Appointment.Participant.Builder from(Appointment.Participant participant)