Class Patient.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.Patient.Builder
-
- Enclosing class:
- Patient
public static class Patient.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 Patient.Builder
active(java.lang.Boolean active)
Convenience method for settingactive
.Patient.Builder
active(Boolean active)
Whether this patient record is in active use.Patient.Builder
address(java.util.Collection<Address> address)
An address for the individual.Patient.Builder
address(Address... address)
An address for the individual.Patient.Builder
birthDate(java.time.LocalDate birthDate)
Convenience method for settingbirthDate
.Patient.Builder
birthDate(Date birthDate)
The date of birth for the individual.Patient
build()
Build thePatient
Patient.Builder
communication(java.util.Collection<Patient.Communication> communication)
A language which may be used to communicate with the patient about his or her health.Patient.Builder
communication(Patient.Communication... communication)
A language which may be used to communicate with the patient about his or her health.Patient.Builder
contact(java.util.Collection<Patient.Contact> contact)
A contact party (e.g.Patient.Builder
contact(Patient.Contact... contact)
A contact party (e.g.Patient.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.Patient.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.Patient.Builder
deceased(java.lang.Boolean deceased)
Convenience method for settingdeceased
with choice type Boolean.Patient.Builder
deceased(Element deceased)
Indicates if the individual is deceased or not.Patient.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.Patient.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource.protected Patient.Builder
from(Patient patient)
Patient.Builder
gender(AdministrativeGender gender)
Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.Patient.Builder
generalPractitioner(java.util.Collection<Reference> generalPractitioner)
Patient's nominated care provider.Patient.Builder
generalPractitioner(Reference... generalPractitioner)
Patient's nominated care provider.Patient.Builder
id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource.Patient.Builder
identifier(java.util.Collection<Identifier> identifier)
An identifier for this patient.Patient.Builder
identifier(Identifier... identifier)
An identifier for this patient.Patient.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.Patient.Builder
language(Code language)
The base language in which the resource is written.Patient.Builder
link(java.util.Collection<Patient.Link> link)
Link to another patient resource that concerns the same actual patient.Patient.Builder
link(Patient.Link... link)
Link to another patient resource that concerns the same actual patient.Patient.Builder
managingOrganization(Reference managingOrganization)
Organization that is the custodian of the patient record.Patient.Builder
maritalStatus(CodeableConcept maritalStatus)
This field contains a patient's most recent marital (civil) status.Patient.Builder
meta(Meta meta)
The metadata about the resource.Patient.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.Patient.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.Patient.Builder
multipleBirth(java.lang.Boolean multipleBirth)
Convenience method for settingmultipleBirth
with choice type Boolean.Patient.Builder
multipleBirth(java.lang.Integer multipleBirth)
Convenience method for settingmultipleBirth
with choice type Integer.Patient.Builder
multipleBirth(Element multipleBirth)
Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).Patient.Builder
name(java.util.Collection<HumanName> name)
A name associated with the individual.Patient.Builder
name(HumanName... name)
A name associated with the individual.Patient.Builder
photo(java.util.Collection<Attachment> photo)
Image of the patient.Patient.Builder
photo(Attachment... photo)
Image of the patient.Patient.Builder
telecom(java.util.Collection<ContactPoint> telecom)
A contact detail (e.g.Patient.Builder
telecom(ContactPoint... telecom)
A contact detail (e.g.Patient.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(Patient patient)
-
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 Patient.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 Patient.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 Patient.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 Patient.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 Patient.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 Patient.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 Patient.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 Patient.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 Patient.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 Patient.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 Patient.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 Patient.Builder identifier(Identifier... identifier)
An identifier for this patient.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
identifier
- An identifier for this patient- Returns:
- A reference to this Builder instance
-
identifier
public Patient.Builder identifier(java.util.Collection<Identifier> identifier)
An identifier for this patient.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 this patient- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
active
public Patient.Builder active(java.lang.Boolean active)
Convenience method for settingactive
.- Parameters:
active
- Whether this patient's record is in active use- Returns:
- A reference to this Builder instance
- See Also:
active(org.linuxforhealth.fhir.model.type.Boolean)
-
active
public Patient.Builder active(Boolean active)
Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.It is often used to filter patient lists to exclude inactive patients
Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.
- Parameters:
active
- Whether this patient's record is in active use- Returns:
- A reference to this Builder instance
-
name
public Patient.Builder name(HumanName... name)
A name associated with the individual.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
name
- A name associated with the patient- Returns:
- A reference to this Builder instance
-
name
public Patient.Builder name(java.util.Collection<HumanName> name)
A name associated with the individual.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
- A name associated with the patient- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
telecom
public Patient.Builder telecom(ContactPoint... telecom)
A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.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 individual- Returns:
- A reference to this Builder instance
-
telecom
public Patient.Builder telecom(java.util.Collection<ContactPoint> telecom)
A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.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 individual- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
gender
public Patient.Builder gender(AdministrativeGender gender)
Administrative Gender - the gender that the patient 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 Patient.Builder birthDate(java.time.LocalDate birthDate)
Convenience method for settingbirthDate
.- Parameters:
birthDate
- The date of birth for the individual- Returns:
- A reference to this Builder instance
- See Also:
birthDate(org.linuxforhealth.fhir.model.type.Date)
-
birthDate
public Patient.Builder birthDate(Date birthDate)
The date of birth for the individual.- Parameters:
birthDate
- The date of birth for the individual- Returns:
- A reference to this Builder instance
-
deceased
public Patient.Builder deceased(java.lang.Boolean deceased)
Convenience method for settingdeceased
with choice type Boolean.- Parameters:
deceased
- Indicates if the individual is deceased or not- Returns:
- A reference to this Builder instance
- See Also:
deceased(Element)
-
deceased
public Patient.Builder deceased(Element deceased)
Indicates if the individual is deceased or not.This is a choice element with the following allowed types:
- Parameters:
deceased
- Indicates if the individual is deceased or not- Returns:
- A reference to this Builder instance
-
address
public Patient.Builder address(Address... address)
An address for the individual.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
address
- An address for the individual- Returns:
- A reference to this Builder instance
-
address
public Patient.Builder address(java.util.Collection<Address> address)
An address for the individual.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
- An address for the individual- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
maritalStatus
public Patient.Builder maritalStatus(CodeableConcept maritalStatus)
This field contains a patient's most recent marital (civil) status.- Parameters:
maritalStatus
- Marital (civil) status of a patient- Returns:
- A reference to this Builder instance
-
multipleBirth
public Patient.Builder multipleBirth(java.lang.Boolean multipleBirth)
Convenience method for settingmultipleBirth
with choice type Boolean.- Parameters:
multipleBirth
- Whether patient is part of a multiple birth- Returns:
- A reference to this Builder instance
- See Also:
multipleBirth(Element)
-
multipleBirth
public Patient.Builder multipleBirth(java.lang.Integer multipleBirth)
Convenience method for settingmultipleBirth
with choice type Integer.- Parameters:
multipleBirth
- Whether patient is part of a multiple birth- Returns:
- A reference to this Builder instance
- See Also:
multipleBirth(Element)
-
multipleBirth
public Patient.Builder multipleBirth(Element multipleBirth)
Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).This is a choice element with the following allowed types:
- Parameters:
multipleBirth
- Whether patient is part of a multiple birth- Returns:
- A reference to this Builder instance
-
photo
public Patient.Builder photo(Attachment... photo)
Image of the patient.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
photo
- Image of the patient- Returns:
- A reference to this Builder instance
-
photo
public Patient.Builder photo(java.util.Collection<Attachment> photo)
Image of the patient.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 patient- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
contact
public Patient.Builder contact(Patient.Contact... contact)
A contact party (e.g. guardian, partner, friend) for the patient.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
contact
- A contact party (e.g. guardian, partner, friend) for the patient- Returns:
- A reference to this Builder instance
-
contact
public Patient.Builder contact(java.util.Collection<Patient.Contact> contact)
A contact party (e.g. guardian, partner, friend) for the patient.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:
contact
- A contact party (e.g. guardian, partner, friend) for the patient- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
communication
public Patient.Builder communication(Patient.Communication... communication)
A language which may be used to communicate with the patient about his or her health.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
communication
- A language which may be used to communicate with the patient about his or her health- Returns:
- A reference to this Builder instance
-
communication
public Patient.Builder communication(java.util.Collection<Patient.Communication> communication)
A language which may be used to communicate with the patient about his or her health.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 which may be used to communicate with the patient about his or her health- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
generalPractitioner
public Patient.Builder generalPractitioner(Reference... generalPractitioner)
Patient's nominated care provider.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.Allowed resource types for the references:
- Parameters:
generalPractitioner
- Patient's nominated primary care provider- Returns:
- A reference to this Builder instance
-
generalPractitioner
public Patient.Builder generalPractitioner(java.util.Collection<Reference> generalPractitioner)
Patient's nominated care provider.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.Allowed resource types for the references:
- Parameters:
generalPractitioner
- Patient's nominated primary care provider- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
managingOrganization
public Patient.Builder managingOrganization(Reference managingOrganization)
Organization that is the custodian of the patient record.Allowed resource types for this reference:
- Parameters:
managingOrganization
- Organization that is the custodian of the patient record- Returns:
- A reference to this Builder instance
-
link
public Patient.Builder link(Patient.Link... link)
Link to another patient resource that concerns the same actual patient.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
link
- Link to another patient resource that concerns the same actual person- Returns:
- A reference to this Builder instance
-
link
public Patient.Builder link(java.util.Collection<Patient.Link> link)
Link to another patient resource that concerns the same actual patient.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:
link
- Link to another patient resource that concerns the same actual person- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
validate
protected void validate(Patient patient)
-
from
protected Patient.Builder from(Patient patient)
-
-