Operation-codesystem-compose.xml

Operation Definition

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="CodeSystem-compose"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2>Code Composition based on supplied properties</h2>
      <p>OPERATION: Code Composition based on supplied properties</p>
      <div>
        <p>Given a set of properties, return one or more possible matching codes</p>

        <p>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.</p>

        <p>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 informationfor some of the properties</p>

        <p>The $compose 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</p>

        <p>The compose operation is still preliminary. The interface can be expected to change as
           more experience is gained from implementations.</p>

      </div>
      <p>URL: [base]/CodeSystem/$compose</p>
      <p>URL: [base]/CodeSystem/[id]/$compose</p>
      <p>Parameters</p>
      <table class="grid">
        <tr>
          <td>
            <b>Use</b>
          </td>
          <td>
            <b>Name</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>0..1</td>
          <td>uri</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>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>version</td>
          <td>0..1</td>
          <td>string</td>
          <td/>
          <td>
            <div>
              <p>The version of the system for the inferencing to be performed</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>property</td>
          <td>0..*</td>
          <td/>
          <td/>
          <td>
            <div>
              <p>One or more properties that contain information to be composed into the code</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>property.code</td>
          <td>1..1</td>
          <td>code</td>
          <td/>
          <td>
            <div>
              <p>Identifies the property provided</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>property.value</td>
          <td>1..1</td>
          <td>code</td>
          <td/>
          <td>
            <div>
              <p>The value of the property provided</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>property.subproperty</td>
          <td>0..*</td>
          <td/>
          <td/>
          <td>
            <div>
              <p>Nested Properties (mainly used for SNOMED CT composition, for relationship Groups)</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>property.subproperty.code</td>
          <td>1..1</td>
          <td>code</td>
          <td/>
          <td>
            <div>
              <p>Identifies the sub-property provided</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>property.subproperty.value</td>
          <td>1..1</td>
          <td>code</td>
          <td/>
          <td>
            <div>
              <p>The value of the sub-property provided</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>mode</td>
          <td>1..1</td>
          <td>code</td>
          <td/>
          <td>
            <div>
              <p>Whether the operation is being used by a human, or a machine. 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 sure matches, or none at all</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>compositional</td>
          <td>0..1</td>
          <td>boolean</td>
          <td/>
          <td>
            <div>
              <p>Post-coordinated expressions are allowed to be returned in the matching codes (mainly
                 for SNOMED CT). Default = false</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>OUT</td>
          <td>match</td>
          <td>0..*</td>
          <td/>
          <td/>
          <td>
            <div>
              <p>Concepts returned by the server as a result of the inferencing operation</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>OUT</td>
          <td>match.code</td>
          <td>1..1</td>
          <td>Coding</td>
          <td/>
          <td>
            <div>
              <p>A code that matches the properties provided</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>OUT</td>
          <td>match.unmatched</td>
          <td>1..1</td>
          <td/>
          <td/>
          <td>
            <div>
              <p>One or more properties that contain properties that could not be matched into the code</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>OUT</td>
          <td>match.unmatched.code</td>
          <td>1..1</td>
          <td>code</td>
          <td/>
          <td>
            <div>
              <p>Identifies the property provided</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>OUT</td>
          <td>match.unmatched.value</td>
          <td>1..1</td>
          <td>code</td>
          <td/>
          <td>
            <div>
              <p>The value of the property provided</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>OUT</td>
          <td>match.unmatched.property</td>
          <td>0..*</td>
          <td/>
          <td/>
          <td>
            <div>
              <p>Nested Properties (mainly used for SNOMED CT composition, for relationship Groups)</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>OUT</td>
          <td>match.unmatched.property.code</td>
          <td>1..1</td>
          <td>code</td>
          <td/>
          <td>
            <div>
              <p>Identifies the sub-property provided</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>OUT</td>
          <td>match.unmatched.property.value</td>
          <td>1..1</td>
          <td>code</td>
          <td/>
          <td>
            <div>
              <p>The value of the sub-property provided</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>OUT</td>
          <td>match.comment</td>
          <td>0..1</td>
          <td>string</td>
          <td/>
          <td>
            <div>
              <p>Information about the quality of the match, if operation is for a human</p>

            </div>
          </td>
        </tr>
      </table>
    </div>
  </text>
  <url value="http://hl7.org/fhir/OperationDefinition/CodeSystem-compose"/>
  <name value="Code Composition based on supplied properties"/>
  <status value="draft"/>
  <kind value="operation"/>
  <date value="2016-12-06T12:22:34+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, 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 informationfor some of the properties  The
   $compose 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  The compose operation is still preliminary. The interface can be expected
   to change as more experience is gained from implementations."/>
  <code value="compose"/>
  <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>
      <name value="value"/>
      <use value="in"/>
      <min value="1"/>
      <max value="1"/>
      <documentation value="The value of the property provided"/>
      <type value="code"/>
    </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>
        <name value="value"/>
        <use value="in"/>
        <min value="1"/>
        <max value="1"/>
        <documentation value="The value of the sub-property provided"/>
        <type value="code"/>
      </part>
    </part>
  </parameter>
  <parameter>
    <name value="mode"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="Whether the operation is being used by a human, or a machine. 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 sure matches, or none at all"/>
    <type value="code"/>
  </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="1"/>
      <max value="1"/>
      <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>
        <name value="value"/>
        <use value="out"/>
        <min value="1"/>
        <max value="1"/>
        <documentation value="The value of the property provided"/>
        <type value="code"/>
      </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>
          <name value="value"/>
          <use value="out"/>
          <min value="1"/>
          <max value="1"/>
          <documentation value="The value of the sub-property provided"/>
          <type value="code"/>
        </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>