Skip to main content

HS.FHIRModel.R4.Immunization

class HS.FHIRModel.R4.Immunization extends HS.FHIRModel.FHIRClassSuper

*****************************************
** Immunization generated class schema
*****************************************
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.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_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 _expirationDate as HS.FHIRModel.R4.Element;
Extensions for expirationDate
Property methods: _expirationDateGet(), _expirationDateGetSwizzled(), _expirationDateIsValid(), _expirationDateNewObject(), _expirationDateSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _isSubpotent as HS.FHIRModel.R4.Element;
Extensions for isSubpotent
Property methods: _isSubpotentGet(), _isSubpotentGetSwizzled(), _isSubpotentIsValid(), _isSubpotentNewObject(), _isSubpotentSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _lotNumber as HS.FHIRModel.R4.Element;
Extensions for lotNumber
Property methods: _lotNumberGet(), _lotNumberGetSwizzled(), _lotNumberIsValid(), _lotNumberNewObject(), _lotNumberSet()
property _occurrenceDateTime as HS.FHIRModel.R4.Element;
Extensions for occurrenceDateTime
Property methods: _occurrenceDateTimeGet(), _occurrenceDateTimeGetSwizzled(), _occurrenceDateTimeIsValid(), _occurrenceDateTimeNewObject(), _occurrenceDateTimeSet()
property _occurrenceString as HS.FHIRModel.R4.Element;
Extensions for occurrenceString
Property methods: _occurrenceStringGet(), _occurrenceStringGetSwizzled(), _occurrenceStringIsValid(), _occurrenceStringNewObject(), _occurrenceStringSet()
property _primarySource as HS.FHIRModel.R4.Element;
Extensions for primarySource
Property methods: _primarySourceGet(), _primarySourceGetSwizzled(), _primarySourceIsValid(), _primarySourceNewObject(), _primarySourceSet()
property _recorded as HS.FHIRModel.R4.Element;
Extensions for recorded
Property methods: _recordedGet(), _recordedGetSwizzled(), _recordedIsValid(), _recordedNewObject(), _recordedSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property doseQuantity as HS.FHIRModel.R4.Quantity;
The quantity of vaccine product that was administered.
Property methods: doseQuantityGet(), doseQuantityGetSwizzled(), doseQuantityIsValid(), doseQuantityNewObject(), doseQuantitySet()
Educational material presented to the patient (or guardian) at the time of vaccine administration.
Property methods: educationGet(), educationGetSwizzled(), educationIsValid(), educationNewObject(), educationSet()
property encounter as HS.FHIRModel.R4.Reference;
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 %String;
Date vaccine batch expires.
Property methods: expirationDateDisplayToLogical(), expirationDateGet(), expirationDateIsValid(), expirationDateLogicalToDisplay(), expirationDateLogicalToOdbc(), expirationDateNormalize(), expirationDateSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property fundingSource as HS.FHIRModel.R4.CodeableConcept;
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).
Property methods: fundingSourceGet(), fundingSourceGetSwizzled(), fundingSourceIsValid(), fundingSourceNewObject(), fundingSourceSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
A unique identifier assigned to this immunization record.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property isSubpotent as %Boolean;
Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
Property methods: isSubpotentDisplayToLogical(), isSubpotentGet(), isSubpotentIsValid(), isSubpotentLogicalToDisplay(), isSubpotentLogicalToXSD(), isSubpotentNormalize(), isSubpotentSet(), isSubpotentXSDToLogical()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property location as HS.FHIRModel.R4.Reference;
The service delivery location where the vaccine administration occurred.
Property methods: locationGet(), locationGetSwizzled(), locationIsValid(), locationNewObject(), locationSet()
property lotNumber as %String;
Lot number of the vaccine product.
Property methods: lotNumberDisplayToLogical(), lotNumberGet(), lotNumberIsValid(), lotNumberLogicalToDisplay(), lotNumberLogicalToOdbc(), lotNumberNormalize(), lotNumberSet()
property manufacturer as HS.FHIRModel.R4.Reference;
Name of vaccine manufacturer.
Property methods: manufacturerGet(), manufacturerGetSwizzled(), manufacturerIsValid(), manufacturerNewObject(), manufacturerSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
Extra information about the immunization that is not conveyed by the other attributes.
Property methods: noteGet(), noteGetSwizzled(), noteIsValid(), noteNewObject(), noteSet()
property occurrenceDateTime as %String;
Date vaccine administered or was to be administered.
Property methods: occurrenceDateTimeDisplayToLogical(), occurrenceDateTimeGet(), occurrenceDateTimeIsValid(), occurrenceDateTimeLogicalToDisplay(), occurrenceDateTimeLogicalToOdbc(), occurrenceDateTimeNormalize(), occurrenceDateTimeSet()
property occurrenceString as %String;
Date vaccine administered or was to be administered.
Property methods: occurrenceStringDisplayToLogical(), occurrenceStringGet(), occurrenceStringIsValid(), occurrenceStringLogicalToDisplay(), occurrenceStringLogicalToOdbc(), occurrenceStringNormalize(), occurrenceStringSet()
property patient as HS.FHIRModel.R4.Reference [ Required ];
The patient who either received or did not receive the immunization.
Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
Indicates who performed the immunization event.
Property methods: performerGet(), performerGetSwizzled(), performerIsValid(), performerNewObject(), performerSet()
property primarySource as %Boolean;
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: primarySourceDisplayToLogical(), primarySourceGet(), primarySourceIsValid(), primarySourceLogicalToDisplay(), primarySourceLogicalToXSD(), primarySourceNormalize(), primarySourceSet(), primarySourceXSDToLogical()
property programEligibility as HS.FHIRModel.R4.SeqOfCodeableConcept;
Indicates a patient's eligibility for a funding program.
Property methods: programEligibilityGet(), programEligibilityGetSwizzled(), programEligibilityIsValid(), programEligibilityNewObject(), programEligibilitySet()
The protocol (set of recommendations) being followed by the provider who administered the dose.
Property methods: protocolAppliedGet(), protocolAppliedGetSwizzled(), protocolAppliedIsValid(), protocolAppliedNewObject(), protocolAppliedSet()
Categorical data indicating that an adverse event is associated in time to an immunization.
Property methods: reactionGet(), reactionGetSwizzled(), reactionIsValid(), reactionNewObject(), reactionSet()
property reasonCode as HS.FHIRModel.R4.SeqOfCodeableConcept;
Reasons why the vaccine was administered.
Property methods: reasonCodeGet(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeNewObject(), reasonCodeSet()
property reasonReference as HS.FHIRModel.R4.SeqOfReference;
Condition, Observation or DiagnosticReport that supports why the immunization was administered.
Property methods: reasonReferenceGet(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceNewObject(), reasonReferenceSet()
property recorded as %String;
The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
Property methods: recordedDisplayToLogical(), recordedGet(), recordedIsValid(), recordedLogicalToDisplay(), recordedLogicalToOdbc(), recordedNormalize(), recordedSet()
property reportOrigin as HS.FHIRModel.R4.CodeableConcept;
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 resourceType as %String [ InitialExpression = "Immunization" , Required ];
This is a Immunization resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property route as HS.FHIRModel.R4.CodeableConcept;
The path by which the vaccine product is taken into the body.
Property methods: routeGet(), routeGetSwizzled(), routeIsValid(), routeNewObject(), routeSet()
Body site where vaccine was administered.
Property methods: siteGet(), siteGetSwizzled(), siteIsValid(), siteNewObject(), siteSet()
property status as %String;
Indicates the current status of the immunization event.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property statusReason as HS.FHIRModel.R4.CodeableConcept;
Indicates the reason the immunization event was not performed.
Property methods: statusReasonGet(), statusReasonGetSwizzled(), statusReasonIsValid(), statusReasonNewObject(), statusReasonSet()
property subpotentReason as HS.FHIRModel.R4.SeqOfCodeableConcept;
Reason why a dose is considered to be subpotent.
Property methods: subpotentReasonGet(), subpotentReasonGetSwizzled(), subpotentReasonIsValid(), subpotentReasonNewObject(), subpotentReasonSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
property vaccineCode as HS.FHIRModel.R4.CodeableConcept [ Required ];
Vaccine that was administered or was to be administered.
Property methods: vaccineCodeGet(), vaccineCodeGetSwizzled(), vaccineCodeIsValid(), vaccineCodeNewObject(), vaccineCodeSet()

Methods

method IncludeContained()
method IncludeDoseQuantity()
method IncludeEducation()
method IncludeEncounter()
method IncludeExtension()
method IncludeFundingSource()
method IncludeIdentifier()
method IncludeLocation()
method IncludeManufacturer()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeNote()
method IncludePatient()
method IncludePerformer()
method IncludeProgramEligibility()
method IncludeProtocolApplied()
method IncludeReaction()
method IncludeReasonCode()
method IncludeReasonReference()
method IncludeReportOrigin()
method IncludeRoute()
method IncludeSite()
method IncludeStatusReason()
method IncludeSubpotentReason()
method IncludeText()
method IncludeVaccineCode()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab