001/*-
002 * #%L
003 * HAPI FHIR - Master Data Management
004 * %%
005 * Copyright (C) 2014 - 2024 Smile CDR, Inc.
006 * %%
007 * Licensed under the Apache License, Version 2.0 (the "License");
008 * you may not use this file except in compliance with the License.
009 * You may obtain a copy of the License at
010 *
011 *      http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 * #L%
019 */
020package ca.uhn.fhir.mdm.api;
021
022import ca.uhn.fhir.mdm.model.MdmMergeGoldenResourcesParams;
023import org.hl7.fhir.instance.model.api.IAnyResource;
024
025public interface IGoldenResourceMergerSvc {
026        /**
027         * Move all links from the theFromGoldenResource to theToGoldenResource and then set active=false on theFromGoldenResource.
028         * Merge all Golden Resource fields subject to survivorship rules.
029         *
030         * @param theFromGoldenResource the golden resource we are merging from
031         * @param theManuallyMergedResource an optional golden resource that was manually merged
032         * @param theToGoldenResource the golden resource we are merging to
033         * @return updated theToGoldenResource with the merged fields and links.
034         */
035        IAnyResource mergeGoldenResources(MdmMergeGoldenResourcesParams theParams);
036}