ca.uhn.fhir.model.dstu.resource

Class ImmunizationRecommendation

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseResource

ca.uhn.fhir.model.dstu.resource.ImmunizationRecommendation

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions

public class ImmunizationRecommendation
extends BaseResource
implements IResource

HAPI/FHIR ImmunizationRecommendation Resource (Immunization profile)

Definition: A patient's point-of-time immunization status and recommendation with optional supporting justification

Requirements:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmunizationRecommendation.Recommendation Block class for child element: ImmunizationRecommendation.recommendation (Vaccine administration recommendations)
static class	ImmunizationRecommendation.RecommendationDateCriterion Block class for child element: ImmunizationRecommendation.recommendation.dateCriterion (Dates governing proposed immunization)
static class	ImmunizationRecommendation.RecommendationProtocol Block class for child element: ImmunizationRecommendation.recommendation.protocol (Protocol used by recommendation)

Field Summary

Fields

Modifier and Type	Field and Description
static DateClientParam	DATE Fluent Client search parameter constant for date
static NumberClientParam	DOSE_NUMBER Fluent Client search parameter constant for dose-number
static TokenClientParam	DOSE_SEQUENCE Fluent Client search parameter constant for dose-sequence
static TokenClientParam	IDENTIFIER Fluent Client search parameter constant for identifier
static Include	INCLUDE_RECOMMENDATION_SUPPORTINGIMMUNIZATION Constant for fluent queries to be used to add include statements.
static Include	INCLUDE_RECOMMENDATION_SUPPORTINGPATIENTINFORMATION Constant for fluent queries to be used to add include statements.
static Include	INCLUDE_SUBJECT Constant for fluent queries to be used to add include statements.
static ReferenceClientParam	INFORMATION Fluent Client search parameter constant for information
static String	SP_DATE Search parameter constant for date
static String	SP_DOSE_NUMBER Search parameter constant for dose-number
static String	SP_DOSE_SEQUENCE Search parameter constant for dose-sequence
static String	SP_IDENTIFIER Search parameter constant for identifier
static String	SP_INFORMATION Search parameter constant for information
static String	SP_STATUS Search parameter constant for status
static String	SP_SUBJECT Search parameter constant for subject
static String	SP_SUPPORT Search parameter constant for support
static String	SP_VACCINE_TYPE Search parameter constant for vaccine-type
static TokenClientParam	STATUS Fluent Client search parameter constant for status
static ReferenceClientParam	SUBJECT Fluent Client search parameter constant for subject
static ReferenceClientParam	SUPPORT Fluent Client search parameter constant for support
static TokenClientParam	VACCINE_TYPE Fluent Client search parameter constant for vaccine-type

Fields inherited from class ca.uhn.fhir.model.api.BaseResource

SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors

Constructor and Description
ImmunizationRecommendation()

Method Summary

Methods

Modifier and Type	Method and Description
IdentifierDt	addIdentifier() Adds and returns a new value for identifier (Business identifier)
ImmunizationRecommendation	addIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel) Adds a new value for identifier (Business identifier)
ImmunizationRecommendation	addIdentifier(String theSystem, String theValue) Adds a new value for identifier (Business identifier)
ImmunizationRecommendation.Recommendation	addRecommendation() Adds and returns a new value for recommendation (Vaccine administration recommendations)
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType) Returns a list containing all child elements matching a given type
List<IdentifierDt>	getIdentifier() Gets the value(s) for identifier (Business identifier).
IdentifierDt	getIdentifierFirstRep() Gets the first repetition for identifier (Business identifier), creating it if it does not already exist.
List<ImmunizationRecommendation.Recommendation>	getRecommendation() Gets the value(s) for recommendation (Vaccine administration recommendations).
ImmunizationRecommendation.Recommendation	getRecommendationFirstRep() Gets the first repetition for recommendation (Vaccine administration recommendations), creating it if it does not already exist.
ResourceReferenceDt	getSubject() Gets the value(s) for subject (Who this profile is for).
boolean	isEmpty()
ImmunizationRecommendation	setIdentifier(List<IdentifierDt> theValue) Sets the value(s) for identifier (Business identifier)
ImmunizationRecommendation	setRecommendation(List<ImmunizationRecommendation.Recommendation> theValue) Sets the value(s) for recommendation (Vaccine administration recommendations)
ImmunizationRecommendation	setSubject(ResourceReferenceDt theValue) Sets the value(s) for subject (Who this profile is for)

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

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

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

addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

Methods inherited from class java.lang.Object

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

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

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

Field Detail

SP_SUBJECT

public static final String SP_SUBJECT

Search parameter constant for subject

Description:
Type: reference
Path: ImmunizationRecommendation.subject

See Also:

Constant Field Values

SUBJECT

public static final ReferenceClientParam SUBJECT

Fluent Client search parameter constant for subject

Description:
Type: reference
Path: ImmunizationRecommendation.subject

INCLUDE_SUBJECT

public static final Include INCLUDE_SUBJECT

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

SP_VACCINE_TYPE

public static final String SP_VACCINE_TYPE

Search parameter constant for vaccine-type

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

See Also:

Constant Field Values

VACCINE_TYPE

public static final TokenClientParam VACCINE_TYPE

Fluent Client search parameter constant for vaccine-type

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

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 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 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 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 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: token
Path: ImmunizationRecommendation.recommendation.protocol.doseSequence

See Also:

Constant Field Values

DOSE_SEQUENCE

public static final TokenClientParam DOSE_SEQUENCE

Fluent Client search parameter constant for dose-sequence

Description:
Type: token
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 ReferenceClientParam SUPPORT

Fluent Client search parameter constant for support

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

INCLUDE_RECOMMENDATION_SUPPORTINGIMMUNIZATION

public static final Include INCLUDE_RECOMMENDATION_SUPPORTINGIMMUNIZATION

Constant for fluent queries to be used to add include statements. Specifies the path value of "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 ReferenceClientParam INFORMATION

Fluent Client search parameter constant for information

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

INCLUDE_RECOMMENDATION_SUPPORTINGPATIENTINFORMATION

public static final Include INCLUDE_RECOMMENDATION_SUPPORTINGPATIENTINFORMATION

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

Constructor Detail

ImmunizationRecommendation

public ImmunizationRecommendation()

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IElement

getAllPopulatedChildElementsOfType

public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Description copied from interface: ICompositeElement

Returns a list containing all child elements matching a given type

Specified by:

getAllPopulatedChildElementsOfType in interface ICompositeElement

Parameters:

theType - The type to match. If set to null, all child elements will be returned

getIdentifier

public List<IdentifierDt> getIdentifier()

Gets the value(s) for identifier (Business identifier). 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 (Business identifier)

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

addIdentifier

public IdentifierDt addIdentifier()

Adds and returns a new value for identifier (Business identifier)

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

getIdentifierFirstRep

public IdentifierDt getIdentifierFirstRep()

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

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

addIdentifier

public ImmunizationRecommendation addIdentifier(IdentifierUseEnum theUse,
                                       String theSystem,
                                       String theValue,
                                       String theLabel)

Adds a new value for identifier (Business identifier)

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

Returns:

Returns a reference to this object, to allow for simple chaining.

addIdentifier

public ImmunizationRecommendation addIdentifier(String theSystem,
                                       String theValue)

Adds a new value for identifier (Business identifier)

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

Returns:

Returns a reference to this object, to allow for simple chaining.

getSubject

public ResourceReferenceDt getSubject()

Gets the value(s) for subject (Who this profile is for). creating it if it does not exist. Will not return null.

Definition: The patient who is the subject of the profile

setSubject

public ImmunizationRecommendation setSubject(ResourceReferenceDt theValue)

Sets the value(s) for subject (Who this profile is for)

Definition: The patient who is the subject of the profile

getRecommendation

public List<ImmunizationRecommendation.Recommendation> getRecommendation()

Gets the value(s) for recommendation (Vaccine administration recommendations). 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 (Vaccine administration recommendations)

Definition: Vaccine administration recommendations

addRecommendation

public ImmunizationRecommendation.Recommendation addRecommendation()

Adds and returns a new value for recommendation (Vaccine administration recommendations)

Definition: Vaccine administration recommendations

getRecommendationFirstRep

public ImmunizationRecommendation.Recommendation getRecommendationFirstRep()

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

Definition: Vaccine administration recommendations