Class Practitioner.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.Practitioner.Builder
-
- Enclosing class:
- Practitioner
public static class Practitioner.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 Practitioner.Builder
active(java.lang.Boolean active)
Convenience method for settingactive
.Practitioner.Builder
active(Boolean active)
Whether this practitioner's record is in active use.Practitioner.Builder
address(java.util.Collection<Address> address)
Address(es) of the practitioner that are not role specific (typically home address).Practitioner.Builder
address(Address... address)
Address(es) of the practitioner that are not role specific (typically home address).Practitioner.Builder
birthDate(java.time.LocalDate birthDate)
Convenience method for settingbirthDate
.Practitioner.Builder
birthDate(Date birthDate)
The date of birth for the practitioner.Practitioner
build()
Build thePractitioner
Practitioner.Builder
communication(java.util.Collection<CodeableConcept> communication)
A language the practitioner can use in patient communication.Practitioner.Builder
communication(CodeableConcept... communication)
A language the practitioner can use in patient communication.Practitioner.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.Practitioner.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.Practitioner.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.Practitioner.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource.protected Practitioner.Builder
from(Practitioner practitioner)
Practitioner.Builder
gender(AdministrativeGender gender)
Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.Practitioner.Builder
id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource.Practitioner.Builder
identifier(java.util.Collection<Identifier> identifier)
An identifier that applies to this person in this role.Practitioner.Builder
identifier(Identifier... identifier)
An identifier that applies to this person in this role.Practitioner.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.Practitioner.Builder
language(Code language)
The base language in which the resource is written.Practitioner.Builder
meta(Meta meta)
The metadata about the resource.Practitioner.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.Practitioner.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.Practitioner.Builder
name(java.util.Collection<HumanName> name)
The name(s) associated with the practitioner.Practitioner.Builder
name(HumanName... name)
The name(s) associated with the practitioner.Practitioner.Builder
photo(java.util.Collection<Attachment> photo)
Image of the person.Practitioner.Builder
photo(Attachment... photo)
Image of the person.Practitioner.Builder
qualification(java.util.Collection<Practitioner.Qualification> qualification)
The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner.Practitioner.Builder
qualification(Practitioner.Qualification... qualification)
The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner.Practitioner.Builder
telecom(java.util.Collection<ContactPoint> telecom)
A contact detail for the practitioner, e.g.Practitioner.Builder
telecom(ContactPoint... telecom)
A contact detail for the practitioner, e.g.Practitioner.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(Practitioner practitioner)
-
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 Practitioner.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 Practitioner.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 Practitioner.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 Practitioner.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 Practitioner.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 Practitioner.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 Practitioner.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 Practitioner.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 Practitioner.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 Practitioner.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 Practitioner.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 Practitioner.Builder identifier(Identifier... identifier)
An identifier that applies to this person in this role.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
identifier
- An identifier for the person as this agent- Returns:
- A reference to this Builder instance
-
identifier
public Practitioner.Builder identifier(java.util.Collection<Identifier> identifier)
An identifier that applies to this person in this role.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
- An identifier for the person as this agent- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
active
public Practitioner.Builder active(java.lang.Boolean active)
Convenience method for settingactive
.- Parameters:
active
- Whether this practitioner's record is in active use- Returns:
- A reference to this Builder instance org.linuxforhealth.fhir
- See Also:
active(org.linuxforhealth.fhir.model.type.Boolean)
-
active
public Practitioner.Builder active(Boolean active)
Whether this practitioner's record is in active use.- Parameters:
active
- Whether this practitioner's record is in active use- Returns:
- A reference to this Builder instance
-
name
public Practitioner.Builder name(HumanName... name)
The name(s) associated with the practitioner.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
name
- The name(s) associated with the practitioner- Returns:
- A reference to this Builder instance
-
name
public Practitioner.Builder name(java.util.Collection<HumanName> name)
The name(s) associated with the practitioner.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:
name
- The name(s) associated with the practitioner- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
telecom
public Practitioner.Builder telecom(ContactPoint... telecom)
A contact detail for the practitioner, e.g. a telephone number or an email address.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
telecom
- A contact detail for the practitioner (that apply to all roles)- Returns:
- A reference to this Builder instance
-
telecom
public Practitioner.Builder telecom(java.util.Collection<ContactPoint> telecom)
A contact detail for the practitioner, e.g. a telephone number or an email address.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:
telecom
- A contact detail for the practitioner (that apply to all roles)- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
address
public Practitioner.Builder address(Address... address)
Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
address
- Address(es) of the practitioner that are not role specific (typically home address)- Returns:
- A reference to this Builder instance
-
address
public Practitioner.Builder address(java.util.Collection<Address> address)
Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.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:
address
- Address(es) of the practitioner that are not role specific (typically home address)- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
gender
public Practitioner.Builder gender(AdministrativeGender gender)
Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.- Parameters:
gender
- male | female | other | unknown- Returns:
- A reference to this Builder instance
-
birthDate
public Practitioner.Builder birthDate(java.time.LocalDate birthDate)
Convenience method for settingbirthDate
.- Parameters:
birthDate
- The date on which the practitioner was born- See Also:
birthDate(org.linuxforhealth.fhir.model.type.Date)
-
birthDate
public Practitioner.Builder birthDate(Date birthDate)
The date of birth for the practitioner.- Parameters:
birthDate
- The date on which the practitioner was born- Returns:
- A reference to this Builder instance
-
photo
public Practitioner.Builder photo(Attachment... photo)
Image of the person.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
photo
- Image of the person- Returns:
- A reference to this Builder instance
-
photo
public Practitioner.Builder photo(java.util.Collection<Attachment> photo)
Image of the person.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:
photo
- Image of the person- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
qualification
public Practitioner.Builder qualification(Practitioner.Qualification... qualification)
The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
qualification
- Certification, licenses, or training pertaining to the provision of care- Returns:
- A reference to this Builder instance
-
qualification
public Practitioner.Builder qualification(java.util.Collection<Practitioner.Qualification> qualification)
The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.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:
qualification
- Certification, licenses, or training pertaining to the provision of care- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
communication
public Practitioner.Builder communication(CodeableConcept... communication)
A language the practitioner can use in patient communication.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
communication
- A language the practitioner can use in patient communication- Returns:
- A reference to this Builder instance
-
communication
public Practitioner.Builder communication(java.util.Collection<CodeableConcept> communication)
A language the practitioner can use in patient communication.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:
communication
- A language the practitioner can use in patient communication- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
build
public Practitioner build()
Build thePractitioner
- Specified by:
build
in interfaceBuilder<Resource>
- Specified by:
build
in classDomainResource.Builder
- Returns:
- An immutable object of type
Practitioner
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Practitioner per the base specification
-
validate
protected void validate(Practitioner practitioner)
-
from
protected Practitioner.Builder from(Practitioner practitioner)
-
-