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.api.params.GenerateMdmMetricsParameters;
023import ca.uhn.fhir.mdm.model.MdmMetrics;
024
025public interface IMdmMetricSvc {
026
027        /**
028         * Generates metrics on MDM Links.
029         * Metrics include:
030         * * breakdowns of counts of MATCH_RESULT types by LINK_SOURCE types.
031         * * counts of resources of each type
032         * * a histogram of score 'buckets' with the appropriate counts.
033         * @param theParameters - Parameters defining resource type of interest,
034         *                      as well as MatchResult and LinkSource filters.
035         * @return The metrics in a JSON format.
036         */
037        MdmMetrics generateMdmMetrics(GenerateMdmMetricsParameters theParameters);
038}