Package org.hl7.fhir.dstu3.model

Class Immunization.ImmunizationVaccinationProtocolComponent

java.lang.Object

org.hl7.fhir.dstu3.model.Base

org.hl7.fhir.dstu3.model.Element

org.hl7.fhir.dstu3.model.BackboneElement

org.hl7.fhir.dstu3.model.Immunization.ImmunizationVaccinationProtocolComponent

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Enclosing class:

Immunization

public static class Immunization.ImmunizationVaccinationProtocolComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Reference	authority	Indicates the authority who published the protocol.
protected Organization	authorityTarget	The actual object that is the target of the reference (Indicates the authority who published the protocol.
protected StringType	description	Contains the description about the protocol under which the vaccine was administered.
protected PositiveIntType	doseSequence	Nominal position in a series.
protected CodeableConcept	doseStatus	Indicates if the immunization event should "count" against the protocol.
protected CodeableConcept	doseStatusReason	Provides an explanation as to why an immunization event should or should not count against the protocol.
protected StringType	series	One possible path to achieve presumed immunity against a disease - within the context of an authority.
protected PositiveIntType	seriesDoses	The recommended number of doses to achieve immunity.
protected List<CodeableConcept>	targetDisease	The targeted disease.

Fields inherited from class org.hl7.fhir.dstu3.model.BackboneElement

modifierExtension

Fields inherited from class org.hl7.fhir.dstu3.model.Element

extension, id

Constructor Summary

Constructors

Constructor	Description
ImmunizationVaccinationProtocolComponent()	Constructor
ImmunizationVaccinationProtocolComponent(CodeableConcept doseStatus)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
CodeableConcept	addTargetDisease()
Immunization.ImmunizationVaccinationProtocolComponent	addTargetDisease(CodeableConcept t)
Immunization.ImmunizationVaccinationProtocolComponent	copy()
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
Reference	getAuthority()
Organization	getAuthorityTarget()
String	getDescription()
StringType	getDescriptionElement()
int	getDoseSequence()
PositiveIntType	getDoseSequenceElement()
CodeableConcept	getDoseStatus()
CodeableConcept	getDoseStatusReason()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
String	getSeries()
int	getSeriesDoses()
PositiveIntType	getSeriesDosesElement()
StringType	getSeriesElement()
List<CodeableConcept>	getTargetDisease()
CodeableConcept	getTargetDiseaseFirstRep()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAuthority()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasDoseSequence()
boolean	hasDoseSequenceElement()
boolean	hasDoseStatus()
boolean	hasDoseStatusReason()
boolean	hasSeries()
boolean	hasSeriesDoses()
boolean	hasSeriesDosesElement()
boolean	hasSeriesElement()
boolean	hasTargetDisease()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
Immunization.ImmunizationVaccinationProtocolComponent	setAuthority(Reference value)
Immunization.ImmunizationVaccinationProtocolComponent	setAuthorityTarget(Organization value)
Immunization.ImmunizationVaccinationProtocolComponent	setDescription(String value)
Immunization.ImmunizationVaccinationProtocolComponent	setDescriptionElement(StringType value)
Immunization.ImmunizationVaccinationProtocolComponent	setDoseSequence(int value)
Immunization.ImmunizationVaccinationProtocolComponent	setDoseSequenceElement(PositiveIntType value)
Immunization.ImmunizationVaccinationProtocolComponent	setDoseStatus(CodeableConcept value)
Immunization.ImmunizationVaccinationProtocolComponent	setDoseStatusReason(CodeableConcept value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Immunization.ImmunizationVaccinationProtocolComponent	setSeries(String value)
Immunization.ImmunizationVaccinationProtocolComponent	setSeriesDoses(int value)
Immunization.ImmunizationVaccinationProtocolComponent	setSeriesDosesElement(PositiveIntType value)
Immunization.ImmunizationVaccinationProtocolComponent	setSeriesElement(StringType value)
Immunization.ImmunizationVaccinationProtocolComponent	setTargetDisease(List<CodeableConcept> theTargetDisease)

Methods inherited from class org.hl7.fhir.dstu3.model.BackboneElement

addModifierExtension, addModifierExtension, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtension

Methods inherited from class org.hl7.fhir.dstu3.model.Element

addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setExtension, setId, setIdBase, setIdElement

Methods inherited from class org.hl7.fhir.dstu3.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

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

getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement

getUserData, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions

addExtension, getExtension, hasExtension

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

addModifierExtension, getModifierExtension, hasModifierExtension

Field Details

doseSequence

protected PositiveIntType doseSequence

Nominal position in a series.

description

protected StringType description

Contains the description about the protocol under which the vaccine was administered.

authority

protected Reference authority

Indicates the authority who published the protocol. E.g. ACIP.

authorityTarget

protected Organization authorityTarget

The actual object that is the target of the reference (Indicates the authority who published the protocol. E.g. ACIP.)

series

protected StringType series

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

seriesDoses

protected PositiveIntType seriesDoses

The recommended number of doses to achieve immunity.

targetDisease

protected List<CodeableConcept> targetDisease

The targeted disease.

doseStatus

protected CodeableConcept doseStatus

Indicates if the immunization event should "count" against the protocol.

doseStatusReason

protected CodeableConcept doseStatusReason

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

Constructor Details

ImmunizationVaccinationProtocolComponent

public ImmunizationVaccinationProtocolComponent()

Constructor

ImmunizationVaccinationProtocolComponent

public ImmunizationVaccinationProtocolComponent(CodeableConcept doseStatus)

Constructor

Method Details

getDoseSequenceElement

public PositiveIntType getDoseSequenceElement()

Returns:

doseSequence (Nominal position in a series.). This is the underlying object with id, value and extensions. The accessor "getDoseSequence" gives direct access to the value

hasDoseSequenceElement

public boolean hasDoseSequenceElement()

hasDoseSequence

public boolean hasDoseSequence()

setDoseSequenceElement

public Immunization.ImmunizationVaccinationProtocolComponent setDoseSequenceElement(PositiveIntType value)

Parameters:

value - doseSequence (Nominal position in a series.). This is the underlying object with id, value and extensions. The accessor "getDoseSequence" gives direct access to the value

getDoseSequence

public int getDoseSequence()

Returns:

Nominal position in a series.

setDoseSequence

public Immunization.ImmunizationVaccinationProtocolComponent setDoseSequence(int value)

Parameters:

value - Nominal position in a series.

getDescriptionElement

public StringType getDescriptionElement()

Returns:

description (Contains the description about the protocol under which the vaccine was administered.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

hasDescriptionElement

public boolean hasDescriptionElement()

hasDescription

public boolean hasDescription()

setDescriptionElement

public Immunization.ImmunizationVaccinationProtocolComponent setDescriptionElement(StringType value)

Parameters:

value - description (Contains the description about the protocol under which the vaccine was administered.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

getDescription

public String getDescription()

Returns:

Contains the description about the protocol under which the vaccine was administered.

setDescription

public Immunization.ImmunizationVaccinationProtocolComponent setDescription(String value)

Parameters:

value - Contains the description about the protocol under which the vaccine was administered.

getAuthority

public Reference getAuthority()

Returns:

authority (Indicates the authority who published the protocol. E.g. ACIP.)

hasAuthority

public boolean hasAuthority()

setAuthority

public Immunization.ImmunizationVaccinationProtocolComponent setAuthority(Reference value)

Parameters:

value - authority (Indicates the authority who published the protocol. E.g. ACIP.)

getAuthorityTarget

public Organization getAuthorityTarget()

Returns:

authority The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Indicates the authority who published the protocol. E.g. ACIP.)

setAuthorityTarget

public Immunization.ImmunizationVaccinationProtocolComponent setAuthorityTarget(Organization value)

Parameters:

value - authority The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Indicates the authority who published the protocol. E.g. ACIP.)

getSeriesElement

public StringType getSeriesElement()

Returns:

series (One possible path to achieve presumed immunity against a disease - within the context of an authority.). This is the underlying object with id, value and extensions. The accessor "getSeries" gives direct access to the value

hasSeriesElement

public boolean hasSeriesElement()

hasSeries

public boolean hasSeries()

setSeriesElement

public Immunization.ImmunizationVaccinationProtocolComponent setSeriesElement(StringType value)

Parameters:

value - series (One possible path to achieve presumed immunity against a disease - within the context of an authority.). This is the underlying object with id, value and extensions. The accessor "getSeries" gives direct access to the value

getSeries

public String getSeries()

Returns:

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

setSeries

public Immunization.ImmunizationVaccinationProtocolComponent setSeries(String value)

Parameters:

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

getSeriesDosesElement

public PositiveIntType getSeriesDosesElement()

Returns:

seriesDoses (The recommended number of doses to achieve immunity.). This is the underlying object with id, value and extensions. The accessor "getSeriesDoses" gives direct access to the value

hasSeriesDosesElement

public boolean hasSeriesDosesElement()

hasSeriesDoses

public boolean hasSeriesDoses()

setSeriesDosesElement

public Immunization.ImmunizationVaccinationProtocolComponent setSeriesDosesElement(PositiveIntType value)

Parameters:

value - seriesDoses (The recommended number of doses to achieve immunity.). This is the underlying object with id, value and extensions. The accessor "getSeriesDoses" gives direct access to the value

getSeriesDoses

public int getSeriesDoses()

Returns:

The recommended number of doses to achieve immunity.

setSeriesDoses

public Immunization.ImmunizationVaccinationProtocolComponent setSeriesDoses(int value)

Parameters:

value - The recommended number of doses to achieve immunity.

getTargetDisease

public List<CodeableConcept> getTargetDisease()

Returns:

targetDisease (The targeted disease.)

setTargetDisease

public Immunization.ImmunizationVaccinationProtocolComponent setTargetDisease(List<CodeableConcept> theTargetDisease)

Returns:

Returns a reference to this for easy method chaining

hasTargetDisease

public boolean hasTargetDisease()

addTargetDisease

public CodeableConcept addTargetDisease()

addTargetDisease

public Immunization.ImmunizationVaccinationProtocolComponent addTargetDisease(CodeableConcept t)

getTargetDiseaseFirstRep

public CodeableConcept getTargetDiseaseFirstRep()

Returns:

The first repetition of repeating field targetDisease, creating it if it does not already exist

getDoseStatus

public CodeableConcept getDoseStatus()

Returns:

doseStatus (Indicates if the immunization event should "count" against the protocol.)

hasDoseStatus

public boolean hasDoseStatus()

setDoseStatus

public Immunization.ImmunizationVaccinationProtocolComponent setDoseStatus(CodeableConcept value)

Parameters:

value - doseStatus (Indicates if the immunization event should "count" against the protocol.)

getDoseStatusReason

public CodeableConcept getDoseStatusReason()

Returns:

doseStatusReason (Provides an explanation as to why an immunization event should or should not count against the protocol.)

hasDoseStatusReason

public boolean hasDoseStatusReason()

setDoseStatusReason

public Immunization.ImmunizationVaccinationProtocolComponent setDoseStatusReason(CodeableConcept value)

Parameters:

value - doseStatusReason (Provides an explanation as to why an immunization event should or should not count against the protocol.)

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class BackboneElement

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

copy

public Immunization.ImmunizationVaccinationProtocolComponent copy()

Specified by:

copy in class BackboneElement

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class BackboneElement

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class BackboneElement

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class BackboneElement

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class BackboneElement