Class Immunization
- java.lang.Object
-
- org.hl7.fhir.r4.model.Base
-
- org.hl7.fhir.r4.model.BaseResource
-
- org.hl7.fhir.r4.model.Resource
-
- org.hl7.fhir.r4.model.DomainResource
-
- org.hl7.fhir.r4.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 vaccine or a record of an immunization as reported by a patient, a clinician or another party.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classImmunization.ImmunizationEducationComponentstatic classImmunization.ImmunizationPerformerComponentstatic classImmunization.ImmunizationProtocolAppliedComponentstatic classImmunization.ImmunizationReactionComponentstatic classImmunization.ImmunizationStatusstatic classImmunization.ImmunizationStatusEnumFactory
-
Field Summary
Fields Modifier and Type Field Description static ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for dateprotected QuantitydoseQuantityThe quantity of vaccine product that was administered.protected List<Immunization.ImmunizationEducationComponent>educationEducational material presented to the patient (or guardian) at the time of vaccine administration.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 CodeableConceptfundingSourceIndicates the source of the vaccine actually 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_PERFORMERConstant 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.static ca.uhn.fhir.model.api.IncludeINCLUDE_REASON_REFERENCEConstant for fluent queries to be used to add include statements.protected BooleanTypeisSubpotentIndication if a dose is considered to be subpotent.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 TypeoccurrenceDate vaccine administered or was to be administered.protected 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.ImmunizationPerformerComponent>performerIndicates who performed the immunization event.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPERFORMERFluent Client search parameter constant for performerprotected BooleanTypeprimarySourceAn indication that the content of the record is based on information from the person who administered the vaccine.protected List<CodeableConcept>programEligibilityIndicates a patient's eligibility for a funding program.protected List<Immunization.ImmunizationProtocolAppliedComponent>protocolAppliedThe protocol (set of recommendations) being followed by the provider who administered the dose.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.TokenClientParamREASON_CODEFluent Client search parameter constant for reason-codestatic ca.uhn.fhir.rest.gclient.ReferenceClientParamREASON_REFERENCEFluent Client search parameter constant for reason-referenceprotected List<CodeableConcept>reasonCodeReasons why the vaccine was administered.protected List<Reference>reasonReferenceCondition, Observation or DiagnosticReport that supports why the immunization was administered.protected List<Resource>reasonReferenceTargetThe actual objects that are the target of the reference (Condition, Observation or DiagnosticReport that supports why the immunization was administered.)protected DateTimeTyperecordedThe date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.protected 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.static ca.uhn.fhir.rest.gclient.StringClientParamSERIESFluent Client search parameter constant for seriesprotected CodeableConceptsiteBody site where vaccine was administered.static StringSP_DATESearch parameter: datestatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_LOCATIONSearch parameter: locationstatic StringSP_LOT_NUMBERSearch parameter: lot-numberstatic StringSP_MANUFACTURERSearch parameter: manufacturerstatic StringSP_PATIENTSearch parameter: patientstatic StringSP_PERFORMERSearch parameter: performerstatic StringSP_REACTIONSearch parameter: reactionstatic StringSP_REACTION_DATESearch parameter: reaction-datestatic StringSP_REASON_CODESearch parameter: reason-codestatic StringSP_REASON_REFERENCESearch parameter: reason-referencestatic StringSP_SERIESSearch parameter: seriesstatic StringSP_STATUSSearch parameter: statusstatic StringSP_STATUS_REASONSearch parameter: status-reasonstatic StringSP_TARGET_DISEASESearch parameter: target-diseasestatic StringSP_VACCINE_CODESearch parameter: vaccine-codeprotected Enumeration<Immunization.ImmunizationStatus>statusIndicates the current status of the immunization event.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusstatic ca.uhn.fhir.rest.gclient.TokenClientParamSTATUS_REASONFluent Client search parameter constant for status-reasonprotected CodeableConceptstatusReasonIndicates the reason the immunization event was not performed.protected List<CodeableConcept>subpotentReasonReason why a dose is considered to be subpotent.static ca.uhn.fhir.rest.gclient.TokenClientParamTARGET_DISEASEFluent Client search parameter constant for target-diseasestatic 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.r4.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description Immunization()ConstructorImmunization(Enumeration<Immunization.ImmunizationStatus> status, CodeableConcept vaccineCode, Reference patient, Type occurrence)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, 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.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
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, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, 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 immunization event.
-
statusReason
protected CodeableConcept statusReason
Indicates the reason the immunization event was not performed.
-
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.)
-
occurrence
protected Type occurrence
Date vaccine administered or was to be administered.
-
recorded
protected DateTimeType recorded
The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
-
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 Quantity doseQuantity
The quantity of vaccine product that was administered.
-
performer
protected List<Immunization.ImmunizationPerformerComponent> performer
Indicates who performed the immunization event.
-
note
protected List<Annotation> note
Extra information about the immunization that is not conveyed by the other attributes.
-
reasonCode
protected List<CodeableConcept> reasonCode
Reasons why the vaccine was administered.
-
reasonReference
protected List<Reference> reasonReference
Condition, Observation or DiagnosticReport that supports why the immunization was administered.
-
reasonReferenceTarget
protected List<Resource> reasonReferenceTarget
The actual objects that are the target of the reference (Condition, Observation or DiagnosticReport that supports why the immunization was administered.)
-
isSubpotent
protected BooleanType isSubpotent
Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
-
subpotentReason
protected List<CodeableConcept> subpotentReason
Reason why a dose is considered to be subpotent.
-
education
protected List<Immunization.ImmunizationEducationComponent> education
Educational material presented to the patient (or guardian) at the time of vaccine administration.
-
programEligibility
protected List<CodeableConcept> programEligibility
Indicates a patient's eligibility for a funding program.
-
fundingSource
protected CodeableConcept fundingSource
Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).
-
reaction
protected List<Immunization.ImmunizationReactionComponent> reaction
Categorical data indicating that an adverse event is associated in time to an immunization.
-
protocolApplied
protected List<Immunization.ImmunizationProtocolAppliedComponent> protocolApplied
The protocol (set of recommendations) being followed by the provider who administered the dose.
-
SP_DATE
public static final String SP_DATE
Search parameter: dateDescription: Vaccination (non)-Administration Date
Type: date
Path: Immunization.occurrence[x]
- 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.occurrence[x]
-
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_PERFORMER
public static final String SP_PERFORMER
Search parameter: performerDescription: The practitioner or organization who played a role in the vaccination
Type: reference
Path: Immunization.performer.actor
- See Also:
- Constant Field Values
-
PERFORMER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PERFORMER
Fluent Client search parameter constant for performerDescription: The practitioner or organization who played a role in the vaccination
Type: reference
Path: Immunization.performer.actor
-
INCLUDE_PERFORMER
public static final ca.uhn.fhir.model.api.Include INCLUDE_PERFORMER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization:performer".
-
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_STATUS_REASON
public static final String SP_STATUS_REASON
Search parameter: status-reasonDescription: Reason why the vaccine was not administered
Type: token
Path: Immunization.statusReason
- See Also:
- Constant Field Values
-
STATUS_REASON
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS_REASON
Fluent Client search parameter constant for status-reasonDescription: Reason why the vaccine was not administered
Type: token
Path: Immunization.statusReason
-
SP_REASON_CODE
public static final String SP_REASON_CODE
Search parameter: reason-codeDescription: Reason why the vaccine was administered
Type: token
Path: Immunization.reasonCode
- See Also:
- Constant Field Values
-
REASON_CODE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam REASON_CODE
Fluent Client search parameter constant for reason-codeDescription: Reason why the vaccine was administered
Type: token
Path: Immunization.reasonCode
-
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_TARGET_DISEASE
public static final String SP_TARGET_DISEASE
Search parameter: target-diseaseDescription: The target disease the dose is being administered against
Type: token
Path: Immunization.protocolApplied.targetDisease
- See Also:
- Constant Field Values
-
TARGET_DISEASE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam TARGET_DISEASE
Fluent Client search parameter constant for target-diseaseDescription: The target disease the dose is being administered against
Type: token
Path: Immunization.protocolApplied.targetDisease
-
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_SERIES
public static final String SP_SERIES
Search parameter: seriesDescription: The series being followed by the provider
Type: string
Path: Immunization.protocolApplied.series
- See Also:
- Constant Field Values
-
SERIES
public static final ca.uhn.fhir.rest.gclient.StringClientParam SERIES
Fluent Client search parameter constant for seriesDescription: The series being followed by the provider
Type: string
Path: Immunization.protocolApplied.series
-
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_REFERENCE
public static final String SP_REASON_REFERENCE
Search parameter: reason-referenceDescription: Why immunization occurred
Type: reference
Path: Immunization.reasonReference
- See Also:
- Constant Field Values
-
REASON_REFERENCE
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REASON_REFERENCE
Fluent Client search parameter constant for reason-referenceDescription: Why immunization occurred
Type: reference
Path: Immunization.reasonReference
-
INCLUDE_REASON_REFERENCE
public static final ca.uhn.fhir.model.api.Include INCLUDE_REASON_REFERENCE
Constant for fluent queries to be used to add include statements. Specifies the path value of "Immunization:reason-reference".
-
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_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
-
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
-
-
Constructor Detail
-
Immunization
public Immunization()
Constructor
-
Immunization
public Immunization(Enumeration<Immunization.ImmunizationStatus> status, CodeableConcept vaccineCode, Reference patient, Type occurrence)
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 immunization 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 immunization 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 immunization event.
-
setStatus
public Immunization setStatus(Immunization.ImmunizationStatus value)
- Parameters:
value- Indicates the current status of the immunization event.
-
getStatusReason
public CodeableConcept getStatusReason()
- Returns:
statusReason(Indicates the reason the immunization event was not performed.)
-
hasStatusReason
public boolean hasStatusReason()
-
setStatusReason
public Immunization setStatusReason(CodeableConcept value)
- Parameters:
value-statusReason(Indicates the reason the immunization event was not performed.)
-
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.)
-
getOccurrence
public Type getOccurrence()
- Returns:
occurrence(Date vaccine administered or was to be administered.)
-
getOccurrenceDateTimeType
public DateTimeType getOccurrenceDateTimeType() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
occurrence(Date vaccine administered or was to be administered.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasOccurrenceDateTimeType
public boolean hasOccurrenceDateTimeType()
-
getOccurrenceStringType
public StringType getOccurrenceStringType() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
occurrence(Date vaccine administered or was to be administered.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasOccurrenceStringType
public boolean hasOccurrenceStringType()
-
hasOccurrence
public boolean hasOccurrence()
-
setOccurrence
public Immunization setOccurrence(Type value)
- Parameters:
value-occurrence(Date vaccine administered or was to be administered.)
-
getRecordedElement
public DateTimeType getRecordedElement()
- Returns:
recorded(The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.). This is the underlying object with id, value and extensions. The accessor "getRecorded" gives direct access to the value
-
hasRecordedElement
public boolean hasRecordedElement()
-
hasRecorded
public boolean hasRecorded()
-
setRecordedElement
public Immunization setRecordedElement(DateTimeType value)
- Parameters:
value-recorded(The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.). This is the underlying object with id, value and extensions. The accessor "getRecorded" gives direct access to the value
-
getRecorded
public Date getRecorded()
- Returns:
- The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
-
setRecorded
public Immunization setRecorded(Date value)
- Parameters:
value- The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
-
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 Quantity getDoseQuantity()
- Returns:
doseQuantity(The quantity of vaccine product that was administered.)
-
hasDoseQuantity
public boolean hasDoseQuantity()
-
setDoseQuantity
public Immunization setDoseQuantity(Quantity value)
- Parameters:
value-doseQuantity(The quantity of vaccine product that was administered.)
-
getPerformer
public List<Immunization.ImmunizationPerformerComponent> getPerformer()
- Returns:
performer(Indicates who performed the immunization event.)
-
setPerformer
public Immunization setPerformer(List<Immunization.ImmunizationPerformerComponent> thePerformer)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasPerformer
public boolean hasPerformer()
-
addPerformer
public Immunization.ImmunizationPerformerComponent addPerformer()
-
addPerformer
public Immunization addPerformer(Immunization.ImmunizationPerformerComponent t)
-
getPerformerFirstRep
public Immunization.ImmunizationPerformerComponent getPerformerFirstRep()
- Returns:
- The first repetition of repeating field
performer, 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
-
getReasonCode
public List<CodeableConcept> getReasonCode()
- Returns:
reasonCode(Reasons why the vaccine was administered.)
-
setReasonCode
public Immunization setReasonCode(List<CodeableConcept> theReasonCode)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasReasonCode
public boolean hasReasonCode()
-
addReasonCode
public CodeableConcept addReasonCode()
-
addReasonCode
public Immunization addReasonCode(CodeableConcept t)
-
getReasonCodeFirstRep
public CodeableConcept getReasonCodeFirstRep()
- Returns:
- The first repetition of repeating field
reasonCode, creating it if it does not already exist
-
getReasonReference
public List<Reference> getReasonReference()
- Returns:
reasonReference(Condition, Observation or DiagnosticReport that supports why the immunization was administered.)
-
setReasonReference
public Immunization setReasonReference(List<Reference> theReasonReference)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasReasonReference
public boolean hasReasonReference()
-
addReasonReference
public Reference addReasonReference()
-
addReasonReference
public Immunization addReasonReference(Reference t)
-
getReasonReferenceFirstRep
public Reference getReasonReferenceFirstRep()
- Returns:
- The first repetition of repeating field
reasonReference, creating it if it does not already exist
-
getReasonReferenceTarget
@Deprecated public List<Resource> getReasonReferenceTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getIsSubpotentElement
public BooleanType getIsSubpotentElement()
- Returns:
isSubpotent(Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.). This is the underlying object with id, value and extensions. The accessor "getIsSubpotent" gives direct access to the value
-
hasIsSubpotentElement
public boolean hasIsSubpotentElement()
-
hasIsSubpotent
public boolean hasIsSubpotent()
-
setIsSubpotentElement
public Immunization setIsSubpotentElement(BooleanType value)
- Parameters:
value-isSubpotent(Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.). This is the underlying object with id, value and extensions. The accessor "getIsSubpotent" gives direct access to the value
-
getIsSubpotent
public boolean getIsSubpotent()
- Returns:
- Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
-
setIsSubpotent
public Immunization setIsSubpotent(boolean value)
- Parameters:
value- Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
-
getSubpotentReason
public List<CodeableConcept> getSubpotentReason()
- Returns:
subpotentReason(Reason why a dose is considered to be subpotent.)
-
setSubpotentReason
public Immunization setSubpotentReason(List<CodeableConcept> theSubpotentReason)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSubpotentReason
public boolean hasSubpotentReason()
-
addSubpotentReason
public CodeableConcept addSubpotentReason()
-
addSubpotentReason
public Immunization addSubpotentReason(CodeableConcept t)
-
getSubpotentReasonFirstRep
public CodeableConcept getSubpotentReasonFirstRep()
- Returns:
- The first repetition of repeating field
subpotentReason, creating it if it does not already exist
-
getEducation
public List<Immunization.ImmunizationEducationComponent> getEducation()
- Returns:
education(Educational material presented to the patient (or guardian) at the time of vaccine administration.)
-
setEducation
public Immunization setEducation(List<Immunization.ImmunizationEducationComponent> theEducation)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasEducation
public boolean hasEducation()
-
addEducation
public Immunization.ImmunizationEducationComponent addEducation()
-
addEducation
public Immunization addEducation(Immunization.ImmunizationEducationComponent t)
-
getEducationFirstRep
public Immunization.ImmunizationEducationComponent getEducationFirstRep()
- Returns:
- The first repetition of repeating field
education, creating it if it does not already exist
-
getProgramEligibility
public List<CodeableConcept> getProgramEligibility()
- Returns:
programEligibility(Indicates a patient's eligibility for a funding program.)
-
setProgramEligibility
public Immunization setProgramEligibility(List<CodeableConcept> theProgramEligibility)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasProgramEligibility
public boolean hasProgramEligibility()
-
addProgramEligibility
public CodeableConcept addProgramEligibility()
-
addProgramEligibility
public Immunization addProgramEligibility(CodeableConcept t)
-
getProgramEligibilityFirstRep
public CodeableConcept getProgramEligibilityFirstRep()
- Returns:
- The first repetition of repeating field
programEligibility, creating it if it does not already exist
-
getFundingSource
public CodeableConcept getFundingSource()
- Returns:
fundingSource(Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).)
-
hasFundingSource
public boolean hasFundingSource()
-
setFundingSource
public Immunization setFundingSource(CodeableConcept value)
- Parameters:
value-fundingSource(Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually 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
-
getProtocolApplied
public List<Immunization.ImmunizationProtocolAppliedComponent> getProtocolApplied()
- Returns:
protocolApplied(The protocol (set of recommendations) being followed by the provider who administered the dose.)
-
setProtocolApplied
public Immunization setProtocolApplied(List<Immunization.ImmunizationProtocolAppliedComponent> theProtocolApplied)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasProtocolApplied
public boolean hasProtocolApplied()
-
addProtocolApplied
public Immunization.ImmunizationProtocolAppliedComponent addProtocolApplied()
-
addProtocolApplied
public Immunization addProtocolApplied(Immunization.ImmunizationProtocolAppliedComponent t)
-
getProtocolAppliedFirstRep
public Immunization.ImmunizationProtocolAppliedComponent getProtocolAppliedFirstRep()
- Returns:
- The first repetition of repeating field
protocolApplied, 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
-
copyValues
public void copyValues(Immunization dst)
-
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
-
-