Class ImmunizationEvaluation.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.ImmunizationEvaluation.Builder
-
- Enclosing class:
- ImmunizationEvaluation
public static class ImmunizationEvaluation.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 ImmunizationEvaluation.Builder
authority(Reference authority)
Indicates the authority who published the protocol (e.g.ImmunizationEvaluation
build()
Build theImmunizationEvaluation
ImmunizationEvaluation.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.ImmunizationEvaluation.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.ImmunizationEvaluation.Builder
date(DateTime date)
The date the evaluation of the vaccine administration event was performed.ImmunizationEvaluation.Builder
description(java.lang.String description)
Convenience method for settingdescription
.ImmunizationEvaluation.Builder
description(String description)
Additional information about the evaluation.ImmunizationEvaluation.Builder
doseNumber(java.lang.String doseNumber)
Convenience method for settingdoseNumber
with choice type String.ImmunizationEvaluation.Builder
doseNumber(Element doseNumber)
Nominal position in a series.ImmunizationEvaluation.Builder
doseStatus(CodeableConcept doseStatus)
Indicates if the dose is valid or not valid with respect to the published recommendations.ImmunizationEvaluation.Builder
doseStatusReason(java.util.Collection<CodeableConcept> doseStatusReason)
Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations.ImmunizationEvaluation.Builder
doseStatusReason(CodeableConcept... doseStatusReason)
Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations.ImmunizationEvaluation.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.ImmunizationEvaluation.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource.protected ImmunizationEvaluation.Builder
from(ImmunizationEvaluation immunizationEvaluation)
ImmunizationEvaluation.Builder
id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource.ImmunizationEvaluation.Builder
identifier(java.util.Collection<Identifier> identifier)
A unique identifier assigned to this immunization evaluation record.ImmunizationEvaluation.Builder
identifier(Identifier... identifier)
A unique identifier assigned to this immunization evaluation record.ImmunizationEvaluation.Builder
immunizationEvent(Reference immunizationEvent)
The vaccine administration event being evaluated.ImmunizationEvaluation.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.ImmunizationEvaluation.Builder
language(Code language)
The base language in which the resource is written.ImmunizationEvaluation.Builder
meta(Meta meta)
The metadata about the resource.ImmunizationEvaluation.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.ImmunizationEvaluation.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.ImmunizationEvaluation.Builder
patient(Reference patient)
The individual for whom the evaluation is being done.ImmunizationEvaluation.Builder
series(java.lang.String series)
Convenience method for settingseries
.ImmunizationEvaluation.Builder
series(String series)
One possible path to achieve presumed immunity against a disease - within the context of an authority.ImmunizationEvaluation.Builder
seriesDoses(java.lang.String seriesDoses)
Convenience method for settingseriesDoses
with choice type String.ImmunizationEvaluation.Builder
seriesDoses(Element seriesDoses)
The recommended number of doses to achieve immunity.ImmunizationEvaluation.Builder
status(ImmunizationEvaluationStatus status)
Indicates the current status of the evaluation of the vaccination administration event.ImmunizationEvaluation.Builder
targetDisease(CodeableConcept targetDisease)
The vaccine preventable disease the dose is being evaluated against.ImmunizationEvaluation.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(ImmunizationEvaluation immunizationEvaluation)
-
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 ImmunizationEvaluation.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 ImmunizationEvaluation.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 ImmunizationEvaluation.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 ImmunizationEvaluation.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 ImmunizationEvaluation.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 ImmunizationEvaluation.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 ImmunizationEvaluation.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 ImmunizationEvaluation.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 ImmunizationEvaluation.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 ImmunizationEvaluation.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 ImmunizationEvaluation.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 ImmunizationEvaluation.Builder identifier(Identifier... identifier)
A unique identifier assigned to this immunization evaluation record.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
identifier
- Business identifier- Returns:
- A reference to this Builder instance
-
identifier
public ImmunizationEvaluation.Builder identifier(java.util.Collection<Identifier> identifier)
A unique identifier assigned to this immunization evaluation record.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
- Business identifier- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
status
public ImmunizationEvaluation.Builder status(ImmunizationEvaluationStatus status)
Indicates the current status of the evaluation of the vaccination administration event.This element is required.
- Parameters:
status
- completed | entered-in-error- Returns:
- A reference to this Builder instance
-
patient
public ImmunizationEvaluation.Builder patient(Reference patient)
The individual for whom the evaluation is being done.This element is required.
Allowed resource types for this reference:
- Parameters:
patient
- Who this evaluation is for- Returns:
- A reference to this Builder instance
-
date
public ImmunizationEvaluation.Builder date(DateTime date)
The date the evaluation of the vaccine administration event was performed.- Parameters:
date
- Date evaluation was performed- Returns:
- A reference to this Builder instance
-
authority
public ImmunizationEvaluation.Builder authority(Reference authority)
Indicates the authority who published the protocol (e.g. ACIP).Allowed resource types for this reference:
- Parameters:
authority
- Who is responsible for publishing the recommendations- Returns:
- A reference to this Builder instance
-
targetDisease
public ImmunizationEvaluation.Builder targetDisease(CodeableConcept targetDisease)
The vaccine preventable disease the dose is being evaluated against.This element is required.
- Parameters:
targetDisease
- Evaluation target disease- Returns:
- A reference to this Builder instance
-
immunizationEvent
public ImmunizationEvaluation.Builder immunizationEvent(Reference immunizationEvent)
The vaccine administration event being evaluated.This element is required.
Allowed resource types for this reference:
- Parameters:
immunizationEvent
- Immunization being evaluated- Returns:
- A reference to this Builder instance
-
doseStatus
public ImmunizationEvaluation.Builder doseStatus(CodeableConcept doseStatus)
Indicates if the dose is valid or not valid with respect to the published recommendations.This element is required.
- Parameters:
doseStatus
- Status of the dose relative to published recommendations- Returns:
- A reference to this Builder instance
-
doseStatusReason
public ImmunizationEvaluation.Builder doseStatusReason(CodeableConcept... doseStatusReason)
Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
doseStatusReason
- Reason for the dose status- Returns:
- A reference to this Builder instance
-
doseStatusReason
public ImmunizationEvaluation.Builder doseStatusReason(java.util.Collection<CodeableConcept> doseStatusReason)
Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations.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:
doseStatusReason
- Reason for the dose status- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
description
public ImmunizationEvaluation.Builder description(java.lang.String description)
Convenience method for settingdescription
.- Parameters:
description
- Evaluation notes- Returns:
- A reference to this Builder instance
- See Also:
description(org.linuxforhealth.fhir.model.type.String)
-
description
public ImmunizationEvaluation.Builder description(String description)
Additional information about the evaluation.- Parameters:
description
- Evaluation notes- Returns:
- A reference to this Builder instance
-
series
public ImmunizationEvaluation.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 ImmunizationEvaluation.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
-
doseNumber
public ImmunizationEvaluation.Builder doseNumber(java.lang.String doseNumber)
Convenience method for settingdoseNumber
with choice type String.- Parameters:
doseNumber
- Dose number within series- Returns:
- A reference to this Builder instance
- See Also:
doseNumber(Element)
-
doseNumber
public ImmunizationEvaluation.Builder doseNumber(Element doseNumber)
Nominal position in a series.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 ImmunizationEvaluation.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 ImmunizationEvaluation.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 ImmunizationEvaluation build()
Build theImmunizationEvaluation
Required elements:
- status
- patient
- targetDisease
- immunizationEvent
- doseStatus
- Specified by:
build
in interfaceBuilder<Resource>
- Specified by:
build
in classDomainResource.Builder
- Returns:
- An immutable object of type
ImmunizationEvaluation
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid ImmunizationEvaluation per the base specification
-
validate
protected void validate(ImmunizationEvaluation immunizationEvaluation)
-
from
protected ImmunizationEvaluation.Builder from(ImmunizationEvaluation immunizationEvaluation)
-
-