HTML-878: Order Tag should support placing orders for the same drug at an earlier date if the expiry date doesn't overlap (#330)

Author: mogoodrich

api-tests/src/test/java/org/openmrs/module/htmlformentry/element/OrderSubmissionElementTest.java

@@ -135,8 +135,70 @@ public void shouldFailValidationIfOverlappingOrders() {
 		FormResultsTester results = formSessionTester.submitForm();
 		results.assertErrorMessage("htmlformentry.orders.overlappingScheduleWithActiveOrder");
 	}
-	
-	@Test
+
+    @Test
+    public void shouldAllowEarlierOrderIfNonOverlappingByCalculatedExpiryDate() {
+        FormTester formTester = FormTester.buildForm("orderTestForm.xml");
+
+        // Enter an encounter with an order for drug 2
+        {
+            FormSessionTester formSessionTester = formTester.openNewForm(6);
+            formSessionTester.setEncounterFields("2020-03-30", "2", "502");
+            OrderFieldTester triomuneField = OrderFieldTester.forDrug(2, formSessionTester);
+            triomuneField.orderAction("NEW").careSetting("2").urgency(Order.Urgency.ROUTINE.name());
+            triomuneField.freeTextDosing("Triomune instructions");
+            FormResultsTester results = formSessionTester.submitForm();
+            results.assertNoErrors().assertEncounterCreated().assertOrderCreatedCount(1).assertNonVoidedOrderCount(1);
+            DrugOrder o1 = results.assertDrugOrder(Order.Action.NEW, 2);
+            TestUtil.assertDate(o1.getDateActivated(), "yyyy-MM-dd HH:mm:ss", "2020-03-30 00:00:00");
+            assertThat(o1.getDateStopped(), nullValue());
+        }
+
+        // Now, enter an encounter month earlier, but with a duration of only 20 days
+        FormSessionTester formSessionTester = formTester.openNewForm(6);
+        formSessionTester.setEncounterFields("2020-02-28", "2", "502");
+        OrderFieldTester triomuneField = OrderFieldTester.forDrug(2, formSessionTester);
+        triomuneField.orderAction("NEW").careSetting("2").urgency(Order.Urgency.ROUTINE.name());
+        triomuneField.freeTextDosing("Triomune instructions");
+        triomuneField.duration("20");
+        triomuneField.durationUnits("28");  // duration concept for days
+        FormResultsTester results = formSessionTester.submitForm();
+        results.assertNoErrors().assertEncounterCreated().assertOrderCreatedCount(1).assertNonVoidedOrderCount(1);
+    }
+
+    @Test
+    public void shouldNotAllowEarlierOrderIfOverlappingByCalculatedExpiryDate() {
+        FormTester formTester = FormTester.buildForm("orderTestForm.xml");
+
+        // Enter an encounter with an order for drug 2
+        {
+            FormSessionTester formSessionTester = formTester.openNewForm(6);
+            formSessionTester.setEncounterFields("2020-03-30", "2", "502");
+            OrderFieldTester triomuneField = OrderFieldTester.forDrug(2, formSessionTester);
+            triomuneField.orderAction("NEW").careSetting("2").urgency(Order.Urgency.ROUTINE.name());
+            triomuneField.freeTextDosing("Triomune instructions");
+            FormResultsTester results = formSessionTester.submitForm();
+            results.assertNoErrors().assertEncounterCreated().assertOrderCreatedCount(1).assertNonVoidedOrderCount(1);
+            DrugOrder o1 = results.assertDrugOrder(Order.Action.NEW, 2);
+            TestUtil.assertDate(o1.getDateActivated(), "yyyy-MM-dd HH:mm:ss", "2020-03-30 00:00:00");
+            assertThat(o1.getDateStopped(), nullValue());
+        }
+
+        // Now, enter an encounter month earlier, with a duration of 40 days
+        FormSessionTester formSessionTester = formTester.openNewForm(6);
+        formSessionTester.setEncounterFields("2020-02-28", "2", "502");
+        OrderFieldTester triomuneField = OrderFieldTester.forDrug(2, formSessionTester);
+        triomuneField.orderAction("NEW").careSetting("2").urgency(Order.Urgency.ROUTINE.name());
+        triomuneField.freeTextDosing("Triomune instructions");
+        triomuneField.duration("40");
+        triomuneField.durationUnits("28");  // duration concept for days
+        FormResultsTester results = formSessionTester.submitForm();
+        results.assertErrorMessage("htmlformentry.orders.overlappingScheduleWithActiveOrder");
+    }
+
+
+
+    @Test
 	public void shouldFailValidationIfMultipleOrdersPlacedForSameOrderable() {
 		FormTester formTester = FormTester.buildForm("orderTestForm.xml");
 

api/src/main/java/org/openmrs/module/htmlformentry/element/OrderSubmissionElement.java

@@ -8,6 +8,7 @@
 import org.openmrs.Concept;
 import org.openmrs.Drug;
 import org.openmrs.DrugOrder;
+import org.openmrs.Duration;
 import org.openmrs.Encounter;
 import org.openmrs.FreeTextDosingInstructions;
 import org.openmrs.Order;
@@ -35,6 +36,8 @@
 import java.util.Map;
 import java.util.Set;
 
+import static org.apache.commons.lang3.time.DateUtils.addSeconds;
+
 /**
  * Holds the widgets used to represent orders for a configured set of orderables (concepts, drugs),
  * and serves as both the HtmlGeneratorElement and the FormSubmissionControllerAction for the
@@ -352,7 +355,7 @@ public boolean overlapsWithExistingDrugOrder(FormEntryContext ctx, List<Order> e
 		return false;
 	}
 
-	private boolean checkScheduleOverlap(FormEntryContext ctx, Order newOrder, Order existingOrder) {
+	private boolean checkScheduleOverlap(FormEntryContext ctx, DrugOrder newOrder, Order existingOrder) {
 		Date newStart = newOrder.getEffectiveStartDate();
 		Date newStop = newOrder.getEffectiveStopDate();
 		Date existingStart = existingOrder.getEffectiveStartDate();
@@ -361,7 +364,18 @@ private boolean checkScheduleOverlap(FormEntryContext ctx, Order newOrder, Order
 		if (newStart == null) {
 			newStart = ctx.getBestApproximationOfEncounterDate();
 		}
-		
+
+        // attempt to estimate the stop date based on the auto-expire date
+        if (newStop == null) {
+            if (newOrder.getDuration() != null && newOrder.getDurationUnits() != null) {
+                String durationCode = Duration.getCode(newOrder.getDurationUnits());
+                if (durationCode != null) {
+                    Duration duration = new Duration(newOrder.getDuration(), durationCode);
+                    newStop = addSeconds(duration.addToDate(newStart, newOrder.getFrequency()),-1);
+                }
+            }
+        }
+
 		// If both orders start on the same date, then they overlap
 		if (OpenmrsUtil.compareWithNullAsLatest(newStart, existingStart) == 0) {
 			return true;