HS.FHIR.DTL.vR4.Model.Element.Immunization.protocolApplied
class HS.FHIR.DTL.vR4.Model.Element.Immunization.protocolApplied extends HS.FHIR.DTL.vR4.Model.Base.BackboneElement
Protocol followed by the provider.Property Inventory
- authority
- doseNumberPositiveInt
- doseNumberString
- series
- seriesDosesPositiveInt
- seriesDosesString
- targetDisease
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.protocolApplied;
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.protocolApplied;
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.vR4.Model.Base.Reference (XMLNAME = "authority", XMLPROJECTION = "ELEMENT");
Reference
Who is responsible for publishing the recommendations.
Organization
Property methods: authorityGet(), authorityGetSwizzled(), authorityIsValid(), authorityNewObject(), authoritySet()
property doseNumberPositiveInt as %Integer (XMLNAME = "doseNumberPositiveInt", XMLPROJECTION = "ATTRIBUTE") [ Required ];
positiveInt
Dose number within series.
Property methods: doseNumberPositiveIntDisplayToLogical(), doseNumberPositiveIntGet(), doseNumberPositiveIntIsValid(), doseNumberPositiveIntLogicalToDisplay(), doseNumberPositiveIntNormalize(), doseNumberPositiveIntSet(), doseNumberPositiveIntXSDToLogical()
property doseNumberString as %String (MAXLEN = 1000000, XMLNAME = "doseNumberString", XMLPROJECTION = "ATTRIBUTE") [ Required ];
string
Dose number within series.
Property methods: doseNumberStringDisplayToLogical(), doseNumberStringGet(), doseNumberStringIsValid(), doseNumberStringLogicalToDisplay(), doseNumberStringLogicalToOdbc(), doseNumberStringNormalize(), doseNumberStringSet()
property series as %String (MAXLEN = 1000000, XMLNAME = "series", XMLPROJECTION = "ATTRIBUTE");
string
Name of vaccine series.
Property methods: seriesDisplayToLogical(), seriesGet(), seriesIsValid(), seriesLogicalToDisplay(), seriesLogicalToOdbc(), seriesNormalize(), seriesSet()
property seriesDosesPositiveInt as %Integer (XMLNAME = "seriesDosesPositiveInt", XMLPROJECTION = "ATTRIBUTE");
positiveInt
Recommended number of doses for immunity.
Property methods: seriesDosesPositiveIntDisplayToLogical(), seriesDosesPositiveIntGet(), seriesDosesPositiveIntIsValid(), seriesDosesPositiveIntLogicalToDisplay(), seriesDosesPositiveIntNormalize(), seriesDosesPositiveIntSet(), seriesDosesPositiveIntXSDToLogical()
property seriesDosesString as %String (MAXLEN = 1000000, XMLNAME = "seriesDosesString", XMLPROJECTION = "ATTRIBUTE");
string
Recommended number of doses for immunity.
Property methods: seriesDosesStringDisplayToLogical(), seriesDosesStringGet(), seriesDosesStringIsValid(), seriesDosesStringLogicalToDisplay(), seriesDosesStringLogicalToOdbc(), seriesDosesStringNormalize(), seriesDosesStringSet()
property targetDisease as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "targetDisease", XMLPROJECTION = "ELEMENT");
CodeableConcept
Vaccine preventatable disease being targetted.
any FHIR4 code may be used; immunization-target-disease 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
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- FromJSON()
- FromJSONDir()
- FromJSONFile()
- FromJSONHelper()
- FromXML()
- FromXMLHelper()
- PrimitiveExtensionHandler()
- ToJSON()
- ToJSONHelper()
- ToXML()
- ToXMLHelper()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()