Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

Example OperationDefinition/CodeSystem-find-matches (Narrative)

Terminology Infrastructure Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: 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

UseNameScopeCardinalityTypeBindingDocumentation
INsystemtype0..1uri

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

INversiontype0..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..1Coding | boolean | code | dateTime | integer | string

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..1Coding | boolean | code | dateTime | integer | string

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..1Coding | boolean | code | dateTime | integer | string

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..1Coding | boolean | code | dateTime | integer | string

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.