$find-matches

Finding codes based on supplied properties

draftFHIR Core package4.3.0operation5 inputs1 output

Given a set of properties (and text), return one or more possible matching codes

This operation takes a set of properties, and examines the code system looking for codes in the code system that match a set of known properties.

When looking for matches, there are 3 possible types of match:

  • a complete match - a code that represents all the provided properties correctly
  • a partial match - a code that represents some of the provided properties correctly, and not others
  • a possible match - a code that may represent the provided properties closely, but may capture less or more precise information for some of the properties

The $find-matches operation can be called in one of 2 modes:

  • By a human, looking for the best match for a set of properties. In this mode, the server returns a list of complete, possible or partial matches (possibly with comments), so that the user can choose (or not) the most appropriate code
  • By a machine (typically in a system interface performing a transformation). In this mode, the server returns only a list of complete and partial matches, but no possible matches. The machine can choose a code from the list (or not) based on what properties are not coded

These modes are differentiated by the 'exact' parameter, so the client can indicate whether it only wants exact matches (including partial matches) or whether potential matches based on text matching are desired

The find-matches operation is still preliminary. The interface can be expected to change as more experience is gained from implementations.

Metadata

hl7.org/fhir
Canonical URL
http://hl7.org/fhir/OperationDefinition/CodeSystem-find-matches
Code
$find-matches
Kind
operation
Affects State
No
Publisher
HL7 (FHIR Project)

Invocation Context

Can be invoked at:
Type LevelInstance Level
Target Resources:
CodeSystem
Affects State:No

Input Parameters (5)

NameTypeCard.Description
systemuri0..1The system in which composition is to be performed. This must be provided unless the operation is invoked on a code system instance
versionstring0..1The version of the system for the inferencing to be performed
propertyany0..*One or more properties that contain information to be composed into the code
exact*boolean1..1Whether the operation is being used by a human ('false'), or a machine ('true'). If the operation is being used by a human, the terminology server can return a list of possible matches, with commentary. For a machine, the server returns complete or partial matches, not possible matches. The default value is 'false'
compositionalboolean0..1Post-coordinated expressions are allowed to be returned in the matching codes (mainly for SNOMED CT). Default = false

Output Parameters (1)

NameTypeCard.Description
matchany0..*Concepts returned by the server as a result of the inferencing operation

Additional Information

Version
4.3.0
Date
2022-05-28T12:47:40+10:00