Package com.ibm.fhir.model.resource

Class ImmunizationEvaluation

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class ImmunizationEvaluation
extends DomainResource
    Describes a comparison of an immunization event against published recommendations to determine if the administration is "valid" in relation to those recommendations.

    Maturity level: FMM0 (Trial Use)

    • Method Detail

      • getIdentifier

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

      • getPatient

        public Reference getPatient()
        The individual for whom the evaluation is being done.
        Returns:
        An immutable object of type Reference that is non-null.

      • getDate

        public DateTime getDate()
        The date the evaluation of the vaccine administration event was performed.
        Returns:
        An immutable object of type DateTime that may be null.

      • getAuthority

        public Reference getAuthority()
        Indicates the authority who published the protocol (e.g. ACIP).
        Returns:
        An immutable object of type Reference that may be null.

      • getTargetDisease

        public CodeableConcept getTargetDisease()
        The vaccine preventable disease the dose is being evaluated against.
        Returns:
        An immutable object of type CodeableConcept that is non-null.

      • getImmunizationEvent

        public Reference getImmunizationEvent()
        The vaccine administration event being evaluated.
        Returns:
        An immutable object of type Reference that is non-null.

      • getDoseStatus

        public CodeableConcept getDoseStatus()
        Indicates if the dose is valid or not valid with respect to the published recommendations.
        Returns:
        An immutable object of type CodeableConcept that is non-null.

      • getDoseStatusReason

        public List<CodeableConcept> getDoseStatusReason()
        Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getDescription

        public String getDescription()
        Additional information about the evaluation.
        Returns:
        An immutable object of type String that may be null.

      • getSeries

        public String getSeries()
        One possible path to achieve presumed immunity against a disease - within the context of an authority.
        Returns:
        An immutable object of type String that may be null.

      • getDoseNumber

        public Element getDoseNumber()
        Nominal position in a series.
        Returns:
        An immutable object of type Element that may be null.

      • getSeriesDoses

        public Element getSeriesDoses()
        The recommended number of doses to achieve immunity.
        Returns:
        An immutable object of type Element that may be null.

      • 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