ca.uhn.fhir.model.dstu.resource

Class Alert

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseResource

ca.uhn.fhir.model.dstu.resource.Alert

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions

public class Alert
extends BaseResource
implements IResource

HAPI/FHIR Alert Resource (Key information to flag to healthcare providers)

Definition: Prospective warnings of potential issues when providing care to the patient

Requirements:

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

Field Summary

Fields

Modifier and Type	Field and Description
static Include	INCLUDE_SUBJECT Constant for fluent queries to be used to add include statements.
static String	SP_SUBJECT Search parameter constant for subject
static ReferenceClientParam	SUBJECT Fluent Client search parameter constant for subject

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

SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors

Constructor and Description
Alert()

Method Summary

Methods

Modifier and Type	Method and Description
IdentifierDt	addIdentifier() Adds and returns a new value for identifier (Business identifier)
Alert	addIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel) Adds a new value for identifier (Business identifier)
Alert	addIdentifier(String theSystem, String theValue) Adds a new value for identifier (Business identifier)
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType) Returns a list containing all child elements matching a given type
ResourceReferenceDt	getAuthor() Gets the value(s) for author (Alert creator).
CodeableConceptDt	getCategory() Gets the value(s) for category (Clinical, administrative, etc.).
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.
StringDt	getNote() Gets the value(s) for note (Text of alert).
BoundCodeDt<AlertStatusEnum>	getStatus() Gets the value(s) for status (active | inactive | entered in error).
ResourceReferenceDt	getSubject() Gets the value(s) for subject (Who is alert about?).
boolean	isEmpty()
Alert	setAuthor(ResourceReferenceDt theValue) Sets the value(s) for author (Alert creator)
Alert	setCategory(CodeableConceptDt theValue) Sets the value(s) for category (Clinical, administrative, etc.)
Alert	setIdentifier(List<IdentifierDt> theValue) Sets the value(s) for identifier (Business identifier)
Alert	setNote(String theString) Sets the value for note (Text of alert)
Alert	setNote(StringDt theValue) Sets the value(s) for note (Text of alert)
Alert	setStatus(AlertStatusEnum theValue) Sets the value(s) for status (active | inactive | entered in error)
Alert	setStatus(BoundCodeDt<AlertStatusEnum> theValue) Sets the value(s) for status (active | inactive | entered in error)
Alert	setSubject(ResourceReferenceDt theValue) Sets the value(s) for subject (Who is alert about?)

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: The identity of a subject to list alerts for
Type: reference
Path: Alert.subject

See Also:

Constant Field Values

SUBJECT

public static final ReferenceClientParam SUBJECT

Fluent Client search parameter constant for subject

Description: The identity of a subject to list alerts for
Type: reference
Path: Alert.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 "Alert.subject".

Constructor Detail

Alert

public Alert()

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: Identifier assigned to the alert for external use (outside the FHIR environment)

setIdentifier

public Alert setIdentifier(List<IdentifierDt> theValue)

Sets the value(s) for identifier (Business identifier)

Definition: Identifier assigned to the alert for external use (outside the FHIR environment)

addIdentifier

public IdentifierDt addIdentifier()

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

Definition: Identifier assigned to the alert for external use (outside the FHIR environment)

getIdentifierFirstRep

public IdentifierDt getIdentifierFirstRep()

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

Definition: Identifier assigned to the alert for external use (outside the FHIR environment)

addIdentifier

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

Adds a new value for identifier (Business identifier)

Definition: Identifier assigned to the alert for external use (outside the FHIR environment)

Returns:

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

addIdentifier

public Alert addIdentifier(String theSystem,
                  String theValue)

Adds a new value for identifier (Business identifier)

Definition: Identifier assigned to the alert for external use (outside the FHIR environment)

Returns:

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

getCategory

public CodeableConceptDt getCategory()

Gets the value(s) for category (Clinical, administrative, etc.). creating it if it does not exist. Will not return null.

Definition: Allows an alert to be divided into different categories like clinical, administrative etc.

setCategory

public Alert setCategory(CodeableConceptDt theValue)

Sets the value(s) for category (Clinical, administrative, etc.)

Definition: Allows an alert to be divided into different categories like clinical, administrative etc.

getStatus

public BoundCodeDt<AlertStatusEnum> getStatus()

Gets the value(s) for status (active | inactive | entered in error). creating it if it does not exist. Will not return null.

Definition: Supports basic workflow

setStatus

public Alert setStatus(BoundCodeDt<AlertStatusEnum> theValue)

Sets the value(s) for status (active | inactive | entered in error)

Definition: Supports basic workflow

setStatus

public Alert setStatus(AlertStatusEnum theValue)

Sets the value(s) for status (active | inactive | entered in error)

Definition: Supports basic workflow

getSubject

public ResourceReferenceDt getSubject()

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

Definition: The person who this alert concerns

setSubject

public Alert setSubject(ResourceReferenceDt theValue)

Sets the value(s) for subject (Who is alert about?)

Definition: The person who this alert concerns

getAuthor

public ResourceReferenceDt getAuthor()

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

Definition: The person or device that created the alert

setAuthor

public Alert setAuthor(ResourceReferenceDt theValue)

Sets the value(s) for author (Alert creator)

Definition: The person or device that created the alert

getNote

public StringDt getNote()

Gets the value(s) for note (Text of alert). creating it if it does not exist. Will not return null.

Definition: The textual component of the alert to display to the user

setNote

public Alert setNote(StringDt theValue)

Sets the value(s) for note (Text of alert)

Definition: The textual component of the alert to display to the user

setNote

public Alert setNote(String theString)

Sets the value for note (Text of alert)

Definition: The textual component of the alert to display to the user