org.openmrs.api

Interface DiagnosisService

All Superinterfaces:

OpenmrsService

All Known Implementing Classes:

DiagnosisServiceImpl

public interface DiagnosisService
extends OpenmrsService

 API methods for managing diagnoses
 

Since:

2.2

Method Summary

Modifier and Type	Method and Description
List<DiagnosisAttributeType>	getAllDiagnosisAttributeTypes() Fetches all diagnosis attribute types including retired ones.
List<Diagnosis>	getDiagnoses(Patient patient, Date fromDate) Gets diagnoses since date, sorted in reverse chronological order
List<Diagnosis>	getDiagnosesByEncounter(Encounter encounter, boolean primaryOnly, boolean confirmedOnly) Gets diagnoses for an Encounter.
List<Diagnosis>	getDiagnosesByVisit(Visit visit, boolean primaryOnly, boolean confirmedOnly) Gets diagnoses for a Visit.
Diagnosis	getDiagnosis(Integer diagnosisId) Gets a diagnosis by id.
DiagnosisAttribute	getDiagnosisAttributeByUuid(String uuid) Fetches a given diagnosis attribute using the provided uuid
DiagnosisAttributeType	getDiagnosisAttributeTypeById(Integer id) Fetches a given diagnosis attribute type using the provided id
DiagnosisAttributeType	getDiagnosisAttributeTypeByUuid(String uuid) Fetches a given diagnosis attribute type using the provided uuid
Diagnosis	getDiagnosisByUuid(String uuid) Gets a diagnosis based on the uuid
List<Diagnosis>	getPrimaryDiagnoses(Encounter encounter) Deprecated. since 2.5.0, use getDiagnosesByEncounter(org.openmrs.Encounter, boolean, boolean)
List<Diagnosis>	getUniqueDiagnoses(Patient patient, Date fromDate) Gets unique diagnoses since date, sorted in reverse chronological order
void	purgeDiagnosis(Diagnosis diagnosis) Completely remove a diagnosis from the database.
void	purgeDiagnosisAttributeType(DiagnosisAttributeType diagnosisAttributeType) Completely removes a diagnosis attribute type from the database
DiagnosisAttributeType	retireDiagnosisAttributeType(DiagnosisAttributeType diagnosisAttributeType, String reason) Retires the given diagnosis attribute type in the database
Diagnosis	save(Diagnosis diagnosis) Saves a diagnosis
DiagnosisAttributeType	saveDiagnosisAttributeType(DiagnosisAttributeType diagnosisAttributeType) Creates or updates the given diagnosis attribute type in the database
DiagnosisAttributeType	unretireDiagnosisAttributeType(DiagnosisAttributeType diagnosisAttributeType) Restores a diagnosis attribute type that was previously retired
Diagnosis	unvoidDiagnosis(Diagnosis diagnosis) Revive a diagnosis (pull a Lazarus)
Diagnosis	voidDiagnosis(Diagnosis diagnosis, String voidReason) Voids a diagnosis

Methods inherited from interface org.openmrs.api.OpenmrsService

onShutdown, onStartup

Method Detail

save

@Authorized(value="Edit Diagnoses")
Diagnosis save(Diagnosis diagnosis)

Saves a diagnosis

Parameters:

diagnosis - - the diagnosis to be saved

Returns:

the diagnosis

voidDiagnosis

@Authorized(value="Edit Diagnoses")
Diagnosis voidDiagnosis(Diagnosis diagnosis,
                                                            String voidReason)

Voids a diagnosis

Parameters:

diagnosis - - the diagnosis to be voided

voidReason - - the reason for voiding the diagnosis

Returns:

the diagnosis that was voided

getDiagnosisByUuid

@Authorized(value="Get Diagnoses")
Diagnosis getDiagnosisByUuid(String uuid)

Gets a diagnosis based on the uuid

Parameters:

uuid - - uuid of the diagnosis to be returned

Returns:

diagnosis matching the given uuid

getDiagnoses

@Authorized(value="Get Diagnoses")
List<Diagnosis> getDiagnoses(Patient patient,
                                                                Date fromDate)

Gets diagnoses since date, sorted in reverse chronological order

Parameters:

patient - the patient whose diagnosis we are to get

fromDate - the date used to filter diagnosis which happened from this date and later

Returns:

the list of diagnoses for the given patient and starting from the given date

getDiagnosesByEncounter

@Authorized(value="Get Diagnoses")
List<Diagnosis> getDiagnosesByEncounter(Encounter encounter,
                                                                           boolean primaryOnly,
                                                                           boolean confirmedOnly)

Gets diagnoses for an Encounter.

Parameters:

encounter - the encounter for which to fetch diagnoses

primaryOnly - whether to return only primary diagnoses

confirmedOnly - whether to return only confirmed diagnoses

Returns:

the list of diagnoses for the given encounter

Since:

2.5.0

getDiagnosesByVisit

@Authorized(value="Get Diagnoses")
List<Diagnosis> getDiagnosesByVisit(Visit visit,
                                                                       boolean primaryOnly,
                                                                       boolean confirmedOnly)

Gets diagnoses for a Visit.

Parameters:

visit - the visit for which to fetch diagnoses

primaryOnly - whether to return only primary diagnoses

confirmedOnly - whether to return only confirmed diagnoses

Returns:

the list of diagnoses for the given visit

Since:

2.5.0

getPrimaryDiagnoses

@Deprecated
List<Diagnosis> getPrimaryDiagnoses(Encounter encounter)

Deprecated. since 2.5.0, use getDiagnosesByEncounter(org.openmrs.Encounter, boolean, boolean)

Finds the primary diagnoses for a given encounter

Parameters:

encounter - the encounter whose diagnoses we are to get

Returns:

the list of diagnoses in the given encounter

getUniqueDiagnoses

List<Diagnosis> getUniqueDiagnoses(Patient patient,
                                   Date fromDate)

Gets unique diagnoses since date, sorted in reverse chronological order

Parameters:

patient - the patient whose diagnosis we are to get

fromDate - the date used to filter diagnosis which happened from this date and later

Returns:

the list of diagnoses

getDiagnosis

@Authorized(value="Get Diagnoses")
Diagnosis getDiagnosis(Integer diagnosisId)

Gets a diagnosis by id.

Parameters:

diagnosisId - - id of the diagnosis to be returned

Returns:

diagnosis matching the given id

unvoidDiagnosis

@Authorized(value="Edit Diagnoses")
Diagnosis unvoidDiagnosis(Diagnosis diagnosis)
                                                       throws APIException

Revive a diagnosis (pull a Lazarus)

Parameters:

diagnosis - diagnosis to unvoid

Returns:

the unvoided diagnosis

Throws:

APIException - Should unset voided bit on given diagnosis

purgeDiagnosis

@Authorized(value="Delete Diagnoses")
void purgeDiagnosis(Diagnosis diagnosis)
                                                   throws APIException

Completely remove a diagnosis 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 #voidDiagnosis(Diagnosis) for that one) If other things link to this diagnosis, an error will be thrown.

Parameters:

diagnosis - diagnosis to remove from the database

Throws:

APIException

See Also:

Should delete the given diagnosis from th e database

getAllDiagnosisAttributeTypes

@Authorized(value="Get Diagnoses Attribute Types")
List<DiagnosisAttributeType> getAllDiagnosisAttributeTypes()
                                                                                                       throws APIException

Fetches all diagnosis attribute types including retired ones.

Returns:

all DiagnosisAttributeTypes

Throws:

APIException

Since:

2.5.0 Should return all diagnosis attribute types including retired ones.

getDiagnosisAttributeTypeById

@Authorized(value="Get Diagnoses Attribute Types")
DiagnosisAttributeType getDiagnosisAttributeTypeById(Integer id)
                                                                                                 throws APIException

Fetches a given diagnosis attribute type using the provided id

Parameters:

id - the id of the diagnosis attribute type to fetch

Returns:

the DiagnosisAttributeType with the given id

Throws:

APIException

Since:

2.5.0 Should return the diagnosis attribute type with the given id Should return null if no diagnosis attribute type exists with the given id

getDiagnosisAttributeTypeByUuid

@Authorized(value="Get Diagnoses Attribute Types")
DiagnosisAttributeType getDiagnosisAttributeTypeByUuid(String uuid)
                                                                                                   throws APIException

Fetches a given diagnosis attribute type using the provided uuid

Parameters:

uuid - the uuid of the diagnosis attribute type to fetch

Returns:

the DiagnosisAttributeType with the given uuid

Throws:

APIException

Since:

2.5.0 Should return the diagnosis attribute type with the given uuid Should return null if no diagnosis attribute type exists with the given uuid

saveDiagnosisAttributeType

@Authorized(value="Edit Diagnoses")
DiagnosisAttributeType saveDiagnosisAttributeType(DiagnosisAttributeType diagnosisAttributeType)
                                                                               throws APIException

Creates or updates the given diagnosis attribute type in the database

Parameters:

diagnosisAttributeType - the diagnosis attribute type to save or update

Returns:

the DiagnosisAttributeType created/saved

Throws:

APIException

Since:

2.5.0 Should create a new diagnosis attribute type Should edit an existing diagnosis attribute type

retireDiagnosisAttributeType

@Authorized(value="Edit Diagnoses")
DiagnosisAttributeType retireDiagnosisAttributeType(DiagnosisAttributeType diagnosisAttributeType,
                                                                                        String reason)
                                                                                 throws APIException

Retires the given diagnosis attribute type in the database

Parameters:

diagnosisAttributeType - the diagnosis attribute type to retire

reason - the reason why the diagnosis attribute type is being retired

Returns:

the diagnosisAttributeType retired

Throws:

APIException

Since:

2.5.0 Should retire a diagnosis attribute type

unretireDiagnosisAttributeType

@Authorized(value="Edit Diagnoses")
DiagnosisAttributeType unretireDiagnosisAttributeType(DiagnosisAttributeType diagnosisAttributeType)
                                                                                   throws APIException

Restores a diagnosis attribute type that was previously retired

Parameters:

diagnosisAttributeType - the diagnosis attribute type to unretire.

Returns:

the DiagnosisAttributeType unretired

Throws:

APIException

Since:

2.5.0 Should unretire a retired diagnosis attribute type

purgeDiagnosisAttributeType

@Authorized(value="Delete Diagnoses")
void purgeDiagnosisAttributeType(DiagnosisAttributeType diagnosisAttributeType)
                                                                throws APIException

Completely removes a diagnosis attribute type from the database

Parameters:

diagnosisAttributeType - the diagnosis attribute type to purge

Throws:

APIException

Since:

2.5.0 Should completely remove a diagnosis attribute type

getDiagnosisAttributeByUuid

@Authorized(value="Get Diagnoses")
DiagnosisAttribute getDiagnosisAttributeByUuid(String uuid)
                                                                           throws APIException

Fetches a given diagnosis attribute using the provided uuid

Parameters:

uuid - the uuid of the diagnosis attribute to fetch

Returns:

the DiagnosisAttribute with the given uuid

Throws:

APIException

Since:

2.5.0 Should get the diagnosis attribute with the given uuid Should return null if no diagnosis attribute has the given uuid