Definition for Code SystemFHIRRestfulInteractions

{
  "resourceType" : "CodeSystem",
  "id" : "restful-interaction",
  "meta" : {
    "lastUpdated" : "2025-11-02T01:07:14.271+00:00"
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CodeSystem restful-interaction</b></p><a name=\"restful-interaction\"> </a><a name=\"hcrestful-interaction\"> </a><p>This case-sensitive code system <code>http://hl7.org/fhir/restful-interaction</code> defines the following codes in a Is-A hierarchy:</p><table class=\"codes\"><tr><td><b>Lvl</b></td><td style=\"white-space:nowrap\"><b>Code</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 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>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 an existing resource by its id (or create it if it is new).</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">update-conditional<a name=\"restful-interaction-update-conditional\"> </a></td><td>Update an existing resource based on some identification criteria (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>Update an existing resource by posting a set of changes to it.</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">patch-conditional<a name=\"restful-interaction-patch-conditional\"> </a></td><td>Update an existing resource, based on some identification criteria, 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 a resource.</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">delete-conditional-single<a name=\"restful-interaction-delete-conditional-single\"> </a></td><td>Delete a single resource based on some identification criteria.</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">delete-conditional-multiple<a name=\"restful-interaction-delete-conditional-multiple\"> </a></td><td>Delete one or more resources based on some identification criteria.</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">delete-history<a name=\"restful-interaction-delete-history\"> </a></td><td>Delete all historical versions of a resource.</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">delete-history-version<a name=\"restful-interaction-delete-history-version\"> </a></td><td>Delete a specific version of a resource.</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">history<a name=\"restful-interaction-history\"> </a></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>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>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>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 a new resource with a server assigned id.</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">create-conditional<a name=\"restful-interaction-create-conditional\"> </a></td><td>Create a new resource with a server assigned id if an equivalent resource does not already exist.</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">search<a name=\"restful-interaction-search\"> </a></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 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 all resources based on some filter criteria.</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0search-compartment<a name=\"restful-interaction-search-compartment\"> </a></td><td>Search resources in a compartment 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>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>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>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>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",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.4.1823"
  }],
  "version" : "6.0.0-ballot3",
  "name" : "FHIRRestfulInteractions",
  "title" : "FHIR Restful Interactions",
  "status" : "active",
  "experimental" : true,
  "publisher" : "HL7 International / FHIR Infrastructure",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://www.hl7.org/Special/committees/fiwg"
    }]
  }],
  "description" : "The set of interactions defined by the RESTful part of the FHIR specification.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "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" : "update-conditional",
    "display" : "update-conditional",
    "definition" : "Update an existing resource based on some identification criteria (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" : "patch-conditional",
    "display" : "patch-conditional",
    "definition" : "Update an existing resource, based on some identification criteria, by posting a set of changes to it."
  },
  {
    "code" : "delete",
    "display" : "delete",
    "definition" : "Delete a resource."
  },
  {
    "code" : "delete-conditional-single",
    "display" : "delete-conditional-single",
    "definition" : "Delete a single resource based on some identification criteria."
  },
  {
    "code" : "delete-conditional-multiple",
    "display" : "delete-conditional-multiple",
    "definition" : "Delete one or more resources based on some identification criteria."
  },
  {
    "code" : "delete-history",
    "display" : "delete-history",
    "definition" : "Delete all historical versions of a resource."
  },
  {
    "code" : "delete-history-version",
    "display" : "delete-history-version",
    "definition" : "Delete a specific version of 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" : "create-conditional",
    "display" : "create-conditional",
    "definition" : "Create a new resource with a server assigned id if an equivalent resource does not already exist."
  },
  {
    "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" : "search-compartment",
      "display" : "search-compartment",
      "definition" : "Search resources in a compartment 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."
  }]
}