Skip to main content
AskMe (beta)
Loading icon
Responses may be inaccurate. Learn more about AskMe.

HS.FHIR.DTL.vR4.Model.Resource.Immunization

class HS.FHIR.DTL.vR4.Model.Resource.Immunization extends HS.FHIR.DTL.vR4.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 doseQuantity as HS.FHIR.DTL.vR4.Model.Datatype.Quantity (XMLNAME = "doseQuantity", XMLPROJECTION = "ELEMENT");
Quantity

Amount of vaccine administered.

Property methods: doseQuantityGet(), doseQuantityGetSwizzled(), doseQuantityIsValid(), doseQuantityNewObject(), doseQuantitySet()
property education as list of HS.FHIR.DTL.vR4.Model.Element.Immunization.education (XMLNAME = "education", XMLPROJECTION = "ELEMENT");
BackboneElement

Educational material presented to patient.

Property methods: educationBuildValueArray(), educationCollectionToDisplay(), educationCollectionToOdbc(), educationDisplayToCollection(), educationGet(), educationGetObject(), educationGetObjectId(), educationGetSwizzled(), educationIsValid(), educationOdbcToCollection(), educationSet(), educationSetObject(), educationSetObjectId()
property encounter as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "encounter", XMLPROJECTION = "ELEMENT");
Reference

Encounter immunization was 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 fundingSource as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "fundingSource", XMLPROJECTION = "ELEMENT");
CodeableConcept

Funding source for the vaccine.

any FHIR4 code may be used; immunization-funding-source shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: fundingSourceGet(), fundingSourceGetSwizzled(), fundingSourceIsValid(), fundingSourceNewObject(), fundingSourceSet()
property identifier as list of HS.FHIR.DTL.vR4.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 isSubpotent as %Boolean (XMLNAME = "isSubpotent", XMLPROJECTION = "ATTRIBUTE");
boolean

Dose potency.

Property methods: isSubpotentDisplayToLogical(), isSubpotentGet(), isSubpotentIsValid(), isSubpotentLogicalToDisplay(), isSubpotentLogicalToXSD(), isSubpotentNormalize(), isSubpotentSet(), isSubpotentXSDToLogical()
property location as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "location", XMLPROJECTION = "ELEMENT");
Reference

Where immunization 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.vR4.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.vR4.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Annotation

Additional immunization notes.

Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property occurrenceDateTime as %String (MAXLEN = 1000000, XMLNAME = "occurrenceDateTime", XMLPROJECTION = "ATTRIBUTE") [ Required ];
dateTime

Vaccine administration date.

Property methods: occurrenceDateTimeDisplayToLogical(), occurrenceDateTimeGet(), occurrenceDateTimeIsValid(), occurrenceDateTimeLogicalToDisplay(), occurrenceDateTimeLogicalToOdbc(), occurrenceDateTimeNormalize(), occurrenceDateTimeSet()
property occurrenceString as %String (MAXLEN = 1000000, XMLNAME = "occurrenceString", XMLPROJECTION = "ATTRIBUTE") [ Required ];
string

Vaccine administration date.

Property methods: occurrenceStringDisplayToLogical(), occurrenceStringGet(), occurrenceStringIsValid(), occurrenceStringLogicalToDisplay(), occurrenceStringLogicalToOdbc(), occurrenceStringNormalize(), occurrenceStringSet()
property patient as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

Who was immunized.

Patient

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

Who performed event.

Property methods: performerBuildValueArray(), performerCollectionToDisplay(), performerCollectionToOdbc(), performerDisplayToCollection(), performerGet(), performerGetObject(), performerGetObjectId(), performerGetSwizzled(), performerIsValid(), performerOdbcToCollection(), performerSet(), performerSetObject(), performerSetObjectId()
property primarySource as %Boolean (XMLNAME = "primarySource", XMLPROJECTION = "ATTRIBUTE");
boolean

Indicates context the data was recorded in.

Property methods: primarySourceDisplayToLogical(), primarySourceGet(), primarySourceIsValid(), primarySourceLogicalToDisplay(), primarySourceLogicalToXSD(), primarySourceNormalize(), primarySourceSet(), primarySourceXSDToLogical()
property programEligibility as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "programEligibility", XMLPROJECTION = "ELEMENT");
CodeableConcept

Patient eligibility for a vaccination program.

any FHIR4 code may be used; immunization-program-eligibility shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: programEligibilityBuildValueArray(), programEligibilityCollectionToDisplay(), programEligibilityCollectionToOdbc(), programEligibilityDisplayToCollection(), programEligibilityGet(), programEligibilityGetObject(), programEligibilityGetObjectId(), programEligibilityGetSwizzled(), programEligibilityIsValid(), programEligibilityOdbcToCollection(), programEligibilitySet(), programEligibilitySetObject(), programEligibilitySetObjectId()
property protocolApplied as list of HS.FHIR.DTL.vR4.Model.Element.Immunization.protocolApplied (XMLNAME = "protocolApplied", XMLPROJECTION = "ELEMENT");
BackboneElement

Protocol followed by the provider.

Property methods: protocolAppliedBuildValueArray(), protocolAppliedCollectionToDisplay(), protocolAppliedCollectionToOdbc(), protocolAppliedDisplayToCollection(), protocolAppliedGet(), protocolAppliedGetObject(), protocolAppliedGetObjectId(), protocolAppliedGetSwizzled(), protocolAppliedIsValid(), protocolAppliedOdbcToCollection(), protocolAppliedSet(), protocolAppliedSetObject(), protocolAppliedSetObjectId()
property reaction as list of HS.FHIR.DTL.vR4.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 reasonCode as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "reasonCode", XMLPROJECTION = "ELEMENT");
CodeableConcept

Why immunization occurred.

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

Property methods: reasonCodeBuildValueArray(), reasonCodeCollectionToDisplay(), reasonCodeCollectionToOdbc(), reasonCodeDisplayToCollection(), reasonCodeGet(), reasonCodeGetObject(), reasonCodeGetObjectId(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeOdbcToCollection(), reasonCodeSet(), reasonCodeSetObject(), reasonCodeSetObjectId()
property reasonReference as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "reasonReference", XMLPROJECTION = "ELEMENT");
Reference

Why immunization occurred.

Condition | Observation | DiagnosticReport

Property methods: reasonReferenceBuildValueArray(), reasonReferenceCollectionToDisplay(), reasonReferenceCollectionToOdbc(), reasonReferenceDisplayToCollection(), reasonReferenceGet(), reasonReferenceGetObject(), reasonReferenceGetObjectId(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceOdbcToCollection(), reasonReferenceSet(), reasonReferenceSetObject(), reasonReferenceSetObjectId()
property recorded as %String (MAXLEN = 1000000, XMLNAME = "recorded", XMLPROJECTION = "ATTRIBUTE");
dateTime

When the immunization was first captured in the subject's record.

Property methods: recordedDisplayToLogical(), recordedGet(), recordedIsValid(), recordedLogicalToDisplay(), recordedLogicalToOdbc(), recordedNormalize(), recordedSet()
property reportOrigin as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "reportOrigin", XMLPROJECTION = "ELEMENT");
CodeableConcept

Indicates the source of a secondarily reported record.

any FHIR4 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.vR4.Model.Datatype.CodeableConcept (XMLNAME = "route", XMLPROJECTION = "ELEMENT");
CodeableConcept

How vaccine entered body.

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

Body site vaccine was administered.

any FHIR4 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

completed | entered-in-error | not-done

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

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property statusReason as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "statusReason", XMLPROJECTION = "ELEMENT");
CodeableConcept

Reason not done.

any FHIR4 code may be used; immunization-status-reason shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: statusReasonGet(), statusReasonGetSwizzled(), statusReasonIsValid(), statusReasonNewObject(), statusReasonSet()
property subpotentReason as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "subpotentReason", XMLPROJECTION = "ELEMENT");
CodeableConcept

Reason for being subpotent.

any FHIR4 code may be used; immunization-subpotent-reason shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: subpotentReasonBuildValueArray(), subpotentReasonCollectionToDisplay(), subpotentReasonCollectionToOdbc(), subpotentReasonDisplayToCollection(), subpotentReasonGet(), subpotentReasonGetObject(), subpotentReasonGetObjectId(), subpotentReasonGetSwizzled(), subpotentReasonIsValid(), subpotentReasonOdbcToCollection(), subpotentReasonSet(), subpotentReasonSetObject(), subpotentReasonSetObjectId()
property vaccineCode as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "vaccineCode", XMLPROJECTION = "ELEMENT") [ Required ];
CodeableConcept

Vaccine product administered.

any FHIR4 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