Operation-capabilitystatement-conforms.xml

Operation Definition

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="CapabilityStatement-conforms"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2>Test if a server implements a client's required operations</h2>
      <p>OPERATION: Test if a server implements a client's required operations</p>
      <div>
        <p>This operation asks the server to check that it implements all the resources, interactions,
           search parameters, and operations that the client provides in it's capability statement.
           The client provides both capability statements by reference, and must ensure that all
           the referenced resources are available to the conformance server</p>

      </div>
      <p>URL: [base]/CapabilityStatement/$conforms</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>left</td>
          <td>0..1</td>
          <td>uri</td>
          <td/>
          <td>
            <div>
              <p>The canonical URL for the server capability statement - use this if the subset is not
                 invoked on an instance (or on the /metadata end-point)</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>right</td>
          <td>0..1</td>
          <td>uri</td>
          <td/>
          <td>
            <div>
              <p>The canonical URL for the client capability statement - use this if the subset is not
                 invoked on an instance (or on the /metadata end-point)</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>mode</td>
          <td>0..1</td>
          <td>code</td>
          <td/>
          <td>
            <div>
              <p>What kind of comparison to preform - server cf server, or client to server (use the codes
                 'server/server' or 'client/server')</p>

            </div>
          </td>
        </tr>
      </table>
      <div>
        <p>The operation performs a full comparison of the functionality described by the two capability
           statements, including the profiles and value sets they reference, and also including concept
           maps and structure maps.</p>

        <p>The full execution of this operation is still a matter of research, but it is intended
           to support comparison of systems to see if they will interoperate</p>

        <p>If the capability statements can be successfully compared, then the return value is a
           200 OK with an OperationOutcome along with intersection and union capability statements.
           The operation outcome can contain errors relating to differences between the capability
           statements. If the capability statements cannot be compared, because dependencies cannot
           be located, the return value is a 4xx error, with an OperationOutcome with at least one
           issue with severity &gt;= error</p>

      </div>
    </div>
  </text>
  <url value="http://hl7.org/fhir/OperationDefinition/CapabilityStatement-conforms"/>
  <name value="Test if a server implements a client's required operations"/>
  <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="This operation asks the server to check that it implements all the resources, interactions,
   search parameters, and operations that the client provides in it's capability statement.
   The client provides both capability statements by reference, and must ensure that all
   the referenced resources are available to the conformance server"/>
  <code value="conforms"/>
  <comment value="The operation performs a full comparison of the functionality described by the two capability
   statements, including the profiles and value sets they reference, and also including concept
   maps and structure maps.   The full execution of this operation is still a matter of research,
   but it is intended to support comparison of systems to see if they will interoperate 
   If the capability statements can be successfully compared, then the return value is a
   200 OK with an OperationOutcome along with intersection and union capability statements.
   The operation outcome can contain errors relating to differences between the capability
   statements. If the capability statements cannot be compared, because dependencies cannot
   be located, the return value is a 4xx error, with an OperationOutcome with at least one
   issue with severity &gt;= error"/>
  <resource value="CapabilityStatement"/>
  <system value="false"/>
  <type value="true"/>
  <instance value="false"/>
  <parameter>
    <name value="left"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The canonical URL for the server capability statement - use this if the subset is not
     invoked on an instance (or on the /metadata end-point)"/>
    <type value="uri"/>
  </parameter>
  <parameter>
    <name value="right"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The canonical URL for the client capability statement - use this if the subset is not
     invoked on an instance (or on the /metadata end-point)"/>
    <type value="uri"/>
  </parameter>
  <parameter>
    <name value="mode"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="What kind of comparison to preform - server cf server, or client to server (use the codes
     'server/server' or 'client/server')"/>
    <type value="code"/>
  </parameter>
</OperationDefinition>