codesystem-restful-interaction.txt

{
 "resourceType": "CodeSystem",
 "id": "restful-interaction",
 "meta": {
  "lastUpdated": "2019-11-01T09:29:23.356+11:00"
 },
 "text": {
  "status": "generated",
  "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2>FHIR Restful Interactions</h2><div><p>The set of interactions defined by the RESTful part of the FHIR specification.</p>\n</div><p>This code system http://hl7.org/fhir/restful-interaction defines the following codes:</p><table class=\"codes\"><tr><td><b>Lvl</b></td><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td>1</td><td style=\"white-space:nowrap\">read<a name=\"restful-interaction-read\"> </a></td><td>read</td><td>Read the current state of the resource.</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">vread<a name=\"restful-interaction-vread\"> </a></td><td>vread</td><td>Read the state of a specific version of the resource.</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">update<a name=\"restful-interaction-update\"> </a></td><td>update</td><td>Update an existing resource by its id (or create it if it is new).</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">patch<a name=\"restful-interaction-patch\"> </a></td><td>patch</td><td>Update an existing resource by posting a set of changes to it.</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">delete<a name=\"restful-interaction-delete\"> </a></td><td>delete</td><td>Delete a resource.</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">history<a name=\"restful-interaction-history\"> </a></td><td>history</td><td>Retrieve the change history for a particular resource, type of resource, or the entire system.</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0history-instance<a name=\"restful-interaction-history-instance\"> </a></td><td>history-instance</td><td>Retrieve the change history for a particular resource.</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0history-type<a name=\"restful-interaction-history-type\"> </a></td><td>history-type</td><td>Retrieve the change history for all resources of a particular type.</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0history-system<a name=\"restful-interaction-history-system\"> </a></td><td>history-system</td><td>Retrieve the change history for all resources on a system.</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">create<a name=\"restful-interaction-create\"> </a></td><td>create</td><td>Create a new resource with a server assigned id.</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">search<a name=\"restful-interaction-search\"> </a></td><td>search</td><td>Search a resource type or all resources based on some filter criteria.</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0search-type<a name=\"restful-interaction-search-type\"> </a></td><td>search-type</td><td>Search all resources of the specified type based on some filter criteria.</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0search-system<a name=\"restful-interaction-search-system\"> </a></td><td>search-system</td><td>Search all resources based on some filter criteria.</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">capabilities<a name=\"restful-interaction-capabilities\"> </a></td><td>capabilities</td><td>Get a Capability Statement for the system.</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">transaction<a name=\"restful-interaction-transaction\"> </a></td><td>transaction</td><td>Update, create or delete a set of resources as a single transaction.</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">batch<a name=\"restful-interaction-batch\"> </a></td><td>batch</td><td>perform a set of a separate interactions in a single http operation</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">operation<a name=\"restful-interaction-operation\"> </a></td><td>operation</td><td>Perform an operation as defined by an OperationDefinition.</td></tr></table></div>"
 },
 "extension": [
  {
   "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
   "valueCode": "fhir"
  },
  {
   "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
   "valueCode": "normative"
  },
  {
   "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
   "valueCode": "4.0.0"
  },
  {
   "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
   "valueInteger": 5
  }
 ],
 "url": "http://hl7.org/fhir/restful-interaction",
 "version": "4.0.1",
 "name": "FHIR Restful Interactions",
 "status": "active",
 "experimental": false,
 "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",
 "hierarchyMeaning": "is-a",
 "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": "patch",
   "display": "patch",
   "definition": "Update an existing resource by posting a set of changes to it."
  },
  {
   "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 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": "capabilities",
   "display": "capabilities",
   "definition": "Get a Capability 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."
  }
 ]
}