OverviewTopPackageElement
Immunization UML Documentation

Immunization

The FHIM Immunization domain is concerned with the documentation surrounding ordering, administration, and reporting to public authorities of vaccations. There are three potential "entry points", the primary one being the Immunization History List. The Immunization History List can be composed of entries from multiple organizations and may include entries describing actual immunizations as well as immunizations that did not occur for some reason.

There currently exists a subpackage in this domain that deals with forecasting of immunizations, which is out of scope for this iteration of the FHIM, but was modeled in the HL7 Domain Analysis Model, which was one of the sources for this domain. The Immunization Forecast will likely be modeled in a future iteration.

_Immunization
Generalization Polyline coordinates describing hotspot on the image Generalization Polyline coordinates describing hotspot on the image doseAndRate Property doseAndRate Property doseAndRate doseAndRate Property Property dosage_doseAndRate Polyline coordinates describing hotspot on the image vehicle Property vehicle Property vehicle vehicle Property Property pharmacyManufacturedProduct_vehicle Polyline coordinates describing hotspot on the image productInstance Property productInstance Property productInstance productInstance Property Property vehicle_productInstance Polyline coordinates describing hotspot on the image additive Property additive Property additive additive Property Property pharmacyManufacturedProduct_additive Polyline coordinates describing hotspot on the image pharmacyManufacturedProduct Property pharmacyManufacturedProduct Property pharmacyManufacturedProduct pharmacyManufacturedProduct Property Property administeredDrug_pharmacyManufacturedProduct Polyline coordinates describing hotspot on the image productInstance Property productInstance Property productInstance productInstance Property Property additive_productInstance Polyline coordinates describing hotspot on the image packagedMedicinalProduct medicinalProduct packagedMedicinalProduct medicinalProduct packagedMedicinalProduct packagedMedicinalProduct medicinalProduct medicinalProduct medicinalProduct_packagedMedicinalProduct Polyline coordinates describing hotspot on the image productInstance packagedMedicinalProduct productInstance packagedMedicinalProduct productInstance productInstance packagedMedicinalProduct packagedMedicinalProduct packagedMedicinalProduct_productInstance Polyline coordinates describing hotspot on the image manufacturingLot Property manufacturingLot Property manufacturingLot manufacturingLot Property Property medicinalProductInstance_manufacturingLot Polyline coordinates describing hotspot on the image productInstance Property productInstance Property productInstance productInstance Property Property administeredDrug_productInstance Polyline coordinates describing hotspot on the image Generalization Polyline coordinates describing hotspot on the image indication Property indication Property indication indication Property Property vaccine_indication Polyline coordinates describing hotspot on the image targetDose Property targetDose Property targetDose targetDose Property Property patientSeries_targetDose Polyline coordinates describing hotspot on the image targetDose Property targetDose Property targetDose targetDose Property Property immunizationEvaluation_targetDose Polyline coordinates describing hotspot on the image evaluation Property evaluation Property evaluation evaluation Property Property vaccinationEvent_evaluation Polyline coordinates describing hotspot on the image vaccineInformationStatement Property vaccineInformationStatement Property vaccineInformationStatement vaccineInformationStatement Property Property patientDocumentPresentation_vaccineInformationStatement Polyline coordinates describing hotspot on the image patientDocumentPresentation Property patientDocumentPresentation Property patientDocumentPresentation patientDocumentPresentation Property Property vaccinationEvent_patientDocumentPresentation Polyline coordinates describing hotspot on the image evidenceOfImmunity Property evidenceOfImmunity Property evidenceOfImmunity evidenceOfImmunity Property Property immunityStatus_evidenceOfImmunity Polyline coordinates describing hotspot on the image immunityStatus Property immunityStatus Property immunityStatus immunityStatus Property Property vaccinationEvent_immunityStatus Polyline coordinates describing hotspot on the image vaccinePreventibleDisease Property vaccinePreventibleDisease Property vaccinePreventibleDisease vaccinePreventibleDisease Property Property immunityStatus_vaccinePreventibleDisease Polyline coordinates describing hotspot on the image immunityStatus Property immunityStatus Property immunityStatus immunityStatus Property Property vaccinationNonEvent_immunityStatus Polyline coordinates describing hotspot on the image Generalization Polyline coordinates describing hotspot on the image publicHealthJurisdiction Property publicHealthJurisdiction Property publicHealthJurisdiction publicHealthJurisdiction Property Property immunizationRegistrySubmission_publicHealthJurisdiction Polyline coordinates describing hotspot on the image publicHealthJurisdiction Property publicHealthJurisdiction Property publicHealthJurisdiction publicHealthJurisdiction Property Property publicHealthClient_publicHealthJurisdiction Polyline coordinates describing hotspot on the image patient Property patient Property patient patient Property Property publicHealthClient_patient Polyline coordinates describing hotspot on the image publicHealthClient Property publicHealthClient Property publicHealthClient publicHealthClient Property Property immunizationRegistrySubmission_publicHealthClient Polyline coordinates describing hotspot on the image fundingEligibility Property fundingEligibility Property fundingEligibility fundingEligibility Property Property vaccinationEvent_fundingEligibility Polyline coordinates describing hotspot on the image subjectOfRecord Property subjectOfRecord Property subjectOfRecord subjectOfRecord Property Property clinicalStatement_subjectOfRecord Polyline coordinates describing hotspot on the image patient Property patient Property patient patient Property Property immunizationHistoryList_patient Polyline coordinates describing hotspot on the image immunizationHistory Property immunizationHistory Property immunizationHistory immunizationHistory Property Property immunizationRegistrySubmission_immunizationHistory Polyline coordinates describing hotspot on the image vaccinationNonEvent Property vaccinationNonEvent Property vaccinationNonEvent vaccinationNonEvent Property Property immunizationHistoryEntry_vaccinationNonEvent Polyline coordinates describing hotspot on the image vaccinationEvent Property vaccinationEvent Property vaccinationEvent vaccinationEvent Property Property immunizationHistoryEntry_vaccinationEvent Polyline coordinates describing hotspot on the image immunizationHistoryEntry Property immunizationHistoryEntry Property immunizationHistoryEntry immunizationHistoryEntry Property Property immunizationHistoryList_immunizationHistoryEntry Polyline coordinates describing hotspot on the image Generalization Polyline coordinates describing hotspot on the image Generalization Polyline coordinates describing hotspot on the image orderedDrug Property orderedDrug Property orderedDrug orderedDrug Property Property medicationAdministrationTopic_orderedDrug Polyline coordinates describing hotspot on the image indication Property indication Property indication indication Property Property medicationAdministrationTopic_indication Polyline coordinates describing hotspot on the image exemption Property exemption Property exemption exemption Property Property medicationAdministrationTopic_exemption Polyline coordinates describing hotspot on the image contraIndication Property contraIndication Property contraIndication contraIndication Property Property medicationAdministrationTopic_contraIndication Polyline coordinates describing hotspot on the image healthConcern Property healthConcern Property healthConcern healthConcern Property Property contraIndication_healthConcern Polyline coordinates describing hotspot on the image patientCondition Property patientCondition Property patientCondition patientCondition Property Property medicationAdministrationPerformed_patientCondition Polyline coordinates describing hotspot on the image Generalization Polyline coordinates describing hotspot on the image reaction Property reaction Property reaction reaction Property Property medicationAdministrationPerformed_reaction Polyline coordinates describing hotspot on the image Generalization Polyline coordinates describing hotspot on the image Generalization Polyline coordinates describing hotspot on the image Generalization Polyline coordinates describing hotspot on the image Generalization Polyline coordinates describing hotspot on the image Generalization Polyline coordinates describing hotspot on the image Generalization Polyline coordinates describing hotspot on the image fulfillsOrder Property fulfillsOrder Property fulfillsOrder fulfillsOrder Property Property actionPerformed_fulfillsOrder Polyline coordinates describing hotspot on the image Generalization Polyline coordinates describing hotspot on the image promise Property promise Property promise promise Property Property order_promise Polyline coordinates describing hotspot on the image order Property order Property order order Property Property promise_order Polyline coordinates describing hotspot on the image Generalization Polyline coordinates describing hotspot on the image Generalization Polyline coordinates describing hotspot on the image medicationAdministrationTopic Property medicationAdministrationTopic Property medicationAdministrationTopic medicationAdministrationTopic Property Property medicationAdministrationRequest_medicationAdministrationTopic Polyline coordinates describing hotspot on the image medicationAdministrationTopic Property medicationAdministrationTopic Property medicationAdministrationTopic medicationAdministrationTopic Property Property medicationAdministrationNotPerformed_medicationAdministrationTopic Polyline coordinates describing hotspot on the image medicationAdministrationTopic Property medicationAdministrationTopic Property medicationAdministrationTopic medicationAdministrationTopic Property Property medicationAdministrationPromise_medicationAdministrationTopic Polyline coordinates describing hotspot on the image medicationAdministrationTopic Property medicationAdministrationTopic Property medicationAdministrationTopic medicationAdministrationTopic Property Property medicationAdministrationPerformed_medicationAdministrationTopic Polyline coordinates describing hotspot on the image dosage Property dosage Property dosage dosage Property Property medicationAdministrationTopic_dosage Polyline coordinates describing hotspot on the image administeredDrug Property administeredDrug Property administeredDrug administeredDrug Property Property medicationAdministrationPerformed_administeredDrug Polyline coordinates describing hotspot on the image ObservationStatement rate kind dose DoseAndRate 371113008 (varicella) 278968001 (rubella) 341112003 (mumps) 371111005 (measles) 271511000 (hepatitis B) 278971009 (hepatitis A) EvidenceOfImmunity_Serological 16541001 (yellow fever) 66071002 (viral hepatitis B) 40468003 (viral hepatitis A) 38907003 (varicella) 111852003 (vaccinia) 4834000 (typhoid fever) 76902006 (tetanus) 36653000 (rubella) 18624000 (rotavirus infection) 14168008 (rabies) 398102009 (poliomyelitis) 16814004 (pneumococcal infection) 27836007 (pertussis) 36989005 (mumps) 23511006 (meningococcal infection) 14189004 (measles) 52947006 (Japanese encephalitis) 6142004 (influenza) 240532009 (human papilloma virus) 91428005 (haemophilus influenzae) 397428000 (diphtheria) 409498004 (anthrax) EvidenceOfImmunity_HistoryOfDisease VXC8 (Member of special group) VXC7 (Rabies exposure...) VaccinationSpecialIndication RE (refused) PA (partially administered) NA (not administered) CP (complete) TreatmentCompletionStatus P (Inactive-permanently) M (Inactive-Moved or gone elsewhere) L (Inactive-Lost to follow-up) I (Inactive-unspecified) A (Active) ImmunizationRegistryStatus 08 (Historical info-public agency) 07 (Historical info-school record) 06 (Historical info-birth certificate) 05 (Historical info-other registry ) 04 (Historical info-parent’s recall ) 03 (Historical info-parent’s written record) 02 (Historical info-other provider) 01 (Historical info-source unspecified) 00 (New immunization record) ImmunizationInformationSource 91930004 (allergy to eggs) 77386006 (currently pregnant) 402306009 (allergy to aluminum) 302215000 (thrombocytopenic disorder) 300916003 (allergy to latex) 294847001 (allergy to gelatin) 294530006 (allergy to Polymyxin B) 294468006 (allergy to neomycin) 294466005 (allergy to streptomycin) 27624003 (chronic disease) 161461006 (history of purpura) VXC30 (allergy to rodent or neural protein) VXC27 (immunodeficiency) VXC26 (underlying unstable neurologic disorders...) VXC25 (history of Arthus hypersensitivity...) VXC24 (current acute illness) VXC23 (current fever) VXC22 (encephalopathy w/in 7 days of DTP or DTaP...) VXC21 (previous history of intussusception) VXC20 (allergy to previous dose of this vaccine...) VXC19 (allergy to thimerosal) VXC18 (allergy to baker’s yeast) VXC17 (allergy to 2-phenoxyethanol) VaccinationContraindication VXC3 (Tribal funds) VXC2 (State funds) VXC1 (Federal funds) PHC70 (Private funds) PHC68 (Military funds) ImmunizationFundingSource V08 (Deprecated) V07 (Local-specific eligibility) V06 (Deprecated) V05 (VFC eligible-FQHC Patient (under-insured)) V04 (VFC eligible-American Indian/Alaskan Native) V03 (VFC eligible-Uninsured) V02 (VFC eligible-Medicaid/Medicaid Managed Care) V01 (Not VFC eligible) FinancialClass RVL (Right Vastus Lateralis) RT (Right Thigh) RLFA (Right Lower Forearm) RG (Right Gluteous Medius) RD (Right Deltoid) RA (Right Arm) LVL (Left Vastus Lateralis) LT (Left Thigh) LLFA (Left Lower Forearm) LG (Left Gluteous Medius) LD (Left Deltoid) LA (Left Arm) AdministrativeSite volume Vehicle preparationTime doseForm dispenseUnitType description componentCount LocallyManufacturedProduct amount Additive packageType packageCapacity nationalDrugCode name description codeModifier code capType PackagedMedicinalProduct lotSize lotId expirationDate ManufacturingLot unitPrice storageCondition identifier MedicinalProductInstance newDrugApplicationId isOverTheCounter investigationalNewDrugId controlledSubstanceSchedule auxilliaryLabel MedicinalProduct vaccineCode Vaccine seriesName numberOfDoses PatientSeries status doseNumber TargetDose status identifier doseStatusReason doseStatus description date ImmunizationEvaluation serialNumber reference language documentType dateOfPublication VaccineInformationStatement dateOfPresentation PatientDocumentPresentation evidenceCategory relevantDate EvidenceOfImmunity dateOfDetermination statusCategory ImmunityStatus NotificationReport PublicHealthJurisdiction status endDate beginDate clientIdentifier PublicHealthClient financialClassAssessmentDate programEligibility ImmunizationFundingEligibility ImmunizationForecast ImmunizationForecast status patientId mothersIdentifier endDate beginDate Patient ImmunizationRegistrySubmission informationSource ImmunizationHistoryEntry ImmunizationHistoryList dateRecorded VaccinationNonEvent subpotentReason numberInSeries isSubpotent fundingSource VaccinationEvent OrderablePharmacyItem kind Indication remarks reason issuedBy identifier effectiveTime dateAsserted Exemption code ContraIndication HealthConcern severity reaction onsetDateTime note exposureRoute description certainty ReactionObservation scheduledPerformanceTime cancellationTimeframe canceledBy cancelDate ActionNotPerformed ActionPerformed Promise Order verified signed recorded cosigned topicCode temporalContext subjectGroup sourceSystem sourceRecordType recordStatus note encounter contextCode contentVersion ClinicalStatement wasReported usingDevice supportingInformation scope relevantHistory reasonReference reasonNarrative reasonCode precondition outputFinding method location justification intent insurance instantiatesUri instantiatesCanonical inputFinding indication description currentStatus category ActionStatement reasonNotGiven notGiven MedicationAdministrationNotPerformed quantityOrdered MedicationAdministrationRequest systemEntryDateTime quantityGiven notGiven category MedicationAdministrationPerformed timing text strengthVolume strength sequence route patientInstruction method maxDosePerPeriod maxDosePerLifetime maxDosePerAdministration doseForm bodySite asNeeded additionalInstruction Dosage MedicationAdministrationTopic administrationTagId administeredBarcodeId AdministeredDrug MedicationAdministrationPromise

Classifiers
ActNoImmunizationReason_V3 ActNoImmunizationReason_V3
AdministrativeSite AdministrativeSite
EvidenceOfImmunity EvidenceOfImmunity
EvidenceOfImmunity_HistoryOfDisease EvidenceOfImmunity_HistoryOfDisease
EvidenceOfImmunity_Serological EvidenceOfImmunity_Serological
FinancialClass FinancialClass
ImmunityStatus ImmunityStatus
ImmunizationDoseEvaluation ImmunizationDoseEvaluation
ImmunizationFundingEligibility ImmunizationFundingEligibility
ImmunizationFundingSource ImmunizationFundingSource
ImmunizationHistoryEntry ImmunizationHistoryEntry
ImmunizationHistoryList ImmunizationHistoryList
ImmunizationInformationSource ImmunizationInformationSource
ImmunizationRegistryStatus ImmunizationRegistryStatus
ImmunizationRegistrySubmission ImmunizationRegistrySubmission
ImmunizationScheduleIdentifier ImmunizationScheduleIdentifier
ImmunizationSeriesStatus ImmunizationSeriesStatus
ImmunizationTargetDoseFulfillment ImmunizationTargetDoseFulfillment
ManufacturersOfVaccines ManufacturersOfVaccines
PatientDocumentPresentation PatientDocumentPresentation
PatientImmunityCategory PatientImmunityCategory
PatientSeries PatientSeries
Route Of Administration (PHVS_IIS) Route Of Administration (PHVS_IIS)
SubstanceRefusalReason SubstanceRefusalReason
TargetDose TargetDose
TreatmentCompletionStatus TreatmentCompletionStatus
VaccinationContraindication VaccinationContraindication
VaccinationEvent VaccinationEvent
VaccinationNonEvent VaccinationNonEvent
VaccinationReaction VaccinationReaction
VaccinationSpecialIndication VaccinationSpecialIndication
Vaccine Vaccine
VaccineInformationStatement VaccineInformationStatement
VaccinesAdministered VaccinesAdministered
VIS Bar Codes (IIS) VIS Bar Codes (IIS)
VocabContext VocabContext

Diagrams
_Immunization _Immunization

Properties:

Alias
Keywords
NameImmunization
Name Expression
NamespaceFHIM
Nesting PackageFHIM
Owned Template Signature
OwnerFHIM
Owning Template Parameter
Qualified NameFHIM::Immunization
Stereotype
Template Parameter
VisibilityPublic
OverviewTopPackageElement
Immunization UML Documentation