Class Immunization

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

    public class Immunization
    extends BaseResource
    implements ca.uhn.fhir.model.api.IResource
    HAPI/FHIR Immunization Resource (clinical.medication)

    Definition: 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.

    Requirements:

    Profile Definition: http://hl7.org/fhir/profiles/Immunization

    See Also:
    Serialized Form
    • Field Detail

      • SP_DATE

        public static final String SP_DATE
        Search parameter constant for 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_DOSE_SEQUENCE

        public static final String SP_DOSE_SEQUENCE
        Search parameter constant for dose-sequence

        Description:
        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:
        Type: number
        Path: Immunization.vaccinationProtocol.doseSequence

      • IDENTIFIER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
        Fluent Client search parameter constant for identifier

        Description:
        Type: token
        Path: Immunization.identifier

      • SP_LOCATION

        public static final String SP_LOCATION
        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

        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

      • SP_LOT_NUMBER

        public static final String SP_LOT_NUMBER
        Search parameter constant for lot-number

        Description: Vaccine Lot Number
        Type: string
        Path: Immunization.lotNumber

        See Also:
        Constant Field Values
      • LOT_NUMBER

        public static final ca.uhn.fhir.rest.gclient.StringClientParam LOT_NUMBER
        Fluent Client search parameter constant for lot-number

        Description: Vaccine Lot Number
        Type: string
        Path: Immunization.lotNumber

      • SP_MANUFACTURER

        public static final String SP_MANUFACTURER
        Search parameter constant for 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

      • SP_PERFORMER

        public static final String SP_PERFORMER
        Search parameter constant for performer

        Description: The practitioner who administered the vaccination
        Type: reference
        Path: Immunization.performer

        See Also:
        Constant Field Values
      • PERFORMER

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PERFORMER
        Fluent Client search parameter constant for performer

        Description: The practitioner who administered the vaccination
        Type: reference
        Path: Immunization.performer

      • REACTION

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REACTION
        Fluent Client search parameter constant for reaction

        Description:
        Type: reference
        Path: Immunization.reaction.detail

      • REACTION_DATE

        public static final ca.uhn.fhir.rest.gclient.DateClientParam REACTION_DATE
        Fluent Client search parameter constant for reaction-date

        Description:
        Type: date
        Path: Immunization.reaction.date

      • SP_REASON

        public static final String SP_REASON
        Search parameter constant for reason

        Description:
        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:
        Type: token
        Path: Immunization.explanation.reason

      • SP_REASON_NOT_GIVEN

        public static final String SP_REASON_NOT_GIVEN
        Search parameter constant for 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_NOTGIVEN

        public static final String SP_NOTGIVEN
        Search parameter constant for notgiven

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

        See Also:
        Constant Field Values
      • NOTGIVEN

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam NOTGIVEN
        Fluent Client search parameter constant for notgiven

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

      • SP_REQUESTER

        public static final String SP_REQUESTER
        Search parameter constant for requester

        Description: The practitioner who ordered the vaccination
        Type: reference
        Path: Immunization.requester

        See Also:
        Constant Field Values
      • REQUESTER

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REQUESTER
        Fluent Client search parameter constant for requester

        Description: The practitioner who ordered the vaccination
        Type: reference
        Path: Immunization.requester

      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter constant for 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

      • SP_VACCINE_CODE

        public static final String SP_VACCINE_CODE
        Search parameter constant for 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_STATUS

        public static final String SP_STATUS
        Search parameter constant for 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

      • 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".
      • 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".
      • 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".
      • INCLUDE_PERFORMER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PERFORMER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization:performer".
      • 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".
      • INCLUDE_REQUESTER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_REQUESTER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization:requester".
    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getIdentifier

        public List<IdentifierDtgetIdentifier()
        Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.

        Definition: A unique identifier assigned to this immunization record.

      • addIdentifier

        public IdentifierDt addIdentifier()
        Adds and returns a new value for identifier (id)

        Definition: A unique identifier assigned to this immunization record.

      • addIdentifier

        public Immunization addIdentifier​(IdentifierDt theValue)
        Adds a given new value for identifier (id)

        Definition: A unique identifier assigned to this immunization record.

        Parameters:
        theValue - The identifier to add (must not be null)
      • getIdentifierFirstRep

        public IdentifierDt getIdentifierFirstRep()
        Gets the first repetition for identifier (id), creating it if it does not already exist.

        Definition: A unique identifier assigned to this immunization record.

      • getStatusElement

        public ca.uhn.fhir.model.primitive.CodeDt getStatusElement()
        Gets the value(s) for status (status). creating it if it does not exist. Will not return null.

        Definition: Indicates the current status of the vaccination event

      • getStatus

        public String getStatus()
        Gets the value(s) for status (status). creating it if it does not exist. This method may return null.

        Definition: Indicates the current status of the vaccination event

      • setStatus

        public Immunization setStatus​(ca.uhn.fhir.model.primitive.CodeDt theValue)
        Sets the value(s) for status (status)

        Definition: Indicates the current status of the vaccination event

      • setStatus

        public Immunization setStatus​(String theCode)
        Sets the value for status (status)

        Definition: Indicates the current status of the vaccination event

      • getDateElement

        public ca.uhn.fhir.model.primitive.DateTimeDt getDateElement()
        Gets the value(s) for date (when.init). creating it if it does not exist. Will not return null.

        Definition: Date vaccine administered or was to be administered

      • getDate

        public Date getDate()
        Gets the value(s) for date (when.init). creating it if it does not exist. This method may return null.

        Definition: Date vaccine administered or was to be administered

      • setDate

        public Immunization setDate​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for date (when.init)

        Definition: Date vaccine administered or was to be administered

      • setDate

        public Immunization setDate​(Date theDate,
                                    ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for date (when.init)

        Definition: Date vaccine administered or was to be administered

      • getVaccineCode

        public CodeableConceptDt getVaccineCode()
        Gets the value(s) for vaccineCode (what). creating it if it does not exist. Will not return null.

        Definition: Vaccine that was administered or was to be administered

      • getPatient

        public ResourceReferenceDt getPatient()
        Gets the value(s) for patient (who.focus). creating it if it does not exist. Will not return null.

        Definition: The patient who either received or did not receive the immunization.

      • getWasNotGivenElement

        public ca.uhn.fhir.model.primitive.BooleanDt getWasNotGivenElement()
        Gets the value(s) for wasNotGiven (status). creating it if it does not exist. Will not return null.

        Definition: Indicates if the vaccination was or was not given

      • getWasNotGiven

        public Boolean getWasNotGiven()
        Gets the value(s) for wasNotGiven (status). creating it if it does not exist. This method may return null.

        Definition: Indicates if the vaccination was or was not given

      • setWasNotGiven

        public Immunization setWasNotGiven​(ca.uhn.fhir.model.primitive.BooleanDt theValue)
        Sets the value(s) for wasNotGiven (status)

        Definition: Indicates if the vaccination was or was not given

      • setWasNotGiven

        public Immunization setWasNotGiven​(boolean theBoolean)
        Sets the value for wasNotGiven (status)

        Definition: Indicates if the vaccination was or was not given

      • getReportedElement

        public ca.uhn.fhir.model.primitive.BooleanDt getReportedElement()
        Gets the value(s) for reported (who.source). creating it if it does not exist. Will not return null.

        Definition: True if this administration was reported rather than directly administered.

      • getReported

        public Boolean getReported()
        Gets the value(s) for reported (who.source). creating it if it does not exist. This method may return null.

        Definition: True if this administration was reported rather than directly administered.

      • setReported

        public Immunization setReported​(ca.uhn.fhir.model.primitive.BooleanDt theValue)
        Sets the value(s) for reported (who.source)

        Definition: True if this administration was reported rather than directly administered.

      • setReported

        public Immunization setReported​(boolean theBoolean)
        Sets the value for reported (who.source)

        Definition: True if this administration was reported rather than directly administered.

      • getPerformer

        public ResourceReferenceDt getPerformer()
        Gets the value(s) for performer (who.actor). creating it if it does not exist. Will not return null.

        Definition: Clinician who administered the vaccine

      • getRequester

        public ResourceReferenceDt getRequester()
        Gets the value(s) for requester (who.cause). creating it if it does not exist. Will not return null.

        Definition: Clinician who ordered the vaccination

      • getEncounter

        public ResourceReferenceDt getEncounter()
        Gets the value(s) for encounter (context). creating it if it does not exist. Will not return null.

        Definition: The visit or admission or other contact between patient and health care provider the immunization was performed as part of.

      • setEncounter

        public Immunization setEncounter​(ResourceReferenceDt theValue)
        Sets the value(s) for encounter (context)

        Definition: The visit or admission or other contact between patient and health care provider the immunization was performed as part of.

      • getManufacturer

        public ResourceReferenceDt getManufacturer()
        Gets the value(s) for manufacturer (). creating it if it does not exist. Will not return null.

        Definition: Name of vaccine manufacturer

      • getLocation

        public ResourceReferenceDt getLocation()
        Gets the value(s) for location (where). creating it if it does not exist. Will not return null.

        Definition: The service delivery location where the vaccine administration occurred.

      • getLotNumberElement

        public ca.uhn.fhir.model.primitive.StringDt getLotNumberElement()
        Gets the value(s) for lotNumber (). creating it if it does not exist. Will not return null.

        Definition: Lot number of the vaccine product

      • getLotNumber

        public String getLotNumber()
        Gets the value(s) for lotNumber (). creating it if it does not exist. This method may return null.

        Definition: Lot number of the vaccine product

      • setLotNumber

        public Immunization setLotNumber​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for lotNumber ()

        Definition: Lot number of the vaccine product

      • getExpirationDateElement

        public ca.uhn.fhir.model.primitive.DateDt getExpirationDateElement()
        Gets the value(s) for expirationDate (). creating it if it does not exist. Will not return null.

        Definition: Date vaccine batch expires

      • getExpirationDate

        public Date getExpirationDate()
        Gets the value(s) for expirationDate (). creating it if it does not exist. This method may return null.

        Definition: Date vaccine batch expires

      • setExpirationDate

        public Immunization setExpirationDate​(ca.uhn.fhir.model.primitive.DateDt theValue)
        Sets the value(s) for expirationDate ()

        Definition: Date vaccine batch expires

      • setExpirationDate

        public Immunization setExpirationDate​(Date theDate,
                                              ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for expirationDate ()

        Definition: Date vaccine batch expires

      • getSite

        public CodeableConceptDt getSite()
        Gets the value(s) for site (). creating it if it does not exist. Will not return null.

        Definition: Body site where vaccine was administered

      • getRoute

        public CodeableConceptDt getRoute()
        Gets the value(s) for route (). creating it if it does not exist. Will not return null.

        Definition: The path by which the vaccine product is taken into the body.

      • getDoseQuantity

        public SimpleQuantityDt getDoseQuantity()
        Gets the value(s) for doseQuantity (). creating it if it does not exist. Will not return null.

        Definition: The quantity of vaccine product that was administered

      • getNote

        public List<AnnotationDtgetNote()
        Gets the value(s) for note (). creating it if it does not exist. Will not return null.

        Definition: Extra information about the immunization that is not conveyed by the other attributes.

      • setNote

        public Immunization setNote​(List<AnnotationDt> theValue)
        Sets the value(s) for note ()

        Definition: Extra information about the immunization that is not conveyed by the other attributes.

      • addNote

        public AnnotationDt addNote()
        Adds and returns a new value for note ()

        Definition: Extra information about the immunization that is not conveyed by the other attributes.

      • addNote

        public Immunization addNote​(AnnotationDt theValue)
        Adds a given new value for note ()

        Definition: Extra information about the immunization that is not conveyed by the other attributes.

        Parameters:
        theValue - The note to add (must not be null)
      • getNoteFirstRep

        public AnnotationDt getNoteFirstRep()
        Gets the first repetition for note (), creating it if it does not already exist.

        Definition: Extra information about the immunization that is not conveyed by the other attributes.

      • getExplanation

        public Immunization.Explanation getExplanation()
        Gets the value(s) for explanation (). creating it if it does not exist. Will not return null.

        Definition: Reasons why a vaccine was or was not administered

      • getReaction

        public List<Immunization.ReactiongetReaction()
        Gets the value(s) for reaction (). creating it if it does not exist. Will not return null.

        Definition: Categorical data indicating that an adverse event is associated in time to an immunization

      • addReaction

        public Immunization.Reaction addReaction()
        Adds and returns a new value for reaction ()

        Definition: Categorical data indicating that an adverse event is associated in time to an immunization

      • addReaction

        public Immunization addReaction​(Immunization.Reaction theValue)
        Adds a given new value for reaction ()

        Definition: Categorical data indicating that an adverse event is associated in time to an immunization

        Parameters:
        theValue - The reaction to add (must not be null)
      • getReactionFirstRep

        public Immunization.Reaction getReactionFirstRep()
        Gets the first repetition for reaction (), creating it if it does not already exist.

        Definition: Categorical data indicating that an adverse event is associated in time to an immunization

      • getVaccinationProtocol

        public List<Immunization.VaccinationProtocolgetVaccinationProtocol()
        Gets the value(s) for vaccinationProtocol (). creating it if it does not exist. Will not return null.

        Definition: Contains information about the protocol(s) under which the vaccine was administered

      • addVaccinationProtocol

        public Immunization addVaccinationProtocol​(Immunization.VaccinationProtocol theValue)
        Adds a given new value for vaccinationProtocol ()

        Definition: Contains information about the protocol(s) under which the vaccine was administered

        Parameters:
        theValue - The vaccinationProtocol to add (must not be null)
      • getResourceName

        public String getResourceName()
        Specified by:
        getResourceName in interface ca.uhn.fhir.model.api.IResource
      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource