Uses of Package
org.openmrs.api

Packages that use org.openmrs.api

Package	Description
org.openmrs	These classes represent the core domain objects for the OpenMRS project.
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.db	OpenMRS database layer interfaces.
org.openmrs.api.db.hibernate	Resources for Hibernate ORM.
org.openmrs.api.handler
org.openmrs.api.impl
org.openmrs.arden
org.openmrs.arden.impl
org.openmrs.customdatatype
org.openmrs.hl7	OpenMRS HL7 module.
org.openmrs.hl7.handler
org.openmrs.hl7.impl
org.openmrs.layout.web.address
org.openmrs.logic.result
org.openmrs.notification
org.openmrs.notification.impl
org.openmrs.obs
org.openmrs.obs.handler
org.openmrs.order
org.openmrs.patient
org.openmrs.report	Deprecated
org.openmrs.report.impl
org.openmrs.reporting	Deprecated
org.openmrs.reporting.export
org.openmrs.reporting.impl
org.openmrs.scheduler
org.openmrs.scheduler.timer
org.openmrs.util	Shared utilities for OpenMRS classes
org.openmrs.validator
org.openmrs.web.controller
org.openmrs.web.dwr
org.openmrs.web.filter.initialization

Classes in org.openmrs.api used by org.openmrs

Class and Description
APIException Represents often fatal errors that occur within the API infrastructure.
ConceptNameType The concept name type enumeration FULLY_SPECIFIED - Indicates that the name is marked as the fully specified name, which is returned by default for a locale in case there is no preferred name set, a concept can have only one fully specified name per locale.

Classes in org.openmrs.api used by org.openmrs.api

Class and Description
APIException Represents often fatal errors that occur within the API infrastructure.
ConceptNameType The concept name type enumeration FULLY_SPECIFIED - Indicates that the name is marked as the fully specified name, which is returned by default for a locale in case there is no preferred name set, a concept can have only one fully specified name per locale.
ConceptsLockedException This exception is thrown when a specific implementation has chosen to lock down their concepts and prevent editing.
EncounterTypeLockedException This exception is thrown when a encounter types are locked and the user tries to edit an encounter type type, this is done by a global property being true/false.
GlobalPropertyListener This interface allows code to be run when global properties are created, edited, or deleted.
OpenmrsService Base OpenMRS Service Interface All services registered to the ServiceContext are required to implement this interface.
OrderContext Contains contextual information like the OrderType, CareSetting and any other custom attributes that are passed to the service layer when placing a new Order E.g you could add a user defined order number from a form that can be looked up from the context and returned by a custom OrderNumberGenerator
PasswordException Represents common exceptions that happen when validating a User's password.
PatientIdentifierException
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.

Classes in org.openmrs.api used by org.openmrs.api.context

Class and Description
ActiveListService Contains generic methods pertaining to Active Lists in the system
AdministrationService Contains methods pertaining to doing some administrative tasks in OpenMRS
APIException Represents often fatal errors that occur within the API infrastructure.
CohortService API methods related to Cohorts and CohortDefinitions A Cohort is a list of patient ids. A CohortDefinition is a search strategy which can be used to arrive at a cohort.
ConceptService Contains methods pertaining to creating/updating/deleting/retiring Concepts, Drugs, Concept Proposals, and all other things 'Concept'.
DataSetService Deprecated. see reportingcompatibility module
DatatypeService API methods related to CustomDatatype and CustomDatatypeHandler.
EncounterService Services for Encounters and Encounter Types
FormService This service contains methods relating to Form, FormField, and Field.
LocationService API methods for managing Locations Example Usage: 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
PatientService Contains methods pertaining to Patients in the system
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:
ProviderService This service contains methods relating to providers.
ReportService Deprecated. see reportingcompatibility module
SerializationService Contains methods for retrieving registered Serializer instances, and for persisting/retrieving/deleting objects using serialization
UserService Contains methods pertaining to Users in the system Use:
VisitService This service contains methods relating to visits.

Classes in org.openmrs.api used by org.openmrs.api.db

Class and Description
APIException Represents often fatal errors that occur within the API infrastructure.
PatientSetService.Modifier
PatientSetService.PatientLocationMethod
PatientSetService.TimeModifier

Classes in org.openmrs.api used by org.openmrs.api.db.hibernate

Class and Description
APIException Represents often fatal errors that occur within the API infrastructure.
PatientSetService.Modifier
PatientSetService.PatientLocationMethod
PatientSetService.TimeModifier

Classes in org.openmrs.api used by org.openmrs.api.handler

Class and Description
APIException Represents often fatal errors that occur within the API infrastructure.

Classes in org.openmrs.api used by org.openmrs.api.impl

Class and Description
ActiveListService Contains generic methods pertaining to Active Lists in the system
AdministrationService Contains methods pertaining to doing some administrative tasks in OpenMRS
APIException Represents often fatal errors that occur within the API infrastructure.
CohortService API methods related to Cohorts and CohortDefinitions A Cohort is a list of patient ids. A CohortDefinition is a search strategy which can be used to arrive at a cohort.
ConceptService Contains methods pertaining to creating/updating/deleting/retiring Concepts, Drugs, Concept Proposals, and all other things 'Concept'.
ConceptsLockedException This exception is thrown when a specific implementation has chosen to lock down their concepts and prevent editing.
DatatypeService API methods related to CustomDatatype and CustomDatatypeHandler.
EncounterService Services for Encounters and Encounter Types
EventListeners Holds all OpenMRS event listeners
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 Example Usage: 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.
OrderContext Contains contextual information like the OrderType, CareSetting and any other custom attributes that are passed to the service layer when placing a new Order E.g you could add a user defined order number from a form that can be looked up from the context and returned by a custom OrderNumberGenerator
OrderNumberGenerator Will be implemented by classes that auto generate order numbers.
OrderService Contains methods pertaining to creating/deleting/voiding Orders
PatientIdentifierException
PatientService Contains methods pertaining to Patients in the system
PatientSetService
PatientSetService.GroupMethod
PatientSetService.Modifier
PatientSetService.PatientLocationMethod
PatientSetService.TimeModifier
PersonService Contains methods pertaining to Persons in the system Use:
PersonService.ATTR_VIEW_TYPE These enumerations are used when determining which person attr types to display.
ProgramWorkflowService Contains methods pertaining to management of Programs, ProgramWorkflows, ProgramWorkflowStates, PatientPrograms, PatientStates, and ConceptStateConversions Use:
ProviderService This service contains methods relating to providers.
SerializationService Contains methods for retrieving registered Serializer instances, and for persisting/retrieving/deleting objects using serialization
UserService Contains methods pertaining to Users in the system Use:
VisitService This service contains methods relating to visits.

Classes in org.openmrs.api used by org.openmrs.arden

Class and Description
APIException Represents often fatal errors that occur within the API infrastructure.

Classes in org.openmrs.api used by org.openmrs.arden.impl

Class and Description
APIException Represents often fatal errors that occur within the API infrastructure.

Classes in org.openmrs.api used by org.openmrs.customdatatype

Class and Description
APIException Represents often fatal errors that occur within the API infrastructure.

Classes in org.openmrs.api used by org.openmrs.hl7

Class and Description
APIException Represents often fatal errors that occur within the API infrastructure.
OpenmrsService Base OpenMRS Service Interface All services registered to the ServiceContext are required to implement this interface.

Classes in org.openmrs.api used by org.openmrs.hl7.handler

Class and Description
APIException Represents often fatal errors that occur within the API infrastructure.

Classes in org.openmrs.api used by org.openmrs.hl7.impl

Class and Description
APIException Represents often fatal errors that occur within the API infrastructure.
OpenmrsService Base OpenMRS Service Interface All services registered to the ServiceContext are required to implement this interface.

Classes in org.openmrs.api used by org.openmrs.layout.web.address

Class and Description
GlobalPropertyListener This interface allows code to be run when global properties are created, edited, or deleted.

Classes in org.openmrs.api used by org.openmrs.logic.result

Class and Description
APIException Represents often fatal errors that occur within the API infrastructure.

Classes in org.openmrs.api used by org.openmrs.notification

Class and Description
APIException Represents often fatal errors that occur within the API infrastructure.
OpenmrsService Base OpenMRS Service Interface All services registered to the ServiceContext are required to implement this interface.

Classes in org.openmrs.api used by org.openmrs.notification.impl

Class and Description
APIException Represents often fatal errors that occur within the API infrastructure.
OpenmrsService Base OpenMRS Service Interface All services registered to the ServiceContext are required to implement this interface.

Classes in org.openmrs.api used by org.openmrs.obs

Class and Description
APIException Represents often fatal errors that occur within the API infrastructure.

Classes in org.openmrs.api used by org.openmrs.obs.handler

Class and Description
APIException Represents often fatal errors that occur within the API infrastructure.

Classes in org.openmrs.api used by org.openmrs.order

Class and Description
GlobalPropertyListener This interface allows code to be run when global properties are created, edited, or deleted.

Classes in org.openmrs.api used by org.openmrs.patient

Class and Description
APIException Represents often fatal errors that occur within the API infrastructure.

Classes in org.openmrs.api used by org.openmrs.report

Class and Description
APIException Represents often fatal errors that occur within the API infrastructure.

Classes in org.openmrs.api used by org.openmrs.report.impl

Class and Description
APIException Represents often fatal errors that occur within the API infrastructure.
DataSetService Deprecated. see reportingcompatibility module
ReportService Deprecated. see reportingcompatibility module

Classes in org.openmrs.api used by org.openmrs.reporting

Class and Description
APIException Represents often fatal errors that occur within the API infrastructure.
OpenmrsService Base OpenMRS Service Interface All services registered to the ServiceContext are required to implement this interface.
PatientSetService.BooleanOperator
PatientSetService.GroupMethod
PatientSetService.Modifier
PatientSetService.PatientLocationMethod
PatientSetService.TimeModifier

Classes in org.openmrs.api used by org.openmrs.reporting.export

Class and Description
ConceptService Contains methods pertaining to creating/updating/deleting/retiring Concepts, Drugs, Concept Proposals, and all other things 'Concept'.
EncounterService Services for Encounters and Encounter Types
PatientService Contains methods pertaining to Patients in the system
PatientSetService

Classes in org.openmrs.api used by org.openmrs.reporting.impl

Class and Description
APIException Represents often fatal errors that occur within the API infrastructure.
OpenmrsService Base OpenMRS Service Interface All services registered to the ServiceContext are required to implement this interface.

Classes in org.openmrs.api used by org.openmrs.scheduler

Class and Description
OpenmrsService Base OpenMRS Service Interface All services registered to the ServiceContext are required to implement this interface.

Classes in org.openmrs.api used by org.openmrs.scheduler.timer

Class and Description
OpenmrsService Base OpenMRS Service Interface All services registered to the ServiceContext are required to implement this interface.

Classes in org.openmrs.api used by org.openmrs.util

Class and Description
APIException Represents often fatal errors that occur within the API infrastructure.
GlobalPropertyListener This interface allows code to be run when global properties are created, edited, or deleted.
PasswordException Represents common exceptions that happen when validating a User's password.

Classes in org.openmrs.api used by org.openmrs.validator

Class and Description
APIException Represents often fatal errors that occur within the API infrastructure.
DuplicateConceptNameException An error of this type is thrown when a concept name is found in the database when one tries to create a new one with the same preferred name in the same locale
PatientIdentifierException

Classes in org.openmrs.api used by org.openmrs.web.controller

Class and Description
GlobalPropertyListener This interface allows code to be run when global properties are created, edited, or deleted.

Classes in org.openmrs.api used by org.openmrs.web.dwr

Class and Description
APIException Represents often fatal errors that occur within the API infrastructure.
GlobalPropertyListener This interface allows code to be run when global properties are created, edited, or deleted.

Classes in org.openmrs.api used by org.openmrs.web.filter.initialization

Class and Description
APIException Represents often fatal errors that occur within the API infrastructure.