ImmunizationRecommendation.Recommendation (HAPI FHIR Structures

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.api.BaseIdentifiableElement
  - - ca.uhn.fhir.model.dstu2.resource.ImmunizationRecommendation.Recommendation

All Implemented Interfaces:

ICompositeElement, IElement, IIdentifiableElement, IResourceBlock, ISupportsUndeclaredExtensions, Serializable, IBase

Enclosing class:

ImmunizationRecommendation
```
public static class ImmunizationRecommendation.Recommendation
extends BaseIdentifiableElement
implements IResourceBlock
```
Block class for child element: ImmunizationRecommendation.recommendation ()
Definition: Vaccine administration recommendations

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Recommendation()

Constructors
Constructor and Description
`Recommendation()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ImmunizationRecommendation.RecommendationDateCriterion`	`addDateCriterion()` Adds and returns a new value for dateCriterion ()
`ImmunizationRecommendation.Recommendation`	`addDateCriterion(ImmunizationRecommendation.RecommendationDateCriterion theValue)` Adds a given new value for dateCriterion ()
`ResourceReferenceDt`	`addSupportingImmunization()` Adds and returns a new value for supportingImmunization ()
`ResourceReferenceDt`	`addSupportingPatientInformation()` Adds and returns a new value for supportingPatientInformation ()
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`Date`	`getDate()` Gets the value(s) for date ().
`List<ImmunizationRecommendation.RecommendationDateCriterion>`	`getDateCriterion()` Gets the value(s) for dateCriterion ().
`ImmunizationRecommendation.RecommendationDateCriterion`	`getDateCriterionFirstRep()` Gets the first repetition for dateCriterion (), creating it if it does not already exist.
`DateTimeDt`	`getDateElement()` Gets the value(s) for date ().
`Integer`	`getDoseNumber()` Gets the value(s) for doseNumber ().
`PositiveIntDt`	`getDoseNumberElement()` Gets the value(s) for doseNumber ().
`BoundCodeableConceptDt<ImmunizationRecommendationStatusCodesEnum>`	`getForecastStatus()` Gets the value(s) for forecastStatus ().
`ImmunizationRecommendation.RecommendationProtocol`	`getProtocol()` Gets the value(s) for protocol ().
`List<ResourceReferenceDt>`	`getSupportingImmunization()` Gets the value(s) for supportingImmunization ().
`List<ResourceReferenceDt>`	`getSupportingPatientInformation()` Gets the value(s) for supportingPatientInformation ().
`CodeableConceptDt`	`getVaccineCode()` Gets the value(s) for vaccineCode ().
`boolean`	`isEmpty()`
`ImmunizationRecommendation.Recommendation`	`setDate(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for date ()
`ImmunizationRecommendation.Recommendation`	`setDate(DateTimeDt theValue)` Sets the value(s) for date ()
`ImmunizationRecommendation.Recommendation`	`setDateCriterion(List<ImmunizationRecommendation.RecommendationDateCriterion> theValue)` Sets the value(s) for dateCriterion ()
`ImmunizationRecommendation.Recommendation`	`setDateWithSecondsPrecision(Date theDate)` Sets the value for date ()
`ImmunizationRecommendation.Recommendation`	`setDoseNumber(int theInteger)` Sets the value for doseNumber ()
`ImmunizationRecommendation.Recommendation`	`setDoseNumber(PositiveIntDt theValue)` Sets the value(s) for doseNumber ()
`ImmunizationRecommendation.Recommendation`	`setForecastStatus(BoundCodeableConceptDt<ImmunizationRecommendationStatusCodesEnum> theValue)` Sets the value(s) for forecastStatus ()
`ImmunizationRecommendation.Recommendation`	`setForecastStatus(ImmunizationRecommendationStatusCodesEnum theValue)` Sets the value(s) for forecastStatus ()
`ImmunizationRecommendation.Recommendation`	`setProtocol(ImmunizationRecommendation.RecommendationProtocol theValue)` Sets the value(s) for protocol ()
`ImmunizationRecommendation.Recommendation`	`setSupportingImmunization(List<ResourceReferenceDt> theValue)` Sets the value(s) for supportingImmunization ()
`ImmunizationRecommendation.Recommendation`	`setSupportingPatientInformation(List<ResourceReferenceDt> theValue)` Sets the value(s) for supportingPatientInformation ()
`ImmunizationRecommendation.Recommendation`	`setVaccineCode(CodeableConceptDt theValue)` Sets the value(s) for vaccineCode ()

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement
getElementSpecificId, getId, setElementSpecificId, setId, setId

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, isBaseEmpty

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IIdentifiableElement
getElementSpecificId, getId, setElementSpecificId, setId, setId

- Constructor Detail
  - Recommendation
```
public Recommendation()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
  - getDateElement
```
public DateTimeDt getDateElement()
```
    Gets the value(s) for date (). creating it if it does not exist. Will not return null.
    Definition: The date the immunization recommendation was created.
  - getDate
```
public Date getDate()
```
    Gets the value(s) for date (). creating it if it does not exist. Will not return null.
    Definition: The date the immunization recommendation was created.
  - setDate
```
public ImmunizationRecommendation.Recommendation setDate(DateTimeDt theValue)
```
    Sets the value(s) for date ()
    Definition: The date the immunization recommendation was created.
  - setDate
```
public ImmunizationRecommendation.Recommendation setDate(Date theDate,
                                                         TemporalPrecisionEnum thePrecision)
```
    Sets the value for date ()
    Definition: The date the immunization recommendation was created.
  - setDateWithSecondsPrecision
```
public ImmunizationRecommendation.Recommendation setDateWithSecondsPrecision(Date theDate)
```
    Sets the value for date ()
    Definition: The date the immunization recommendation was created.
  - getVaccineCode
```
public CodeableConceptDt getVaccineCode()
```
    Gets the value(s) for vaccineCode (). creating it if it does not exist. Will not return null.
    Definition: Vaccine that pertains to the recommendation
  - setVaccineCode
```
public ImmunizationRecommendation.Recommendation setVaccineCode(CodeableConceptDt theValue)
```
    Sets the value(s) for vaccineCode ()
    Definition: Vaccine that pertains to the recommendation
  - getDoseNumberElement
```
public PositiveIntDt getDoseNumberElement()
```
    Gets the value(s) for doseNumber (). creating it if it does not exist. Will not return null.
    Definition: This indicates the next recommended dose number (e.g. dose 2 is the next recommended dose).
  - getDoseNumber
```
public Integer getDoseNumber()
```
    Gets the value(s) for doseNumber (). creating it if it does not exist. Will not return null.
    Definition: This indicates the next recommended dose number (e.g. dose 2 is the next recommended dose).
  - setDoseNumber
```
public ImmunizationRecommendation.Recommendation setDoseNumber(PositiveIntDt theValue)
```
    Sets the value(s) for doseNumber ()
    Definition: This indicates the next recommended dose number (e.g. dose 2 is the next recommended dose).
  - setDoseNumber
```
public ImmunizationRecommendation.Recommendation setDoseNumber(int theInteger)
```
    Sets the value for doseNumber ()
    Definition: This indicates the next recommended dose number (e.g. dose 2 is the next recommended dose).
  - getForecastStatus
```
public BoundCodeableConceptDt<ImmunizationRecommendationStatusCodesEnum> getForecastStatus()
```
    Gets the value(s) for forecastStatus (). creating it if it does not exist. Will not return null.
    Definition: Vaccine administration status
  - setForecastStatus
```
public ImmunizationRecommendation.Recommendation setForecastStatus(BoundCodeableConceptDt<ImmunizationRecommendationStatusCodesEnum> theValue)
```
    Sets the value(s) for forecastStatus ()
    Definition: Vaccine administration status
  - setForecastStatus
```
public ImmunizationRecommendation.Recommendation setForecastStatus(ImmunizationRecommendationStatusCodesEnum theValue)
```
    Sets the value(s) for forecastStatus ()
    Definition: Vaccine administration status
  - getDateCriterion
```
public List<ImmunizationRecommendation.RecommendationDateCriterion> getDateCriterion()
```
    Gets the value(s) for dateCriterion (). creating it if it does not exist. Will not return null.
    Definition: Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.
  - setDateCriterion
```
public ImmunizationRecommendation.Recommendation setDateCriterion(List<ImmunizationRecommendation.RecommendationDateCriterion> theValue)
```
    Sets the value(s) for dateCriterion ()
    Definition: Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.
  - addDateCriterion
```
public ImmunizationRecommendation.RecommendationDateCriterion addDateCriterion()
```
    Adds and returns a new value for dateCriterion ()
    Definition: Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.
  - addDateCriterion
```
public ImmunizationRecommendation.Recommendation addDateCriterion(ImmunizationRecommendation.RecommendationDateCriterion theValue)
```
    Adds a given new value for dateCriterion ()
    Definition: Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.
    
    Parameters:
    
    theValue - The dateCriterion to add (must not be null)
  - getDateCriterionFirstRep
```
public ImmunizationRecommendation.RecommendationDateCriterion getDateCriterionFirstRep()
```
    Gets the first repetition for dateCriterion (), creating it if it does not already exist.
    Definition: Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.
  - getProtocol
```
public ImmunizationRecommendation.RecommendationProtocol getProtocol()
```
    Gets the value(s) for protocol (). creating it if it does not exist. Will not return null.
    Definition: Contains information about the protocol under which the vaccine was administered
  - setProtocol
```
public ImmunizationRecommendation.Recommendation setProtocol(ImmunizationRecommendation.RecommendationProtocol theValue)
```
    Sets the value(s) for protocol ()
    Definition: Contains information about the protocol under which the vaccine was administered
  - getSupportingImmunization
```
public List<ResourceReferenceDt> getSupportingImmunization()
```
    Gets the value(s) for supportingImmunization (). creating it if it does not exist. Will not return null.
    Definition: Immunization event history that supports the status and recommendation
  - setSupportingImmunization
```
public ImmunizationRecommendation.Recommendation setSupportingImmunization(List<ResourceReferenceDt> theValue)
```
    Sets the value(s) for supportingImmunization ()
    Definition: Immunization event history that supports the status and recommendation
  - addSupportingImmunization
```
public ResourceReferenceDt addSupportingImmunization()
```
    Adds and returns a new value for supportingImmunization ()
    Definition: Immunization event history that supports the status and recommendation
  - getSupportingPatientInformation
```
public List<ResourceReferenceDt> getSupportingPatientInformation()
```
    Gets the value(s) for supportingPatientInformation (). creating it if it does not exist. Will not return null.
    Definition: Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.
  - setSupportingPatientInformation
```
public ImmunizationRecommendation.Recommendation setSupportingPatientInformation(List<ResourceReferenceDt> theValue)
```
    Sets the value(s) for supportingPatientInformation ()
    Definition: Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.
  - addSupportingPatientInformation
```
public ResourceReferenceDt addSupportingPatientInformation()
```
    Adds and returns a new value for supportingPatientInformation ()
    Definition: Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.

Class ImmunizationRecommendation.Recommendation

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IIdentifiableElement

Constructor Detail

Recommendation

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getDateElement

getDate

setDate

setDate

setDateWithSecondsPrecision

getVaccineCode

setVaccineCode

getDoseNumberElement

getDoseNumber

setDoseNumber

setDoseNumber

getForecastStatus

setForecastStatus

setForecastStatus

getDateCriterion

setDateCriterion

addDateCriterion

addDateCriterion

getDateCriterionFirstRep

getProtocol

setProtocol

getSupportingImmunization

setSupportingImmunization

addSupportingImmunization

getSupportingPatientInformation

setSupportingPatientInformation

addSupportingPatientInformation