org.openmrs.api.db

Interface PatientDAO

All Known Implementing Classes:

HibernatePatientDAO

public interface PatientDAO

Database methods for the PatientService

See Also:

Context, PatientService

Method Summary

Modifier and Type	Method and Description
void	deletePatient(Patient patient) Delete patient from database.
void	deletePatientIdentifier(PatientIdentifier patientIdentifier)
void	deletePatientIdentifierType(PatientIdentifierType patientIdentifierType)
List<PatientIdentifierType>	getAllPatientIdentifierTypes(boolean includeRetired)
List<Patient>	getAllPatients(boolean includeVoided)
Integer	getCountOfPatients(String name, String identifier, List<PatientIdentifierType> identifierTypes, boolean matchIdentifierExactly, boolean searchOnNamesOrIdentifiers)
List<Patient>	getDuplicatePatientsByAttributes(List<String> attributes)
Patient	getPatient(Integer patientId)
Patient	getPatientByUuid(String uuid) Auto generated method comment
PatientIdentifier	getPatientIdentifier(Integer patientIdentifierId)
PatientIdentifier	getPatientIdentifierByUuid(String uuid)
List<PatientIdentifier>	getPatientIdentifiers(String identifier, List<PatientIdentifierType> patientIdentifierTypes, List<Location> locations, List<Patient> patients, Boolean isPreferred)
PatientIdentifierType	getPatientIdentifierType(Integer patientIdentifierTypeId)
PatientIdentifierType	getPatientIdentifierTypeByUuid(String uuid) Auto generated method comment
List<PatientIdentifierType>	getPatientIdentifierTypes(String name, String format, Boolean required, Boolean hasCheckDigit)
List<Patient>	getPatients(String name, String identifier, List<PatientIdentifierType> identifierTypes, boolean matchIdentifierExactly, Integer start, Integer length, boolean searchOnNamesOrIdentifiers)
boolean	isIdentifierInUseByAnotherPatient(PatientIdentifier patientIdentifier)
Patient	savePatient(Patient patient)
PatientIdentifier	savePatientIdentifier(PatientIdentifier patientIdentifier)
PatientIdentifierType	savePatientIdentifierType(PatientIdentifierType patientIdentifierType)

Method Detail

savePatient

Patient savePatient(Patient patient)
             throws DAOException

Throws:

DAOException

See Also:

PatientService.savePatient(org.openmrs.Patient)

getPatient

Patient getPatient(Integer patientId)
            throws DAOException

Throws:

DAOException

See Also:

PatientService.getPatient(Integer)

deletePatient

void deletePatient(Patient patient)
            throws DAOException

Delete patient from database. This should not be called except for testing and administration purposes. Use the void method instead

Parameters:

patient - patient to be deleted

Throws:

DAOException

See Also:

PatientService.deletePatient(org.openmrs.Patient), PatientService.voidPatient(Patient, String)

getAllPatients

List<Patient> getAllPatients(boolean includeVoided)
                      throws DAOException

Throws:

DAOException

See Also:

PatientService.getAllPatients(boolean)

getPatients

List<Patient> getPatients(String name,
                          String identifier,
                          List<PatientIdentifierType> identifierTypes,
                          boolean matchIdentifierExactly,
                          Integer start,
                          Integer length,
                          boolean searchOnNamesOrIdentifiers)
                   throws DAOException

Parameters:

searchOnNamesOrIdentifiers - specifies if the logic should find patients that match the name or identifier otherwise find patients that match both the name and identifier

Throws:

DAOException

See Also:

PatientService.getPatients(String, String, List, boolean, Integer, Integer)

Should:

escape percentage character in name phrase, escape underscore character in name phrase, escape an asterix character in name phrase, escape percentage character in identifier phrase, escape underscore character in identifier phrase, escape an asterix character in identifier phrase, get patients with a matching identifier and type

getPatientIdentifiers

List<PatientIdentifier> getPatientIdentifiers(String identifier,
                                              List<PatientIdentifierType> patientIdentifierTypes,
                                              List<Location> locations,
                                              List<Patient> patients,
                                              Boolean isPreferred)
                                       throws DAOException

Throws:

DAOException

See Also:

PatientService.getPatientIdentifiers(java.lang.String, java.util.List, java.util.List, java.util.List, java.lang.Boolean)

savePatientIdentifierType

PatientIdentifierType savePatientIdentifierType(PatientIdentifierType patientIdentifierType)
                                         throws DAOException

Throws:

DAOException

See Also:

PatientService.savePatientIdentifierType(org.openmrs.PatientIdentifierType)

getAllPatientIdentifierTypes

List<PatientIdentifierType> getAllPatientIdentifierTypes(boolean includeRetired)
                                                  throws DAOException

Throws:

DAOException

See Also:

PatientService.getAllPatientIdentifierTypes(boolean)

getPatientIdentifierTypes

List<PatientIdentifierType> getPatientIdentifierTypes(String name,
                                                      String format,
                                                      Boolean required,
                                                      Boolean hasCheckDigit)
                                               throws DAOException

Throws:

DAOException

See Also:

PatientService.getPatientIdentifierTypes(java.lang.String, java.lang.String, java.lang.Boolean, java.lang.Boolean)

getPatientIdentifierType

PatientIdentifierType getPatientIdentifierType(Integer patientIdentifierTypeId)
                                        throws DAOException

Throws:

DAOException

See Also:

PatientService.getPatientIdentifierType(java.lang.Integer)

deletePatientIdentifierType

void deletePatientIdentifierType(PatientIdentifierType patientIdentifierType)
                          throws DAOException

Throws:

DAOException

See Also:

PatientService.purgePatientIdentifierType(org.openmrs.PatientIdentifierType)

getDuplicatePatientsByAttributes

List<Patient> getDuplicatePatientsByAttributes(List<String> attributes)
                                        throws DAOException

Throws:

DAOException

See Also:

PatientService.getDuplicatePatientsByAttributes(java.util.List)

isIdentifierInUseByAnotherPatient

boolean isIdentifierInUseByAnotherPatient(PatientIdentifier patientIdentifier)

See Also:

PatientService.isIdentifierInUseByAnotherPatient(PatientIdentifier)

getPatientByUuid

Patient getPatientByUuid(String uuid)

Auto generated method comment

Parameters:

uuid -

Returns:

getPatientIdentifierByUuid

PatientIdentifier getPatientIdentifierByUuid(String uuid)

getPatientIdentifierTypeByUuid

PatientIdentifierType getPatientIdentifierTypeByUuid(String uuid)

Auto generated method comment

Parameters:

uuid -

Returns:

getPatientIdentifier

PatientIdentifier getPatientIdentifier(Integer patientIdentifierId)
                                throws DAOException

Throws:

DAOException

See Also:

PatientService.getPatientIdentifier(java.lang.Integer)

savePatientIdentifier

PatientIdentifier savePatientIdentifier(PatientIdentifier patientIdentifier)

See Also:

PatientService.savePatientIdentifier(org.openmrs.PatientIdentifier)

deletePatientIdentifier

void deletePatientIdentifier(PatientIdentifier patientIdentifier)
                      throws DAOException

Throws:

DAOException

See Also:

PatientService.purgePatientIdentifier(org.openmrs.PatientIdentifier)

getCountOfPatients

Integer getCountOfPatients(String name,
                           String identifier,
                           List<PatientIdentifierType> identifierTypes,
                           boolean matchIdentifierExactly,
                           boolean searchOnNamesOrIdentifiers)

Parameters:

searchOnNamesOrIdentifiers - specifies if the logic should find patients that match the name or identifier otherwise find patients that match both the name and identifier

See Also:

PatientService.getCountOfPatients(String)