Skip to main content

HS.FHIR.vSTU3.Model.Resource.Immunization.VaccinationProtocol

deprecated class HS.FHIR.vSTU3.Model.Resource.Immunization.VaccinationProtocol extends HS.FHIR.vSTU3.Model.Base.BackboneElement

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.

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 JSONTYPEFIELD;
Inherited description: Type property name for JSON export.
parameter XMLNAME = Immunization.VaccinationProtocol;
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.VaccinationProtocol;
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 authority as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "authority", XMLPROJECTION = "ELEMENT");
Indicates the authority who published the protocol. E.g. ACIP.
Property methods: authorityGet(), authorityGetSwizzled(), authorityIsValid(), authorityNewObject(), authoritySet()
property description as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "description", XMLPROJECTION = "ELEMENT");
Contains the description about the protocol under which the vaccine was administered.
Property methods: descriptionGet(), descriptionGetSwizzled(), descriptionIsValid(), descriptionNewObject(), descriptionSet()
property doseSequence as HS.FHIR.vSTU3.Model.Datatype.PositiveInt (XMLNAME = "doseSequence", XMLPROJECTION = "ELEMENT");
Nominal position in a series.
Property methods: doseSequenceGet(), doseSequenceGetSwizzled(), doseSequenceIsValid(), doseSequenceNewObject(), doseSequenceSet()
property doseStatus as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "doseStatus", XMLPROJECTION = "ELEMENT") [ Required ];
Indicates if the immunization event should "count" against the protocol.
Property methods: doseStatusGet(), doseStatusGetSwizzled(), doseStatusIsValid(), doseStatusNewObject(), doseStatusReasonGet(), doseStatusReasonGetSwizzled(), doseStatusReasonIsValid(), doseStatusReasonNewObject(), doseStatusReasonSet(), doseStatusSet()
property doseStatusReason as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "doseStatusReason", XMLPROJECTION = "ELEMENT");
Provides an explanation as to why an immunization event should or should not count against the protocol.
Property methods: doseStatusReasonGet(), doseStatusReasonGetSwizzled(), doseStatusReasonIsValid(), doseStatusReasonNewObject(), doseStatusReasonSet()
property series as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "series", XMLPROJECTION = "ELEMENT");
One possible path to achieve presumed immunity against a disease - within the context of an authority.
Property methods: seriesDosesGet(), seriesDosesGetSwizzled(), seriesDosesIsValid(), seriesDosesNewObject(), seriesDosesSet(), seriesGet(), seriesGetSwizzled(), seriesIsValid(), seriesNewObject(), seriesSet()
property seriesDoses as HS.FHIR.vSTU3.Model.Datatype.PositiveInt (XMLNAME = "seriesDoses", XMLPROJECTION = "ELEMENT");
The recommended number of doses to achieve immunity.
Property methods: seriesDosesGet(), seriesDosesGetSwizzled(), seriesDosesIsValid(), seriesDosesNewObject(), seriesDosesSet()
property targetDisease as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "targetDisease", XMLPROJECTION = "ELEMENT");
The targeted disease.
Property methods: targetDiseaseBuildValueArray(), targetDiseaseCollectionToDisplay(), targetDiseaseCollectionToOdbc(), targetDiseaseDisplayToCollection(), targetDiseaseGet(), targetDiseaseGetObject(), targetDiseaseGetObjectId(), targetDiseaseGetSwizzled(), targetDiseaseIsValid(), targetDiseaseOdbcToCollection(), targetDiseaseSet(), targetDiseaseSetObject(), targetDiseaseSetObjectId()

Methods

deprecated method SetAuthority(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 "authority" property.
deprecated method SetDescription(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 "description" property.
deprecated method SetDoseSequence(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 "doseSequence" property.
deprecated method SetDoseStatus(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 "doseStatus" property.
deprecated method SetDoseStatusReason(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 "doseStatusReason" property.
deprecated method SetSeries(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 "series" property.
deprecated method SetSeriesDoses(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 "seriesDoses" property.
deprecated method SetTargetDisease(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.
Insert method for the "targetDisease" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab