Skip to main content

HS.FHIR.DTL.vDSTU2.Model.Element.Immunization.vaccinationProtocol

class HS.FHIR.DTL.vDSTU2.Model.Element.Immunization.vaccinationProtocol extends HS.FHIR.DTL.vDSTU2.Model.Base.BackboneElement

What protocol was followed.

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.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 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.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.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "authority", XMLPROJECTION = "ELEMENT");
Reference

Who is responsible for protocol.

Organization

Property methods: authorityGet(), authorityGetSwizzled(), authorityIsValid(), authorityNewObject(), authoritySet()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");
string

Details of vaccine protocol.

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property doseSequence as %Integer (XMLNAME = "doseSequence", XMLPROJECTION = "ATTRIBUTE") [ Required ];
positiveInt

Dose number within series.

Property methods: doseSequenceDisplayToLogical(), doseSequenceGet(), doseSequenceIsValid(), doseSequenceLogicalToDisplay(), doseSequenceNormalize(), doseSequenceSet(), doseSequenceXSDToLogical()
property doseStatus as HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "doseStatus", XMLPROJECTION = "ELEMENT") [ Required ];
CodeableConcept

Indicates if dose counts towards immunity.

any FHIR2 code may be used; vaccination-protocol-dose-status shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: doseStatusGet(), doseStatusGetSwizzled(), doseStatusIsValid(), doseStatusNewObject(), doseStatusReasonGet(), doseStatusReasonGetSwizzled(), doseStatusReasonIsValid(), doseStatusReasonNewObject(), doseStatusReasonSet(), doseStatusSet()
property doseStatusReason as HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "doseStatusReason", XMLPROJECTION = "ELEMENT");
CodeableConcept

Why dose does (not) count.

any FHIR2 code may be used; vaccination-protocol-dose-status-reason shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: doseStatusReasonGet(), doseStatusReasonGetSwizzled(), doseStatusReasonIsValid(), doseStatusReasonNewObject(), doseStatusReasonSet()
property series as %String (MAXLEN = 1000000, XMLNAME = "series", XMLPROJECTION = "ATTRIBUTE");
string

Name of vaccine series.

Property methods: seriesDisplayToLogical(), seriesDosesDisplayToLogical(), seriesDosesGet(), seriesDosesIsValid(), seriesDosesLogicalToDisplay(), seriesDosesNormalize(), seriesDosesSet(), seriesDosesXSDToLogical(), seriesGet(), seriesIsValid(), seriesLogicalToDisplay(), seriesLogicalToOdbc(), seriesNormalize(), seriesSet()
property seriesDoses as %Integer (XMLNAME = "seriesDoses", XMLPROJECTION = "ATTRIBUTE");
positiveInt

Recommended number of doses for immunity.

Property methods: seriesDosesDisplayToLogical(), seriesDosesGet(), seriesDosesIsValid(), seriesDosesLogicalToDisplay(), seriesDosesNormalize(), seriesDosesSet(), seriesDosesXSDToLogical()
property targetDisease as list of HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "targetDisease", XMLPROJECTION = "ELEMENT") [ Required ];
CodeableConcept

Disease immunized against.

any FHIR2 code may be used; vaccination-protocol-dose-target shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: targetDiseaseBuildValueArray(), targetDiseaseCollectionToDisplay(), targetDiseaseCollectionToOdbc(), targetDiseaseDisplayToCollection(), targetDiseaseGet(), targetDiseaseGetObject(), targetDiseaseGetObjectId(), targetDiseaseGetSwizzled(), targetDiseaseIsValid(), targetDiseaseOdbcToCollection(), targetDiseaseSet(), targetDiseaseSetObject(), targetDiseaseSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab