| Package | Description | 
|---|---|
| org.openmrs.api | 
 
The primary OpenMRS API interfaces. 
 | 
| org.openmrs.api.context | 
 This package describes the context framework through which
authentication is performed and services provided for the OpenMRS system. 
 | 
| org.openmrs.api.impl | |
| org.openmrs.hl7 | 
 OpenMRS HL7 module. 
 | 
| org.openmrs.hl7.impl | |
| org.openmrs.notification | |
| org.openmrs.notification.impl | |
| org.openmrs.scheduler | |
| org.openmrs.scheduler.timer | 
| Modifier and Type | Interface and Description | 
|---|---|
interface  | 
AdministrationService
Contains methods pertaining to doing some administrative tasks in OpenMRS
 
 Use: 
List<GlobalProperty> globalProperties = Context.getAdministrationService().getGlobalProperties();  | 
interface  | 
CohortService
API methods related to Cohorts and CohortDefinitions
 
 A Cohort is a list of patient ids. 
 | 
interface  | 
ConceptService
Contains methods pertaining to creating/updating/deleting/retiring Concepts, Drugs, Concept
 Proposals, and all other things 'Concept'. 
 | 
interface  | 
ConditionService
This interface defines methods for condition objects. 
 | 
interface  | 
DatatypeService
API methods related to  
CustomDatatype and CustomDatatypeHandler. | 
interface  | 
DiagnosisService
 API methods for managing diagnoses
  
 | 
interface  | 
EncounterService
Services for Encounters and Encounter Types 
 | 
interface  | 
FormService
This service contains methods relating to Form, FormField, and Field. 
 | 
interface  | 
LocationService
API methods for managing Locations  
Example Usage: 
   List<Location> locations = Context.getLocationService().getAllLocations();
  | 
interface  | 
MedicationDispenseService
This interface defines an API for interacting with MedicationDispense objects. 
 | 
interface  | 
ObsService
The ObsService deals with saving and getting Obs to/from the database Usage:
 
 
  ObsService obsService = Context.getObsService();
 
  // get the obs for patient with internal identifier of 1235
  List<Obs> someObsList = obsService.getObservationsByPerson(new Patient(1235));
 
 
 There are also a number of convenience methods for extracting obs pertaining to certain Concepts,
 people, or encounters 
 | 
interface  | 
OrderService
Contains methods pertaining to creating/deleting/voiding Orders 
 | 
interface  | 
OrderSetService
Contains methods pertaining to creating/deleting/voiding Order Sets. 
 | 
interface  | 
PatientService
Contains methods pertaining to Patients in the system
 
 
 Usage:
 List<Patient> patients = Context.getPatientService().getAllPatients();
  
 | 
interface  | 
PersonService
Contains methods pertaining to Persons in the system Use: 
List<Person> personObjects = Context.getPersonService().getAllPersons();  | 
interface  | 
ProgramWorkflowService
Contains methods pertaining to management of Programs, ProgramWorkflows, ProgramWorkflowStates,
 PatientPrograms, PatientStates, and ConceptStateConversions Use: 
Program program = new Program(); program.set___(___); ...etc Context.getProgramWorkflowService().saveProgram(program);  | 
interface  | 
ProviderService
This service contains methods relating to providers. 
 | 
interface  | 
SerializationService
Contains methods for retrieving registered Serializer instances, and for
 persisting/retrieving/deleting objects using serialization 
 | 
interface  | 
UserService
Contains methods pertaining to Users in the system Use: 
List<User> users = Context.getUserService().getAllUsers();  | 
interface  | 
VisitService
This service contains methods relating to visits. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
List<OpenmrsService> | 
ServiceContext.getModuleOpenmrsServices(String modulePackage)
Gets a list of services implementing the  
OpenmrsService interface, for a given
 module. | 
static List<OpenmrsService> | 
Context.getModuleOpenmrsServices(String modulePackage)  | 
| Modifier and Type | Method and Description | 
|---|---|
static void | 
Daemon.runStartupForService(OpenmrsService service)
Calls the  
onStartup() method, as a daemon, for an instance
 implementing the OpenmrsService interface. | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
AdministrationServiceImpl
Default implementation of the administration services. 
 | 
class  | 
BaseOpenmrsService
Default method implementations for the OpenmrsService. 
 | 
class  | 
CohortServiceImpl
API functions related to Cohorts 
 | 
class  | 
ConceptServiceImpl
Default Implementation of ConceptService service layer classes 
 | 
class  | 
ConditionServiceImpl
This class implements the  
ConditionService interface
 It defines the methods to handle the condition domain object | 
class  | 
DatatypeServiceImpl
Standard implementation of  
DatatypeService | 
class  | 
DiagnosisServiceImpl  | 
class  | 
EncounterServiceImpl
Default implementation of the  
EncounterService
 
 This class should not be instantiated alone, get a service class from the Context:
 Context.getEncounterService(); | 
class  | 
FormServiceImpl
Default implementation of the  
FormService
 
 This class should not be instantiated alone, get a service class from the Context:
 Context.getFormService(); | 
class  | 
LocationServiceImpl
Default implementation of the  
LocationService
 
 This class should not be instantiated alone, get a service class from the Context:
 Context.getLocationService(); | 
class  | 
MedicationDispenseServiceImpl
This class implements the  
MedicationDispenseService interface
 It defines the API for interacting with MedicationDispense objects. | 
class  | 
ObsServiceImpl
Default implementation of the Observation Service 
 | 
class  | 
OrderServiceImpl
Default implementation of the Order-related services class. 
 | 
class  | 
OrderSetServiceImpl  | 
class  | 
PatientServiceImpl
Default implementation of the patient service. 
 | 
class  | 
PersonServiceImpl
Default implementation of the PersonService
 
 Which implementation to use is determined by Spring. 
 | 
class  | 
ProgramWorkflowServiceImpl
Default implementation of the ProgramWorkflow-related services class. 
 | 
class  | 
ProviderServiceImpl
Default implementation of the  
ProviderService. | 
class  | 
SerializationServiceImpl
Contains methods for retrieving registered OpenmrsSerializer instances, and for
 persisting/retrieving/deleting objects using serialization 
 | 
class  | 
UserServiceImpl
Default implementation of the user service. 
 | 
class  | 
VisitServiceImpl
Default implementation of the  
VisitService. | 
| Modifier and Type | Interface and Description | 
|---|---|
interface  | 
HL7Service
OpenMRS HL7 API 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
HL7ServiceImpl
OpenMRS HL7 API default methods This class shouldn't be instantiated by itself. 
 | 
| Modifier and Type | Interface and Description | 
|---|---|
interface  | 
AlertService
Contains methods pertaining to creating/deleting/voiding Alerts in the system Use: 
Alert alert = new Alert(); alert.set___(___); ...etc Context.getAlertService().saveAlert(alert);  | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
AlertServiceImpl
This class should not be instantiated by itself. 
 | 
| Modifier and Type | Interface and Description | 
|---|---|
interface  | 
SchedulerService
Defines methods required to schedule a task. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
TimerSchedulerServiceImpl
Simple scheduler service that uses JDK timer to trigger and execute scheduled tasks. 
 | 
Copyright © 2024 OpenMRS Inc.. All rights reserved.