001package ca.uhn.fhir.mdm.api;
002
003/*-
004 * #%L
005 * HAPI FHIR - Master Data Management
006 * %%
007 * Copyright (C) 2014 - 2022 Smile CDR, Inc.
008 * %%
009 * Licensed under the Apache License, Version 2.0 (the "License");
010 * you may not use this file except in compliance with the License.
011 * You may obtain a copy of the License at
012 *
013 *      http://www.apache.org/licenses/LICENSE-2.0
014 *
015 * Unless required by applicable law or agreed to in writing, software
016 * distributed under the License is distributed on an "AS IS" BASIS,
017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
018 * See the License for the specific language governing permissions and
019 * limitations under the License.
020 * #L%
021 */
022
023import org.hl7.fhir.instance.model.api.IAnyResource;
024
025import javax.annotation.Nonnull;
026import java.util.List;
027
028public interface IMdmMatchFinderSvc {
029        
030        /**
031         * Retrieve a list of possible target candidates for matching, based on the given {@link IAnyResource}
032         * Internally, performs all MDM matching rules on the type of the resource.
033         *
034         * @param theResourceType the type of the resource.
035         * @param theResource the resource that we are attempting to find matches for.
036         * @return a List of {@link MatchedTarget} representing POSSIBLE_MATCH and MATCH outcomes.
037         */
038        @Nonnull
039        List<MatchedTarget> getMatchedTargets(String theResourceType, IAnyResource theResource);
040}