Operation Definition

{
  "resourceType" : "OperationDefinition",
  "id" : "CodeSystem-find-matches",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition CodeSystem-find-matches</b></p><a name=\"CodeSystem-find-matches\"> </a><a name=\"hcCodeSystem-find-matches\"> </a><a name=\"CodeSystem-find-matches-en-US\"> </a><p>URL: [base]/CodeSystem/$find-matches</p><p>URL: [base]/CodeSystem/[id]/$find-matches</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>system</td><td>type</td><td>0..1</td><td><a href=\"datatypes.html#uri\">uri</a></td><td/><td><div><p>The system in which composition is to be performed. This must be provided unless the operation is invoked on a code system instance</p>\n</div></td></tr><tr><td>IN</td><td>version</td><td>type</td><td>0..1</td><td><a href=\"datatypes.html#string\">string</a></td><td/><td><div><p>The version of the system for the inferencing to be performed</p>\n</div></td></tr><tr><td>IN</td><td>property</td><td/><td>0..*</td><td></td><td/><td><div><p>One or more properties that contain information to be composed into the code</p>\n</div></td></tr><tr><td>IN</td><td>property.code</td><td/><td>1..1</td><td><a href=\"datatypes.html#code\">code</a></td><td/><td><div><p>Identifies the property provided</p>\n</div></td></tr><tr><td>IN</td><td>property.value</td><td/><td>0..1</td><td><a href=\"datatypes.html#Coding\">Coding</a> | <a href=\"datatypes.html#boolean\">boolean</a> | <a href=\"datatypes.html#code\">code</a> | <a href=\"datatypes.html#dateTime\">dateTime</a> | <a href=\"datatypes.html#integer\">integer</a> | <a href=\"datatypes.html#string\">string</a></td><td/><td><div><p>The value of the property provided</p>\n</div></td></tr><tr><td>IN</td><td>property.subproperty</td><td/><td>0..*</td><td></td><td/><td><div><p>Nested Properties (mainly used for SNOMED CT composition, for relationship Groups)</p>\n</div></td></tr><tr><td>IN</td><td>property.subproperty.code</td><td/><td>1..1</td><td><a href=\"datatypes.html#code\">code</a></td><td/><td><div><p>Identifies the sub-property provided</p>\n</div></td></tr><tr><td>IN</td><td>property.subproperty.value</td><td/><td>1..1</td><td><a href=\"datatypes.html#Coding\">Coding</a> | <a href=\"datatypes.html#boolean\">boolean</a> | <a href=\"datatypes.html#code\">code</a> | <a href=\"datatypes.html#dateTime\">dateTime</a> | <a href=\"datatypes.html#integer\">integer</a> | <a href=\"datatypes.html#string\">string</a></td><td/><td><div><p>The value of the sub-property provided</p>\n</div></td></tr><tr><td>IN</td><td>exact</td><td/><td>1..1</td><td><a href=\"datatypes.html#boolean\">boolean</a></td><td/><td><div><p>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'</p>\n</div></td></tr><tr><td>IN</td><td>compositional</td><td/><td>0..1</td><td><a href=\"datatypes.html#boolean\">boolean</a></td><td/><td><div><p>Post-coordinated expressions are allowed to be returned in the matching codes (mainly for SNOMED CT). Default = false</p>\n</div></td></tr><tr><td>OUT</td><td>match</td><td/><td>0..*</td><td></td><td/><td><div><p>Concepts returned by the server as a result of the inferencing operation</p>\n</div></td></tr><tr><td>OUT</td><td>match.code</td><td/><td>1..1</td><td><a href=\"datatypes.html#Coding\">Coding</a></td><td/><td><div><p>A code that matches the properties provided</p>\n</div></td></tr><tr><td>OUT</td><td>match.unmatched</td><td/><td>0..*</td><td></td><td/><td><div><p>One or more properties that contain properties that could not be matched into the code</p>\n</div></td></tr><tr><td>OUT</td><td>match.unmatched.code</td><td/><td>1..1</td><td><a href=\"datatypes.html#code\">code</a></td><td/><td><div><p>Identifies the property provided</p>\n</div></td></tr><tr><td>OUT</td><td>match.unmatched.value</td><td/><td>1..1</td><td><a href=\"datatypes.html#Coding\">Coding</a> | <a href=\"datatypes.html#boolean\">boolean</a> | <a href=\"datatypes.html#code\">code</a> | <a href=\"datatypes.html#dateTime\">dateTime</a> | <a href=\"datatypes.html#integer\">integer</a> | <a href=\"datatypes.html#string\">string</a></td><td/><td><div><p>The value of the property provided</p>\n</div></td></tr><tr><td>OUT</td><td>match.unmatched.property</td><td/><td>0..*</td><td></td><td/><td><div><p>Nested Properties (mainly used for SNOMED CT composition, for relationship Groups)</p>\n</div></td></tr><tr><td>OUT</td><td>match.unmatched.property.code</td><td/><td>1..1</td><td><a href=\"datatypes.html#code\">code</a></td><td/><td><div><p>Identifies the sub-property provided</p>\n</div></td></tr><tr><td>OUT</td><td>match.unmatched.property.value</td><td/><td>1..1</td><td><a href=\"datatypes.html#Coding\">Coding</a> | <a href=\"datatypes.html#boolean\">boolean</a> | <a href=\"datatypes.html#code\">code</a> | <a href=\"datatypes.html#dateTime\">dateTime</a> | <a href=\"datatypes.html#integer\">integer</a> | <a href=\"datatypes.html#string\">string</a></td><td/><td><div><p>The value of the sub-property provided</p>\n</div></td></tr><tr><td>OUT</td><td>match.comment</td><td/><td>0..1</td><td><a href=\"datatypes.html#string\">string</a></td><td/><td><div><p>Information about the quality of the match, if operation is for a human</p>\n</div></td></tr></table></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 0
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "trial-use"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "vocab"
  }],
  "url" : "http://hl7.org/fhir/OperationDefinition/CodeSystem-find-matches",
  "version" : "6.0.0-ballot2",
  "name" : "FindMatches",
  "title" : "Finding codes based on supplied properties",
  "status" : "draft",
  "kind" : "operation",
  "experimental" : false,
  "date" : "2024-11-20T15:00:58+00:00",
  "publisher" : "HL7 International / Terminology Infrastructure",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    },
    {
      "system" : "email",
      "value" : "fhir@lists.hl7.org"
    }]
  },
  {
    "telecom" : [{
      "system" : "url",
      "value" : "http://www.hl7.org/Special/committees/Vocab"
    }]
  }],
  "description" : "Given a set of properties (and text), return one or more possible matching codes\n\nThis 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. \n\nWhen looking for matches, there are 3 possible types of match:\n* a complete match - a code that represents all the provided properties correctly\n* a partial match - a code that represents some of the provided properties correctly, and not others \n* 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\n\nThe $find-matches operation can be called in one of 2 modes:\n* 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\n* 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\n\nThese 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\n \nThe find-matches operation is still preliminary. The interface can be expected to change as more experience is gained from implementations.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "affectsState" : false,
  "code" : "find-matches",
  "resource" : ["CodeSystem"],
  "system" : false,
  "type" : true,
  "instance" : true,
  "parameter" : [{
    "name" : "system",
    "use" : "in",
    "scope" : ["type"],
    "min" : 0,
    "max" : "1",
    "documentation" : "The system in which composition is to be performed. This must be provided unless the operation is invoked on a code system instance",
    "type" : "uri"
  },
  {
    "name" : "version",
    "use" : "in",
    "scope" : ["type"],
    "min" : 0,
    "max" : "1",
    "documentation" : "The version of the system for the inferencing to be performed",
    "type" : "string"
  },
  {
    "name" : "property",
    "use" : "in",
    "min" : 0,
    "max" : "*",
    "documentation" : "One or more properties that contain information to be composed into the code",
    "part" : [{
      "name" : "code",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "Identifies the property provided",
      "type" : "code"
    },
    {
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
        "valueUri" : "Coding"
      },
      {
        "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
        "valueUri" : "boolean"
      },
      {
        "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
        "valueUri" : "code"
      },
      {
        "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
        "valueUri" : "dateTime"
      },
      {
        "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
        "valueUri" : "integer"
      },
      {
        "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
        "valueUri" : "string"
      }],
      "name" : "value",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The value of the property provided",
      "type" : "Element"
    },
    {
      "name" : "subproperty",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "Nested Properties (mainly used for SNOMED CT composition, for relationship Groups)",
      "part" : [{
        "name" : "code",
        "use" : "in",
        "min" : 1,
        "max" : "1",
        "documentation" : "Identifies the sub-property provided",
        "type" : "code"
      },
      {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
          "valueUri" : "Coding"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
          "valueUri" : "boolean"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
          "valueUri" : "code"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
          "valueUri" : "dateTime"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
          "valueUri" : "integer"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
          "valueUri" : "string"
        }],
        "name" : "value",
        "use" : "in",
        "min" : 1,
        "max" : "1",
        "documentation" : "The value of the sub-property provided",
        "type" : "Element"
      }]
    }]
  },
  {
    "name" : "exact",
    "use" : "in",
    "min" : 1,
    "max" : "1",
    "documentation" : "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" : "boolean"
  },
  {
    "name" : "compositional",
    "use" : "in",
    "min" : 0,
    "max" : "1",
    "documentation" : "Post-coordinated expressions are allowed to be returned in the matching codes (mainly for SNOMED CT). Default = false",
    "type" : "boolean"
  },
  {
    "name" : "match",
    "use" : "out",
    "min" : 0,
    "max" : "*",
    "documentation" : "Concepts returned by the server as a result of the inferencing operation",
    "part" : [{
      "name" : "code",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "A code that matches the properties provided",
      "type" : "Coding"
    },
    {
      "name" : "unmatched",
      "use" : "out",
      "min" : 0,
      "max" : "*",
      "documentation" : "One or more properties that contain properties that could not be matched into the code",
      "part" : [{
        "name" : "code",
        "use" : "out",
        "min" : 1,
        "max" : "1",
        "documentation" : "Identifies the property provided",
        "type" : "code"
      },
      {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
          "valueUri" : "Coding"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
          "valueUri" : "boolean"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
          "valueUri" : "code"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
          "valueUri" : "dateTime"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
          "valueUri" : "integer"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
          "valueUri" : "string"
        }],
        "name" : "value",
        "use" : "out",
        "min" : 1,
        "max" : "1",
        "documentation" : "The value of the property provided",
        "type" : "Element"
      },
      {
        "name" : "property",
        "use" : "out",
        "min" : 0,
        "max" : "*",
        "documentation" : "Nested Properties (mainly used for SNOMED CT composition, for relationship Groups)",
        "part" : [{
          "name" : "code",
          "use" : "out",
          "min" : 1,
          "max" : "1",
          "documentation" : "Identifies the sub-property provided",
          "type" : "code"
        },
        {
          "extension" : [{
            "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
            "valueUri" : "Coding"
          },
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
            "valueUri" : "boolean"
          },
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
            "valueUri" : "code"
          },
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
            "valueUri" : "dateTime"
          },
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
            "valueUri" : "integer"
          },
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
            "valueUri" : "string"
          }],
          "name" : "value",
          "use" : "out",
          "min" : 1,
          "max" : "1",
          "documentation" : "The value of the sub-property provided",
          "type" : "Element"
        }]
      }]
    },
    {
      "name" : "comment",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "Information about the quality of the match, if operation is for a human",
      "type" : "string"
    }]
  }]
}