Immunization (HAPI FHIR Structures - DSTU2.1 (2016May) 3.3.0 API)

java.lang.Object
- org.hl7.fhir.dstu2016may.model.Base
- - org.hl7.fhir.dstu2016may.model.BaseResource
  - - org.hl7.fhir.dstu2016may.model.Resource
    - - org.hl7.fhir.dstu2016may.model.DomainResource
      - org.hl7.fhir.dstu2016may.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 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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Immunization.ImmunizationExplanationComponent`
`static class`	`Immunization.ImmunizationReactionComponent`
`static class`	`Immunization.ImmunizationVaccinationProtocolComponent`

Field Summary

Fields
Modifier and Type	Field and Description
`protected DateTimeType`	`date` Date vaccine administered or was to be administered.
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`DATE` Fluent Client search parameter constant for date
`static ca.uhn.fhir.rest.gclient.NumberClientParam`	`DOSE_SEQUENCE` Fluent Client search parameter constant for dose-sequence
`protected SimpleQuantity`	`doseQuantity` The quantity of vaccine product that was administered.
`protected Reference`	`encounter` The visit or admission or other contact between patient and health care provider the immunization was performed as part of.
`protected Encounter`	`encounterTarget` The actual object that is the target of the reference (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 Immunization.ImmunizationExplanationComponent`	`explanation` Reasons why a vaccine was or was not 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_REQUESTER` Constant for fluent queries to be used to add include statements.
`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
`protected Location`	`locationTarget` The actual object that is the target of the reference (The service delivery location where the vaccine administration occurred.)
`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 Organization`	`manufacturerTarget` The actual object that is the target of the reference (Name of vaccine manufacturer.)
`protected List<Annotation>`	`note` Extra information about the immunization that is not conveyed by the other attributes.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`NOTGIVEN` Fluent Client search parameter constant for notgiven
`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 Patient`	`patientTarget` The actual object that is the target of the reference (The patient who either received or did not receive the immunization.)
`protected Reference`	`performer` Clinician who administered the vaccine.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PERFORMER` Fluent Client search parameter constant for performer
`protected Practitioner`	`performerTarget` The actual object that is the target of the reference (Clinician who administered the vaccine.)
`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` Fluent Client search parameter constant for reason
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`REASON_NOT_GIVEN` Fluent Client search parameter constant for reason-not-given
`protected BooleanType`	`reported` True if this administration was reported rather than directly administered.
`protected Reference`	`requester` Clinician who ordered the vaccination.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`REQUESTER` Fluent Client search parameter constant for requester
`protected Practitioner`	`requesterTarget` The actual object that is the target of the reference (Clinician who ordered the vaccination.)
`protected CodeableConcept`	`route` The path by which the vaccine product is taken into the body.
`protected CodeableConcept`	`site` Body site where vaccine was administered.
`static String`	`SP_DATE` Search parameter: date
`static String`	`SP_DOSE_SEQUENCE` Search parameter: dose-sequence
`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_NOTGIVEN` Search parameter: notgiven
`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` Search parameter: reason
`static String`	`SP_REASON_NOT_GIVEN` Search parameter: reason-not-given
`static String`	`SP_REQUESTER` Search parameter: requester
`static String`	`SP_STATUS` Search parameter: status
`static String`	`SP_VACCINE_CODE` Search parameter: vaccine-code
`protected CodeType`	`status` Indicates the current status of the vaccination event.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`STATUS` Fluent Client search parameter constant for status
`protected List<Immunization.ImmunizationVaccinationProtocolComponent>`	`vaccinationProtocol` Contains information about the protocol(s) under which the vaccine was administered.
`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.
`protected BooleanType`	`wasNotGiven` Indicates if the vaccination was or was not given.

Fields inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu2016may.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 and Description
`Immunization()` Constructor
`Immunization(CodeType status, CodeableConcept vaccineCode, Reference patient, BooleanType wasNotGiven, BooleanType reported)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`Identifier`	`addIdentifier()`
`Immunization`	`addIdentifier(Identifier t)`
`Annotation`	`addNote()`
`Immunization`	`addNote(Annotation t)`
`Immunization.ImmunizationReactionComponent`	`addReaction()`
`Immunization`	`addReaction(Immunization.ImmunizationReactionComponent t)`
`Immunization.ImmunizationVaccinationProtocolComponent`	`addVaccinationProtocol()`
`Immunization`	`addVaccinationProtocol(Immunization.ImmunizationVaccinationProtocolComponent t)`
`Immunization`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`Date`	`getDate()`
`DateTimeType`	`getDateElement()`
`SimpleQuantity`	`getDoseQuantity()`
`Reference`	`getEncounter()`
`Encounter`	`getEncounterTarget()`
`Date`	`getExpirationDate()`
`DateType`	`getExpirationDateElement()`
`Immunization.ImmunizationExplanationComponent`	`getExplanation()`
`List<Identifier>`	`getIdentifier()`
`Reference`	`getLocation()`
`Location`	`getLocationTarget()`
`String`	`getLotNumber()`
`StringType`	`getLotNumberElement()`
`Reference`	`getManufacturer()`
`Organization`	`getManufacturerTarget()`
`List<Annotation>`	`getNote()`
`Reference`	`getPatient()`
`Patient`	`getPatientTarget()`
`Reference`	`getPerformer()`
`Practitioner`	`getPerformerTarget()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`List<Immunization.ImmunizationReactionComponent>`	`getReaction()`
`boolean`	`getReported()`
`BooleanType`	`getReportedElement()`
`Reference`	`getRequester()`
`Practitioner`	`getRequesterTarget()`
`ResourceType`	`getResourceType()`
`CodeableConcept`	`getRoute()`
`CodeableConcept`	`getSite()`
`String`	`getStatus()`
`CodeType`	`getStatusElement()`
`List<Immunization.ImmunizationVaccinationProtocolComponent>`	`getVaccinationProtocol()`
`CodeableConcept`	`getVaccineCode()`
`boolean`	`getWasNotGiven()`
`BooleanType`	`getWasNotGivenElement()`
`boolean`	`hasDate()`
`boolean`	`hasDateElement()`
`boolean`	`hasDoseQuantity()`
`boolean`	`hasEncounter()`
`boolean`	`hasExpirationDate()`
`boolean`	`hasExpirationDateElement()`
`boolean`	`hasExplanation()`
`boolean`	`hasIdentifier()`
`boolean`	`hasLocation()`
`boolean`	`hasLotNumber()`
`boolean`	`hasLotNumberElement()`
`boolean`	`hasManufacturer()`
`boolean`	`hasNote()`
`boolean`	`hasPatient()`
`boolean`	`hasPerformer()`
`boolean`	`hasReaction()`
`boolean`	`hasReported()`
`boolean`	`hasReportedElement()`
`boolean`	`hasRequester()`
`boolean`	`hasRoute()`
`boolean`	`hasSite()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasVaccinationProtocol()`
`boolean`	`hasVaccineCode()`
`boolean`	`hasWasNotGiven()`
`boolean`	`hasWasNotGivenElement()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`Immunization`	`setDate(Date value)`
`Immunization`	`setDateElement(DateTimeType value)`
`Immunization`	`setDoseQuantity(SimpleQuantity value)`
`Immunization`	`setEncounter(Reference value)`
`Immunization`	`setEncounterTarget(Encounter value)`
`Immunization`	`setExpirationDate(Date value)`
`Immunization`	`setExpirationDateElement(DateType value)`
`Immunization`	`setExplanation(Immunization.ImmunizationExplanationComponent value)`
`Immunization`	`setLocation(Reference value)`
`Immunization`	`setLocationTarget(Location value)`
`Immunization`	`setLotNumber(String value)`
`Immunization`	`setLotNumberElement(StringType value)`
`Immunization`	`setManufacturer(Reference value)`
`Immunization`	`setManufacturerTarget(Organization value)`
`Immunization`	`setPatient(Reference value)`
`Immunization`	`setPatientTarget(Patient value)`
`Immunization`	`setPerformer(Reference value)`
`Immunization`	`setPerformerTarget(Practitioner value)`
`void`	`setProperty(int hash, String name, Base value)`
`void`	`setProperty(String name, Base value)`
`Immunization`	`setReported(boolean value)`
`Immunization`	`setReportedElement(BooleanType value)`
`Immunization`	`setRequester(Reference value)`
`Immunization`	`setRequesterTarget(Practitioner value)`
`Immunization`	`setRoute(CodeableConcept value)`
`Immunization`	`setSite(CodeableConcept value)`
`Immunization`	`setStatus(String value)`
`Immunization`	`setStatusElement(CodeType value)`
`Immunization`	`setVaccineCode(CodeableConcept value)`
`Immunization`	`setWasNotGiven(boolean value)`
`Immunization`	`setWasNotGivenElement(BooleanType value)`
`protected Immunization`	`typedCopy()`

Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

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

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

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base
castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, 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.IBaseResource
getMeta, getStructureFhirVersionEnum, setId

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

- Field Detail
  - identifier
```
protected List<Identifier> identifier
```
    A unique identifier assigned to this immunization record.
  - status
```
protected CodeType status
```
    Indicates the current status of the vaccination event.
  - date
```
protected DateTimeType date
```
    Date vaccine administered or was to be administered.
  - 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.
  - patientTarget
```
protected Patient patientTarget
```
    The actual object that is the target of the reference (The patient who either received or did not receive the immunization.)
  - wasNotGiven
```
protected BooleanType wasNotGiven
```
    Indicates if the vaccination was or was not given.
  - reported
```
protected BooleanType reported
```
    True if this administration was reported rather than directly administered.
  - performer
```
protected Reference performer
```
    Clinician who administered the vaccine.
  - performerTarget
```
protected Practitioner performerTarget
```
    The actual object that is the target of the reference (Clinician who administered the vaccine.)
  - requester
```
protected Reference requester
```
    Clinician who ordered the vaccination.
  - requesterTarget
```
protected Practitioner requesterTarget
```
    The actual object that is the target of the reference (Clinician who ordered the vaccination.)
  - encounter
```
protected Reference encounter
```
    The visit or admission or other contact between patient and health care provider the immunization was performed as part of.
  - encounterTarget
```
protected Encounter encounterTarget
```
    The actual object that is the target of the reference (The visit or admission or other contact between patient and health care provider the immunization was performed as part of.)
  - manufacturer
```
protected Reference manufacturer
```
    Name of vaccine manufacturer.
  - manufacturerTarget
```
protected Organization manufacturerTarget
```
    The actual object that is the target of the reference (Name of vaccine manufacturer.)
  - location
```
protected Reference location
```
    The service delivery location where the vaccine administration occurred.
  - locationTarget
```
protected Location locationTarget
```
    The actual object that is the target of the reference (The service delivery location where the vaccine administration occurred.)
  - 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 SimpleQuantity doseQuantity
```
    The quantity of vaccine product that was administered.
  - note
```
protected List<Annotation> note
```
    Extra information about the immunization that is not conveyed by the other attributes.
  - explanation
```
protected Immunization.ImmunizationExplanationComponent explanation
```
    Reasons why a vaccine was or was not administered.
  - reaction
```
protected List<Immunization.ImmunizationReactionComponent> reaction
```
    Categorical data indicating that an adverse event is associated in time to an immunization.
  - vaccinationProtocol
```
protected List<Immunization.ImmunizationVaccinationProtocolComponent> vaccinationProtocol
```
    Contains information about the protocol(s) under which the vaccine was administered.
  - 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_REQUESTER
```
public static final String SP_REQUESTER
```
    Search parameter: requester
    Description: The practitioner who ordered the vaccination
    Type: reference
    Path: Immunization.requester
    
    See Also:
    
    Constant Field Values
  - REQUESTER
```
public static final ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.model.api.Include INCLUDE_REQUESTER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization:requester".
  - SP_DOSE_SEQUENCE
```
public static final String SP_DOSE_SEQUENCE
```
    Search parameter: dose-sequence
    Description: Dose number within series
    Type: number
    Path: Immunization.vaccinationProtocol.doseSequence
    
    See Also:
    
    Constant Field Values
  - DOSE_SEQUENCE
```
public static final ca.uhn.fhir.rest.gclient.NumberClientParam DOSE_SEQUENCE
```
    Fluent Client search parameter constant for dose-sequence
    Description: Dose number within series
    Type: number
    Path: Immunization.vaccinationProtocol.doseSequence
  - 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_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_REASON
```
public static final String SP_REASON
```
    Search parameter: reason
    Description: Why immunization occurred
    Type: token
    Path: Immunization.explanation.reason
    
    See Also:
    
    Constant Field Values
  - REASON
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam REASON
```
    Fluent Client search parameter constant for reason
    Description: Why immunization occurred
    Type: token
    Path: Immunization.explanation.reason
  - 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_NOTGIVEN
```
public static final String SP_NOTGIVEN
```
    Search parameter: notgiven
    Description: Administrations which were not given
    Type: token
    Path: Immunization.wasNotGiven
    
    See Also:
    
    Constant Field Values
  - NOTGIVEN
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam NOTGIVEN
```
    Fluent Client search parameter constant for notgiven
    Description: Administrations which were not given
    Type: token
    Path: Immunization.wasNotGiven
  - SP_DATE
```
public static final String SP_DATE
```
    Search parameter: date
    Description: Vaccination (non)-Administration Date
    Type: date
    Path: Immunization.date
    
    See Also:
    
    Constant Field Values
  - DATE
```
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
```
    Fluent Client search parameter constant for date
    Description: Vaccination (non)-Administration Date
    Type: date
    Path: Immunization.date
  - SP_REASON_NOT_GIVEN
```
public static final String SP_REASON_NOT_GIVEN
```
    Search parameter: 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 ca.uhn.fhir.rest.gclient.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_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_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter: patient
    Description: The patient for the vaccination record
    Type: reference
    Path: Immunization.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: The patient for the vaccination record
    Type: reference
    Path: Immunization.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".
  - 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 who administered the vaccination
    Type: reference
    Path: Immunization.performer
    
    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 who administered the vaccination
    Type: reference
    Path: Immunization.performer
  - 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_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter: identifier
    Description: Business identifier
    Type: token
    Path: Immunization.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: Business identifier
    Type: token
    Path: Immunization.identifier
- Constructor Detail
  - Immunization
```
public Immunization()
```
    Constructor
  - Immunization
```
public Immunization(CodeType status,
                    CodeableConcept vaccineCode,
                    Reference patient,
                    BooleanType wasNotGiven,
                    BooleanType reported)
```
    Constructor
- Method Detail
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    identifier (A unique identifier assigned to this immunization record.)
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
    Returns:
    
    identifier (A unique identifier assigned to this immunization record.)
  - addIdentifier
```
public Immunization addIdentifier(Identifier t)
```
  - getStatusElement
```
public CodeType getStatusElement()
```
    Returns:
    
    status (Indicates the current status of the vaccination 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(CodeType value)
```
    Parameters:
    
    value - status (Indicates the current status of the vaccination event.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - getStatus
```
public String getStatus()
```
    Returns:
    
    Indicates the current status of the vaccination event.
  - setStatus
```
public Immunization setStatus(String value)
```
    Parameters:
    
    value - Indicates the current status of the vaccination event.
  - getDateElement
```
public DateTimeType getDateElement()
```
    Returns:
    
    date (Date vaccine administered or was to be administered.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
  - hasDateElement
```
public boolean hasDateElement()
```
  - hasDate
```
public boolean hasDate()
```
  - setDateElement
```
public Immunization setDateElement(DateTimeType value)
```
    Parameters:
    
    value - date (Date vaccine administered or was to be administered.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
  - getDate
```
public Date getDate()
```
    Returns:
    
    Date vaccine administered or was to be administered.
  - setDate
```
public Immunization setDate(Date value)
```
    Parameters:
    
    value - Date vaccine administered or was to be administered.
  - 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.)
  - getPatientTarget
```
public Patient getPatientTarget()
```
    Returns:
    
    patient The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The patient who either received or did not receive the immunization.)
  - setPatientTarget
```
public Immunization setPatientTarget(Patient value)
```
    Parameters:
    
    value - patient The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The patient who either received or did not receive the immunization.)
  - getWasNotGivenElement
```
public BooleanType getWasNotGivenElement()
```
    Returns:
    
    wasNotGiven (Indicates if the vaccination was or was not given.). This is the underlying object with id, value and extensions. The accessor "getWasNotGiven" gives direct access to the value
  - hasWasNotGivenElement
```
public boolean hasWasNotGivenElement()
```
  - hasWasNotGiven
```
public boolean hasWasNotGiven()
```
  - setWasNotGivenElement
```
public Immunization setWasNotGivenElement(BooleanType value)
```
    Parameters:
    
    value - wasNotGiven (Indicates if the vaccination was or was not given.). This is the underlying object with id, value and extensions. The accessor "getWasNotGiven" gives direct access to the value
  - getWasNotGiven
```
public boolean getWasNotGiven()
```
    Returns:
    
    Indicates if the vaccination was or was not given.
  - setWasNotGiven
```
public Immunization setWasNotGiven(boolean value)
```
    Parameters:
    
    value - Indicates if the vaccination was or was not given.
  - getReportedElement
```
public BooleanType getReportedElement()
```
    Returns:
    
    reported (True if this administration was reported rather than directly administered.). This is the underlying object with id, value and extensions. The accessor "getReported" gives direct access to the value
  - hasReportedElement
```
public boolean hasReportedElement()
```
  - hasReported
```
public boolean hasReported()
```
  - setReportedElement
```
public Immunization setReportedElement(BooleanType value)
```
    Parameters:
    
    value - reported (True if this administration was reported rather than directly administered.). This is the underlying object with id, value and extensions. The accessor "getReported" gives direct access to the value
  - getReported
```
public boolean getReported()
```
    Returns:
    
    True if this administration was reported rather than directly administered.
  - setReported
```
public Immunization setReported(boolean value)
```
    Parameters:
    
    value - True if this administration was reported rather than directly administered.
  - getPerformer
```
public Reference getPerformer()
```
    Returns:
    
    performer (Clinician who administered the vaccine.)
  - hasPerformer
```
public boolean hasPerformer()
```
  - setPerformer
```
public Immunization setPerformer(Reference value)
```
    Parameters:
    
    value - performer (Clinician who administered the vaccine.)
  - getPerformerTarget
```
public Practitioner getPerformerTarget()
```
    Returns:
    
    performer The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Clinician who administered the vaccine.)
  - setPerformerTarget
```
public Immunization setPerformerTarget(Practitioner value)
```
    Parameters:
    
    value - performer The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Clinician who administered the vaccine.)
  - getRequester
```
public Reference getRequester()
```
    Returns:
    
    requester (Clinician who ordered the vaccination.)
  - hasRequester
```
public boolean hasRequester()
```
  - setRequester
```
public Immunization setRequester(Reference value)
```
    Parameters:
    
    value - requester (Clinician who ordered the vaccination.)
  - getRequesterTarget
```
public Practitioner getRequesterTarget()
```
    Returns:
    
    requester The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Clinician who ordered the vaccination.)
  - setRequesterTarget
```
public Immunization setRequesterTarget(Practitioner value)
```
    Parameters:
    
    value - requester The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Clinician who ordered the vaccination.)
  - 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.)
  - getEncounterTarget
```
public Encounter getEncounterTarget()
```
    Returns:
    
    encounter The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The visit or admission or other contact between patient and health care provider the immunization was performed as part of.)
  - setEncounterTarget
```
public Immunization setEncounterTarget(Encounter value)
```
    Parameters:
    
    value - encounter The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The visit or admission or other contact between patient and health care provider the immunization was performed as part of.)
  - 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.)
  - getManufacturerTarget
```
public Organization getManufacturerTarget()
```
    Returns:
    
    manufacturer The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Name of vaccine manufacturer.)
  - setManufacturerTarget
```
public Immunization setManufacturerTarget(Organization value)
```
    Parameters:
    
    value - manufacturer The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Name of vaccine manufacturer.)
  - 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.)
  - getLocationTarget
```
public Location getLocationTarget()
```
    Returns:
    
    location The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The service delivery location where the vaccine administration occurred.)
  - setLocationTarget
```
public Immunization setLocationTarget(Location value)
```
    Parameters:
    
    value - location The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The service delivery location where the vaccine administration occurred.)
  - 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 SimpleQuantity getDoseQuantity()
```
    Returns:
    
    doseQuantity (The quantity of vaccine product that was administered.)
  - hasDoseQuantity
```
public boolean hasDoseQuantity()
```
  - setDoseQuantity
```
public Immunization setDoseQuantity(SimpleQuantity value)
```
    Parameters:
    
    value - doseQuantity (The quantity of vaccine product that was administered.)
  - getNote
```
public List<Annotation> getNote()
```
    Returns:
    
    note (Extra information about the immunization that is not conveyed by the other attributes.)
  - hasNote
```
public boolean hasNote()
```
  - addNote
```
public Annotation addNote()
```
    Returns:
    
    note (Extra information about the immunization that is not conveyed by the other attributes.)
  - addNote
```
public Immunization addNote(Annotation t)
```
  - getExplanation
```
public Immunization.ImmunizationExplanationComponent getExplanation()
```
    Returns:
    
    explanation (Reasons why a vaccine was or was not administered.)
  - hasExplanation
```
public boolean hasExplanation()
```
  - setExplanation
```
public Immunization setExplanation(Immunization.ImmunizationExplanationComponent value)
```
    Parameters:
    
    value - explanation (Reasons why a vaccine was or was not administered.)
  - getReaction
```
public List<Immunization.ImmunizationReactionComponent> getReaction()
```
    Returns:
    
    reaction (Categorical data indicating that an adverse event is associated in time to an immunization.)
  - hasReaction
```
public boolean hasReaction()
```
  - addReaction
```
public Immunization.ImmunizationReactionComponent addReaction()
```
    Returns:
    
    reaction (Categorical data indicating that an adverse event is associated in time to an immunization.)
  - addReaction
```
public Immunization addReaction(Immunization.ImmunizationReactionComponent t)
```
  - getVaccinationProtocol
```
public List<Immunization.ImmunizationVaccinationProtocolComponent> getVaccinationProtocol()
```
    Returns:
    
    vaccinationProtocol (Contains information about the protocol(s) under which the vaccine was administered.)
  - hasVaccinationProtocol
```
public boolean hasVaccinationProtocol()
```
  - addVaccinationProtocol
```
public Immunization.ImmunizationVaccinationProtocolComponent addVaccinationProtocol()
```
    Returns:
    
    vaccinationProtocol (Contains information about the protocol(s) under which the vaccine was administered.)
  - addVaccinationProtocol
```
public Immunization addVaccinationProtocol(Immunization.ImmunizationVaccinationProtocolComponent t)
```
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class DomainResource
  - 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 void 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 void 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
  - 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()
```
    Overrides:
    
    fhirType in class DomainResource
  - copy
```
public Immunization copy()
```
    Specified by:
    
    copy in class DomainResource
  - 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.dstu2016may.model.DomainResource

Fields inherited from class org.hl7.fhir.dstu2016may.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.dstu2016may.model.DomainResource

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

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

Methods inherited from class org.hl7.fhir.dstu2016may.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.IBaseResource

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

Field Detail

identifier

status

date

vaccineCode

patient

patientTarget

wasNotGiven

reported

performer

performerTarget

requester

requesterTarget

encounter

encounterTarget

manufacturer

manufacturerTarget

location

locationTarget

lotNumber

expirationDate

site

route

doseQuantity

note

explanation

reaction

vaccinationProtocol

SP_REACTION

REACTION

INCLUDE_REACTION

SP_REQUESTER

REQUESTER

INCLUDE_REQUESTER

SP_DOSE_SEQUENCE

DOSE_SEQUENCE

SP_STATUS

STATUS

SP_LOCATION

LOCATION

INCLUDE_LOCATION

SP_REASON

REASON

SP_REACTION_DATE

REACTION_DATE

SP_NOTGIVEN

NOTGIVEN

SP_DATE

DATE

SP_REASON_NOT_GIVEN

REASON_NOT_GIVEN

SP_VACCINE_CODE

VACCINE_CODE

SP_PATIENT

PATIENT

INCLUDE_PATIENT

SP_LOT_NUMBER

LOT_NUMBER

SP_MANUFACTURER

MANUFACTURER

INCLUDE_MANUFACTURER

SP_PERFORMER

PERFORMER