Package com.ibm.fhir.model.resource
Class ImmunizationRecommendation.Recommendation
- java.lang.Object
-
- com.ibm.fhir.model.visitor.AbstractVisitable
-
- com.ibm.fhir.model.type.Element
-
- com.ibm.fhir.model.type.BackboneElement
-
- com.ibm.fhir.model.resource.ImmunizationRecommendation.Recommendation
-
- All Implemented Interfaces:
Visitable
- Enclosing class:
- ImmunizationRecommendation
public static class ImmunizationRecommendation.Recommendation extends BackboneElement
Vaccine administration recommendations.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classImmunizationRecommendation.Recommendation.Builderstatic classImmunizationRecommendation.Recommendation.DateCriterionVaccine date recommendations.
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.type.BackboneElement
modifierExtension
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(String elementName, int elementIndex, Visitor visitor)Accept a Visitor and invoke the appropriate visit methods.static ImmunizationRecommendation.Recommendation.Builderbuilder()booleanequals(Object obj)List<CodeableConcept>getContraindicatedVaccineCode()Vaccine(s) which should not be used to fulfill the recommendation.List<ImmunizationRecommendation.Recommendation.DateCriterion>getDateCriterion()Vaccine date recommendations.StringgetDescription()Contains the description about the protocol under which the vaccine was administered.ElementgetDoseNumber()Nominal position of the recommended dose in a series (e.g.List<CodeableConcept>getForecastReason()The reason for the assigned forecast status.CodeableConceptgetForecastStatus()Indicates the patient status with respect to the path to immunity for the target disease.StringgetSeries()One possible path to achieve presumed immunity against a disease - within the context of an authority.ElementgetSeriesDoses()The recommended number of doses to achieve immunity.List<Reference>getSupportingImmunization()Immunization event history and/or evaluation that supports the status and recommendation.List<Reference>getSupportingPatientInformation()Patient Information that supports the status and recommendation.CodeableConceptgetTargetDisease()The targeted disease for the recommendation.List<CodeableConcept>getVaccineCode()Vaccine(s) or vaccine group that pertain to the recommendation.booleanhasChildren()inthashCode()ImmunizationRecommendation.Recommendation.BuildertoBuilder()Create a new Builder from the contents of this Element-
Methods inherited from class com.ibm.fhir.model.type.BackboneElement
getModifierExtension
-
-
-
-
Method Detail
-
getVaccineCode
public List<CodeableConcept> getVaccineCode()
Vaccine(s) or vaccine group that pertain to the recommendation.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConceptthat may be empty.
-
getTargetDisease
public CodeableConcept getTargetDisease()
The targeted disease for the recommendation.- Returns:
- An immutable object of type
CodeableConceptthat may be null.
-
getContraindicatedVaccineCode
public List<CodeableConcept> getContraindicatedVaccineCode()
Vaccine(s) which should not be used to fulfill the recommendation.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConceptthat may be empty.
-
getForecastStatus
public CodeableConcept getForecastStatus()
Indicates the patient status with respect to the path to immunity for the target disease.- Returns:
- An immutable object of type
CodeableConceptthat is non-null.
-
getForecastReason
public List<CodeableConcept> getForecastReason()
The reason for the assigned forecast status.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConceptthat may be empty.
-
getDateCriterion
public List<ImmunizationRecommendation.Recommendation.DateCriterion> getDateCriterion()
Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.- Returns:
- An unmodifiable list containing immutable objects of type
ImmunizationRecommendation.Recommendation.DateCriterionthat may be empty.
-
getDescription
public String getDescription()
Contains the description about the protocol under which the vaccine was administered.- Returns:
- An immutable object of type
Stringthat 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
Stringthat may be null.
-
getDoseNumber
public Element getDoseNumber()
Nominal position of the recommended dose in a series (e.g. dose 2 is the next recommended dose).- Returns:
- An immutable object of type
Elementthat may be null.
-
getSeriesDoses
public Element getSeriesDoses()
The recommended number of doses to achieve immunity.- Returns:
- An immutable object of type
Elementthat may be null.
-
getSupportingImmunization
public List<Reference> getSupportingImmunization()
Immunization event history and/or evaluation that supports the status and recommendation.- Returns:
- An unmodifiable list containing immutable objects of type
Referencethat may be empty.
-
getSupportingPatientInformation
public List<Reference> getSupportingPatientInformation()
Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.- Returns:
- An unmodifiable list containing immutable objects of type
Referencethat may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildrenin classBackboneElement
-
accept
public void accept(String elementName, int elementIndex, Visitor visitor)
Description copied from interface:VisitableAccept 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:
acceptin interfaceVisitable- Specified by:
acceptin 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
-
toBuilder
public ImmunizationRecommendation.Recommendation.Builder toBuilder()
Description copied from class:ElementCreate a new Builder from the contents of this Element- Specified by:
toBuilderin classBackboneElement
-
builder
public static ImmunizationRecommendation.Recommendation.Builder builder()
-
-