org.openmrs.api

Interface ConditionService

All Superinterfaces:

OpenmrsService

All Known Implementing Classes:

ConditionServiceImpl

public interface ConditionService
extends OpenmrsService

This interface defines methods for condition objects.

Since:

2.2

Method Summary

Modifier and Type	Method and Description
List<Condition>	getActiveConditions(Patient patient) Gets a patient's active conditions
List<Condition>	getAllConditions(Patient patient) Gets all conditions i.e both active and inactive conditions, associated with a patient
Condition	getCondition(Integer conditionId) Gets a condition by id
Condition	getConditionByUuid(String uuid) Gets a condition based on the uuid
List<Condition>	getConditionsByEncounter(Encounter encounter) Gets all conditions(not voided) of an encounter.
void	purgeCondition(Condition condition) Completely remove a condition from the database.
Condition	saveCondition(Condition condition) Saves a condition
Condition	unvoidCondition(Condition condition) Revive a previously voided condition
Condition	voidCondition(Condition condition, String voidReason) Voids a condition

Methods inherited from interface org.openmrs.api.OpenmrsService

onShutdown, onStartup

Method Detail

getConditionByUuid

@Authorized(value="Get Conditions")
Condition getConditionByUuid(String uuid)
                                                          throws APIException

Gets a condition based on the uuid

Parameters:

uuid - - uuid of the condition to be returned

Returns:

the condition

Throws:

APIException

getActiveConditions

@Authorized(value="Get Conditions")
List<Condition> getActiveConditions(Patient patient)
                                                                 throws APIException

Gets a patient's active conditions

Parameters:

patient - - the patient to retrieve conditions for

Returns:

a list of the patient's active conditions

Throws:

APIException

getAllConditions

@Authorized(value="Get Conditions")
List<Condition> getAllConditions(Patient patient)
                                                              throws APIException

Gets all conditions i.e both active and inactive conditions, associated with a patient

Parameters:

patient - - the patient to retrieve conditions for

Returns:

a list of the patient's conditions

Throws:

APIException

Since:

2.2.1

getConditionsByEncounter

List<Condition> getConditionsByEncounter(Encounter encounter)
                                  throws APIException

Gets all conditions(not voided) of an encounter.

Parameters:

encounter - - the encounter to retrieve conditions for

Returns:

a list of encounter's conditions

Throws:

APIException

Since:

2.4.0, 2.3.1

getCondition

@Authorized(value="Get Conditions")
Condition getCondition(Integer conditionId)
                                                    throws APIException

Gets a condition by id

Parameters:

conditionId - the id of the Condition to retrieve

Returns:

the Condition with the given id, or null if none exists

Throws:

APIException

saveCondition

@Authorized(value="Edit Conditions")
Condition saveCondition(Condition condition)
                                                      throws APIException

Saves a condition

Parameters:

condition - - the condition to be saved

Throws:

APIException

voidCondition

@Authorized(value="Edit Conditions")
Condition voidCondition(Condition condition,
                                                             String voidReason)
                                                      throws APIException

Voids a condition

Parameters:

condition - the condition to be voided

voidReason - the reason for voiding the condition

Throws:

APIException - if an error occurs while voiding the condition

unvoidCondition

@Authorized(value="Edit Conditions")
Condition unvoidCondition(Condition condition)
                                                        throws APIException

Revive a previously voided condition

Parameters:

condition - Condition to unvoid

Throws:

APIException - Should unset voided bit on given condition

purgeCondition

@Authorized(value="Delete Conditions")
void purgeCondition(Condition condition)
                                                    throws APIException

Completely remove a condition from the database. This should typically not be called because we don't want to ever lose data. The data really should be voided and then it is not seen in interface any longer (see #voidCondition(Condition) for that one) If other things link to this condition, an error will be thrown.

Parameters:

condition -

Throws:

APIException - Should delete the given condition from the database