Skip to main content

HS.FHIR.DTL.vR4.Model.Element.ImmunizationRecommendation.recommendation

class HS.FHIR.DTL.vR4.Model.Element.ImmunizationRecommendation.recommendation extends HS.FHIR.DTL.vR4.Model.Base.BackboneElement

Vaccine administration recommendations.

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 = 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 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 = 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 contraindicatedVaccineCode as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "contraindicatedVaccineCode", XMLPROJECTION = "ELEMENT");
CodeableConcept

Vaccine which is contraindicated to fulfill the recommendation.

any FHIR4 code may be used; vaccine-code shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: contraindicatedVaccineCodeBuildValueArray(), contraindicatedVaccineCodeCollectionToDisplay(), contraindicatedVaccineCodeCollectionToOdbc(), contraindicatedVaccineCodeDisplayToCollection(), contraindicatedVaccineCodeGet(), contraindicatedVaccineCodeGetObject(), contraindicatedVaccineCodeGetObjectId(), contraindicatedVaccineCodeGetSwizzled(), contraindicatedVaccineCodeIsValid(), contraindicatedVaccineCodeOdbcToCollection(), contraindicatedVaccineCodeSet(), contraindicatedVaccineCodeSetObject(), contraindicatedVaccineCodeSetObjectId()
property dateCriterion as list of HS.FHIR.DTL.vR4.Model.Element.ImmunizationRecommendation.recommendation.dateCriterion (XMLNAME = "dateCriterion", XMLPROJECTION = "ELEMENT");
BackboneElement

Dates governing proposed immunization.

Property methods: dateCriterionBuildValueArray(), dateCriterionCollectionToDisplay(), dateCriterionCollectionToOdbc(), dateCriterionDisplayToCollection(), dateCriterionGet(), dateCriterionGetObject(), dateCriterionGetObjectId(), dateCriterionGetSwizzled(), dateCriterionIsValid(), dateCriterionOdbcToCollection(), dateCriterionSet(), dateCriterionSetObject(), dateCriterionSetObjectId()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");
string

Protocol details.

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

Recommended dose number within series.

Property methods: doseNumberPositiveIntDisplayToLogical(), doseNumberPositiveIntGet(), doseNumberPositiveIntIsValid(), doseNumberPositiveIntLogicalToDisplay(), doseNumberPositiveIntNormalize(), doseNumberPositiveIntSet(), doseNumberPositiveIntXSDToLogical()
property doseNumberString as %String (MAXLEN = 1000000, XMLNAME = "doseNumberString", XMLPROJECTION = "ATTRIBUTE");
string

Recommended dose number within series.

Property methods: doseNumberStringDisplayToLogical(), doseNumberStringGet(), doseNumberStringIsValid(), doseNumberStringLogicalToDisplay(), doseNumberStringLogicalToOdbc(), doseNumberStringNormalize(), doseNumberStringSet()
property forecastReason as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "forecastReason", XMLPROJECTION = "ELEMENT");
CodeableConcept

Vaccine administration status reason.

any FHIR4 code may be used; immunization-recommendation-reason shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: forecastReasonBuildValueArray(), forecastReasonCollectionToDisplay(), forecastReasonCollectionToOdbc(), forecastReasonDisplayToCollection(), forecastReasonGet(), forecastReasonGetObject(), forecastReasonGetObjectId(), forecastReasonGetSwizzled(), forecastReasonIsValid(), forecastReasonOdbcToCollection(), forecastReasonSet(), forecastReasonSetObject(), forecastReasonSetObjectId()
property forecastStatus as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "forecastStatus", XMLPROJECTION = "ELEMENT") [ Required ];
CodeableConcept

Vaccine recommendation status.

any FHIR4 code may be used; immunization-recommendation-status shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: forecastStatusGet(), forecastStatusGetSwizzled(), forecastStatusIsValid(), forecastStatusNewObject(), forecastStatusSet()
property series as %String (MAXLEN = 1000000, XMLNAME = "series", XMLPROJECTION = "ATTRIBUTE");
string

Name of vaccination series.

Property methods: seriesDisplayToLogical(), seriesDosesPositiveIntDisplayToLogical(), seriesDosesPositiveIntGet(), seriesDosesPositiveIntIsValid(), seriesDosesPositiveIntLogicalToDisplay(), seriesDosesPositiveIntNormalize(), seriesDosesPositiveIntSet(), seriesDosesPositiveIntXSDToLogical(), seriesDosesStringDisplayToLogical(), seriesDosesStringGet(), seriesDosesStringIsValid(), seriesDosesStringLogicalToDisplay(), seriesDosesStringLogicalToOdbc(), seriesDosesStringNormalize(), seriesDosesStringSet(), 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 supportingImmunization as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "supportingImmunization", XMLPROJECTION = "ELEMENT");
Reference

Past immunizations supporting recommendation.

Immunization | ImmunizationEvaluation

Property methods: supportingImmunizationBuildValueArray(), supportingImmunizationCollectionToDisplay(), supportingImmunizationCollectionToOdbc(), supportingImmunizationDisplayToCollection(), supportingImmunizationGet(), supportingImmunizationGetObject(), supportingImmunizationGetObjectId(), supportingImmunizationGetSwizzled(), supportingImmunizationIsValid(), supportingImmunizationOdbcToCollection(), supportingImmunizationSet(), supportingImmunizationSetObject(), supportingImmunizationSetObjectId()
property supportingPatientInformation as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "supportingPatientInformation", XMLPROJECTION = "ELEMENT");
Reference

Patient observations supporting recommendation.

Any FHIR4 Resource may be indicated by this Reference

Property methods: supportingPatientInformationBuildValueArray(), supportingPatientInformationCollectionToDisplay(), supportingPatientInformationCollectionToOdbc(), supportingPatientInformationDisplayToCollection(), supportingPatientInformationGet(), supportingPatientInformationGetObject(), supportingPatientInformationGetObjectId(), supportingPatientInformationGetSwizzled(), supportingPatientInformationIsValid(), supportingPatientInformationOdbcToCollection(), supportingPatientInformationSet(), supportingPatientInformationSetObject(), supportingPatientInformationSetObjectId()
property targetDisease as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "targetDisease", XMLPROJECTION = "ELEMENT");
CodeableConcept

Disease to be immunized against.

any FHIR4 code may be used; immunization-recommendation-target-disease shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: targetDiseaseGet(), targetDiseaseGetSwizzled(), targetDiseaseIsValid(), targetDiseaseNewObject(), targetDiseaseSet()
property vaccineCode as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "vaccineCode", XMLPROJECTION = "ELEMENT");
CodeableConcept

Vaccine or vaccine group recommendation applies to.

any FHIR4 code may be used; vaccine-code shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: vaccineCodeBuildValueArray(), vaccineCodeCollectionToDisplay(), vaccineCodeCollectionToOdbc(), vaccineCodeDisplayToCollection(), vaccineCodeGet(), vaccineCodeGetObject(), vaccineCodeGetObjectId(), vaccineCodeGetSwizzled(), vaccineCodeIsValid(), vaccineCodeOdbcToCollection(), vaccineCodeSet(), vaccineCodeSetObject(), vaccineCodeSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab