Skip to main content

HS.FHIR.DTL.vDSTU2.Model.Resource.Immunization

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

Immunization event information.

Property 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 XMLPROJECTION = ELEMENT;
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.

Properties

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

Vaccination administration date.

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

Amount of vaccine administered.

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

Encounter administered as part of.

Encounter

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

Vaccine expiration date.

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

Administration/non-administration reasons.

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

Business identifier.

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

Where vaccination occurred.

Location

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

Vaccine lot number.

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

Vaccine manufacturer.

Organization

Property methods: manufacturerGet(), manufacturerGetSwizzled(), manufacturerIsValid(), manufacturerNewObject(), manufacturerSet()
property note as list of HS.FHIR.DTL.vDSTU2.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Annotation

Vaccination notes.

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

Who was immunized.

Patient

Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property performer as HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "performer", XMLPROJECTION = "ELEMENT");
Reference

Who administered vaccine.

Practitioner

Property methods: performerGet(), performerGetSwizzled(), performerIsValid(), performerNewObject(), performerSet()
property reaction as list of HS.FHIR.DTL.vDSTU2.Model.Element.Immunization.reaction (XMLNAME = "reaction", XMLPROJECTION = "ELEMENT");
BackboneElement

Details of a reaction that follows immunization.

Property methods: reactionBuildValueArray(), reactionCollectionToDisplay(), reactionCollectionToOdbc(), reactionDisplayToCollection(), reactionGet(), reactionGetObject(), reactionGetObjectId(), reactionGetSwizzled(), reactionIsValid(), reactionOdbcToCollection(), reactionSet(), reactionSetObject(), reactionSetObjectId()
property reported as %Boolean (XMLNAME = "reported", XMLPROJECTION = "ATTRIBUTE") [ Required ];
boolean

Indicates a self-reported record.

Property methods: reportedDisplayToLogical(), reportedGet(), reportedIsValid(), reportedLogicalToDisplay(), reportedLogicalToXSD(), reportedNormalize(), reportedSet(), reportedXSDToLogical()
property requester as HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "requester", XMLPROJECTION = "ELEMENT");
Reference

Who ordered vaccination.

Practitioner

Property methods: requesterGet(), requesterGetSwizzled(), requesterIsValid(), requesterNewObject(), requesterSet()
property route as HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "route", XMLPROJECTION = "ELEMENT");
CodeableConcept

How vaccine entered body.

any FHIR2 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.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "site", XMLPROJECTION = "ELEMENT");
CodeableConcept

Body site vaccine was administered.

any FHIR2 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 ];
code

in-progress | on-hold | completed | entered-in-error | stopped

medication-admin-status is the REQUIRED FHIR2 ValueSet for codes; you may NOT extend medication-admin-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.vDSTU2.Model.Element.Immunization.vaccinationProtocol (XMLNAME = "vaccinationProtocol", XMLPROJECTION = "ELEMENT");
BackboneElement

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.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "vaccineCode", XMLPROJECTION = "ELEMENT") [ Required ];
CodeableConcept

Vaccine product administered.

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

Property methods: vaccineCodeGet(), vaccineCodeGetSwizzled(), vaccineCodeIsValid(), vaccineCodeNewObject(), vaccineCodeSet()
property wasNotGiven as %Boolean (XMLNAME = "wasNotGiven", XMLPROJECTION = "ATTRIBUTE") [ Required ];
boolean

Flag for whether immunization was given.

Property methods: wasNotGivenDisplayToLogical(), wasNotGivenGet(), wasNotGivenIsValid(), wasNotGivenLogicalToDisplay(), wasNotGivenLogicalToXSD(), wasNotGivenNormalize(), wasNotGivenSet(), wasNotGivenXSDToLogical()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab