
Class Immunization.VaccinationProtocol
- All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeElement
,ca.uhn.fhir.model.api.IElement
,ca.uhn.fhir.model.api.IIdentifiableElement
,ca.uhn.fhir.model.api.IResourceBlock
,ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions
,Serializable
,org.hl7.fhir.instance.model.api.IBase
- Enclosing class:
- Immunization
public static class Immunization.VaccinationProtocol extends ca.uhn.fhir.model.api.BaseIdentifiableElement implements ca.uhn.fhir.model.api.IResourceBlock
Definition: Contains information about the protocol(s) under which the vaccine was administered
- See Also:
- Serialized Form
-
Constructor Summary
Constructors Constructor Description VaccinationProtocol()
-
Method Summary
Modifier and Type Method 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 ca.uhn.fhir.model.api.IElement>
List<T>getAllPopulatedChildElementsOfType(Class<T> theType)
ResourceReferenceDt
getAuthority()
Gets the value(s) for authority ().String
getDescription()
Gets the value(s) for description ().ca.uhn.fhir.model.primitive.StringDt
getDescriptionElement()
Gets the value(s) for description ().Integer
getDoseSequence()
Gets the value(s) for doseSequence ().ca.uhn.fhir.model.primitive.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 ().ca.uhn.fhir.model.primitive.PositiveIntDt
getSeriesDosesElement()
Gets the value(s) for seriesDoses ().ca.uhn.fhir.model.primitive.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(ca.uhn.fhir.model.primitive.StringDt theValue)
Sets the value(s) for description ()Immunization.VaccinationProtocol
setDescription(String theString)
Sets the value for description ()Immunization.VaccinationProtocol
setDoseSequence(int theInteger)
Sets the value for doseSequence ()Immunization.VaccinationProtocol
setDoseSequence(ca.uhn.fhir.model.primitive.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(ca.uhn.fhir.model.primitive.StringDt theValue)
Sets the value(s) for series ()Immunization.VaccinationProtocol
setSeries(String theString)
Sets the value for series ()Immunization.VaccinationProtocol
setSeriesDoses(int theInteger)
Sets the value for seriesDoses ()Immunization.VaccinationProtocol
setSeriesDoses(ca.uhn.fhir.model.primitive.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, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, getUserData, hasFormatComment, isBaseEmpty, setUserData
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
fhirType, getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
Methods inherited from interface ca.uhn.fhir.model.api.IIdentifiableElement
getElementSpecificId, getId, setElementSpecificId, setId, setId
-
Constructor Details
-
VaccinationProtocol
public VaccinationProtocol()
-
-
Method Details
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
-
getAllPopulatedChildElementsOfType
public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)- Specified by:
getAllPopulatedChildElementsOfType
in interfaceca.uhn.fhir.model.api.ICompositeElement
-
getDoseSequenceElement
Gets the value(s) for doseSequence (). creating it if it does not exist. Will not returnnull
.Definition: Nominal position in a series
-
getDoseSequence
Gets the value(s) for doseSequence (). creating it if it does not exist. This method may returnnull
.Definition: Nominal position in a series
-
setDoseSequence
public Immunization.VaccinationProtocol setDoseSequence(ca.uhn.fhir.model.primitive.PositiveIntDt theValue)Sets the value(s) for doseSequence ()Definition: Nominal position in a series
-
setDoseSequence
Sets the value for doseSequence ()Definition: Nominal position in a series
-
getDescriptionElement
Gets the value(s) for description (). creating it if it does not exist. Will not returnnull
.Definition: Contains the description about the protocol under which the vaccine was administered
-
getDescription
Gets the value(s) for description (). creating it if it does not exist. This method may returnnull
.Definition: Contains the description about the protocol under which the vaccine was administered
-
setDescription
public Immunization.VaccinationProtocol setDescription(ca.uhn.fhir.model.primitive.StringDt theValue)Sets the value(s) for description ()Definition: Contains the description about the protocol under which the vaccine was administered
-
setDescription
Sets the value for description ()Definition: Contains the description about the protocol under which the vaccine was administered
-
getAuthority
Gets the value(s) for authority (). creating it if it does not exist. Will not returnnull
.Definition: Indicates the authority who published the protocol. E.g. ACIP
-
setAuthority
Sets the value(s) for authority ()Definition: Indicates the authority who published the protocol. E.g. ACIP
-
getSeriesElement
Gets the value(s) for series (). creating it if it does not exist. Will not returnnull
.Definition: One possible path to achieve presumed immunity against a disease - within the context of an authority
-
getSeries
Gets the value(s) for series (). creating it if it does not exist. This method may returnnull
.Definition: One possible path to achieve presumed immunity against a disease - within the context of an authority
-
setSeries
Sets the value(s) for series ()Definition: One possible path to achieve presumed immunity against a disease - within the context of an authority
-
setSeries
Sets the value for series ()Definition: One possible path to achieve presumed immunity against a disease - within the context of an authority
-
getSeriesDosesElement
Gets the value(s) for seriesDoses (). creating it if it does not exist. Will not returnnull
.Definition: The recommended number of doses to achieve immunity.
-
getSeriesDoses
Gets the value(s) for seriesDoses (). creating it if it does not exist. This method may returnnull
.Definition: The recommended number of doses to achieve immunity.
-
setSeriesDoses
public Immunization.VaccinationProtocol setSeriesDoses(ca.uhn.fhir.model.primitive.PositiveIntDt theValue)Sets the value(s) for seriesDoses ()Definition: The recommended number of doses to achieve immunity.
-
setSeriesDoses
Sets the value for seriesDoses ()Definition: The recommended number of doses to achieve immunity.
-
getTargetDisease
Gets the value(s) for targetDisease (). creating it if it does not exist. Will not returnnull
.Definition: The targeted disease
-
setTargetDisease
Sets the value(s) for targetDisease ()Definition: The targeted disease
-
addTargetDisease
Adds and returns a new value for targetDisease ()Definition: The targeted disease
-
addTargetDisease
Adds a given new value for targetDisease ()Definition: The targeted disease
- Parameters:
theValue
- The targetDisease to add (must not benull
)
-
getTargetDiseaseFirstRep
Gets the first repetition for targetDisease (), creating it if it does not already exist.Definition: The targeted disease
-
getDoseStatus
Gets the value(s) for doseStatus (). creating it if it does not exist. Will not returnnull
.Definition: Indicates if the immunization event should \"count\" against the protocol.
-
setDoseStatus
Sets the value(s) for doseStatus ()Definition: Indicates if the immunization event should \"count\" against the protocol.
-
getDoseStatusReason
Gets the value(s) for doseStatusReason (). creating it if it does not exist. Will not returnnull
.Definition: Provides an explanation as to why an immunization event should or should not count against the protocol.
-
setDoseStatusReason
Sets the value(s) for doseStatusReason ()Definition: Provides an explanation as to why an immunization event should or should not count against the protocol.
-