Class ImmunizationRecommendation.Recommendation.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.ImmunizationRecommendation.Recommendation.Builder
-
- Enclosing class:
- ImmunizationRecommendation.Recommendation
public static class ImmunizationRecommendation.Recommendation.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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ImmunizationRecommendation.Recommendation
build()
ImmunizationRecommendation.Recommendation.Builder
contraindicatedVaccineCode(java.util.Collection<CodeableConcept> contraindicatedVaccineCode)
Vaccine(s) which should not be used to fulfill the recommendation.ImmunizationRecommendation.Recommendation.Builder
contraindicatedVaccineCode(CodeableConcept... contraindicatedVaccineCode)
Vaccine(s) which should not be used to fulfill the recommendation.ImmunizationRecommendation.Recommendation.Builder
dateCriterion(java.util.Collection<ImmunizationRecommendation.Recommendation.DateCriterion> dateCriterion)
Vaccine date recommendations.ImmunizationRecommendation.Recommendation.Builder
dateCriterion(ImmunizationRecommendation.Recommendation.DateCriterion... dateCriterion)
Vaccine date recommendations.ImmunizationRecommendation.Recommendation.Builder
description(java.lang.String description)
Convenience method for settingdescription
.ImmunizationRecommendation.Recommendation.Builder
description(String description)
Contains the description about the protocol under which the vaccine was administered.ImmunizationRecommendation.Recommendation.Builder
doseNumber(java.lang.String doseNumber)
Convenience method for settingdoseNumber
with choice type String.ImmunizationRecommendation.Recommendation.Builder
doseNumber(Element doseNumber)
Nominal position of the recommended dose in a series (e.g.ImmunizationRecommendation.Recommendation.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.ImmunizationRecommendation.Recommendation.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.ImmunizationRecommendation.Recommendation.Builder
forecastReason(java.util.Collection<CodeableConcept> forecastReason)
The reason for the assigned forecast status.ImmunizationRecommendation.Recommendation.Builder
forecastReason(CodeableConcept... forecastReason)
The reason for the assigned forecast status.ImmunizationRecommendation.Recommendation.Builder
forecastStatus(CodeableConcept forecastStatus)
Indicates the patient status with respect to the path to immunity for the target disease.protected ImmunizationRecommendation.Recommendation.Builder
from(ImmunizationRecommendation.Recommendation recommendation)
ImmunizationRecommendation.Recommendation.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).ImmunizationRecommendation.Recommendation.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.ImmunizationRecommendation.Recommendation.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.ImmunizationRecommendation.Recommendation.Builder
series(java.lang.String series)
Convenience method for settingseries
.ImmunizationRecommendation.Recommendation.Builder
series(String series)
One possible path to achieve presumed immunity against a disease - within the context of an authority.ImmunizationRecommendation.Recommendation.Builder
seriesDoses(java.lang.String seriesDoses)
Convenience method for settingseriesDoses
with choice type String.ImmunizationRecommendation.Recommendation.Builder
seriesDoses(Element seriesDoses)
The recommended number of doses to achieve immunity.ImmunizationRecommendation.Recommendation.Builder
supportingImmunization(java.util.Collection<Reference> supportingImmunization)
Immunization event history and/or evaluation that supports the status and recommendation.ImmunizationRecommendation.Recommendation.Builder
supportingImmunization(Reference... supportingImmunization)
Immunization event history and/or evaluation that supports the status and recommendation.ImmunizationRecommendation.Recommendation.Builder
supportingPatientInformation(java.util.Collection<Reference> supportingPatientInformation)
Patient Information that supports the status and recommendation.ImmunizationRecommendation.Recommendation.Builder
supportingPatientInformation(Reference... supportingPatientInformation)
Patient Information that supports the status and recommendation.ImmunizationRecommendation.Recommendation.Builder
targetDisease(CodeableConcept targetDisease)
The targeted disease for the recommendation.ImmunizationRecommendation.Recommendation.Builder
vaccineCode(java.util.Collection<CodeableConcept> vaccineCode)
Vaccine(s) or vaccine group that pertain to the recommendation.ImmunizationRecommendation.Recommendation.Builder
vaccineCode(CodeableConcept... vaccineCode)
Vaccine(s) or vaccine group that pertain to the recommendation.protected void
validate(ImmunizationRecommendation.Recommendation recommendation)
-
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
-
-
-
-
Method Detail
-
id
public ImmunizationRecommendation.Recommendation.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 classBackboneElement.Builder
- Parameters:
id
- Unique id for inter-element referencing- Returns:
- A reference to this Builder instance
-
extension
public ImmunizationRecommendation.Recommendation.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 classBackboneElement.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public ImmunizationRecommendation.Recommendation.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 classBackboneElement.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 ImmunizationRecommendation.Recommendation.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 classBackboneElement.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored even if unrecognized- Returns:
- A reference to this Builder instance
-
modifierExtension
public ImmunizationRecommendation.Recommendation.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 classBackboneElement.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
-
vaccineCode
public ImmunizationRecommendation.Recommendation.Builder vaccineCode(CodeableConcept... vaccineCode)
Vaccine(s) or vaccine group that pertain to the recommendation.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
vaccineCode
- Vaccine or vaccine group recommendation applies to- Returns:
- A reference to this Builder instance
-
vaccineCode
public ImmunizationRecommendation.Recommendation.Builder vaccineCode(java.util.Collection<CodeableConcept> vaccineCode)
Vaccine(s) or vaccine group that pertain to the recommendation.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:
vaccineCode
- Vaccine or vaccine group recommendation applies to- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
targetDisease
public ImmunizationRecommendation.Recommendation.Builder targetDisease(CodeableConcept targetDisease)
The targeted disease for the recommendation.- Parameters:
targetDisease
- Disease to be immunized against- Returns:
- A reference to this Builder instance
-
contraindicatedVaccineCode
public ImmunizationRecommendation.Recommendation.Builder contraindicatedVaccineCode(CodeableConcept... contraindicatedVaccineCode)
Vaccine(s) which should not be used to fulfill the recommendation.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
contraindicatedVaccineCode
- Vaccine which is contraindicated to fulfill the recommendation- Returns:
- A reference to this Builder instance
-
contraindicatedVaccineCode
public ImmunizationRecommendation.Recommendation.Builder contraindicatedVaccineCode(java.util.Collection<CodeableConcept> contraindicatedVaccineCode)
Vaccine(s) which should not be used to fulfill the recommendation.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:
contraindicatedVaccineCode
- Vaccine which is contraindicated to fulfill the recommendation- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
forecastStatus
public ImmunizationRecommendation.Recommendation.Builder forecastStatus(CodeableConcept forecastStatus)
Indicates the patient status with respect to the path to immunity for the target disease.This element is required.
- Parameters:
forecastStatus
- Vaccine recommendation status- Returns:
- A reference to this Builder instance
-
forecastReason
public ImmunizationRecommendation.Recommendation.Builder forecastReason(CodeableConcept... forecastReason)
The reason for the assigned forecast status.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
forecastReason
- Vaccine administration status reason- Returns:
- A reference to this Builder instance
-
forecastReason
public ImmunizationRecommendation.Recommendation.Builder forecastReason(java.util.Collection<CodeableConcept> forecastReason)
The reason for the assigned forecast status.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:
forecastReason
- Vaccine administration status reason- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
dateCriterion
public ImmunizationRecommendation.Recommendation.Builder dateCriterion(ImmunizationRecommendation.Recommendation.DateCriterion... dateCriterion)
Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
dateCriterion
- Dates governing proposed immunization- Returns:
- A reference to this Builder instance
-
dateCriterion
public ImmunizationRecommendation.Recommendation.Builder dateCriterion(java.util.Collection<ImmunizationRecommendation.Recommendation.DateCriterion> dateCriterion)
Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.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:
dateCriterion
- Dates governing proposed immunization- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
description
public ImmunizationRecommendation.Recommendation.Builder description(java.lang.String description)
Convenience method for settingdescription
.- Parameters:
description
- Protocol details- Returns:
- A reference to this Builder instance
- See Also:
description(org.linuxforhealth.fhir.model.type.String)
-
description
public ImmunizationRecommendation.Recommendation.Builder description(String description)
Contains the description about the protocol under which the vaccine was administered.- Parameters:
description
- Protocol details- Returns:
- A reference to this Builder instance
-
series
public ImmunizationRecommendation.Recommendation.Builder series(java.lang.String series)
Convenience method for settingseries
.- Parameters:
series
- Name of vaccination series- Returns:
- A reference to this Builder instance
- See Also:
series(org.linuxforhealth.fhir.model.type.String)
-
series
public ImmunizationRecommendation.Recommendation.Builder series(String series)
One possible path to achieve presumed immunity against a disease - within the context of an authority.- Parameters:
series
- Name of vaccination series- Returns:
- A reference to this Builder instance
-
doseNumber
public ImmunizationRecommendation.Recommendation.Builder doseNumber(java.lang.String doseNumber)
Convenience method for settingdoseNumber
with choice type String.- Parameters:
doseNumber
- Recommended dose number within series- Returns:
- A reference to this Builder instance
- See Also:
doseNumber(Element)
-
doseNumber
public ImmunizationRecommendation.Recommendation.Builder doseNumber(Element doseNumber)
Nominal position of the recommended dose in a series (e.g. dose 2 is the next recommended dose).This is a choice element with the following allowed types:
- Parameters:
doseNumber
- Recommended dose number within series- Returns:
- A reference to this Builder instance
-
seriesDoses
public ImmunizationRecommendation.Recommendation.Builder seriesDoses(java.lang.String seriesDoses)
Convenience method for settingseriesDoses
with choice type String.- Parameters:
seriesDoses
- Recommended number of doses for immunity- Returns:
- A reference to this Builder instance
- See Also:
seriesDoses(Element)
-
seriesDoses
public ImmunizationRecommendation.Recommendation.Builder seriesDoses(Element seriesDoses)
The recommended number of doses to achieve immunity.This is a choice element with the following allowed types:
- Parameters:
seriesDoses
- Recommended number of doses for immunity- Returns:
- A reference to this Builder instance
-
supportingImmunization
public ImmunizationRecommendation.Recommendation.Builder supportingImmunization(Reference... supportingImmunization)
Immunization event history and/or evaluation that supports the status and recommendation.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:
supportingImmunization
- Past immunizations supporting recommendation- Returns:
- A reference to this Builder instance
-
supportingImmunization
public ImmunizationRecommendation.Recommendation.Builder supportingImmunization(java.util.Collection<Reference> supportingImmunization)
Immunization event history and/or evaluation that supports the status and recommendation.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:
supportingImmunization
- Past immunizations supporting recommendation- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
supportingPatientInformation
public ImmunizationRecommendation.Recommendation.Builder supportingPatientInformation(Reference... supportingPatientInformation)
Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
supportingPatientInformation
- Patient observations supporting recommendation- Returns:
- A reference to this Builder instance
-
supportingPatientInformation
public ImmunizationRecommendation.Recommendation.Builder supportingPatientInformation(java.util.Collection<Reference> supportingPatientInformation)
Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.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:
supportingPatientInformation
- Patient observations supporting recommendation- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
build
public ImmunizationRecommendation.Recommendation build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
ImmunizationRecommendation.Recommendation
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Recommendation per the base specification
-
validate
protected void validate(ImmunizationRecommendation.Recommendation recommendation)
-
from
protected ImmunizationRecommendation.Recommendation.Builder from(ImmunizationRecommendation.Recommendation recommendation)
-
-