support patch history rewrite (#7024)

* initial implementation, tests

* changelog, docs

* spotless

* fix refactor causing test failure

* remove todo's and failing test for delete bug - move to new bug ticket

* link to docs in changelog

* address review comments

* undo a review comments

* fix test

---------

Co-authored-by: jdar <[email protected]>

Author: jdar8

hapi-fhir-base/src/main/java/ca/uhn/fhir/rest/gclient/IPatchWithBody.java

@@ -59,4 +59,9 @@ public interface IPatchWithBody extends IPatchExecutable {
 	 * The resource ID to patch (must include both a resource type and an ID, e.g. <code>Patient/123</code>)
 	 */
 	IPatchExecutable withId(String theId);
+
+	/**
+	 * Call patch with the history rewrite header
+	 */
+	IPatchWithBody historyRewrite();
 }

hapi-fhir-client/src/main/java/ca/uhn/fhir/rest/client/impl/GenericClient.java

@@ -1741,6 +1741,7 @@ private class PatchInternal extends BaseSearch<IPatchExecutable, IPatchWithQuery
 		private PreferReturnEnum myPrefer;
 		private String myResourceType;
 		private String mySearchUrl;
+		private boolean myIsHistoryRewrite;
 
 		@Override
 		public IPatchWithQuery conditional(Class<? extends IBaseResource> theClass) {
@@ -1775,7 +1776,17 @@ public MethodOutcome execute() {
 			}
 
 			BaseHttpClientInvocation invocation;
-			if (isNotBlank(mySearchUrl)) {
+			if (myIsHistoryRewrite) {
+				if (!myId.hasVersionIdPart()) {
+					throw new InvalidRequestException(Msg.code(2716)
+							+ "Invalid resource ID for rewrite history: ID must contain a history version");
+				}
+				// createPatchInvocation() eventually calls HttpPatchClientInvocation
+				// passing in the ID as a URL (String) will keep the version whereas passing in the raw ID will remove
+				// the version
+				invocation = MethodUtil.createPatchInvocation(myContext, myId.getValue(), myPatchType, myPatchBody);
+				invocation.addHeader(Constants.HEADER_REWRITE_HISTORY, "true");
+			} else if (isNotBlank(mySearchUrl)) {
 				invocation = MethodUtil.createPatchInvocation(myContext, mySearchUrl, myPatchType, myPatchBody);
 			} else if (myConditional) {
 				invocation = MethodUtil.createPatchInvocation(
@@ -1854,6 +1865,12 @@ public IPatchExecutable withId(String theId) {
 			}
 			return withId(new IdDt(theId));
 		}
+
+		@Override
+		public IPatchWithBody historyRewrite() {
+			myIsHistoryRewrite = true;
+			return this;
+		}
 	}
 
 	@SuppressWarnings({"rawtypes", "unchecked"})

hapi-fhir-docs/src/main/resources/ca/uhn/hapi/fhir/changelog/8_4_0/7023-add-patch-support-for-history-rewrite.yaml

@@ -0,0 +1,7 @@
+---
+type: add
+issue: 7023
+jira: SMILE-8730
+title: "The HTTP Patch operation now supports the `X-Rewrite-History` header. This enables a specific version of a resource 
+to be rewritten in-place without the resource version being incremented by using the PATCH operation. 
+See [Patch with History Rewrite](/hapi-fhir/docs/server_plain/rest_operations.html#patch-with-history-rewrite) for more information."

hapi-fhir-docs/src/main/resources/ca/uhn/hapi/fhir/docs/server_plain/rest_operations.md

@@ -208,6 +208,45 @@ The following snippet shows how to define a patch method on a server:
 {{snippet:classpath:/ca/uhn/hapi/fhir/docs/PatchExamples.java|patch}}
 ```
 
+## Patch with History Rewrite
+
+If you wish to patch a historical version of a resource without creating a new version, this can now be done in the
+`Patch` operation. While this operation is not supported by the FHIR specification, it's an enhancement added to
+specifically to HAPI-FHIR.
+
+In order to use this new functionality, you must set the `myUpdateWithHistoryRewriteEnabled` setting in the `StorageSettings`
+to true.
+
+The request must include the header `X-Rewrite-History`, and should be set to true. The body of the request must include
+the desired FHIR Patch or JSON Patch. Note that transaction bundles are not yet supported.
+
+The following API request shows an example of executing a FHIR Patch that updates a Patient's birthday without incrementing
+the resource version:
+
+
+```http
+PATCH Patient/123/_history/2
+Content-Type: application/fhir+json
+X-Rewrite-History: true
+
+{
+  "resourceType": "Parameters",
+  "parameter": [ {
+    "name": "operation",
+    "part": [ {
+      "name": "type",
+      "valueCode": "replace"
+    }, {
+      "name": "path",
+      "valueString": "Patient.birthDate"
+    }, {
+      "name": "value",
+      "valueDate": "1930-01-01"
+    } ]
+  } ]
+}
+```
+
 
 <a name="type_create" />
 

hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/dao/BaseHapiFhirResourceDao.java

@@ -2385,8 +2385,8 @@ public DaoMethodOutcome update(
 		if (myStorageSettings.isUpdateWithHistoryRewriteEnabled()
 				&& theRequest != null
 				&& theRequest.isRewriteHistory()) {
-			updateCallback = () ->
-					doUpdateWithHistoryRewrite(theResource, theRequest, theTransactionDetails, requestPartitionId);
+			updateCallback = () -> doUpdateWithHistoryRewrite(
+					theResource, theRequest, theTransactionDetails, requestPartitionId, RestOperationTypeEnum.UPDATE);
 		} else {
 			updateCallback = () -> doUpdate(
 					theResource,
@@ -2620,13 +2620,16 @@ protected DaoMethodOutcome doUpdateForUpdateOrPatch(UpdateParameters<T> theUpdat
 	 * @param theResource           to be saved
 	 * @param theRequest            details of the request
 	 * @param theTransactionDetails details of the transaction
+	 * @param theRequestPartitionId the partition on which to perform the request
+	 * @param theRestOperationType  the rest operation type (update or patch)
 	 * @return the outcome of the operation
 	 */
-	private DaoMethodOutcome doUpdateWithHistoryRewrite(
+	DaoMethodOutcome doUpdateWithHistoryRewrite(
 			T theResource,
 			RequestDetails theRequest,
 			TransactionDetails theTransactionDetails,
-			RequestPartitionId theRequestPartitionId) {
+			RequestPartitionId theRequestPartitionId,
+			RestOperationTypeEnum theRestOperationType) {
 		StopWatch w = new StopWatch();
 
 		// No need for indexing as this will update a non-current version of the resource which will not be searchable
@@ -2669,11 +2672,10 @@ private DaoMethodOutcome doUpdateWithHistoryRewrite(
 				&& Long.parseLong(resourceId.getVersionIdPart()) == currentEntity.getVersion();
 		IBasePersistedResource<?> savedEntity = updateHistoryEntity(
 				theRequest, theResource, currentEntity, entity, resourceId, theTransactionDetails, isUpdatingCurrent);
-		DaoMethodOutcome outcome = toMethodOutcome(
-						theRequest, savedEntity, theResource, null, RestOperationTypeEnum.UPDATE)
+		DaoMethodOutcome outcome = toMethodOutcome(theRequest, savedEntity, theResource, null, theRestOperationType)
 				.setCreated(wasDeleted);
 
-		populateOperationOutcomeForUpdate(w, outcome, null, RestOperationTypeEnum.UPDATE, theTransactionDetails);
+		populateOperationOutcomeForUpdate(w, outcome, null, theRestOperationType, theTransactionDetails);
 
 		return outcome;
 	}