Class Immunization
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.resource.Resource
-
- org.linuxforhealth.fhir.model.resource.DomainResource
-
- org.linuxforhealth.fhir.model.resource.Immunization
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.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)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Immunization.Builder
static class
Immunization.Education
Educational material presented to the patient (or guardian) at the time of vaccine administration.static class
Immunization.Performer
Indicates who performed the immunization event.static class
Immunization.ProtocolApplied
The protocol (set of recommendations) being followed by the provider who administered the dose.static class
Immunization.Reaction
Categorical data indicating that an adverse event is associated in time to an immunization.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static Immunization.Builder
builder()
boolean
equals(java.lang.Object obj)
SimpleQuantity
getDoseQuantity()
The quantity of vaccine product that was administered.java.util.List<Immunization.Education>
getEducation()
Educational material presented to the patient (or guardian) at the time of vaccine administration.Reference
getEncounter()
The visit or admission or other contact between patient and health care provider the immunization was performed as part of.Date
getExpirationDate()
Date vaccine batch expires.CodeableConcept
getFundingSource()
Indicates the source of the vaccine actually administered.java.util.List<Identifier>
getIdentifier()
A unique identifier assigned to this immunization record.Boolean
getIsSubpotent()
Indication if a dose is considered to be subpotent.Reference
getLocation()
The service delivery location where the vaccine administration occurred.String
getLotNumber()
Lot number of the vaccine product.Reference
getManufacturer()
Name of vaccine manufacturer.java.util.List<Annotation>
getNote()
Extra information about the immunization that is not conveyed by the other attributes.Element
getOccurrence()
Date vaccine administered or was to be administered.Reference
getPatient()
The patient who either received or did not receive the immunization.java.util.List<Immunization.Performer>
getPerformer()
Indicates who performed the immunization event.Boolean
getPrimarySource()
An indication that the content of the record is based on information from the person who administered the vaccine.java.util.List<CodeableConcept>
getProgramEligibility()
Indicates a patient's eligibility for a funding program.java.util.List<Immunization.ProtocolApplied>
getProtocolApplied()
The protocol (set of recommendations) being followed by the provider who administered the dose.java.util.List<Immunization.Reaction>
getReaction()
Categorical data indicating that an adverse event is associated in time to an immunization.java.util.List<CodeableConcept>
getReasonCode()
Reasons why the vaccine was administered.java.util.List<Reference>
getReasonReference()
Condition, Observation or DiagnosticReport that supports why the immunization was administered.DateTime
getRecorded()
The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.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.CodeableConcept
getRoute()
The path by which the vaccine product is taken into the body.CodeableConcept
getSite()
Body site where vaccine was administered.ImmunizationStatus
getStatus()
Indicates the current status of the immunization event.CodeableConcept
getStatusReason()
Indicates the reason the immunization event was not performed.java.util.List<CodeableConcept>
getSubpotentReason()
Reason why a dose is considered to be subpotent.CodeableConcept
getVaccineCode()
Vaccine that was administered or was to be administered.boolean
hasChildren()
int
hashCode()
Immunization.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getIdentifier
public java.util.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.
-
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.
-
getPerformer
public java.util.List<Immunization.Performer> getPerformer()
Indicates who performed the immunization event.- Returns:
- An unmodifiable list containing immutable objects of type
Immunization.Performer
that may be empty.
-
getNote
public java.util.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 java.util.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 java.util.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 java.util.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 java.util.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 java.util.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 java.util.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.
-
getProtocolApplied
public java.util.List<Immunization.ProtocolApplied> getProtocolApplied()
The protocol (set of recommendations) being followed by the provider who administered the dose.- Returns:
- An unmodifiable list containing immutable objects of type
Immunization.ProtocolApplied
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(java.lang.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 interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public Immunization.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static Immunization.Builder builder()
-
-