Codesystem-restful-interaction.json

The set of interactions defined by the RESTful part of the FHIR specification

{
  "resourceType": "CodeSystem",
  "id": "restful-interaction",
  "text": {
    "status": "generated",
    "div": "<div>\n      <h2>FHIR Restful Interactions</h2>\n      <p>The set of interactions defined by the RESTful part of the FHIR specification.</p>\n      <p>This code system http://hl7.org/fhir/restful-interaction defines the following codes:</p>\n      <table class=\"codes\">\n        <tr>\n          <td>\n            <b>Lvl</b>\n          </td>\n          <td>\n            <b>Code</b>\n          </td>\n          <td>\n            <b>Display</b>\n          </td>\n          <td>\n            <b>Definition</b>\n          </td>\n        </tr>\n        <tr>\n          <td>1</td>\n          <td>read\n            <a name=\"read\"> </a>\n          </td>\n          <td>read</td>\n          <td>Read the current state of the resource.</td>\n        </tr>\n        <tr>\n          <td>1</td>\n          <td>vread\n            <a name=\"vread\"> </a>\n          </td>\n          <td>vread</td>\n          <td>Read the state of a specific version of the resource.</td>\n        </tr>\n        <tr>\n          <td>1</td>\n          <td>update\n            <a name=\"update\"> </a>\n          </td>\n          <td>update</td>\n          <td>Update an existing resource by its id (or create it if it is new).</td>\n        </tr>\n        <tr>\n          <td>1</td>\n          <td>delete\n            <a name=\"delete\"> </a>\n          </td>\n          <td>delete</td>\n          <td>Delete a resource.</td>\n        </tr>\n        <tr>\n          <td>1</td>\n          <td>history\n            <a name=\"history\"> </a>\n          </td>\n          <td>history</td>\n          <td>Retrieve the change history for a particular resource, type of resource, or the entire system.</td>\n        </tr>\n        <tr>\n          <td>2</td>\n          <td>  history-instance\n            <a name=\"history-instance\"> </a>\n          </td>\n          <td>history-instance</td>\n          <td>Retrieve the change history for a particular resource.</td>\n        </tr>\n        <tr>\n          <td>2</td>\n          <td>  history-type\n            <a name=\"history-type\"> </a>\n          </td>\n          <td>history-type</td>\n          <td>Retrieve the change history for a all resources of a particular type.</td>\n        </tr>\n        <tr>\n          <td>2</td>\n          <td>  history-system\n            <a name=\"history-system\"> </a>\n          </td>\n          <td>history-system</td>\n          <td>Retrieve the change history for all resources on a system.</td>\n        </tr>\n        <tr>\n          <td>1</td>\n          <td>create\n            <a name=\"create\"> </a>\n          </td>\n          <td>create</td>\n          <td>Create a new resource with a server assigned id.</td>\n        </tr>\n        <tr>\n          <td>1</td>\n          <td>search\n            <a name=\"search\"> </a>\n          </td>\n          <td>search</td>\n          <td>Search a resource type or all resources based on some filter criteria.</td>\n        </tr>\n        <tr>\n          <td>2</td>\n          <td>  search-type\n            <a name=\"search-type\"> </a>\n          </td>\n          <td>search-type</td>\n          <td>Search all resources of the specified type based on some filter criteria.</td>\n        </tr>\n        <tr>\n          <td>2</td>\n          <td>  search-system\n            <a name=\"search-system\"> </a>\n          </td>\n          <td>search-system</td>\n          <td>Search all resources based on some filter criteria.</td>\n        </tr>\n        <tr>\n          <td>1</td>\n          <td>conformance\n            <a name=\"conformance\"> </a>\n          </td>\n          <td>conformance</td>\n          <td>Get a conformance statement for the system.</td>\n        </tr>\n        <tr>\n          <td>1</td>\n          <td>transaction\n            <a name=\"transaction\"> </a>\n          </td>\n          <td>transaction</td>\n          <td>Update, create or delete a set of resources as a single transaction.</td>\n        </tr>\n        <tr>\n          <td>1</td>\n          <td>batch\n            <a name=\"batch\"> </a>\n          </td>\n          <td>batch</td>\n          <td>perform a set of a separate interactions in a single http operation</td>\n        </tr>\n        <tr>\n          <td>1</td>\n          <td>operation\n            <a name=\"operation\"> </a>\n          </td>\n          <td>operation</td>\n          <td>Perform an operation as defined by an OperationDefinition.</td>\n        </tr>\n      </table>\n    </div>"
  },
  "url": "http://hl7.org/fhir/restful-interaction",
  "name": "FHIR Restful Interactions",
  "status": "draft",
  "publisher": "FHIR Project",
  "description": "The set of interactions defined by the RESTful part of the FHIR specification.",
  "caseSensitive": true,
  "valueSet": "http://hl7.org/fhir/ValueSet/restful-interaction",
  "content": "complete",
  "concept": [
    {
      "code": "read",
      "display": "read",
      "definition": "Read the current state of the resource."
    },
    {
      "code": "vread",
      "display": "vread",
      "definition": "Read the state of a specific version of the resource."
    },
    {
      "code": "update",
      "display": "update",
      "definition": "Update an existing resource by its id (or create it if it is new)."
    },
    {
      "code": "delete",
      "display": "delete",
      "definition": "Delete a resource."
    },
    {
      "code": "history",
      "display": "history",
      "definition": "Retrieve the change history for a particular resource, type of resource, or the entire system.",
      "concept": [
        {
          "code": "history-instance",
          "display": "history-instance",
          "definition": "Retrieve the change history for a particular resource."
        },
        {
          "code": "history-type",
          "display": "history-type",
          "definition": "Retrieve the change history for a all resources of a particular type."
        },
        {
          "code": "history-system",
          "display": "history-system",
          "definition": "Retrieve the change history for all resources on a system."
        }
      ]
    },
    {
      "code": "create",
      "display": "create",
      "definition": "Create a new resource with a server assigned id."
    },
    {
      "code": "search",
      "display": "search",
      "definition": "Search a resource type or all resources based on some filter criteria.",
      "concept": [
        {
          "code": "search-type",
          "display": "search-type",
          "definition": "Search all resources of the specified type based on some filter criteria."
        },
        {
          "code": "search-system",
          "display": "search-system",
          "definition": "Search all resources based on some filter criteria."
        }
      ]
    },
    {
      "code": "conformance",
      "display": "conformance",
      "definition": "Get a conformance statement for the system."
    },
    {
      "code": "transaction",
      "display": "transaction",
      "definition": "Update, create or delete a set of resources as a single transaction."
    },
    {
      "code": "batch",
      "display": "batch",
      "definition": "perform a set of a separate interactions in a single http operation"
    },
    {
      "code": "operation",
      "display": "operation",
      "definition": "Perform an operation as defined by an OperationDefinition."
    }
  ]
}