Class ImmunizationEvaluation
- 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.ImmunizationEvaluation
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.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)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ImmunizationEvaluation.Builder
-
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 ImmunizationEvaluation.Builder
builder()
boolean
equals(java.lang.Object obj)
Reference
getAuthority()
Indicates the authority who published the protocol (e.g.DateTime
getDate()
The date the evaluation of the vaccine administration event was performed.String
getDescription()
Additional information about the evaluation.Element
getDoseNumber()
Nominal position in a series.CodeableConcept
getDoseStatus()
Indicates if the dose is valid or not valid with respect to the published recommendations.java.util.List<CodeableConcept>
getDoseStatusReason()
Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations.java.util.List<Identifier>
getIdentifier()
A unique identifier assigned to this immunization evaluation record.Reference
getImmunizationEvent()
The vaccine administration event being evaluated.Reference
getPatient()
The individual for whom the evaluation is being done.String
getSeries()
One possible path to achieve presumed immunity against a disease - within the context of an authority.Element
getSeriesDoses()
The recommended number of doses to achieve immunity.ImmunizationEvaluationStatus
getStatus()
Indicates the current status of the evaluation of the vaccination administration event.CodeableConcept
getTargetDisease()
The vaccine preventable disease the dose is being evaluated against.boolean
hasChildren()
int
hashCode()
ImmunizationEvaluation.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 evaluation record.- Returns:
- An unmodifiable list containing immutable objects of type
Identifier
that may be empty.
-
getStatus
public ImmunizationEvaluationStatus getStatus()
Indicates the current status of the evaluation of the vaccination administration event.- Returns:
- An immutable object of type
ImmunizationEvaluationStatus
that is non-null.
-
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 java.util.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
PositiveInt
orString
that may be null.
-
getSeriesDoses
public Element getSeriesDoses()
The recommended number of doses to achieve immunity.- Returns:
- An immutable object of type
PositiveInt
orString
that may be null.
-
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 ImmunizationEvaluation.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 ImmunizationEvaluation.Builder builder()
-
-