Package org.hl7.fhir.dstu2.model
Class Immunization
java.lang.Object
org.hl7.fhir.dstu2.model.Base
org.hl7.fhir.dstu2.model.BaseResource
org.hl7.fhir.dstu2.model.Resource
org.hl7.fhir.dstu2.model.DomainResource
org.hl7.fhir.dstu2.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
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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static class
static class
-
Field Summary
Modifier and TypeFieldDescriptionprotected DateTimeType
Date vaccine administered or was to be administered.protected SimpleQuantity
The quantity of vaccine product that was administered.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.Reasons why a vaccine was or was not administered.protected List
<Identifier> A unique identifier assigned to this immunization record.protected Reference
The service delivery location where the vaccine administration occurred.protected Location
The actual object that is the target of the reference (The service delivery location where the vaccine administration occurred.)protected StringType
Lot number of the vaccine product.protected Reference
Name of vaccine manufacturer.protected 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 Reference
The patient who either received or did not receive the immunization.protected Patient
The actual object that is the target of the reference (The patient who either received or did not receive the immunization.)protected Reference
Clinician who administered the vaccine.protected Practitioner
The actual object that is the target of the reference (Clinician who administered the vaccine.)protected List
<Immunization.ImmunizationReactionComponent> Categorical data indicating that an adverse event is associated in time to an immunization.protected BooleanType
True if this administration was reported rather than directly administered.protected Reference
Clinician who ordered the vaccination.protected Practitioner
The actual object that is the target of the reference (Clinician who ordered the vaccination.)protected CodeableConcept
The path by which the vaccine product is taken into the body.protected CodeableConcept
Body site where vaccine was administered.static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
protected CodeType
Indicates the current status of the vaccination event.Contains information about the protocol(s) under which the vaccine was administered.protected CodeableConcept
Vaccine that was administered or was to be administered.protected BooleanType
Indicates if the vaccination was or was not given.Fields inherited from class org.hl7.fhir.dstu2.model.DomainResource
contained, extension, modifierExtension, text
Fields inherited from class org.hl7.fhir.dstu2.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
ConstructorDescriptionImmunization
(CodeType status, CodeableConcept vaccineCode, Reference patient, BooleanType wasNotGiven, BooleanType reported) -
Method Summary
Modifier and TypeMethodDescriptionaddNote()
copy()
boolean
equalsDeep
(Base other) boolean
equalsShallow
(Base other) fhirType()
getDate()
getNote()
boolean
getRoute()
getSite()
boolean
boolean
hasDate()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasNote()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasRoute()
boolean
hasSite()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> childrenList) setDateElement
(DateTimeType value) setDoseQuantity
(SimpleQuantity value) setEncounter
(Reference value) setEncounterTarget
(Encounter value) setExpirationDate
(Date value) setExpirationDateElement
(DateType value) setLocation
(Reference value) setLocationTarget
(Location value) setLotNumber
(String value) setLotNumberElement
(StringType value) setManufacturer
(Reference value) setPatient
(Reference value) setPatientTarget
(Patient value) setPerformer
(Reference value) setPerformerTarget
(Practitioner value) void
setProperty
(String name, Base value) setReported
(boolean value) setReportedElement
(BooleanType value) setRequester
(Reference value) setRequesterTarget
(Practitioner value) setRoute
(CodeableConcept value) setSite
(CodeableConcept value) setStatusElement
(CodeType value) setVaccineCode
(CodeableConcept value) setWasNotGiven
(boolean value) setWasNotGivenElement
(BooleanType value) protected Immunization
Methods inherited from class org.hl7.fhir.dstu2.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getModifierExtension, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setText
Methods inherited from class org.hl7.fhir.dstu2.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.dstu2.model.BaseResource
getStructureFhirVersionEnum, setId
Methods inherited from class org.hl7.fhir.dstu2.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, 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 vaccination event. -
date
Date vaccine administered or was to be administered. -
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.) -
wasNotGiven
Indicates if the vaccination was or was not given. -
reported
True if this administration was reported rather than directly administered. -
performer
Clinician who administered the vaccine. -
performerTarget
The actual object that is the target of the reference (Clinician who administered the vaccine.) -
requester
Clinician who ordered the vaccination. -
requesterTarget
The actual object that is the target of the reference (Clinician who ordered the vaccination.) -
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.) -
manufacturer
Name of vaccine manufacturer. -
manufacturerTarget
The actual object that is the target of the reference (Name of vaccine manufacturer.) -
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.) -
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. -
note
Extra information about the immunization that is not conveyed by the other attributes. -
explanation
Reasons why a vaccine was or was not administered. -
reaction
Categorical data indicating that an adverse event is associated in time to an immunization. -
vaccinationProtocol
Contains information about the protocol(s) under which the vaccine was administered. -
SP_DATE
- See Also:
-
SP_REQUESTER
- See Also:
-
SP_IDENTIFIER
- See Also:
-
SP_REASON
- See Also:
-
SP_PERFORMER
- See Also:
-
SP_REACTION
- See Also:
-
SP_LOTNUMBER
- See Also:
-
SP_NOTGIVEN
- See Also:
-
SP_MANUFACTURER
- See Also:
-
SP_DOSESEQUENCE
- See Also:
-
SP_PATIENT
- See Also:
-
SP_VACCINECODE
- See Also:
-
SP_REASONNOTGIVEN
- See Also:
-
SP_LOCATION
- See Also:
-
SP_REACTIONDATE
- See Also:
-
SP_STATUS
- See Also:
-
-
Constructor Details
-
Immunization
public Immunization() -
Immunization
public Immunization(CodeType status, CodeableConcept vaccineCode, Reference patient, BooleanType wasNotGiven, BooleanType reported)
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(A unique identifier assigned to this immunization record.)
-
hasIdentifier
-
addIdentifier
- Returns:
identifier
(A unique identifier assigned to this immunization record.)
-
addIdentifier
-
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
-
hasStatus
-
setStatusElement
- 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
- Returns:
- Indicates the current status of the vaccination event.
-
setStatus
- Parameters:
value
- Indicates the current status of the vaccination event.
-
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
-
hasDate
-
setDateElement
- 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
- Returns:
- Date vaccine administered or was to be administered.
-
setDate
- Parameters:
value
- Date vaccine administered or was to be administered.
-
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.)
-
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
-
hasWasNotGiven
-
setWasNotGivenElement
- 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
- Returns:
- Indicates if the vaccination was or was not given.
-
setWasNotGiven
- Parameters:
value
- Indicates if the vaccination was or was not given.
-
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
-
hasReported
-
setReportedElement
- 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
- Returns:
- True if this administration was reported rather than directly administered.
-
setReported
- Parameters:
value
- True if this administration was reported rather than directly administered.
-
getPerformer
- Returns:
performer
(Clinician who administered the vaccine.)
-
hasPerformer
-
setPerformer
- Parameters:
value
-performer
(Clinician who administered the vaccine.)
-
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
- 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
- Returns:
requester
(Clinician who ordered the vaccination.)
-
hasRequester
-
setRequester
- Parameters:
value
-requester
(Clinician who ordered the vaccination.)
-
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
- 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
- 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.)
-
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.)
-
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.)
-
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.)
-
getNote
- Returns:
note
(Extra information about the immunization that is not conveyed by the other attributes.)
-
hasNote
-
addNote
- Returns:
note
(Extra information about the immunization that is not conveyed by the other attributes.)
-
addNote
-
getExplanation
- Returns:
explanation
(Reasons why a vaccine was or was not administered.)
-
hasExplanation
-
setExplanation
- Parameters:
value
-explanation
(Reasons why a vaccine was or was not administered.)
-
getReaction
- Returns:
reaction
(Categorical data indicating that an adverse event is associated in time to an immunization.)
-
hasReaction
-
addReaction
- Returns:
reaction
(Categorical data indicating that an adverse event is associated in time to an immunization.)
-
addReaction
-
getVaccinationProtocol
- Returns:
vaccinationProtocol
(Contains information about the protocol(s) under which the vaccine was administered.)
-
hasVaccinationProtocol
-
addVaccinationProtocol
- Returns:
vaccinationProtocol
(Contains information about the protocol(s) under which the vaccine was administered.)
-
addVaccinationProtocol
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
setProperty
- Overrides:
setProperty
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
-
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
-