# Record Matching Provider

`IRecordMatchingService` in assembly SanteDB.Core.Api version 3.0.1980.0

## Summary

Represents a service that performs record matching and classification

## Operations

| Operation               | Response/Return                      | Input/Parameter                                                                                                                                                                                                                                    | Description                                                                                      |
| ----------------------- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| Block                   | IQueryResultSet\<T>                  | <p><em>T</em> <strong>input</strong><br><em>String</em> <strong>configurationId</strong><br><em>IEnumerable\<Guid></em> <strong>ignoreList</strong><br><em>IRecordMatchingDiagnosticSession</em> <strong>collector</strong></p>                    | Instructs the record matching service to perform a quick block function of records for type with |
| Classify                | IEnumerable\<IRecordMatchResult\<T>> | <p><em>T</em> <strong>input</strong><br><em>IEnumerable\<T></em> <strong>blocks</strong><br><em>String</em> <strong>configurationId</strong><br><em>IRecordMatchingDiagnosticSession</em> <strong>collector</strong></p>                           | Instructs the record matcher to run a detailed classification on the matching blocks in          |
| Match                   | IEnumerable\<IRecordMatchResult\<T>> | <p><em>T</em> <strong>input</strong><br><em>String</em> <strong>configurationId</strong><br><em>IEnumerable\<Guid></em> <strong>ignoreList</strong><br><em>IRecordMatchingDiagnosticSession</em> <strong>collector</strong></p>                    | Instructs the record matcher to run a block and match operation against                          |
| Match                   | IEnumerable\<IRecordMatchResult>     | <p><em>IdentifiedData</em> <strong>input</strong><br><em>String</em> <strong>configurationId</strong><br><em>IEnumerable\<Guid></em> <strong>ignoreList</strong><br><em>IRecordMatchingDiagnosticSession</em> <strong>collector</strong></p>       | A non-generic method which uses the type of to call Match                                        |
| Classify                | IEnumerable\<IRecordMatchResult>     | <p><em>IdentifiedData</em> <strong>input</strong><br><em>IEnumerable\<IdentifiedData></em> <strong>blocks</strong><br><em>String</em> <strong>configurationId</strong><br><em>IRecordMatchingDiagnosticSession</em> <strong>collector</strong></p> | A non-generic method which uses the type of to call Classify                                     |
| CreateDiagnosticSession | IRecordMatchingDiagnosticSession     | *none*                                                                                                                                                                                                                                             | TODO                                                                                             |

## Implementations

### BaseRecordMatchingService - (SanteDB.Matcher)

Represents base record matching service for SanteDB Matcher

{% hint style="info" %}
This service implementation is abstract or is a generic definition. It is intended to be implemented or constructed at runtime from other services and cannot be used directly
{% endhint %}

### SanteMatch Deterministic Matcher - (SanteDB.Matcher)

Represents a deterministic record matching service

#### Service Registration

```markup
...
<section xsi:type="ApplicationServiceContextConfigurationSection" threadPoolSize="4">
	<serviceProviders>
		...
		<add type="SanteDB.Matcher.Matchers.SimpleRecordMatchingService, SanteDB.Matcher, Version=3.0.1980.0, Culture=neutral, PublicKeyToken=null" />
		...
	</serviceProviders>
```

### SanteMatch Probabalistic Match Service - (SanteDB.Matcher)

Represents a probabalistic record matching service

#### Service Registration

```markup
...
<section xsi:type="ApplicationServiceContextConfigurationSection" threadPoolSize="4">
	<serviceProviders>
		...
		<add type="SanteDB.Matcher.Matchers.WeightedRecordMatchingService, SanteDB.Matcher, Version=3.0.1980.0, Culture=neutral, PublicKeyToken=null" />
		...
	</serviceProviders>
```

### MdmRecordMatchingService - (SanteDB.Persistence.MDM)

Represents a matching service that wraps the underlying system IRecordMatchingService and provides additional functionality

#### Service Registration

```markup
...
<section xsi:type="ApplicationServiceContextConfigurationSection" threadPoolSize="4">
	<serviceProviders>
		...
		<add type="SanteDB.Persistence.MDM.Services.MdmRecordMatchingService, SanteDB.Persistence.MDM, Version=3.0.1980.0, Culture=neutral, PublicKeyToken=null" />
		...
	</serviceProviders>
```

## Example Implementation

```csharp
/// Example Implementation
using SanteDB.Core.Matching;
/// Other usings here
public class MyRecordMatchingService : SanteDB.Core.Matching.IRecordMatchingService { 
	public String ServiceName => "My own IRecordMatchingService service";
	/// <summary>
	/// Instructs the record matching service to perform a quick block function of records            for type  with
	/// </summary>
	public IQueryResultSet<T> Block<T>(T input,String configurationId,IEnumerable<Guid> ignoreList,IRecordMatchingDiagnosticSession collector){
		throw new System.NotImplementedException();
	}
	/// <summary>
	/// Instructs the record matcher to run a detailed classification on the matching blocks in
	/// </summary>
	public IEnumerable<IRecordMatchResult<T>> Classify<T>(T input,IEnumerable<T> blocks,String configurationId,IRecordMatchingDiagnosticSession collector){
		throw new System.NotImplementedException();
	}
	/// <summary>
	/// Instructs the record matcher to run a block and match operation against
	/// </summary>
	public IEnumerable<IRecordMatchResult<T>> Match<T>(T input,String configurationId,IEnumerable<Guid> ignoreList,IRecordMatchingDiagnosticSession collector){
		throw new System.NotImplementedException();
	}
	/// <summary>
	/// A non-generic method which uses the type of  to call Match<T>
	/// </summary>
	public IEnumerable<IRecordMatchResult> Match(IdentifiedData input,String configurationId,IEnumerable<Guid> ignoreList,IRecordMatchingDiagnosticSession collector){
		throw new System.NotImplementedException();
	}
	/// <summary>
	/// A non-generic method which uses the type of  to call Classify<T>
	/// </summary>
	public IEnumerable<IRecordMatchResult> Classify(IdentifiedData input,IEnumerable<IdentifiedData> blocks,String configurationId,IRecordMatchingDiagnosticSession collector){
		throw new System.NotImplementedException();
	}
	public IRecordMatchingDiagnosticSession CreateDiagnosticSession(){
		throw new System.NotImplementedException();
	}
}
```

## References

* [IRecordMatchingService C# Documentation](http://santesuite.org/assets/doc/net/html/T_SanteDB_Core_Matching_IRecordMatchingService.htm)
* [BaseRecordMatchingService C# Documentation](http://santesuite.org/assets/doc/net/html/T_SanteDB_Matcher_Matchers_BaseRecordMatchingService.htm)
* [SimpleRecordMatchingService C# Documentation](http://santesuite.org/assets/doc/net/html/T_SanteDB_Matcher_Matchers_SimpleRecordMatchingService.htm)
* [WeightedRecordMatchingService C# Documentation](http://santesuite.org/assets/doc/net/html/T_SanteDB_Matcher_Matchers_WeightedRecordMatchingService.htm)
* [MdmRecordMatchingService C# Documentation](http://santesuite.org/assets/doc/net/html/T_SanteDB_Persistence_MDM_Services_MdmRecordMatchingService.htm)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.santesuite.org/developers/server-plugins/implementing-.net-features/service-definitions/record-matching-provider.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.