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 Summary
Modifier and TypeClassDescriptionstatic enum
static class
-
Field Summary
Modifier and TypeFieldDescriptionprotected Reference
Indicates the authority who published the protocol (e.g.protected Organization
The actual object that is the target of the reference (Indicates the authority who published the protocol (e.g.protected DateTimeType
The date the evaluation of the vaccine administration event was performed.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for dateprotected StringType
Additional information about the evaluation.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for dose-statusprotected Type
Nominal position in a series.protected CodeableConcept
Indicates 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.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for immunization-eventprotected Reference
The vaccine administration event being evaluated.protected Immunization
The actual object that is the target of the reference (The vaccine administration event being evaluated.)static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.protected Reference
The individual for whom the evaluation is being done.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for patientprotected Patient
The actual object that is the target of the reference (The individual for whom the evaluation is being done.)protected StringType
One possible path to achieve presumed immunity against a disease - within the context of an authority.protected Type
The recommended number of doses to achieve immunity.static final String
Search parameter: datestatic final String
Search parameter: dose-statusstatic final String
Search parameter: identifierstatic final String
Search parameter: immunization-eventstatic final String
Search parameter: patientstatic final String
Search parameter: statusstatic final String
Search parameter: target-diseaseIndicates the current status of the evaluation of the vaccination administration event.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for target-diseaseprotected CodeableConcept
The vaccine preventable disease the dose is being evaluated against.Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_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_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
ConstructorDescriptionConstructorImmunizationEvaluation
(Enumeration<ImmunizationEvaluation.ImmunizationEvaluationStatus> status, Reference patient, CodeableConcept targetDisease, Reference immunizationEvent, CodeableConcept doseStatus) Constructor -
Method Summary
Modifier and TypeMethodDescriptioncopy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(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) boolean
boolean
hasDate()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(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 ImmunizationEvaluation
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
Methods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, 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, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
identifier
A unique identifier assigned to this immunization evaluation record. -
status
Indicates the current status of the evaluation of the vaccination administration event. -
patient
The individual for whom the evaluation is being done. -
patientTarget
The actual object that is the target of the reference (The individual for whom the evaluation is being done.) -
date
The date the evaluation of the vaccine administration event was performed. -
authority
Indicates the authority who published the protocol (e.g. ACIP). -
authorityTarget
The actual object that is the target of the reference (Indicates the authority who published the protocol (e.g. ACIP).) -
targetDisease
The vaccine preventable disease the dose is being evaluated against. -
immunizationEvent
The vaccine administration event being evaluated. -
immunizationEventTarget
The actual object that is the target of the reference (The vaccine administration event being evaluated.) -
doseStatus
Indicates if the dose is valid or not valid with respect to the published recommendations. -
doseStatusReason
Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations. -
description
Additional information about the evaluation. -
series
One possible path to achieve presumed immunity against a disease - within the context of an authority. -
doseNumber
Nominal position in a series. -
seriesDoses
The recommended number of doses to achieve immunity. -
SP_DATE
Search parameter: dateDescription: Date the evaluation was generated
Type: date
Path: ImmunizationEvaluation.date
- See Also:
-
DATE
Fluent Client search parameter constant for dateDescription: Date the evaluation was generated
Type: date
Path: ImmunizationEvaluation.date
-
SP_IDENTIFIER
Search parameter: identifierDescription: ID of the evaluation
Type: token
Path: ImmunizationEvaluation.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: ID of the evaluation
Type: token
Path: ImmunizationEvaluation.identifier
-
SP_TARGET_DISEASE
Search parameter: target-diseaseDescription: The vaccine preventable disease being evaluated against
Type: token
Path: ImmunizationEvaluation.targetDisease
- See Also:
-
TARGET_DISEASE
Fluent Client search parameter constant for target-diseaseDescription: The vaccine preventable disease being evaluated against
Type: token
Path: ImmunizationEvaluation.targetDisease
-
SP_PATIENT
Search parameter: patientDescription: The patient being evaluated
Type: reference
Path: ImmunizationEvaluation.patient
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: The patient being evaluated
Type: reference
Path: ImmunizationEvaluation.patient
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "ImmunizationEvaluation:patient". -
SP_DOSE_STATUS
Search parameter: dose-statusDescription: The status of the dose relative to published recommendations
Type: token
Path: ImmunizationEvaluation.doseStatus
- See Also:
-
DOSE_STATUS
Fluent Client search parameter constant for dose-statusDescription: The status of the dose relative to published recommendations
Type: token
Path: ImmunizationEvaluation.doseStatus
-
SP_IMMUNIZATION_EVENT
Search parameter: immunization-eventDescription: The vaccine administration event being evaluated
Type: reference
Path: ImmunizationEvaluation.immunizationEvent
- See Also:
-
IMMUNIZATION_EVENT
Fluent Client search parameter constant for immunization-eventDescription: The vaccine administration event being evaluated
Type: reference
Path: ImmunizationEvaluation.immunizationEvent
-
INCLUDE_IMMUNIZATION_EVENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "ImmunizationEvaluation:immunization-event". -
SP_STATUS
Search parameter: statusDescription: Immunization evaluation status
Type: token
Path: ImmunizationEvaluation.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: Immunization evaluation status
Type: token
Path: ImmunizationEvaluation.status
-
-
Constructor Details
-
ImmunizationEvaluation
public ImmunizationEvaluation()Constructor -
ImmunizationEvaluation
public 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
this
for 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
-
setStatusElement
public 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:
patient
The 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
-patient
The 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:
authority
The 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
-authority
The 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:
immunizationEvent
The 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
-immunizationEvent
The 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
this
for 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:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-