{"type":"doc","content":[{"type":"panel","attrs":{"panelType":"error"},"content":[{"type":"paragraph","content":[{"text":"We did ","type":"text"},{"text":"not","type":"text","marks":[{"type":"em"}]},{"text":" release this module. Ultimately, we introduced a new Order Entry API in OpenMRS Platform 1.10.0, and there is no module to add this support in earlier OpenMRS platform versions.","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Background","type":"text"}]},{"type":"paragraph","content":[{"text":"A new 'Order Entry' module will be authored to provide a new API and features necessary to manage patient specific orders, the module is intended to be a cleaner version of the existing order entry API with several additions and subtractions. For more background information, please visit","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]},{"text":" ","type":"text"},{"text":"api support for order entry","type":"text","marks":[{"type":"link","attrs":{"href":"https://openmrs.atlassian.net/wiki/display/projects/API+Support+for+Order+Entry+(Design+Page)"}},{"type":"textColor","attrs":{"color":"#222222"}}]},{"text":" page. This module will use the \"org.openmrs\" namespace, rather than the conventional \"org.openmrs.module\" namespace in order to more easily support the goal of eventually incorporating this module into core. By keeping it as a module initially, this allows implementations running older versions of OpenMRS (1.7, 1.8, 1.9, etc) to take advantage of, and test out, this work, without requiring them to upgrade. It also will allow the module to evolve at a different pace than the core code.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]}]},{"type":"paragraph","content":[{"text":"The module will use existing orders tables, installing the module will essentially lead to modification of the related tables, ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]}]},{"type":"paragraph","content":[{"text":"Can we have the OrderService in core marked as deprecated prior to releasing 1.9","type":"text","marks":[{"type":"em"},{"type":"strong"},{"type":"textColor","attrs":{"color":"#222222"}}]},{"text":"?","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]}]},{"type":"paragraph","content":[{"text":"Module id:","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#222222"}}]},{"text":" ","type":"text"},{"text":"orderentry","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]}]},{"type":"paragraph","content":[{"text":"Module name:","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#222222"}}]},{"text":" ","type":"text"},{"text":"Order Entry","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]}]},{"type":"paragraph","content":[{"text":"Package namespace:","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#222222"}}]},{"text":" ","type":"text"},{"text":"org.openmrs.orderentry","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Module design","type":"text"}]},{"type":"paragraph","content":[{"text":"We are getting rid of the ","type":"text"},{"text":"OrderType","type":"text","marks":[{"type":"strong"}]},{"text":" class including the associated database table, the broader categorization of will by the concept class of each order's backing concept. A more granular break down of these can be done through attribute types. (Though this is not supported in older versions)","type":"text"}]},{"type":"paragraph","content":[{"text":"Order","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#222222"}}]}]},{"type":"paragraph","content":[{"text":"( * = required)","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]}]},{"type":"codeBlock","content":[{"text":"class Order extends BaseOpenmrsData{\n\n public enum OrderAction {\n DISCONTINUE, ORDER\n }\n\n *Integer orderId\n *Patient patient\n *Concept concept\n *String orderNumber\n String previousOrderNumber\n *OrderAction orderAction\n *Date startDate\n Date autoExpireDate \n *Encounter encounter\n String instructions\n *User orderer\n Boolean discontinued\n User discontinuedBy\n Date discontinuedDate\n String discontinuedReason\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"DrugOrder","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]}]},{"type":"codeBlock","content":[{"text":"class DrugOrder extends Order{\n Drug drug\n Concept concept;//should be drug.concept if drug is not null\n Double dose\n String doseUnits\n Boolean isStructuredDosing\n Double strength\n String strengthUnits \n Integer quantity\n String quantityUnits\n String frequency\n String brandName\n String dosageForm\n String route\n Boolean asNeeded - Indicated PRN\n String asNeededCondition\n String additionalInstructions\n Integer duration\n String durationUnits\n Integer numRefills\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"TestOrder","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]}]},{"type":"codeBlock","content":[{"text":"class TestOrder extends Order{ \n Concept specimenSource \n Concept laterality \n String clinicalHistory\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Orderable","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]}]},{"type":"paragraph","content":[{"text":"Marker interface for things that a User can order","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]}]},{"type":"codeBlock","content":[{"text":"public interface Orderable {\n String getUniqueIdentifier(); //The unique identifier for this Orderable.\n Concept getConcept(); //The concept of the order that will ultimately be created from this Orderable.\n String getName(); //display name of this orderable, typically should be inherited from the concept. Intended for use in the UI.\n String getDescription(); //display descripion of this orderable, typically should be inherited from the concept. Intended for use in the UI.\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"BaseOrderable","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]}]},{"type":"paragraph","content":[{"text":"Base implementation of the","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]},{"text":" ","type":"text"},{"text":"Orderable","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]},{"text":" interface, should define the properties and provide the default implementation of the inherited methods","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]}]},{"type":"paragraph","content":[{"text":"Is Drug.concept nullable?","type":"text","marks":[{"type":"em"},{"type":"strong"},{"type":"textColor","attrs":{"color":"#222222"}}]}]},{"type":"codeBlock","content":[{"text":"abstract class BaseOrderable{\n Concept concept; //will this be required?\n String name; //We really need this if drug.concept is nullable and fetch it from the drug?\n String description; //same here\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"SimpleOrderable","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]}]},{"type":"paragraph","content":[{"text":"Acts a wrapper for a concept or Drug(if drug.concept is nullable) with concept class as 'Drug' or ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]},{"text":"'Test' or 'Misc Order' or a Drug with no","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]}]},{"type":"codeBlock","content":[{"text":"class GenericOrderable extends BaseOrderable{\n //constructor that takes in a concept\n public SimpleOrderable(Concept concept) {\n ..............\n }\n\n //constructor that takes in a drug if drug.concept is nullable\n public SimpleOrderable(Drug drug) {\n ..............\n }\n\n //return something unique with type included i.e Concept Vs Drug(if drug.concept is nullable)\n @Override\n public String getUniqueIdentifier() {\n ...........\n }\n\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"OrderEntryService","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]}]},{"type":"codeBlock","content":[{"text":"interface OrderService extends OpenmrsService{\n saveOrder(Order);//Should not let you change an Order. can only do an sql insert from here.\n voidOrder(Order, String voidReason);\n unvoidOrder(Order order);\n purgeOrder(Order);\n //Creates a new order with a new order number that is a \"discontinue\" order. previous_order_number on this\n //should point to old Order, also finds old Order and marks it as discontinued with the given parameters\n discontinueOrder(Order order, Concept discontinueReason, Date discontinueDate);\n discontinueOrder(Order order, String discontinueReason, Date discontinueDate);\n createOrdersAndEncounter(Patient p, Collection orders);// activates the orders given, do we need this?\n getOrder(Integer orderId);\n getOrderByUuid(String uuid);\n String getNewOrderNumber();\n getOrderByOrderNumber(String orderNumber);\n Class getOrder(Integer orderId, Class orderClassType);\n getOrders(Class orderClassType, List patients, List concepts, OrderAction action, List orderers, List encounters, List conceptClasses);\n getOrdersByOrderer(User user);\n getOrdersByPatient(Patient patient);\n getDrugOrdersByPatient(Patient patient, OrderAction orderAction);\n getDrugOrdersByPatient(Patient patient, OrderAction orderAction, boolean includeVoided);\n getDrugOrdersByPatient(Patient patient);\n getOrdersByEncounter(Encounter encounter);\n List getOrderHistoryByConcept(Patient patient, Concept concept);\n getOrderables(String query);\n getOrderables(String uniqueIdentifier);\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"OrderValidator","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]}]},{"type":"codeBlock","content":[{"text":"class OrderValidator implements Validator{\n public void validate(Object obj, Errors errors) {\n //Enforce all required fields\n //TODO: What are the extra validation rules?\n }\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"DrugOrderValidator","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]}]},{"type":"codeBlock","content":[{"text":"class DrugOrderValidator extends OrderValidator{\n public void validate(Object obj, Errors errors) {\n super.validate(obj, errors);\n\n //drug and concept cannot both be null, drug.concept should match concept if not null\n //Check that the class of the concept is Drug\n //TODO: Add other validation rules specific to drug orders\n }\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"TestOrderValidator","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]}]},{"type":"codeBlock","content":[{"text":"class TestOrderValidator extends OrderValidator{\n public void validate(Object obj, Errors errors) {\n super.validate(obj, errors);\n\n //Check that the class of the concept is Test\n //TODO: Add other validation rules specific to test orders\n }\n}\n","type":"text"}]}],"version":1}

Browser not supported