Operation Definition

{
  "resourceType" : "OperationDefinition",
  "id" : "CapabilityStatement-implements",
  "text" : {
    "status" : "generated",
    "div" : "<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><a name=\"CapabilityStatement-implements-en-US\"> </a><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=\"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>\n</div></td></tr><tr><td>IN</td><td>client</td><td/><td>0..1</td><td><a href=\"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>\n</div></td></tr><tr><td>IN</td><td>resource</td><td/><td>0..1</td><td><a href=\"capabilitystatement.html\">CapabilityStatement</a></td><td/><td><div><p>The client capability statement, provided inline</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"operationoutcome.html\">OperationOutcome</a></td><td/><td><div><p>Outcome of the CapabilityStatement test</p>\n</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>\n<ul>\n<li>The server's capability statement must have an entry for each resource in the client's capability statement</li>\n<li>The server's resource support must have matching flags for updateCreate, conditionalCreate, conditionalRead, conditionalUpdate, conditionalPatch, conditionalDelete, searchInclude, searchRevInclude</li>\n<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>\n<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>\n<li>The server must have an operation definition with a matching reference for any operations in the client capability statement</li>\n</ul>\n<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>\n</div></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 5
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "trial-use"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "fhir"
  }],
  "url" : "http://hl7.org/fhir/OperationDefinition/CapabilityStatement-implements",
  "version" : "6.0.0-ballot2",
  "name" : "Implements",
  "title" : "Test if a server implements a client's required operations",
  "status" : "draft",
  "kind" : "operation",
  "experimental" : false,
  "date" : "2024-11-15T17:44:13+00:00",
  "publisher" : "HL7 International / FHIR Infrastructure",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    },
    {
      "system" : "email",
      "value" : "fhir@lists.hl7.org"
    }]
  },
  {
    "telecom" : [{
      "system" : "url",
      "value" : "http://www.hl7.org/Special/committees/fiwg"
    }]
  }],
  "description" : "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" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "affectsState" : false,
  "code" : "implements",
  "comment" : "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:   \n\n* The server's capability statement must have an entry for each resource in the client's capability statement    \n* The server's resource support must have matching flags for updateCreate, conditionalCreate, conditionalRead, conditionalUpdate, conditionalPatch, conditionalDelete, searchInclude, searchRevInclude   \n* 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)   \n* The server's capability statement must have a search parameter with matching name and definition for any search parameters in the client capability statement   \n* The server must have an operation definition with a matching reference for any operations in the client capability statement   \n\nIf 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 >= 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 >= error",
  "resource" : ["CapabilityStatement"],
  "system" : false,
  "type" : true,
  "instance" : true,
  "parameter" : [{
    "name" : "server",
    "use" : "in",
    "min" : 0,
    "max" : "1",
    "documentation" : "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" : "canonical"
  },
  {
    "name" : "client",
    "use" : "in",
    "min" : 0,
    "max" : "1",
    "documentation" : "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" : "canonical"
  },
  {
    "name" : "resource",
    "use" : "in",
    "min" : 0,
    "max" : "1",
    "documentation" : "The client capability statement, provided inline",
    "type" : "CapabilityStatement"
  },
  {
    "name" : "return",
    "use" : "out",
    "min" : 1,
    "max" : "1",
    "documentation" : "Outcome of the CapabilityStatement test",
    "type" : "OperationOutcome"
  }]
}