Skip to main content

HS.FHIR.vSTU3.Model.Resource.ImmunizationRecommendation.Recommendation

deprecated class HS.FHIR.vSTU3.Model.Resource.ImmunizationRecommendation.Recommendation extends HS.FHIR.vSTU3.Model.Base.BackboneElement

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
A patient's point-in-time immunization and recommendation (i.e. forecasting a patient's immunization eligibility according to a published schedule) with optional supporting justification.

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 = ImmunizationRecommendation.Recommendation;
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 = ImmunizationRecommendation.Recommendation;
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 date as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "date", XMLPROJECTION = "ELEMENT") [ Required ];
The date the immunization recommendation was created.
Property methods: dateGet(), dateGetSwizzled(), dateIsValid(), dateNewObject(), dateSet()
property dateCriterion as list of HS.FHIR.vSTU3.Model.Resource.ImmunizationRecommendation.DateCriterion (XMLNAME = "dateCriterion", XMLPROJECTION = "ELEMENT");
Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.
Property methods: dateCriterionBuildValueArray(), dateCriterionCollectionToDisplay(), dateCriterionCollectionToOdbc(), dateCriterionDisplayToCollection(), dateCriterionGet(), dateCriterionGetObject(), dateCriterionGetObjectId(), dateCriterionGetSwizzled(), dateCriterionIsValid(), dateCriterionOdbcToCollection(), dateCriterionSet(), dateCriterionSetObject(), dateCriterionSetObjectId()
property doseNumber as HS.FHIR.vSTU3.Model.Datatype.PositiveInt (XMLNAME = "doseNumber", XMLPROJECTION = "ELEMENT");
The next recommended dose number (e.g. dose 2 is the next recommended dose).
Property methods: doseNumberGet(), doseNumberGetSwizzled(), doseNumberIsValid(), doseNumberNewObject(), doseNumberSet()
property forecastStatus as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "forecastStatus", XMLPROJECTION = "ELEMENT") [ Required ];
Vaccine administration status.
Property methods: forecastStatusGet(), forecastStatusGetSwizzled(), forecastStatusIsValid(), forecastStatusNewObject(), forecastStatusSet()
property protocol as HS.FHIR.vSTU3.Model.Resource.ImmunizationRecommendation.Protocol (XMLNAME = "protocol", XMLPROJECTION = "ELEMENT");
Contains information about the protocol under which the vaccine was administered.
Property methods: protocolGet(), protocolGetSwizzled(), protocolIsValid(), protocolNewObject(), protocolSet()
property supportingImmunization as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "supportingImmunization", XMLPROJECTION = "ELEMENT");
Immunization event history that supports the status and recommendation.
Property methods: supportingImmunizationBuildValueArray(), supportingImmunizationCollectionToDisplay(), supportingImmunizationCollectionToOdbc(), supportingImmunizationDisplayToCollection(), supportingImmunizationGet(), supportingImmunizationGetObject(), supportingImmunizationGetObjectId(), supportingImmunizationGetSwizzled(), supportingImmunizationIsValid(), supportingImmunizationOdbcToCollection(), supportingImmunizationSet(), supportingImmunizationSetObject(), supportingImmunizationSetObjectId()
property supportingPatientInformation as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "supportingPatientInformation", XMLPROJECTION = "ELEMENT");
Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.
Property methods: supportingPatientInformationBuildValueArray(), supportingPatientInformationCollectionToDisplay(), supportingPatientInformationCollectionToOdbc(), supportingPatientInformationDisplayToCollection(), supportingPatientInformationGet(), supportingPatientInformationGetObject(), supportingPatientInformationGetObjectId(), supportingPatientInformationGetSwizzled(), supportingPatientInformationIsValid(), supportingPatientInformationOdbcToCollection(), supportingPatientInformationSet(), supportingPatientInformationSetObject(), supportingPatientInformationSetObjectId()
property targetDisease as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "targetDisease", XMLPROJECTION = "ELEMENT");
The targeted disease for the recommendation.
Property methods: targetDiseaseGet(), targetDiseaseGetSwizzled(), targetDiseaseIsValid(), targetDiseaseNewObject(), targetDiseaseSet()
property vaccineCode as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "vaccineCode", XMLPROJECTION = "ELEMENT");
Vaccine that pertains to the recommendation.
Property methods: vaccineCodeGet(), vaccineCodeGetSwizzled(), vaccineCodeIsValid(), vaccineCodeNewObject(), vaccineCodeSet()

Methods

deprecated method SetDate(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 "date" property.
deprecated method SetDoseNumber(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 "doseNumber" property.
deprecated method SetForecastStatus(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 "forecastStatus" property.
deprecated method SetSupportingImmunization(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "supportingImmunization" property.
deprecated method SetSupportingPatientInformation(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "supportingPatientInformation" 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.
Set method for the "targetDisease" property.
deprecated method SetVaccineCode(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 "vaccineCode" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab