FHIR Application Feature Framework Implementation Guide
1.0.0 - STU 1

FHIR Application Feature Framework Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## : Test if a server implements a client's required operations - XML Representation

Page standards status: Trial-use | Maturity Level: 5

Raw xml | Download

    <OperationDefinition xmlns="http://hl7.org/fhir">
      <id value="CapabilityStatement-implements"/>
      <meta>
        <lastUpdated value="2021-01-05T10:01:24.148+11:00"/>
      </meta>
      <text>
        <status value="generated"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition CapabilityStatement-implements</b></p><a name="CapabilityStatement-implements"> </a><a name="hcCapabilityStatement-implements"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Last updated: 2021-01-05 10:01:24+1100</p></div><p>URL: [base]/CapabilityStatement/$implements</p><p>URL: [base]/CapabilityStatement/[id]/$implements</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>server</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#canonical">canonical</a></td><td/><td><div><p>A canonical reference to the server capability statement - use this if the implements is not invoked on an instance (or on the /metadata end-point)</p>
    </div></td></tr><tr><td>IN</td><td>client</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#canonical">canonical</a></td><td/><td><div><p>A canonical reference to the client capability statement - use this if the implements is not invoked on an instance (or on the /metadata end-point)</p>
    </div></td></tr><tr><td>IN</td><td>resource</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R5/capabilitystatement.html">CapabilityStatement</a></td><td/><td><div><p>The client capability statement, provided inline</p>
    </div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R5/operationoutcome.html">OperationOutcome</a></td><td/><td><div><p>Outcome of the CapabilityStatement test</p>
    </div></td></tr></table><div><p>The operation does not perform a full conformance check; in particular it does not check that the profiles align. It merely checks that the behaviors the client wishes to use are provided    Technically, this operation is implemented as follows:</p>
    <ul>
    <li>The server's capability statement must have an entry for each resource in the client's capability statement</li>
    <li>The server's resource support must have matching flags for updateCreate, conditionalCreate, conditionalRead, conditionalUpdate, conditionalPatch, conditionalDelete, searchInclude, searchRevInclude</li>
    <li>The server's capability statement must have a matching interaction for each interaction in the client capability statement (whether or not it is on a resource)</li>
    <li>The server's capability statement must have a search parameter with matching name and definition for any search parameters in the client capability statement</li>
    <li>The server must have an operation definition with a matching reference for any operations in the client capability statement</li>
    </ul>
    <p>If the capability statements match by these rules, then the return value is a 200 OK with an operation outcome that contains no issues with severity &gt;= error. If the capability statement doesn't match, the return value is a 4xx error, with an OperationOutcome with at least one issue with severity &gt;= error</p>
    </div></div>
      </text>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="5"/>
      </extension>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="trial-use"/>
      </extension>
      <extension url="http://hl7.org/fhir/build/StructureDefinition/example">
        <extension url="list">
          <valueString value="1"/>
        </extension>
        <extension url="response">
          <valueBoolean value="false"/>
        </extension>
        <extension url="content">
          <valueString value="$implements-request.txt"/>
        </extension>
      </extension>
      <extension url="http://hl7.org/fhir/build/StructureDefinition/example">
        <extension url="list">
          <valueString value="1"/>
        </extension>
        <extension url="response">
          <valueBoolean value="true"/>
        </extension>
        <extension url="content">
          <valueString value="$implements-response.txt"/>
        </extension>
      </extension>
      <extension url="http://hl7.org/fhir/build/StructureDefinition/footer">
        <valueMarkdown
                       value="The operation does not perform a full conformance check; in particular it does not check that the profiles align. It merely checks that the behaviors the client wishes to use are provided    Technically, this operation is implemented as follows:

    * The server's capability statement must have an entry for each resource in the client's capability statement
    * The server's resource support must have matching flags for updateCreate, conditionalCreate, conditionalRead, conditionalUpdate, conditionalPatch, conditionalDelete, searchInclude, searchRevInclude
    * The server's capability statement must have a matching interaction for each interaction in the client capability statement (whether or not it is on a resource)
    * The server's capability statement must have a search parameter with matching name and definition for any search parameters in the client capability statement
    * The server must have an operation definition with a matching reference for any operations in the client capability statement

    If the capability statements match by these rules, then the return value is a 200 OK with an operation outcome that contains no issues with severity &gt;= error. If the capability statement doesn't match, the return value is a 4xx error, with an OperationOutcome with at least one issue with severity &gt;= error"/>
      </extension>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="fhir"/>
      </extension>
      <url
           value="http://hl7.org/fhir/uv/application-feature/OperationDefinition/CapabilityStatement-implements"/>
      <identifier>
        <system value="urn:ietf:rfc:3986"/>
        <value value="urn:oid:2.16.840.1.113883.4.642.32.4"/>
      </identifier>
      <version value="1.0.0"/>
      <name value="Implements"/>
      <title value="Test if a server implements a client's required operations"/>
      <status value="active"/>
      <kind value="operation"/>
      <date value="2021-01-05T10:01:24+11:00"/>
      <publisher value="HL7 International / FHIR Infrastructure"/>
      <contact>
        <name value="HL7 International / FHIR Infrastructure"/>
        <telecom>
          <system value="url"/>
          <value value="http://www.hl7.org/Special/committees/fiwg"/>
        </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 its capability statement. The client provides its capability statement inline, or by referring the server to the canonical URL of its capability statement"/>
      <jurisdiction>
        <coding>
          <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
          <code value="001"/>
          <display value="World"/>
        </coding>
      </jurisdiction>
      <affectsState value="false"/>
      <code value="implements"/>
      <comment
               value="The operation does not perform a full conformance check; in particular it does not check that the profiles align. It merely checks that the behaviors the client wishes to use are provided    Technically, this operation is implemented as follows:

    * The server's capability statement must have an entry for each resource in the client's capability statement
    * The server's resource support must have matching flags for updateCreate, conditionalCreate, conditionalRead, conditionalUpdate, conditionalPatch, conditionalDelete, searchInclude, searchRevInclude
    * The server's capability statement must have a matching interaction for each interaction in the client capability statement (whether or not it is on a resource)
    * The server's capability statement must have a search parameter with matching name and definition for any search parameters in the client capability statement
    * The server must have an operation definition with a matching reference for any operations in the client capability statement

    If the capability statements match by these rules, then the return value is a 200 OK with an operation outcome that contains no issues with severity &gt;= error. If the capability statement doesn't match, 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="true"/>
      <parameter>
        <name value="server"/>
        <use value="in"/>
        <min value="0"/>
        <max value="1"/>
        <documentation
                       value="A canonical reference to the server capability statement - use this if the implements is not invoked on an instance (or on the /metadata end-point)"/>
        <type value="canonical"/>
      </parameter>
      <parameter>
        <name value="client"/>
        <use value="in"/>
        <min value="0"/>
        <max value="1"/>
        <documentation
                       value="A canonical reference to the client capability statement - use this if the implements is not invoked on an instance (or on the /metadata end-point)"/>
        <type value="canonical"/>
      </parameter>
      <parameter>
        <name value="resource"/>
        <use value="in"/>
        <min value="0"/>
        <max value="1"/>
        <documentation value="The client capability statement, provided inline"/>
        <type value="CapabilityStatement"/>
      </parameter>
      <parameter>
        <name value="return"/>
        <use value="out"/>
        <min value="1"/>
        <max value="1"/>
        <documentation value="Outcome of the CapabilityStatement test"/>
        <type value="OperationOutcome"/>
      </parameter>
    </OperationDefinition>