Class PractitionerRole.Builder
- java.lang.Object
-
- com.ibm.fhir.model.builder.AbstractBuilder<Resource>
-
- com.ibm.fhir.model.resource.Resource.Builder
-
- com.ibm.fhir.model.resource.DomainResource.Builder
-
- com.ibm.fhir.model.resource.PractitionerRole.Builder
-
- Enclosing class:
- PractitionerRole
public static class PractitionerRole.Builder extends DomainResource.Builder
-
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.resource.DomainResource.Builder
contained, extension, modifierExtension, text
-
Fields inherited from class com.ibm.fhir.model.resource.Resource.Builder
id, implicitRules, language, meta
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PractitionerRole.Builder
active(Boolean active)
Whether this practitioner role record is in active use.PractitionerRole.Builder
availabilityExceptions(String availabilityExceptions)
A description of site availability exceptions, e.g.PractitionerRole.Builder
availableTime(PractitionerRole.AvailableTime... availableTime)
A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.PractitionerRole.Builder
availableTime(Collection<PractitionerRole.AvailableTime> availableTime)
A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.PractitionerRole
build()
Build thePractitionerRole
PractitionerRole.Builder
code(CodeableConcept... code)
Roles which this practitioner is authorized to perform for the organization.PractitionerRole.Builder
code(Collection<CodeableConcept> code)
Roles which this practitioner is authorized to perform for the organization.PractitionerRole.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.PractitionerRole.Builder
contained(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.PractitionerRole.Builder
endpoint(Reference... endpoint)
Technical endpoints providing access to services operated for the practitioner with this role.PractitionerRole.Builder
endpoint(Collection<Reference> endpoint)
Technical endpoints providing access to services operated for the practitioner with this role.PractitionerRole.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource.PractitionerRole.Builder
extension(Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the resource.protected PractitionerRole.Builder
from(PractitionerRole practitionerRole)
PractitionerRole.Builder
healthcareService(Reference... healthcareService)
The list of healthcare services that this worker provides for this role's Organization/Location(s).PractitionerRole.Builder
healthcareService(Collection<Reference> healthcareService)
The list of healthcare services that this worker provides for this role's Organization/Location(s).PractitionerRole.Builder
id(String id)
The logical id of the resource, as used in the URL for the resource.PractitionerRole.Builder
identifier(Identifier... identifier)
Business Identifiers that are specific to a role/location.PractitionerRole.Builder
identifier(Collection<Identifier> identifier)
Business Identifiers that are specific to a role/location.PractitionerRole.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.PractitionerRole.Builder
language(Code language)
The base language in which the resource is written.PractitionerRole.Builder
location(Reference... location)
The location(s) at which this practitioner provides care.PractitionerRole.Builder
location(Collection<Reference> location)
The location(s) at which this practitioner provides care.PractitionerRole.Builder
meta(Meta meta)
The metadata about the resource.PractitionerRole.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.PractitionerRole.Builder
modifierExtension(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.PractitionerRole.Builder
notAvailable(PractitionerRole.NotAvailable... notAvailable)
The practitioner is not available or performing this role during this period of time due to the provided reason.PractitionerRole.Builder
notAvailable(Collection<PractitionerRole.NotAvailable> notAvailable)
The practitioner is not available or performing this role during this period of time due to the provided reason.PractitionerRole.Builder
organization(Reference organization)
The organization where the Practitioner performs the roles associated.PractitionerRole.Builder
period(Period period)
The period during which the person is authorized to act as a practitioner in these role(s) for the organization.PractitionerRole.Builder
practitioner(Reference practitioner)
Practitioner that is able to provide the defined services for the organization.PractitionerRole.Builder
specialty(CodeableConcept... specialty)
Specific specialty of the practitioner.PractitionerRole.Builder
specialty(Collection<CodeableConcept> specialty)
Specific specialty of the practitioner.PractitionerRole.Builder
telecom(ContactPoint... telecom)
Contact details that are specific to the role/location/service.PractitionerRole.Builder
telecom(Collection<ContactPoint> telecom)
Contact details that are specific to the role/location/service.PractitionerRole.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.-
Methods inherited from class com.ibm.fhir.model.resource.DomainResource.Builder
from
-
Methods inherited from class com.ibm.fhir.model.resource.Resource.Builder
from
-
-
-
-
Method Detail
-
id
public PractitionerRole.Builder id(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 PractitionerRole.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 PractitionerRole.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 PractitionerRole.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 PractitionerRole.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 PractitionerRole.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
- Overrides:
contained
in classDomainResource.Builder
- Parameters:
contained
- Contained, inline Resources- Returns:
- A reference to this Builder instance
-
contained
public PractitionerRole.Builder contained(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
- Overrides:
contained
in classDomainResource.Builder
- Parameters:
contained
- Contained, inline Resources- Returns:
- A reference to this Builder instance
-
extension
public PractitionerRole.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
- Overrides:
extension
in classDomainResource.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public PractitionerRole.Builder extension(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
- Overrides:
extension
in classDomainResource.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
modifierExtension
public PractitionerRole.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
- Overrides:
modifierExtension
in classDomainResource.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored- Returns:
- A reference to this Builder instance
-
modifierExtension
public PractitionerRole.Builder modifierExtension(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
- Overrides:
modifierExtension
in classDomainResource.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored- Returns:
- A reference to this Builder instance
-
identifier
public PractitionerRole.Builder identifier(Identifier... identifier)
Business Identifiers that are specific to a role/location.Adds new element(s) to the existing list
- Parameters:
identifier
- Business Identifiers that are specific to a role/location- Returns:
- A reference to this Builder instance
-
identifier
public PractitionerRole.Builder identifier(Collection<Identifier> identifier)
Business Identifiers that are specific to a role/location.Replaces the existing list with a new one containing elements from the Collection
- Parameters:
identifier
- Business Identifiers that are specific to a role/location- Returns:
- A reference to this Builder instance
-
active
public PractitionerRole.Builder active(Boolean active)
Whether this practitioner role record is in active use.- Parameters:
active
- Whether this practitioner role record is in active use- Returns:
- A reference to this Builder instance
-
period
public PractitionerRole.Builder period(Period period)
The period during which the person is authorized to act as a practitioner in these role(s) for the organization.- Parameters:
period
- The period during which the practitioner is authorized to perform in these role(s)- Returns:
- A reference to this Builder instance
-
practitioner
public PractitionerRole.Builder practitioner(Reference practitioner)
Practitioner that is able to provide the defined services for the organization.Allowed resource types for this reference:
- Parameters:
practitioner
- Practitioner that is able to provide the defined services for the organization- Returns:
- A reference to this Builder instance
-
organization
public PractitionerRole.Builder organization(Reference organization)
The organization where the Practitioner performs the roles associated.Allowed resource types for this reference:
- Parameters:
organization
- Organization where the roles are available- Returns:
- A reference to this Builder instance
-
code
public PractitionerRole.Builder code(CodeableConcept... code)
Roles which this practitioner is authorized to perform for the organization.Adds new element(s) to the existing list
- Parameters:
code
- Roles which this practitioner may perform- Returns:
- A reference to this Builder instance
-
code
public PractitionerRole.Builder code(Collection<CodeableConcept> code)
Roles which this practitioner is authorized to perform for the organization.Replaces the existing list with a new one containing elements from the Collection
- Parameters:
code
- Roles which this practitioner may perform- Returns:
- A reference to this Builder instance
-
specialty
public PractitionerRole.Builder specialty(CodeableConcept... specialty)
Specific specialty of the practitioner.Adds new element(s) to the existing list
- Parameters:
specialty
- Specific specialty of the practitioner- Returns:
- A reference to this Builder instance
-
specialty
public PractitionerRole.Builder specialty(Collection<CodeableConcept> specialty)
Specific specialty of the practitioner.Replaces the existing list with a new one containing elements from the Collection
- Parameters:
specialty
- Specific specialty of the practitioner- Returns:
- A reference to this Builder instance
-
location
public PractitionerRole.Builder location(Reference... location)
The location(s) at which this practitioner provides care.Adds new element(s) to the existing list
- Parameters:
location
- The location(s) at which this practitioner provides care- Returns:
- A reference to this Builder instance
-
location
public PractitionerRole.Builder location(Collection<Reference> location)
The location(s) at which this practitioner provides care.Replaces the existing list with a new one containing elements from the Collection
- Parameters:
location
- The location(s) at which this practitioner provides care- Returns:
- A reference to this Builder instance
-
healthcareService
public PractitionerRole.Builder healthcareService(Reference... healthcareService)
The list of healthcare services that this worker provides for this role's Organization/Location(s).Adds new element(s) to the existing list
- Parameters:
healthcareService
- The list of healthcare services that this worker provides for this role's Organization/Location(s)- Returns:
- A reference to this Builder instance
-
healthcareService
public PractitionerRole.Builder healthcareService(Collection<Reference> healthcareService)
The list of healthcare services that this worker provides for this role's Organization/Location(s).Replaces the existing list with a new one containing elements from the Collection
- Parameters:
healthcareService
- The list of healthcare services that this worker provides for this role's Organization/Location(s)- Returns:
- A reference to this Builder instance
-
telecom
public PractitionerRole.Builder telecom(ContactPoint... telecom)
Contact details that are specific to the role/location/service.Adds new element(s) to the existing list
- Parameters:
telecom
- Contact details that are specific to the role/location/service- Returns:
- A reference to this Builder instance
-
telecom
public PractitionerRole.Builder telecom(Collection<ContactPoint> telecom)
Contact details that are specific to the role/location/service.Replaces the existing list with a new one containing elements from the Collection
- Parameters:
telecom
- Contact details that are specific to the role/location/service- Returns:
- A reference to this Builder instance
-
availableTime
public PractitionerRole.Builder availableTime(PractitionerRole.AvailableTime... availableTime)
A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.Adds new element(s) to the existing list
- Parameters:
availableTime
- Times the Service Site is available- Returns:
- A reference to this Builder instance
-
availableTime
public PractitionerRole.Builder availableTime(Collection<PractitionerRole.AvailableTime> availableTime)
A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.Replaces the existing list with a new one containing elements from the Collection
- Parameters:
availableTime
- Times the Service Site is available- Returns:
- A reference to this Builder instance
-
notAvailable
public PractitionerRole.Builder notAvailable(PractitionerRole.NotAvailable... notAvailable)
The practitioner is not available or performing this role during this period of time due to the provided reason.Adds new element(s) to the existing list
- Parameters:
notAvailable
- Not available during this time due to provided reason- Returns:
- A reference to this Builder instance
-
notAvailable
public PractitionerRole.Builder notAvailable(Collection<PractitionerRole.NotAvailable> notAvailable)
The practitioner is not available or performing this role during this period of time due to the provided reason.Replaces the existing list with a new one containing elements from the Collection
- Parameters:
notAvailable
- Not available during this time due to provided reason- Returns:
- A reference to this Builder instance
-
availabilityExceptions
public PractitionerRole.Builder availabilityExceptions(String availabilityExceptions)
A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.- Parameters:
availabilityExceptions
- Description of availability exceptions- Returns:
- A reference to this Builder instance
-
endpoint
public PractitionerRole.Builder endpoint(Reference... endpoint)
Technical endpoints providing access to services operated for the practitioner with this role.Adds new element(s) to the existing list
- Parameters:
endpoint
- Technical endpoints providing access to services operated for the practitioner with this role- Returns:
- A reference to this Builder instance
-
endpoint
public PractitionerRole.Builder endpoint(Collection<Reference> endpoint)
Technical endpoints providing access to services operated for the practitioner with this role.Replaces the existing list with a new one containing elements from the Collection
- Parameters:
endpoint
- Technical endpoints providing access to services operated for the practitioner with this role- Returns:
- A reference to this Builder instance
-
build
public PractitionerRole build()
Build thePractitionerRole
- Specified by:
build
in interfaceBuilder<Resource>
- Specified by:
build
in classDomainResource.Builder
- Returns:
- An immutable object of type
PractitionerRole
- Throws:
IllegalStateException
- if the current state cannot be built into a valid PractitionerRole per the base specification
-
from
protected PractitionerRole.Builder from(PractitionerRole practitionerRole)
-
-