ca.uhn.fhir.model.dstu.resource

Class AdverseReaction

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseResource

ca.uhn.fhir.model.dstu.resource.AdverseReaction

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions

public class AdverseReaction
extends BaseResource
implements IResource

HAPI/FHIR AdverseReaction Resource (Specific reactions to a substance)

Definition: Records an unexpected reaction suspected to be related to the exposure of the reaction subject to a substance

Requirements: Used to track reactions when it is unknown the exact cause but there's a desire to flag/track potential causes. Also used to capture reactions that are significant for inclusion in the health record or as evidence for an allergy or intolerance.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AdverseReaction.Exposure Block class for child element: AdverseReaction.exposure (Suspected substance)
static class	AdverseReaction.Symptom Block class for child element: AdverseReaction.symptom (What was reaction?)

Field Summary

Fields

Modifier and Type	Field and Description
static DateClientParam	DATE Fluent Client search parameter constant for date
static Include	INCLUDE_EXPOSURE_SUBSTANCE 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 String	SP_DATE Search parameter constant for date
static String	SP_SUBJECT Search parameter constant for subject
static String	SP_SUBSTANCE Search parameter constant for substance
static String	SP_SYMPTOM Search parameter constant for symptom
static ReferenceClientParam	SUBJECT Fluent Client search parameter constant for subject
static ReferenceClientParam	SUBSTANCE Fluent Client search parameter constant for substance
static TokenClientParam	SYMPTOM Fluent Client search parameter constant for symptom

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

SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors

Constructor and Description
AdverseReaction()

Method Summary

Methods

Modifier and Type	Method and Description
AdverseReaction.Exposure	addExposure() Adds and returns a new value for exposure (Suspected substance)
IdentifierDt	addIdentifier() Adds and returns a new value for identifier (External Ids for this adverse reaction)
AdverseReaction	addIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel) Adds a new value for identifier (External Ids for this adverse reaction)
AdverseReaction	addIdentifier(String theSystem, String theValue) Adds a new value for identifier (External Ids for this adverse reaction)
AdverseReaction.Symptom	addSymptom() Adds and returns a new value for symptom (What was reaction?)
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType) Returns a list containing all child elements matching a given type
DateTimeDt	getDate() Gets the value(s) for date (When the reaction occurred).
BooleanDt	getDidNotOccurFlag() Gets the value(s) for didNotOccurFlag (Indicates lack of reaction).
List<AdverseReaction.Exposure>	getExposure() Gets the value(s) for exposure (Suspected substance).
AdverseReaction.Exposure	getExposureFirstRep() Gets the first repetition for exposure (Suspected substance), creating it if it does not already exist.
List<IdentifierDt>	getIdentifier() Gets the value(s) for identifier (External Ids for this adverse reaction).
IdentifierDt	getIdentifierFirstRep() Gets the first repetition for identifier (External Ids for this adverse reaction), creating it if it does not already exist.
ResourceReferenceDt	getRecorder() Gets the value(s) for recorder (Who recorded the reaction).
ResourceReferenceDt	getSubject() Gets the value(s) for subject (Who had the reaction).
List<AdverseReaction.Symptom>	getSymptom() Gets the value(s) for symptom (What was reaction?).
AdverseReaction.Symptom	getSymptomFirstRep() Gets the first repetition for symptom (What was reaction?), creating it if it does not already exist.
boolean	isEmpty()
AdverseReaction	setDate(Date theDate, TemporalPrecisionEnum thePrecision) Sets the value for date (When the reaction occurred)
AdverseReaction	setDate(DateTimeDt theValue) Sets the value(s) for date (When the reaction occurred)
AdverseReaction	setDateWithSecondsPrecision(Date theDate) Sets the value for date (When the reaction occurred)
AdverseReaction	setDidNotOccurFlag(boolean theBoolean) Sets the value for didNotOccurFlag (Indicates lack of reaction)
AdverseReaction	setDidNotOccurFlag(BooleanDt theValue) Sets the value(s) for didNotOccurFlag (Indicates lack of reaction)
AdverseReaction	setExposure(List<AdverseReaction.Exposure> theValue) Sets the value(s) for exposure (Suspected substance)
AdverseReaction	setIdentifier(List<IdentifierDt> theValue) Sets the value(s) for identifier (External Ids for this adverse reaction)
AdverseReaction	setRecorder(ResourceReferenceDt theValue) Sets the value(s) for recorder (Who recorded the reaction)
AdverseReaction	setSubject(ResourceReferenceDt theValue) Sets the value(s) for subject (Who had the reaction)
AdverseReaction	setSymptom(List<AdverseReaction.Symptom> theValue) Sets the value(s) for symptom (What was reaction?)

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_SYMPTOM

public static final String SP_SYMPTOM

Search parameter constant for symptom

Description: One of the symptoms of the reaction
Type: token
Path: AdverseReaction.symptom.code

See Also:

Constant Field Values

SYMPTOM

public static final TokenClientParam SYMPTOM

Fluent Client search parameter constant for symptom

Description: One of the symptoms of the reaction
Type: token
Path: AdverseReaction.symptom.code

SP_SUBSTANCE

public static final String SP_SUBSTANCE

Search parameter constant for substance

Description: The name or code of the substance that produces the sensitivity
Type: reference
Path: AdverseReaction.exposure.substance

See Also:

Constant Field Values

SUBSTANCE

public static final ReferenceClientParam SUBSTANCE

Fluent Client search parameter constant for substance

Description: The name or code of the substance that produces the sensitivity
Type: reference
Path: AdverseReaction.exposure.substance

INCLUDE_EXPOSURE_SUBSTANCE

public static final Include INCLUDE_EXPOSURE_SUBSTANCE

Constant for fluent queries to be used to add include statements. Specifies the path value of "AdverseReaction.exposure.substance".

SP_DATE

public static final String SP_DATE

Search parameter constant for date

Description: The date of the reaction
Type: date
Path: AdverseReaction.date

See Also:

Constant Field Values

DATE

public static final DateClientParam DATE

Fluent Client search parameter constant for date

Description: The date of the reaction
Type: date
Path: AdverseReaction.date

SP_SUBJECT

public static final String SP_SUBJECT

Search parameter constant for subject

Description: The subject that the sensitivity is about
Type: reference
Path: AdverseReaction.subject

See Also:

Constant Field Values

SUBJECT

public static final ReferenceClientParam SUBJECT

Fluent Client search parameter constant for subject

Description: The subject that the sensitivity is about
Type: reference
Path: AdverseReaction.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 "AdverseReaction.subject".

Constructor Detail

AdverseReaction

public AdverseReaction()

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 (External Ids for this adverse reaction). creating it if it does not exist. Will not return null.

Definition: This records identifiers associated with this reaction that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)

setIdentifier

public AdverseReaction setIdentifier(List<IdentifierDt> theValue)

Sets the value(s) for identifier (External Ids for this adverse reaction)

Definition: This records identifiers associated with this reaction that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)

addIdentifier

public IdentifierDt addIdentifier()

Adds and returns a new value for identifier (External Ids for this adverse reaction)

Definition: This records identifiers associated with this reaction that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)

getIdentifierFirstRep

public IdentifierDt getIdentifierFirstRep()

Gets the first repetition for identifier (External Ids for this adverse reaction), creating it if it does not already exist.

Definition: This records identifiers associated with this reaction that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)

addIdentifier

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

Adds a new value for identifier (External Ids for this adverse reaction)

Definition: This records identifiers associated with this reaction that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)

Returns:

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

addIdentifier

public AdverseReaction addIdentifier(String theSystem,
                            String theValue)

Adds a new value for identifier (External Ids for this adverse reaction)

Definition: This records identifiers associated with this reaction that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)

Returns:

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

getDate

public DateTimeDt getDate()

Gets the value(s) for date (When the reaction occurred). creating it if it does not exist. Will not return null.

Definition: The date (and possibly time) when the reaction began

setDate

public AdverseReaction setDate(DateTimeDt theValue)

Sets the value(s) for date (When the reaction occurred)

Definition: The date (and possibly time) when the reaction began

setDateWithSecondsPrecision

public AdverseReaction setDateWithSecondsPrecision(Date theDate)

Sets the value for date (When the reaction occurred)

Definition: The date (and possibly time) when the reaction began

setDate

public AdverseReaction setDate(Date theDate,
                      TemporalPrecisionEnum thePrecision)

Sets the value for date (When the reaction occurred)

Definition: The date (and possibly time) when the reaction began

getSubject

public ResourceReferenceDt getSubject()

Gets the value(s) for subject (Who had the reaction). creating it if it does not exist. Will not return null.

Definition: The subject of the adverse reaction

setSubject

public AdverseReaction setSubject(ResourceReferenceDt theValue)

Sets the value(s) for subject (Who had the reaction)

Definition: The subject of the adverse reaction

getDidNotOccurFlag

public BooleanDt getDidNotOccurFlag()

Gets the value(s) for didNotOccurFlag (Indicates lack of reaction). creating it if it does not exist. Will not return null.

Definition: If true, indicates that no reaction occurred.

setDidNotOccurFlag

public AdverseReaction setDidNotOccurFlag(BooleanDt theValue)

Sets the value(s) for didNotOccurFlag (Indicates lack of reaction)

Definition: If true, indicates that no reaction occurred.

setDidNotOccurFlag

public AdverseReaction setDidNotOccurFlag(boolean theBoolean)

Sets the value for didNotOccurFlag (Indicates lack of reaction)

Definition: If true, indicates that no reaction occurred.

getRecorder

public ResourceReferenceDt getRecorder()

Gets the value(s) for recorder (Who recorded the reaction). creating it if it does not exist. Will not return null.

Definition: Identifies the individual responsible for the information in the reaction record.

setRecorder

public AdverseReaction setRecorder(ResourceReferenceDt theValue)

Sets the value(s) for recorder (Who recorded the reaction)

Definition: Identifies the individual responsible for the information in the reaction record.

getSymptom

public List<AdverseReaction.Symptom> getSymptom()

Gets the value(s) for symptom (What was reaction?). creating it if it does not exist. Will not return null.

Definition: The signs and symptoms that were observed as part of the reaction

setSymptom

public AdverseReaction setSymptom(List<AdverseReaction.Symptom> theValue)

Sets the value(s) for symptom (What was reaction?)

Definition: The signs and symptoms that were observed as part of the reaction

addSymptom

public AdverseReaction.Symptom addSymptom()

Adds and returns a new value for symptom (What was reaction?)

Definition: The signs and symptoms that were observed as part of the reaction

getSymptomFirstRep

public AdverseReaction.Symptom getSymptomFirstRep()

Gets the first repetition for symptom (What was reaction?), creating it if it does not already exist.

Definition: The signs and symptoms that were observed as part of the reaction

getExposure

public List<AdverseReaction.Exposure> getExposure()

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

Definition: An exposure to a substance that preceded a reaction occurrence

setExposure

public AdverseReaction setExposure(List<AdverseReaction.Exposure> theValue)

Sets the value(s) for exposure (Suspected substance)

Definition: An exposure to a substance that preceded a reaction occurrence

addExposure

public AdverseReaction.Exposure addExposure()

Adds and returns a new value for exposure (Suspected substance)

Definition: An exposure to a substance that preceded a reaction occurrence

getExposureFirstRep

public AdverseReaction.Exposure getExposureFirstRep()

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

Definition: An exposure to a substance that preceded a reaction occurrence