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

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

Parameters

Use Name Cardinality Type Binding Documentation
IN system 0..1 uri

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

The version of the system for the inferencing to be performed
IN property 0..*

One or more properties that contain information to be composed into the code
IN property.code 1..1 code

Identifies the property provided
IN property.value 0..1 Coding | boolean | code | dateTime | integer | string

The value of the property provided
IN property.subproperty 0..*

Nested Properties (mainly used for SNOMED CT composition, for relationship Groups)
IN property.subproperty.code 1..1 code

Identifies the sub-property provided
IN property.subproperty.value 1..1 Coding | boolean | code | dateTime | integer | string

The value of the sub-property provided
IN exact 1..1 boolean

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'
IN compositional 0..1 boolean

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

Concepts returned by the server as a result of the inferencing operation
OUT match.code 1..1 Coding

A code that matches the properties provided
OUT match.unmatched 0..*

One or more properties that contain properties that could not be matched into the code
OUT match.unmatched.code 1..1 code

Identifies the property provided
OUT match.unmatched.value 1..1 Coding | boolean | code | dateTime | integer | string

The value of the property provided
OUT match.unmatched.property 0..*

Nested Properties (mainly used for SNOMED CT composition, for relationship Groups)
OUT match.unmatched.property.code 1..1 code

Identifies the sub-property provided
OUT match.unmatched.property.value 1..1 Coding | boolean | code | dateTime | integer | string

The value of the sub-property provided
OUT match.comment 0..1 string

Information about the quality of the match, if operation is for a human
<status value="draft"/> <kind value="operation"/> <experimental value="false"/> <date value="2022-12-14T07:12:54+11:00"/> <publisher value="HL7 (FHIR Project)"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> <telecom> <system value="email"/> <value value="fhir@lists.hl7.org"/> </telecom> </contact> <description value="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."/> <jurisdiction> <coding> <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> <code value="001"/> <display value="World"/> </coding> </jurisdiction> <affectsState value="false"/> <code value="find-matches"/> <resource value="CodeSystem"/> <system value="false"/> <type value="true"/> <instance value="true"/> <parameter> <name value="system"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="The system in which composition is to be performed. This must be provided unless the operation is invoked on a code system instance"/> <type value="uri"/> </parameter> <parameter> <name value="version"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="The version of the system for the inferencing to be performed"/> <type value="string"/> </parameter> <parameter> <name value="property"/> <use value="in"/> <min value="0"/> <max value="*"/> <documentation value="One or more properties that contain information to be composed into the code"/> <part> <name value="code"/> <use value="in"/> <min value="1"/> <max value="1"/> <documentation value="Identifies the property provided"/> <type value="code"/> </part> <part> <extension url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type"> <valueUri value="Coding"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type"> <valueUri value="boolean"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type"> <valueUri value="code"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type"> <valueUri value="dateTime"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type"> <valueUri value="integer"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type"> <valueUri value="string"/> </extension> <name value="value"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="The value of the property provided"/> <type value="Element"/> </part> <part> <name value="subproperty"/> <use value="in"/> <min value="0"/> <max value="*"/> <documentation value="Nested Properties (mainly used for SNOMED CT composition, for relationship Groups)"/> <part> <name value="code"/> <use value="in"/> <min value="1"/> <max value="1"/> <documentation value="Identifies the sub-property provided"/> <type value="code"/> </part> <part> <extension url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type"> <valueUri value="Coding"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type"> <valueUri value="boolean"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type"> <valueUri value="code"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type"> <valueUri value="dateTime"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type"> <valueUri value="integer"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type"> <valueUri value="string"/> </extension> <name value="value"/> <use value="in"/> <min value="1"/> <max value="1"/> <documentation value="The value of the sub-property provided"/> <type value="Element"/> </part> </part> </parameter> <parameter> <name value="exact"/> <use value="in"/> <min value="1"/> <max value="1"/> <documentation value="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'"/> <type value="boolean"/> </parameter> <parameter> <name value="compositional"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="Post-coordinated expressions are allowed to be returned in the matching codes (mainly for SNOMED CT). Default = false"/> <type value="boolean"/> </parameter> <parameter> <name value="match"/> <use value="out"/> <min value="0"/> <max value="*"/> <documentation value="Concepts returned by the server as a result of the inferencing operation"/> <part> <name value="code"/> <use value="out"/> <min value="1"/> <max value="1"/> <documentation value="A code that matches the properties provided"/> <type value="Coding"/> </part> <part> <name value="unmatched"/> <use value="out"/> <min value="0"/> <max value="*"/> <documentation value="One or more properties that contain properties that could not be matched into the code"/> <part> <name value="code"/> <use value="out"/> <min value="1"/> <max value="1"/> <documentation value="Identifies the property provided"/> <type value="code"/> </part> <part> <extension url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type"> <valueUri value="Coding"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type"> <valueUri value="boolean"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type"> <valueUri value="code"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type"> <valueUri value="dateTime"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type"> <valueUri value="integer"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type"> <valueUri value="string"/> </extension> <name value="value"/> <use value="out"/> <min value="1"/> <max value="1"/> <documentation value="The value of the property provided"/> <type value="Element"/> </part> <part> <name value="property"/> <use value="out"/> <min value="0"/> <max value="*"/> <documentation value="Nested Properties (mainly used for SNOMED CT composition, for relationship Groups)"/> <part> <name value="code"/> <use value="out"/> <min value="1"/> <max value="1"/> <documentation value="Identifies the sub-property provided"/> <type value="code"/> </part> <part> <extension url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type"> <valueUri value="Coding"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type"> <valueUri value="boolean"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type"> <valueUri value="code"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type"> <valueUri value="dateTime"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type"> <valueUri value="integer"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type"> <valueUri value="string"/> </extension> <name value="value"/> <use value="out"/> <min value="1"/> <max value="1"/> <documentation value="The value of the sub-property provided"/> <type value="Element"/> </part> </part> </part> <part> <name value="comment"/> <use value="out"/> <min value="0"/> <max value="1"/> <documentation value="Information about the quality of the match, if operation is for a human"/> <type value="string"/> </part> </parameter> </OperationDefinition>