java.lang.Object
- org.hl7.fhir.r4b.model.Base
- - org.hl7.fhir.r4b.model.BaseResource
  - - org.hl7.fhir.r4b.model.Resource
    - - org.hl7.fhir.r4b.model.DomainResource
      - org.hl7.fhir.r4b.model.Immunization

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource
```
public class Immunization
extends DomainResource
```
Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`Immunization.ImmunizationEducationComponent`
`static class`	`Immunization.ImmunizationPerformerComponent`
`static class`	`Immunization.ImmunizationProtocolAppliedComponent`
`static class`	`Immunization.ImmunizationReactionComponent`
`static class`	`Immunization.ImmunizationStatusCodes`
`static class`	`Immunization.ImmunizationStatusCodesEnumFactory`

Field Summary

Fields
Modifier and Type	Field	Description
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`DATE`	Fluent Client search parameter constant for date
`protected Quantity`	`doseQuantity`	The quantity of vaccine product that was administered.
`protected List<Immunization.ImmunizationEducationComponent>`	`education`	Educational material presented to the patient (or guardian) at the time of vaccine administration.
`protected Reference`	`encounter`	The visit or admission or other contact between patient and health care provider the immunization was performed as part of.
`protected DateType`	`expirationDate`	Date vaccine batch expires.
`protected CodeableConcept`	`fundingSource`	Indicates the source of the vaccine actually administered.
`protected List<Identifier>`	`identifier`	A unique identifier assigned to this immunization record.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`IDENTIFIER`	Fluent Client search parameter constant for identifier
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_LOCATION`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_MANUFACTURER`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PATIENT`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PERFORMER`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_REACTION`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_REASON_REFERENCE`	Constant for fluent queries to be used to add include statements.
`protected BooleanType`	`isSubpotent`	Indication if a dose is considered to be subpotent.
`protected Reference`	`location`	The service delivery location where the vaccine administration occurred.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`LOCATION`	Fluent Client search parameter constant for location
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`LOT_NUMBER`	Fluent Client search parameter constant for lot-number
`protected StringType`	`lotNumber`	Lot number of the vaccine product.
`protected Reference`	`manufacturer`	Name of vaccine manufacturer.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`MANUFACTURER`	Fluent Client search parameter constant for manufacturer
`protected List<Annotation>`	`note`	Extra information about the immunization that is not conveyed by the other attributes.
`protected DataType`	`occurrence`	Date vaccine administered or was to be administered.
`protected Reference`	`patient`	The patient who either received or did not receive the immunization.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PATIENT`	Fluent Client search parameter constant for patient
`protected List<Immunization.ImmunizationPerformerComponent>`	`performer`	Indicates who performed the immunization event.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PERFORMER`	Fluent Client search parameter constant for performer
`protected BooleanType`	`primarySource`	An indication that the content of the record is based on information from the person who administered the vaccine.
`protected List<CodeableConcept>`	`programEligibility`	Indicates a patient's eligibility for a funding program.
`protected List<Immunization.ImmunizationProtocolAppliedComponent>`	`protocolApplied`	The protocol (set of recommendations) being followed by the provider who administered the dose.
`protected List<Immunization.ImmunizationReactionComponent>`	`reaction`	Categorical data indicating that an adverse event is associated in time to an immunization.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`REACTION`	Fluent Client search parameter constant for reaction
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`REACTION_DATE`	Fluent Client search parameter constant for reaction-date
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`REASON_CODE`	Fluent Client search parameter constant for reason-code
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`REASON_REFERENCE`	Fluent Client search parameter constant for reason-reference
`protected List<CodeableConcept>`	`reasonCode`	Reasons why the vaccine was administered.
`protected List<Reference>`	`reasonReference`	Condition, Observation or DiagnosticReport that supports why the immunization was administered.
`protected DateTimeType`	`recorded`	The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
`protected CodeableConcept`	`reportOrigin`	The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
`protected CodeableConcept`	`route`	The path by which the vaccine product is taken into the body.
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`SERIES`	Fluent Client search parameter constant for series
`protected CodeableConcept`	`site`	Body site where vaccine was administered.
`static String`	`SP_DATE`	Search parameter: date
`static String`	`SP_IDENTIFIER`	Search parameter: identifier
`static String`	`SP_LOCATION`	Search parameter: location
`static String`	`SP_LOT_NUMBER`	Search parameter: lot-number
`static String`	`SP_MANUFACTURER`	Search parameter: manufacturer
`static String`	`SP_PATIENT`	Search parameter: patient
`static String`	`SP_PERFORMER`	Search parameter: performer
`static String`	`SP_REACTION`	Search parameter: reaction
`static String`	`SP_REACTION_DATE`	Search parameter: reaction-date
`static String`	`SP_REASON_CODE`	Search parameter: reason-code
`static String`	`SP_REASON_REFERENCE`	Search parameter: reason-reference
`static String`	`SP_SERIES`	Search parameter: series
`static String`	`SP_STATUS`	Search parameter: status
`static String`	`SP_STATUS_REASON`	Search parameter: status-reason
`static String`	`SP_TARGET_DISEASE`	Search parameter: target-disease
`static String`	`SP_VACCINE_CODE`	Search parameter: vaccine-code
`protected Enumeration<Immunization.ImmunizationStatusCodes>`	`status`	Indicates the current status of the immunization event.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`STATUS`	Fluent Client search parameter constant for status
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`STATUS_REASON`	Fluent Client search parameter constant for status-reason
`protected CodeableConcept`	`statusReason`	Indicates the reason the immunization event was not performed.
`protected List<CodeableConcept>`	`subpotentReason`	Reason why a dose is considered to be subpotent.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`TARGET_DISEASE`	Fluent Client search parameter constant for target-disease
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`VACCINE_CODE`	Fluent Client search parameter constant for vaccine-code
`protected CodeableConcept`	`vaccineCode`	Vaccine that was administered or was to be administered.

Fields inherited from class org.hl7.fhir.r4b.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT

Fields inherited from class org.hl7.fhir.r4b.model.Resource
id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor	Description
`Immunization()`	Constructor
`Immunization(Immunization.ImmunizationStatusCodes status, CodeableConcept vaccineCode, Reference patient, DataType occurrence)`	Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Base`	`addChild(String name)`
`Immunization.ImmunizationEducationComponent`	`addEducation()`
`Immunization`	`addEducation(Immunization.ImmunizationEducationComponent t)`
`Identifier`	`addIdentifier()`
`Immunization`	`addIdentifier(Identifier t)`
`Annotation`	`addNote()`
`Immunization`	`addNote(Annotation t)`
`Immunization.ImmunizationPerformerComponent`	`addPerformer()`
`Immunization`	`addPerformer(Immunization.ImmunizationPerformerComponent t)`
`CodeableConcept`	`addProgramEligibility()`
`Immunization`	`addProgramEligibility(CodeableConcept t)`
`Immunization.ImmunizationProtocolAppliedComponent`	`addProtocolApplied()`
`Immunization`	`addProtocolApplied(Immunization.ImmunizationProtocolAppliedComponent t)`
`Immunization.ImmunizationReactionComponent`	`addReaction()`
`Immunization`	`addReaction(Immunization.ImmunizationReactionComponent t)`
`CodeableConcept`	`addReasonCode()`
`Immunization`	`addReasonCode(CodeableConcept t)`
`Reference`	`addReasonReference()`
`Immunization`	`addReasonReference(Reference t)`
`CodeableConcept`	`addSubpotentReason()`
`Immunization`	`addSubpotentReason(CodeableConcept t)`
`Immunization`	`copy()`
`void`	`copyValues(Immunization dst)`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`Quantity`	`getDoseQuantity()`
`List<Immunization.ImmunizationEducationComponent>`	`getEducation()`
`Immunization.ImmunizationEducationComponent`	`getEducationFirstRep()`
`Reference`	`getEncounter()`
`Date`	`getExpirationDate()`
`DateType`	`getExpirationDateElement()`
`CodeableConcept`	`getFundingSource()`
`List<Identifier>`	`getIdentifier()`
`Identifier`	`getIdentifierFirstRep()`
`boolean`	`getIsSubpotent()`
`BooleanType`	`getIsSubpotentElement()`
`Reference`	`getLocation()`
`String`	`getLotNumber()`
`StringType`	`getLotNumberElement()`
`Reference`	`getManufacturer()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`List<Annotation>`	`getNote()`
`Annotation`	`getNoteFirstRep()`
`DataType`	`getOccurrence()`
`DateTimeType`	`getOccurrenceDateTimeType()`
`StringType`	`getOccurrenceStringType()`
`Reference`	`getPatient()`
`List<Immunization.ImmunizationPerformerComponent>`	`getPerformer()`
`Immunization.ImmunizationPerformerComponent`	`getPerformerFirstRep()`
`boolean`	`getPrimarySource()`
`BooleanType`	`getPrimarySourceElement()`
`List<CodeableConcept>`	`getProgramEligibility()`
`CodeableConcept`	`getProgramEligibilityFirstRep()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`List<Immunization.ImmunizationProtocolAppliedComponent>`	`getProtocolApplied()`
`Immunization.ImmunizationProtocolAppliedComponent`	`getProtocolAppliedFirstRep()`
`List<Immunization.ImmunizationReactionComponent>`	`getReaction()`
`Immunization.ImmunizationReactionComponent`	`getReactionFirstRep()`
`List<CodeableConcept>`	`getReasonCode()`
`CodeableConcept`	`getReasonCodeFirstRep()`
`List<Reference>`	`getReasonReference()`
`Reference`	`getReasonReferenceFirstRep()`
`Date`	`getRecorded()`
`DateTimeType`	`getRecordedElement()`
`CodeableConcept`	`getReportOrigin()`
`ResourceType`	`getResourceType()`
`CodeableConcept`	`getRoute()`
`CodeableConcept`	`getSite()`
`Immunization.ImmunizationStatusCodes`	`getStatus()`
`Enumeration<Immunization.ImmunizationStatusCodes>`	`getStatusElement()`
`CodeableConcept`	`getStatusReason()`
`List<CodeableConcept>`	`getSubpotentReason()`
`CodeableConcept`	`getSubpotentReasonFirstRep()`
`String[]`	`getTypesForProperty(int hash, String name)`
`CodeableConcept`	`getVaccineCode()`
`boolean`	`hasDoseQuantity()`
`boolean`	`hasEducation()`
`boolean`	`hasEncounter()`
`boolean`	`hasExpirationDate()`
`boolean`	`hasExpirationDateElement()`
`boolean`	`hasFundingSource()`
`boolean`	`hasIdentifier()`
`boolean`	`hasIsSubpotent()`
`boolean`	`hasIsSubpotentElement()`
`boolean`	`hasLocation()`
`boolean`	`hasLotNumber()`
`boolean`	`hasLotNumberElement()`
`boolean`	`hasManufacturer()`
`boolean`	`hasNote()`
`boolean`	`hasOccurrence()`
`boolean`	`hasOccurrenceDateTimeType()`
`boolean`	`hasOccurrenceStringType()`
`boolean`	`hasPatient()`
`boolean`	`hasPerformer()`
`boolean`	`hasPrimarySource()`
`boolean`	`hasPrimarySourceElement()`
`boolean`	`hasProgramEligibility()`
`boolean`	`hasProtocolApplied()`
`boolean`	`hasReaction()`
`boolean`	`hasReasonCode()`
`boolean`	`hasReasonReference()`
`boolean`	`hasRecorded()`
`boolean`	`hasRecordedElement()`
`boolean`	`hasReportOrigin()`
`boolean`	`hasRoute()`
`boolean`	`hasSite()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasStatusReason()`
`boolean`	`hasSubpotentReason()`
`boolean`	`hasVaccineCode()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`Immunization`	`setDoseQuantity(Quantity value)`
`Immunization`	`setEducation(List<Immunization.ImmunizationEducationComponent> theEducation)`
`Immunization`	`setEncounter(Reference value)`
`Immunization`	`setExpirationDate(Date value)`
`Immunization`	`setExpirationDateElement(DateType value)`
`Immunization`	`setFundingSource(CodeableConcept value)`
`Immunization`	`setIdentifier(List<Identifier> theIdentifier)`
`Immunization`	`setIsSubpotent(boolean value)`
`Immunization`	`setIsSubpotentElement(BooleanType value)`
`Immunization`	`setLocation(Reference value)`
`Immunization`	`setLotNumber(String value)`
`Immunization`	`setLotNumberElement(StringType value)`
`Immunization`	`setManufacturer(Reference value)`
`Immunization`	`setNote(List<Annotation> theNote)`
`Immunization`	`setOccurrence(DataType value)`
`Immunization`	`setPatient(Reference value)`
`Immunization`	`setPerformer(List<Immunization.ImmunizationPerformerComponent> thePerformer)`
`Immunization`	`setPrimarySource(boolean value)`
`Immunization`	`setPrimarySourceElement(BooleanType value)`
`Immunization`	`setProgramEligibility(List<CodeableConcept> theProgramEligibility)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`Immunization`	`setProtocolApplied(List<Immunization.ImmunizationProtocolAppliedComponent> theProtocolApplied)`
`Immunization`	`setReaction(List<Immunization.ImmunizationReactionComponent> theReaction)`
`Immunization`	`setReasonCode(List<CodeableConcept> theReasonCode)`
`Immunization`	`setReasonReference(List<Reference> theReasonReference)`
`Immunization`	`setRecorded(Date value)`
`Immunization`	`setRecordedElement(DateTimeType value)`
`Immunization`	`setReportOrigin(CodeableConcept value)`
`Immunization`	`setRoute(CodeableConcept value)`
`Immunization`	`setSite(CodeableConcept value)`
`Immunization`	`setStatus(Immunization.ImmunizationStatusCodes value)`
`Immunization`	`setStatusElement(Enumeration<Immunization.ImmunizationStatusCodes> value)`
`Immunization`	`setStatusReason(CodeableConcept value)`
`Immunization`	`setSubpotentReason(List<CodeableConcept> theSubpotentReason)`
`Immunization`	`setVaccineCode(CodeableConcept value)`
`protected Immunization`	`typedCopy()`

Methods inherited from class org.hl7.fhir.r4b.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.r4b.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.r4b.model.BaseResource
getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r4b.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, setId

- Field Detail
  - identifier
```
protected List<Identifier> identifier
```
    A unique identifier assigned to this immunization record.
  - status
```
protected Enumeration<Immunization.ImmunizationStatusCodes> status
```
    Indicates the current status of the immunization event.
  - statusReason
```
protected CodeableConcept statusReason
```
    Indicates the reason the immunization event was not performed.
  - vaccineCode
```
protected CodeableConcept vaccineCode
```
    Vaccine that was administered or was to be administered.
  - patient
```
protected Reference patient
```
    The patient who either received or did not receive the immunization.
  - encounter
```
protected Reference encounter
```
    The visit or admission or other contact between patient and health care provider the immunization was performed as part of.
  - occurrence
```
protected DataType occurrence
```
    Date vaccine administered or was to be administered.
  - recorded
```
protected DateTimeType recorded
```
    The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
  - primarySource
```
protected BooleanType primarySource
```
    An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.
  - reportOrigin
```
protected CodeableConcept reportOrigin
```
    The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
  - location
```
protected Reference location
```
    The service delivery location where the vaccine administration occurred.
  - manufacturer
```
protected Reference manufacturer
```
    Name of vaccine manufacturer.
  - lotNumber
```
protected StringType lotNumber
```
    Lot number of the vaccine product.
  - expirationDate
```
protected DateType expirationDate
```
    Date vaccine batch expires.
  - site
```
protected CodeableConcept site
```
    Body site where vaccine was administered.
  - route
```
protected CodeableConcept route
```
    The path by which the vaccine product is taken into the body.
  - doseQuantity
```
protected Quantity doseQuantity
```
    The quantity of vaccine product that was administered.
  - performer
```
protected List<Immunization.ImmunizationPerformerComponent> performer
```
    Indicates who performed the immunization event.
  - note
```
protected List<Annotation> note
```
    Extra information about the immunization that is not conveyed by the other attributes.
  - reasonCode
```
protected List<CodeableConcept> reasonCode
```
    Reasons why the vaccine was administered.
  - reasonReference
```
protected List<Reference> reasonReference
```
    Condition, Observation or DiagnosticReport that supports why the immunization was administered.
  - isSubpotent
```
protected BooleanType isSubpotent
```
    Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
  - subpotentReason
```
protected List<CodeableConcept> subpotentReason
```
    Reason why a dose is considered to be subpotent.
  - education
```
protected List<Immunization.ImmunizationEducationComponent> education
```
    Educational material presented to the patient (or guardian) at the time of vaccine administration.
  - programEligibility
```
protected List<CodeableConcept> programEligibility
```
    Indicates a patient's eligibility for a funding program.
  - fundingSource
```
protected CodeableConcept fundingSource
```
    Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).
  - reaction
```
protected List<Immunization.ImmunizationReactionComponent> reaction
```
    Categorical data indicating that an adverse event is associated in time to an immunization.
  - protocolApplied
```
protected List<Immunization.ImmunizationProtocolAppliedComponent> protocolApplied
```
    The protocol (set of recommendations) being followed by the provider who administered the dose.
  - SP_LOCATION
```
public static final String SP_LOCATION
```
    Search parameter: location
    Description: The service delivery location or facility in which the vaccine was / was to be administered
    Type: reference
    Path: Immunization.location
    
    See Also:
    
    Constant Field Values
  - LOCATION
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam LOCATION
```
    Fluent Client search parameter constant for location
    Description: The service delivery location or facility in which the vaccine was / was to be administered
    Type: reference
    Path: Immunization.location
  - INCLUDE_LOCATION
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_LOCATION
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization:location".
  - SP_LOT_NUMBER
```
public static final String SP_LOT_NUMBER
```
    Search parameter: lot-number
    Description: Vaccine Lot Number
    Type: string
    Path: Immunization.lotNumber
    
    See Also:
    
    Constant Field Values
  - LOT_NUMBER
```
public static final ca.uhn.fhir.rest.gclient.StringClientParam LOT_NUMBER
```
    Fluent Client search parameter constant for lot-number
    Description: Vaccine Lot Number
    Type: string
    Path: Immunization.lotNumber
  - SP_MANUFACTURER
```
public static final String SP_MANUFACTURER
```
    Search parameter: manufacturer
    Description: Vaccine Manufacturer
    Type: reference
    Path: Immunization.manufacturer
    
    See Also:
    
    Constant Field Values
  - MANUFACTURER
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam MANUFACTURER
```
    Fluent Client search parameter constant for manufacturer
    Description: Vaccine Manufacturer
    Type: reference
    Path: Immunization.manufacturer
  - INCLUDE_MANUFACTURER
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_MANUFACTURER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization:manufacturer".
  - SP_PERFORMER
```
public static final String SP_PERFORMER
```
    Search parameter: performer
    Description: The practitioner or organization who played a role in the vaccination
    Type: reference
    Path: Immunization.performer.actor
    
    See Also:
    
    Constant Field Values
  - PERFORMER
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PERFORMER
```
    Fluent Client search parameter constant for performer
    Description: The practitioner or organization who played a role in the vaccination
    Type: reference
    Path: Immunization.performer.actor
  - INCLUDE_PERFORMER
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_PERFORMER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization:performer".
  - SP_REACTION_DATE
```
public static final String SP_REACTION_DATE
```
    Search parameter: reaction-date
    Description: When reaction started
    Type: date
    Path: Immunization.reaction.date
    
    See Also:
    
    Constant Field Values
  - REACTION_DATE
```
public static final ca.uhn.fhir.rest.gclient.DateClientParam REACTION_DATE
```
    Fluent Client search parameter constant for reaction-date
    Description: When reaction started
    Type: date
    Path: Immunization.reaction.date
  - SP_REACTION
```
public static final String SP_REACTION
```
    Search parameter: reaction
    Description: Additional information on reaction
    Type: reference
    Path: Immunization.reaction.detail
    
    See Also:
    
    Constant Field Values
  - REACTION
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REACTION
```
    Fluent Client search parameter constant for reaction
    Description: Additional information on reaction
    Type: reference
    Path: Immunization.reaction.detail
  - INCLUDE_REACTION
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_REACTION
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization:reaction".
  - SP_REASON_CODE
```
public static final String SP_REASON_CODE
```
    Search parameter: reason-code
    Description: Reason why the vaccine was administered
    Type: token
    Path: Immunization.reasonCode
    
    See Also:
    
    Constant Field Values
  - REASON_CODE
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam REASON_CODE
```
    Fluent Client search parameter constant for reason-code
    Description: Reason why the vaccine was administered
    Type: token
    Path: Immunization.reasonCode
  - SP_REASON_REFERENCE
```
public static final String SP_REASON_REFERENCE
```
    Search parameter: reason-reference
    Description: Why immunization occurred
    Type: reference
    Path: Immunization.reasonReference
    
    See Also:
    
    Constant Field Values
  - REASON_REFERENCE
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REASON_REFERENCE
```
    Fluent Client search parameter constant for reason-reference
    Description: Why immunization occurred
    Type: reference
    Path: Immunization.reasonReference
  - INCLUDE_REASON_REFERENCE
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_REASON_REFERENCE
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization:reason-reference".
  - SP_SERIES
```
public static final String SP_SERIES
```
    Search parameter: series
    Description: The series being followed by the provider
    Type: string
    Path: Immunization.protocolApplied.series
    
    See Also:
    
    Constant Field Values
  - SERIES
```
public static final ca.uhn.fhir.rest.gclient.StringClientParam SERIES
```
    Fluent Client search parameter constant for series
    Description: The series being followed by the provider
    Type: string
    Path: Immunization.protocolApplied.series
  - SP_STATUS_REASON
```
public static final String SP_STATUS_REASON
```
    Search parameter: status-reason
    Description: Reason why the vaccine was not administered
    Type: token
    Path: Immunization.statusReason
    
    See Also:
    
    Constant Field Values
  - STATUS_REASON
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS_REASON
```
    Fluent Client search parameter constant for status-reason
    Description: Reason why the vaccine was not administered
    Type: token
    Path: Immunization.statusReason
  - SP_STATUS
```
public static final String SP_STATUS
```
    Search parameter: status
    Description: Immunization event status
    Type: token
    Path: Immunization.status
    
    See Also:
    
    Constant Field Values
  - STATUS
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
```
    Fluent Client search parameter constant for status
    Description: Immunization event status
    Type: token
    Path: Immunization.status
  - SP_TARGET_DISEASE
```
public static final String SP_TARGET_DISEASE
```
    Search parameter: target-disease
    Description: The target disease the dose is being administered against
    Type: token
    Path: Immunization.protocolApplied.targetDisease
    
    See Also:
    
    Constant Field Values
  - TARGET_DISEASE
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam TARGET_DISEASE
```
    Fluent Client search parameter constant for target-disease
    Description: The target disease the dose is being administered against
    Type: token
    Path: Immunization.protocolApplied.targetDisease
  - SP_VACCINE_CODE
```
public static final String SP_VACCINE_CODE
```
    Search parameter: vaccine-code
    Description: Vaccine Product Administered
    Type: token
    Path: Immunization.vaccineCode
    
    See Also:
    
    Constant Field Values
  - VACCINE_CODE
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam VACCINE_CODE
```
    Fluent Client search parameter constant for vaccine-code
    Description: Vaccine Product Administered
    Type: token
    Path: Immunization.vaccineCode
  - SP_DATE
```
public static final String SP_DATE
```
    Search parameter: date
    Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded [CarePlan](careplan.html): Time period plan covers [CareTeam](careteam.html): Time period team covers [ClinicalImpression](clinicalimpression.html): When the assessment was documented [Composition](composition.html): Composition editing time [Consent](consent.html): When this Consent was created or indexed [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report [Encounter](encounter.html): A date within the period the Encounter lasted [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated [Flag](flag.html): Time period when flag is active [Immunization](immunization.html): Vaccination (non)-Administration Date [List](list.html): When the list was prepared [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period [Procedure](procedure.html): When the procedure was performed [RiskAssessment](riskassessment.html): When was assessment made? [SupplyRequest](supplyrequest.html): When the request was made
    Type: date
    Path: AllergyIntolerance.recordedDate | CarePlan.period | CareTeam.period | ClinicalImpression.date | Composition.date | Consent.dateTime | DiagnosticReport.effective | Encounter.period | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | Immunization.occurrence | List.date | Observation.effective | Procedure.performed | (RiskAssessment.occurrence as dateTime) | SupplyRequest.authoredOn
    
    See Also:
    
    Constant Field Values
  - DATE
```
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
```
    Fluent Client search parameter constant for date
    Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded [CarePlan](careplan.html): Time period plan covers [CareTeam](careteam.html): Time period team covers [ClinicalImpression](clinicalimpression.html): When the assessment was documented [Composition](composition.html): Composition editing time [Consent](consent.html): When this Consent was created or indexed [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report [Encounter](encounter.html): A date within the period the Encounter lasted [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated [Flag](flag.html): Time period when flag is active [Immunization](immunization.html): Vaccination (non)-Administration Date [List](list.html): When the list was prepared [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period [Procedure](procedure.html): When the procedure was performed [RiskAssessment](riskassessment.html): When was assessment made? [SupplyRequest](supplyrequest.html): When the request was made
    Type: date
    Path: AllergyIntolerance.recordedDate | CarePlan.period | CareTeam.period | ClinicalImpression.date | Composition.date | Consent.dateTime | DiagnosticReport.effective | Encounter.period | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | Immunization.occurrence | List.date | Observation.effective | Procedure.performed | (RiskAssessment.occurrence as dateTime) | SupplyRequest.authoredOn
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter: identifier
    Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): External ids for this item [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents [DocumentReference](documentreference.html): Master Version Specific Identifier [Encounter](encounter.html): Identifier(s) by which this encounter is known [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Goal](goal.html): External Ids for this goal [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number [Immunization](immunization.html): Business identifier [List](list.html): Business identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationStatement](medicationstatement.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Procedure](procedure.html): A unique identifier for a procedure [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
    Type: token
    Path: AllergyIntolerance.identifier | CarePlan.identifier | CareTeam.identifier | Composition.identifier | Condition.identifier | Consent.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DiagnosticReport.identifier | DocumentManifest.masterIdentifier | DocumentManifest.identifier | DocumentReference.masterIdentifier | DocumentReference.identifier | Encounter.identifier | EpisodeOfCare.identifier | FamilyMemberHistory.identifier | Goal.identifier | ImagingStudy.identifier | Immunization.identifier | List.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationStatement.identifier | NutritionOrder.identifier | Observation.identifier | Procedure.identifier | RiskAssessment.identifier | ServiceRequest.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | VisionPrescription.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): External ids for this item [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents [DocumentReference](documentreference.html): Master Version Specific Identifier [Encounter](encounter.html): Identifier(s) by which this encounter is known [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Goal](goal.html): External Ids for this goal [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number [Immunization](immunization.html): Business identifier [List](list.html): Business identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationStatement](medicationstatement.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Procedure](procedure.html): A unique identifier for a procedure [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
    Type: token
    Path: AllergyIntolerance.identifier | CarePlan.identifier | CareTeam.identifier | Composition.identifier | Condition.identifier | Consent.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DiagnosticReport.identifier | DocumentManifest.masterIdentifier | DocumentManifest.identifier | DocumentReference.masterIdentifier | DocumentReference.identifier | Encounter.identifier | EpisodeOfCare.identifier | FamilyMemberHistory.identifier | Goal.identifier | ImagingStudy.identifier | Immunization.identifier | List.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationStatement.identifier | NutritionOrder.identifier | Observation.identifier | Procedure.identifier | RiskAssessment.identifier | ServiceRequest.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | VisionPrescription.identifier
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter: patient
    Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ClinicalImpression](clinicalimpression.html): Patient or group assessed [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentManifest](documentmanifest.html): The subject of the set of documents [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient or group present at the encounter [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [List](list.html): If all resources have the same subject [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationStatement](medicationstatement.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Procedure](procedure.html): Search by subject - a patient [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
    Type: reference
    Path: AllergyIntolerance.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ClinicalImpression.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.patient | DetectedIssue.patient | DeviceRequest.subject.where(resolve() is Patient) | DeviceUseStatement.subject.where(resolve() is Patient) | DiagnosticReport.subject.where(resolve() is Patient) | DocumentManifest.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EpisodeOfCare.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | List.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationStatement.subject.where(resolve() is Patient) | NutritionOrder.patient | Observation.subject.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | SupplyDelivery.patient | VisionPrescription.patient
    
    See Also:
    
    Constant Field Values
  - PATIENT
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ClinicalImpression](clinicalimpression.html): Patient or group assessed [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentManifest](documentmanifest.html): The subject of the set of documents [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient or group present at the encounter [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [List](list.html): If all resources have the same subject [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationStatement](medicationstatement.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Procedure](procedure.html): Search by subject - a patient [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
    Type: reference
    Path: AllergyIntolerance.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ClinicalImpression.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.patient | DetectedIssue.patient | DeviceRequest.subject.where(resolve() is Patient) | DeviceUseStatement.subject.where(resolve() is Patient) | DiagnosticReport.subject.where(resolve() is Patient) | DocumentManifest.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EpisodeOfCare.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | List.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationStatement.subject.where(resolve() is Patient) | NutritionOrder.patient | Observation.subject.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | SupplyDelivery.patient | VisionPrescription.patient
  - INCLUDE_PATIENT
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization:patient".
- Constructor Detail
  - Immunization
```
public Immunization()
```
    Constructor
  - Immunization
```
public Immunization(Immunization.ImmunizationStatusCodes status,
                    CodeableConcept vaccineCode,
                    Reference patient,
                    DataType occurrence)
```
    Constructor
- Method Detail
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    identifier (A unique identifier assigned to this immunization record.)
  - setIdentifier
```
public Immunization setIdentifier(List<Identifier> theIdentifier)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
  - addIdentifier
```
public Immunization addIdentifier(Identifier t)
```
  - getIdentifierFirstRep
```
public Identifier getIdentifierFirstRep()
```
    Returns:
    
    The first repetition of repeating field identifier, creating it if it does not already exist {3}
  - getStatusElement
```
public Enumeration<Immunization.ImmunizationStatusCodes> getStatusElement()
```
    Returns:
    
    status (Indicates the current status of the immunization event.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - hasStatusElement
```
public boolean hasStatusElement()
```
  - hasStatus
```
public boolean hasStatus()
```
  - setStatusElement
```
public Immunization setStatusElement(Enumeration<Immunization.ImmunizationStatusCodes> value)
```
    Parameters:
    
    value - status (Indicates the current status of the immunization event.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - getStatus
```
public Immunization.ImmunizationStatusCodes getStatus()
```
    Returns:
    
    Indicates the current status of the immunization event.
  - setStatus
```
public Immunization setStatus(Immunization.ImmunizationStatusCodes value)
```
    Parameters:
    
    value - Indicates the current status of the immunization event.
  - getStatusReason
```
public CodeableConcept getStatusReason()
```
    Returns:
    
    statusReason (Indicates the reason the immunization event was not performed.)
  - hasStatusReason
```
public boolean hasStatusReason()
```
  - setStatusReason
```
public Immunization setStatusReason(CodeableConcept value)
```
    Parameters:
    
    value - statusReason (Indicates the reason the immunization event was not performed.)
  - getVaccineCode
```
public CodeableConcept getVaccineCode()
```
    Returns:
    
    vaccineCode (Vaccine that was administered or was to be administered.)
  - hasVaccineCode
```
public boolean hasVaccineCode()
```
  - setVaccineCode
```
public Immunization setVaccineCode(CodeableConcept value)
```
    Parameters:
    
    value - vaccineCode (Vaccine that was administered or was to be administered.)
  - getPatient
```
public Reference getPatient()
```
    Returns:
    
    patient (The patient who either received or did not receive the immunization.)
  - hasPatient
```
public boolean hasPatient()
```
  - setPatient
```
public Immunization setPatient(Reference value)
```
    Parameters:
    
    value - patient (The patient who either received or did not receive the immunization.)
  - getEncounter
```
public Reference getEncounter()
```
    Returns:
    
    encounter (The visit or admission or other contact between patient and health care provider the immunization was performed as part of.)
  - hasEncounter
```
public boolean hasEncounter()
```
  - setEncounter
```
public Immunization setEncounter(Reference value)
```
    Parameters:
    
    value - encounter (The visit or admission or other contact between patient and health care provider the immunization was performed as part of.)
  - getOccurrence
```
public DataType getOccurrence()
```
    Returns:
    
    occurrence (Date vaccine administered or was to be administered.)
  - getOccurrenceDateTimeType
```
public DateTimeType getOccurrenceDateTimeType()
                                       throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    occurrence (Date vaccine administered or was to be administered.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasOccurrenceDateTimeType
```
public boolean hasOccurrenceDateTimeType()
```
  - getOccurrenceStringType
```
public StringType getOccurrenceStringType()
                                   throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    occurrence (Date vaccine administered or was to be administered.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasOccurrenceStringType
```
public boolean hasOccurrenceStringType()
```
  - hasOccurrence
```
public boolean hasOccurrence()
```
  - setOccurrence
```
public Immunization setOccurrence(DataType value)
```
    Parameters:
    
    value - occurrence (Date vaccine administered or was to be administered.)
  - getRecordedElement
```
public DateTimeType getRecordedElement()
```
    Returns:
    
    recorded (The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.). This is the underlying object with id, value and extensions. The accessor "getRecorded" gives direct access to the value
  - hasRecordedElement
```
public boolean hasRecordedElement()
```
  - hasRecorded
```
public boolean hasRecorded()
```
  - setRecordedElement
```
public Immunization setRecordedElement(DateTimeType value)
```
    Parameters:
    
    value - recorded (The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.). This is the underlying object with id, value and extensions. The accessor "getRecorded" gives direct access to the value
  - getRecorded
```
public Date getRecorded()
```
    Returns:
    
    The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
  - setRecorded
```
public Immunization setRecorded(Date value)
```
    Parameters:
    
    value - The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
  - getPrimarySourceElement
```
public BooleanType getPrimarySourceElement()
```
    Returns:
    
    primarySource (An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.). This is the underlying object with id, value and extensions. The accessor "getPrimarySource" gives direct access to the value
  - hasPrimarySourceElement
```
public boolean hasPrimarySourceElement()
```
  - hasPrimarySource
```
public boolean hasPrimarySource()
```
  - setPrimarySourceElement
```
public Immunization setPrimarySourceElement(BooleanType value)
```
    Parameters:
    
    value - primarySource (An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.). This is the underlying object with id, value and extensions. The accessor "getPrimarySource" gives direct access to the value
  - getPrimarySource
```
public boolean getPrimarySource()
```
    Returns:
    
    An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.
  - setPrimarySource
```
public Immunization setPrimarySource(boolean value)
```
    Parameters:
    
    value - An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.
  - getReportOrigin
```
public CodeableConcept getReportOrigin()
```
    Returns:
    
    reportOrigin (The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.)
  - hasReportOrigin
```
public boolean hasReportOrigin()
```
  - setReportOrigin
```
public Immunization setReportOrigin(CodeableConcept value)
```
    Parameters:
    
    value - reportOrigin (The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.)
  - getLocation
```
public Reference getLocation()
```
    Returns:
    
    location (The service delivery location where the vaccine administration occurred.)
  - hasLocation
```
public boolean hasLocation()
```
  - setLocation
```
public Immunization setLocation(Reference value)
```
    Parameters:
    
    value - location (The service delivery location where the vaccine administration occurred.)
  - getManufacturer
```
public Reference getManufacturer()
```
    Returns:
    
    manufacturer (Name of vaccine manufacturer.)
  - hasManufacturer
```
public boolean hasManufacturer()
```
  - setManufacturer
```
public Immunization setManufacturer(Reference value)
```
    Parameters:
    
    value - manufacturer (Name of vaccine manufacturer.)
  - getLotNumberElement
```
public StringType getLotNumberElement()
```
    Returns:
    
    lotNumber (Lot number of the vaccine product.). This is the underlying object with id, value and extensions. The accessor "getLotNumber" gives direct access to the value
  - hasLotNumberElement
```
public boolean hasLotNumberElement()
```
  - hasLotNumber
```
public boolean hasLotNumber()
```
  - setLotNumberElement
```
public Immunization setLotNumberElement(StringType value)
```
    Parameters:
    
    value - lotNumber (Lot number of the vaccine product.). This is the underlying object with id, value and extensions. The accessor "getLotNumber" gives direct access to the value
  - getLotNumber
```
public String getLotNumber()
```
    Returns:
    
    Lot number of the vaccine product.
  - setLotNumber
```
public Immunization setLotNumber(String value)
```
    Parameters:
    
    value - Lot number of the vaccine product.
  - getExpirationDateElement
```
public DateType getExpirationDateElement()
```
    Returns:
    
    expirationDate (Date vaccine batch expires.). This is the underlying object with id, value and extensions. The accessor "getExpirationDate" gives direct access to the value
  - hasExpirationDateElement
```
public boolean hasExpirationDateElement()
```
  - hasExpirationDate
```
public boolean hasExpirationDate()
```
  - setExpirationDateElement
```
public Immunization setExpirationDateElement(DateType value)
```
    Parameters:
    
    value - expirationDate (Date vaccine batch expires.). This is the underlying object with id, value and extensions. The accessor "getExpirationDate" gives direct access to the value
  - getExpirationDate
```
public Date getExpirationDate()
```
    Returns:
    
    Date vaccine batch expires.
  - setExpirationDate
```
public Immunization setExpirationDate(Date value)
```
    Parameters:
    
    value - Date vaccine batch expires.
  - getSite
```
public CodeableConcept getSite()
```
    Returns:
    
    site (Body site where vaccine was administered.)
  - hasSite
```
public boolean hasSite()
```
  - setSite
```
public Immunization setSite(CodeableConcept value)
```
    Parameters:
    
    value - site (Body site where vaccine was administered.)
  - getRoute
```
public CodeableConcept getRoute()
```
    Returns:
    
    route (The path by which the vaccine product is taken into the body.)
  - hasRoute
```
public boolean hasRoute()
```
  - setRoute
```
public Immunization setRoute(CodeableConcept value)
```
    Parameters:
    
    value - route (The path by which the vaccine product is taken into the body.)
  - getDoseQuantity
```
public Quantity getDoseQuantity()
```
    Returns:
    
    doseQuantity (The quantity of vaccine product that was administered.)
  - hasDoseQuantity
```
public boolean hasDoseQuantity()
```
  - setDoseQuantity
```
public Immunization setDoseQuantity(Quantity value)
```
    Parameters:
    
    value - doseQuantity (The quantity of vaccine product that was administered.)
  - getPerformer
```
public List<Immunization.ImmunizationPerformerComponent> getPerformer()
```
    Returns:
    
    performer (Indicates who performed the immunization event.)
  - setPerformer
```
public Immunization setPerformer(List<Immunization.ImmunizationPerformerComponent> thePerformer)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasPerformer
```
public boolean hasPerformer()
```
  - addPerformer
```
public Immunization.ImmunizationPerformerComponent addPerformer()
```
  - addPerformer
```
public Immunization addPerformer(Immunization.ImmunizationPerformerComponent t)
```
  - getPerformerFirstRep
```
public Immunization.ImmunizationPerformerComponent getPerformerFirstRep()
```
    Returns:
    
    The first repetition of repeating field performer, creating it if it does not already exist {3}
  - getNote
```
public List<Annotation> getNote()
```
    Returns:
    
    note (Extra information about the immunization that is not conveyed by the other attributes.)
  - setNote
```
public Immunization setNote(List<Annotation> theNote)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasNote
```
public boolean hasNote()
```
  - addNote
```
public Annotation addNote()
```
  - addNote
```
public Immunization addNote(Annotation t)
```
  - getNoteFirstRep
```
public Annotation getNoteFirstRep()
```
    Returns:
    
    The first repetition of repeating field note, creating it if it does not already exist {3}
  - getReasonCode
```
public List<CodeableConcept> getReasonCode()
```
    Returns:
    
    reasonCode (Reasons why the vaccine was administered.)
  - setReasonCode
```
public Immunization setReasonCode(List<CodeableConcept> theReasonCode)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasReasonCode
```
public boolean hasReasonCode()
```
  - addReasonCode
```
public CodeableConcept addReasonCode()
```
  - addReasonCode
```
public Immunization addReasonCode(CodeableConcept t)
```
  - getReasonCodeFirstRep
```
public CodeableConcept getReasonCodeFirstRep()
```
    Returns:
    
    The first repetition of repeating field reasonCode, creating it if it does not already exist {3}
  - getReasonReference
```
public List<Reference> getReasonReference()
```
    Returns:
    
    reasonReference (Condition, Observation or DiagnosticReport that supports why the immunization was administered.)
  - setReasonReference
```
public Immunization setReasonReference(List<Reference> theReasonReference)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasReasonReference
```
public boolean hasReasonReference()
```
  - addReasonReference
```
public Reference addReasonReference()
```
  - addReasonReference
```
public Immunization addReasonReference(Reference t)
```
  - getReasonReferenceFirstRep
```
public Reference getReasonReferenceFirstRep()
```
    Returns:
    
    The first repetition of repeating field reasonReference, creating it if it does not already exist {3}
  - getIsSubpotentElement
```
public BooleanType getIsSubpotentElement()
```
    Returns:
    
    isSubpotent (Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.). This is the underlying object with id, value and extensions. The accessor "getIsSubpotent" gives direct access to the value
  - hasIsSubpotentElement
```
public boolean hasIsSubpotentElement()
```
  - hasIsSubpotent
```
public boolean hasIsSubpotent()
```
  - setIsSubpotentElement
```
public Immunization setIsSubpotentElement(BooleanType value)
```
    Parameters:
    
    value - isSubpotent (Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.). This is the underlying object with id, value and extensions. The accessor "getIsSubpotent" gives direct access to the value
  - getIsSubpotent
```
public boolean getIsSubpotent()
```
    Returns:
    
    Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
  - setIsSubpotent
```
public Immunization setIsSubpotent(boolean value)
```
    Parameters:
    
    value - Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
  - getSubpotentReason
```
public List<CodeableConcept> getSubpotentReason()
```
    Returns:
    
    subpotentReason (Reason why a dose is considered to be subpotent.)
  - setSubpotentReason
```
public Immunization setSubpotentReason(List<CodeableConcept> theSubpotentReason)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasSubpotentReason
```
public boolean hasSubpotentReason()
```
  - addSubpotentReason
```
public CodeableConcept addSubpotentReason()
```
  - addSubpotentReason
```
public Immunization addSubpotentReason(CodeableConcept t)
```
  - getSubpotentReasonFirstRep
```
public CodeableConcept getSubpotentReasonFirstRep()
```
    Returns:
    
    The first repetition of repeating field subpotentReason, creating it if it does not already exist {3}
  - getEducation
```
public List<Immunization.ImmunizationEducationComponent> getEducation()
```
    Returns:
    
    education (Educational material presented to the patient (or guardian) at the time of vaccine administration.)
  - setEducation
```
public Immunization setEducation(List<Immunization.ImmunizationEducationComponent> theEducation)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasEducation
```
public boolean hasEducation()
```
  - addEducation
```
public Immunization.ImmunizationEducationComponent addEducation()
```
  - addEducation
```
public Immunization addEducation(Immunization.ImmunizationEducationComponent t)
```
  - getEducationFirstRep
```
public Immunization.ImmunizationEducationComponent getEducationFirstRep()
```
    Returns:
    
    The first repetition of repeating field education, creating it if it does not already exist {3}
  - getProgramEligibility
```
public List<CodeableConcept> getProgramEligibility()
```
    Returns:
    
    programEligibility (Indicates a patient's eligibility for a funding program.)
  - setProgramEligibility
```
public Immunization setProgramEligibility(List<CodeableConcept> theProgramEligibility)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasProgramEligibility
```
public boolean hasProgramEligibility()
```
  - addProgramEligibility
```
public CodeableConcept addProgramEligibility()
```
  - addProgramEligibility
```
public Immunization addProgramEligibility(CodeableConcept t)
```
  - getProgramEligibilityFirstRep
```
public CodeableConcept getProgramEligibilityFirstRep()
```
    Returns:
    
    The first repetition of repeating field programEligibility, creating it if it does not already exist {3}
  - getFundingSource
```
public CodeableConcept getFundingSource()
```
    Returns:
    
    fundingSource (Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).)
  - hasFundingSource
```
public boolean hasFundingSource()
```
  - setFundingSource
```
public Immunization setFundingSource(CodeableConcept value)
```
    Parameters:
    
    value - fundingSource (Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).)
  - getReaction
```
public List<Immunization.ImmunizationReactionComponent> getReaction()
```
    Returns:
    
    reaction (Categorical data indicating that an adverse event is associated in time to an immunization.)
  - setReaction
```
public Immunization setReaction(List<Immunization.ImmunizationReactionComponent> theReaction)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasReaction
```
public boolean hasReaction()
```
  - addReaction
```
public Immunization.ImmunizationReactionComponent addReaction()
```
  - addReaction
```
public Immunization addReaction(Immunization.ImmunizationReactionComponent t)
```
  - getReactionFirstRep
```
public Immunization.ImmunizationReactionComponent getReactionFirstRep()
```
    Returns:
    
    The first repetition of repeating field reaction, creating it if it does not already exist {3}
  - getProtocolApplied
```
public List<Immunization.ImmunizationProtocolAppliedComponent> getProtocolApplied()
```
    Returns:
    
    protocolApplied (The protocol (set of recommendations) being followed by the provider who administered the dose.)
  - setProtocolApplied
```
public Immunization setProtocolApplied(List<Immunization.ImmunizationProtocolAppliedComponent> theProtocolApplied)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasProtocolApplied
```
public boolean hasProtocolApplied()
```
  - addProtocolApplied
```
public Immunization.ImmunizationProtocolAppliedComponent addProtocolApplied()
```
  - addProtocolApplied
```
public Immunization addProtocolApplied(Immunization.ImmunizationProtocolAppliedComponent t)
```
  - getProtocolAppliedFirstRep
```
public Immunization.ImmunizationProtocolAppliedComponent getProtocolAppliedFirstRep()
```
    Returns:
    
    The first repetition of repeating field protocolApplied, creating it if it does not already exist {3}
  - listChildren
```
protected void listChildren(List<Property> children)
```
    Overrides:
    
    listChildren in class DomainResource
  - getNamedProperty
```
public Property getNamedProperty(int _hash,
                                 String _name,
                                 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getNamedProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getTypesForProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - fhirType
```
public String fhirType()
```
    Specified by:
    
    fhirType in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    fhirType in class DomainResource
  - copy
```
public Immunization copy()
```
    Specified by:
    
    copy in class DomainResource
  - copyValues
```
public void copyValues(Immunization dst)
```
  - typedCopy
```
protected Immunization typedCopy()
```
  - equalsDeep
```
public boolean equalsDeep(Base other_)
```
    Overrides:
    
    equalsDeep in class DomainResource
  - equalsShallow
```
public boolean equalsShallow(Base other_)
```
    Overrides:
    
    equalsShallow in class DomainResource
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class DomainResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Class Immunization

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.r4b.model.DomainResource

Fields inherited from class org.hl7.fhir.r4b.model.Resource

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.r4b.model.DomainResource

Methods inherited from class org.hl7.fhir.r4b.model.Resource

Methods inherited from class org.hl7.fhir.r4b.model.BaseResource

Methods inherited from class org.hl7.fhir.r4b.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Field Detail

identifier

status

statusReason

vaccineCode

patient

encounter

occurrence

recorded

primarySource

reportOrigin

location

manufacturer

lotNumber

expirationDate

site

route

doseQuantity

performer

note

reasonCode

reasonReference

isSubpotent

subpotentReason

education

programEligibility

fundingSource

reaction

protocolApplied

SP_LOCATION

LOCATION

INCLUDE_LOCATION

SP_LOT_NUMBER

LOT_NUMBER

SP_MANUFACTURER

MANUFACTURER

INCLUDE_MANUFACTURER

SP_PERFORMER

PERFORMER

INCLUDE_PERFORMER

SP_REACTION_DATE

REACTION_DATE

SP_REACTION

REACTION

INCLUDE_REACTION

SP_REASON_CODE

REASON_CODE

SP_REASON_REFERENCE

REASON_REFERENCE

INCLUDE_REASON_REFERENCE

SP_SERIES

SERIES

SP_STATUS_REASON

STATUS_REASON

SP_STATUS

STATUS

SP_TARGET_DISEASE

TARGET_DISEASE

SP_VACCINE_CODE

VACCINE_CODE

SP_DATE

DATE

SP_IDENTIFIER