Data Model Libraries
    Preparing search index...

    Class Immunization

    Immunization Class

    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.

    FHIR Specification

    • Short: Immunization event information
    • Definition: 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.
    • FHIR Version: 4.3.0

    FHIR Immunization

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? eventStatusEnum status statusReason? vaccineCode patient encounter? occurrence recorded? primarySource? reportOrigin? location? manufacturer? lotNumber? expirationDate? site? route? doseQuantity? performer? note? reasonCode? reasonReference? isSubpotent? subpotentReason? education? programEligibility? fundingSource? reaction? protocolApplied?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getStatusReason setStatusReason hasStatusReason getVaccineCode setVaccineCode hasVaccineCode getPatient setPatient hasPatient getEncounter setEncounter hasEncounter getOccurrence setOccurrence hasOccurrence getOccurrenceDateTimeType hasOccurrenceDateTimeType getOccurrenceStringType hasOccurrenceStringType getRecordedElement setRecordedElement hasRecordedElement getRecorded setRecorded hasRecorded getPrimarySourceElement setPrimarySourceElement hasPrimarySourceElement getPrimarySource setPrimarySource hasPrimarySource getReportOrigin setReportOrigin hasReportOrigin getLocation setLocation hasLocation getManufacturer setManufacturer hasManufacturer getLotNumberElement setLotNumberElement hasLotNumberElement getLotNumber setLotNumber hasLotNumber getExpirationDateElement setExpirationDateElement hasExpirationDateElement getExpirationDate setExpirationDate hasExpirationDate getSite setSite hasSite getRoute setRoute hasRoute getDoseQuantity setDoseQuantity hasDoseQuantity getPerformer setPerformer addPerformer hasPerformer getNote setNote addNote hasNote getReasonCode setReasonCode addReasonCode hasReasonCode getReasonReference setReasonReference addReasonReference hasReasonReference getIsSubpotentElement setIsSubpotentElement hasIsSubpotentElement getIsSubpotent setIsSubpotent hasIsSubpotent getSubpotentReason setSubpotentReason addSubpotentReason hasSubpotentReason getEducation setEducation addEducation hasEducation getProgramEligibility setProgramEligibility addProgramEligibility hasProgramEligibility getFundingSource setFundingSource hasFundingSource getReaction setReaction addReaction hasReaction getProtocolApplied setProtocolApplied addProtocolApplied hasProtocolApplied fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initPerformer initNote initReasonCode initReasonReference initSubpotentReason initEducation initProgramEligibility initReaction initProtocolApplied

    Constructors

    Properties

    identifier?: Identifier[]

    Immunization.identifier Element

    FHIR Specification

    • Short: Business identifier
    • Definition: A unique identifier assigned to this immunization record.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    eventStatusEnum: EventStatusEnum

    FHIR CodeSystem: EventStatus

    EventStatusEnum

    status: null | EnumCodeType

    Immunization.status Element

    FHIR Specification

    • Short: completed | entered-in-error | not-done
    • Definition: Indicates the current status of the immunization event.
    • Comment: Will generally be set to show that the immunization has been completed or not done. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labeled as a modifier because it is a status element that contains statuses entered-in-error and not-done which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: EventStatusEnum

    statusReason?: CodeableConcept

    Immunization.statusReason Element

    FHIR Specification

    • Short: Reason not done
    • Definition: Indicates the reason the immunization event was not performed.
    • Comment: This is generally only used for the status of "not-done". The reason for performing the immunization event is captured in reasonCode, not here.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    vaccineCode: null | CodeableConcept

    Immunization.vaccineCode Element

    FHIR Specification

    • Short: Vaccine product administered
    • Definition: Vaccine that was administered or was to be administered.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    patient: null | Reference

    Immunization.patient Element

    FHIR Specification

    • Short: Who was immunized
    • Definition: The patient who either received or did not receive the immunization.
    • FHIR Type: Reference
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    encounter?: Reference

    Immunization.encounter Element

    FHIR Specification

    • Short: Encounter immunization was part of
    • Definition: The visit or admission or other contact between patient and health care provider the immunization was performed as part of.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    occurrence: null | IDataType

    Immunization.occurrence[x] Element

    @ChoiceDataTypesMeta('Immunization.occurrence[x]', ['dateTime','string',]

    FHIR Specification

    • Short: Vaccine administration date
    • Definition: Date vaccine administered or was to be administered.
    • Comment: When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose.
    • FHIR Types: 'dateTime', 'string',
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    recorded?: DateTimeType

    Immunization.recorded Element

    FHIR Specification

    • Short: When the immunization was first captured in the subject's record
    • Definition: The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    primarySource?: BooleanType

    Immunization.primarySource Element

    FHIR Specification

    • Short: Indicates context the data was recorded in
    • Definition: 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.
    • Comment: Reflects the "reliability" of the content.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    reportOrigin?: CodeableConcept

    Immunization.reportOrigin Element

    FHIR Specification

    • Short: Indicates the source of a secondarily reported record
    • Definition: The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
    • Comment: Should not be populated if primarySource = True, not required even if primarySource = False.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    location?: Reference

    Immunization.location Element

    FHIR Specification

    • Short: Where immunization occurred
    • Definition: The service delivery location where the vaccine administration occurred.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    manufacturer?: Reference

    Immunization.manufacturer Element

    FHIR Specification

    lotNumber?: StringType

    Immunization.lotNumber Element

    FHIR Specification

    • Short: Vaccine lot number
    • Definition: Lot number of the vaccine product.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    expirationDate?: DateType

    Immunization.expirationDate Element

    FHIR Specification

    • Short: Vaccine expiration date
    • Definition: Date vaccine batch expires.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    site?: CodeableConcept

    Immunization.site Element

    FHIR Specification

    • Short: Body site vaccine was administered
    • Definition: Body site where vaccine was administered.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    route?: CodeableConcept

    Immunization.route Element

    FHIR Specification

    • Short: How vaccine entered body
    • Definition: The path by which the vaccine product is taken into the body.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    doseQuantity?: Quantity

    Immunization.doseQuantity Element

    FHIR Specification

    • Short: Amount of vaccine administered
    • Definition: The quantity of vaccine product that was administered.
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    performer?: ImmunizationPerformerComponent[]

    Immunization.performer Element

    FHIR Specification

    • Short: Who performed event
    • Definition: Indicates who performed the immunization event.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    note?: Annotation[]

    Immunization.note Element

    FHIR Specification

    • Short: Additional immunization notes
    • Definition: Extra information about the immunization that is not conveyed by the other attributes.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    reasonCode?: CodeableConcept[]

    Immunization.reasonCode Element

    FHIR Specification

    • Short: Why immunization occurred
    • Definition: Reasons why the vaccine was administered.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    reasonReference?: Reference[]

    Immunization.reasonReference Element

    FHIR Specification

    isSubpotent?: BooleanType

    Immunization.isSubpotent Element

    FHIR Specification

    • Short: Dose potency
    • Definition: Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
    • Comment: Typically, the recognition of the dose being sub-potent is retrospective, after the administration (ex. notification of a manufacturer recall after administration). However, in the case of a partial administration (the patient moves unexpectedly and only some of the dose is actually administered), subpotency may be recognized immediately, but it is still important to record the event.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: This element is labeled as a modifier because an immunization event with a subpotent vaccine doesn't protect the patient the same way as a potent dose.
    • isSummary: true
    subpotentReason?: CodeableConcept[]

    Immunization.subpotentReason Element

    FHIR Specification

    • Short: Reason for being subpotent
    • Definition: Reason why a dose is considered to be subpotent.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    education?: ImmunizationEducationComponent[]

    Immunization.education Element

    FHIR Specification

    • Short: Educational material presented to patient
    • Definition: Educational material presented to the patient (or guardian) at the time of vaccine administration.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    programEligibility?: CodeableConcept[]

    Immunization.programEligibility Element

    FHIR Specification

    • Short: Patient eligibility for a vaccination program
    • Definition: Indicates a patient's eligibility for a funding program.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    fundingSource?: CodeableConcept

    Immunization.fundingSource Element

    FHIR Specification

    • Short: Funding source for the vaccine
    • Definition: 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).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    reaction?: ImmunizationReactionComponent[]

    Immunization.reaction Element

    FHIR Specification

    • Short: Details of a reaction that follows immunization
    • Definition: Categorical data indicating that an adverse event is associated in time to an immunization.
    • Comment: A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new AllergyIntolerance resource instance as most systems will not query against past Immunization.reaction elements.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    protocolApplied?: ImmunizationProtocolAppliedComponent[]

    Immunization.protocolApplied Element

    FHIR Specification

    • Short: Protocol followed by the provider
    • Definition: The protocol (set of recommendations) being followed by the provider who administered the dose.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided Immunization JSON to instantiate the Immunization data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR Immunization

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Immunization

      Returns undefined | Immunization

      Immunization data model or undefined for Immunization

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Reference array value to the reasonReference property.

      Parameters

      • value: undefined | Reference[]

        the reasonReference array value

      Returns this

      this

      @ReferenceTargets('Immunization.reasonReference', ['Condition','Observation','DiagnosticReport',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetStatusReasonsetStatusReasonhasStatusReasongetVaccineCodesetVaccineCodehasVaccineCodegetPatientsetPatienthasPatientgetEncountersetEncounterhasEncountergetOccurrencesetOccurrencehasOccurrencegetOccurrenceDateTimeTypehasOccurrenceDateTimeTypegetOccurrenceStringTypehasOccurrenceStringTypegetRecordedElementsetRecordedElementhasRecordedElementgetRecordedsetRecordedhasRecordedgetPrimarySourceElementsetPrimarySourceElementhasPrimarySourceElementgetPrimarySourcesetPrimarySourcehasPrimarySourcegetReportOriginsetReportOriginhasReportOrigingetLocationsetLocationhasLocationgetManufacturersetManufacturerhasManufacturergetLotNumberElementsetLotNumberElementhasLotNumberElementgetLotNumbersetLotNumberhasLotNumbergetExpirationDateElementsetExpirationDateElementhasExpirationDateElementgetExpirationDatesetExpirationDatehasExpirationDategetSitesetSitehasSitegetRoutesetRoutehasRoutegetDoseQuantitysetDoseQuantityhasDoseQuantitygetPerformersetPerformeraddPerformerhasPerformergetNotesetNoteaddNotehasNotegetReasonCodesetReasonCodeaddReasonCodehasReasonCodegetReasonReferencesetReasonReferenceaddReasonReferencehasReasonReferencegetIsSubpotentElementsetIsSubpotentElementhasIsSubpotentElementgetIsSubpotentsetIsSubpotenthasIsSubpotentgetSubpotentReasonsetSubpotentReasonaddSubpotentReasonhasSubpotentReasongetEducationsetEducationaddEducationhasEducationgetProgramEligibilitysetProgramEligibilityaddProgramEligibilityhasProgramEligibilitygetFundingSourcesetFundingSourcehasFundingSourcegetReactionsetReactionaddReactionhasReactiongetProtocolAppliedsetProtocolAppliedaddProtocolAppliedhasProtocolAppliedfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitPerformerinitNoteinitReasonCodeinitReasonReferenceinitSubpotentReasoninitEducationinitProgramEligibilityinitReactioninitProtocolApplied