Skip to main content

HS.FHIRModel.R4.ImmunizationRecommendationX.Recommendation

class HS.FHIRModel.R4.ImmunizationRecommendationX.Recommendation extends HS.FHIRModel.FHIRClassSuper

*****************************************
** ImmunizationRecommendationX.Recommendation generated class schema
*****************************************
A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_IMMUNIZATIONRECOMMENDATIONX_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 _description as HS.FHIRModel.R4.Element;
Extensions for description
Property methods: _descriptionGet(), _descriptionGetSwizzled(), _descriptionIsValid(), _descriptionNewObject(), _descriptionSet()
property _doseNumberPositiveInt as HS.FHIRModel.R4.Element;
Extensions for doseNumberPositiveInt
Property methods: _doseNumberPositiveIntGet(), _doseNumberPositiveIntGetSwizzled(), _doseNumberPositiveIntIsValid(), _doseNumberPositiveIntNewObject(), _doseNumberPositiveIntSet()
property _doseNumberString as HS.FHIRModel.R4.Element;
Extensions for doseNumberString
Property methods: _doseNumberStringGet(), _doseNumberStringGetSwizzled(), _doseNumberStringIsValid(), _doseNumberStringNewObject(), _doseNumberStringSet()
property _series as HS.FHIRModel.R4.Element;
Extensions for series
Property methods: _seriesGet(), _seriesGetSwizzled(), _seriesIsValid(), _seriesNewObject(), _seriesSet()
property _seriesDosesPositiveInt as HS.FHIRModel.R4.Element;
Extensions for seriesDosesPositiveInt
Property methods: _seriesDosesPositiveIntGet(), _seriesDosesPositiveIntGetSwizzled(), _seriesDosesPositiveIntIsValid(), _seriesDosesPositiveIntNewObject(), _seriesDosesPositiveIntSet()
property _seriesDosesString as HS.FHIRModel.R4.Element;
Extensions for seriesDosesString
Property methods: _seriesDosesStringGet(), _seriesDosesStringGetSwizzled(), _seriesDosesStringIsValid(), _seriesDosesStringNewObject(), _seriesDosesStringSet()
property contraindicatedVaccineCode as HS.FHIRModel.R4.SeqOfCodeableConcept;
Vaccine(s) which should not be used to fulfill the recommendation.
Property methods: contraindicatedVaccineCodeGet(), contraindicatedVaccineCodeGetSwizzled(), contraindicatedVaccineCodeIsValid(), contraindicatedVaccineCodeNewObject(), contraindicatedVaccineCodeSet()
Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.
Property methods: dateCriterionGet(), dateCriterionGetSwizzled(), dateCriterionIsValid(), dateCriterionNewObject(), dateCriterionSet()
property description as %String;
Contains the description about the protocol under which the vaccine was administered.
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property doseNumberPositiveInt as %Integer;
Nominal position of the recommended dose in a series (e.g. dose 2 is the next recommended dose).
Property methods: doseNumberPositiveIntDisplayToLogical(), doseNumberPositiveIntGet(), doseNumberPositiveIntIsValid(), doseNumberPositiveIntLogicalToDisplay(), doseNumberPositiveIntNormalize(), doseNumberPositiveIntSet(), doseNumberPositiveIntXSDToLogical()
property doseNumberString as %String;
Nominal position of the recommended dose in a series (e.g. dose 2 is the next recommended dose).
Property methods: doseNumberStringDisplayToLogical(), doseNumberStringGet(), doseNumberStringIsValid(), doseNumberStringLogicalToDisplay(), doseNumberStringLogicalToOdbc(), doseNumberStringNormalize(), doseNumberStringSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property forecastReason as HS.FHIRModel.R4.SeqOfCodeableConcept;
The reason for the assigned forecast status.
Property methods: forecastReasonGet(), forecastReasonGetSwizzled(), forecastReasonIsValid(), forecastReasonNewObject(), forecastReasonSet()
property forecastStatus as HS.FHIRModel.R4.CodeableConcept [ Required ];
Indicates the patient status with respect to the path to immunity for the target disease.
Property methods: forecastStatusGet(), forecastStatusGetSwizzled(), forecastStatusIsValid(), forecastStatusNewObject(), forecastStatusSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property series as %String;
One possible path to achieve presumed immunity against a disease - within the context of an authority.
Property methods: seriesDisplayToLogical(), seriesGet(), seriesIsValid(), seriesLogicalToDisplay(), seriesLogicalToOdbc(), seriesNormalize(), seriesSet()
property seriesDosesPositiveInt as %Integer;
The recommended number of doses to achieve immunity.
Property methods: seriesDosesPositiveIntDisplayToLogical(), seriesDosesPositiveIntGet(), seriesDosesPositiveIntIsValid(), seriesDosesPositiveIntLogicalToDisplay(), seriesDosesPositiveIntNormalize(), seriesDosesPositiveIntSet(), seriesDosesPositiveIntXSDToLogical()
property seriesDosesString as %String;
The recommended number of doses to achieve immunity.
Property methods: seriesDosesStringDisplayToLogical(), seriesDosesStringGet(), seriesDosesStringIsValid(), seriesDosesStringLogicalToDisplay(), seriesDosesStringLogicalToOdbc(), seriesDosesStringNormalize(), seriesDosesStringSet()
property supportingImmunization as HS.FHIRModel.R4.SeqOfReference;
Immunization event history and/or evaluation that supports the status and recommendation.
Property methods: supportingImmunizationGet(), supportingImmunizationGetSwizzled(), supportingImmunizationIsValid(), supportingImmunizationNewObject(), supportingImmunizationSet()
property supportingPatientInformation as HS.FHIRModel.R4.SeqOfReference;
Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.
Property methods: supportingPatientInformationGet(), supportingPatientInformationGetSwizzled(), supportingPatientInformationIsValid(), supportingPatientInformationNewObject(), supportingPatientInformationSet()
property targetDisease as HS.FHIRModel.R4.CodeableConcept;
The targeted disease for the recommendation.
Property methods: targetDiseaseGet(), targetDiseaseGetSwizzled(), targetDiseaseIsValid(), targetDiseaseNewObject(), targetDiseaseSet()
property vaccineCode as HS.FHIRModel.R4.SeqOfCodeableConcept;
Vaccine(s) or vaccine group that pertain to the recommendation.
Property methods: vaccineCodeGet(), vaccineCodeGetSwizzled(), vaccineCodeIsValid(), vaccineCodeNewObject(), vaccineCodeSet()

Methods

method IncludeContraindicatedVaccineCode()
method IncludeDateCriterion()
method IncludeExtension()
method IncludeForecastReason()
method IncludeForecastStatus()
method IncludeModifierExtension()
method IncludeSupportingImmunization()
method IncludeSupportingPatientInformation()
method IncludeTargetDisease()
method IncludeVaccineCode()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab