FHIR CI-Build
ConformanceThis is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions
| Terminology Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: No defined compartments |
This is the narrative for the resource. See also the XML, JSON or Turtle format.
Note that this is the formal definition for the find-matches operation as 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 | 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 |
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.
FHIR ®© HL7.org 2011+. FHIR R6 hl7.fhir.core#6.0.0-cibuild generated on Thu, Apr 25, 2024 12:43+0000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R5 |
|
Propose a change