Information about the administration of a vaccine to a patient. This class is a sub-class of MedicationAdministrationPerformed, and therefore inherits the properties of that class, and then adds vaccination-specific information such as the dose number within a series, and immunity status.
"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." - HL7 FHIR, Immunization

Attributes
ImmunizationEvaluation	evaluation	An evaluation of a given vaccination in which an attempt is made to match the vaccination with a target dose number.
ImmunizationFundingEligibility	fundingEligibility	Indicates the eligibility of the Patient to receive a vaccine under a publicly funded vaccine program.
«CS» Code	fundingSource	Indicates the source of funds used to pay for the Immunization. In the CDC Version 2 Implementation Guide, this is implemented as a seperate observation, in OBX-5. "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)." - HL7 FHIR, Immunization.fundingSource
ImmunityStatus	immunityStatus	The immunological state of the patient with respect to a given disease.
Boolean	isSubpotent	"Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent." - HL7 FHIR, Immunization.isSubpotent
Integer	numberInSeries	"If the order is for a continuous administration (such as an IV), and the rate is changed at a certain time after the start, an RAS message can be issued to record the change. For such an RAS message, this field records the time the rate was changed to the new value recorded in the RXA-12-Administered Per (time unit) of the same message." - HL7 Version 2.8, RXA-2
PatientDocumentPresentation	patientDocumentPresentation	The provision of a Vaccine Information Sheet to the patient.
«CS» Code	subpotentReason	"Reason why a dose is considered to be subpotent." - HL7 FHIR, Immunization.subpotentReason

Attributes inherited from  FHIM::MedicationAdministration::MedicationAdministrationPerformed

administeredDrug,  category,  medicationAdministrationTopic,  notGiven,  patientCondition,  quantityGiven,  reaction,  systemEntryDateTime,  deviceInstance,  patientEducationPerformed

Attributes inherited from  FHIM::Common::ActionPerformed

basedOn,  bodySite,  complication,  complicationDetail,  duration,  enactsPlan,  focalDevice,  followUp,  fulfillsOrder,  fulfillsPromise,  nonCompletionTimeframe,  outcome,  partOf,  performancePeriod,  performer,  procedureModifier,  report,  researchStudy,  status,  statusReason,  timesPerformed,  topicCode,  usedCode,  usedReference,  wasCompleted

Attributes inherited from  FHIM::Common::ActionStatement

category,  currentStatus,  description,  indication,  inputFinding,  instantiatesCanonical,  instantiatesUri,  insurance,  intent,  justification,  location,  method,  outputFinding,  precondition,  reasonCode,  reasonNarrative,  reasonReference,  relevantHistory,  scope,  supportingInformation,  usingDevice,  wasReported

Attributes inherited from  FHIM::Common::ClinicalStatement

clinicalDataSource,  contentVersion,  contextCode,  encounter,  note,  recordStatus,  relatedClinicalInformation,  sourceRecordType,  sourceSystem,  subjectGroup,  subjectOfInformation,  subjectOfRecord,  temporalContext,  topicCode,  cosigned,  recorded,  signed,  verified

Attributes inherited from  FHIM::Common::InformationEntry

identifier

 evaluation

Public ImmunizationEvaluation evaluation

An evaluation of a given vaccination in which an attempt is made to match the vaccination with a target dose number.

Constraints:

Properties:

Aggregation	None
Alias
Association	vaccinationEvent_evaluation
Association End
Class	VaccinationEvent
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value	(1)
Multiplicity	1
Name	evaluation
Name Expression
Namespace	VaccinationEvent
Opposite
Owner	VaccinationEvent
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Immunization::VaccinationEvent::evaluation
Stereotype
Template Parameter
Type	ImmunizationEvaluation
Upper	1
Upper Value	(1)
Visibility	Public

 fundingEligibility

Public ImmunizationFundingEligibility fundingEligibility

Indicates the eligibility of the Patient to receive a vaccine under a publicly funded vaccine program.

Constraints:

Properties:

Aggregation	None
Alias
Association	vaccinationEvent_fundingEligibility
Association End
Class	VaccinationEvent
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	*
Name	fundingEligibility
Name Expression
Namespace	VaccinationEvent
Opposite
Owner	VaccinationEvent
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Immunization::VaccinationEvent::fundingEligibility
Stereotype
Template Parameter
Type	ImmunizationFundingEligibility
Upper	*
Upper Value	(*)
Visibility	Public

 fundingSource

Public «CS» Code fundingSource

Indicates the source of funds used to pay for the Immunization. In the CDC Version 2 Implementation Guide, this is implemented as a seperate observation, in OBX-5.
"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)." - HL7 FHIR, Immunization.fundingSource

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	VaccinationEvent
Terminologies	[ HL7_V2 Immunization Funding Source (IIS) 2.16.840.1.114222.4.11.3287 , HL7_FHIR_R4 ImmunizationFundingSource http://hl7.org/fhir/ValueSet/immunization-funding-source ]
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	fundingSource
Name Expression
Namespace	VaccinationEvent
Opposite
Owner	VaccinationEvent
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Immunization::VaccinationEvent::fundingSource
Stereotype	ValueSetConstraints
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

 immunityStatus

Public ImmunityStatus immunityStatus

The immunological state of the patient with respect to a given disease.

Constraints:

Properties:

Aggregation	None
Alias
Association	vaccinationEvent_immunityStatus
Association End
Class	VaccinationEvent
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	*
Name	immunityStatus
Name Expression
Namespace	VaccinationEvent
Opposite
Owner	VaccinationEvent
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Immunization::VaccinationEvent::immunityStatus
Stereotype
Template Parameter
Type	ImmunityStatus
Upper	*
Upper Value	(*)
Visibility	Public

 isSubpotent

Public Boolean isSubpotent

"Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent." - HL7 FHIR, Immunization.isSubpotent

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	VaccinationEvent
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	isSubpotent
Name Expression
Namespace	VaccinationEvent
Opposite
Owner	VaccinationEvent
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Immunization::VaccinationEvent::isSubpotent
Stereotype
Template Parameter
Type	Boolean
Upper	1
Upper Value	(1)
Visibility	Public

 numberInSeries

Public Integer numberInSeries

"If the order is for a continuous administration (such as an IV), and the rate is changed at a certain time after the start, an RAS message can be issued to record the change. For such an RAS message, this field records the time the rate was changed to the new value recorded in the RXA-12-Administered Per (time unit) of the same message." - HL7 Version 2.8, RXA-2

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	VaccinationEvent
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	numberInSeries
Name Expression
Namespace	VaccinationEvent
Opposite
Owner	VaccinationEvent
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Immunization::VaccinationEvent::numberInSeries
Stereotype
Template Parameter
Type	Integer
Upper	1
Upper Value	(1)
Visibility	Public

 patientDocumentPresentation

Public PatientDocumentPresentation patientDocumentPresentation

The provision of a Vaccine Information Sheet to the patient.

Constraints:

Properties:

Aggregation	None
Alias
Association	vaccinationEvent_patientDocumentPresentation
Association End
Class	VaccinationEvent
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	patientDocumentPresentation
Name Expression
Namespace	VaccinationEvent
Opposite
Owner	VaccinationEvent
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Immunization::VaccinationEvent::patientDocumentPresentation
Stereotype
Template Parameter
Type	PatientDocumentPresentation
Upper	1
Upper Value	(1)
Visibility	Public

 subpotentReason

Public «CS» Code subpotentReason

"Reason why a dose is considered to be subpotent." - HL7 FHIR, Immunization.subpotentReason

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	VaccinationEvent
Terminologies	[ HL7_FHIR_R4 ImmunizationSubpotentReason http://hl7.org/fhir/ValueSet/immunization-subpotent-reason ]
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	*
Name	subpotentReason
Name Expression
Namespace	VaccinationEvent
Opposite
Owner	VaccinationEvent
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Immunization::VaccinationEvent::subpotentReason
Stereotype	ValueSetConstraints
Template Parameter
Type	«CS» Code
Upper	*
Upper Value	(*)
Visibility	Public