Package org.hl7.fhir.r4.model

Class Immunization.ImmunizationProtocolAppliedComponent

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.Element

org.hl7.fhir.r4.model.BackboneElement

org.hl7.fhir.r4.model.Immunization.ImmunizationProtocolAppliedComponent

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.ImmunizationProtocolAppliedComponent
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 (e.g.
protected Organization	authorityTarget	The actual object that is the target of the reference (Indicates the authority who published the protocol (e.g.
protected Type	doseNumber	Nominal position in a series.
protected StringType	series	One possible path to achieve presumed immunity against a disease - within the context of an authority.
protected Type	seriesDoses	The recommended number of doses to achieve immunity.
protected List<CodeableConcept>	targetDisease	The vaccine preventable disease the dose is being administered against.

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

modifierExtension

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

extension, id

Constructor Summary

Constructors

Constructor	Description
ImmunizationProtocolAppliedComponent()	Constructor
ImmunizationProtocolAppliedComponent(Type doseNumber)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
CodeableConcept	addTargetDisease()
Immunization.ImmunizationProtocolAppliedComponent	addTargetDisease(CodeableConcept t)
Immunization.ImmunizationProtocolAppliedComponent	copy()
void	copyValues(Immunization.ImmunizationProtocolAppliedComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
Reference	getAuthority()
Organization	getAuthorityTarget()
Type	getDoseNumber()
PositiveIntType	getDoseNumberPositiveIntType()
StringType	getDoseNumberStringType()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
String	getSeries()
Type	getSeriesDoses()
PositiveIntType	getSeriesDosesPositiveIntType()
StringType	getSeriesDosesStringType()
StringType	getSeriesElement()
List<CodeableConcept>	getTargetDisease()
CodeableConcept	getTargetDiseaseFirstRep()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAuthority()
boolean	hasDoseNumber()
boolean	hasDoseNumberPositiveIntType()
boolean	hasDoseNumberStringType()
boolean	hasSeries()
boolean	hasSeriesDoses()
boolean	hasSeriesDosesPositiveIntType()
boolean	hasSeriesDosesStringType()
boolean	hasSeriesElement()
boolean	hasTargetDisease()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
Immunization.ImmunizationProtocolAppliedComponent	setAuthority(Reference value)
Immunization.ImmunizationProtocolAppliedComponent	setAuthorityTarget(Organization value)
Immunization.ImmunizationProtocolAppliedComponent	setDoseNumber(Type value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Immunization.ImmunizationProtocolAppliedComponent	setSeries(String value)
Immunization.ImmunizationProtocolAppliedComponent	setSeriesDoses(Type value)
Immunization.ImmunizationProtocolAppliedComponent	setSeriesElement(StringType value)
Immunization.ImmunizationProtocolAppliedComponent	setTargetDisease(List<CodeableConcept> theTargetDisease)

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

addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyExtensions, copyNewExtensions, copyValues, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, removeExtension, setModifierExtension

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

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionFirstRep, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement

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

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

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

series

protected StringType series

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

authority

protected Reference authority

Indicates the authority who published the protocol (e.g. ACIP) that is being followed.

authorityTarget

protected Organization authorityTarget

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

targetDisease

protected List<CodeableConcept> targetDisease

The vaccine preventable disease the dose is being administered against.

doseNumber

protected Type doseNumber

Nominal position in a series.

seriesDoses

protected Type seriesDoses

The recommended number of doses to achieve immunity.

Constructor Details

ImmunizationProtocolAppliedComponent

public ImmunizationProtocolAppliedComponent()

Constructor

ImmunizationProtocolAppliedComponent

public ImmunizationProtocolAppliedComponent(Type doseNumber)

Constructor

Method Details

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.ImmunizationProtocolAppliedComponent 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.ImmunizationProtocolAppliedComponent setSeries(String value)

Parameters:

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

getAuthority

public Reference getAuthority()

Returns:

authority (Indicates the authority who published the protocol (e.g. ACIP) that is being followed.)

hasAuthority

public boolean hasAuthority()

setAuthority

public Immunization.ImmunizationProtocolAppliedComponent setAuthority(Reference value)

Parameters:

value - authority (Indicates the authority who published the protocol (e.g. ACIP) that is being followed.)

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) that is being followed.)

setAuthorityTarget

public Immunization.ImmunizationProtocolAppliedComponent 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) that is being followed.)

getTargetDisease

public List<CodeableConcept> getTargetDisease()

Returns:

targetDisease (The vaccine preventable disease the dose is being administered against.)

setTargetDisease

public Immunization.ImmunizationProtocolAppliedComponent 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.ImmunizationProtocolAppliedComponent addTargetDisease(CodeableConcept t)

getTargetDiseaseFirstRep

public CodeableConcept getTargetDiseaseFirstRep()

Returns:

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

getDoseNumber

public Type getDoseNumber()

Returns:

doseNumber (Nominal position in a series.)

getDoseNumberPositiveIntType

public PositiveIntType getDoseNumberPositiveIntType()
                                             throws org.hl7.fhir.exceptions.FHIRException

Returns:

doseNumber (Nominal position in a series.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasDoseNumberPositiveIntType

public boolean hasDoseNumberPositiveIntType()

getDoseNumberStringType

public StringType getDoseNumberStringType()
                                   throws org.hl7.fhir.exceptions.FHIRException

Returns:

doseNumber (Nominal position in a series.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasDoseNumberStringType

public boolean hasDoseNumberStringType()

hasDoseNumber

public boolean hasDoseNumber()

setDoseNumber

public Immunization.ImmunizationProtocolAppliedComponent setDoseNumber(Type value)

Parameters:

value - doseNumber (Nominal position in a series.)

getSeriesDoses

public Type getSeriesDoses()

Returns:

seriesDoses (The recommended number of doses to achieve immunity.)

getSeriesDosesPositiveIntType

public PositiveIntType getSeriesDosesPositiveIntType()
                                              throws org.hl7.fhir.exceptions.FHIRException

Returns:

seriesDoses (The recommended number of doses to achieve immunity.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasSeriesDosesPositiveIntType

public boolean hasSeriesDosesPositiveIntType()

getSeriesDosesStringType

public StringType getSeriesDosesStringType()
                                    throws org.hl7.fhir.exceptions.FHIRException

Returns:

seriesDoses (The recommended number of doses to achieve immunity.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasSeriesDosesStringType

public boolean hasSeriesDosesStringType()

hasSeriesDoses

public boolean hasSeriesDoses()

setSeriesDoses

public Immunization.ImmunizationProtocolAppliedComponent setSeriesDoses(Type value)

Parameters:

value - seriesDoses (The recommended number of doses to achieve immunity.)

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

removeChild

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

Overrides:

removeChild 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.ImmunizationProtocolAppliedComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(Immunization.ImmunizationProtocolAppliedComponent dst)

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