ca.uhn.fhir.mdm.api.IMdmMatchFinderSvc Maven / Gradle / Ivy

Go to download
/*-
 * #%L
 * HAPI FHIR - Master Data Management
 * %%
 * Copyright (C) 2014 - 2024 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.mdm.api;

import ca.uhn.fhir.interceptor.model.RequestPartitionId;
import jakarta.annotation.Nonnull;
import org.hl7.fhir.instance.model.api.IAnyResource;

import java.util.List;

public interface IMdmMatchFinderSvc {

	/**
	 * Retrieve a list of possible target candidates for matching, based on the given {@link IAnyResource}
	 * Internally, performs all MDM matching rules on the type of the resource.
	 *
	 * @param theResourceType the type of the resource.
	 * @param theResource the resource that we are attempting to find matches for.
	 * @return a List of {@link MatchedTarget} representing POSSIBLE_MATCH and MATCH outcomes.
	 */
	@Nonnull
	List getMatchedTargets(
			String theResourceType, IAnyResource theResource, RequestPartitionId theRequestPartitionId);
}