Release 5 Preview #2

Operation-codesystem-find-matches

Vocabulary Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Not linked to any defined compartments

This is the narrative for the resource. See also the XML, JSON or Turtle format.


Finding codes based on supplied properties

OPERATION: Finding codes based on supplied properties

The official URL for this operation definition is:

http://hl7.org/fhir/OperationDefinition/CodeSystem-find-matches

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.

URL: [base]/CodeSystem/$find-matches

URL: [base]/CodeSystem/[id]/$find-matches

Parameters

UseNameCardinalityTypeBindingDocumentation
INsystem0..1uri

The system in which composition is to be performed. This must be provided unless the operation is invoked on a code system instance

INversion0..1string

The version of the system for the inferencing to be performed

INproperty0..*

One or more properties that contain information to be composed into the code

INproperty.code1..1code

Identifies the property provided

INproperty.value0..1code | Coding | string | integer | boolean | dateTime

The value of the property provided

INproperty.subproperty0..*

Nested Properties (mainly used for SNOMED CT composition, for relationship Groups)

INproperty.subproperty.code1..1code

Identifies the sub-property provided

INproperty.subproperty.value1..1code | Coding | string | integer | boolean | dateTime

The value of the sub-property provided

INexact1..1boolean

Whether 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'

INcompositional0..1boolean

Post-coordinated expressions are allowed to be returned in the matching codes (mainly for SNOMED CT). Default = false

OUTmatch0..*

Concepts returned by the server as a result of the inferencing operation

OUTmatch.code1..1Coding

A code that matches the properties provided

OUTmatch.unmatched0..*

One or more properties that contain properties that could not be matched into the code

OUTmatch.unmatched.code1..1code

Identifies the property provided

OUTmatch.unmatched.value1..1code | Coding | string | integer | boolean | dateTime

The value of the property provided

OUTmatch.unmatched.property0..*

Nested Properties (mainly used for SNOMED CT composition, for relationship Groups)

OUTmatch.unmatched.property.code1..1code

Identifies the sub-property provided

OUTmatch.unmatched.property.value1..1code | Coding | string | integer | boolean | dateTime

The value of the sub-property provided

OUTmatch.comment0..1string

Information about the quality of the match, if operation is for a human


 

 

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.