Operation-codesystem-subsumes.xml

Operation Definition

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="CodeSystem-subsumes"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2>Subsumption Testing</h2>
      <p>OPERATION: Subsumption Testing</p>
      <div>
        <p>Test whether code &quot;sub&quot; is subsumed by code &quot;super&quot; given the semantics
           of subsumption in the underlying code system (see hierarchyMeaning)</p>

      </div>
      <p>URL: [base]/CodeSystem/$subsumes</p>
      <p>URL: [base]/CodeSystem/[id]/$subsumes</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>codeA</td>
          <td>0..1</td>
          <td>code</td>
          <td/>
          <td>
            <div>
              <p>The &quot;sub&quot; code that is to be tested. If a code is provided, a system must be
                 provided</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>codeB</td>
          <td>0..1</td>
          <td>code</td>
          <td/>
          <td>
            <div>
              <p>The &quot;super&quot; code that is to be validated. If a code is provided, a system must
                 be provided</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>system</td>
          <td>0..1</td>
          <td>uri</td>
          <td/>
          <td>
            <div>
              <p>The system in which subsumption testing 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, if one was provided in the source data</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>codingA</td>
          <td>0..1</td>
          <td>Coding</td>
          <td/>
          <td>
            <div>
              <p>The &quot;sub&quot; coding to test. The coding system does not have to match the specified
                 subsumption system, but the relationships between the systems must be well established</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>codingB</td>
          <td>0..1</td>
          <td>Coding</td>
          <td/>
          <td>
            <div>
              <p>The &quot;super&quot; coding to test. The coding system does not have to match the specified
                 subsumption system, but the relationships between the systems must be well established</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>OUT</td>
          <td>outcome</td>
          <td>1..1</td>
          <td>code</td>
          <td/>
          <td>
            <div>
              <p>Whether &quot;sub&quot; is subsumed by &quot;super&quot;. There are 4 possible codes to
                 be returned: equivalent, subsumes, subsumed-by, and not-subsumed. If the server is unable
                 to determine the relationship between the codes, then it returns an error (i.e. an OperationOutcome)</p>

            </div>
          </td>
        </tr>
      </table>
    </div>
  </text>
  <url value="http://hl7.org/fhir/OperationDefinition/CodeSystem-subsumes"/>
  <name value="Subsumption Testing"/>
  <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="Test whether code &quot;sub&quot; is subsumed by code &quot;super&quot; given the semantics
   of subsumption in the underlying code system (see hierarchyMeaning)"/>
  <code value="subsumes"/>
  <resource value="CodeSystem"/>
  <system value="false"/>
  <type value="true"/>
  <instance value="true"/>
  <parameter>
    <name value="codeA"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The &quot;sub&quot; code that is to be tested. If a code is provided, a system must be
     provided"/>
    <type value="code"/>
  </parameter>
  <parameter>
    <name value="codeB"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The &quot;super&quot; code that is to be validated. If a code is provided, a system must
     be provided"/>
    <type value="code"/>
  </parameter>
  <parameter>
    <name value="system"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The system in which subsumption testing 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, if one was provided in the source data"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="codingA"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The &quot;sub&quot; coding to test. The coding system does not have to match the specified
     subsumption system, but the relationships between the systems must be well established"/>
    <type value="Coding"/>
  </parameter>
  <parameter>
    <name value="codingB"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The &quot;super&quot; coding to test. The coding system does not have to match the specified
     subsumption system, but the relationships between the systems must be well established"/>
    <type value="Coding"/>
  </parameter>
  <parameter>
    <name value="outcome"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="Whether &quot;sub&quot; is subsumed by &quot;super&quot;. There are 4 possible codes to
     be returned: equivalent, subsumes, subsumed-by, and not-subsumed. If the server is unable
     to determine the relationship between the codes, then it returns an error (i.e. an OperationOutcome)"/>
    <type value="code"/>
  </parameter>
</OperationDefinition>