add undo-merge operation (#7146)

* add undo-merge operation

Author: mrdnctrk

hapi-fhir-docs/src/main/resources/ca/uhn/hapi/fhir/changelog/8_4_0/7148-undo-merge-operation.yaml

@@ -0,0 +1,6 @@
+---
+type: add
+issue: 7148
+title: "An operation named `$hapi.fhir.undo-merge` has been added for Patient resources. This operation restores the 
+resources that were updated by a Patient `$merge` operation to their previous versions based on the Provenance resource 
+created by the `$merge` operation."

hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/config/JpaConfig.java

@@ -1015,6 +1015,7 @@ public IReplaceReferencesSvc replaceReferencesSvc(
 				theProvenanceSvc);
 	}
 
+	@Primary
 	@Bean
 	public ReplaceReferencesProvenanceSvc replaceReferencesProvenanceSvc(DaoRegistry theDaoRegistry) {
 		return new ReplaceReferencesProvenanceSvc(theDaoRegistry);

hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/config/r4/JpaR4Config.java

@@ -38,14 +38,18 @@
 import ca.uhn.fhir.jpa.partition.IRequestPartitionHelperSvc;
 import ca.uhn.fhir.jpa.provider.IReplaceReferencesSvc;
 import ca.uhn.fhir.jpa.provider.JpaSystemProvider;
+import ca.uhn.fhir.jpa.provider.merge.MergeValidationService;
 import ca.uhn.fhir.jpa.provider.merge.PatientMergeProvider;
 import ca.uhn.fhir.jpa.provider.merge.ResourceMergeService;
+import ca.uhn.fhir.jpa.provider.merge.ResourceUndoMergeService;
 import ca.uhn.fhir.jpa.term.TermLoaderSvcImpl;
 import ca.uhn.fhir.jpa.term.TermVersionAdapterSvcR4;
 import ca.uhn.fhir.jpa.term.api.ITermCodeSystemStorageSvc;
 import ca.uhn.fhir.jpa.term.api.ITermDeferredStorageSvc;
 import ca.uhn.fhir.jpa.term.api.ITermLoaderSvc;
 import ca.uhn.fhir.jpa.term.api.ITermVersionAdapterSvc;
+import ca.uhn.fhir.merge.MergeProvenanceSvc;
+import ca.uhn.fhir.replacereferences.PreviousResourceVersionRestorer;
 import ca.uhn.fhir.rest.server.util.ISearchParamRegistry;
 import org.hl7.fhir.r4.model.Bundle;
 import org.hl7.fhir.r4.model.Meta;
@@ -107,6 +111,16 @@ public ITermLoaderSvc termLoaderService(
 		return new TermLoaderSvcImpl(theDeferredStorageSvc, theCodeSystemStorageSvc);
 	}
 
+	@Bean
+	public MergeValidationService mergeValidationService(FhirContext theFhirContext, DaoRegistry theDaoRegistry) {
+		return new MergeValidationService(theFhirContext, theDaoRegistry);
+	}
+
+	@Bean
+	public MergeProvenanceSvc mergeProvenanceSvc(DaoRegistry theDaoRegistry) {
+		return new MergeProvenanceSvc(theDaoRegistry);
+	}
+
 	@Bean
 	public ResourceMergeService resourceMergeService(
 			DaoRegistry theDaoRegistry,
@@ -115,7 +129,9 @@ public ResourceMergeService resourceMergeService(
 			IRequestPartitionHelperSvc theRequestPartitionHelperSvc,
 			IJobCoordinator theJobCoordinator,
 			Batch2TaskHelper theBatch2TaskHelper,
-			JpaStorageSettings theStorageSettings) {
+			JpaStorageSettings theStorageSettings,
+			MergeValidationService theMergeValidationService,
+			MergeProvenanceSvc theMergeProvenanceSvc) {
 
 		return new ResourceMergeService(
 				theStorageSettings,
@@ -124,17 +140,39 @@ public ResourceMergeService resourceMergeService(
 				theHapiTransactionService,
 				theRequestPartitionHelperSvc,
 				theJobCoordinator,
-				theBatch2TaskHelper);
+				theBatch2TaskHelper,
+				theMergeValidationService,
+				theMergeProvenanceSvc);
+	}
+
+	@Bean
+	public ResourceUndoMergeService resourceUndoMergeService(
+			DaoRegistry theDaoRegistry,
+			MergeProvenanceSvc theMergeProvenanceSvc,
+			PreviousResourceVersionRestorer theResourceVersionRestorer,
+			MergeValidationService theMergeValidationService,
+			IRequestPartitionHelperSvc theRequestPartitionHelperSvc) {
+		return new ResourceUndoMergeService(
+				theDaoRegistry,
+				theMergeProvenanceSvc,
+				theResourceVersionRestorer,
+				theMergeValidationService,
+				theRequestPartitionHelperSvc);
 	}
 
 	@Bean
 	public PatientMergeProvider patientMergeProvider(
 			FhirContext theFhirContext,
 			DaoRegistry theDaoRegistry,
 			ResourceMergeService theResourceMergeService,
+			ResourceUndoMergeService theResourceUndoMergeService,
 			IInterceptorBroadcaster theInterceptorBroadcaster) {
 
 		return new PatientMergeProvider(
-				theFhirContext, theDaoRegistry, theResourceMergeService, theInterceptorBroadcaster);
+				theFhirContext,
+				theDaoRegistry,
+				theResourceMergeService,
+				theResourceUndoMergeService,
+				theInterceptorBroadcaster);
 	}
 }

hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/provider/ReplaceReferencesSvcImpl.java

@@ -47,6 +47,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import java.util.Collections;
 import java.util.Date;
 import java.util.List;
 import java.util.stream.Stream;
@@ -182,7 +183,8 @@ private IBaseParameters replaceReferencesPreferSync(
 					List.of(result),
 					startTime,
 					theRequestDetails,
-					theReplaceReferencesRequest.provenanceAgents);
+					theReplaceReferencesRequest.provenanceAgents,
+					Collections.emptyList());
 		}
 
 		Parameters retval = new Parameters();

hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/provider/merge/BaseMergeOperationInputParameters.java renamed to hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/provider/merge/MergeOperationInputParameters.java

@@ -26,8 +26,6 @@
 import ca.uhn.fhir.interceptor.model.RequestPartitionId;
 import ca.uhn.fhir.jpa.api.config.JpaStorageSettings;
 import ca.uhn.fhir.model.api.IProvenanceAgent;
-import ca.uhn.fhir.util.CanonicalIdentifier;
-import org.hl7.fhir.instance.model.api.IBaseReference;
 import org.hl7.fhir.instance.model.api.IBaseResource;
 import org.hl7.fhir.r4.model.Patient;
 
@@ -36,55 +34,17 @@
 /**
  * See <a href="https://build.fhir.org/patient-operation-merge.html">Patient $merge spec</a>
  */
-public abstract class BaseMergeOperationInputParameters {
+public class MergeOperationInputParameters extends MergeOperationsCommonInputParameters {
 
-	private List<CanonicalIdentifier> mySourceResourceIdentifiers;
-	private List<CanonicalIdentifier> myTargetResourceIdentifiers;
-	private IBaseReference mySourceResource;
-	private IBaseReference myTargetResource;
 	private boolean myPreview;
 	private boolean myDeleteSource;
 	private IBaseResource myResultResource;
-	private final int myResourceLimit;
 	private List<IProvenanceAgent> myProvenanceAgents;
 	private boolean myCreateProvenance = true;
+	private IBaseResource myOriginalInputParameters;
 
-	protected BaseMergeOperationInputParameters(int theResourceLimit) {
-		myResourceLimit = theResourceLimit;
-	}
-
-	public abstract String getSourceResourceParameterName();
-
-	public abstract String getTargetResourceParameterName();
-
-	public abstract String getSourceIdentifiersParameterName();
-
-	public abstract String getTargetIdentifiersParameterName();
-
-	public abstract String getResultResourceParameterName();
-
-	public List<CanonicalIdentifier> getSourceIdentifiers() {
-		return mySourceResourceIdentifiers;
-	}
-
-	public boolean hasAtLeastOneSourceIdentifier() {
-		return mySourceResourceIdentifiers != null && !mySourceResourceIdentifiers.isEmpty();
-	}
-
-	public void setSourceResourceIdentifiers(List<CanonicalIdentifier> theSourceIdentifiers) {
-		this.mySourceResourceIdentifiers = theSourceIdentifiers;
-	}
-
-	public List<CanonicalIdentifier> getTargetIdentifiers() {
-		return myTargetResourceIdentifiers;
-	}
-
-	public boolean hasAtLeastOneTargetIdentifier() {
-		return myTargetResourceIdentifiers != null && !myTargetResourceIdentifiers.isEmpty();
-	}
-
-	public void setTargetResourceIdentifiers(List<CanonicalIdentifier> theTargetIdentifiers) {
-		this.myTargetResourceIdentifiers = theTargetIdentifiers;
+	protected MergeOperationInputParameters(int theResourceLimit) {
+		super(theResourceLimit);
 	}
 
 	public boolean getPreview() {
@@ -111,26 +71,6 @@ public void setResultResource(IBaseResource theResultResource) {
 		this.myResultResource = theResultResource;
 	}
 
-	public IBaseReference getSourceResource() {
-		return mySourceResource;
-	}
-
-	public void setSourceResource(IBaseReference theSourceResource) {
-		this.mySourceResource = theSourceResource;
-	}
-
-	public IBaseReference getTargetResource() {
-		return myTargetResource;
-	}
-
-	public void setTargetResource(IBaseReference theTargetResource) {
-		this.myTargetResource = theTargetResource;
-	}
-
-	public int getResourceLimit() {
-		return myResourceLimit;
-	}
-
 	public boolean getCreateProvenance() {
 		return myCreateProvenance;
 	}
@@ -147,17 +87,23 @@ public void setProvenanceAgents(List<IProvenanceAgent> theProvenanceAgents) {
 		this.myProvenanceAgents = theProvenanceAgents;
 	}
 
+	public IBaseResource getOriginalInputParameters() {
+		return myOriginalInputParameters;
+	}
+
+	public void setOriginalInputParameters(IBaseResource theOriginalInputParameters) {
+		myOriginalInputParameters = theOriginalInputParameters;
+	}
+
 	public MergeJobParameters asMergeJobParameters(
 			FhirContext theFhirContext,
 			JpaStorageSettings theStorageSettings,
 			Patient theSourceResource,
 			Patient theTargetResource,
 			RequestPartitionId thePartitionId) {
 		MergeJobParameters retval = new MergeJobParameters();
-		if (getResultResource() != null) {
-			retval.setResultResource(theFhirContext.newJsonParser().encodeResourceToString(getResultResource()));
-		}
-		retval.setDeleteSource(getDeleteSource());
+		retval.setOriginalInputParameters(
+				theFhirContext.newJsonParser().encodeResourceToString(myOriginalInputParameters));
 		retval.setBatchSize(theStorageSettings.getDefaultTransactionEntriesForWrite());
 		retval.setSourceId(new FhirIdJson(theSourceResource.getIdElement().toVersionless()));
 		retval.setTargetId(new FhirIdJson(theTargetResource.getIdElement().toVersionless()));

hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/provider/merge/MergeOperationOutcome.java

@@ -19,34 +19,16 @@
  */
 package ca.uhn.fhir.jpa.provider.merge;
 
-import org.hl7.fhir.instance.model.api.IBaseOperationOutcome;
 import org.hl7.fhir.instance.model.api.IBaseResource;
 
 /**
  * See <a href="https://build.fhir.org/patient-operation-merge.html">Patient $merge spec</a>
  */
-public class MergeOperationOutcome {
-	private IBaseOperationOutcome myOperationOutcome;
-	private int myHttpStatusCode;
+public class MergeOperationOutcome extends OperationOutcomeWithStatusCode {
+
 	private IBaseResource myUpdatedTargetResource;
 	private IBaseResource myTask;
 
-	public IBaseOperationOutcome getOperationOutcome() {
-		return myOperationOutcome;
-	}
-
-	public void setOperationOutcome(IBaseOperationOutcome theOperationOutcome) {
-		this.myOperationOutcome = theOperationOutcome;
-	}
-
-	public int getHttpStatusCode() {
-		return myHttpStatusCode;
-	}
-
-	public void setHttpStatusCode(int theHttpStatusCode) {
-		this.myHttpStatusCode = theHttpStatusCode;
-	}
-
 	public IBaseResource getUpdatedTargetResource() {
 		return myUpdatedTargetResource;
 	}

hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/provider/merge/MergeOperationsCommonInputParameters.java

@@ -0,0 +1,84 @@
+/*-
+ * #%L
+ * HAPI FHIR JPA Server
+ * %%
+ * Copyright (C) 2014 - 2025 Smile CDR, Inc.
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package ca.uhn.fhir.jpa.provider.merge;
+
+import ca.uhn.fhir.util.CanonicalIdentifier;
+import org.hl7.fhir.instance.model.api.IBaseReference;
+
+import java.util.List;
+
+/**
+ *  Class for input parameters used in both $merge and $hapi.fhir.undo-merge operations.
+ */
+public class MergeOperationsCommonInputParameters {
+	private List<CanonicalIdentifier> mySourceResourceIdentifiers;
+	private List<CanonicalIdentifier> myTargetResourceIdentifiers;
+	private IBaseReference mySourceResource;
+	private IBaseReference myTargetResource;
+	private final int myResourceLimit;
+
+	public MergeOperationsCommonInputParameters(int theResourceLimit) {
+		myResourceLimit = theResourceLimit;
+	}
+
+	public List<CanonicalIdentifier> getSourceIdentifiers() {
+		return mySourceResourceIdentifiers;
+	}
+
+	public boolean hasAtLeastOneSourceIdentifier() {
+		return mySourceResourceIdentifiers != null && !mySourceResourceIdentifiers.isEmpty();
+	}
+
+	public void setSourceResourceIdentifiers(List<CanonicalIdentifier> theSourceIdentifiers) {
+		this.mySourceResourceIdentifiers = theSourceIdentifiers;
+	}
+
+	public List<CanonicalIdentifier> getTargetIdentifiers() {
+		return myTargetResourceIdentifiers;
+	}
+
+	public boolean hasAtLeastOneTargetIdentifier() {
+		return myTargetResourceIdentifiers != null && !myTargetResourceIdentifiers.isEmpty();
+	}
+
+	public void setTargetResourceIdentifiers(List<CanonicalIdentifier> theTargetIdentifiers) {
+		this.myTargetResourceIdentifiers = theTargetIdentifiers;
+	}
+
+	public IBaseReference getSourceResource() {
+		return mySourceResource;
+	}
+
+	public void setSourceResource(IBaseReference theSourceResource) {
+		this.mySourceResource = theSourceResource;
+	}
+
+	public IBaseReference getTargetResource() {
+		return myTargetResource;
+	}
+
+	public void setTargetResource(IBaseReference theTargetResource) {
+		this.myTargetResource = theTargetResource;
+	}
+
+	public int getResourceLimit() {
+		return myResourceLimit;
+	}
+}