Skip to main content

HS.FHIR.vSTU3.Model.Resource.Immunization

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

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
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.
If the element is present, it must have either a @value, an @id, or extensions

Property Inventory

Method Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
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.

Properties

property date as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "date", XMLPROJECTION = "ELEMENT");
Date vaccine administered or was to be administered.
Property methods: dateGet(), dateGetSwizzled(), dateIsValid(), dateNewObject(), dateSet()
property doseQuantity as HS.FHIR.vSTU3.Model.Base.Quantity (XMLNAME = "doseQuantity", XMLPROJECTION = "ELEMENT");
The quantity of vaccine product that was administered.
Property methods: doseQuantityGet(), doseQuantityGetSwizzled(), doseQuantityIsValid(), doseQuantityNewObject(), doseQuantitySet()
property encounter as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "encounter", XMLPROJECTION = "ELEMENT");
The visit or admission or other contact between patient and health care provider the immunization was performed as part of.
Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property expirationDate as HS.FHIR.vSTU3.Model.Datatype.Date (XMLNAME = "expirationDate", XMLPROJECTION = "ELEMENT");
Date vaccine batch expires.
Property methods: expirationDateGet(), expirationDateGetSwizzled(), expirationDateIsValid(), expirationDateNewObject(), expirationDateSet()
property explanation as HS.FHIR.vSTU3.Model.Resource.Immunization.Explanation (XMLNAME = "explanation", XMLPROJECTION = "ELEMENT");
Reasons why a vaccine was or was not administered.
Property methods: explanationGet(), explanationGetSwizzled(), explanationIsValid(), explanationNewObject(), explanationSet()
property identifier as list of HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
A unique identifier assigned to this immunization record.
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property location as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "location", XMLPROJECTION = "ELEMENT");
The service delivery location where the vaccine administration occurred.
Property methods: locationGet(), locationGetSwizzled(), locationIsValid(), locationNewObject(), locationSet()
property lotNumber as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "lotNumber", XMLPROJECTION = "ELEMENT");
Lot number of the vaccine product.
Property methods: lotNumberGet(), lotNumberGetSwizzled(), lotNumberIsValid(), lotNumberNewObject(), lotNumberSet()
property manufacturer as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "manufacturer", XMLPROJECTION = "ELEMENT");
Name of vaccine manufacturer.
Property methods: manufacturerGet(), manufacturerGetSwizzled(), manufacturerIsValid(), manufacturerNewObject(), manufacturerSet()
property notGiven as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "notGiven", XMLPROJECTION = "ELEMENT") [ Required ];
Indicates if the vaccination was or was not given.
Property methods: notGivenGet(), notGivenGetSwizzled(), notGivenIsValid(), notGivenNewObject(), notGivenSet()
property note as list of HS.FHIR.vSTU3.Model.Base.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Extra information about the immunization that is not conveyed by the other attributes.
Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property patient as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT") [ Required ];
The patient who either received or did not receive the immunization.
Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property practitioner as list of HS.FHIR.vSTU3.Model.Resource.Immunization.Practitioner (XMLNAME = "practitioner", XMLPROJECTION = "ELEMENT");
Indicates who or what performed the event.
Property methods: practitionerBuildValueArray(), practitionerCollectionToDisplay(), practitionerCollectionToOdbc(), practitionerDisplayToCollection(), practitionerGet(), practitionerGetObject(), practitionerGetObjectId(), practitionerGetSwizzled(), practitionerIsValid(), practitionerOdbcToCollection(), practitionerSet(), practitionerSetObject(), practitionerSetObjectId()
property primarySource as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "primarySource", XMLPROJECTION = "ELEMENT") [ Required ];
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.
Property methods: primarySourceGet(), primarySourceGetSwizzled(), primarySourceIsValid(), primarySourceNewObject(), primarySourceSet()
property reaction as list of HS.FHIR.vSTU3.Model.Resource.Immunization.Reaction (XMLNAME = "reaction", XMLPROJECTION = "ELEMENT");
Categorical data indicating that an adverse event is associated in time to an immunization.
Property methods: reactionBuildValueArray(), reactionCollectionToDisplay(), reactionCollectionToOdbc(), reactionDisplayToCollection(), reactionGet(), reactionGetObject(), reactionGetObjectId(), reactionGetSwizzled(), reactionIsValid(), reactionOdbcToCollection(), reactionSet(), reactionSetObject(), reactionSetObjectId()
property reportOrigin as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "reportOrigin", XMLPROJECTION = "ELEMENT");
The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
Property methods: reportOriginGet(), reportOriginGetSwizzled(), reportOriginIsValid(), reportOriginNewObject(), reportOriginSet()
property route as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "route", XMLPROJECTION = "ELEMENT");
The path by which the vaccine product is taken into the body.
Property methods: routeGet(), routeGetSwizzled(), routeIsValid(), routeNewObject(), routeSet()
property site as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "site", XMLPROJECTION = "ELEMENT");
Body site where vaccine was administered.
Property methods: siteGet(), siteGetSwizzled(), siteIsValid(), siteNewObject(), siteSet()
property status as HS.FHIR.vSTU3.Model.Base.ImmunizationStatusCodes (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
Indicates the current status of the vaccination event.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property vaccinationProtocol as list of HS.FHIR.vSTU3.Model.Resource.Immunization.VaccinationProtocol (XMLNAME = "vaccinationProtocol", XMLPROJECTION = "ELEMENT");
Contains information about the protocol(s) under which the vaccine was administered.
Property methods: vaccinationProtocolBuildValueArray(), vaccinationProtocolCollectionToDisplay(), vaccinationProtocolCollectionToOdbc(), vaccinationProtocolDisplayToCollection(), vaccinationProtocolGet(), vaccinationProtocolGetObject(), vaccinationProtocolGetObjectId(), vaccinationProtocolGetSwizzled(), vaccinationProtocolIsValid(), vaccinationProtocolOdbcToCollection(), vaccinationProtocolSet(), vaccinationProtocolSetObject(), vaccinationProtocolSetObjectId()
property vaccineCode as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "vaccineCode", XMLPROJECTION = "ELEMENT") [ Required ];
Vaccine that was administered or was to be administered.
Property methods: vaccineCodeGet(), vaccineCodeGetSwizzled(), vaccineCodeIsValid(), vaccineCodeNewObject(), vaccineCodeSet()

Methods

deprecated method SetDate(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "date" property.
deprecated method SetDoseQuantity(pValue As %String = "", pComparator As %String = "", pUnit As %String = "", pSystem As %String = "", pCode As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "doseQuantity" property.
deprecated method SetEncounter(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "encounter" property.
deprecated method SetExpirationDate(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "expirationDate" property.
deprecated method SetIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "identifier" property.
deprecated method SetLocation(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "location" property.
deprecated method SetLotNumber(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "lotNumber" property.
deprecated method SetManufacturer(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "manufacturer" property.
deprecated method SetNotGiven(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "notGiven" property.
deprecated method SetPatient(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "patient" property.
deprecated method SetPrimarySource(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "primarySource" property.
deprecated method SetReportOrigin(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "reportOrigin" property.
deprecated method SetRoute(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "route" property.
deprecated method SetSite(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "site" property.
deprecated method SetStatus(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "status" property.
deprecated method SetVaccineCode(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "vaccineCode" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab