Package ca.uhn.fhir.model.dstu2.resource

Class ImmunizationRecommendation

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.dstu2.resource.BaseResource

ca.uhn.fhir.model.dstu2.resource.ImmunizationRecommendation

All Implemented Interfaces:

ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

public class ImmunizationRecommendation
extends BaseResource
implements ca.uhn.fhir.model.api.IResource

HAPI/FHIR ImmunizationRecommendation Resource (clinical.medication)

Definition: A patient's point-in-time immunization and recommendation (i.e. forecasting a patient's immunization eligibility according to a published schedule) with optional supporting justification.

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/ImmunizationRecommendation

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImmunizationRecommendation.Recommendation	Block class for child element: ImmunizationRecommendation.recommendation ()
static class	ImmunizationRecommendation.RecommendationDateCriterion	Block class for child element: ImmunizationRecommendation.recommendation.dateCriterion ()
static class	ImmunizationRecommendation.RecommendationProtocol	Block class for child element: ImmunizationRecommendation.recommendation.protocol ()

Field Summary

Fields

Modifier and Type	Field	Description
static final ca.uhn.fhir.rest.gclient.DateClientParam	DATE	Fluent Client search parameter constant for date
static final ca.uhn.fhir.rest.gclient.NumberClientParam	DOSE_NUMBER	Fluent Client search parameter constant for dose-number
static final ca.uhn.fhir.rest.gclient.NumberClientParam	DOSE_SEQUENCE	Fluent Client search parameter constant for dose-sequence
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_INFORMATION	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PATIENT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SUPPORT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	INFORMATION	Fluent Client search parameter constant for information
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PATIENT	Fluent Client search parameter constant for patient
static final String	SP_DATE	Search parameter constant for date
static final String	SP_DOSE_NUMBER	Search parameter constant for dose-number
static final String	SP_DOSE_SEQUENCE	Search parameter constant for dose-sequence
static final String	SP_IDENTIFIER	Search parameter constant for identifier
static final String	SP_INFORMATION	Search parameter constant for information
static final String	SP_PATIENT	Search parameter constant for patient
static final String	SP_STATUS	Search parameter constant for status
static final String	SP_SUPPORT	Search parameter constant for support
static final String	SP_VACCINE_TYPE	Search parameter constant for vaccine-type
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SUPPORT	Fluent Client search parameter constant for support
static final ca.uhn.fhir.rest.gclient.TokenClientParam	VACCINE_TYPE	Fluent Client search parameter constant for vaccine-type

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

RES_ID, SP_RES_ID

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
ImmunizationRecommendation()

Method Summary

Modifier and Type	Method	Description
IdentifierDt	addIdentifier()	Adds and returns a new value for identifier (id)
ImmunizationRecommendation	addIdentifier(IdentifierDt theValue)	Adds a given new value for identifier (id)
ImmunizationRecommendation.Recommendation	addRecommendation()	Adds and returns a new value for recommendation ()
ImmunizationRecommendation	addRecommendation(ImmunizationRecommendation.Recommendation theValue)	Adds a given new value for recommendation ()
<T extends ca.uhn.fhir.model.api.IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType)
List<IdentifierDt>	getIdentifier()	Gets the value(s) for identifier (id).
IdentifierDt	getIdentifierFirstRep()	Gets the first repetition for identifier (id), creating it if it does not already exist.
ResourceReferenceDt	getPatient()	Gets the value(s) for patient (who.focus).
List<ImmunizationRecommendation.Recommendation>	getRecommendation()	Gets the value(s) for recommendation ().
ImmunizationRecommendation.Recommendation	getRecommendationFirstRep()	Gets the first repetition for recommendation (), creating it if it does not already exist.
String	getResourceName()
ca.uhn.fhir.context.FhirVersionEnum	getStructureFhirVersionEnum()
boolean	isEmpty()
ImmunizationRecommendation	setIdentifier(List<IdentifierDt> theValue)	Sets the value(s) for identifier (id)
ImmunizationRecommendation	setPatient(ResourceReferenceDt theValue)	Sets the value(s) for patient (who.focus)
ImmunizationRecommendation	setRecommendation(List<ImmunizationRecommendation.Recommendation> theValue)	Sets the value(s) for recommendation ()

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

getContained, getId, getIdElement, getLanguage, getMeta, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, getUserData, hasFormatComment, setUserData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

fhirType, getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getIdElement, isDeleted, setId, setId

Methods inherited from interface ca.uhn.fhir.model.api.IResource

getContained, getId, getLanguage, getMeta, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

Field Details

SP_VACCINE_TYPE

public static final String SP_VACCINE_TYPE

Search parameter constant for vaccine-type

Description:
Type: token
Path: ImmunizationRecommendation.recommendation.vaccineCode

See Also:

• Constant Field Values

VACCINE_TYPE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam VACCINE_TYPE

Fluent Client search parameter constant for vaccine-type

Description:
Type: token
Path: ImmunizationRecommendation.recommendation.vaccineCode

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter constant for identifier

Description:
Type: token
Path: ImmunizationRecommendation.identifier

See Also:

• Constant Field Values

IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description:
Type: token
Path: ImmunizationRecommendation.identifier

SP_DATE

public static final String SP_DATE

Search parameter constant for date

Description:
Type: date
Path: ImmunizationRecommendation.recommendation.date

See Also:

• Constant Field Values

DATE

public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE

Fluent Client search parameter constant for date

Description:
Type: date
Path: ImmunizationRecommendation.recommendation.date

SP_DOSE_NUMBER

public static final String SP_DOSE_NUMBER

Search parameter constant for dose-number

Description:
Type: number
Path: ImmunizationRecommendation.recommendation.doseNumber

See Also:

• Constant Field Values

DOSE_NUMBER

public static final ca.uhn.fhir.rest.gclient.NumberClientParam DOSE_NUMBER

Fluent Client search parameter constant for dose-number

Description:
Type: number
Path: ImmunizationRecommendation.recommendation.doseNumber

SP_STATUS

public static final String SP_STATUS

Search parameter constant for status

Description:
Type: token
Path: ImmunizationRecommendation.recommendation.forecastStatus

See Also:

• Constant Field Values

STATUS

public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS

Fluent Client search parameter constant for status

Description:
Type: token
Path: ImmunizationRecommendation.recommendation.forecastStatus

SP_DOSE_SEQUENCE

public static final String SP_DOSE_SEQUENCE

Search parameter constant for dose-sequence

Description:
Type: number
Path: ImmunizationRecommendation.recommendation.protocol.doseSequence

See Also:

• Constant Field Values

DOSE_SEQUENCE

public static final ca.uhn.fhir.rest.gclient.NumberClientParam DOSE_SEQUENCE

Fluent Client search parameter constant for dose-sequence

Description:
Type: number
Path: ImmunizationRecommendation.recommendation.protocol.doseSequence

SP_SUPPORT

public static final String SP_SUPPORT

Search parameter constant for support

Description:
Type: reference
Path: ImmunizationRecommendation.recommendation.supportingImmunization

See Also:

• Constant Field Values

SUPPORT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUPPORT

Fluent Client search parameter constant for support

Description:
Type: reference
Path: ImmunizationRecommendation.recommendation.supportingImmunization

SP_INFORMATION

public static final String SP_INFORMATION

Search parameter constant for information

Description:
Type: reference
Path: ImmunizationRecommendation.recommendation.supportingPatientInformation

See Also:

• Constant Field Values

INFORMATION

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INFORMATION

Fluent Client search parameter constant for information

Description:
Type: reference
Path: ImmunizationRecommendation.recommendation.supportingPatientInformation

SP_PATIENT

public static final String SP_PATIENT

Search parameter constant for patient

Description:
Type: reference
Path: ImmunizationRecommendation.patient

See Also:

• Constant Field Values

PATIENT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT

Fluent Client search parameter constant for patient

Description:
Type: reference
Path: ImmunizationRecommendation.patient

INCLUDE_INFORMATION

public static final ca.uhn.fhir.model.api.Include INCLUDE_INFORMATION

Constant for fluent queries to be used to add include statements. Specifies the path value of "ImmunizationRecommendation:information".

INCLUDE_PATIENT

public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT

Constant for fluent queries to be used to add include statements. Specifies the path value of "ImmunizationRecommendation:patient".

INCLUDE_SUPPORT

public static final ca.uhn.fhir.model.api.Include INCLUDE_SUPPORT

Constant for fluent queries to be used to add include statements. Specifies the path value of "ImmunizationRecommendation:support".

Constructor Details

ImmunizationRecommendation

public ImmunizationRecommendation()

Method Details

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

getAllPopulatedChildElementsOfType

public <T extends ca.uhn.fhir.model.api.IElement>
List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Specified by:

getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement

getIdentifier

public List<IdentifierDt> getIdentifier()

Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.

Definition: A unique identifier assigned to this particular recommendation record.

setIdentifier

public ImmunizationRecommendation setIdentifier(List<IdentifierDt> theValue)

Sets the value(s) for identifier (id)

Definition: A unique identifier assigned to this particular recommendation record.

addIdentifier

public IdentifierDt addIdentifier()

Adds and returns a new value for identifier (id)

Definition: A unique identifier assigned to this particular recommendation record.

addIdentifier

public ImmunizationRecommendation addIdentifier(IdentifierDt theValue)

Adds a given new value for identifier (id)

Definition: A unique identifier assigned to this particular recommendation record.

Parameters:

theValue - The identifier to add (must not be null)

getIdentifierFirstRep

public IdentifierDt getIdentifierFirstRep()

Gets the first repetition for identifier (id), creating it if it does not already exist.

Definition: A unique identifier assigned to this particular recommendation record.

getPatient

public ResourceReferenceDt getPatient()

Gets the value(s) for patient (who.focus). creating it if it does not exist. Will not return null.

Definition: The patient for whom the recommendations are for.

setPatient

public ImmunizationRecommendation setPatient(ResourceReferenceDt theValue)

Sets the value(s) for patient (who.focus)

Definition: The patient for whom the recommendations are for.

getRecommendation

public List<ImmunizationRecommendation.Recommendation> getRecommendation()

Gets the value(s) for recommendation (). creating it if it does not exist. Will not return null.

Definition: Vaccine administration recommendations

setRecommendation

public ImmunizationRecommendation setRecommendation(List<ImmunizationRecommendation.Recommendation> theValue)

Sets the value(s) for recommendation ()

Definition: Vaccine administration recommendations

addRecommendation

public ImmunizationRecommendation.Recommendation addRecommendation()

Adds and returns a new value for recommendation ()

Definition: Vaccine administration recommendations

addRecommendation

public ImmunizationRecommendation addRecommendation(ImmunizationRecommendation.Recommendation theValue)

Adds a given new value for recommendation ()

Definition: Vaccine administration recommendations

Parameters:

theValue - The recommendation to add (must not be null)

getRecommendationFirstRep

public ImmunizationRecommendation.Recommendation getRecommendationFirstRep()

Gets the first repetition for recommendation (), creating it if it does not already exist.

Definition: Vaccine administration recommendations

getResourceName

public String getResourceName()

Specified by:

getResourceName in interface ca.uhn.fhir.model.api.IResource

getStructureFhirVersionEnum

public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()

Specified by:

getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource

Specified by:

getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource