ca.uhn.fhir.model.dstu.resource

Class Immunization.VaccinationProtocol

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

ca.uhn.fhir.model.dstu.resource.Immunization.VaccinationProtocol

All Implemented Interfaces:

ICompositeElement, IElement, IIdentifiableElement, IResourceBlock, ISupportsUndeclaredExtensions

Enclosing class:

Immunization

public static class Immunization.VaccinationProtocol
extends BaseIdentifiableElement
implements IResourceBlock

Block class for child element: Immunization.vaccinationProtocol (What protocol was followed)

Definition: Contains information about the protocol(s) under which the vaccine was administered

Constructor Summary

Constructors

Constructor and Description
Immunization.VaccinationProtocol()

Method Summary

Methods

Modifier and Type	Method and Description
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType) Returns a list containing all child elements matching a given type
ResourceReferenceDt	getAuthority() Gets the value(s) for authority (Who is responsible for protocol).
StringDt	getDescription() Gets the value(s) for description (Details of vaccine protocol).
IntegerDt	getDoseSequence() Gets the value(s) for doseSequence (What dose number within series?).
CodeableConceptDt	getDoseStatus() Gets the value(s) for doseStatus (Does dose count towards immunity?).
CodeableConceptDt	getDoseStatusReason() Gets the value(s) for doseStatusReason (Why does does count/not count?).
CodeableConceptDt	getDoseTarget() Gets the value(s) for doseTarget (Disease immunized against).
StringDt	getSeries() Gets the value(s) for series (Name of vaccine series).
IntegerDt	getSeriesDoses() Gets the value(s) for seriesDoses (Recommended number of doses for immunity).
boolean	isEmpty()
Immunization.VaccinationProtocol	setAuthority(ResourceReferenceDt theValue) Sets the value(s) for authority (Who is responsible for protocol)
Immunization.VaccinationProtocol	setDescription(String theString) Sets the value for description (Details of vaccine protocol)
Immunization.VaccinationProtocol	setDescription(StringDt theValue) Sets the value(s) for description (Details of vaccine protocol)
Immunization.VaccinationProtocol	setDoseSequence(int theInteger) Sets the value for doseSequence (What dose number within series?)
Immunization.VaccinationProtocol	setDoseSequence(IntegerDt theValue) Sets the value(s) for doseSequence (What dose number within series?)
Immunization.VaccinationProtocol	setDoseStatus(CodeableConceptDt theValue) Sets the value(s) for doseStatus (Does dose count towards immunity?)
Immunization.VaccinationProtocol	setDoseStatusReason(CodeableConceptDt theValue) Sets the value(s) for doseStatusReason (Why does does count/not count?)
Immunization.VaccinationProtocol	setDoseTarget(CodeableConceptDt theValue) Sets the value(s) for doseTarget (Disease immunized against)
Immunization.VaccinationProtocol	setSeries(String theString) Sets the value for series (Name of vaccine series)
Immunization.VaccinationProtocol	setSeries(StringDt theValue) Sets the value(s) for series (Name of vaccine series)
Immunization.VaccinationProtocol	setSeriesDoses(int theInteger) Sets the value for seriesDoses (Recommended number of doses for immunity)
Immunization.VaccinationProtocol	setSeriesDoses(IntegerDt theValue) Sets the value(s) for seriesDoses (Recommended number of doses for immunity)

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

Immunization.VaccinationProtocol

public Immunization.VaccinationProtocol()

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IElement

getAllPopulatedChildElementsOfType

public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Description copied from interface: ICompositeElement

Returns a list containing all child elements matching a given type

Specified by:

getAllPopulatedChildElementsOfType in interface ICompositeElement

Parameters:

theType - The type to match. If set to null, all child elements will be returned

getDoseSequence

public IntegerDt getDoseSequence()

Gets the value(s) for doseSequence (What dose number within series?). creating it if it does not exist. Will not return null.

Definition: Nominal position in a series

setDoseSequence

public Immunization.VaccinationProtocol setDoseSequence(IntegerDt theValue)

Sets the value(s) for doseSequence (What dose number within series?)

Definition: Nominal position in a series

setDoseSequence

public Immunization.VaccinationProtocol setDoseSequence(int theInteger)

Sets the value for doseSequence (What dose number within series?)

Definition: Nominal position in a series

getDescription

public StringDt getDescription()

Gets the value(s) for description (Details of vaccine protocol). 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 (Details of vaccine protocol)

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 (Details of vaccine protocol)

Definition: Contains the description about the protocol under which the vaccine was administered

getAuthority

public ResourceReferenceDt getAuthority()

Gets the value(s) for authority (Who is responsible for protocol). 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 (Who is responsible for protocol)

Definition: Indicates the authority who published the protocol? E.g. ACIP

getSeries

public StringDt getSeries()

Gets the value(s) for series (Name of vaccine 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 (Name of vaccine 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 (Name of vaccine series)

Definition: One possible path to achieve presumed immunity against a disease - within the context of an authority

getSeriesDoses

public IntegerDt getSeriesDoses()

Gets the value(s) for seriesDoses (Recommended number of doses for immunity). 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(IntegerDt theValue)

Sets the value(s) for seriesDoses (Recommended number of doses for immunity)

Definition: The recommended number of doses to achieve immunity.

setSeriesDoses

public Immunization.VaccinationProtocol setSeriesDoses(int theInteger)

Sets the value for seriesDoses (Recommended number of doses for immunity)

Definition: The recommended number of doses to achieve immunity.

getDoseTarget

public CodeableConceptDt getDoseTarget()

Gets the value(s) for doseTarget (Disease immunized against). creating it if it does not exist. Will not return null.

Definition: The targeted disease

setDoseTarget

public Immunization.VaccinationProtocol setDoseTarget(CodeableConceptDt theValue)

Sets the value(s) for doseTarget (Disease immunized against)

Definition: The targeted disease

getDoseStatus

public CodeableConceptDt getDoseStatus()

Gets the value(s) for doseStatus (Does dose count towards immunity?). 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 (Does dose count towards immunity?)

Definition: Indicates if the immunization event should \"count\" against the protocol.

getDoseStatusReason

public CodeableConceptDt getDoseStatusReason()

Gets the value(s) for doseStatusReason (Why does does count/not count?). creating it if it does not exist. Will not return null.

Definition: Provides an explanation as to why a immunization event should or should not count against the protocol.

setDoseStatusReason

public Immunization.VaccinationProtocol setDoseStatusReason(CodeableConceptDt theValue)

Sets the value(s) for doseStatusReason (Why does does count/not count?)

Definition: Provides an explanation as to why a immunization event should or should not count against the protocol.