Class Immunization.ProtocolApplied.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.Immunization.ProtocolApplied.Builder
-
- Enclosing class:
- Immunization.ProtocolApplied
public static class Immunization.ProtocolApplied.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 Immunization.ProtocolApplied.Builder
authority(Reference authority)
Indicates the authority who published the protocol (e.g.Immunization.ProtocolApplied
build()
Build theImmunization.ProtocolApplied
Immunization.ProtocolApplied.Builder
doseNumber(java.lang.String doseNumber)
Convenience method for settingdoseNumber
with choice type String.Immunization.ProtocolApplied.Builder
doseNumber(Element doseNumber)
Nominal position in a series.Immunization.ProtocolApplied.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.Immunization.ProtocolApplied.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.protected Immunization.ProtocolApplied.Builder
from(Immunization.ProtocolApplied protocolApplied)
Immunization.ProtocolApplied.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).Immunization.ProtocolApplied.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.Immunization.ProtocolApplied.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.Immunization.ProtocolApplied.Builder
series(java.lang.String series)
Convenience method for settingseries
.Immunization.ProtocolApplied.Builder
series(String series)
One possible path to achieve presumed immunity against a disease - within the context of an authority.Immunization.ProtocolApplied.Builder
seriesDoses(java.lang.String seriesDoses)
Convenience method for settingseriesDoses
with choice type String.Immunization.ProtocolApplied.Builder
seriesDoses(Element seriesDoses)
The recommended number of doses to achieve immunity.Immunization.ProtocolApplied.Builder
targetDisease(java.util.Collection<CodeableConcept> targetDisease)
The vaccine preventable disease the dose is being administered against.Immunization.ProtocolApplied.Builder
targetDisease(CodeableConcept... targetDisease)
The vaccine preventable disease the dose is being administered against.protected void
validate(Immunization.ProtocolApplied protocolApplied)
-
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 Immunization.ProtocolApplied.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 Immunization.ProtocolApplied.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 Immunization.ProtocolApplied.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 Immunization.ProtocolApplied.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 Immunization.ProtocolApplied.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
-
series
public Immunization.ProtocolApplied.Builder series(java.lang.String series)
Convenience method for settingseries
.- Parameters:
series
- Name of vaccine series- Returns:
- A reference to this Builder instance
- See Also:
series(org.linuxforhealth.fhir.model.type.String)
-
series
public Immunization.ProtocolApplied.Builder series(String series)
One possible path to achieve presumed immunity against a disease - within the context of an authority.- Parameters:
series
- Name of vaccine series- Returns:
- A reference to this Builder instance
-
authority
public Immunization.ProtocolApplied.Builder authority(Reference authority)
Indicates the authority who published the protocol (e.g. ACIP) that is being followed.Allowed resource types for this reference:
- Parameters:
authority
- Who is responsible for publishing the recommendations- Returns:
- A reference to this Builder instance
-
targetDisease
public Immunization.ProtocolApplied.Builder targetDisease(CodeableConcept... targetDisease)
The vaccine preventable disease the dose is being administered against.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
targetDisease
- Vaccine preventatable disease being targetted- Returns:
- A reference to this Builder instance
-
targetDisease
public Immunization.ProtocolApplied.Builder targetDisease(java.util.Collection<CodeableConcept> targetDisease)
The vaccine preventable disease the dose is being administered against.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:
targetDisease
- Vaccine preventatable disease being targetted- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
doseNumber
public Immunization.ProtocolApplied.Builder doseNumber(java.lang.String doseNumber)
Convenience method for settingdoseNumber
with choice type String.This element is required.
- Parameters:
doseNumber
- Dose number within series- Returns:
- A reference to this Builder instance
- See Also:
doseNumber(Element)
-
doseNumber
public Immunization.ProtocolApplied.Builder doseNumber(Element doseNumber)
Nominal position in a series.This element is required.
This is a choice element with the following allowed types:
- Parameters:
doseNumber
- Dose number within series- Returns:
- A reference to this Builder instance
-
seriesDoses
public Immunization.ProtocolApplied.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 Immunization.ProtocolApplied.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
-
build
public Immunization.ProtocolApplied build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
Immunization.ProtocolApplied
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid ProtocolApplied per the base specification
-
validate
protected void validate(Immunization.ProtocolApplied protocolApplied)
-
from
protected Immunization.ProtocolApplied.Builder from(Immunization.ProtocolApplied protocolApplied)
-
-