
Class ImmunizationEvaluation
- All Implemented Interfaces:
- ca.uhn.fhir.model.api.IElement,- Serializable,- org.hl7.fhir.instance.model.api.IAnyResource,- org.hl7.fhir.instance.model.api.IBase,- org.hl7.fhir.instance.model.api.IBaseHasExtensions,- org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions,- org.hl7.fhir.instance.model.api.IBaseResource,- org.hl7.fhir.instance.model.api.IDomainResource
- See Also:
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionstatic enumstatic class
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected ReferenceIndicates the authority who published the protocol (e.g.protected OrganizationThe actual object that is the target of the reference (Indicates the authority who published the protocol (e.g.protected DateTimeTypeThe date the evaluation of the vaccine administration event was performed.static final ca.uhn.fhir.rest.gclient.DateClientParamFluent Client search parameter constant for dateprotected StringTypeAdditional information about the evaluation.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for dose-statusprotected TypeNominal position in a series.protected CodeableConceptIndicates if the dose is valid or not valid with respect to the published recommendations.protected List<CodeableConcept> Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations.protected List<Identifier> A unique identifier assigned to this immunization evaluation record.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for identifierstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for immunization-eventprotected ReferenceThe vaccine administration event being evaluated.protected ImmunizationThe actual object that is the target of the reference (The vaccine administration event being evaluated.)static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.protected ReferenceThe individual for whom the evaluation is being done.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for patientprotected PatientThe actual object that is the target of the reference (The individual for whom the evaluation is being done.)protected StringTypeOne possible path to achieve presumed immunity against a disease - within the context of an authority.protected TypeThe recommended number of doses to achieve immunity.static final StringSearch parameter: datestatic final StringSearch parameter: dose-statusstatic final StringSearch parameter: identifierstatic final StringSearch parameter: immunization-eventstatic final StringSearch parameter: patientstatic final StringSearch parameter: statusstatic final StringSearch parameter: target-diseaseIndicates the current status of the evaluation of the vaccination administration event.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for statusstatic final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for target-diseaseprotected CodeableConceptThe vaccine preventable disease the dose is being evaluated against.Fields inherited from class org.hl7.fhir.r4.model.DomainResourcecontained, extension, modifierExtension, textFields inherited from class org.hl7.fhir.r4.model.Resourceid, implicitRules, language, metaFields inherited from interface org.hl7.fhir.instance.model.api.IAnyResourceRES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAGFields inherited from interface org.hl7.fhir.instance.model.api.IBaseResourceINCLUDE_ALL, WILDCARD_ALL_SET
- 
Constructor SummaryConstructorsConstructorDescriptionConstructorImmunizationEvaluation(Enumeration<ImmunizationEvaluation.ImmunizationEvaluationStatus> status, Reference patient, CodeableConcept targetDisease, Reference immunizationEvent, CodeableConcept doseStatus) Constructor
- 
Method SummaryModifier and TypeMethodDescriptioncopy()voidbooleanequalsDeep(Base other_) booleanequalsShallow(Base other_) fhirType()getDate()getNamedProperty(int _hash, String _name, boolean _checkValid) Base[]getProperty(int hash, String name, boolean checkValid) String[]getTypesForProperty(int hash, String name) booleanbooleanhasDate()booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanisEmpty()protected voidlistChildren(List<Property> children) makeProperty(int hash, String name) voidremoveChild(String name, Base value) setAuthority(Reference value) setAuthorityTarget(Organization value) setDateElement(DateTimeType value) setDescription(String value) setDescriptionElement(StringType value) setDoseNumber(Type value) setDoseStatus(CodeableConcept value) setDoseStatusReason(List<CodeableConcept> theDoseStatusReason) setIdentifier(List<Identifier> theIdentifier) setImmunizationEvent(Reference value) setPatient(Reference value) setPatientTarget(Patient value) setProperty(int hash, String name, Base value) setProperty(String name, Base value) setSeriesDoses(Type value) setSeriesElement(StringType value) setTargetDisease(CodeableConcept value) protected ImmunizationEvaluationMethods inherited from class org.hl7.fhir.r4.model.DomainResourceaddContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionString, getExtensionString, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasPrimitiveExtension, hasText, setContained, setExtension, setModifierExtension, setTextMethods inherited from class org.hl7.fhir.r4.model.ResourcecopyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetaMethods inherited from class org.hl7.fhir.r4.model.BaseResourcegetStructureFhirVersionEnum, isResource, setIdMethods inherited from class org.hl7.fhir.r4.model.BasecastToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN, setXhtmlMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.hl7.fhir.instance.model.api.IAnyResourcegetId, getIdElement, getLanguageElement, getUserData, setId, setUserDataMethods inherited from interface org.hl7.fhir.instance.model.api.IBasegetFormatCommentsPost, getFormatCommentsPre, hasFormatCommentMethods inherited from interface org.hl7.fhir.instance.model.api.IBaseResourcegetMeta, getStructureFhirVersionEnum, isDeleted, setId
- 
Field Details- 
identifierA unique identifier assigned to this immunization evaluation record.
- 
statusIndicates the current status of the evaluation of the vaccination administration event.
- 
patientThe individual for whom the evaluation is being done.
- 
patientTargetThe actual object that is the target of the reference (The individual for whom the evaluation is being done.)
- 
dateThe date the evaluation of the vaccine administration event was performed.
- 
authorityIndicates the authority who published the protocol (e.g. ACIP).
- 
authorityTargetThe actual object that is the target of the reference (Indicates the authority who published the protocol (e.g. ACIP).)
- 
targetDiseaseThe vaccine preventable disease the dose is being evaluated against.
- 
immunizationEventThe vaccine administration event being evaluated.
- 
immunizationEventTargetThe actual object that is the target of the reference (The vaccine administration event being evaluated.)
- 
doseStatusIndicates if the dose is valid or not valid with respect to the published recommendations.
- 
doseStatusReasonProvides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations.
- 
descriptionAdditional information about the evaluation.
- 
seriesOne possible path to achieve presumed immunity against a disease - within the context of an authority.
- 
doseNumberNominal position in a series.
- 
seriesDosesThe recommended number of doses to achieve immunity.
- 
SP_DATESearch parameter: dateDescription: Date the evaluation was generated 
 Type: date
 Path: ImmunizationEvaluation.date
 - See Also:
 
- 
DATEFluent Client search parameter constant for dateDescription: Date the evaluation was generated 
 Type: date
 Path: ImmunizationEvaluation.date
 
- 
SP_IDENTIFIERSearch parameter: identifierDescription: ID of the evaluation 
 Type: token
 Path: ImmunizationEvaluation.identifier
 - See Also:
 
- 
IDENTIFIERFluent Client search parameter constant for identifierDescription: ID of the evaluation 
 Type: token
 Path: ImmunizationEvaluation.identifier
 
- 
SP_TARGET_DISEASESearch parameter: target-diseaseDescription: The vaccine preventable disease being evaluated against 
 Type: token
 Path: ImmunizationEvaluation.targetDisease
 - See Also:
 
- 
TARGET_DISEASEFluent Client search parameter constant for target-diseaseDescription: The vaccine preventable disease being evaluated against 
 Type: token
 Path: ImmunizationEvaluation.targetDisease
 
- 
SP_PATIENTSearch parameter: patientDescription: The patient being evaluated 
 Type: reference
 Path: ImmunizationEvaluation.patient
 - See Also:
 
- 
PATIENTFluent Client search parameter constant for patientDescription: The patient being evaluated 
 Type: reference
 Path: ImmunizationEvaluation.patient
 
- 
INCLUDE_PATIENTConstant for fluent queries to be used to add include statements. Specifies the path value of "ImmunizationEvaluation:patient".
- 
SP_DOSE_STATUSSearch parameter: dose-statusDescription: The status of the dose relative to published recommendations 
 Type: token
 Path: ImmunizationEvaluation.doseStatus
 - See Also:
 
- 
DOSE_STATUSFluent Client search parameter constant for dose-statusDescription: The status of the dose relative to published recommendations 
 Type: token
 Path: ImmunizationEvaluation.doseStatus
 
- 
SP_IMMUNIZATION_EVENTSearch parameter: immunization-eventDescription: The vaccine administration event being evaluated 
 Type: reference
 Path: ImmunizationEvaluation.immunizationEvent
 - See Also:
 
- 
IMMUNIZATION_EVENTFluent Client search parameter constant for immunization-eventDescription: The vaccine administration event being evaluated 
 Type: reference
 Path: ImmunizationEvaluation.immunizationEvent
 
- 
INCLUDE_IMMUNIZATION_EVENTConstant for fluent queries to be used to add include statements. Specifies the path value of "ImmunizationEvaluation:immunization-event".
- 
SP_STATUSSearch parameter: statusDescription: Immunization evaluation status 
 Type: token
 Path: ImmunizationEvaluation.status
 - See Also:
 
- 
STATUSFluent Client search parameter constant for statusDescription: Immunization evaluation status 
 Type: token
 Path: ImmunizationEvaluation.status
 
 
- 
- 
Constructor Details- 
ImmunizationEvaluationpublic ImmunizationEvaluation()Constructor
- 
ImmunizationEvaluationpublic ImmunizationEvaluation(Enumeration<ImmunizationEvaluation.ImmunizationEvaluationStatus> status, Reference patient, CodeableConcept targetDisease, Reference immunizationEvent, CodeableConcept doseStatus) Constructor
 
- 
- 
Method Details- 
getIdentifier- Returns:
- identifier(A unique identifier assigned to this immunization evaluation record.)
 
- 
setIdentifier- Returns:
- Returns a reference to thisfor easy method chaining
 
- 
hasIdentifier
- 
addIdentifier
- 
addIdentifier
- 
getIdentifierFirstRep- Returns:
- The first repetition of repeating field identifier, creating it if it does not already exist
 
- 
getStatusElement- Returns:
- status(Indicates the current status of the evaluation of the vaccination administration event.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
 
- 
hasStatusElement
- 
hasStatus
- 
setStatusElementpublic ImmunizationEvaluation setStatusElement(Enumeration<ImmunizationEvaluation.ImmunizationEvaluationStatus> value) - Parameters:
- value-- status(Indicates the current status of the evaluation of the vaccination administration event.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
 
- 
getStatus- Returns:
- Indicates the current status of the evaluation of the vaccination administration event.
 
- 
setStatus- Parameters:
- value- Indicates the current status of the evaluation of the vaccination administration event.
 
- 
getPatient- Returns:
- patient(The individual for whom the evaluation is being done.)
 
- 
hasPatient
- 
setPatient- Parameters:
- value-- patient(The individual for whom the evaluation is being done.)
 
- 
getPatientTarget- Returns:
- patientThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The individual for whom the evaluation is being done.)
 
- 
setPatientTarget- Parameters:
- value-- patientThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The individual for whom the evaluation is being done.)
 
- 
getDateElement- Returns:
- date(The date the evaluation of the vaccine administration event was performed.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
 
- 
hasDateElement
- 
hasDate
- 
setDateElement- Parameters:
- value-- date(The date the evaluation of the vaccine administration event was performed.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
 
- 
getDate- Returns:
- The date the evaluation of the vaccine administration event was performed.
 
- 
setDate- Parameters:
- value- The date the evaluation of the vaccine administration event was performed.
 
- 
getAuthority- Returns:
- authority(Indicates the authority who published the protocol (e.g. ACIP).)
 
- 
hasAuthority
- 
setAuthority- Parameters:
- value-- authority(Indicates the authority who published the protocol (e.g. ACIP).)
 
- 
getAuthorityTarget- Returns:
- authorityThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Indicates the authority who published the protocol (e.g. ACIP).)
 
- 
setAuthorityTarget- Parameters:
- value-- authorityThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Indicates the authority who published the protocol (e.g. ACIP).)
 
- 
getTargetDisease- Returns:
- targetDisease(The vaccine preventable disease the dose is being evaluated against.)
 
- 
hasTargetDisease
- 
setTargetDisease- Parameters:
- value-- targetDisease(The vaccine preventable disease the dose is being evaluated against.)
 
- 
getImmunizationEvent- Returns:
- immunizationEvent(The vaccine administration event being evaluated.)
 
- 
hasImmunizationEvent
- 
setImmunizationEvent- Parameters:
- value-- immunizationEvent(The vaccine administration event being evaluated.)
 
- 
getImmunizationEventTarget- Returns:
- immunizationEventThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The vaccine administration event being evaluated.)
 
- 
setImmunizationEventTarget- Parameters:
- value-- immunizationEventThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The vaccine administration event being evaluated.)
 
- 
getDoseStatus- Returns:
- doseStatus(Indicates if the dose is valid or not valid with respect to the published recommendations.)
 
- 
hasDoseStatus
- 
setDoseStatus- Parameters:
- value-- doseStatus(Indicates if the dose is valid or not valid with respect to the published recommendations.)
 
- 
getDoseStatusReason- Returns:
- doseStatusReason(Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations.)
 
- 
setDoseStatusReason- Returns:
- Returns a reference to thisfor easy method chaining
 
- 
hasDoseStatusReason
- 
addDoseStatusReason
- 
addDoseStatusReason
- 
getDoseStatusReasonFirstRep- Returns:
- The first repetition of repeating field doseStatusReason, creating it if it does not already exist
 
- 
getDescriptionElement- Returns:
- description(Additional information about the evaluation.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
 
- 
hasDescriptionElement
- 
hasDescription
- 
setDescriptionElement- Parameters:
- value-- description(Additional information about the evaluation.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
 
- 
getDescription- Returns:
- Additional information about the evaluation.
 
- 
setDescription- Parameters:
- value- Additional information about the evaluation.
 
- 
getSeriesElement- Returns:
- series(One possible path to achieve presumed immunity against a disease - within the context of an authority.). This is the underlying object with id, value and extensions. The accessor "getSeries" gives direct access to the value
 
- 
hasSeriesElement
- 
hasSeries
- 
setSeriesElement- Parameters:
- value-- series(One possible path to achieve presumed immunity against a disease - within the context of an authority.). This is the underlying object with id, value and extensions. The accessor "getSeries" gives direct access to the value
 
- 
getSeries- Returns:
- One possible path to achieve presumed immunity against a disease - within the context of an authority.
 
- 
setSeries- Parameters:
- value- One possible path to achieve presumed immunity against a disease - within the context of an authority.
 
- 
getDoseNumber- Returns:
- doseNumber(Nominal position in a series.)
 
- 
getDoseNumberPositiveIntType- Returns:
- doseNumber(Nominal position in a series.)
- Throws:
- org.hl7.fhir.exceptions.FHIRException
 
- 
hasDoseNumberPositiveIntType
- 
getDoseNumberStringType- Returns:
- doseNumber(Nominal position in a series.)
- Throws:
- org.hl7.fhir.exceptions.FHIRException
 
- 
hasDoseNumberStringType
- 
hasDoseNumber
- 
setDoseNumber- Parameters:
- value-- doseNumber(Nominal position in a series.)
 
- 
getSeriesDoses- Returns:
- seriesDoses(The recommended number of doses to achieve immunity.)
 
- 
getSeriesDosesPositiveIntType- Returns:
- seriesDoses(The recommended number of doses to achieve immunity.)
- Throws:
- org.hl7.fhir.exceptions.FHIRException
 
- 
hasSeriesDosesPositiveIntType
- 
getSeriesDosesStringType- Returns:
- seriesDoses(The recommended number of doses to achieve immunity.)
- Throws:
- org.hl7.fhir.exceptions.FHIRException
 
- 
hasSeriesDosesStringType
- 
hasSeriesDoses
- 
setSeriesDoses- Parameters:
- value-- seriesDoses(The recommended number of doses to achieve immunity.)
 
- 
listChildren- Overrides:
- listChildrenin class- DomainResource
 
- 
getNamedPropertypublic Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
- getNamedPropertyin class- DomainResource
- Throws:
- org.hl7.fhir.exceptions.FHIRException
 
- 
getPropertypublic Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
- getPropertyin class- DomainResource
- Throws:
- org.hl7.fhir.exceptions.FHIRException
 
- 
setPropertypublic Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
- setPropertyin class- DomainResource
- Throws:
- org.hl7.fhir.exceptions.FHIRException
 
- 
setProperty- Overrides:
- setPropertyin class- DomainResource
- Throws:
- org.hl7.fhir.exceptions.FHIRException
 
- 
removeChild- Overrides:
- removeChildin class- DomainResource
- Throws:
- org.hl7.fhir.exceptions.FHIRException
 
- 
makeProperty- Overrides:
- makePropertyin class- DomainResource
- Throws:
- org.hl7.fhir.exceptions.FHIRException
 
- 
getTypesForPropertypublic String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
- getTypesForPropertyin class- DomainResource
- Throws:
- org.hl7.fhir.exceptions.FHIRException
 
- 
addChild- Overrides:
- addChildin class- DomainResource
- Throws:
- org.hl7.fhir.exceptions.FHIRException
 
- 
fhirType- Specified by:
- fhirTypein interface- org.hl7.fhir.instance.model.api.IBase
- Overrides:
- fhirTypein class- DomainResource
 
- 
copy- Specified by:
- copyin class- DomainResource
 
- 
copyValues
- 
typedCopy
- 
equalsDeep- Overrides:
- equalsDeepin class- DomainResource
 
- 
equalsShallow- Overrides:
- equalsShallowin class- DomainResource
 
- 
isEmpty- Specified by:
- isEmptyin interface- org.hl7.fhir.instance.model.api.IBase
- Overrides:
- isEmptyin class- DomainResource
 
- 
getResourceType- Specified by:
- getResourceTypein class- Resource
 
 
-