Immunization.VaccinationProtocol (HAPI FHIR Structures

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.api.BaseIdentifiableElement
  - - ca.uhn.fhir.model.dstu2.resource.Immunization.VaccinationProtocol

All Implemented Interfaces:

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

Enclosing class:

Immunization
```
public static class Immunization.VaccinationProtocol
extends BaseIdentifiableElement
implements IResourceBlock
```
Block class for child element: Immunization.vaccinationProtocol ()
Definition: Contains information about the protocol(s) under which the vaccine was administered

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

VaccinationProtocol()

Constructors
Constructor and Description
`VaccinationProtocol()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CodeableConceptDt`	`addTargetDisease()` Adds and returns a new value for targetDisease ()
`Immunization.VaccinationProtocol`	`addTargetDisease(CodeableConceptDt theValue)` Adds a given new value for targetDisease ()
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`ResourceReferenceDt`	`getAuthority()` Gets the value(s) for authority ().
`String`	`getDescription()` Gets the value(s) for description ().
`StringDt`	`getDescriptionElement()` Gets the value(s) for description ().
`Integer`	`getDoseSequence()` Gets the value(s) for doseSequence ().
`PositiveIntDt`	`getDoseSequenceElement()` Gets the value(s) for doseSequence ().
`CodeableConceptDt`	`getDoseStatus()` Gets the value(s) for doseStatus ().
`CodeableConceptDt`	`getDoseStatusReason()` Gets the value(s) for doseStatusReason ().
`String`	`getSeries()` Gets the value(s) for series ().
`Integer`	`getSeriesDoses()` Gets the value(s) for seriesDoses ().
`PositiveIntDt`	`getSeriesDosesElement()` Gets the value(s) for seriesDoses ().
`StringDt`	`getSeriesElement()` Gets the value(s) for series ().
`List<CodeableConceptDt>`	`getTargetDisease()` Gets the value(s) for targetDisease ().
`CodeableConceptDt`	`getTargetDiseaseFirstRep()` Gets the first repetition for targetDisease (), creating it if it does not already exist.
`boolean`	`isEmpty()`
`Immunization.VaccinationProtocol`	`setAuthority(ResourceReferenceDt theValue)` Sets the value(s) for authority ()
`Immunization.VaccinationProtocol`	`setDescription(String theString)` Sets the value for description ()
`Immunization.VaccinationProtocol`	`setDescription(StringDt theValue)` Sets the value(s) for description ()
`Immunization.VaccinationProtocol`	`setDoseSequence(int theInteger)` Sets the value for doseSequence ()
`Immunization.VaccinationProtocol`	`setDoseSequence(PositiveIntDt theValue)` Sets the value(s) for doseSequence ()
`Immunization.VaccinationProtocol`	`setDoseStatus(CodeableConceptDt theValue)` Sets the value(s) for doseStatus ()
`Immunization.VaccinationProtocol`	`setDoseStatusReason(CodeableConceptDt theValue)` Sets the value(s) for doseStatusReason ()
`Immunization.VaccinationProtocol`	`setSeries(String theString)` Sets the value for series ()
`Immunization.VaccinationProtocol`	`setSeries(StringDt theValue)` Sets the value(s) for series ()
`Immunization.VaccinationProtocol`	`setSeriesDoses(int theInteger)` Sets the value for seriesDoses ()
`Immunization.VaccinationProtocol`	`setSeriesDoses(PositiveIntDt theValue)` Sets the value(s) for seriesDoses ()
`Immunization.VaccinationProtocol`	`setTargetDisease(List<CodeableConceptDt> theValue)` Sets the value(s) for targetDisease ()

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
  - VaccinationProtocol
```
public VaccinationProtocol()
```
- 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
  - getDoseSequenceElement
```
public PositiveIntDt getDoseSequenceElement()
```
    Gets the value(s) for doseSequence (). creating it if it does not exist. Will not return null.
    Definition: Nominal position in a series
  - getDoseSequence
```
public Integer getDoseSequence()
```
    Gets the value(s) for doseSequence (). creating it if it does not exist. Will not return null.
    Definition: Nominal position in a series
  - setDoseSequence
```
public Immunization.VaccinationProtocol setDoseSequence(PositiveIntDt theValue)
```
    Sets the value(s) for doseSequence ()
    Definition: Nominal position in a series
  - setDoseSequence
```
public Immunization.VaccinationProtocol setDoseSequence(int theInteger)
```
    Sets the value for doseSequence ()
    Definition: Nominal position in a series
  - getDescriptionElement
```
public StringDt getDescriptionElement()
```
    Gets the value(s) for description (). creating it if it does not exist. Will not return null.
    Definition: Contains the description about the protocol under which the vaccine was administered
  - getDescription
```
public String getDescription()
```
    Gets the value(s) for description (). creating it if it does not exist. Will not return null.
    Definition: Contains the description about the protocol under which the vaccine was administered
  - setDescription
```
public Immunization.VaccinationProtocol setDescription(StringDt theValue)
```
    Sets the value(s) for description ()
    Definition: Contains the description about the protocol under which the vaccine was administered
  - setDescription
```
public Immunization.VaccinationProtocol setDescription(String theString)
```
    Sets the value for description ()
    Definition: Contains the description about the protocol under which the vaccine was administered
  - getAuthority
```
public ResourceReferenceDt getAuthority()
```
    Gets the value(s) for authority (). creating it if it does not exist. Will not return null.
    Definition: Indicates the authority who published the protocol. E.g. ACIP
  - setAuthority
```
public Immunization.VaccinationProtocol setAuthority(ResourceReferenceDt theValue)
```
    Sets the value(s) for authority ()
    Definition: Indicates the authority who published the protocol. E.g. ACIP
  - getSeriesElement
```
public StringDt getSeriesElement()
```
    Gets the value(s) for series (). creating it if it does not exist. Will not return null.
    Definition: One possible path to achieve presumed immunity against a disease - within the context of an authority
  - getSeries
```
public String getSeries()
```
    Gets the value(s) for series (). creating it if it does not exist. Will not return null.
    Definition: One possible path to achieve presumed immunity against a disease - within the context of an authority
  - setSeries
```
public Immunization.VaccinationProtocol setSeries(StringDt theValue)
```
    Sets the value(s) for series ()
    Definition: One possible path to achieve presumed immunity against a disease - within the context of an authority
  - setSeries
```
public Immunization.VaccinationProtocol setSeries(String theString)
```
    Sets the value for series ()
    Definition: One possible path to achieve presumed immunity against a disease - within the context of an authority
  - getSeriesDosesElement
```
public PositiveIntDt getSeriesDosesElement()
```
    Gets the value(s) for seriesDoses (). creating it if it does not exist. Will not return null.
    Definition: The recommended number of doses to achieve immunity.
  - getSeriesDoses
```
public Integer getSeriesDoses()
```
    Gets the value(s) for seriesDoses (). creating it if it does not exist. Will not return null.
    Definition: The recommended number of doses to achieve immunity.
  - setSeriesDoses
```
public Immunization.VaccinationProtocol setSeriesDoses(PositiveIntDt theValue)
```
    Sets the value(s) for seriesDoses ()
    Definition: The recommended number of doses to achieve immunity.
  - setSeriesDoses
```
public Immunization.VaccinationProtocol setSeriesDoses(int theInteger)
```
    Sets the value for seriesDoses ()
    Definition: The recommended number of doses to achieve immunity.
  - getTargetDisease
```
public List<CodeableConceptDt> getTargetDisease()
```
    Gets the value(s) for targetDisease (). creating it if it does not exist. Will not return null.
    Definition: The targeted disease
  - setTargetDisease
```
public Immunization.VaccinationProtocol setTargetDisease(List<CodeableConceptDt> theValue)
```
    Sets the value(s) for targetDisease ()
    Definition: The targeted disease
  - addTargetDisease
```
public CodeableConceptDt addTargetDisease()
```
    Adds and returns a new value for targetDisease ()
    Definition: The targeted disease
  - addTargetDisease
```
public Immunization.VaccinationProtocol addTargetDisease(CodeableConceptDt theValue)
```
    Adds a given new value for targetDisease ()
    Definition: The targeted disease
    
    Parameters:
    
    theValue - The targetDisease to add (must not be null)
  - getTargetDiseaseFirstRep
```
public CodeableConceptDt getTargetDiseaseFirstRep()
```
    Gets the first repetition for targetDisease (), creating it if it does not already exist.
    Definition: The targeted disease
  - getDoseStatus
```
public CodeableConceptDt getDoseStatus()
```
    Gets the value(s) for doseStatus (). creating it if it does not exist. Will not return null.
    Definition: Indicates if the immunization event should \"count\" against the protocol.
  - setDoseStatus
```
public Immunization.VaccinationProtocol setDoseStatus(CodeableConceptDt theValue)
```
    Sets the value(s) for doseStatus ()
    Definition: Indicates if the immunization event should \"count\" against the protocol.
  - getDoseStatusReason
```
public CodeableConceptDt getDoseStatusReason()
```
    Gets the value(s) for doseStatusReason (). creating it if it does not exist. Will not return null.
    Definition: Provides an explanation as to why an immunization event should or should not count against the protocol.
  - setDoseStatusReason
```
public Immunization.VaccinationProtocol setDoseStatusReason(CodeableConceptDt theValue)
```
    Sets the value(s) for doseStatusReason ()
    Definition: Provides an explanation as to why an immunization event should or should not count against the protocol.

Class Immunization.VaccinationProtocol

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

VaccinationProtocol

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getDoseSequenceElement

getDoseSequence

setDoseSequence

setDoseSequence

getDescriptionElement

getDescription

setDescription

setDescription

getAuthority

setAuthority

getSeriesElement

getSeries

setSeries

setSeries

getSeriesDosesElement

getSeriesDoses

setSeriesDoses

setSeriesDoses

getTargetDisease

setTargetDisease

addTargetDisease

addTargetDisease

getTargetDiseaseFirstRep

getDoseStatus

setDoseStatus

getDoseStatusReason

setDoseStatusReason