org.openmrs.api

Interface PatientSetService

All Superinterfaces:

OpenmrsService

All Known Implementing Classes:

PatientSetServiceImpl

@Transactional
public interface PatientSetService
extends OpenmrsService

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PatientSetService.BooleanOperator
static class	PatientSetService.GroupMethod
static class	PatientSetService.Modifier
static class	PatientSetService.PatientLocationMethod
static class	PatientSetService.TimeModifier

Method Summary

Modifier and Type	Method and Description
Cohort	convertPatientIdentifier(java.util.List<java.lang.String> identifiers) TODO write something here
java.lang.String	exportXml(Cohort ps) Export a set of patients to an XML
java.lang.String	exportXml(java.lang.Integer patientId)
Cohort	getAllPatients()
java.util.Map<java.lang.Integer,java.util.Map<java.lang.String,java.lang.Object>>	getCharacteristics(Cohort patients) TODO write something here
java.lang.Integer	getCountOfPatients()
java.util.Map<java.lang.Integer,java.util.List<DrugOrder>>	getCurrentDrugOrders(Cohort ps, Concept drugSet)
java.util.Map<java.lang.Integer,PatientProgram>	getCurrentPatientPrograms(Cohort ps, Program program)
java.util.Map<java.lang.Integer,PatientState>	getCurrentStates(Cohort ps, ProgramWorkflow wf) Gets statistical information about current states of patients within given cohort for specific program workflow
java.util.Map<java.lang.Integer,java.util.List<DrugOrder>>	getDrugOrders(Cohort ps, Concept drugSet)
java.util.Map<java.lang.Integer,java.lang.Object>	getEncounterAttrsByType(Cohort patients, java.util.List<EncounterType> encTypes, java.lang.String attr) TODO write something here
java.util.Map<java.lang.Integer,Encounter>	getEncounters(Cohort patients) This method returns a map of patients matched against their most recent encounters given a Cohort of patients, see EncounterService.getAllEncounters(Cohort) which gets a map of patient matched against lists of all their encounters.
java.util.List<Encounter>	getEncountersByForm(Cohort patients, java.util.List<Form> form) Gets a list of encounters associated with the given form, filtered by the given patient set.
java.util.Map<java.lang.Integer,Encounter>	getEncountersByType(Cohort patients, EncounterType encType) TODO write something here
java.util.Map<java.lang.Integer,Encounter>	getEncountersByType(Cohort patients, java.util.List<EncounterType> encType) TODO write something here
java.util.Map<java.lang.Integer,java.lang.Object>	getFirstEncounterAttrsByType(Cohort patients, java.util.List<EncounterType> encTypes, java.lang.String attr) TODO write something here
java.util.Map<java.lang.Integer,Encounter>	getFirstEncountersByType(Cohort patients, EncounterType encType) TODO write something here
java.util.Map<java.lang.Integer,Encounter>	getFirstEncountersByType(Cohort patients, java.util.List<EncounterType> types) TODO write something here
Cohort	getInverseOfCohort(Cohort cohort) Equivalent to Cohort.subtract(PatientSetService.getAllPatients(), cohort) but may eventually perform faster by delegating to the database.
java.util.Map<java.lang.Integer,java.util.List<Obs>>	getObservations(Cohort patients, Concept concept)
java.util.Map<java.lang.Integer,java.util.List<Obs>>	getObservations(Cohort patients, Concept concept, java.util.Date fromDate, java.util.Date toDate) Date range is inclusive of both endpoints
java.util.Map<java.lang.Integer,java.util.List<java.util.List<java.lang.Object>>>	getObservationsValues(Cohort patients, Concept c) TODO write something here
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) Deprecated. use getObservationsValues(Cohort, Concept, List, Integer, boolean) instead
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) Returns a mapping from patient id to obs for concept c
java.util.Map<java.lang.Integer,java.lang.Object>	getPatientAttributes(Cohort patients, java.lang.String classNameDotProperty, boolean returnAll) TODO write something here
java.util.Map<java.lang.Integer,java.lang.Object>	getPatientAttributes(Cohort patients, java.lang.String className, java.lang.String property, boolean returnAll) TODO write something here
java.util.Map<java.lang.Integer,PatientIdentifier>	getPatientIdentifiersByType(Cohort patients, PatientIdentifierType type) Deprecated. use method by same name that returns just the string instead of the whole object
java.util.Map<java.lang.Integer,java.lang.String>	getPatientIdentifierStringsByType(Cohort patients, PatientIdentifierType type) Gets a map of patient identifiers values by identifier type, indexed by patient primary key.
java.util.Map<java.lang.Integer,PatientProgram>	getPatientPrograms(Cohort ps, Program program) Gets program enrollment data for the given cohort in the given program.
java.util.List<Patient>	getPatients(java.util.Collection<java.lang.Integer> patientIds) TODO write something here
Cohort	getPatients(java.lang.Integer start, java.lang.Integer size) Get a batch of patients that are not voided in the database
Cohort	getPatientsByCharacteristics(java.lang.String gender, java.util.Date minBirthdate, java.util.Date maxBirthdate)
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) Get patients by specified gender, birthdate range, age range, and alive status (all optional)
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) Get patients by specified gender, birthdate range, age range, and alive status (all optional)
Cohort	getPatientsByProgramAndState(Program program, java.util.List<ProgramWorkflowState> stateList, java.util.Date fromDate, java.util.Date toDate) Gets patients who are enrolled in the given program or in the given state(s) at the specified time
Cohort	getPatientsHavingDateObs(java.lang.Integer conceptId, java.util.Date startTime, java.util.Date endTime)
Cohort	getPatientsHavingDrugOrder(java.util.Collection<java.lang.Integer> patientIds, java.util.Collection<java.lang.Integer> takingIds, java.util.Date onDate) Returns a Cohort of patient who had drug orders for a set of drugs active on a certain date.
Cohort	getPatientsHavingDrugOrder(java.util.Collection<java.lang.Integer> patientIds, java.util.Collection<java.lang.Integer> drugIds, PatientSetService.GroupMethod groupMethod, java.util.Date fromDate, java.util.Date toDate) Returns a Cohort of patient who had drug orders for a set of drugs active between a pair of dates.
Cohort	getPatientsHavingDrugOrder(java.util.List<Drug> drug, java.util.List<Concept> drugConcept, 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(EncounterType encounterType, Location location, Form form, java.util.Date fromDate, java.util.Date toDate, java.lang.Integer minCount, java.lang.Integer maxCount) Searches for patients who have encounters as described by the arguments to this method
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) Gets patients who have encounters as described by the parameters specified (all optional)
Cohort	getPatientsHavingLocation(java.lang.Integer locationId)
Cohort	getPatientsHavingLocation(java.lang.Integer locationId, PatientSetService.PatientLocationMethod method)
Cohort	getPatientsHavingLocation(Location loc)
Cohort	getPatientsHavingLocation(Location loc, 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) Searches for patients who have observations as described by the arguments to this method
Cohort	getPatientsHavingPersonAttribute(PersonAttributeType attribute, java.lang.String value) At least one of attribute and value must be non-null
Cohort	getPatientsHavingTextObs(Concept concept, java.lang.String value, PatientSetService.TimeModifier timeModifier)
Cohort	getPatientsHavingTextObs(java.lang.Integer conceptId, java.lang.String value, PatientSetService.TimeModifier timeModifier)
Cohort	getPatientsInProgram(Program program, 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)
void	setPatientSetDAO(PatientSetDAO dao)

Methods inherited from interface org.openmrs.api.OpenmrsService

onShutdown, onStartup

Method Detail

setPatientSetDAO

void setPatientSetDAO(PatientSetDAO dao)

exportXml

@Transactional(readOnly=true)
java.lang.String exportXml(Cohort ps)

Export a set of patients to an XML

Parameters:

ps - The set you want to export as XML

Returns:

an XML representation of this patient-set, including patient characteristics, and observations

exportXml

@Transactional(readOnly=true)
java.lang.String exportXml(java.lang.Integer patientId)

getAllPatients

@Transactional(readOnly=true)
Cohort getAllPatients()
                                             throws DAOException

Throws:

DAOException

getPatientsByCharacteristics

@Transactional(readOnly=true)
Cohort getPatientsByCharacteristics(java.lang.String gender,
                                                                  java.util.Date minBirthdate,
                                                                  java.util.Date maxBirthdate)
                                                           throws DAOException

Throws:

DAOException

getPatientsByCharacteristics

@Transactional(readOnly=true)
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

Get patients by specified gender, birthdate range, age range, and alive status (all optional)

Parameters:

gender -

minBirthdate -

maxBirthdate -

minAge -

maxAge -

aliveOnly -

deadOnly -

Returns:

Cohort with all matching patients

Throws:

DAOException

getPatientsByCharacteristics

@Transactional(readOnly=true)
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

Get patients by specified gender, birthdate range, age range, and alive status (all optional)

Parameters:

gender -

minBirthdate -

maxBirthdate -

minAge -

maxAge -

aliveOnly -

deadOnly -

effectiveDate -

Returns:

Cohort with all matching patients

Throws:

DAOException

getPatientsHavingNumericObs

@Transactional(readOnly=true)
Cohort getPatientsHavingNumericObs(java.lang.Integer conceptId,
                                                                 PatientSetService.TimeModifier timeModifier,
                                                                 PatientSetService.Modifier modifier,
                                                                 java.lang.Number value,
                                                                 java.util.Date fromDate,
                                                                 java.util.Date toDate)

getPatientsHavingObs

@Transactional(readOnly=true)
Cohort getPatientsHavingObs(java.lang.Integer conceptId,
                                                          PatientSetService.TimeModifier timeModifier,
                                                          PatientSetService.Modifier modifier,
                                                          java.lang.Object value,
                                                          java.util.Date fromDate,
                                                          java.util.Date toDate)

Searches for patients who have observations as described by the arguments to this method

Parameters:

conceptId -

timeModifier -

modifier -

value -

fromDate -

toDate -

Returns:

all patients with observations matching the arguments to this method

getPatientsHavingEncounters

@Transactional(readOnly=true)
Cohort getPatientsHavingEncounters(EncounterType encounterType,
                                                                 Location location,
                                                                 Form form,
                                                                 java.util.Date fromDate,
                                                                 java.util.Date toDate,
                                                                 java.lang.Integer minCount,
                                                                 java.lang.Integer maxCount)

Searches for patients who have encounters as described by the arguments to this method

Parameters:

encounterType -

location -

form -

fromDate -

toDate -

minCount -

maxCount -

Returns:

all patients with encounters matching the arguments to this method

getPatientsHavingEncounters

@Transactional(readOnly=true)
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)

Gets patients who have encounters as described by the parameters specified (all optional)

Parameters:

encounterTypeList -

location -

form -

fromDate -

toDate -

minCount -

maxCount -

Returns:

Cohort with matching Patients

getPatientsByProgramAndState

@Transactional(readOnly=true)
Cohort getPatientsByProgramAndState(Program program,
                                                                  java.util.List<ProgramWorkflowState> stateList,
                                                                  java.util.Date fromDate,
                                                                  java.util.Date toDate)

Gets patients who are enrolled in the given program or in the given state(s) at the specified time

Parameters:

program -

stateList -

fromDate -

toDate -

Returns:

Cohort with matching Patients

getPatientsInProgram

@Transactional(readOnly=true)
Cohort getPatientsInProgram(Program program,
                                                          java.util.Date fromDate,
                                                          java.util.Date toDate)

getPatientsHavingDateObs

@Transactional(readOnly=true)
Cohort getPatientsHavingDateObs(java.lang.Integer conceptId,
                                                              java.util.Date startTime,
                                                              java.util.Date endTime)

getPatientsHavingTextObs

@Transactional(readOnly=true)
Cohort getPatientsHavingTextObs(Concept concept,
                                                              java.lang.String value,
                                                              PatientSetService.TimeModifier timeModifier)

getPatientsHavingTextObs

@Transactional(readOnly=true)
Cohort getPatientsHavingTextObs(java.lang.Integer conceptId,
                                                              java.lang.String value,
                                                              PatientSetService.TimeModifier timeModifier)

getPatientsHavingLocation

@Transactional(readOnly=true)
Cohort getPatientsHavingLocation(Location loc)

getPatientsHavingLocation

@Transactional(readOnly=true)
Cohort getPatientsHavingLocation(Location loc,
                                                               PatientSetService.PatientLocationMethod method)

getPatientsHavingLocation

@Transactional(readOnly=true)
Cohort getPatientsHavingLocation(java.lang.Integer locationId)

getPatientsHavingLocation

@Transactional(readOnly=true)
Cohort getPatientsHavingLocation(java.lang.Integer locationId,
                                                               PatientSetService.PatientLocationMethod method)

getPatientsHavingDrugOrder

@Transactional(readOnly=true)
Cohort getPatientsHavingDrugOrder(java.util.Collection<java.lang.Integer> patientIds,
                                                                java.util.Collection<java.lang.Integer> takingIds,
                                                                java.util.Date onDate)

Returns a Cohort of patient who had drug orders for a set of drugs active on a certain date. Can also be used to find patient with no drug orders on that date.

Parameters:

patientIds - Collection of patientIds you're interested in. NULL means all patients.

takingIds - Collection of drugIds the patient is taking. (Or the empty set to mean "any drug" or NULL to mean "no drugs")

onDate - Which date to look at the patients' drug orders. (NULL defaults to now().)

getPatientsHavingDrugOrder

@Transactional(readOnly=true)
Cohort getPatientsHavingDrugOrder(java.util.Collection<java.lang.Integer> patientIds,
                                                                java.util.Collection<java.lang.Integer> drugIds,
                                                                PatientSetService.GroupMethod groupMethod,
                                                                java.util.Date fromDate,
                                                                java.util.Date toDate)

Returns a Cohort of patient who had drug orders for a set of drugs active between a pair of dates. Can also be used to find patient with no drug orders on that date.

Parameters:

patientIds - Collection of patientIds you're interested in. NULL means all patients.

drugIds - Collection of drugIds the patient is taking. (Or the empty set to mean "any drug" or NULL to mean "no drugs")

groupMethod - whether to do NONE, ALL, or ANY of the list of specified ids.

fromDate - Beginning of date range to look at (NULL defaults to toDate if that isn't null, or now() if it is.)

toDate - End of date range to look at (NULL defaults to fromDate if that isn't null, or now() if it is.)

Returns:

Cohort with matching Patients

getPatientsHavingDrugOrder

@Transactional(readOnly=true)
Cohort getPatientsHavingDrugOrder(java.util.List<Drug> drug,
                                                                java.util.List<Concept> drugConcept,
                                                                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)

Returns:

A Cohort of patients who had drug order for particular drugs or generics, with start dates within a range, with end dates within a range, and a reason for discontinuation.

getPatientsHavingPersonAttribute

@Transactional(readOnly=true)
Cohort getPatientsHavingPersonAttribute(PersonAttributeType attribute,
                                                                      java.lang.String value)

At least one of attribute and value must be non-null

Parameters:

attribute - if not null, look for this attribute

value - if not null, look for this value

Returns:

Cohort of patients who have a person attribute (optionally) with attributeType of attribute and (optionally) value of value.

getShortPatientDescriptions

@Transactional(readOnly=true)
java.util.Map<java.lang.Integer,java.lang.String> getShortPatientDescriptions(java.util.Collection<java.lang.Integer> patientIds)

getObservations

@Transactional(readOnly=true)
java.util.Map<java.lang.Integer,java.util.List<Obs>> getObservations(Cohort patients,
                                                                                                   Concept concept)

getObservations

@Transactional(readOnly=true)
java.util.Map<java.lang.Integer,java.util.List<Obs>> getObservations(Cohort patients,
                                                                                                   Concept concept,
                                                                                                   java.util.Date fromDate,
                                                                                                   java.util.Date toDate)

Date range is inclusive of both endpoints

getObservationsValues

@Transactional(readOnly=true)
java.util.Map<java.lang.Integer,java.util.List<java.util.List<java.lang.Object>>> getObservationsValues(Cohort patients,
                                                                                                                                      Concept c)

TODO write something here

Parameters:

patients -

c -

Returns:

Map>

getObservationsValues

@Deprecated
 @Transactional(readOnly=true)
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)

Deprecated. use getObservationsValues(Cohort, Concept, List, Integer, boolean) instead

getObservationsValues

@Transactional(readOnly=true)
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)

Returns a mapping from patient id to obs for concept c

The returned List< attribute value > is [obs value, attr value, attr value, attr value...] The returned List> represents the obs rows

Parameters:

patients - the cohort to restrict to. if null, then all patients are fetched

c - the concept to look for in obs.concept_id

attributes - list of attributes

limit - the number of patients to limit the results to. If null or less than zero, return all

showMostRecentFirst - if true, obs with the highest obsDatetime will be first in the List>

Returns:

Map>>

getEncountersByType

@Transactional(readOnly=true)
java.util.Map<java.lang.Integer,Encounter> getEncountersByType(Cohort patients,
                                                                                             EncounterType encType)

TODO write something here

Parameters:

patients - Cohort of patients to search

encType - the type of the encounter

Returns:

Map of patientId to encounters matching a specific type

getEncounterAttrsByType

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

TODO write something here

Parameters:

patients - Cohort of patients to search

encTypes - List to include in the search

attr - String of attributes to get

Returns:

Map of encounter attributes

getEncountersByType

@Transactional(readOnly=true)
java.util.Map<java.lang.Integer,Encounter> getEncountersByType(Cohort patients,
                                                                                             java.util.List<EncounterType> encType)

TODO write something here

Parameters:

patients - Cohort of patients to search

encType - List to include in the search

Returns:

Map of patientId to encounters matching a specific type

getEncounters

@Transactional(readOnly=true)
java.util.Map<java.lang.Integer,Encounter> getEncounters(Cohort patients)

This method returns a map of patients matched against their most recent encounters given a Cohort of patients, see EncounterService.getAllEncounters(Cohort) which gets a map of patient matched against lists of all their encounters.

Parameters:

patients - Cohort of patients to search

Returns:

Map of all encounters for specified patients.

See Also:

EncounterService.getAllEncounters(Cohort)

getFirstEncountersByType

@Transactional(readOnly=true)
java.util.Map<java.lang.Integer,Encounter> getFirstEncountersByType(Cohort patients,
                                                                                                  EncounterType encType)

TODO write something here

Parameters:

patients - Cohort of patients to search

encType -

Returns:

Map of patientId to first encounters of specified patients, from a specific type

getFirstEncountersByType

@Transactional(readOnly=true)
java.util.Map<java.lang.Integer,Encounter> getFirstEncountersByType(Cohort patients,
                                                                                                  java.util.List<EncounterType> types)

TODO write something here

Parameters:

patients - Cohort of patients to search

types - List to include in the search

Returns:

Map of patientId to first encounters of specified patients, from a specific list of types

getFirstEncounterAttrsByType

@Transactional(readOnly=true)
java.util.Map<java.lang.Integer,java.lang.Object> getFirstEncounterAttrsByType(Cohort patients,
                                                                                                             java.util.List<EncounterType> encTypes,
                                                                                                             java.lang.String attr)

TODO write something here

Parameters:

patients - Cohort of patients to search

encTypes - List to include in the search

attr -

Returns:

Map of patientId to first encounters properties

getPatientAttributes

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

TODO write something here

Parameters:

patients - Cohort of patients to search

className -

property -

returnAll -

Returns:

Map of patientId to patient properties

getPatientAttributes

@Transactional(readOnly=true)
java.util.Map<java.lang.Integer,java.lang.Object> getPatientAttributes(Cohort patients,
                                                                                                     java.lang.String classNameDotProperty,
                                                                                                     boolean returnAll)

TODO write something here

Parameters:

patients -

classNameDotProperty -

returnAll -

Returns:

Map of patientId to patient properties

getPersonAttributes

@Transactional(readOnly=true)
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)

Parameters:

patients -

attributeName -

joinClass -

joinProperty -

outputColumn -

returnAll -

Returns:

Map of patientId to person properties

getCharacteristics

@Transactional(readOnly=true)
java.util.Map<java.lang.Integer,java.util.Map<java.lang.String,java.lang.Object>> getCharacteristics(Cohort patients)

TODO write something here

Parameters:

patients - Cohort of patients to look up

Returns:

Map> with characteristics of specified patients

getPatientIdentifiersByType

@Deprecated
 @Transactional(readOnly=true)
java.util.Map<java.lang.Integer,PatientIdentifier> getPatientIdentifiersByType(Cohort patients,
                                                                                                                          PatientIdentifierType type)

Deprecated. use method by same name that returns just the string instead of the whole object

The PatientIdentifer object in the returned map now ONLY contains the identifier string, no other data is available

getPatientIdentifierStringsByType

@Transactional(readOnly=true)
java.util.Map<java.lang.Integer,java.lang.String> getPatientIdentifierStringsByType(Cohort patients,
                                                                                                                  PatientIdentifierType type)

Gets a map of patient identifiers values by identifier type, indexed by patient primary key.

Parameters:

patients - Cohort of patients to look up

type - PatientIdentifierType to retrieve

Returns:

Map of patient identifiers (strings) for all patients in the specified cohort

convertPatientIdentifier

@Transactional(readOnly=true)
Cohort convertPatientIdentifier(java.util.List<java.lang.String> identifiers)

TODO write something here

Parameters:

identifiers - List of String patient identifiers

Returns:

Cohort of patients matching specified identifiers

getPatients

@Transactional(readOnly=true)
java.util.List<Patient> getPatients(java.util.Collection<java.lang.Integer> patientIds)

TODO write something here

Parameters:

patientIds -

Returns:

List of matching patients

getCurrentStates

@Transactional(readOnly=true)
java.util.Map<java.lang.Integer,PatientState> getCurrentStates(Cohort ps,
                                                                                             ProgramWorkflow wf)

Gets statistical information about current states of patients within given cohort for specific program workflow

Parameters:

ps - the patient's cohort object

wf - the program workflow instance

Returns:

map containing statistic information about patient states in cohort

getCurrentPatientPrograms

@Transactional(readOnly=true)
java.util.Map<java.lang.Integer,PatientProgram> getCurrentPatientPrograms(Cohort ps,
                                                                                                        Program program)

getPatientPrograms

@Transactional(readOnly=true)
java.util.Map<java.lang.Integer,PatientProgram> getPatientPrograms(Cohort ps,
                                                                                                 Program program)

Gets program enrollment data for the given cohort in the given program. The behavior is not specified if a patient is enrolled in the same program twice simultaneously.

Parameters:

ps - the cohort to get data for

program - the program to look for enrollments in

Returns:

a Map from patientId to PatientProgram

getRelationships

@Transactional(readOnly=true)
java.util.Map<java.lang.Integer,java.util.List<Relationship>> getRelationships(Cohort ps,
                                                                                                             RelationshipType relType)

getRelatives

@Transactional(readOnly=true)
java.util.Map<java.lang.Integer,java.util.List<Person>> getRelatives(Cohort ps,
                                                                                                   RelationshipType relType,
                                                                                                   boolean forwards)

getCurrentDrugOrders

@Transactional(readOnly=true)
java.util.Map<java.lang.Integer,java.util.List<DrugOrder>> getCurrentDrugOrders(Cohort ps,
                                                                                                              Concept drugSet)

Returns:

all active drug orders whose drug concept is in the given set (or all drugs if that's null)

getDrugOrders

@Transactional(readOnly=true)
java.util.Map<java.lang.Integer,java.util.List<DrugOrder>> getDrugOrders(Cohort ps,
                                                                                                       Concept drugSet)

Returns:

all active or finished drug orders whose drug concept is in the given set (or all drugs if that's null)

getEncountersByForm

@Transactional(readOnly=true)
java.util.List<Encounter> getEncountersByForm(Cohort patients,
                                                                            java.util.List<Form> form)

Gets a list of encounters associated with the given form, filtered by the given patient set.

Parameters:

patients - Cohort of the patients to filter by (null will return all encounters for all patients)

form - List

of the forms to filter by

getInverseOfCohort

Cohort getInverseOfCohort(Cohort cohort)

Equivalent to Cohort.subtract(PatientSetService.getAllPatients(), cohort) but may eventually perform faster by delegating to the database. (The current implementation has *not* been optimized.)

Parameters:

cached -

Returns:

Since:

1.8

getCountOfPatients

java.lang.Integer getCountOfPatients()

Returns:

number of unvoided patients in the database

Since:

1.8

getPatients

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

Get a batch of patients that are not voided in the database

Parameters:

start - the starting index

size - the number of patients to get in this batch

Returns:

a Cohort with patient ids

Since:

1.8