Immunization (HAPI FHIR - Core Library 0.7 API)

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

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions
```
public class Immunization
extends BaseResource
implements IResource
```
HAPI/FHIR Immunization Resource (Immunization event information)
Definition: Immunization event information

Requirements:

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Immunization.Explanation` Block class for child element: Immunization.explanation (Administration / refusal reasons)
`static class`	`Immunization.Reaction` Block class for child element: Immunization.reaction (Details of a reaction that follows immunization)
`static class`	`Immunization.VaccinationProtocol` Block class for child element: Immunization.vaccinationProtocol (What protocol was followed)

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_PERFORMER` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_REACTION_DETAIL` 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 Include`	`INCLUDE_SUBJECT` 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 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`	`REFUSAL_REASON` Fluent Client search parameter constant for refusal-reason
`static TokenClientParam`	`REFUSED` Fluent Client search parameter constant for refused
`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_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_REFUSAL_REASON` Search parameter constant for refusal-reason
`static String`	`SP_REFUSED` Search parameter constant for refused
`static String`	`SP_REQUESTER` Search parameter constant for requester
`static String`	`SP_SUBJECT` Search parameter constant for subject
`static String`	`SP_VACCINE_TYPE` Search parameter constant for vaccine-type
`static ReferenceClientParam`	`SUBJECT` Fluent Client search parameter constant for subject
`static TokenClientParam`	`VACCINE_TYPE` Fluent Client search parameter constant for vaccine-type

Fields inherited from class ca.uhn.fhir.model.api.BaseResource
SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors
Constructor and Description

Immunization()

Constructors
Constructor and Description
`Immunization()`

Method Summary

Methods
Modifier and Type	Method and Description
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier (Business identifier)
`Immunization`	`addIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel)` Adds a new value for identifier (Business identifier)
`Immunization`	`addIdentifier(String theSystem, String theValue)` Adds a new value for identifier (Business identifier)
`Immunization.Reaction`	`addReaction()` Adds and returns a new value for reaction (Details of a reaction that follows immunization)
`Immunization.VaccinationProtocol`	`addVaccinationProtocol()` Adds and returns a new value for vaccinationProtocol (What protocol was followed)
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)` Returns a list containing all child elements matching a given type
`DateTimeDt`	`getDate()` Gets the value(s) for date (Vaccination administration date).
`QuantityDt`	`getDoseQuantity()` Gets the value(s) for doseQuantity (Amount of vaccine administered).
`DateDt`	`getExpirationDate()` Gets the value(s) for expirationDate (Vaccine expiration date).
`Immunization.Explanation`	`getExplanation()` Gets the value(s) for explanation (Administration / refusal reasons).
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier (Business identifier).
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (Business identifier), creating it if it does not already exist.
`ResourceReferenceDt`	`getLocation()` Gets the value(s) for location (Where did vaccination occur?).
`StringDt`	`getLotNumber()` Gets the value(s) for lotNumber (Vaccine lot number).
`ResourceReferenceDt`	`getManufacturer()` Gets the value(s) for manufacturer (Vaccine manufacturer).
`ResourceReferenceDt`	`getPerformer()` Gets the value(s) for performer (Who administered vaccine?).
`List<Immunization.Reaction>`	`getReaction()` Gets the value(s) for reaction (Details of a reaction that follows immunization).
`Immunization.Reaction`	`getReactionFirstRep()` Gets the first repetition for reaction (Details of a reaction that follows immunization), creating it if it does not already exist.
`BooleanDt`	`getRefusedIndicator()` Gets the value(s) for refusedIndicator (Was immunization refused?).
`BooleanDt`	`getReported()` Gets the value(s) for reported (Is this a self-reported record?).
`ResourceReferenceDt`	`getRequester()` Gets the value(s) for requester (Who ordered vaccination?).
`BoundCodeableConceptDt<ImmunizationRouteCodesEnum>`	`getRoute()` Gets the value(s) for route (How vaccine entered body).
`CodeableConceptDt`	`getSite()` Gets the value(s) for site (Body site vaccine was administered).
`ResourceReferenceDt`	`getSubject()` Gets the value(s) for subject (Who was immunized?).
`List<Immunization.VaccinationProtocol>`	`getVaccinationProtocol()` Gets the value(s) for vaccinationProtocol (What protocol was followed).
`Immunization.VaccinationProtocol`	`getVaccinationProtocolFirstRep()` Gets the first repetition for vaccinationProtocol (What protocol was followed), creating it if it does not already exist.
`CodeableConceptDt`	`getVaccineType()` Gets the value(s) for vaccineType (Vaccine product administered).
`boolean`	`isEmpty()`
`Immunization`	`setDate(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for date (Vaccination administration date)
`Immunization`	`setDate(DateTimeDt theValue)` Sets the value(s) for date (Vaccination administration date)
`Immunization`	`setDateWithSecondsPrecision(Date theDate)` Sets the value for date (Vaccination administration date)
`Immunization`	`setDoseQuantity(double theValue)` Sets the value for doseQuantity (Amount of vaccine administered)
`Immunization`	`setDoseQuantity(long theValue)` Sets the value for doseQuantity (Amount of vaccine administered)
`Immunization`	`setDoseQuantity(QuantityCompararatorEnum theComparator, double theValue, String theUnits)` Sets the value for doseQuantity (Amount of vaccine administered)
`Immunization`	`setDoseQuantity(QuantityCompararatorEnum theComparator, double theValue, String theSystem, String theUnits)` Sets the value for doseQuantity (Amount of vaccine administered)
`Immunization`	`setDoseQuantity(QuantityCompararatorEnum theComparator, long theValue, String theUnits)` Sets the value for doseQuantity (Amount of vaccine administered)
`Immunization`	`setDoseQuantity(QuantityCompararatorEnum theComparator, long theValue, String theSystem, String theUnits)` Sets the value for doseQuantity (Amount of vaccine administered)
`Immunization`	`setDoseQuantity(QuantityDt theValue)` Sets the value(s) for doseQuantity (Amount of vaccine administered)
`Immunization`	`setExpirationDate(DateDt theValue)` Sets the value(s) for expirationDate (Vaccine expiration date)
`Immunization`	`setExpirationDate(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for expirationDate (Vaccine expiration date)
`Immunization`	`setExpirationDateWithDayPrecision(Date theDate)` Sets the value for expirationDate (Vaccine expiration date)
`Immunization`	`setExplanation(Immunization.Explanation theValue)` Sets the value(s) for explanation (Administration / refusal reasons)
`Immunization`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier (Business identifier)
`Immunization`	`setLocation(ResourceReferenceDt theValue)` Sets the value(s) for location (Where did vaccination occur?)
`Immunization`	`setLotNumber(String theString)` Sets the value for lotNumber (Vaccine lot number)
`Immunization`	`setLotNumber(StringDt theValue)` Sets the value(s) for lotNumber (Vaccine lot number)
`Immunization`	`setManufacturer(ResourceReferenceDt theValue)` Sets the value(s) for manufacturer (Vaccine manufacturer)
`Immunization`	`setPerformer(ResourceReferenceDt theValue)` Sets the value(s) for performer (Who administered vaccine?)
`Immunization`	`setReaction(List<Immunization.Reaction> theValue)` Sets the value(s) for reaction (Details of a reaction that follows immunization)
`Immunization`	`setRefusedIndicator(boolean theBoolean)` Sets the value for refusedIndicator (Was immunization refused?)
`Immunization`	`setRefusedIndicator(BooleanDt theValue)` Sets the value(s) for refusedIndicator (Was immunization refused?)
`Immunization`	`setReported(boolean theBoolean)` Sets the value for reported (Is this a self-reported record?)
`Immunization`	`setReported(BooleanDt theValue)` Sets the value(s) for reported (Is this a self-reported record?)
`Immunization`	`setRequester(ResourceReferenceDt theValue)` Sets the value(s) for requester (Who ordered vaccination?)
`Immunization`	`setRoute(BoundCodeableConceptDt<ImmunizationRouteCodesEnum> theValue)` Sets the value(s) for route (How vaccine entered body)
`Immunization`	`setRoute(ImmunizationRouteCodesEnum theValue)` Sets the value(s) for route (How vaccine entered body)
`Immunization`	`setSite(CodeableConceptDt theValue)` Sets the value(s) for site (Body site vaccine was administered)
`Immunization`	`setSubject(ResourceReferenceDt theValue)` Sets the value(s) for subject (Who was immunized?)
`Immunization`	`setVaccinationProtocol(List<Immunization.VaccinationProtocol> theValue)` Sets the value(s) for vaccinationProtocol (What protocol was followed)
`Immunization`	`setVaccineType(CodeableConceptDt theValue)` Sets the value(s) for vaccineType (Vaccine product administered)

Methods inherited from class ca.uhn.fhir.model.api.BaseResource
getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, 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

- Field Detail
  - SP_DATE
```
public static final String SP_DATE
```
    Search parameter constant for date
    Description: Vaccination Administration / Refusal 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 Administration / Refusal 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
  - 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".
  - 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
  - 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".
  - 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
  - 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".
  - 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
  - INCLUDE_REACTION_DETAIL
```
public static final Include INCLUDE_REACTION_DETAIL
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "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_REFUSAL_REASON
```
public static final String SP_REFUSAL_REASON
```
    Search parameter constant for refusal-reason
    Description: Explanation of refusal / exemption
    Type: token
    Path: Immunization.explanation.refusalReason
    
    See Also:
    Constant Field Values
  - REFUSAL_REASON
```
public static final TokenClientParam REFUSAL_REASON
```
    Fluent Client search parameter constant for refusal-reason
    Description: Explanation of refusal / exemption
    Type: token
    Path: Immunization.explanation.refusalReason
  - SP_REFUSED
```
public static final String SP_REFUSED
```
    Search parameter constant for refused
    Description:
    Type: token
    Path: Immunization.refusedIndicator
    
    See Also:
    Constant Field Values
  - REFUSED
```
public static final TokenClientParam REFUSED
```
    Fluent Client search parameter constant for refused
    Description:
    Type: token
    Path: Immunization.refusedIndicator
  - 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
  - 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".
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    Search parameter constant for subject
    Description: The subject of the vaccination event / refusal
    Type: reference
    Path: Immunization.subject
    
    See Also:
    Constant Field Values
  - SUBJECT
```
public static final ReferenceClientParam SUBJECT
```
    Fluent Client search parameter constant for subject
    Description: The subject of the vaccination event / refusal
    Type: reference
    Path: Immunization.subject
  - INCLUDE_SUBJECT
```
public static final Include INCLUDE_SUBJECT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization.subject".
  - SP_VACCINE_TYPE
```
public static final String SP_VACCINE_TYPE
```
    Search parameter constant for vaccine-type
    Description: Vaccine Product Type Administered
    Type: token
    Path: Immunization.vaccineType
    
    See Also:
    Constant Field Values
  - VACCINE_TYPE
```
public static final TokenClientParam VACCINE_TYPE
```
    Fluent Client search parameter constant for vaccine-type
    Description: Vaccine Product Type Administered
    Type: token
    Path: Immunization.vaccineType
- Constructor Detail
  - Immunization
```
public Immunization()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IElement
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Description copied from interface: ICompositeElement
    
    Returns a list containing all child elements matching a given type
    
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
    
    Parameters:
    theType - The type to match. If set to null, all child elements will be returned
  - getIdentifier
```
public List<IdentifierDt> getIdentifier()
```
    Gets the value(s) for identifier (Business identifier). creating it if it does not exist. Will not return null.
    Definition: A unique identifier assigned to this adverse reaction record.
  - setIdentifier
```
public Immunization setIdentifier(List<IdentifierDt> theValue)
```
    Sets the value(s) for identifier (Business identifier)
    Definition: A unique identifier assigned to this adverse reaction record.
  - addIdentifier
```
public IdentifierDt addIdentifier()
```
    Adds and returns a new value for identifier (Business identifier)
    Definition: A unique identifier assigned to this adverse reaction record.
  - getIdentifierFirstRep
```
public IdentifierDt getIdentifierFirstRep()
```
    Gets the first repetition for identifier (Business identifier), creating it if it does not already exist.
    Definition: A unique identifier assigned to this adverse reaction record.
  - addIdentifier
```
public Immunization addIdentifier(IdentifierUseEnum theUse,
                         String theSystem,
                         String theValue,
                         String theLabel)
```
    Adds a new value for identifier (Business identifier)
    Definition: A unique identifier assigned to this adverse reaction record.
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - addIdentifier
```
public Immunization addIdentifier(String theSystem,
                         String theValue)
```
    Adds a new value for identifier (Business identifier)
    Definition: A unique identifier assigned to this adverse reaction record.
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - getDate
```
public DateTimeDt getDate()
```
    Gets the value(s) for date (Vaccination administration date). 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 (Vaccination administration date)
    Definition: Date vaccine administered or was to be administered
  - setDateWithSecondsPrecision
```
public Immunization setDateWithSecondsPrecision(Date theDate)
```
    Sets the value for date (Vaccination administration date)
    Definition: Date vaccine administered or was to be administered
  - setDate
```
public Immunization setDate(Date theDate,
                   TemporalPrecisionEnum thePrecision)
```
    Sets the value for date (Vaccination administration date)
    Definition: Date vaccine administered or was to be administered
  - getVaccineType
```
public CodeableConceptDt getVaccineType()
```
    Gets the value(s) for vaccineType (Vaccine product administered). creating it if it does not exist. Will not return null.
    Definition: Vaccine that was administered or was to be administered
  - setVaccineType
```
public Immunization setVaccineType(CodeableConceptDt theValue)
```
    Sets the value(s) for vaccineType (Vaccine product administered)
    Definition: Vaccine that was administered or was to be administered
  - getSubject
```
public ResourceReferenceDt getSubject()
```
    Gets the value(s) for subject (Who was immunized?). creating it if it does not exist. Will not return null.
    Definition: The patient to whom the vaccine was to be administered
  - setSubject
```
public Immunization setSubject(ResourceReferenceDt theValue)
```
    Sets the value(s) for subject (Who was immunized?)
    Definition: The patient to whom the vaccine was to be administered
  - getRefusedIndicator
```
public BooleanDt getRefusedIndicator()
```
    Gets the value(s) for refusedIndicator (Was immunization refused?). creating it if it does not exist. Will not return null.
    Definition: Indicates if the vaccination was refused.
  - setRefusedIndicator
```
public Immunization setRefusedIndicator(BooleanDt theValue)
```
    Sets the value(s) for refusedIndicator (Was immunization refused?)
    Definition: Indicates if the vaccination was refused.
  - setRefusedIndicator
```
public Immunization setRefusedIndicator(boolean theBoolean)
```
    Sets the value for refusedIndicator (Was immunization refused?)
    Definition: Indicates if the vaccination was refused.
  - getReported
```
public BooleanDt getReported()
```
    Gets the value(s) for reported (Is this a self-reported record?). 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 (Is this a self-reported record?)
    Definition: True if this administration was reported rather than directly administered.
  - setReported
```
public Immunization setReported(boolean theBoolean)
```
    Sets the value for reported (Is this a self-reported record?)
    Definition: True if this administration was reported rather than directly administered.
  - getPerformer
```
public ResourceReferenceDt getPerformer()
```
    Gets the value(s) for performer (Who administered vaccine?). 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 administered vaccine?)
    Definition: Clinician who administered the vaccine
  - getRequester
```
public ResourceReferenceDt getRequester()
```
    Gets the value(s) for requester (Who ordered vaccination?). 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 ordered vaccination?)
    Definition: Clinician who ordered the vaccination
  - getManufacturer
```
public ResourceReferenceDt getManufacturer()
```
    Gets the value(s) for manufacturer (Vaccine 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 (Vaccine manufacturer)
    Definition: Name of vaccine manufacturer
  - getLocation
```
public ResourceReferenceDt getLocation()
```
    Gets the value(s) for location (Where did vaccination occur?). 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 did vaccination occur?)
    Definition: The service delivery location where the vaccine administration occurred.
  - getLotNumber
```
public StringDt getLotNumber()
```
    Gets the value(s) for lotNumber (Vaccine lot number). 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 (Vaccine lot number)
    Definition: Lot number of the vaccine product
  - setLotNumber
```
public Immunization setLotNumber(String theString)
```
    Sets the value for lotNumber (Vaccine lot number)
    Definition: Lot number of the vaccine product
  - getExpirationDate
```
public DateDt getExpirationDate()
```
    Gets the value(s) for expirationDate (Vaccine expiration date). 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 (Vaccine expiration date)
    Definition: Date vaccine batch expires
  - setExpirationDateWithDayPrecision
```
public Immunization setExpirationDateWithDayPrecision(Date theDate)
```
    Sets the value for expirationDate (Vaccine expiration date)
    Definition: Date vaccine batch expires
  - setExpirationDate
```
public Immunization setExpirationDate(Date theDate,
                             TemporalPrecisionEnum thePrecision)
```
    Sets the value for expirationDate (Vaccine expiration date)
    Definition: Date vaccine batch expires
  - getSite
```
public CodeableConceptDt getSite()
```
    Gets the value(s) for site (Body site vaccine was administered). 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 (Body site vaccine was administered)
    Definition: Body site where vaccine was administered
  - getRoute
```
public BoundCodeableConceptDt<ImmunizationRouteCodesEnum> getRoute()
```
    Gets the value(s) for route (How vaccine entered body). 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 (How vaccine entered body)
    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 (How vaccine entered body)
    Definition: The path by which the vaccine product is taken into the body.
  - getDoseQuantity
```
public QuantityDt getDoseQuantity()
```
    Gets the value(s) for doseQuantity (Amount of vaccine administered). creating it if it does not exist. Will not return null.
    Definition: The quantity of vaccine product that was administered
  - setDoseQuantity
```
public Immunization setDoseQuantity(QuantityDt theValue)
```
    Sets the value(s) for doseQuantity (Amount of vaccine administered)
    Definition: The quantity of vaccine product that was administered
  - setDoseQuantity
```
public Immunization setDoseQuantity(QuantityCompararatorEnum theComparator,
                           double theValue,
                           String theUnits)
```
    Sets the value for doseQuantity (Amount of vaccine administered)
    Definition: The quantity of vaccine product that was administered
  - setDoseQuantity
```
public Immunization setDoseQuantity(QuantityCompararatorEnum theComparator,
                           long theValue,
                           String theUnits)
```
    Sets the value for doseQuantity (Amount of vaccine administered)
    Definition: The quantity of vaccine product that was administered
  - setDoseQuantity
```
public Immunization setDoseQuantity(QuantityCompararatorEnum theComparator,
                           double theValue,
                           String theSystem,
                           String theUnits)
```
    Sets the value for doseQuantity (Amount of vaccine administered)
    Definition: The quantity of vaccine product that was administered
  - setDoseQuantity
```
public Immunization setDoseQuantity(QuantityCompararatorEnum theComparator,
                           long theValue,
                           String theSystem,
                           String theUnits)
```
    Sets the value for doseQuantity (Amount of vaccine administered)
    Definition: The quantity of vaccine product that was administered
  - setDoseQuantity
```
public Immunization setDoseQuantity(double theValue)
```
    Sets the value for doseQuantity (Amount of vaccine administered)
    Definition: The quantity of vaccine product that was administered
  - setDoseQuantity
```
public Immunization setDoseQuantity(long theValue)
```
    Sets the value for doseQuantity (Amount of vaccine administered)
    Definition: The quantity of vaccine product that was administered
  - getExplanation
```
public Immunization.Explanation getExplanation()
```
    Gets the value(s) for explanation (Administration / refusal reasons). creating it if it does not exist. Will not return null.
    Definition: Reasons why a vaccine was administered or refused
  - setExplanation
```
public Immunization setExplanation(Immunization.Explanation theValue)
```
    Sets the value(s) for explanation (Administration / refusal reasons)
    Definition: Reasons why a vaccine was administered or refused
  - getReaction
```
public List<Immunization.Reaction> getReaction()
```
    Gets the value(s) for reaction (Details of a reaction that follows immunization). 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 (Details of a reaction that follows immunization)
    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 (Details of a reaction that follows immunization)
    Definition: Categorical data indicating that an adverse event is associated in time to an immunization
  - getReactionFirstRep
```
public Immunization.Reaction getReactionFirstRep()
```
    Gets the first repetition for reaction (Details of a reaction that follows immunization), 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 (What protocol was followed). 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 (What protocol was followed)
    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 (What protocol was followed)
    Definition: Contains information about the protocol(s) under which the vaccine was administered
  - getVaccinationProtocolFirstRep
```
public Immunization.VaccinationProtocol getVaccinationProtocolFirstRep()
```
    Gets the first repetition for vaccinationProtocol (What protocol was followed), creating it if it does not already exist.
    Definition: Contains information about the protocol(s) under which the vaccine was administered

Class Immunization

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.api.BaseResource

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.api.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

Field Detail

SP_DATE

DATE

SP_DOSE_SEQUENCE

DOSE_SEQUENCE

SP_IDENTIFIER

IDENTIFIER

SP_LOCATION

LOCATION

INCLUDE_LOCATION

SP_LOT_NUMBER

LOT_NUMBER

SP_MANUFACTURER

MANUFACTURER

INCLUDE_MANUFACTURER

SP_PERFORMER

PERFORMER

INCLUDE_PERFORMER

SP_REACTION

REACTION

INCLUDE_REACTION_DETAIL

SP_REACTION_DATE

REACTION_DATE

SP_REASON

REASON

SP_REFUSAL_REASON

REFUSAL_REASON

SP_REFUSED

REFUSED

SP_REQUESTER

REQUESTER

INCLUDE_REQUESTER

SP_SUBJECT

SUBJECT

INCLUDE_SUBJECT

SP_VACCINE_TYPE

VACCINE_TYPE

Constructor Detail

Immunization

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

addIdentifier

getIdentifierFirstRep

addIdentifier

addIdentifier

getDate

setDate

setDateWithSecondsPrecision

setDate

getVaccineType

setVaccineType

getSubject

setSubject

getRefusedIndicator

setRefusedIndicator

setRefusedIndicator

getReported

setReported

setReported

getPerformer

setPerformer

getRequester

setRequester

getManufacturer

setManufacturer

getLocation

setLocation