Release 4 5

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0: R5 - Mixed Normative and STU ) ). This is the current published version in it's permanent home (it will always be available at this URL). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

Operation-codesystem-find-matches

Example OperationDefinition/CodeSystem-find-matches (Narrative)

Vocabulary Terminology Infrastructure Work Group Maturity Level : N/A Standards Status : Informative Compartments : Not linked to any No 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

Note 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 is the 'exact' parameter, so formal definition for 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. an OperationDefinition on CodeSystem. See the Operation documentation

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

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

Parameters

Use Name Scope Cardinality Type Binding Documentation
IN system type 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 type 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 code | Coding | string | integer | 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 code | Coding | string | integer | 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 code | Coding | string | integer | 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 code | Coding | string | integer | 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

 

 

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.