Immunization (HAPI FHIR Structures - DSTU2 (FHIR v1.0.0) 1.4 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.dstu2.resource.BaseResource
  - - ca.uhn.fhir.model.dstu2.resource.Immunization

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource
```
public class Immunization
extends BaseResource
implements IResource
```
HAPI/FHIR Immunization Resource (clinical.medication)
Definition: Describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/Immunization

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Immunization.Explanation` Block class for child element: Immunization.explanation ()
`static class`	`Immunization.Reaction` Block class for child element: Immunization.reaction ()
`static class`	`Immunization.VaccinationProtocol` Block class for child element: Immunization.vaccinationProtocol ()

Field Summary

Fields
Modifier and Type	Field and Description
`static DateClientParam`	`DATE` Fluent Client search parameter constant for date
`static NumberClientParam`	`DOSE_SEQUENCE` Fluent Client search parameter constant for dose-sequence
`static TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static Include`	`INCLUDE_LOCATION` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_MANUFACTURER` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_PERFORMER` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_REACTION` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_REQUESTER` Constant for fluent queries to be used to add include statements.
`static ReferenceClientParam`	`LOCATION` Fluent Client search parameter constant for location
`static StringClientParam`	`LOT_NUMBER` Fluent Client search parameter constant for lot-number
`static ReferenceClientParam`	`MANUFACTURER` Fluent Client search parameter constant for manufacturer
`static TokenClientParam`	`NOTGIVEN` Fluent Client search parameter constant for notgiven
`static ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`static ReferenceClientParam`	`PERFORMER` Fluent Client search parameter constant for performer
`static ReferenceClientParam`	`REACTION` Fluent Client search parameter constant for reaction
`static DateClientParam`	`REACTION_DATE` Fluent Client search parameter constant for reaction-date
`static TokenClientParam`	`REASON` Fluent Client search parameter constant for reason
`static TokenClientParam`	`REASON_NOT_GIVEN` Fluent Client search parameter constant for reason-not-given
`static ReferenceClientParam`	`REQUESTER` Fluent Client search parameter constant for requester
`static String`	`SP_DATE` Search parameter constant for date
`static String`	`SP_DOSE_SEQUENCE` Search parameter constant for dose-sequence
`static String`	`SP_IDENTIFIER` Search parameter constant for identifier
`static String`	`SP_LOCATION` Search parameter constant for location
`static String`	`SP_LOT_NUMBER` Search parameter constant for lot-number
`static String`	`SP_MANUFACTURER` Search parameter constant for manufacturer
`static String`	`SP_NOTGIVEN` Search parameter constant for notgiven
`static String`	`SP_PATIENT` Search parameter constant for patient
`static String`	`SP_PERFORMER` Search parameter constant for performer
`static String`	`SP_REACTION` Search parameter constant for reaction
`static String`	`SP_REACTION_DATE` Search parameter constant for reaction-date
`static String`	`SP_REASON` Search parameter constant for reason
`static String`	`SP_REASON_NOT_GIVEN` Search parameter constant for reason-not-given
`static String`	`SP_REQUESTER` Search parameter constant for requester
`static String`	`SP_STATUS` Search parameter constant for status
`static String`	`SP_VACCINE_CODE` Search parameter constant for vaccine-code
`static TokenClientParam`	`STATUS` Fluent Client search parameter constant for status
`static TokenClientParam`	`VACCINE_CODE` Fluent Client search parameter constant for vaccine-code

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
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 and Description

Immunization()

Constructors
Constructor and Description
`Immunization()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier (id)
`Immunization`	`addIdentifier(IdentifierDt theValue)` Adds a given new value for identifier (id)
`AnnotationDt`	`addNote()` Adds and returns a new value for note ()
`Immunization`	`addNote(AnnotationDt theValue)` Adds a given new value for note ()
`Immunization.Reaction`	`addReaction()` Adds and returns a new value for reaction ()
`Immunization`	`addReaction(Immunization.Reaction theValue)` Adds a given new value for reaction ()
`Immunization.VaccinationProtocol`	`addVaccinationProtocol()` Adds and returns a new value for vaccinationProtocol ()
`Immunization`	`addVaccinationProtocol(Immunization.VaccinationProtocol theValue)` Adds a given new value for vaccinationProtocol ()
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`Date`	`getDate()` Gets the value(s) for date (when.init).
`DateTimeDt`	`getDateElement()` Gets the value(s) for date (when.init).
`SimpleQuantityDt`	`getDoseQuantity()` Gets the value(s) for doseQuantity ().
`ResourceReferenceDt`	`getEncounter()` Gets the value(s) for encounter (context).
`Date`	`getExpirationDate()` Gets the value(s) for expirationDate ().
`DateDt`	`getExpirationDateElement()` Gets the value(s) for expirationDate ().
`Immunization.Explanation`	`getExplanation()` Gets the value(s) for explanation ().
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier (id).
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (id), creating it if it does not already exist.
`ResourceReferenceDt`	`getLocation()` Gets the value(s) for location (where).
`String`	`getLotNumber()` Gets the value(s) for lotNumber ().
`StringDt`	`getLotNumberElement()` Gets the value(s) for lotNumber ().
`ResourceReferenceDt`	`getManufacturer()` Gets the value(s) for manufacturer ().
`List<AnnotationDt>`	`getNote()` Gets the value(s) for note ().
`AnnotationDt`	`getNoteFirstRep()` Gets the first repetition for note (), creating it if it does not already exist.
`ResourceReferenceDt`	`getPatient()` Gets the value(s) for patient (who.focus).
`ResourceReferenceDt`	`getPerformer()` Gets the value(s) for performer (who.actor).
`List<Immunization.Reaction>`	`getReaction()` Gets the value(s) for reaction ().
`Immunization.Reaction`	`getReactionFirstRep()` Gets the first repetition for reaction (), creating it if it does not already exist.
`Boolean`	`getReported()` Gets the value(s) for reported (who.source).
`BooleanDt`	`getReportedElement()` Gets the value(s) for reported (who.source).
`ResourceReferenceDt`	`getRequester()` Gets the value(s) for requester (who.cause).
`String`	`getResourceName()`
`BoundCodeableConceptDt<ImmunizationRouteCodesEnum>`	`getRoute()` Gets the value(s) for route ().
`CodeableConceptDt`	`getSite()` Gets the value(s) for site ().
`String`	`getStatus()` Gets the value(s) for status (status).
`CodeDt`	`getStatusElement()` Gets the value(s) for status (status).
`FhirVersionEnum`	`getStructureFhirVersionEnum()`
`List<Immunization.VaccinationProtocol>`	`getVaccinationProtocol()` Gets the value(s) for vaccinationProtocol ().
`Immunization.VaccinationProtocol`	`getVaccinationProtocolFirstRep()` Gets the first repetition for vaccinationProtocol (), creating it if it does not already exist.
`CodeableConceptDt`	`getVaccineCode()` Gets the value(s) for vaccineCode (what).
`Boolean`	`getWasNotGiven()` Gets the value(s) for wasNotGiven (status).
`BooleanDt`	`getWasNotGivenElement()` Gets the value(s) for wasNotGiven (status).
`boolean`	`isEmpty()`
`Immunization`	`setDate(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for date (when.init)
`Immunization`	`setDate(DateTimeDt theValue)` Sets the value(s) for date (when.init)
`Immunization`	`setDateWithSecondsPrecision(Date theDate)` Sets the value for date (when.init)
`Immunization`	`setDoseQuantity(SimpleQuantityDt theValue)` Sets the value(s) for doseQuantity ()
`Immunization`	`setEncounter(ResourceReferenceDt theValue)` Sets the value(s) for encounter (context)
`Immunization`	`setExpirationDate(DateDt theValue)` Sets the value(s) for expirationDate ()
`Immunization`	`setExpirationDate(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for expirationDate ()
`Immunization`	`setExpirationDateWithDayPrecision(Date theDate)` Sets the value for expirationDate ()
`Immunization`	`setExplanation(Immunization.Explanation theValue)` Sets the value(s) for explanation ()
`Immunization`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier (id)
`Immunization`	`setLocation(ResourceReferenceDt theValue)` Sets the value(s) for location (where)
`Immunization`	`setLotNumber(String theString)` Sets the value for lotNumber ()
`Immunization`	`setLotNumber(StringDt theValue)` Sets the value(s) for lotNumber ()
`Immunization`	`setManufacturer(ResourceReferenceDt theValue)` Sets the value(s) for manufacturer ()
`Immunization`	`setNote(List<AnnotationDt> theValue)` Sets the value(s) for note ()
`Immunization`	`setPatient(ResourceReferenceDt theValue)` Sets the value(s) for patient (who.focus)
`Immunization`	`setPerformer(ResourceReferenceDt theValue)` Sets the value(s) for performer (who.actor)
`Immunization`	`setReaction(List<Immunization.Reaction> theValue)` Sets the value(s) for reaction ()
`Immunization`	`setReported(boolean theBoolean)` Sets the value for reported (who.source)
`Immunization`	`setReported(BooleanDt theValue)` Sets the value(s) for reported (who.source)
`Immunization`	`setRequester(ResourceReferenceDt theValue)` Sets the value(s) for requester (who.cause)
`Immunization`	`setRoute(BoundCodeableConceptDt<ImmunizationRouteCodesEnum> theValue)` Sets the value(s) for route ()
`Immunization`	`setRoute(ImmunizationRouteCodesEnum theValue)` Sets the value(s) for route ()
`Immunization`	`setSite(CodeableConceptDt theValue)` Sets the value(s) for site ()
`Immunization`	`setStatus(CodeDt theValue)` Sets the value(s) for status (status)
`Immunization`	`setStatus(String theCode)` Sets the value for status (status)
`Immunization`	`setVaccinationProtocol(List<Immunization.VaccinationProtocol> theValue)` Sets the value(s) for vaccinationProtocol ()
`Immunization`	`setVaccineCode(CodeableConceptDt theValue)` Sets the value(s) for vaccineCode (what)
`Immunization`	`setWasNotGiven(boolean theBoolean)` Sets the value for wasNotGiven (status)
`Immunization`	`setWasNotGiven(BooleanDt theValue)` Sets the value(s) for wasNotGiven (status)

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

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

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

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

- Field Detail
  - SP_DATE
```
public static final String SP_DATE
```
    Search parameter constant for date
    Description: Vaccination (non)-Administration Date
    Type: date
    Path: Immunization.date
    
    See Also:
    
    Constant Field Values
  - DATE
```
public static final DateClientParam DATE
```
    Fluent Client search parameter constant for date
    Description: Vaccination (non)-Administration Date
    Type: date
    Path: Immunization.date
  - SP_DOSE_SEQUENCE
```
public static final String SP_DOSE_SEQUENCE
```
    Search parameter constant for dose-sequence
    Description:
    Type: number
    Path: Immunization.vaccinationProtocol.doseSequence
    
    See Also:
    
    Constant Field Values
  - DOSE_SEQUENCE
```
public static final NumberClientParam DOSE_SEQUENCE
```
    Fluent Client search parameter constant for dose-sequence
    Description:
    Type: number
    Path: Immunization.vaccinationProtocol.doseSequence
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter constant for identifier
    Description:
    Type: token
    Path: Immunization.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description:
    Type: token
    Path: Immunization.identifier
  - SP_LOCATION
```
public static final String SP_LOCATION
```
    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
    
    See Also:
    
    Constant Field Values
  - LOCATION
```
public static final 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
  - SP_LOT_NUMBER
```
public static final String SP_LOT_NUMBER
```
    Search parameter constant for lot-number
    Description: Vaccine Lot Number
    Type: string
    Path: Immunization.lotNumber
    
    See Also:
    
    Constant Field Values
  - LOT_NUMBER
```
public static final 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 constant for manufacturer
    Description: Vaccine Manufacturer
    Type: reference
    Path: Immunization.manufacturer
    
    See Also:
    
    Constant Field Values
  - MANUFACTURER
```
public static final ReferenceClientParam MANUFACTURER
```
    Fluent Client search parameter constant for manufacturer
    Description: Vaccine Manufacturer
    Type: reference
    Path: Immunization.manufacturer
  - SP_PERFORMER
```
public static final String SP_PERFORMER
```
    Search parameter constant for performer
    Description: The practitioner who administered the vaccination
    Type: reference
    Path: Immunization.performer
    
    See Also:
    
    Constant Field Values
  - PERFORMER
```
public static final ReferenceClientParam PERFORMER
```
    Fluent Client search parameter constant for performer
    Description: The practitioner who administered the vaccination
    Type: reference
    Path: Immunization.performer
  - SP_REACTION
```
public static final String SP_REACTION
```
    Search parameter constant for reaction
    Description:
    Type: reference
    Path: Immunization.reaction.detail
    
    See Also:
    
    Constant Field Values
  - REACTION
```
public static final ReferenceClientParam REACTION
```
    Fluent Client search parameter constant for reaction
    Description:
    Type: reference
    Path: Immunization.reaction.detail
  - SP_REACTION_DATE
```
public static final String SP_REACTION_DATE
```
    Search parameter constant for reaction-date
    Description:
    Type: date
    Path: Immunization.reaction.date
    
    See Also:
    
    Constant Field Values
  - REACTION_DATE
```
public static final DateClientParam REACTION_DATE
```
    Fluent Client search parameter constant for reaction-date
    Description:
    Type: date
    Path: Immunization.reaction.date
  - SP_REASON
```
public static final String SP_REASON
```
    Search parameter constant for reason
    Description:
    Type: token
    Path: Immunization.explanation.reason
    
    See Also:
    
    Constant Field Values
  - REASON
```
public static final TokenClientParam REASON
```
    Fluent Client search parameter constant for reason
    Description:
    Type: token
    Path: Immunization.explanation.reason
  - SP_REASON_NOT_GIVEN
```
public static final String SP_REASON_NOT_GIVEN
```
    Search parameter constant for reason-not-given
    Description: Explanation of reason vaccination was not administered
    Type: token
    Path: Immunization.explanation.reasonNotGiven
    
    See Also:
    
    Constant Field Values
  - REASON_NOT_GIVEN
```
public static final TokenClientParam REASON_NOT_GIVEN
```
    Fluent Client search parameter constant for reason-not-given
    Description: Explanation of reason vaccination was not administered
    Type: token
    Path: Immunization.explanation.reasonNotGiven
  - SP_NOTGIVEN
```
public static final String SP_NOTGIVEN
```
    Search parameter constant for notgiven
    Description: Administrations which were not given
    Type: token
    Path: Immunization.wasNotGiven
    
    See Also:
    
    Constant Field Values
  - NOTGIVEN
```
public static final TokenClientParam NOTGIVEN
```
    Fluent Client search parameter constant for notgiven
    Description: Administrations which were not given
    Type: token
    Path: Immunization.wasNotGiven
  - SP_REQUESTER
```
public static final String SP_REQUESTER
```
    Search parameter constant for requester
    Description: The practitioner who ordered the vaccination
    Type: reference
    Path: Immunization.requester
    
    See Also:
    
    Constant Field Values
  - REQUESTER
```
public static final ReferenceClientParam REQUESTER
```
    Fluent Client search parameter constant for requester
    Description: The practitioner who ordered the vaccination
    Type: reference
    Path: Immunization.requester
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter constant for patient
    Description: The patient for the vaccination record
    Type: reference
    Path: Immunization.patient
    
    See Also:
    
    Constant Field Values
  - PATIENT
```
public static final ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description: The patient for the vaccination record
    Type: reference
    Path: Immunization.patient
  - SP_VACCINE_CODE
```
public static final String SP_VACCINE_CODE
```
    Search parameter constant for vaccine-code
    Description: Vaccine Product Administered
    Type: token
    Path: Immunization.vaccineCode
    
    See Also:
    
    Constant Field Values
  - VACCINE_CODE
```
public static final TokenClientParam VACCINE_CODE
```
    Fluent Client search parameter constant for vaccine-code
    Description: Vaccine Product Administered
    Type: token
    Path: Immunization.vaccineCode
  - SP_STATUS
```
public static final String SP_STATUS
```
    Search parameter constant for status
    Description: Immunization event status
    Type: token
    Path: Immunization.status
    
    See Also:
    
    Constant Field Values
  - STATUS
```
public static final TokenClientParam STATUS
```
    Fluent Client search parameter constant for status
    Description: Immunization event status
    Type: token
    Path: Immunization.status
  - INCLUDE_LOCATION
```
public static final Include INCLUDE_LOCATION
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization:location".
  - INCLUDE_MANUFACTURER
```
public static final Include INCLUDE_MANUFACTURER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization:manufacturer".
  - INCLUDE_PATIENT
```
public static final Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization:patient".
  - INCLUDE_PERFORMER
```
public static final Include INCLUDE_PERFORMER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization:performer".
  - INCLUDE_REACTION
```
public static final Include INCLUDE_REACTION
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization:reaction".
  - INCLUDE_REQUESTER
```
public static final Include INCLUDE_REQUESTER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization:requester".
- Constructor Detail
  - Immunization
```
public Immunization()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
  - getIdentifier
```
public List<IdentifierDt> getIdentifier()
```
    Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.
    Definition: A unique identifier assigned to this immunization record.
  - setIdentifier
```
public Immunization setIdentifier(List<IdentifierDt> theValue)
```
    Sets the value(s) for identifier (id)
    Definition: A unique identifier assigned to this immunization record.
  - addIdentifier
```
public IdentifierDt addIdentifier()
```
    Adds and returns a new value for identifier (id)
    Definition: A unique identifier assigned to this immunization record.
  - addIdentifier
```
public Immunization addIdentifier(IdentifierDt theValue)
```
    Adds a given new value for identifier (id)
    Definition: A unique identifier assigned to this immunization record.
    
    Parameters:
    
    theValue - The identifier to add (must not be null)
  - getIdentifierFirstRep
```
public IdentifierDt getIdentifierFirstRep()
```
    Gets the first repetition for identifier (id), creating it if it does not already exist.
    Definition: A unique identifier assigned to this immunization record.
  - getStatusElement
```
public CodeDt getStatusElement()
```
    Gets the value(s) for status (status). creating it if it does not exist. Will not return null.
    Definition: Indicates the current status of the vaccination event
  - getStatus
```
public String getStatus()
```
    Gets the value(s) for status (status). creating it if it does not exist. Will not return null.
    Definition: Indicates the current status of the vaccination event
  - setStatus
```
public Immunization setStatus(CodeDt theValue)
```
    Sets the value(s) for status (status)
    Definition: Indicates the current status of the vaccination event
  - setStatus
```
public Immunization setStatus(String theCode)
```
    Sets the value for status (status)
    Definition: Indicates the current status of the vaccination event
  - getDateElement
```
public DateTimeDt getDateElement()
```
    Gets the value(s) for date (when.init). creating it if it does not exist. Will not return null.
    Definition: Date vaccine administered or was to be administered
  - getDate
```
public Date getDate()
```
    Gets the value(s) for date (when.init). creating it if it does not exist. Will not return null.
    Definition: Date vaccine administered or was to be administered
  - setDate
```
public Immunization setDate(DateTimeDt theValue)
```
    Sets the value(s) for date (when.init)
    Definition: Date vaccine administered or was to be administered
  - setDate
```
public Immunization setDate(Date theDate,
                            TemporalPrecisionEnum thePrecision)
```
    Sets the value for date (when.init)
    Definition: Date vaccine administered or was to be administered
  - setDateWithSecondsPrecision
```
public Immunization setDateWithSecondsPrecision(Date theDate)
```
    Sets the value for date (when.init)
    Definition: Date vaccine administered or was to be administered
  - getVaccineCode
```
public CodeableConceptDt getVaccineCode()
```
    Gets the value(s) for vaccineCode (what). creating it if it does not exist. Will not return null.
    Definition: Vaccine that was administered or was to be administered
  - setVaccineCode
```
public Immunization setVaccineCode(CodeableConceptDt theValue)
```
    Sets the value(s) for vaccineCode (what)
    Definition: Vaccine that was administered or was to be administered
  - getPatient
```
public ResourceReferenceDt getPatient()
```
    Gets the value(s) for patient (who.focus). creating it if it does not exist. Will not return null.
    Definition: The patient who either received or did not receive the immunization.
  - setPatient
```
public Immunization setPatient(ResourceReferenceDt theValue)
```
    Sets the value(s) for patient (who.focus)
    Definition: The patient who either received or did not receive the immunization.
  - getWasNotGivenElement
```
public BooleanDt getWasNotGivenElement()
```
    Gets the value(s) for wasNotGiven (status). creating it if it does not exist. Will not return null.
    Definition: Indicates if the vaccination was or was not given
  - getWasNotGiven
```
public Boolean getWasNotGiven()
```
    Gets the value(s) for wasNotGiven (status). creating it if it does not exist. Will not return null.
    Definition: Indicates if the vaccination was or was not given
  - setWasNotGiven
```
public Immunization setWasNotGiven(BooleanDt theValue)
```
    Sets the value(s) for wasNotGiven (status)
    Definition: Indicates if the vaccination was or was not given
  - setWasNotGiven
```
public Immunization setWasNotGiven(boolean theBoolean)
```
    Sets the value for wasNotGiven (status)
    Definition: Indicates if the vaccination was or was not given
  - getReportedElement
```
public BooleanDt getReportedElement()
```
    Gets the value(s) for reported (who.source). creating it if it does not exist. Will not return null.
    Definition: True if this administration was reported rather than directly administered.
  - getReported
```
public Boolean getReported()
```
    Gets the value(s) for reported (who.source). creating it if it does not exist. Will not return null.
    Definition: True if this administration was reported rather than directly administered.
  - setReported
```
public Immunization setReported(BooleanDt theValue)
```
    Sets the value(s) for reported (who.source)
    Definition: True if this administration was reported rather than directly administered.
  - setReported
```
public Immunization setReported(boolean theBoolean)
```
    Sets the value for reported (who.source)
    Definition: True if this administration was reported rather than directly administered.
  - getPerformer
```
public ResourceReferenceDt getPerformer()
```
    Gets the value(s) for performer (who.actor). creating it if it does not exist. Will not return null.
    Definition: Clinician who administered the vaccine
  - setPerformer
```
public Immunization setPerformer(ResourceReferenceDt theValue)
```
    Sets the value(s) for performer (who.actor)
    Definition: Clinician who administered the vaccine
  - getRequester
```
public ResourceReferenceDt getRequester()
```
    Gets the value(s) for requester (who.cause). creating it if it does not exist. Will not return null.
    Definition: Clinician who ordered the vaccination
  - setRequester
```
public Immunization setRequester(ResourceReferenceDt theValue)
```
    Sets the value(s) for requester (who.cause)
    Definition: Clinician who ordered the vaccination
  - getEncounter
```
public ResourceReferenceDt getEncounter()
```
    Gets the value(s) for encounter (context). creating it if it does not exist. Will not return null.
    Definition: The visit or admission or other contact between patient and health care provider the immunization was performed as part of.
  - setEncounter
```
public Immunization setEncounter(ResourceReferenceDt theValue)
```
    Sets the value(s) for encounter (context)
    Definition: The visit or admission or other contact between patient and health care provider the immunization was performed as part of.
  - getManufacturer
```
public ResourceReferenceDt getManufacturer()
```
    Gets the value(s) for manufacturer (). creating it if it does not exist. Will not return null.
    Definition: Name of vaccine manufacturer
  - setManufacturer
```
public Immunization setManufacturer(ResourceReferenceDt theValue)
```
    Sets the value(s) for manufacturer ()
    Definition: Name of vaccine manufacturer
  - getLocation
```
public ResourceReferenceDt getLocation()
```
    Gets the value(s) for location (where). creating it if it does not exist. Will not return null.
    Definition: The service delivery location where the vaccine administration occurred.
  - setLocation
```
public Immunization setLocation(ResourceReferenceDt theValue)
```
    Sets the value(s) for location (where)
    Definition: The service delivery location where the vaccine administration occurred.
  - getLotNumberElement
```
public StringDt getLotNumberElement()
```
    Gets the value(s) for lotNumber (). creating it if it does not exist. Will not return null.
    Definition: Lot number of the vaccine product
  - getLotNumber
```
public String getLotNumber()
```
    Gets the value(s) for lotNumber (). creating it if it does not exist. Will not return null.
    Definition: Lot number of the vaccine product
  - setLotNumber
```
public Immunization setLotNumber(StringDt theValue)
```
    Sets the value(s) for lotNumber ()
    Definition: Lot number of the vaccine product
  - setLotNumber
```
public Immunization setLotNumber(String theString)
```
    Sets the value for lotNumber ()
    Definition: Lot number of the vaccine product
  - getExpirationDateElement
```
public DateDt getExpirationDateElement()
```
    Gets the value(s) for expirationDate (). creating it if it does not exist. Will not return null.
    Definition: Date vaccine batch expires
  - getExpirationDate
```
public Date getExpirationDate()
```
    Gets the value(s) for expirationDate (). creating it if it does not exist. Will not return null.
    Definition: Date vaccine batch expires
  - setExpirationDate
```
public Immunization setExpirationDate(DateDt theValue)
```
    Sets the value(s) for expirationDate ()
    Definition: Date vaccine batch expires
  - setExpirationDate
```
public Immunization setExpirationDate(Date theDate,
                                      TemporalPrecisionEnum thePrecision)
```
    Sets the value for expirationDate ()
    Definition: Date vaccine batch expires
  - setExpirationDateWithDayPrecision
```
public Immunization setExpirationDateWithDayPrecision(Date theDate)
```
    Sets the value for expirationDate ()
    Definition: Date vaccine batch expires
  - getSite
```
public CodeableConceptDt getSite()
```
    Gets the value(s) for site (). creating it if it does not exist. Will not return null.
    Definition: Body site where vaccine was administered
  - setSite
```
public Immunization setSite(CodeableConceptDt theValue)
```
    Sets the value(s) for site ()
    Definition: Body site where vaccine was administered
  - getRoute
```
public BoundCodeableConceptDt<ImmunizationRouteCodesEnum> getRoute()
```
    Gets the value(s) for route (). creating it if it does not exist. Will not return null.
    Definition: The path by which the vaccine product is taken into the body.
  - setRoute
```
public Immunization setRoute(BoundCodeableConceptDt<ImmunizationRouteCodesEnum> theValue)
```
    Sets the value(s) for route ()
    Definition: The path by which the vaccine product is taken into the body.
  - setRoute
```
public Immunization setRoute(ImmunizationRouteCodesEnum theValue)
```
    Sets the value(s) for route ()
    Definition: The path by which the vaccine product is taken into the body.
  - getDoseQuantity
```
public SimpleQuantityDt getDoseQuantity()
```
    Gets the value(s) for doseQuantity (). creating it if it does not exist. Will not return null.
    Definition: The quantity of vaccine product that was administered
  - setDoseQuantity
```
public Immunization setDoseQuantity(SimpleQuantityDt theValue)
```
    Sets the value(s) for doseQuantity ()
    Definition: The quantity of vaccine product that was administered
  - getNote
```
public List<AnnotationDt> getNote()
```
    Gets the value(s) for note (). creating it if it does not exist. Will not return null.
    Definition: Extra information about the immunization that is not conveyed by the other attributes.
  - setNote
```
public Immunization setNote(List<AnnotationDt> theValue)
```
    Sets the value(s) for note ()
    Definition: Extra information about the immunization that is not conveyed by the other attributes.
  - addNote
```
public AnnotationDt addNote()
```
    Adds and returns a new value for note ()
    Definition: Extra information about the immunization that is not conveyed by the other attributes.
  - addNote
```
public Immunization addNote(AnnotationDt theValue)
```
    Adds a given new value for note ()
    Definition: Extra information about the immunization that is not conveyed by the other attributes.
    
    Parameters:
    
    theValue - The note to add (must not be null)
  - getNoteFirstRep
```
public AnnotationDt getNoteFirstRep()
```
    Gets the first repetition for note (), creating it if it does not already exist.
    Definition: Extra information about the immunization that is not conveyed by the other attributes.
  - getExplanation
```
public Immunization.Explanation getExplanation()
```
    Gets the value(s) for explanation (). creating it if it does not exist. Will not return null.
    Definition: Reasons why a vaccine was or was not administered
  - setExplanation
```
public Immunization setExplanation(Immunization.Explanation theValue)
```
    Sets the value(s) for explanation ()
    Definition: Reasons why a vaccine was or was not administered
  - getReaction
```
public List<Immunization.Reaction> getReaction()
```
    Gets the value(s) for reaction (). creating it if it does not exist. Will not return null.
    Definition: Categorical data indicating that an adverse event is associated in time to an immunization
  - setReaction
```
public Immunization setReaction(List<Immunization.Reaction> theValue)
```
    Sets the value(s) for reaction ()
    Definition: Categorical data indicating that an adverse event is associated in time to an immunization
  - addReaction
```
public Immunization.Reaction addReaction()
```
    Adds and returns a new value for reaction ()
    Definition: Categorical data indicating that an adverse event is associated in time to an immunization
  - addReaction
```
public Immunization addReaction(Immunization.Reaction theValue)
```
    Adds a given new value for reaction ()
    Definition: Categorical data indicating that an adverse event is associated in time to an immunization
    
    Parameters:
    
    theValue - The reaction to add (must not be null)
  - getReactionFirstRep
```
public Immunization.Reaction getReactionFirstRep()
```
    Gets the first repetition for reaction (), creating it if it does not already exist.
    Definition: Categorical data indicating that an adverse event is associated in time to an immunization
  - getVaccinationProtocol
```
public List<Immunization.VaccinationProtocol> getVaccinationProtocol()
```
    Gets the value(s) for vaccinationProtocol (). creating it if it does not exist. Will not return null.
    Definition: Contains information about the protocol(s) under which the vaccine was administered
  - setVaccinationProtocol
```
public Immunization setVaccinationProtocol(List<Immunization.VaccinationProtocol> theValue)
```
    Sets the value(s) for vaccinationProtocol ()
    Definition: Contains information about the protocol(s) under which the vaccine was administered
  - addVaccinationProtocol
```
public Immunization.VaccinationProtocol addVaccinationProtocol()
```
    Adds and returns a new value for vaccinationProtocol ()
    Definition: Contains information about the protocol(s) under which the vaccine was administered
  - addVaccinationProtocol
```
public Immunization addVaccinationProtocol(Immunization.VaccinationProtocol theValue)
```
    Adds a given new value for vaccinationProtocol ()
    Definition: Contains information about the protocol(s) under which the vaccine was administered
    
    Parameters:
    
    theValue - The vaccinationProtocol to add (must not be null)
  - getVaccinationProtocolFirstRep
```
public Immunization.VaccinationProtocol getVaccinationProtocolFirstRep()
```
    Gets the first repetition for vaccinationProtocol (), creating it if it does not already exist.
    Definition: Contains information about the protocol(s) under which the vaccine was administered
  - getResourceName
```
public String getResourceName()
```
    Specified by:
    
    getResourceName in interface IResource
  - getStructureFhirVersionEnum
```
public FhirVersionEnum getStructureFhirVersionEnum()
```
    Specified by:
    
    getStructureFhirVersionEnum in interface IResource
    
    Specified by:
    
    getStructureFhirVersionEnum in interface IBaseResource

Class Immunization

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

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

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

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

Field Detail

SP_DATE

DATE

SP_DOSE_SEQUENCE

DOSE_SEQUENCE

SP_IDENTIFIER

IDENTIFIER

SP_LOCATION

LOCATION

SP_LOT_NUMBER

LOT_NUMBER

SP_MANUFACTURER

MANUFACTURER

SP_PERFORMER

PERFORMER

SP_REACTION

REACTION

SP_REACTION_DATE

REACTION_DATE

SP_REASON

REASON

SP_REASON_NOT_GIVEN

REASON_NOT_GIVEN

SP_NOTGIVEN

NOTGIVEN

SP_REQUESTER

REQUESTER

SP_PATIENT

PATIENT

SP_VACCINE_CODE

VACCINE_CODE

SP_STATUS

STATUS

INCLUDE_LOCATION

INCLUDE_MANUFACTURER

INCLUDE_PATIENT

INCLUDE_PERFORMER

INCLUDE_REACTION

INCLUDE_REQUESTER

Constructor Detail

Immunization

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getStatusElement

getStatus

setStatus

setStatus

getDateElement

getDate

setDate

setDate

setDateWithSecondsPrecision

getVaccineCode

setVaccineCode

getPatient

setPatient

getWasNotGivenElement

getWasNotGiven

setWasNotGiven

setWasNotGiven

getReportedElement

getReported