Class 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
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static class
static class
static class
static enum
static class
-
Field Summary
Modifier and TypeFieldDescriptionstatic final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for dateprotected Quantity
The quantity of vaccine product that was administered.protected List
<Immunization.ImmunizationEducationComponent> Educational material presented to the patient (or guardian) at the time of vaccine administration.protected Reference
The visit or admission or other contact between patient and health care provider the immunization was performed as part of.protected Encounter
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
Date vaccine batch expires.protected CodeableConcept
Indicates the source of the vaccine actually administered.protected List
<Identifier> A unique identifier assigned to this immunization record.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.protected BooleanType
Indication if a dose is considered to be subpotent.protected Reference
The service delivery location where the vaccine administration occurred.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for locationprotected Location
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
Fluent Client search parameter constant for lot-numberprotected StringType
Lot number of the vaccine product.protected Reference
Name of vaccine manufacturer.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for manufacturerprotected Organization
The actual object that is the target of the reference (Name of vaccine manufacturer.)protected List
<Annotation> Extra information about the immunization that is not conveyed by the other attributes.protected Type
Date vaccine administered or was to be administered.protected Reference
The patient who either received or did not receive the immunization.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for patientprotected Patient
The actual object that is the target of the reference (The patient who either received or did not receive the immunization.)protected List
<Immunization.ImmunizationPerformerComponent> Indicates who performed the immunization event.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for performerprotected BooleanType
An indication that the content of the record is based on information from the person who administered the vaccine.protected List
<CodeableConcept> Indicates a patient's eligibility for a funding program.The protocol (set of recommendations) being followed by the provider who administered the dose.protected List
<Immunization.ImmunizationReactionComponent> Categorical data indicating that an adverse event is associated in time to an immunization.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for reactionstatic final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for reaction-datestatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for reason-codestatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for reason-referenceprotected List
<CodeableConcept> Reasons why the vaccine was administered.Condition, Observation or DiagnosticReport that supports why the immunization was administered.The actual objects that are the target of the reference (Condition, Observation or DiagnosticReport that supports why the immunization was administered.)protected DateTimeType
The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.protected CodeableConcept
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
The path by which the vaccine product is taken into the body.static final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for seriesprotected CodeableConcept
Body site where vaccine was administered.static final String
Search parameter: datestatic final String
Search parameter: identifierstatic final String
Search parameter: locationstatic final String
Search parameter: lot-numberstatic final String
Search parameter: manufacturerstatic final String
Search parameter: patientstatic final String
Search parameter: performerstatic final String
Search parameter: reactionstatic final String
Search parameter: reaction-datestatic final String
Search parameter: reason-codestatic final String
Search parameter: reason-referencestatic final String
Search parameter: seriesstatic final String
Search parameter: statusstatic final String
Search parameter: status-reasonstatic final String
Search parameter: target-diseasestatic final String
Search parameter: vaccine-codeprotected Enumeration
<Immunization.ImmunizationStatus> Indicates the current status of the immunization event.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for status-reasonprotected CodeableConcept
Indicates the reason the immunization event was not performed.protected List
<CodeableConcept> Reason why a dose is considered to be subpotent.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for target-diseasestatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for vaccine-codeprotected CodeableConcept
Vaccine that was administered or was to be administered.Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
Fields inherited from class org.hl7.fhir.r4.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
ConstructorDescriptionConstructorImmunization
(Enumeration<Immunization.ImmunizationStatus> status, CodeableConcept vaccineCode, Reference patient, Type occurrence) Constructor -
Method Summary
Modifier and TypeMethodDescriptionaddNote()
copy()
void
copyValues
(Immunization dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
boolean
getNamedProperty
(int _hash, String _name, boolean _checkValid) getNote()
boolean
Base[]
getProperty
(int hash, String name, boolean checkValid) Deprecated.Use Reference#setResource(IBaseResource) insteadgetRoute()
getSite()
String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasNote()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasRoute()
boolean
hasSite()
boolean
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setDoseQuantity
(Quantity value) setEducation
(List<Immunization.ImmunizationEducationComponent> theEducation) setEncounter
(Reference value) setEncounterTarget
(Encounter value) setExpirationDate
(Date value) setExpirationDateElement
(DateType value) setFundingSource
(CodeableConcept value) setIdentifier
(List<Identifier> theIdentifier) setIsSubpotent
(boolean value) setIsSubpotentElement
(BooleanType value) setLocation
(Reference value) setLocationTarget
(Location value) setLotNumber
(String value) setLotNumberElement
(StringType value) setManufacturer
(Reference value) setNote
(List<Annotation> theNote) setOccurrence
(Type value) setPatient
(Reference value) setPatientTarget
(Patient value) setPerformer
(List<Immunization.ImmunizationPerformerComponent> thePerformer) setPrimarySource
(boolean value) setProgramEligibility
(List<CodeableConcept> theProgramEligibility) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setProtocolApplied
(List<Immunization.ImmunizationProtocolAppliedComponent> theProtocolApplied) setReaction
(List<Immunization.ImmunizationReactionComponent> theReaction) setReasonCode
(List<CodeableConcept> theReasonCode) setReasonReference
(List<Reference> theReasonReference) setRecorded
(Date value) setRecordedElement
(DateTimeType value) setReportOrigin
(CodeableConcept value) setRoute
(CodeableConcept value) setSite
(CodeableConcept value) setStatusReason
(CodeableConcept value) setSubpotentReason
(List<CodeableConcept> theSubpotentReason) setVaccineCode
(CodeableConcept value) protected Immunization
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
Methods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
identifier
A unique identifier assigned to this immunization record. -
status
Indicates the current status of the immunization event. -
statusReason
Indicates the reason the immunization event was not performed. -
vaccineCode
Vaccine that was administered or was to be administered. -
patient
The patient who either received or did not receive the immunization. -
patientTarget
The actual object that is the target of the reference (The patient who either received or did not receive the immunization.) -
encounter
The visit or admission or other contact between patient and health care provider the immunization was performed as part of. -
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.) -
occurrence
Date vaccine administered or was to be administered. -
recorded
The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event. -
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
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
The service delivery location where the vaccine administration occurred. -
locationTarget
The actual object that is the target of the reference (The service delivery location where the vaccine administration occurred.) -
manufacturer
Name of vaccine manufacturer. -
manufacturerTarget
The actual object that is the target of the reference (Name of vaccine manufacturer.) -
lotNumber
Lot number of the vaccine product. -
expirationDate
Date vaccine batch expires. -
site
Body site where vaccine was administered. -
route
The path by which the vaccine product is taken into the body. -
doseQuantity
The quantity of vaccine product that was administered. -
performer
Indicates who performed the immunization event. -
note
Extra information about the immunization that is not conveyed by the other attributes. -
reasonCode
Reasons why the vaccine was administered. -
reasonReference
Condition, Observation or DiagnosticReport that supports why the immunization was administered. -
reasonReferenceTarget
The actual objects that are the target of the reference (Condition, Observation or DiagnosticReport that supports why the immunization was administered.) -
isSubpotent
Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent. -
subpotentReason
Reason why a dose is considered to be subpotent. -
education
Educational material presented to the patient (or guardian) at the time of vaccine administration. -
programEligibility
Indicates a patient's eligibility for a funding program. -
fundingSource
Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered). -
reaction
Categorical data indicating that an adverse event is associated in time to an immunization. -
protocolApplied
The protocol (set of recommendations) being followed by the provider who administered the dose. -
SP_DATE
Search parameter: dateDescription: Vaccination (non)-Administration Date
Type: date
Path: Immunization.occurrence[x]
- See Also:
-
DATE
Fluent Client search parameter constant for dateDescription: Vaccination (non)-Administration Date
Type: date
Path: Immunization.occurrence[x]
-
SP_IDENTIFIER
Search parameter: identifierDescription: Business identifier
Type: token
Path: Immunization.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Business identifier
Type: token
Path: Immunization.identifier
-
SP_PERFORMER
Search parameter: performerDescription: The practitioner or organization who played a role in the vaccination
Type: reference
Path: Immunization.performer.actor
- See Also:
-
PERFORMER
Fluent Client search parameter constant for performerDescription: The practitioner or organization who played a role in the vaccination
Type: reference
Path: Immunization.performer.actor
-
INCLUDE_PERFORMER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization:performer". -
SP_REACTION
Search parameter: reactionDescription: Additional information on reaction
Type: reference
Path: Immunization.reaction.detail
- See Also:
-
REACTION
Fluent Client search parameter constant for reactionDescription: Additional information on reaction
Type: reference
Path: Immunization.reaction.detail
-
INCLUDE_REACTION
Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization:reaction". -
SP_LOT_NUMBER
Search parameter: lot-numberDescription: Vaccine Lot Number
Type: string
Path: Immunization.lotNumber
- See Also:
-
LOT_NUMBER
Fluent Client search parameter constant for lot-numberDescription: Vaccine Lot Number
Type: string
Path: Immunization.lotNumber
-
SP_STATUS_REASON
Search parameter: status-reasonDescription: Reason why the vaccine was not administered
Type: token
Path: Immunization.statusReason
- See Also:
-
STATUS_REASON
Fluent Client search parameter constant for status-reasonDescription: Reason why the vaccine was not administered
Type: token
Path: Immunization.statusReason
-
SP_REASON_CODE
Search parameter: reason-codeDescription: Reason why the vaccine was administered
Type: token
Path: Immunization.reasonCode
- See Also:
-
REASON_CODE
Fluent Client search parameter constant for reason-codeDescription: Reason why the vaccine was administered
Type: token
Path: Immunization.reasonCode
-
SP_MANUFACTURER
Search parameter: manufacturerDescription: Vaccine Manufacturer
Type: reference
Path: Immunization.manufacturer
- See Also:
-
MANUFACTURER
Fluent Client search parameter constant for manufacturerDescription: Vaccine Manufacturer
Type: reference
Path: Immunization.manufacturer
-
INCLUDE_MANUFACTURER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization:manufacturer". -
SP_TARGET_DISEASE
Search parameter: target-diseaseDescription: The target disease the dose is being administered against
Type: token
Path: Immunization.protocolApplied.targetDisease
- See Also:
-
TARGET_DISEASE
Fluent Client search parameter constant for target-diseaseDescription: The target disease the dose is being administered against
Type: token
Path: Immunization.protocolApplied.targetDisease
-
SP_PATIENT
Search parameter: patientDescription: The patient for the vaccination record
Type: reference
Path: Immunization.patient
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: The patient for the vaccination record
Type: reference
Path: Immunization.patient
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization:patient". -
SP_SERIES
Search parameter: seriesDescription: The series being followed by the provider
Type: string
Path: Immunization.protocolApplied.series
- See Also:
-
SERIES
Fluent Client search parameter constant for seriesDescription: The series being followed by the provider
Type: string
Path: Immunization.protocolApplied.series
-
SP_VACCINE_CODE
Search parameter: vaccine-codeDescription: Vaccine Product Administered
Type: token
Path: Immunization.vaccineCode
- See Also:
-
VACCINE_CODE
Fluent Client search parameter constant for vaccine-codeDescription: Vaccine Product Administered
Type: token
Path: Immunization.vaccineCode
-
SP_REASON_REFERENCE
Search parameter: reason-referenceDescription: Why immunization occurred
Type: reference
Path: Immunization.reasonReference
- See Also:
-
REASON_REFERENCE
Fluent Client search parameter constant for reason-referenceDescription: Why immunization occurred
Type: reference
Path: Immunization.reasonReference
-
INCLUDE_REASON_REFERENCE
Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization:reason-reference". -
SP_LOCATION
Search parameter: locationDescription: The service delivery location or facility in which the vaccine was / was to be administered
Type: reference
Path: Immunization.location
- See Also:
-
LOCATION
Fluent Client search parameter constant for locationDescription: The service delivery location or facility in which the vaccine was / was to be administered
Type: reference
Path: Immunization.location
-
INCLUDE_LOCATION
Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization:location". -
SP_STATUS
Search parameter: statusDescription: Immunization event status
Type: token
Path: Immunization.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: Immunization event status
Type: token
Path: Immunization.status
-
SP_REACTION_DATE
Search parameter: reaction-dateDescription: When reaction started
Type: date
Path: Immunization.reaction.date
- See Also:
-
REACTION_DATE
Fluent Client search parameter constant for reaction-dateDescription: When reaction started
Type: date
Path: Immunization.reaction.date
-
-
Constructor Details
-
Immunization
public Immunization()Constructor -
Immunization
public Immunization(Enumeration<Immunization.ImmunizationStatus> status, CodeableConcept vaccineCode, Reference patient, Type occurrence) Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(A unique identifier assigned to this immunization record.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
getStatusElement
- Returns:
status
(Indicates the current status of the immunization event.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
-
hasStatus
-
setStatusElement
- Parameters:
value
-status
(Indicates the current status of the immunization event.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
- Returns:
- Indicates the current status of the immunization event.
-
setStatus
- Parameters:
value
- Indicates the current status of the immunization event.
-
getStatusReason
- Returns:
statusReason
(Indicates the reason the immunization event was not performed.)
-
hasStatusReason
-
setStatusReason
- Parameters:
value
-statusReason
(Indicates the reason the immunization event was not performed.)
-
getVaccineCode
- Returns:
vaccineCode
(Vaccine that was administered or was to be administered.)
-
hasVaccineCode
-
setVaccineCode
- Parameters:
value
-vaccineCode
(Vaccine that was administered or was to be administered.)
-
getPatient
- Returns:
patient
(The patient who either received or did not receive the immunization.)
-
hasPatient
-
setPatient
- Parameters:
value
-patient
(The patient who either received or did not receive the immunization.)
-
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
- 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
- Returns:
encounter
(The visit or admission or other contact between patient and health care provider the immunization was performed as part of.)
-
hasEncounter
-
setEncounter
- Parameters:
value
-encounter
(The visit or admission or other contact between patient and health care provider the immunization was performed as part of.)
-
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
- 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.)
-
getOccurrence
- Returns:
occurrence
(Date vaccine administered or was to be administered.)
-
getOccurrenceDateTimeType
- Returns:
occurrence
(Date vaccine administered or was to be administered.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasOccurrenceDateTimeType
-
getOccurrenceStringType
- Returns:
occurrence
(Date vaccine administered or was to be administered.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasOccurrenceStringType
-
hasOccurrence
-
setOccurrence
- Parameters:
value
-occurrence
(Date vaccine administered or was to be administered.)
-
getRecordedElement
- Returns:
recorded
(The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.). This is the underlying object with id, value and extensions. The accessor "getRecorded" gives direct access to the value
-
hasRecordedElement
-
hasRecorded
-
setRecordedElement
- Parameters:
value
-recorded
(The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.). This is the underlying object with id, value and extensions. The accessor "getRecorded" gives direct access to the value
-
getRecorded
- Returns:
- The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
-
setRecorded
- Parameters:
value
- The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
-
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
-
hasPrimarySource
-
setPrimarySourceElement
- 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
- 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
- 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
- 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
-
setReportOrigin
- 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
- Returns:
location
(The service delivery location where the vaccine administration occurred.)
-
hasLocation
-
setLocation
- Parameters:
value
-location
(The service delivery location where the vaccine administration occurred.)
-
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
- 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
- Returns:
manufacturer
(Name of vaccine manufacturer.)
-
hasManufacturer
-
setManufacturer
- Parameters:
value
-manufacturer
(Name of vaccine manufacturer.)
-
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
- 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
- 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
-
hasLotNumber
-
setLotNumberElement
- 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
- Returns:
- Lot number of the vaccine product.
-
setLotNumber
- Parameters:
value
- Lot number of the vaccine product.
-
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
-
hasExpirationDate
-
setExpirationDateElement
- 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
- Returns:
- Date vaccine batch expires.
-
setExpirationDate
- Parameters:
value
- Date vaccine batch expires.
-
getSite
- Returns:
site
(Body site where vaccine was administered.)
-
hasSite
-
setSite
- Parameters:
value
-site
(Body site where vaccine was administered.)
-
getRoute
- Returns:
route
(The path by which the vaccine product is taken into the body.)
-
hasRoute
-
setRoute
- Parameters:
value
-route
(The path by which the vaccine product is taken into the body.)
-
getDoseQuantity
- Returns:
doseQuantity
(The quantity of vaccine product that was administered.)
-
hasDoseQuantity
-
setDoseQuantity
- Parameters:
value
-doseQuantity
(The quantity of vaccine product that was administered.)
-
getPerformer
- Returns:
performer
(Indicates who performed the immunization event.)
-
setPerformer
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasPerformer
-
addPerformer
-
addPerformer
-
getPerformerFirstRep
- Returns:
- The first repetition of repeating field
performer
, creating it if it does not already exist
-
getNote
- Returns:
note
(Extra information about the immunization that is not conveyed by the other attributes.)
-
setNote
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasNote
-
addNote
-
addNote
-
getNoteFirstRep
- Returns:
- The first repetition of repeating field
note
, creating it if it does not already exist
-
getReasonCode
- Returns:
reasonCode
(Reasons why the vaccine was administered.)
-
setReasonCode
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReasonCode
-
addReasonCode
-
addReasonCode
-
getReasonCodeFirstRep
- Returns:
- The first repetition of repeating field
reasonCode
, creating it if it does not already exist
-
getReasonReference
- Returns:
reasonReference
(Condition, Observation or DiagnosticReport that supports why the immunization was administered.)
-
setReasonReference
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReasonReference
-
addReasonReference
-
addReasonReference
-
getReasonReferenceFirstRep
- Returns:
- The first repetition of repeating field
reasonReference
, creating it if it does not already exist
-
getReasonReferenceTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getIsSubpotentElement
- Returns:
isSubpotent
(Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.). This is the underlying object with id, value and extensions. The accessor "getIsSubpotent" gives direct access to the value
-
hasIsSubpotentElement
-
hasIsSubpotent
-
setIsSubpotentElement
- Parameters:
value
-isSubpotent
(Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.). This is the underlying object with id, value and extensions. The accessor "getIsSubpotent" gives direct access to the value
-
getIsSubpotent
- Returns:
- Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
-
setIsSubpotent
- Parameters:
value
- Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
-
getSubpotentReason
- Returns:
subpotentReason
(Reason why a dose is considered to be subpotent.)
-
setSubpotentReason
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSubpotentReason
-
addSubpotentReason
-
addSubpotentReason
-
getSubpotentReasonFirstRep
- Returns:
- The first repetition of repeating field
subpotentReason
, creating it if it does not already exist
-
getEducation
- Returns:
education
(Educational material presented to the patient (or guardian) at the time of vaccine administration.)
-
setEducation
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasEducation
-
addEducation
-
addEducation
-
getEducationFirstRep
- Returns:
- The first repetition of repeating field
education
, creating it if it does not already exist
-
getProgramEligibility
- Returns:
programEligibility
(Indicates a patient's eligibility for a funding program.)
-
setProgramEligibility
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasProgramEligibility
-
addProgramEligibility
-
addProgramEligibility
-
getProgramEligibilityFirstRep
- Returns:
- The first repetition of repeating field
programEligibility
, creating it if it does not already exist
-
getFundingSource
- Returns:
fundingSource
(Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).)
-
hasFundingSource
-
setFundingSource
- Parameters:
value
-fundingSource
(Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).)
-
getReaction
- Returns:
reaction
(Categorical data indicating that an adverse event is associated in time to an immunization.)
-
setReaction
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReaction
-
addReaction
-
addReaction
-
getReactionFirstRep
- Returns:
- The first repetition of repeating field
reaction
, creating it if it does not already exist
-
getProtocolApplied
- Returns:
protocolApplied
(The protocol (set of recommendations) being followed by the provider who administered the dose.)
-
setProtocolApplied
public Immunization setProtocolApplied(List<Immunization.ImmunizationProtocolAppliedComponent> theProtocolApplied) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasProtocolApplied
-
addProtocolApplied
-
addProtocolApplied
-
getProtocolAppliedFirstRep
- Returns:
- The first repetition of repeating field
protocolApplied
, creating it if it does not already exist
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- 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 classDomainResource
- 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 classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-