Skip to main content


class HS.FHIR.DTL.vSTU3.Model.Resource.Immunization extends HS.FHIR.DTL.vSTU3.Model.Base.DomainResource

Describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.

Property Inventory


Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter XMLNAME = Immunization;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = Immunization;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.


property date as %String (MAXLEN = 1000000, XMLNAME = "date", XMLPROJECTION = "ATTRIBUTE");

Vaccination administration date.

Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
property doseQuantity as HS.FHIR.DTL.vSTU3.Model.Datatype.SimpleQuantity (XMLNAME = "doseQuantity", XMLPROJECTION = "ELEMENT");

Amount of vaccine administered.

Property methods: doseQuantityGet(), doseQuantityGetSwizzled(), doseQuantityIsValid(), doseQuantityNewObject(), doseQuantitySet()
property encounter as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "encounter", XMLPROJECTION = "ELEMENT");

Encounter administered as part of.


Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property expirationDate as %String (MAXLEN = 1000000, XMLNAME = "expirationDate", XMLPROJECTION = "ATTRIBUTE");

Vaccine expiration date.

Property methods: expirationDateDisplayToLogical(), expirationDateGet(), expirationDateIsValid(), expirationDateLogicalToDisplay(), expirationDateLogicalToOdbc(), expirationDateNormalize(), expirationDateSet()
property explanation as HS.FHIR.DTL.vSTU3.Model.Element.Immunization.explanation (XMLNAME = "explanation", XMLPROJECTION = "ELEMENT");

Administration/non-administration reasons.

Property methods: explanationGet(), explanationGetSwizzled(), explanationIsValid(), explanationNewObject(), explanationSet()
property identifier as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Business identifier.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property location as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "location", XMLPROJECTION = "ELEMENT");

Where vaccination occurred.


Property methods: locationGet(), locationGetSwizzled(), locationIsValid(), locationNewObject(), locationSet()
property lotNumber as %String (MAXLEN = 1000000, XMLNAME = "lotNumber", XMLPROJECTION = "ATTRIBUTE");

Vaccine lot number.

Property methods: lotNumberDisplayToLogical(), lotNumberGet(), lotNumberIsValid(), lotNumberLogicalToDisplay(), lotNumberLogicalToOdbc(), lotNumberNormalize(), lotNumberSet()
property manufacturer as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "manufacturer", XMLPROJECTION = "ELEMENT");

Vaccine manufacturer.


Property methods: manufacturerGet(), manufacturerGetSwizzled(), manufacturerIsValid(), manufacturerNewObject(), manufacturerSet()
property notGiven as %Boolean (XMLNAME = "notGiven", XMLPROJECTION = "ATTRIBUTE") [ Required ];

Flag for whether immunization was given.

Property methods: notGivenDisplayToLogical(), notGivenGet(), notGivenIsValid(), notGivenLogicalToDisplay(), notGivenLogicalToXSD(), notGivenNormalize(), notGivenSet(), notGivenXSDToLogical()
property note as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");

Vaccination notes.

Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property patient as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT") [ Required ];

Who was immunized.


Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property practitioner as list of HS.FHIR.DTL.vSTU3.Model.Element.Immunization.practitioner (XMLNAME = "practitioner", XMLPROJECTION = "ELEMENT");

Who performed event.

Property methods: practitionerBuildValueArray(), practitionerCollectionToDisplay(), practitionerCollectionToOdbc(), practitionerDisplayToCollection(), practitionerGet(), practitionerGetObject(), practitionerGetObjectId(), practitionerGetSwizzled(), practitionerIsValid(), practitionerOdbcToCollection(), practitionerSet(), practitionerSetObject(), practitionerSetObjectId()
property primarySource as %Boolean (XMLNAME = "primarySource", XMLPROJECTION = "ATTRIBUTE") [ Required ];

Indicates context the data was recorded in.

Property methods: primarySourceDisplayToLogical(), primarySourceGet(), primarySourceIsValid(), primarySourceLogicalToDisplay(), primarySourceLogicalToXSD(), primarySourceNormalize(), primarySourceSet(), primarySourceXSDToLogical()
property reaction as list of HS.FHIR.DTL.vSTU3.Model.Element.Immunization.reaction (XMLNAME = "reaction", XMLPROJECTION = "ELEMENT");

Details of a reaction that follows immunization.

Property methods: reactionBuildValueArray(), reactionCollectionToDisplay(), reactionCollectionToOdbc(), reactionDisplayToCollection(), reactionGet(), reactionGetObject(), reactionGetObjectId(), reactionGetSwizzled(), reactionIsValid(), reactionOdbcToCollection(), reactionSet(), reactionSetObject(), reactionSetObjectId()
property reportOrigin as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "reportOrigin", XMLPROJECTION = "ELEMENT");

Indicates the source of a secondarily reported record.

any FHIR3 code may be used; immunization-origin shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: reportOriginGet(), reportOriginGetSwizzled(), reportOriginIsValid(), reportOriginNewObject(), reportOriginSet()
property route as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "route", XMLPROJECTION = "ELEMENT");

How vaccine entered body.

any FHIR3 code may be used; immunization-route shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: routeGet(), routeGetSwizzled(), routeIsValid(), routeNewObject(), routeSet()
property site as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "site", XMLPROJECTION = "ELEMENT");

Body site vaccine was administered.

any FHIR3 code may be used; immunization-site shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: siteGet(), siteGetSwizzled(), siteIsValid(), siteNewObject(), siteSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];

completed | entered-in-error

immunization-status is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend immunization-status and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property vaccinationProtocol as list of HS.FHIR.DTL.vSTU3.Model.Element.Immunization.vaccinationProtocol (XMLNAME = "vaccinationProtocol", XMLPROJECTION = "ELEMENT");

What protocol was followed.

Property methods: vaccinationProtocolBuildValueArray(), vaccinationProtocolCollectionToDisplay(), vaccinationProtocolCollectionToOdbc(), vaccinationProtocolDisplayToCollection(), vaccinationProtocolGet(), vaccinationProtocolGetObject(), vaccinationProtocolGetObjectId(), vaccinationProtocolGetSwizzled(), vaccinationProtocolIsValid(), vaccinationProtocolOdbcToCollection(), vaccinationProtocolSet(), vaccinationProtocolSetObject(), vaccinationProtocolSetObjectId()
property vaccineCode as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "vaccineCode", XMLPROJECTION = "ELEMENT") [ Required ];

Vaccine product administered.

any FHIR3 code may be used; vaccine-code shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: vaccineCodeGet(), vaccineCodeGetSwizzled(), vaccineCodeIsValid(), vaccineCodeNewObject(), vaccineCodeSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab