Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.ImmunizationEvaluation

class HS.FHIR.DTL.vR4.Model.Resource.ImmunizationEvaluation extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

Immunization evaluation information.

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 = ImmunizationEvaluation;
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 = ImmunizationEvaluation;
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 date as %String (MAXLEN = 1000000, XMLNAME = "date", XMLPROJECTION = "ATTRIBUTE");
dateTime

Date evaluation was performed.

Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");
string

Evaluation notes.

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

Dose number within series.

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

Dose number within series.

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

Status of the dose relative to published recommendations.

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

Property methods: doseStatusGet(), doseStatusGetSwizzled(), doseStatusIsValid(), doseStatusNewObject(), doseStatusReasonBuildValueArray(), doseStatusReasonCollectionToDisplay(), doseStatusReasonCollectionToOdbc(), doseStatusReasonDisplayToCollection(), doseStatusReasonGet(), doseStatusReasonGetObject(), doseStatusReasonGetObjectId(), doseStatusReasonGetSwizzled(), doseStatusReasonIsValid(), doseStatusReasonOdbcToCollection(), doseStatusReasonSet(), doseStatusReasonSetObject(), doseStatusReasonSetObjectId(), doseStatusSet()
property doseStatusReason as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "doseStatusReason", XMLPROJECTION = "ELEMENT");
CodeableConcept

Reason for the dose status.

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

Property methods: doseStatusReasonBuildValueArray(), doseStatusReasonCollectionToDisplay(), doseStatusReasonCollectionToOdbc(), doseStatusReasonDisplayToCollection(), doseStatusReasonGet(), doseStatusReasonGetObject(), doseStatusReasonGetObjectId(), doseStatusReasonGetSwizzled(), doseStatusReasonIsValid(), doseStatusReasonOdbcToCollection(), doseStatusReasonSet(), doseStatusReasonSetObject(), doseStatusReasonSetObjectId()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

Business identifier.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property immunizationEvent as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "immunizationEvent", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

Immunization being evaluated.

Immunization

Property methods: immunizationEventGet(), immunizationEventGetSwizzled(), immunizationEventIsValid(), immunizationEventNewObject(), immunizationEventSet()
property patient as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

Who this evaluation is for.

Patient

Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property series as %String (MAXLEN = 1000000, XMLNAME = "series", XMLPROJECTION = "ATTRIBUTE");
string

Name of vaccine 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 status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

completed | entered-in-error

immunization-evaluation-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend immunization-evaluation-status|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property targetDisease as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "targetDisease", XMLPROJECTION = "ELEMENT") [ Required ];
CodeableConcept

Evaluation target disease.

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

Property methods: targetDiseaseGet(), targetDiseaseGetSwizzled(), targetDiseaseIsValid(), targetDiseaseNewObject(), targetDiseaseSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab