|
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
@Transactional public interface PatientService
Contains methods pertaining to Patients in the system
Use:
Listpatients = Context.getPatientService().getAllPatients();
Context,
Patient| Method Summary | |
|---|---|
void |
checkPatientIdentifier(PatientIdentifier patientIdentifier)
Convenience method to validate a patient identifier. |
void |
checkPatientIdentifiers(Patient patient)
Convenience method to validate all identifiers for a given patient |
Patient |
createPatient(Patient patient)
Deprecated. replaced by #savePatient(Patient) |
void |
deletePatient(Patient patient)
Deprecated. replaced by purgePatient(Patient) |
void |
exitFromCare(Patient patient,
java.util.Date dateExited,
Concept reasonForExit)
Convenience method to establish that a patient has left the care center. |
java.util.List<Patient> |
findDuplicatePatients(java.util.Set<java.lang.String> attributes)
Deprecated. use getDuplicatePatientsByAttributes(List) |
Patient |
findPatient(Patient patientToMatch)
Deprecated. use #getPatientByExample(Patient) |
java.util.List<Patient> |
findPatients(java.lang.String query,
boolean includeVoided)
Deprecated. use #getPatients(String) |
java.util.List<Tribe> |
findTribes(java.lang.String search)
Deprecated. tribe will be moved to patient attributes |
java.util.Collection<IdentifierValidator> |
getAllIdentifierValidators()
|
java.util.List<PatientIdentifierType> |
getAllPatientIdentifierTypes()
Get all patientIdentifier types |
java.util.List<PatientIdentifierType> |
getAllPatientIdentifierTypes(boolean includeRetired)
Get all patientIdentifier types |
java.util.List<Patient> |
getAllPatients()
Returns all non voided patients in the system |
java.util.List<Patient> |
getAllPatients(boolean includeVoided)
Returns patients in the system |
IdentifierValidator |
getDefaultIdentifierValidator()
|
java.util.List<Patient> |
getDuplicatePatientsByAttributes(java.util.List<java.lang.String> attributes)
Search the database for patients that both share the given attributes. |
IdentifierValidator |
getIdentifierValidator(java.lang.Class<IdentifierValidator> clazz)
|
IdentifierValidator |
getIdentifierValidator(java.lang.String pivClassName)
|
Patient |
getPatient(java.lang.Integer patientId)
Get patient by internal identifier |
Patient |
getPatientByExample(Patient patientToMatch)
This method tries to find a patient in the database given the attributes on the given patientToMatch object. |
java.util.List<PatientIdentifier> |
getPatientIdentifiers(PatientIdentifierType patientIdentifierType)
Deprecated. replaced by #getPatientIdentifiers(String, List, List, List, Boolean, Boolean, boolean) |
java.util.List<PatientIdentifier> |
getPatientIdentifiers(java.lang.String identifier,
java.util.List<PatientIdentifierType> patientIdentifierTypes,
java.util.List<Location> locations,
java.util.List<Patient> patients,
java.lang.Boolean isPreferred)
Get all patientIdentifiers that match all of the given criteria Voided identifiers are not returned |
java.util.List<PatientIdentifier> |
getPatientIdentifiers(java.lang.String identifier,
PatientIdentifierType pit)
Deprecated. replaced by #getPatientIdentifiers(String, List, List, List, Boolean, Boolean, boolean) |
PatientIdentifierType |
getPatientIdentifierType(java.lang.Integer patientIdentifierTypeId)
Get patientIdentifierType by internal identifier |
PatientIdentifierType |
getPatientIdentifierType(java.lang.String name)
Deprecated. use getPatientIdentifierTypeByName(String) |
PatientIdentifierType |
getPatientIdentifierTypeByName(java.lang.String name)
Get patientIdentifierType by exact name |
java.util.List<PatientIdentifierType> |
getPatientIdentifierTypes()
Deprecated. replaced by getAllPatientIdentifierTypes() |
java.util.List<PatientIdentifierType> |
getPatientIdentifierTypes(java.lang.String name,
java.lang.String format,
java.lang.Boolean required,
java.lang.Boolean hasCheckDigit)
Get all patientIdentifier types that match the given criteria |
java.util.List<Patient> |
getPatients(java.lang.String query)
Generic search on patients based on the given string. |
java.util.List<Patient> |
getPatients(java.lang.String name,
java.lang.String identifier,
java.util.List<PatientIdentifierType> identifierTypes)
Get patients based on given criteria The identifier is matched with the regex OpenmrsConstants.PATIENT_IDENTIFIER_REGEX
Will not return voided patients |
java.util.List<Patient> |
getPatientsByIdentifier(java.lang.String identifier,
boolean includeVoided)
Deprecated. replaced by {@link #getPatients(String, String, List) |
java.util.List<Patient> |
getPatientsByIdentifierPattern(java.lang.String identifier,
boolean includeVoided)
Deprecated. replaced by getPatients( ... ) |
java.util.List<Patient> |
getPatientsByName(java.lang.String name)
Deprecated. replaced by getPatients(String, String, List) |
java.util.List<Patient> |
getPatientsByName(java.lang.String name,
boolean includeVoided)
Deprecated. replaced by getPatients( ... ) |
Tribe |
getTribe(java.lang.Integer tribeId)
Deprecated. tribe will be moved to patient attribute |
java.util.List<Tribe> |
getTribes()
Deprecated. tribe will be moved to patient attributes |
Patient |
identifierInUse(java.lang.String identifier,
PatientIdentifierType type,
Patient ignorePatient)
Deprecated. use #getPatientByIdentifier(String) instead |
void |
mergePatients(Patient preferred,
Patient notPreferred)
Convenience method to join two patients' information into one record. |
void |
processDeath(Patient patient,
java.util.Date dateDied,
Concept causeOfDeath,
java.lang.String otherReason)
Convenience method to establish that a patient has died. |
void |
purgePatient(Patient patient)
Delete patient from database. |
void |
purgePatientIdentifierType(PatientIdentifierType patientIdentifierType)
Purge PatientIdentifierType (cannot be undone) |
PatientIdentifierType |
retirePatientIdentifierType(PatientIdentifierType patientIdentifierType,
java.lang.String reason)
Retire a type of patient identifier |
void |
saveCauseOfDeathObs(Patient patient,
java.util.Date dateDied,
Concept causeOfDeath,
java.lang.String otherReason)
Convenience method that saves the Obs that indicates when and why the patient died (including any "other" reason there might be) |
Patient |
savePatient(Patient patient)
Saved the given patient to the database |
PatientIdentifierType |
savePatientIdentifierType(PatientIdentifierType patientIdentifierType)
Create or update a PatientIdentifierType |
void |
setPatientDAO(PatientDAO dao)
Sets the DAO for this service. |
PatientIdentifierType |
unretirePatientIdentifierType(PatientIdentifierType patientIdentifierType)
Unretire a type of patient identifier |
Patient |
unvoidPatient(Patient patient)
Unvoid patient record |
Patient |
updatePatient(Patient patient)
Deprecated. replaced by #savePatient(Patient) |
void |
updatePatientIdentifier(PatientIdentifier patientIdentifier)
Deprecated. patient identifiers should not be updated directly; rather, after changing patient identifiers, use savePatient(Patient) to save changes to the database |
Patient |
voidPatient(Patient patient,
java.lang.String reason)
Void patient record (functionally delete patient from system) |
| Methods inherited from interface org.openmrs.api.OpenmrsService |
|---|
onShutdown, onStartup |
| Method Detail |
|---|
void setPatientDAO(PatientDAO dao)
dao - DAO for this service
@Authorized(value="Add Patients")
Patient createPatient(Patient patient)
throws APIException
APIExceptionsavePatient(Patient)
@Authorized(value={"Add Patients","Edit Patients"})
Patient savePatient(Patient patient)
throws APIException
patient to the database
patient - patient to be created or updated
APIException
@Authorized(value="View Patients")
@Transactional(readOnly=true)
Patient getPatient(java.lang.Integer patientId)
throws APIException
patientId - internal patient identifier
APIException
Patient updatePatient(Patient patient)
throws APIException
APIExceptionsavePatient(Patient)
@Authorized(value="View Patients")
@Transactional(readOnly=true)
java.util.List<Patient> getAllPatients()
throws APIException
APIExceptiongetAllPatients(boolean)
@Authorized(value="View Patients")
@Transactional(readOnly=true)
java.util.List<Patient> getAllPatients(boolean includeVoided)
throws APIException
includeVoided - if false, will limit the search to non-voided patients
APIException
@Transactional(readOnly=true)
Patient identifierInUse(java.lang.String identifier,
PatientIdentifierType type,
Patient ignorePatient)
@Transactional(readOnly=true)
java.util.List<Patient> getPatientsByIdentifier(java.lang.String identifier,
boolean includeVoided)
throws APIException
APIException
@Transactional(readOnly=true)
@Authorized(value="View Patients")
java.util.List<Patient> getPatients(java.lang.String name,
java.lang.String identifier,
java.util.List<PatientIdentifierType> identifierTypes)
throws APIException
OpenmrsConstants.PATIENT_IDENTIFIER_REGEX
Will not return voided patients
name - this is a slight break from the norm, patients with a
partial match on this name will be returnedidentifier - only patients with a matching identifier are returnedidentifierTypes - the PatientIdentifierTypes to restrict to
APIException
@Transactional(readOnly=true)
@Authorized(value="View Patients")
java.util.List<Patient> getPatientsByIdentifierPattern(java.lang.String identifier,
boolean includeVoided)
throws APIException
APIException
@Transactional(readOnly=true)
@Authorized(value="View Patients")
java.util.List<Patient> getPatientsByName(java.lang.String name)
throws APIException
getPatients(String, String, List)
APIException
@Transactional(readOnly=true)
@Authorized(value="View Patients")
java.util.List<Patient> getPatientsByName(java.lang.String name,
boolean includeVoided)
throws APIException
APIException
@Authorized(value="Delete Patients")
Patient voidPatient(Patient patient,
java.lang.String reason)
throws APIException
patient - patient to be voidedreason - reason for voiding patient
APIException
@Authorized(value="Delete Patients")
Patient unvoidPatient(Patient patient)
throws APIException
patient - patient to be revived
APIException
@Authorized(value="Purge Patients")
void deletePatient(Patient patient)
throws APIException
purgePatient(Patient)
APIExceptionpurgePatient(Patient)
@Authorized(value="Purge Patients")
void purgePatient(Patient patient)
throws APIException
patient - patient to be deleted
APIExceptionvoidPatient(org.openmrs.Patient,java.lang.String)
@Transactional(readOnly=true)
@Authorized(value="View Patient Identifiers")
java.util.List<PatientIdentifier> getPatientIdentifiers(PatientIdentifierType patientIdentifierType)
throws APIException
#getPatientIdentifiers(String, List, List, List, Boolean, Boolean, boolean)
APIException
@Transactional(readOnly=true)
@Authorized(value="View Patient Identifiers")
java.util.List<PatientIdentifier> getPatientIdentifiers(java.lang.String identifier,
java.util.List<PatientIdentifierType> patientIdentifierTypes,
java.util.List<Location> locations,
java.util.List<Patient> patients,
java.lang.Boolean isPreferred)
throws APIException
identifier - the full identifier to match onpatientIdentifierTypes - the type of identifiers to getlocations - the locations of the identifiers to matchpatients - the patients containing these identifiersisPreferred - if true, limits to only preferred identifiers
if false, only non preferred. if null, ignores preferred status
APIException
@Transactional(readOnly=true)
@Authorized(value="View Patient Identifiers")
java.util.List<PatientIdentifier> getPatientIdentifiers(java.lang.String identifier,
PatientIdentifierType pit)
throws APIException
#getPatientIdentifiers(String, List, List, List, Boolean, Boolean, boolean)
APIException
@Authorized(value="Edit Patient Identifiers")
void updatePatientIdentifier(PatientIdentifier patientIdentifier)
throws APIException
savePatient(Patient) to save changes to the database
patientIdentifier - identifier to be updated
APIException
@Authorized(value="Manage Identifier Types")
PatientIdentifierType savePatientIdentifierType(PatientIdentifierType patientIdentifierType)
throws APIException
PatientIdentifierType - identifier type to create or update
APIException
@Transactional(readOnly=true)
@Authorized(value="View Identifier Types")
java.util.List<PatientIdentifierType> getPatientIdentifierTypes()
throws APIException
getAllPatientIdentifierTypes()
APIExceptiongetAllPatientIdentifierTypes()
@Transactional(readOnly=true)
@Authorized(value="View Identifier Types")
java.util.List<PatientIdentifierType> getAllPatientIdentifierTypes()
throws APIException
APIException
@Transactional(readOnly=true)
@Authorized(value="View Identifier Types")
java.util.List<PatientIdentifierType> getAllPatientIdentifierTypes(boolean includeRetired)
throws APIException
includeRetired - true/false whether retired types should be included
APIException
@Transactional(readOnly=true)
@Authorized(value="View Identifier Types")
java.util.List<PatientIdentifierType> getPatientIdentifierTypes(java.lang.String name,
java.lang.String format,
java.lang.Boolean required,
java.lang.Boolean hasCheckDigit)
throws APIException
name - name of the type to match onformat - the string format to match onrequired - if true, limits to only identifiers marked as required
if false, only non required. if null, ignores required bithasCheckDigit - if true, limits to only check digit'd identifiers
if false, only non checkdigit'd. if null, ignores checkDigit
APIException
@Transactional(readOnly=true)
@Authorized(value="View Identifier Types")
PatientIdentifierType getPatientIdentifierType(java.lang.Integer patientIdentifierTypeId)
throws APIException
patientIdentifierType - id
APIException
@Transactional(readOnly=true)
@Authorized(value="View Identifier Types")
PatientIdentifierType getPatientIdentifierType(java.lang.String name)
throws APIException
getPatientIdentifierTypeByName(String)
APIException
@Transactional(readOnly=true)
@Authorized(value="View Identifier Types")
PatientIdentifierType getPatientIdentifierTypeByName(java.lang.String name)
throws APIException
name -
APIException
@Authorized(value="Manage Identifier Types")
PatientIdentifierType retirePatientIdentifierType(PatientIdentifierType patientIdentifierType,
java.lang.String reason)
throws APIException
patientIdentifierType - type of patient identifier to be retiredreason - the reason to retire this identifier type
APIException
@Authorized(value="Manage Identifier Types")
PatientIdentifierType unretirePatientIdentifierType(PatientIdentifierType patientIdentifierType)
throws APIException
patientIdentifierType - type of patient identifier to be unretired
APIException
@Authorized(value="Purge Identifier Types")
void purgePatientIdentifierType(PatientIdentifierType patientIdentifierType)
throws APIException
PatientIdentifierType - to purge from the database
APIException
@Authorized(value="View Patient Identifiers")
void checkPatientIdentifier(PatientIdentifier patientIdentifier)
throws PatientIdentifierException
patientIdentifier - identifier to be validated
PatientIdentifierException - if the identifier is invalidcheckPatientIdentifiers(Patient)
@Authorized(value="View Patient Identifiers")
void checkPatientIdentifiers(Patient patient)
throws PatientIdentifierException
patient - patient for which to validate identifiers
PatientIdentifierException - if one or more of the identifiers are invalidcheckPatientIdentifiers(Patient)
@Transactional(readOnly=true)
@Authorized(value="View Tribes")
Tribe getTribe(java.lang.Integer tribeId)
throws APIException
tribeId -
APIException
@Transactional(readOnly=true)
@Authorized(value="View Tribes")
java.util.List<Tribe> getTribes()
throws APIException
APIException
@Transactional(readOnly=true)
@Authorized(value="View Tribes")
java.util.List<Tribe> findTribes(java.lang.String search)
throws APIException
APIException
@Transactional(readOnly=true)
@Authorized(value="View Patients")
java.util.List<Patient> findPatients(java.lang.String query,
boolean includeVoided)
throws APIException
APIExceptiongetPatients(String)
@Transactional(readOnly=true)
@Authorized(value="View Patients")
java.util.List<Patient> getPatients(java.lang.String query)
throws APIException
query - the string to search on
APIException
@Transactional(readOnly=true)
@Authorized(value="View Patients")
Patient findPatient(Patient patientToMatch)
throws APIException
APIExceptiongetPatientByExample(Patient)
@Transactional(readOnly=true)
@Authorized(value="View Patients")
Patient getPatientByExample(Patient patientToMatch)
throws APIException
patientToMatch object.
Assumes there could be a PersonAttribute on this Patient with
PersonAttributeType.name = "Other Matching Information". This
PersonAttribute has a "value" that is just key value pairs in the form of
key:value;nextkey:nextvalue;
patientToMatch -
APIException
@Transactional(readOnly=true)
@Authorized(value="View Patients")
java.util.List<Patient> findDuplicatePatients(java.util.Set<java.lang.String> attributes)
throws APIException
getDuplicatePatientsByAttributes(List)
APIExceptiongetDuplicatePatientsByAttributes(List)
@Transactional(readOnly=true)
@Authorized(value="View Patients")
java.util.List<Patient> getDuplicatePatientsByAttributes(java.util.List<java.lang.String> attributes)
throws APIException
attributes - attributes on a Person or Patient object. similar to: [gender, tribe,
givenName, middleName, familyName]
APIException
@Authorized(value="Edit Patients")
void mergePatients(Patient preferred,
Patient notPreferred)
throws APIException
nonPreferred
to point at preferrednonPreferred to preferred IFF the data
is missing or null in preferrednotPreferred is marked as voided
preferred - The Patient to merge tonotPreferred - The Patient to merge from (and then void)
APIException
@Authorized(value="Edit Patients")
void exitFromCare(Patient patient,
java.util.Date dateExited,
Concept reasonForExit)
throws APIException
patient - - the patient who has exited caredateExited - - the declared date/time of the patient's exitreasonForExit - - the concept that corresponds with why the patient
has been declared as exited
APIException
@Authorized(value="Edit Patients")
void processDeath(Patient patient,
java.util.Date dateDied,
Concept causeOfDeath,
java.lang.String otherReason)
throws APIException
patient - - the patient who has dieddateDied - - the declared date/time of the patient's deathcauseOfDeath - - the concept that corresponds with the reason the
patient diedotherReason - - if the concept representing the reason is OTHER
NON-CODED, and a string-based "other" reason is supplied
APIException
@Authorized(value={"View Patients","Edit Observations"},
requireAll=true)
void saveCauseOfDeathObs(Patient patient,
java.util.Date dateDied,
Concept causeOfDeath,
java.lang.String otherReason)
throws APIException
patient - - the patient who has dieddateDied - - the declared date/time of the patient's deathcauseOfDeath - - the concept that corresponds with the reason the
patient diedotherReason - - if the concept representing the reason is OTHER
NON-CODED, and a string-based "other" reason is supplied
APIExceptionIdentifierValidator getIdentifierValidator(java.lang.Class<IdentifierValidator> clazz)
identifierValidator - which validator to get.IdentifierValidator getIdentifierValidator(java.lang.String pivClassName)
IdentifierValidator getDefaultIdentifierValidator()
java.util.Collection<IdentifierValidator> getAllIdentifierValidators()
|
OpenMRS-trunk | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||