Class Immunization
- java.lang.Object
-
- org.hl7.fhir.dstu3.model.Base
-
- org.hl7.fhir.dstu3.model.BaseResource
-
- org.hl7.fhir.dstu3.model.Resource
-
- org.hl7.fhir.dstu3.model.DomainResource
-
- org.hl7.fhir.dstu3.model.Immunization
-
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement,Serializable,org.hl7.fhir.instance.model.api.IAnyResource,org.hl7.fhir.instance.model.api.IBase,org.hl7.fhir.instance.model.api.IBaseHasExtensions,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions,org.hl7.fhir.instance.model.api.IBaseResource,org.hl7.fhir.instance.model.api.IDomainResource
public class Immunization extends DomainResource
Describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classImmunization.ImmunizationExplanationComponentstatic classImmunization.ImmunizationPractitionerComponentstatic classImmunization.ImmunizationReactionComponentstatic classImmunization.ImmunizationStatusstatic classImmunization.ImmunizationStatusEnumFactorystatic classImmunization.ImmunizationVaccinationProtocolComponent
-
Field Summary
Fields Modifier and Type Field Description protected DateTimeTypedateDate vaccine administered or was to be administered.static ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for datestatic ca.uhn.fhir.rest.gclient.NumberClientParamDOSE_SEQUENCEFluent Client search parameter constant for dose-sequenceprotected SimpleQuantitydoseQuantityThe quantity of vaccine product that was administered.protected ReferenceencounterThe visit or admission or other contact between patient and health care provider the immunization was performed as part of.protected EncounterencounterTargetThe actual object that is the target of the reference (The visit or admission or other contact between patient and health care provider the immunization was performed as part of.)protected DateTypeexpirationDateDate vaccine batch expires.protected Immunization.ImmunizationExplanationComponentexplanationReasons why a vaccine was or was not administered.protected List<Identifier>identifierA unique identifier assigned to this immunization record.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_LOCATIONConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_MANUFACTURERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PATIENTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PRACTITIONERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_REACTIONConstant for fluent queries to be used to add include statements.protected ReferencelocationThe service delivery location where the vaccine administration occurred.static ca.uhn.fhir.rest.gclient.ReferenceClientParamLOCATIONFluent Client search parameter constant for locationprotected LocationlocationTargetThe actual object that is the target of the reference (The service delivery location where the vaccine administration occurred.)static ca.uhn.fhir.rest.gclient.StringClientParamLOT_NUMBERFluent Client search parameter constant for lot-numberprotected StringTypelotNumberLot number of the vaccine product.protected ReferencemanufacturerName of vaccine manufacturer.static ca.uhn.fhir.rest.gclient.ReferenceClientParamMANUFACTURERFluent Client search parameter constant for manufacturerprotected OrganizationmanufacturerTargetThe actual object that is the target of the reference (Name of vaccine manufacturer.)protected List<Annotation>noteExtra information about the immunization that is not conveyed by the other attributes.protected BooleanTypenotGivenIndicates if the vaccination was or was not given.static ca.uhn.fhir.rest.gclient.TokenClientParamNOTGIVENFluent Client search parameter constant for notgivenprotected ReferencepatientThe patient who either received or did not receive the immunization.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPATIENTFluent Client search parameter constant for patientprotected PatientpatientTargetThe actual object that is the target of the reference (The patient who either received or did not receive the immunization.)protected List<Immunization.ImmunizationPractitionerComponent>practitionerIndicates who or what performed the event.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPRACTITIONERFluent Client search parameter constant for practitionerprotected BooleanTypeprimarySourceAn indication that the content of the record is based on information from the person who administered the vaccine.protected List<Immunization.ImmunizationReactionComponent>reactionCategorical data indicating that an adverse event is associated in time to an immunization.static ca.uhn.fhir.rest.gclient.ReferenceClientParamREACTIONFluent Client search parameter constant for reactionstatic ca.uhn.fhir.rest.gclient.DateClientParamREACTION_DATEFluent Client search parameter constant for reaction-datestatic ca.uhn.fhir.rest.gclient.TokenClientParamREASONFluent Client search parameter constant for reasonstatic ca.uhn.fhir.rest.gclient.TokenClientParamREASON_NOT_GIVENFluent Client search parameter constant for reason-not-givenprotected CodeableConceptreportOriginThe source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.protected CodeableConceptrouteThe path by which the vaccine product is taken into the body.protected CodeableConceptsiteBody site where vaccine was administered.static StringSP_DATESearch parameter: datestatic StringSP_DOSE_SEQUENCESearch parameter: dose-sequencestatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_LOCATIONSearch parameter: locationstatic StringSP_LOT_NUMBERSearch parameter: lot-numberstatic StringSP_MANUFACTURERSearch parameter: manufacturerstatic StringSP_NOTGIVENSearch parameter: notgivenstatic StringSP_PATIENTSearch parameter: patientstatic StringSP_PRACTITIONERSearch parameter: practitionerstatic StringSP_REACTIONSearch parameter: reactionstatic StringSP_REACTION_DATESearch parameter: reaction-datestatic StringSP_REASONSearch parameter: reasonstatic StringSP_REASON_NOT_GIVENSearch parameter: reason-not-givenstatic StringSP_STATUSSearch parameter: statusstatic StringSP_VACCINE_CODESearch parameter: vaccine-codeprotected Enumeration<Immunization.ImmunizationStatus>statusIndicates the current status of the vaccination event.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected List<Immunization.ImmunizationVaccinationProtocolComponent>vaccinationProtocolContains information about the protocol(s) under which the vaccine was administered.static ca.uhn.fhir.rest.gclient.TokenClientParamVACCINE_CODEFluent Client search parameter constant for vaccine-codeprotected CodeableConceptvaccineCodeVaccine that was administered or was to be administered.-
Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description Immunization()ConstructorImmunization(Enumeration<Immunization.ImmunizationStatus> status, BooleanType notGiven, CodeableConcept vaccineCode, Reference patient, BooleanType primarySource)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
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, 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.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> identifier
A unique identifier assigned to this immunization record.
-
status
protected Enumeration<Immunization.ImmunizationStatus> status
Indicates the current status of the vaccination event.
-
notGiven
protected BooleanType notGiven
Indicates if the vaccination was or was not given.
-
vaccineCode
protected CodeableConcept vaccineCode
Vaccine that was administered or was to be administered.
-
patient
protected Reference patient
The patient who either received or did not receive the immunization.
-
patientTarget
protected Patient patientTarget
The actual object that is the target of the reference (The patient who either received or did not receive the immunization.)
-
encounter
protected Reference encounter
The visit or admission or other contact between patient and health care provider the immunization was performed as part of.
-
encounterTarget
protected Encounter encounterTarget
The actual object that is the target of the reference (The visit or admission or other contact between patient and health care provider the immunization was performed as part of.)
-
date
protected DateTimeType date
Date vaccine administered or was to be administered.
-
primarySource
protected BooleanType primarySource
An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.
-
reportOrigin
protected CodeableConcept reportOrigin
The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
-
location
protected Reference location
The service delivery location where the vaccine administration occurred.
-
locationTarget
protected Location locationTarget
The actual object that is the target of the reference (The service delivery location where the vaccine administration occurred.)
-
manufacturer
protected Reference manufacturer
Name of vaccine manufacturer.
-
manufacturerTarget
protected Organization manufacturerTarget
The actual object that is the target of the reference (Name of vaccine manufacturer.)
-
lotNumber
protected StringType lotNumber
Lot number of the vaccine product.
-
expirationDate
protected DateType expirationDate
Date vaccine batch expires.
-
site
protected CodeableConcept site
Body site where vaccine was administered.
-
route
protected CodeableConcept route
The path by which the vaccine product is taken into the body.
-
doseQuantity
protected SimpleQuantity doseQuantity
The quantity of vaccine product that was administered.
-
practitioner
protected List<Immunization.ImmunizationPractitionerComponent> practitioner
Indicates who or what performed the event.
-
note
protected List<Annotation> note
Extra information about the immunization that is not conveyed by the other attributes.
-
explanation
protected Immunization.ImmunizationExplanationComponent explanation
Reasons why a vaccine was or was not administered.
-
reaction
protected List<Immunization.ImmunizationReactionComponent> reaction
Categorical data indicating that an adverse event is associated in time to an immunization.
-
vaccinationProtocol
protected List<Immunization.ImmunizationVaccinationProtocolComponent> vaccinationProtocol
Contains information about the protocol(s) under which the vaccine was administered.
-
SP_DATE
public static final String SP_DATE
Search parameter: dateDescription: Vaccination (non)-Administration Date
Type: date
Path: Immunization.date
- See Also:
- Constant Field Values
-
DATE
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
Fluent Client search parameter constant for dateDescription: Vaccination (non)-Administration Date
Type: date
Path: Immunization.date
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: Business identifier
Type: token
Path: Immunization.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Business identifier
Type: token
Path: Immunization.identifier
-
SP_REASON
public static final String SP_REASON
Search parameter: reasonDescription: Why immunization occurred
Type: token
Path: Immunization.explanation.reason
- See Also:
- Constant Field Values
-
REASON
public static final ca.uhn.fhir.rest.gclient.TokenClientParam REASON
Fluent Client search parameter constant for reasonDescription: Why immunization occurred
Type: token
Path: Immunization.explanation.reason
-
SP_REACTION
public static final String SP_REACTION
Search parameter: reactionDescription: Additional information on reaction
Type: reference
Path: Immunization.reaction.detail
- See Also:
- Constant Field Values
-
REACTION
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REACTION
Fluent Client search parameter constant for reactionDescription: Additional information on reaction
Type: reference
Path: Immunization.reaction.detail
-
INCLUDE_REACTION
public static final ca.uhn.fhir.model.api.Include INCLUDE_REACTION
Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization:reaction".
-
SP_LOT_NUMBER
public static final String SP_LOT_NUMBER
Search parameter: lot-numberDescription: Vaccine Lot Number
Type: string
Path: Immunization.lotNumber
- See Also:
- Constant Field Values
-
LOT_NUMBER
public static final ca.uhn.fhir.rest.gclient.StringClientParam LOT_NUMBER
Fluent Client search parameter constant for lot-numberDescription: Vaccine Lot Number
Type: string
Path: Immunization.lotNumber
-
SP_PRACTITIONER
public static final String SP_PRACTITIONER
Search parameter: practitionerDescription: The practitioner who played a role in the vaccination
Type: reference
Path: Immunization.practitioner.actor
- See Also:
- Constant Field Values
-
PRACTITIONER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PRACTITIONER
Fluent Client search parameter constant for practitionerDescription: The practitioner who played a role in the vaccination
Type: reference
Path: Immunization.practitioner.actor
-
INCLUDE_PRACTITIONER
public static final ca.uhn.fhir.model.api.Include INCLUDE_PRACTITIONER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization:practitioner".
-
SP_NOTGIVEN
public static final String SP_NOTGIVEN
Search parameter: notgivenDescription: Administrations which were not given
Type: token
Path: Immunization.notGiven
- See Also:
- Constant Field Values
-
NOTGIVEN
public static final ca.uhn.fhir.rest.gclient.TokenClientParam NOTGIVEN
Fluent Client search parameter constant for notgivenDescription: Administrations which were not given
Type: token
Path: Immunization.notGiven
-
SP_MANUFACTURER
public static final String SP_MANUFACTURER
Search parameter: manufacturerDescription: Vaccine Manufacturer
Type: reference
Path: Immunization.manufacturer
- See Also:
- Constant Field Values
-
MANUFACTURER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam MANUFACTURER
Fluent Client search parameter constant for manufacturerDescription: Vaccine Manufacturer
Type: reference
Path: Immunization.manufacturer
-
INCLUDE_MANUFACTURER
public static final ca.uhn.fhir.model.api.Include INCLUDE_MANUFACTURER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization:manufacturer".
-
SP_DOSE_SEQUENCE
public static final String SP_DOSE_SEQUENCE
Search parameter: dose-sequenceDescription: Dose number within series
Type: number
Path: Immunization.vaccinationProtocol.doseSequence
- See Also:
- Constant Field Values
-
DOSE_SEQUENCE
public static final ca.uhn.fhir.rest.gclient.NumberClientParam DOSE_SEQUENCE
Fluent Client search parameter constant for dose-sequenceDescription: Dose number within series
Type: number
Path: Immunization.vaccinationProtocol.doseSequence
-
SP_PATIENT
public static final String SP_PATIENT
Search parameter: patientDescription: The patient for the vaccination record
Type: reference
Path: Immunization.patient
- See Also:
- Constant Field Values
-
PATIENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
Fluent Client search parameter constant for patientDescription: The patient for the vaccination record
Type: reference
Path: Immunization.patient
-
INCLUDE_PATIENT
public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization:patient".
-
SP_VACCINE_CODE
public static final String SP_VACCINE_CODE
Search parameter: vaccine-codeDescription: Vaccine Product Administered
Type: token
Path: Immunization.vaccineCode
- See Also:
- Constant Field Values
-
VACCINE_CODE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam VACCINE_CODE
Fluent Client search parameter constant for vaccine-codeDescription: Vaccine Product Administered
Type: token
Path: Immunization.vaccineCode
-
SP_REASON_NOT_GIVEN
public static final String SP_REASON_NOT_GIVEN
Search parameter: reason-not-givenDescription: Explanation of reason vaccination was not administered
Type: token
Path: Immunization.explanation.reasonNotGiven
- See Also:
- Constant Field Values
-
REASON_NOT_GIVEN
public static final ca.uhn.fhir.rest.gclient.TokenClientParam REASON_NOT_GIVEN
Fluent Client search parameter constant for reason-not-givenDescription: Explanation of reason vaccination was not administered
Type: token
Path: Immunization.explanation.reasonNotGiven
-
SP_LOCATION
public static final String SP_LOCATION
Search parameter: locationDescription: The service delivery location or facility in which the vaccine was / was to be administered
Type: reference
Path: Immunization.location
- See Also:
- Constant Field Values
-
LOCATION
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam LOCATION
Fluent Client search parameter constant for locationDescription: The service delivery location or facility in which the vaccine was / was to be administered
Type: reference
Path: Immunization.location
-
INCLUDE_LOCATION
public static final ca.uhn.fhir.model.api.Include INCLUDE_LOCATION
Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization:location".
-
SP_REACTION_DATE
public static final String SP_REACTION_DATE
Search parameter: reaction-dateDescription: When reaction started
Type: date
Path: Immunization.reaction.date
- See Also:
- Constant Field Values
-
REACTION_DATE
public static final ca.uhn.fhir.rest.gclient.DateClientParam REACTION_DATE
Fluent Client search parameter constant for reaction-dateDescription: When reaction started
Type: date
Path: Immunization.reaction.date
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: Immunization event status
Type: token
Path: Immunization.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: Immunization event status
Type: token
Path: Immunization.status
-
-
Constructor Detail
-
Immunization
public Immunization()
Constructor
-
Immunization
public Immunization(Enumeration<Immunization.ImmunizationStatus> status, BooleanType notGiven, CodeableConcept vaccineCode, Reference patient, BooleanType primarySource)
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(A unique identifier assigned to this immunization record.)
-
setIdentifier
public Immunization setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public Immunization addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist
-
getStatusElement
public Enumeration<Immunization.ImmunizationStatus> getStatusElement()
- Returns:
status(Indicates the current status of the vaccination event.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
public boolean hasStatusElement()
-
hasStatus
public boolean hasStatus()
-
setStatusElement
public Immunization setStatusElement(Enumeration<Immunization.ImmunizationStatus> value)
- Parameters:
value-status(Indicates the current status of the vaccination event.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public Immunization.ImmunizationStatus getStatus()
- Returns:
- Indicates the current status of the vaccination event.
-
setStatus
public Immunization setStatus(Immunization.ImmunizationStatus value)
- Parameters:
value- Indicates the current status of the vaccination event.
-
getNotGivenElement
public BooleanType getNotGivenElement()
- Returns:
notGiven(Indicates if the vaccination was or was not given.). This is the underlying object with id, value and extensions. The accessor "getNotGiven" gives direct access to the value
-
hasNotGivenElement
public boolean hasNotGivenElement()
-
hasNotGiven
public boolean hasNotGiven()
-
setNotGivenElement
public Immunization setNotGivenElement(BooleanType value)
- Parameters:
value-notGiven(Indicates if the vaccination was or was not given.). This is the underlying object with id, value and extensions. The accessor "getNotGiven" gives direct access to the value
-
getNotGiven
public boolean getNotGiven()
- Returns:
- Indicates if the vaccination was or was not given.
-
setNotGiven
public Immunization setNotGiven(boolean value)
- Parameters:
value- Indicates if the vaccination was or was not given.
-
getVaccineCode
public CodeableConcept getVaccineCode()
- Returns:
vaccineCode(Vaccine that was administered or was to be administered.)
-
hasVaccineCode
public boolean hasVaccineCode()
-
setVaccineCode
public Immunization setVaccineCode(CodeableConcept value)
- Parameters:
value-vaccineCode(Vaccine that was administered or was to be administered.)
-
getPatient
public Reference getPatient()
- Returns:
patient(The patient who either received or did not receive the immunization.)
-
hasPatient
public boolean hasPatient()
-
setPatient
public Immunization setPatient(Reference value)
- Parameters:
value-patient(The patient who either received or did not receive the immunization.)
-
getPatientTarget
public Patient getPatientTarget()
- Returns:
patientThe 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. (The patient who either received or did not receive the immunization.)
-
setPatientTarget
public Immunization setPatientTarget(Patient value)
- Parameters:
value-patientThe 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. (The patient who either received or did not receive the immunization.)
-
getEncounter
public Reference getEncounter()
- Returns:
encounter(The visit or admission or other contact between patient and health care provider the immunization was performed as part of.)
-
hasEncounter
public boolean hasEncounter()
-
setEncounter
public Immunization setEncounter(Reference value)
- Parameters:
value-encounter(The visit or admission or other contact between patient and health care provider the immunization was performed as part of.)
-
getEncounterTarget
public Encounter getEncounterTarget()
- Returns:
encounterThe 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. (The visit or admission or other contact between patient and health care provider the immunization was performed as part of.)
-
setEncounterTarget
public Immunization setEncounterTarget(Encounter value)
- Parameters:
value-encounterThe 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. (The visit or admission or other contact between patient and health care provider the immunization was performed as part of.)
-
getDateElement
public DateTimeType getDateElement()
- Returns:
date(Date vaccine administered or was to be administered.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
hasDateElement
public boolean hasDateElement()
-
hasDate
public boolean hasDate()
-
setDateElement
public Immunization setDateElement(DateTimeType value)
- Parameters:
value-date(Date vaccine administered or was to be administered.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
setDate
public Immunization setDate(Date value)
- Parameters:
value- Date vaccine administered or was to be administered.
-
getPrimarySourceElement
public BooleanType getPrimarySourceElement()
- Returns:
primarySource(An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.). This is the underlying object with id, value and extensions. The accessor "getPrimarySource" gives direct access to the value
-
hasPrimarySourceElement
public boolean hasPrimarySourceElement()
-
hasPrimarySource
public boolean hasPrimarySource()
-
setPrimarySourceElement
public Immunization setPrimarySourceElement(BooleanType value)
- Parameters:
value-primarySource(An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.). This is the underlying object with id, value and extensions. The accessor "getPrimarySource" gives direct access to the value
-
getPrimarySource
public boolean getPrimarySource()
- Returns:
- An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.
-
setPrimarySource
public Immunization setPrimarySource(boolean value)
- Parameters:
value- An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.
-
getReportOrigin
public CodeableConcept getReportOrigin()
- Returns:
reportOrigin(The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.)
-
hasReportOrigin
public boolean hasReportOrigin()
-
setReportOrigin
public Immunization setReportOrigin(CodeableConcept value)
- Parameters:
value-reportOrigin(The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.)
-
getLocation
public Reference getLocation()
- Returns:
location(The service delivery location where the vaccine administration occurred.)
-
hasLocation
public boolean hasLocation()
-
setLocation
public Immunization setLocation(Reference value)
- Parameters:
value-location(The service delivery location where the vaccine administration occurred.)
-
getLocationTarget
public Location getLocationTarget()
- Returns:
locationThe 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. (The service delivery location where the vaccine administration occurred.)
-
setLocationTarget
public Immunization setLocationTarget(Location value)
- Parameters:
value-locationThe 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. (The service delivery location where the vaccine administration occurred.)
-
getManufacturer
public Reference getManufacturer()
- Returns:
manufacturer(Name of vaccine manufacturer.)
-
hasManufacturer
public boolean hasManufacturer()
-
setManufacturer
public Immunization setManufacturer(Reference value)
- Parameters:
value-manufacturer(Name of vaccine manufacturer.)
-
getManufacturerTarget
public Organization getManufacturerTarget()
- Returns:
manufacturerThe 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. (Name of vaccine manufacturer.)
-
setManufacturerTarget
public Immunization setManufacturerTarget(Organization value)
- Parameters:
value-manufacturerThe 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. (Name of vaccine manufacturer.)
-
getLotNumberElement
public StringType getLotNumberElement()
- Returns:
lotNumber(Lot number of the vaccine product.). This is the underlying object with id, value and extensions. The accessor "getLotNumber" gives direct access to the value
-
hasLotNumberElement
public boolean hasLotNumberElement()
-
hasLotNumber
public boolean hasLotNumber()
-
setLotNumberElement
public Immunization setLotNumberElement(StringType value)
- Parameters:
value-lotNumber(Lot number of the vaccine product.). This is the underlying object with id, value and extensions. The accessor "getLotNumber" gives direct access to the value
-
getLotNumber
public String getLotNumber()
- Returns:
- Lot number of the vaccine product.
-
setLotNumber
public Immunization setLotNumber(String value)
- Parameters:
value- Lot number of the vaccine product.
-
getExpirationDateElement
public DateType getExpirationDateElement()
- Returns:
expirationDate(Date vaccine batch expires.). This is the underlying object with id, value and extensions. The accessor "getExpirationDate" gives direct access to the value
-
hasExpirationDateElement
public boolean hasExpirationDateElement()
-
hasExpirationDate
public boolean hasExpirationDate()
-
setExpirationDateElement
public Immunization setExpirationDateElement(DateType value)
- Parameters:
value-expirationDate(Date vaccine batch expires.). This is the underlying object with id, value and extensions. The accessor "getExpirationDate" gives direct access to the value
-
getExpirationDate
public Date getExpirationDate()
- Returns:
- Date vaccine batch expires.
-
setExpirationDate
public Immunization setExpirationDate(Date value)
- Parameters:
value- Date vaccine batch expires.
-
getSite
public CodeableConcept getSite()
- Returns:
site(Body site where vaccine was administered.)
-
hasSite
public boolean hasSite()
-
setSite
public Immunization setSite(CodeableConcept value)
- Parameters:
value-site(Body site where vaccine was administered.)
-
getRoute
public CodeableConcept getRoute()
- Returns:
route(The path by which the vaccine product is taken into the body.)
-
hasRoute
public boolean hasRoute()
-
setRoute
public Immunization setRoute(CodeableConcept value)
- Parameters:
value-route(The path by which the vaccine product is taken into the body.)
-
getDoseQuantity
public SimpleQuantity getDoseQuantity()
- Returns:
doseQuantity(The quantity of vaccine product that was administered.)
-
hasDoseQuantity
public boolean hasDoseQuantity()
-
setDoseQuantity
public Immunization setDoseQuantity(SimpleQuantity value)
- Parameters:
value-doseQuantity(The quantity of vaccine product that was administered.)
-
getPractitioner
public List<Immunization.ImmunizationPractitionerComponent> getPractitioner()
- Returns:
practitioner(Indicates who or what performed the event.)
-
setPractitioner
public Immunization setPractitioner(List<Immunization.ImmunizationPractitionerComponent> thePractitioner)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasPractitioner
public boolean hasPractitioner()
-
addPractitioner
public Immunization.ImmunizationPractitionerComponent addPractitioner()
-
addPractitioner
public Immunization addPractitioner(Immunization.ImmunizationPractitionerComponent t)
-
getPractitionerFirstRep
public Immunization.ImmunizationPractitionerComponent getPractitionerFirstRep()
- Returns:
- The first repetition of repeating field
practitioner, creating it if it does not already exist
-
getNote
public List<Annotation> getNote()
- Returns:
note(Extra information about the immunization that is not conveyed by the other attributes.)
-
setNote
public Immunization setNote(List<Annotation> theNote)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasNote
public boolean hasNote()
-
addNote
public Annotation addNote()
-
addNote
public Immunization addNote(Annotation t)
-
getNoteFirstRep
public Annotation getNoteFirstRep()
- Returns:
- The first repetition of repeating field
note, creating it if it does not already exist
-
getExplanation
public Immunization.ImmunizationExplanationComponent getExplanation()
- Returns:
explanation(Reasons why a vaccine was or was not administered.)
-
hasExplanation
public boolean hasExplanation()
-
setExplanation
public Immunization setExplanation(Immunization.ImmunizationExplanationComponent value)
- Parameters:
value-explanation(Reasons why a vaccine was or was not administered.)
-
getReaction
public List<Immunization.ImmunizationReactionComponent> getReaction()
- Returns:
reaction(Categorical data indicating that an adverse event is associated in time to an immunization.)
-
setReaction
public Immunization setReaction(List<Immunization.ImmunizationReactionComponent> theReaction)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasReaction
public boolean hasReaction()
-
addReaction
public Immunization.ImmunizationReactionComponent addReaction()
-
addReaction
public Immunization addReaction(Immunization.ImmunizationReactionComponent t)
-
getReactionFirstRep
public Immunization.ImmunizationReactionComponent getReactionFirstRep()
- Returns:
- The first repetition of repeating field
reaction, creating it if it does not already exist
-
getVaccinationProtocol
public List<Immunization.ImmunizationVaccinationProtocolComponent> getVaccinationProtocol()
- Returns:
vaccinationProtocol(Contains information about the protocol(s) under which the vaccine was administered.)
-
setVaccinationProtocol
public Immunization setVaccinationProtocol(List<Immunization.ImmunizationVaccinationProtocolComponent> theVaccinationProtocol)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasVaccinationProtocol
public boolean hasVaccinationProtocol()
-
addVaccinationProtocol
public Immunization.ImmunizationVaccinationProtocolComponent addVaccinationProtocol()
-
addVaccinationProtocol
public Immunization addVaccinationProtocol(Immunization.ImmunizationVaccinationProtocolComponent t)
-
getVaccinationProtocolFirstRep
public Immunization.ImmunizationVaccinationProtocolComponent getVaccinationProtocolFirstRep()
- Returns:
- The first repetition of repeating field
vaccinationProtocol, creating it if it does not already exist
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public Immunization copy()
- Specified by:
copyin classDomainResource
-
typedCopy
protected Immunization typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-