Package org.openmrs.api

The primary OpenMRS API interfaces.

See:
Description

Interface Summary

AdministrationService	Contains methods pertaining to doing some administrative tasks in OpenMRS Use:
CohortService	API methods related to Cohorts and CohortDefinitions A Cohort is a list of patient ids.
ConceptService	Contains methods pertaining to creating/updating/deleting/retiring Concepts, Drugs, Concept Proposals, and all other things 'Concept' Use: List concepts = Context.getConceptService().getAllConcepts();
DataSetService
EncounterService	Services for Encounters and Encounter Types
FormService	This service contains methods relating to Form, FormField, and Field.
GlobalPropertyListener	This interface allows code to be run when global properties are created, edited, or deleted.
LocationService	API methods for managing Locations Use: List locations = Context.getLocationService().getAllLocations();
ObsService	The ObsService deals with saving and getting Obs to/from the database Usage:
OpenmrsService	Base OpenMRS Service Interface All services registered to the ServiceContext are required to implement this interface.
OrderService	Contains methods pertaining to creating/deleting/voiding Orders and DrugOrders Use:
PatientService	Contains methods pertaining to Patients in the system Use:
PatientSetService
PersonService	Contains methods pertaining to Persons in the system Use:
ProgramWorkflowService	Contains methods pertaining to management of Programs, ProgramWorkflows, ProgramWorkflowStates, PatientPrograms, PatientStates, and ConceptStateConversions Use:
ReportService
UserService	Contains methods pertaining to Users in the system Use:

Class Summary

EventListeners

Holds all OpenMRS event listeners

Enum Summary

OrderService.ORDER_STATUS	The type of status to match on an order.
PatientSetService.BooleanOperator
PatientSetService.GroupMethod
PatientSetService.Modifier
PatientSetService.PatientLocationMethod
PatientSetService.TimeModifier
PersonService.ATTR_VIEW_TYPE	These enumerations are used when determining which person attr types to display.

Exception Summary

APIAuthenticationException	Represents often fatal errors that occur within the API infrastructure involving a user's lack of privileges.
APIException	Represents often fatal errors that occur within the API infrastructure.
BlankIdentifierException
ConceptsLockedException
DuplicateIdentifierException
IdentifierNotUniqueException
InsufficientIdentifiersException
InvalidCheckDigitException
InvalidIdentifierFormatException
MissingRequiredIdentifierException
PatientIdentifierException

Package org.openmrs.api Description

The primary OpenMRS API interfaces. These services provide the necessary methods to access and manipulate OpenMRS domain objects.

Services are obtained from a org.openmrs.api.context.Context (@see org.openmrs.api.context.Context).

These services compose the OpenMRS business layer API. The majority of developer interaction with the OpenMRS system should occur through these services. Lower level (database) API methods are reflected within these services so that business logic hooks may be placed in front of the database layer. Developers should favor calling these services for database access, rather than going directly to the DAO objects in the org.openmrs.api.db package.

For example:

  Context context = ContextFactory.getContext();
  PatientService ps = context.getPatientService();

  // fetch patient with identifier 3-4
  Patient patient = ps.getPatientByIdentifier("3-4");