Package com.ibm.fhir.model.resource

Class Immunization

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class Immunization
extends DomainResource
    Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.

    Maturity level: FMM3 (Trial Use)

    • Method Detail

      • getIdentifier

        public List<Identifier> getIdentifier()
        A unique identifier assigned to this immunization record.
        Returns:
        An unmodifiable list containing immutable objects of type Identifier that may be empty.

      • getStatus

        public ImmunizationStatus getStatus()
        Indicates the current status of the immunization event.
        Returns:
        An immutable object of type ImmunizationStatus that is non-null.

      • getStatusReason

        public CodeableConcept getStatusReason()
        Indicates the reason the immunization event was not performed.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getVaccineCode

        public CodeableConcept getVaccineCode()
        Vaccine that was administered or was to be administered.
        Returns:
        An immutable object of type CodeableConcept that is non-null.

      • getPatient

        public Reference getPatient()
        The patient who either received or did not receive the immunization.
        Returns:
        An immutable object of type Reference that is non-null.

      • getEncounter

        public Reference getEncounter()
        The visit or admission or other contact between patient and health care provider the immunization was performed as part of.
        Returns:
        An immutable object of type Reference that may be null.

      • getOccurrence

        public Element getOccurrence()
        Date vaccine administered or was to be administered.
        Returns:
        An immutable object of type DateTime or String that is non-null.

      • getRecorded

        public DateTime getRecorded()
        The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
        Returns:
        An immutable object of type DateTime that may be null.

      • getPrimarySource

        public Boolean getPrimarySource()
        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.
        Returns:
        An immutable object of type Boolean that may be null.

      • getReportOrigin

        public CodeableConcept getReportOrigin()
        The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getLocation

        public Reference getLocation()
        The service delivery location where the vaccine administration occurred.
        Returns:
        An immutable object of type Reference that may be null.

      • getManufacturer

        public Reference getManufacturer()
        Name of vaccine manufacturer.
        Returns:
        An immutable object of type Reference that may be null.

      • getLotNumber

        public String getLotNumber()
        Lot number of the vaccine product.
        Returns:
        An immutable object of type String that may be null.

      • getExpirationDate

        public Date getExpirationDate()
        Date vaccine batch expires.
        Returns:
        An immutable object of type Date that may be null.

      • getSite

        public CodeableConcept getSite()
        Body site where vaccine was administered.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getRoute

        public CodeableConcept getRoute()
        The path by which the vaccine product is taken into the body.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getDoseQuantity

        public SimpleQuantity getDoseQuantity()
        The quantity of vaccine product that was administered.
        Returns:
        An immutable object of type SimpleQuantity that may be null.

      • getNote

        public List<Annotation> getNote()
        Extra information about the immunization that is not conveyed by the other attributes.
        Returns:
        An unmodifiable list containing immutable objects of type Annotation that may be empty.

      • getReasonCode

        public List<CodeableConcept> getReasonCode()
        Reasons why the vaccine was administered.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getReasonReference

        public List<Reference> getReasonReference()
        Condition, Observation or DiagnosticReport that supports why the immunization was administered.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getIsSubpotent

        public Boolean getIsSubpotent()
        Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
        Returns:
        An immutable object of type Boolean that may be null.

      • getSubpotentReason

        public List<CodeableConcept> getSubpotentReason()
        Reason why a dose is considered to be subpotent.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getEducation

        public List<Immunization.Education> getEducation()
        Educational material presented to the patient (or guardian) at the time of vaccine administration.
        Returns:
        An unmodifiable list containing immutable objects of type Immunization.Education that may be empty.

      • getProgramEligibility

        public List<CodeableConcept> getProgramEligibility()
        Indicates a patient's eligibility for a funding program.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getFundingSource

        public CodeableConcept getFundingSource()
        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).
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getReaction

        public List<Immunization.Reaction> getReaction()
        Categorical data indicating that an adverse event is associated in time to an immunization.
        Returns:
        An unmodifiable list containing immutable objects of type Immunization.Reaction that may be empty.

      • accept

        public void accept​(String elementName,
                   int elementIndex,
                   Visitor visitor)
        Description copied from interface: Visitable
        Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this: 
         if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
        Specified by:
        accept in interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object