Freetext Search Provider

IFreetextSearchService in assembly SanteDB.Core.Api version 3.0.1980.0

Summary

Contract which defines free-text search functionality

Description

In SanteDB HDSI, the _any parameter can be used by a client to indicate that the caller does not care which field the value matches, rather the client is performing a free-text or full-text search. Full text searches can be used to search for content like: John Smith HBA1C December. Such requests are passed to the IFreetextSearchService as a series of terms provided by the client.

Implementers are expected to call their full-text technology provider to perform the search. Additionally, implementers should provide an IJob implementation (or should subscribe to updates from the IDataPersistenceService) to maintain the index.

Implementations of the freetext search service may be technologies like Apache Lucene, PostgreSQL Free-Text Search, Amazon Elastic Search, etc.

Operations

Operation	Response/Return	Input/Parameter	Description
SearchEntity	IQueryResultSet<TEntity>	String[] term	Perform the freetext search with

Implementations

ADO.NET Freetext Service - (SanteDB.Persistence.Data)

An implementation of the IFreetextSearchService which uses the underlying built-in database functionality

Description

This implementation of the free-text search service relies on a IDbProvider implementation providing a IDbFilterFunction with the identifier freetext. The call is equivalent to using the HDSI query expression: id=:(freetext|$term) and uses SanteDB's extended filter function (see an example of implementing a custom IDbFilterFunction

Service Registration

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

MdmFreetextSearchService - (SanteDB.Persistence.MDM)

Freetext search service that is Master Aware

Description

Only use this freetext search service if your freetext search service implementation interacts directly with the SanteDB database, not if you're using something like Lucene or Redshift as those are index based and the fetch should be done via the IRepositoryService

Service Registration

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

Example Implementation

/// Example Implementation
using SanteDB.Core.Services;
/// Other usings here
public class MyFreetextSearchService : SanteDB.Core.Services.IFreetextSearchService { 
	public String ServiceName => "My own IFreetextSearchService service";
	/// <summary>
	/// Perform the freetext search with
	/// </summary>
	public IQueryResultSet<TEntity> SearchEntity<TEntity>(String[] term){
		throw new System.NotImplementedException();
	}
}

References

• IFreetextSearchService C# Documentation

• AdoFreetextSearchService C# Documentation

• MdmFreetextSearchService C# Documentation