Package org.hl7.fhir.dstu3.model

Class Immunization

java.lang.Object

org.hl7.fhir.dstu3.model.Base

org.hl7.fhir.dstu3.model.BaseResource

org.hl7.fhir.dstu3.model.Resource

org.hl7.fhir.dstu3.model.DomainResource

org.hl7.fhir.dstu3.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	Description
static class	Immunization.ImmunizationExplanationComponent
static class	Immunization.ImmunizationPractitionerComponent
static class	Immunization.ImmunizationReactionComponent
static enum	Immunization.ImmunizationStatus
static class	Immunization.ImmunizationStatusEnumFactory
static class	Immunization.ImmunizationVaccinationProtocolComponent

Field Summary

Fields

Modifier and Type	Field	Description
protected DateTimeType	date	Date vaccine administered or was to be administered.
static final ca.uhn.fhir.rest.gclient.DateClientParam	DATE	Fluent Client search parameter constant for date
static final 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 final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_LOCATION	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_MANUFACTURER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PATIENT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PRACTITIONER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_REACTION	Constant for fluent queries to be used to add include statements.
protected Reference	location	The service delivery location where the vaccine administration occurred.
static final 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 final 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 final 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.
protected BooleanType	notGiven	Indicates if the vaccination was or was not given.
static final 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 final 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 List<Immunization.ImmunizationPractitionerComponent>	practitioner	Indicates who or what performed the event.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PRACTITIONER	Fluent Client search parameter constant for practitioner
protected BooleanType	primarySource	An indication that the content of the record is based on information from the person who administered the vaccine.
protected List<Immunization.ImmunizationReactionComponent>	reaction	Categorical data indicating that an adverse event is associated in time to an immunization.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	REACTION	Fluent Client search parameter constant for reaction
static final ca.uhn.fhir.rest.gclient.DateClientParam	REACTION_DATE	Fluent Client search parameter constant for reaction-date
static final ca.uhn.fhir.rest.gclient.TokenClientParam	REASON	Fluent Client search parameter constant for reason
static final ca.uhn.fhir.rest.gclient.TokenClientParam	REASON_NOT_GIVEN	Fluent Client search parameter constant for reason-not-given
protected CodeableConcept	reportOrigin	The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
protected CodeableConcept	route	The path by which the vaccine product is taken into the body.
protected CodeableConcept	site	Body site where vaccine was administered.
static final String	SP_DATE	Search parameter: date
static final String	SP_DOSE_SEQUENCE	Search parameter: dose-sequence
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_LOCATION	Search parameter: location
static final String	SP_LOT_NUMBER	Search parameter: lot-number
static final String	SP_MANUFACTURER	Search parameter: manufacturer
static final String	SP_NOTGIVEN	Search parameter: notgiven
static final String	SP_PATIENT	Search parameter: patient
static final String	SP_PRACTITIONER	Search parameter: practitioner
static final String	SP_REACTION	Search parameter: reaction
static final String	SP_REACTION_DATE	Search parameter: reaction-date
static final String	SP_REASON	Search parameter: reason
static final String	SP_REASON_NOT_GIVEN	Search parameter: reason-not-given
static final String	SP_STATUS	Search parameter: status
static final String	SP_VACCINE_CODE	Search parameter: vaccine-code
protected Enumeration<Immunization.ImmunizationStatus>	status	Indicates the current status of the vaccination event.
static final 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 final ca.uhn.fhir.rest.gclient.TokenClientParam	VACCINE_CODE	Fluent Client search parameter constant for vaccine-code
protected CodeableConcept	vaccineCode	Vaccine that was administered or was to be administered.

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

contained, extension, modifierExtension, text

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

id, implicitRules, language, meta

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

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
Immunization()	Constructor
Immunization(Enumeration<Immunization.ImmunizationStatus> status, BooleanType notGiven, CodeableConcept vaccineCode, Reference patient, BooleanType primarySource)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Identifier	addIdentifier()
Immunization	addIdentifier(Identifier t)
Annotation	addNote()
Immunization	addNote(Annotation t)
Immunization.ImmunizationPractitionerComponent	addPractitioner()
Immunization	addPractitioner(Immunization.ImmunizationPractitionerComponent 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()
Identifier	getIdentifierFirstRep()
Reference	getLocation()
Location	getLocationTarget()
String	getLotNumber()
StringType	getLotNumberElement()
Reference	getManufacturer()
Organization	getManufacturerTarget()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<Annotation>	getNote()
Annotation	getNoteFirstRep()
boolean	getNotGiven()
BooleanType	getNotGivenElement()
Reference	getPatient()
Patient	getPatientTarget()
List<Immunization.ImmunizationPractitionerComponent>	getPractitioner()
Immunization.ImmunizationPractitionerComponent	getPractitionerFirstRep()
boolean	getPrimarySource()
BooleanType	getPrimarySourceElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<Immunization.ImmunizationReactionComponent>	getReaction()
Immunization.ImmunizationReactionComponent	getReactionFirstRep()
CodeableConcept	getReportOrigin()
ResourceType	getResourceType()
CodeableConcept	getRoute()
CodeableConcept	getSite()
Immunization.ImmunizationStatus	getStatus()
Enumeration<Immunization.ImmunizationStatus>	getStatusElement()
String[]	getTypesForProperty(int hash, String name)
List<Immunization.ImmunizationVaccinationProtocolComponent>	getVaccinationProtocol()
Immunization.ImmunizationVaccinationProtocolComponent	getVaccinationProtocolFirstRep()
CodeableConcept	getVaccineCode()
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	hasNotGiven()
boolean	hasNotGivenElement()
boolean	hasPatient()
boolean	hasPractitioner()
boolean	hasPrimarySource()
boolean	hasPrimarySourceElement()
boolean	hasReaction()
boolean	hasReportOrigin()
boolean	hasRoute()
boolean	hasSite()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasVaccinationProtocol()
boolean	hasVaccineCode()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
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	setIdentifier(List<Identifier> theIdentifier)
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	setNote(List<Annotation> theNote)
Immunization	setNotGiven(boolean value)
Immunization	setNotGivenElement(BooleanType value)
Immunization	setPatient(Reference value)
Immunization	setPatientTarget(Patient value)
Immunization	setPractitioner(List<Immunization.ImmunizationPractitionerComponent> thePractitioner)
Immunization	setPrimarySource(boolean value)
Immunization	setPrimarySourceElement(BooleanType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Immunization	setReaction(List<Immunization.ImmunizationReactionComponent> theReaction)
Immunization	setReportOrigin(CodeableConcept value)
Immunization	setRoute(CodeableConcept value)
Immunization	setSite(CodeableConcept value)
Immunization	setStatus(Immunization.ImmunizationStatus value)
Immunization	setStatusElement(Enumeration<Immunization.ImmunizationStatus> value)
Immunization	setVaccinationProtocol(List<Immunization.ImmunizationVaccinationProtocolComponent> theVaccinationProtocol)
Immunization	setVaccineCode(CodeableConcept value)
protected Immunization	typedCopy()

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

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

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

copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

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

getStructureFhirVersionEnum, isResource, setId

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

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

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

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

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

identifier

protected List<Identifier> identifier

A unique identifier assigned to this immunization record.

status

protected Enumeration<Immunization.ImmunizationStatus> status

Indicates the current status of the vaccination event.

notGiven

protected BooleanType notGiven

Indicates if the vaccination was or was not given.

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.)

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.)

date

protected DateTimeType date

Date vaccine administered or was to be administered.

primarySource

protected BooleanType primarySource

An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.

reportOrigin

protected CodeableConcept reportOrigin

The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.

location

protected Reference location

The service delivery location where the vaccine administration occurred.

locationTarget

protected Location locationTarget

The actual object that is the target of the reference (The service delivery location where the vaccine administration occurred.)

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.)

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.

practitioner

protected List<Immunization.ImmunizationPractitionerComponent> practitioner

Indicates who or what performed the event.

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_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_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

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

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_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_PRACTITIONER

public static final String SP_PRACTITIONER

Search parameter: practitioner

Description: The practitioner who played a role in the vaccination
Type: reference
Path: Immunization.practitioner.actor

See Also:

• Constant Field Values

PRACTITIONER

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PRACTITIONER

Fluent Client search parameter constant for practitioner

Description: The practitioner who played a role in the vaccination
Type: reference
Path: Immunization.practitioner.actor

INCLUDE_PRACTITIONER

public static final ca.uhn.fhir.model.api.Include INCLUDE_PRACTITIONER

Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization:practitioner".

SP_NOTGIVEN

public static final String SP_NOTGIVEN

Search parameter: notgiven

Description: Administrations which were not given
Type: token
Path: Immunization.notGiven

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.notGiven

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_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_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_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_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_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_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_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

Constructor Details

Immunization

public Immunization()

Constructor

Immunization

public Immunization(Enumeration<Immunization.ImmunizationStatus> status,
 BooleanType notGiven,
 CodeableConcept vaccineCode,
 Reference patient,
 BooleanType primarySource)

Constructor

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (A unique identifier assigned to this immunization record.)

setIdentifier

public Immunization setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public Immunization addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist

getStatusElement

public Enumeration<Immunization.ImmunizationStatus> 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(Enumeration<Immunization.ImmunizationStatus> 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 Immunization.ImmunizationStatus getStatus()

Returns:

Indicates the current status of the vaccination event.

setStatus

public Immunization setStatus(Immunization.ImmunizationStatus value)

Parameters:

value - Indicates the current status of the vaccination event.

getNotGivenElement

public BooleanType getNotGivenElement()

Returns:

notGiven (Indicates if the vaccination was or was not given.). This is the underlying object with id, value and extensions. The accessor "getNotGiven" gives direct access to the value

hasNotGivenElement

public boolean hasNotGivenElement()

hasNotGiven

public boolean hasNotGiven()

setNotGivenElement

public Immunization setNotGivenElement(BooleanType value)

Parameters:

value - notGiven (Indicates if the vaccination was or was not given.). This is the underlying object with id, value and extensions. The accessor "getNotGiven" gives direct access to the value

getNotGiven

public boolean getNotGiven()

Returns:

Indicates if the vaccination was or was not given.

setNotGiven

public Immunization setNotGiven(boolean value)

Parameters:

value - Indicates if the vaccination was or was not given.

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.)

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.)

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.

getPrimarySourceElement

public BooleanType getPrimarySourceElement()

Returns:

primarySource (An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.). This is the underlying object with id, value and extensions. The accessor "getPrimarySource" gives direct access to the value

hasPrimarySourceElement

public boolean hasPrimarySourceElement()

hasPrimarySource

public boolean hasPrimarySource()

setPrimarySourceElement

public Immunization setPrimarySourceElement(BooleanType value)

Parameters:

value - primarySource (An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.). This is the underlying object with id, value and extensions. The accessor "getPrimarySource" gives direct access to the value

getPrimarySource

public boolean getPrimarySource()

Returns:

An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.

setPrimarySource

public Immunization setPrimarySource(boolean value)

Parameters:

value - An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.

getReportOrigin

public CodeableConcept getReportOrigin()

Returns:

reportOrigin (The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.)

hasReportOrigin

public boolean hasReportOrigin()

setReportOrigin

public Immunization setReportOrigin(CodeableConcept value)

Parameters:

value - reportOrigin (The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.)

getLocation

public Reference getLocation()

Returns:

location (The service delivery location where the vaccine administration occurred.)

hasLocation

public boolean hasLocation()

setLocation

public Immunization setLocation(Reference value)

Parameters:

value - location (The service delivery location where the vaccine administration occurred.)

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.)

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.)

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.)

getPractitioner

public List<Immunization.ImmunizationPractitionerComponent> getPractitioner()

Returns:

practitioner (Indicates who or what performed the event.)

setPractitioner

public Immunization setPractitioner(List<Immunization.ImmunizationPractitionerComponent> thePractitioner)

Returns:

Returns a reference to this for easy method chaining

hasPractitioner

public boolean hasPractitioner()

addPractitioner

public Immunization.ImmunizationPractitionerComponent addPractitioner()

addPractitioner

public Immunization addPractitioner(Immunization.ImmunizationPractitionerComponent t)

getPractitionerFirstRep

public Immunization.ImmunizationPractitionerComponent getPractitionerFirstRep()

Returns:

The first repetition of repeating field practitioner, creating it if it does not already exist

getNote

public List<Annotation> getNote()

Returns:

note (Extra information about the immunization that is not conveyed by the other attributes.)

setNote

public Immunization setNote(List<Annotation> theNote)

Returns:

Returns a reference to this for easy method chaining

hasNote

public boolean hasNote()

addNote

public Annotation addNote()

addNote

public Immunization addNote(Annotation t)

getNoteFirstRep

public Annotation getNoteFirstRep()

Returns:

The first repetition of repeating field note, creating it if it does not already exist

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.)

setReaction

public Immunization setReaction(List<Immunization.ImmunizationReactionComponent> theReaction)

Returns:

Returns a reference to this for easy method chaining

hasReaction

public boolean hasReaction()

addReaction

public Immunization.ImmunizationReactionComponent addReaction()

addReaction

public Immunization addReaction(Immunization.ImmunizationReactionComponent t)

getReactionFirstRep

public Immunization.ImmunizationReactionComponent getReactionFirstRep()

Returns:

The first repetition of repeating field reaction, creating it if it does not already exist

getVaccinationProtocol

public List<Immunization.ImmunizationVaccinationProtocolComponent> getVaccinationProtocol()

Returns:

vaccinationProtocol (Contains information about the protocol(s) under which the vaccine was administered.)

setVaccinationProtocol

public Immunization setVaccinationProtocol(List<Immunization.ImmunizationVaccinationProtocolComponent> theVaccinationProtocol)

Returns:

Returns a reference to this for easy method chaining

hasVaccinationProtocol

public boolean hasVaccinationProtocol()

addVaccinationProtocol

public Immunization.ImmunizationVaccinationProtocolComponent addVaccinationProtocol()

addVaccinationProtocol

public Immunization addVaccinationProtocol(Immunization.ImmunizationVaccinationProtocolComponent t)

getVaccinationProtocolFirstRep

public Immunization.ImmunizationVaccinationProtocolComponent getVaccinationProtocolFirstRep()

Returns:

The first repetition of repeating field vaccinationProtocol, creating it if it does not already exist

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

copy

public Immunization copy()

Specified by:

copy in class DomainResource

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