org.openmrs.api.db

Interface PatientSetDAO

All Known Implementing Classes:

HibernatePatientSetDAO

public interface PatientSetDAO

Method Summary

Modifier and Type	Method and Description
Cohort	convertPatientIdentifier(java.util.List<java.lang.String> identifiers)
java.lang.String	exportXml(Cohort ps) Deprecated.
java.lang.String	exportXml(java.lang.Integer patientId) Deprecated.
java.util.Map<java.lang.Integer,java.util.Collection<java.lang.Integer>>	getActiveDrugIds(java.util.Collection<java.lang.Integer> patientIds, java.util.Date fromDate, java.util.Date toDate)
Cohort	getAllPatients()
java.util.Map<java.lang.Integer,java.util.Map<java.lang.String,java.lang.Object>>	getCharacteristics(Cohort patients)
java.lang.Integer	getCountOfPatients()
java.util.Map<java.lang.Integer,java.util.List<DrugOrder>>	getCurrentDrugOrders(Cohort ps, java.util.List<Concept> drugConcepts)
java.util.Map<java.lang.Integer,PatientState>	getCurrentStates(Cohort ps, ProgramWorkflow wf)
java.util.Map<java.lang.Integer,java.util.List<DrugOrder>>	getDrugOrders(Cohort ps, java.util.List<Concept> drugConcepts)
java.util.Map<java.lang.Integer,java.lang.Object>	getEncounterAttrsByType(Cohort patients, java.util.List<EncounterType> encTypes, java.lang.String attr, java.lang.Boolean earliestFirst)
java.util.Map<java.lang.Integer,Encounter>	getEncounters(Cohort patients)
java.util.List<Encounter>	getEncountersByForm(Cohort patients, java.util.List<Form> forms)
java.util.Map<java.lang.Integer,Encounter>	getEncountersByType(Cohort patients, java.util.List<EncounterType> encType)
java.util.Map<java.lang.Integer,Encounter>	getFirstEncountersByType(Cohort patients, java.util.List<EncounterType> encType)
java.util.Map<java.lang.Integer,java.util.List<Obs>>	getObservations(Cohort patients, Concept concept, java.util.Date fromDate, java.util.Date toDate)
java.util.Map<java.lang.Integer,java.util.List<java.util.List<java.lang.Object>>>	getObservationsValues(Cohort patients, Concept c, java.util.List<java.lang.String> attributes, java.lang.Integer limit, boolean showMostRecentFirst)
java.util.Map<java.lang.Integer,java.lang.Object>	getPatientAttributes(Cohort patients, java.lang.String className, java.lang.String property, boolean returnAll)
java.util.Map<java.lang.Integer,java.lang.String>	getPatientIdentifierByType(Cohort patients, java.util.List<PatientIdentifierType> types)
java.util.Map<java.lang.Integer,PatientProgram>	getPatientPrograms(Cohort ps, Program program, boolean includeVoided, boolean includePast)
java.util.List<Patient>	getPatients(java.util.Collection<java.lang.Integer> patientIds)
Cohort	getPatients(java.lang.Integer start, java.lang.Integer size)
Cohort	getPatientsByCharacteristics(java.lang.String gender, java.util.Date minBirthdate, java.util.Date maxBirthdate, java.lang.Integer minAge, java.lang.Integer maxAge, java.lang.Boolean aliveOnly, java.lang.Boolean deadOnly)
Cohort	getPatientsByCharacteristics(java.lang.String gender, java.util.Date minBirthdate, java.util.Date maxBirthdate, java.lang.Integer minAge, java.lang.Integer maxAge, java.lang.Boolean aliveOnly, java.lang.Boolean deadOnly, java.util.Date effectiveDate)
Cohort	getPatientsByProgramAndState(Program program, java.util.List<ProgramWorkflowState> stateList, java.util.Date fromDate, java.util.Date toDate)
Cohort	getPatientsByRelationship(RelationshipType relType, boolean includeAtoB, boolean includeBtoA, Person target) Returns the cohort of patients matching a particular relationship search.
Cohort	getPatientsHavingDateObs(java.lang.Integer conceptId, java.util.Date startTime, java.util.Date endTime)
Cohort	getPatientsHavingDrugOrder(java.util.List<Drug> drugList, java.util.List<Concept> drugConceptList, java.util.Date startDateFrom, java.util.Date startDateTo, java.util.Date stopDateFrom, java.util.Date stopDateTo, java.lang.Boolean discontinued, java.util.List<Concept> discontinuedReason)
Cohort	getPatientsHavingEncounters(java.util.List<EncounterType> encounterTypeList, Location location, Form form, java.util.Date fromDate, java.util.Date toDate, java.lang.Integer minCount, java.lang.Integer maxCount)
Cohort	getPatientsHavingLocation(java.lang.Integer locationId, PatientSetService.PatientLocationMethod method)
Cohort	getPatientsHavingNumericObs(java.lang.Integer conceptId, PatientSetService.TimeModifier timeModifier, PatientSetService.Modifier modifier, java.lang.Number value, java.util.Date fromDate, java.util.Date toDate)
Cohort	getPatientsHavingObs(java.lang.Integer conceptId, PatientSetService.TimeModifier timeModifier, PatientSetService.Modifier modifier, java.lang.Object value, java.util.Date fromDate, java.util.Date toDate)
Cohort	getPatientsHavingPersonAttribute(PersonAttributeType attribute, java.lang.String value)
Cohort	getPatientsHavingTextObs(java.lang.Integer conceptId, java.lang.String value, PatientSetService.TimeModifier timeModifier)
Cohort	getPatientsInProgram(java.lang.Integer programId, java.util.Date fromDate, java.util.Date toDate)
java.util.Map<java.lang.Integer,java.lang.Object>	getPersonAttributes(Cohort patients, java.lang.String attributeName, java.lang.String joinClass, java.lang.String joinProperty, java.lang.String outputColumn, boolean returnAll)
java.util.Map<java.lang.Integer,java.util.List<Relationship>>	getRelationships(Cohort ps, RelationshipType relType)
java.util.Map<java.lang.Integer,java.util.List<Person>>	getRelatives(Cohort ps, RelationshipType relType, boolean forwards)
java.util.Map<java.lang.Integer,java.lang.String>	getShortPatientDescriptions(java.util.Collection<java.lang.Integer> patientIds)

Method Detail

exportXml

java.lang.String exportXml(Cohort ps)
                    throws DAOException

Deprecated.

Throws:

DAOException

exportXml

java.lang.String exportXml(java.lang.Integer patientId)
                    throws DAOException

Deprecated.

Throws:

DAOException

getAllPatients

Cohort getAllPatients()

getPatientsByCharacteristics

Cohort getPatientsByCharacteristics(java.lang.String gender,
                                    java.util.Date minBirthdate,
                                    java.util.Date maxBirthdate,
                                    java.lang.Integer minAge,
                                    java.lang.Integer maxAge,
                                    java.lang.Boolean aliveOnly,
                                    java.lang.Boolean deadOnly)
                             throws DAOException

Throws:

DAOException

getPatientsByCharacteristics

Cohort getPatientsByCharacteristics(java.lang.String gender,
                                    java.util.Date minBirthdate,
                                    java.util.Date maxBirthdate,
                                    java.lang.Integer minAge,
                                    java.lang.Integer maxAge,
                                    java.lang.Boolean aliveOnly,
                                    java.lang.Boolean deadOnly,
                                    java.util.Date effectiveDate)
                             throws DAOException

Throws:

DAOException

getPatientsHavingDateObs

Cohort getPatientsHavingDateObs(java.lang.Integer conceptId,
                                java.util.Date startTime,
                                java.util.Date endTime)

getPatientsHavingNumericObs

Cohort getPatientsHavingNumericObs(java.lang.Integer conceptId,
                                   PatientSetService.TimeModifier timeModifier,
                                   PatientSetService.Modifier modifier,
                                   java.lang.Number value,
                                   java.util.Date fromDate,
                                   java.util.Date toDate)
                            throws DAOException

Throws:

DAOException

getPatientsHavingObs

Cohort getPatientsHavingObs(java.lang.Integer conceptId,
                            PatientSetService.TimeModifier timeModifier,
                            PatientSetService.Modifier modifier,
                            java.lang.Object value,
                            java.util.Date fromDate,
                            java.util.Date toDate)
                     throws DAOException

Throws:

DAOException

getPatientsHavingEncounters

Cohort getPatientsHavingEncounters(java.util.List<EncounterType> encounterTypeList,
                                   Location location,
                                   Form form,
                                   java.util.Date fromDate,
                                   java.util.Date toDate,
                                   java.lang.Integer minCount,
                                   java.lang.Integer maxCount)
                            throws DAOException

Throws:

DAOException

getPatientsByProgramAndState

Cohort getPatientsByProgramAndState(Program program,
                                    java.util.List<ProgramWorkflowState> stateList,
                                    java.util.Date fromDate,
                                    java.util.Date toDate)
                             throws DAOException

Throws:

DAOException

getPatientsInProgram

Cohort getPatientsInProgram(java.lang.Integer programId,
                            java.util.Date fromDate,
                            java.util.Date toDate)
                     throws DAOException

Throws:

DAOException

getPatientsHavingTextObs

Cohort getPatientsHavingTextObs(java.lang.Integer conceptId,
                                java.lang.String value,
                                PatientSetService.TimeModifier timeModifier)
                         throws DAOException

Throws:

DAOException

getPatientsHavingLocation

Cohort getPatientsHavingLocation(java.lang.Integer locationId,
                                 PatientSetService.PatientLocationMethod method)
                          throws DAOException

Throws:

DAOException

getShortPatientDescriptions

java.util.Map<java.lang.Integer,java.lang.String> getShortPatientDescriptions(java.util.Collection<java.lang.Integer> patientIds)
                                                                       throws DAOException

Throws:

DAOException

getObservations

java.util.Map<java.lang.Integer,java.util.List<Obs>> getObservations(Cohort patients,
                                                                     Concept concept,
                                                                     java.util.Date fromDate,
                                                                     java.util.Date toDate)
                                                              throws DAOException

Throws:

DAOException

getObservationsValues

java.util.Map<java.lang.Integer,java.util.List<java.util.List<java.lang.Object>>> getObservationsValues(Cohort patients,
                                                                                                        Concept c,
                                                                                                        java.util.List<java.lang.String> attributes,
                                                                                                        java.lang.Integer limit,
                                                                                                        boolean showMostRecentFirst)

getEncountersByType

java.util.Map<java.lang.Integer,Encounter> getEncountersByType(Cohort patients,
                                                               java.util.List<EncounterType> encType)

getEncounterAttrsByType

java.util.Map<java.lang.Integer,java.lang.Object> getEncounterAttrsByType(Cohort patients,
                                                                          java.util.List<EncounterType> encTypes,
                                                                          java.lang.String attr,
                                                                          java.lang.Boolean earliestFirst)

getEncounters

java.util.Map<java.lang.Integer,Encounter> getEncounters(Cohort patients)

getFirstEncountersByType

java.util.Map<java.lang.Integer,Encounter> getFirstEncountersByType(Cohort patients,
                                                                    java.util.List<EncounterType> encType)

getPatientAttributes

java.util.Map<java.lang.Integer,java.lang.Object> getPatientAttributes(Cohort patients,
                                                                       java.lang.String className,
                                                                       java.lang.String property,
                                                                       boolean returnAll)

getPatientIdentifierByType

java.util.Map<java.lang.Integer,java.lang.String> getPatientIdentifierByType(Cohort patients,
                                                                             java.util.List<PatientIdentifierType> types)

getCharacteristics

java.util.Map<java.lang.Integer,java.util.Map<java.lang.String,java.lang.Object>> getCharacteristics(Cohort patients)
                                                                                              throws DAOException

Throws:

DAOException

convertPatientIdentifier

Cohort convertPatientIdentifier(java.util.List<java.lang.String> identifiers)
                         throws DAOException

Throws:

DAOException

getPatients

java.util.List<Patient> getPatients(java.util.Collection<java.lang.Integer> patientIds)
                             throws DAOException

Throws:

DAOException

getActiveDrugIds

java.util.Map<java.lang.Integer,java.util.Collection<java.lang.Integer>> getActiveDrugIds(java.util.Collection<java.lang.Integer> patientIds,
                                                                                          java.util.Date fromDate,
                                                                                          java.util.Date toDate)
                                                                                   throws DAOException

Throws:

DAOException

getCurrentStates

java.util.Map<java.lang.Integer,PatientState> getCurrentStates(Cohort ps,
                                                               ProgramWorkflow wf)
                                                        throws DAOException

Throws:

DAOException

getPatientPrograms

java.util.Map<java.lang.Integer,PatientProgram> getPatientPrograms(Cohort ps,
                                                                   Program program,
                                                                   boolean includeVoided,
                                                                   boolean includePast)
                                                            throws DAOException

Throws:

DAOException

getCurrentDrugOrders

java.util.Map<java.lang.Integer,java.util.List<DrugOrder>> getCurrentDrugOrders(Cohort ps,
                                                                                java.util.List<Concept> drugConcepts)
                                                                         throws DAOException

Throws:

DAOException

getDrugOrders

java.util.Map<java.lang.Integer,java.util.List<DrugOrder>> getDrugOrders(Cohort ps,
                                                                         java.util.List<Concept> drugConcepts)
                                                                  throws DAOException

Throws:

DAOException

getRelationships

java.util.Map<java.lang.Integer,java.util.List<Relationship>> getRelationships(Cohort ps,
                                                                               RelationshipType relType)
                                                                        throws DAOException

Throws:

DAOException

getRelatives

java.util.Map<java.lang.Integer,java.util.List<Person>> getRelatives(Cohort ps,
                                                                     RelationshipType relType,
                                                                     boolean forwards)
                                                              throws DAOException

Throws:

DAOException

getPersonAttributes

java.util.Map<java.lang.Integer,java.lang.Object> getPersonAttributes(Cohort patients,
                                                                      java.lang.String attributeName,
                                                                      java.lang.String joinClass,
                                                                      java.lang.String joinProperty,
                                                                      java.lang.String outputColumn,
                                                                      boolean returnAll)

getPatientsHavingPersonAttribute

Cohort getPatientsHavingPersonAttribute(PersonAttributeType attribute,
                                        java.lang.String value)

getPatientsHavingDrugOrder

Cohort getPatientsHavingDrugOrder(java.util.List<Drug> drugList,
                                  java.util.List<Concept> drugConceptList,
                                  java.util.Date startDateFrom,
                                  java.util.Date startDateTo,
                                  java.util.Date stopDateFrom,
                                  java.util.Date stopDateTo,
                                  java.lang.Boolean discontinued,
                                  java.util.List<Concept> discontinuedReason)

getEncountersByForm

java.util.List<Encounter> getEncountersByForm(Cohort patients,
                                              java.util.List<Form> forms)

getPatientsByRelationship

Cohort getPatientsByRelationship(RelationshipType relType,
                                 boolean includeAtoB,
                                 boolean includeBtoA,
                                 Person target)

Returns the cohort of patients matching a particular relationship search. If relType is specified, then search for patients at one or either end of that relationship type. (Which end is controlled by includeAtoB and includeBtoA.) If target is specified, then that person must be at the other end of the relationship.

Parameters:

relType -

includeAtoB -

includeBtoA -

target -

Returns:

patients matching the specified relationship search

getCountOfPatients

java.lang.Integer getCountOfPatients()

getPatients

Cohort getPatients(java.lang.Integer start,
                   java.lang.Integer size)