| 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.db | 
 
OpenMRS database layer interfaces. 
 | 
| org.openmrs.api.db.hibernate | 
 Resources for Hibernate ORM. 
 | 
| org.openmrs.api.handler | |
| org.openmrs.api.impl | |
| org.openmrs.order | |
| org.openmrs.propertyeditor | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
DrugOrder
DrugOrder 
 | 
class  | 
ReferralOrder
This is a type of order that adds referral specific attributes. 
 | 
class  | 
ServiceOrder
Provides properties for several order types like TestOrder , ReferralOrder
 and others depending on the openmrs implementation use case as need arises 
 | 
class  | 
TestOrder
This is a type of order that adds tests specific attributes like: laterality, clinical history,
 etc. 
 | 
| Modifier and Type | Field and Description | 
|---|---|
protected Order | 
Obs.order  | 
| Modifier and Type | Method and Description | 
|---|---|
Order | 
Order.cloneForDiscontinuing()
Creates a discontinuation order for this order, sets the previousOrder and action fields,
 note that the discontinuation order needs to be saved for the discontinuation to take effect 
 | 
Order | 
Order.cloneForRevision()
Creates an order for revision from this order, sets the previousOrder and action field. 
 | 
protected Order | 
Order.cloneForRevisionHelper(Order target)
The purpose of this method is to allow subclasses of Order to delegate a portion of their
 cloneForRevision() method back to the superclass, in case the base class implementation
 changes. 
 | 
Order | 
Order.copy()
Performs a shallow copy of this Order. 
 | 
protected Order | 
Order.copyHelper(Order target)
The purpose of this method is to allow subclasses of Order to delegate a portion of their
 copy() method back to the superclass, in case the base class implementation changes. 
 | 
Order | 
OrderAttribute.getOrder()  | 
Order | 
Obs.getOrder()  | 
Order | 
Order.getPreviousOrder()
Gets the previous related order. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
List<Order> | 
OrderGroup.getOrders()
Gets the orders 
 | 
Set<Order> | 
Encounter.getOrders()  | 
List<Order> | 
Encounter.getOrdersWithoutOrderGroups()
Takes in a list of orders and filters out the orders which have orderGroups 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
OrderGroup.addOrder(Order order)
Adds a new order to the existing list of orders 
 | 
void | 
Encounter.addOrder(Order order)
Add the given Order to the list of orders for this Encounter 
 | 
void | 
OrderGroup.addOrder(Order order,
        Integer position)
Adds a new order to the existing list of orders. 
 | 
protected Order | 
Order.cloneForRevisionHelper(Order target)
The purpose of this method is to allow subclasses of Order to delegate a portion of their
 cloneForRevision() method back to the superclass, in case the base class implementation
 changes. 
 | 
protected Order | 
Order.copyHelper(Order target)
The purpose of this method is to allow subclasses of Order to delegate a portion of their
 copy() method back to the superclass, in case the base class implementation changes. 
 | 
boolean | 
Order.hasSameOrderableAs(Order otherOrder)
Checks whether orderable of this order is same as other order 
 | 
boolean | 
DrugOrder.hasSameOrderableAs(Order otherOrder)
Checks whether orderable of this drug order is same as other order 
 | 
void | 
Encounter.removeOrder(Order order)
Remove the given order from the list of orders for this Encounter 
 | 
void | 
OrderAttribute.setOrder(Order order)  | 
void | 
Obs.setOrder(Order order)  | 
void | 
Order.setPreviousOrder(Order previousOrder)
Sets the previous order. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
OrderGroup.addOrders(List<Order> orders)
Adds  
Orders to existing Order list | 
void | 
OrderGroup.setOrders(List<Order> orders)
Sets the orders 
 | 
void | 
Encounter.setOrders(Set<Order> orders)  | 
| Modifier and Type | Method and Description | 
|---|---|
Order | 
OrderService.discontinueOrder(Order orderToDiscontinue,
                Concept reasonCoded,
                Date discontinueDate,
                Provider orderer,
                Encounter encounter)
Discontinues an order. 
 | 
Order | 
OrderService.discontinueOrder(Order orderToDiscontinue,
                String reasonNonCoded,
                Date discontinueDate,
                Provider orderer,
                Encounter encounter)
Discontinues an order. 
 | 
Order | 
OrderService.getDiscontinuationOrder(Order order)
Get discontinuation order for the given order, it is the un voided discontinuation order with
 a previousOrder that matches the specified order. 
 | 
Order | 
OrderService.getOrder(Integer orderId)
Get order by internal primary key identifier 
 | 
Order | 
OrderService.getOrderByOrderNumber(String orderNumber)
Gets the order identified by a given order number 
 | 
Order | 
OrderService.getOrderByUuid(String uuid)
Get Order by its UUID 
 | 
Order | 
OrderService.getRevisionOrder(Order order)
Get revision order for the given order, it is the order with the changes that was created as
 a replacement for the specified order. 
 | 
Order | 
OrderService.saveOrder(Order order,
         OrderContext orderContext)
Save or update the given  
order in the database. | 
Order | 
OrderService.saveRetrospectiveOrder(Order order,
                      OrderContext orderContext)
Save or update the given retrospective  
order in the database. | 
Order | 
OrderService.unvoidOrder(Order order)
Unvoid order record. 
 | 
Order | 
OrderService.updateOrderFulfillerStatus(Order order,
                          Order.FulfillerStatus orderFulfillerStatus,
                          String fullFillerComment)
Updates the fulfillerStatus of an order and the related comment and finally persists it 
 | 
Order | 
OrderService.updateOrderFulfillerStatus(Order order,
                          Order.FulfillerStatus orderFulfillerStatus,
                          String fullFillerComment,
                          String accessionNumber)
Updates the fulfillerStatus of an order and the related comment and finally persists it 
 | 
Order | 
OrderService.voidOrder(Order order,
         String voidReason)
Mark an order as voided. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
List<Order> | 
OrderService.getActiveOrders(Patient patient,
               OrderType orderType,
               CareSetting careSetting,
               Date asOfDate)
Gets all active orders for the specified patient matching the specified CareSetting,
 OrderType as of the specified date. 
 | 
List<Order> | 
OrderService.getActiveOrders(Patient patient,
               Visit visit,
               OrderType orderType,
               CareSetting careSetting,
               Date asOfDate)  | 
List<Order> | 
OrderService.getAllOrdersByPatient(Patient patient)
Gets all orders for the specified patient including discontinuation orders 
 | 
List<Order> | 
OrderService.getOrderHistoryByConcept(Patient patient,
                        Concept concept)
Gets all Order objects that use this Concept for a given patient. 
 | 
List<Order> | 
OrderService.getOrderHistoryByOrderNumber(String orderNumber)
Gets the order matching the specified order number and its previous orders in the ordering
 they occurred, i.e if this order has a previous order, fetch it and if it also has a previous
 order then fetch it until the original one with no previous order is reached 
 | 
List<Order> | 
OrderService.getOrders(OrderSearchCriteria orderSearchCriteria)
Get all orders that match a variety of (nullable) criteria contained in the parameter object. 
 | 
List<Order> | 
OrderService.getOrders(Patient patient,
         CareSetting careSetting,
         OrderType orderType,
         boolean includeVoided)
Gets all Orders that match the specified parameters excluding discontinuation orders 
 | 
List<Order> | 
OrderService.getOrders(Patient patient,
         Visit visit,
         CareSetting careSetting,
         OrderType orderType,
         boolean includeVoided)  | 
| Modifier and Type | Method and Description | 
|---|---|
Order | 
OrderService.discontinueOrder(Order orderToDiscontinue,
                Concept reasonCoded,
                Date discontinueDate,
                Provider orderer,
                Encounter encounter)
Discontinues an order. 
 | 
Order | 
OrderService.discontinueOrder(Order orderToDiscontinue,
                String reasonNonCoded,
                Date discontinueDate,
                Provider orderer,
                Encounter encounter)
Discontinues an order. 
 | 
Order | 
OrderService.getDiscontinuationOrder(Order order)
Get discontinuation order for the given order, it is the un voided discontinuation order with
 a previousOrder that matches the specified order. 
 | 
Order | 
OrderService.getRevisionOrder(Order order)
Get revision order for the given order, it is the order with the changes that was created as
 a replacement for the specified order. 
 | 
void | 
OrderService.purgeOrder(Order order)
Completely delete an order from the database. 
 | 
void | 
OrderService.purgeOrder(Order order,
          boolean cascade)
Completely delete an order from the database. 
 | 
Order | 
OrderService.saveOrder(Order order,
         OrderContext orderContext)
Save or update the given  
order in the database. | 
Order | 
OrderService.saveRetrospectiveOrder(Order order,
                      OrderContext orderContext)
Save or update the given retrospective  
order in the database. | 
Order | 
OrderService.unvoidOrder(Order order)
Unvoid order record. 
 | 
Order | 
OrderService.updateOrderFulfillerStatus(Order order,
                          Order.FulfillerStatus orderFulfillerStatus,
                          String fullFillerComment)
Updates the fulfillerStatus of an order and the related comment and finally persists it 
 | 
Order | 
OrderService.updateOrderFulfillerStatus(Order order,
                          Order.FulfillerStatus orderFulfillerStatus,
                          String fullFillerComment,
                          String accessionNumber)
Updates the fulfillerStatus of an order and the related comment and finally persists it 
 | 
Order | 
OrderService.voidOrder(Order order,
         String voidReason)
Mark an order as voided. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Order | 
OrderDAO.getDiscontinuationOrder(Order order)  | 
Order | 
OrderDAO.getOrder(Integer orderId)  | 
Order | 
OrderDAO.getOrderByOrderNumber(String orderNumber)  | 
Order | 
OrderDAO.getOrderByUuid(String uuid)  | 
Order | 
OrderDAO.getRevisionOrder(Order order)  | 
Order | 
OrderDAO.saveOrder(Order order)  | 
| Modifier and Type | Method and Description | 
|---|---|
List<Order> | 
OrderDAO.getActiveOrders(Patient patient,
               List<OrderType> orderTypes,
               CareSetting careSetting,
               Date asOfDate)  | 
List<Order> | 
OrderDAO.getActiveOrders(Patient patient,
               Visit visit,
               List<OrderType> orderTypes,
               CareSetting careSetting,
               Date asOfDate)  | 
List<Order> | 
OrderDAO.getOrders(OrderSearchCriteria orderSearchCriteria)  | 
List<Order> | 
OrderDAO.getOrders(OrderType orderType,
         List<Patient> patients,
         List<Concept> concepts,
         List<User> orderers,
         List<Encounter> encounters)
This searches for orders given the parameters. 
 | 
List<Order> | 
OrderDAO.getOrders(Patient patient,
         CareSetting careSetting,
         List<OrderType> orderTypes,
         boolean includeVoided,
         boolean includeDiscontinuationOrders)  | 
List<Order> | 
OrderDAO.getOrders(Patient patient,
         Visit visit,
         CareSetting careSetting,
         List<OrderType> orderTypes,
         boolean includeVoided,
         boolean includeDiscontinuationOrders)  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
OrderDAO.deleteObsThatReference(Order order)
Delete Obs that references an order 
 | 
void | 
OrderDAO.deleteOrder(Order order)  | 
Order | 
OrderDAO.getDiscontinuationOrder(Order order)  | 
List<Object[]> | 
OrderDAO.getOrderFromDatabase(Order order,
                    boolean isOrderADrugOrder)
Get the fresh order from the database 
 | 
Order | 
OrderDAO.getRevisionOrder(Order order)  | 
Order | 
OrderDAO.saveOrder(Order order)  | 
| Modifier and Type | Method and Description | 
|---|---|
Order | 
HibernateOrderDAO.getDiscontinuationOrder(Order order)  | 
Order | 
HibernateOrderDAO.getOrder(Integer orderId)  | 
Order | 
HibernateOrderDAO.getOrderByOrderNumber(String orderNumber)  | 
Order | 
HibernateOrderDAO.getOrderByUuid(String uuid)  | 
Order | 
HibernateOrderDAO.getRevisionOrder(Order order)  | 
Order | 
HibernateOrderDAO.saveOrder(Order order)  | 
| Modifier and Type | Method and Description | 
|---|---|
List<Order> | 
HibernateOrderDAO.getActiveOrders(Patient patient,
               List<OrderType> orderTypes,
               CareSetting careSetting,
               Date asOfDate)  | 
List<Order> | 
HibernateOrderDAO.getActiveOrders(Patient patient,
               Visit visit,
               List<OrderType> orderTypes,
               CareSetting careSetting,
               Date asOfDate)  | 
List<Order> | 
HibernateOrderDAO.getOrders(OrderSearchCriteria searchCriteria)  | 
List<Order> | 
HibernateOrderDAO.getOrders(OrderType orderType,
         List<Patient> patients,
         List<Concept> concepts,
         List<User> orderers,
         List<Encounter> encounters)  | 
List<Order> | 
HibernateOrderDAO.getOrders(Patient patient,
         CareSetting careSetting,
         List<OrderType> orderTypes,
         boolean includeVoided,
         boolean includeDiscontinuationOrders)  | 
List<Order> | 
HibernateOrderDAO.getOrders(Patient patient,
         Visit visit,
         CareSetting careSetting,
         List<OrderType> orderTypes,
         boolean includeVoided,
         boolean includeDiscontinuationOrders)  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
HibernateOrderDAO.deleteObsThatReference(Order order)
Delete Obs that references (deleted) Order 
 | 
void | 
HibernateOrderDAO.deleteOrder(Order order)  | 
Order | 
HibernateOrderDAO.getDiscontinuationOrder(Order order)  | 
List<Object[]> | 
HibernateOrderDAO.getOrderFromDatabase(Order order,
                    boolean isOrderADrugOrder)  | 
Order | 
HibernateOrderDAO.getRevisionOrder(Order order)  | 
Order | 
HibernateOrderDAO.saveOrder(Order order)  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
OrderSaveHandler.handle(Order order,
      User creator,
      Date dateCreated,
      String other)  | 
| Modifier and Type | Method and Description | 
|---|---|
Order | 
OrderServiceImpl.discontinueOrder(Order orderToDiscontinue,
                Concept reasonCoded,
                Date discontinueDate,
                Provider orderer,
                Encounter encounter)  | 
Order | 
OrderServiceImpl.discontinueOrder(Order orderToDiscontinue,
                String reasonNonCoded,
                Date discontinueDate,
                Provider orderer,
                Encounter encounter)  | 
Order | 
OrderServiceImpl.getDiscontinuationOrder(Order order)  | 
Order | 
OrderServiceImpl.getOrder(Integer orderId)  | 
Order | 
OrderServiceImpl.getOrderByOrderNumber(String orderNumber)  | 
Order | 
OrderServiceImpl.getOrderByUuid(String uuid)  | 
Order | 
OrderServiceImpl.getRevisionOrder(Order order)  | 
Order | 
OrderServiceImpl.saveOrder(Order order,
         OrderContext orderContext)  | 
Order | 
OrderServiceImpl.saveRetrospectiveOrder(Order order,
                      OrderContext orderContext)  | 
Order | 
OrderServiceImpl.unvoidOrder(Order order)  | 
Order | 
OrderServiceImpl.updateOrderFulfillerStatus(Order order,
                          Order.FulfillerStatus orderFulfillerStatus,
                          String fullFillerComment)  | 
Order | 
OrderServiceImpl.updateOrderFulfillerStatus(Order order,
                          Order.FulfillerStatus orderFulfillerStatus,
                          String fullFillerComment,
                          String accessionNumber)  | 
Order | 
OrderServiceImpl.voidOrder(Order order,
         String voidReason)  | 
| Modifier and Type | Method and Description | 
|---|---|
List<Order> | 
OrderServiceImpl.getActiveOrders(Patient patient,
               OrderType orderType,
               CareSetting careSetting,
               Date asOfDate)  | 
List<Order> | 
OrderServiceImpl.getActiveOrders(Patient patient,
               Visit visit,
               OrderType orderType,
               CareSetting careSetting,
               Date asOfDate)  | 
List<Order> | 
OrderServiceImpl.getAllOrdersByPatient(Patient patient)  | 
List<Order> | 
OrderServiceImpl.getOrderHistoryByConcept(Patient patient,
                        Concept concept)  | 
List<Order> | 
OrderServiceImpl.getOrderHistoryByOrderNumber(String orderNumber)  | 
List<Order> | 
OrderServiceImpl.getOrders(OrderSearchCriteria orderSearchCriteria)  | 
List<Order> | 
OrderServiceImpl.getOrders(Patient patient,
         CareSetting careSetting,
         OrderType orderType,
         boolean includeVoided)  | 
List<Order> | 
OrderServiceImpl.getOrders(Patient patient,
         Visit visit,
         CareSetting careSetting,
         OrderType orderType,
         boolean includeVoided)  | 
| Modifier and Type | Method and Description | 
|---|---|
Order | 
OrderServiceImpl.discontinueOrder(Order orderToDiscontinue,
                Concept reasonCoded,
                Date discontinueDate,
                Provider orderer,
                Encounter encounter)  | 
Order | 
OrderServiceImpl.discontinueOrder(Order orderToDiscontinue,
                String reasonNonCoded,
                Date discontinueDate,
                Provider orderer,
                Encounter encounter)  | 
Order | 
OrderServiceImpl.getDiscontinuationOrder(Order order)  | 
Order | 
OrderServiceImpl.getRevisionOrder(Order order)  | 
void | 
OrderServiceImpl.purgeOrder(Order order)  | 
void | 
OrderServiceImpl.purgeOrder(Order order,
          boolean cascade)  | 
Order | 
OrderServiceImpl.saveOrder(Order order,
         OrderContext orderContext)  | 
Order | 
OrderServiceImpl.saveRetrospectiveOrder(Order order,
                      OrderContext orderContext)  | 
Order | 
OrderServiceImpl.unvoidOrder(Order order)  | 
Order | 
OrderServiceImpl.updateOrderFulfillerStatus(Order order,
                          Order.FulfillerStatus orderFulfillerStatus,
                          String fullFillerComment)  | 
Order | 
OrderServiceImpl.updateOrderFulfillerStatus(Order order,
                          Order.FulfillerStatus orderFulfillerStatus,
                          String fullFillerComment,
                          String accessionNumber)  | 
Order | 
OrderServiceImpl.voidOrder(Order order,
         String voidReason)  | 
| Modifier and Type | Method and Description | 
|---|---|
static boolean | 
OrderUtil.checkScheduleOverlap(Order order1,
                    Order order2)
Checks if the schedules of the specified orders overlap, Note this only makes a check that is
 purely based on dates ignoring other properties like patient, voided, careSetting and the
 orderable 
 | 
| Modifier and Type | Method and Description | 
|---|---|
protected Order | 
OrderEditor.getObjectById(Integer id)  | 
protected Order | 
OrderEditor.getObjectByUuid(String uuid)  | 
Copyright © 2024 OpenMRS Inc.. All rights reserved.