| Class and Description |
|---|
| AdministrationService
Contains methods pertaining to doing some administrative tasks in OpenMRS
Use:
List<GlobalProperty> globalProperties = Context.getAdministrationService().getGlobalProperties(); |
| 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. |
| ConceptService
Contains methods pertaining to creating/updating/deleting/retiring Concepts, Drugs, Concept
Proposals, and all other things 'Concept'.
|
| 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.
|
| FormsLockedException
This exception is thrown when a user tries to save or delete a form while forms are locked
|
| GlobalPropertyListener
This interface allows code to be run when global properties are created, edited, or deleted.
|
| InvalidOperationOnObjectException
An instance of this exception is thrown if an operation is attempted on an object, typically this
should be thrown when any operation is made to an existing object and is considered detrimental
to the integrity of any existing associated data.
|
| 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
|
| OrderEntryException
Superclass of all order entry related exceptions and should typically be thrown whenever there is
no more specific type can be thrown.
|
| PasswordException
Represents common exceptions that happen when validating a
User's password. |
| PatientIdentifierException |
| PatientIdentifierTypeLockedException
This exception is thrown when a user tries manipulate of a patient identifier type while patient identifier types are locked
|
| PersonAttributeTypeLockedException
This exception is thrown when a user tries manipulate of a person attribute type while person attribute types are locked
|
| PersonService.ATTR_VIEW_TYPE
These enumerations are used when determining which person attr types to display.
|
| Class and Description |
|---|
| AdministrationService
Contains methods pertaining to doing some administrative tasks in OpenMRS
Use:
List<GlobalProperty> globalProperties = Context.getAdministrationService().getGlobalProperties(); |
| 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.
|
| ConceptService
Contains methods pertaining to creating/updating/deleting/retiring Concepts, Drugs, Concept
Proposals, and all other things 'Concept'.
|
| ConditionService
This interface defines methods for condition objects.
|
| DatatypeService
API methods related to
CustomDatatype and CustomDatatypeHandler. |
| DiagnosisService
API methods for managing diagnoses
|
| 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<Location> locations = Context.getLocationService().getAllLocations();
|
| MedicationDispenseService
This interface defines an API for interacting with MedicationDispense objects.
|
| 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
|
| 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
|
| OrderSetService
Contains methods pertaining to creating/deleting/voiding Order Sets.
|
| PatientService
Contains methods pertaining to Patients in the system
Usage:
List<Patient> patients = Context.getPatientService().getAllPatients();
|
| PersonService
Contains methods pertaining to Persons in the system Use:
List<Person> personObjects = Context.getPersonService().getAllPersons(); |
| 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); |
| 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:
List<User> users = Context.getUserService().getAllUsers(); |
| VisitService
This service contains methods relating to visits.
|
| Class and Description |
|---|
| APIException
Represents often fatal errors that occur within the API infrastructure.
|
| Class and Description |
|---|
| APIException
Represents often fatal errors that occur within the API infrastructure.
|
| Class and Description |
|---|
| GlobalPropertyListener
This interface allows code to be run when global properties are created, edited, or deleted.
|
| Class and Description |
|---|
| AdministrationService
Contains methods pertaining to doing some administrative tasks in OpenMRS
Use:
List<GlobalProperty> globalProperties = Context.getAdministrationService().getGlobalProperties(); |
| 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.
|
| 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.
|
| ConditionService
This interface defines methods for condition objects.
|
| DatatypeService
API methods related to
CustomDatatype and CustomDatatypeHandler. |
| DiagnosisService
API methods for managing diagnoses
|
| 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<Location> locations = Context.getLocationService().getAllLocations();
|
| MedicationDispenseService
This interface defines an API for interacting with MedicationDispense objects.
|
| 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
|
| 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
|
| OrderSetService
Contains methods pertaining to creating/deleting/voiding Order Sets.
|
| PatientIdentifierException |
| PatientService
Contains methods pertaining to Patients in the system
Usage:
List<Patient> patients = Context.getPatientService().getAllPatients();
|
| PersonService
Contains methods pertaining to Persons in the system Use:
List<Person> personObjects = Context.getPersonService().getAllPersons(); |
| 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:
Program program = new Program(); program.set___(___); ...etc Context.getProgramWorkflowService().saveProgram(program); |
| 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:
List<User> users = Context.getUserService().getAllUsers(); |
| VisitService
This service contains methods relating to visits.
|
| Class and Description |
|---|
| APIException
Represents often fatal errors that occur within the API infrastructure.
|
| 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. |
| Class and Description |
|---|
| APIException
Represents often fatal errors that occur within the API infrastructure.
|
| 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. |
| Class and Description |
|---|
| GlobalPropertyListener
This interface allows code to be run when global properties are created, edited, or deleted.
|
| Class and Description |
|---|
| GlobalPropertyListener
This interface allows code to be run when global properties are created, edited, or deleted.
|
| Class and Description |
|---|
| GlobalPropertyListener
This interface allows code to be run when global properties are created, edited, or deleted.
|
| Class and Description |
|---|
| APIException
Represents often fatal errors that occur within the API infrastructure.
|
| 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. |
| 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. |
| Class and Description |
|---|
| APIException
Represents often fatal errors that occur within the API infrastructure.
|
| Class and Description |
|---|
| APIException
Represents often fatal errors that occur within the API infrastructure.
|
| Class and Description |
|---|
| APIException
Represents often fatal errors that occur within the API infrastructure.
|
| Class and Description |
|---|
| OpenmrsService
Base OpenMRS Service Interface All services registered to the
ServiceContext are required
to implement this interface. |
| Class and Description |
|---|
| OpenmrsService
Base OpenMRS Service Interface All services registered to the
ServiceContext are required
to implement this interface. |
| Class and Description |
|---|
| AdministrationService
Contains methods pertaining to doing some administrative tasks in OpenMRS
Use:
List<GlobalProperty> globalProperties = Context.getAdministrationService().getGlobalProperties(); |
| 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. |
| 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 |
| ValidationException
Represents often fatal errors that occur when an object fails validation
|
| Class and Description |
|---|
| GlobalPropertyListener
This interface allows code to be run when global properties are created, edited, or deleted.
|
| Class and Description |
|---|
| GlobalPropertyListener
This interface allows code to be run when global properties are created, edited, or deleted.
|
| Class and Description |
|---|
| APIException
Represents often fatal errors that occur within the API infrastructure.
|
Copyright © 2024 OpenMRS Inc.. All rights reserved.