Package ca.uhn.fhir.model.dstu2.resource

Class Immunization.VaccinationProtocol

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:
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
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 Details

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.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 interface ca.uhn.fhir.model.api.ICompositeElement

    • getDoseSequenceElement

      public ca.uhn.fhir.model.primitive.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. This method may return null.

      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

      public Immunization.VaccinationProtocol setDoseSequence​(int theInteger)
      Sets the value for doseSequence ()

      Definition: Nominal position in a series

    • getDescriptionElement

      public ca.uhn.fhir.model.primitive.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. This method may return null.

      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

      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 ca.uhn.fhir.model.primitive.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. This method may return null.

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

    • setSeries

      public Immunization.VaccinationProtocol setSeries​(ca.uhn.fhir.model.primitive.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 ca.uhn.fhir.model.primitive.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. This method may return null.

      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

      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.