Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Example ValueSet/type-restful-interaction (JSON)

Terminology Infrastructure Work GroupMaturity Level: N/AStandards Status: Informative

Raw JSON (canonical form + also see JSON Format Specification)

Definition for Value SetType Restful Interaction

{
  "resourceType" : "ValueSet",
  "id" : "type-restful-interaction",
  "meta" : {
    "lastUpdated" : "2023-03-26T15:21:02.749+11:00",
    "profile" : ["http://hl7.org/fhir/StructureDefinition/shareablevalueset"]
  },
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      \n      \n      <ul>\n        \n        \n        <li>Include these codes as defined in \n          \n          \n          <a href=\"codesystem-restful-interaction.html\">\n            \n            \n            <code>http://hl7.org/fhir/restful-interaction</code>\n          \n          \n          </a>\n          \n          \n          <table class=\"none\">\n            \n            \n            <tr>\n              \n              \n              <td style=\"white-space:nowrap\">\n                \n                \n                <b>Code</b>\n              \n              \n              </td>\n              \n              \n              <td>\n                \n                \n                <b>Display</b>\n              \n              \n              </td>\n              \n              \n              <td>\n                \n                \n                <b>Definition</b>\n              \n              \n              </td>\n            \n            \n            </tr>\n            \n            \n            <tr>\n              \n              \n              <td>\n                \n                \n                <a href=\"codesystem-restful-interaction.html#restful-interaction-read\">read</a>\n              \n              \n              </td>\n              \n              \n              <td>read</td>\n              \n              \n              <td>Read the current state of the resource.</td>\n            \n            \n            </tr>\n            \n            \n            <tr>\n              \n              \n              <td>\n                \n                \n                <a href=\"codesystem-restful-interaction.html#restful-interaction-vread\">vread</a>\n              \n              \n              </td>\n              \n              \n              <td>vread</td>\n              \n              \n              <td>Read the state of a specific version of the resource.</td>\n            \n            \n            </tr>\n            \n            \n            <tr>\n              \n              \n              <td>\n                \n                \n                <a href=\"codesystem-restful-interaction.html#restful-interaction-update\">update</a>\n              \n              \n              </td>\n              \n              \n              <td>update</td>\n              \n              \n              <td>Update an existing resource by its id (or create it if it is new).</td>\n            \n            \n            </tr>\n            \n            \n            <tr>\n              \n              \n              <td>\n                \n                \n                <a href=\"codesystem-restful-interaction.html#restful-interaction-patch\">patch</a>\n              \n              \n              </td>\n              \n              \n              <td>patch</td>\n              \n              \n              <td>Update an existing resource by posting a set of changes to it.</td>\n            \n            \n            </tr>\n            \n            \n            <tr>\n              \n              \n              <td>\n                \n                \n                <a href=\"codesystem-restful-interaction.html#restful-interaction-delete\">delete</a>\n              \n              \n              </td>\n              \n              \n              <td>delete</td>\n              \n              \n              <td>Delete a resource.</td>\n            \n            \n            </tr>\n            \n            \n            <tr>\n              \n              \n              <td>\n                \n                \n                <a href=\"codesystem-restful-interaction.html#restful-interaction-history-instance\">history-instance</a>\n              \n              \n              </td>\n              \n              \n              <td>history-instance</td>\n              \n              \n              <td>Retrieve the change history for a particular resource.</td>\n            \n            \n            </tr>\n            \n            \n            <tr>\n              \n              \n              <td>\n                \n                \n                <a href=\"codesystem-restful-interaction.html#restful-interaction-history-type\">history-type</a>\n              \n              \n              </td>\n              \n              \n              <td>history-type</td>\n              \n              \n              <td>Retrieve the change history for all resources of a particular type.</td>\n            \n            \n            </tr>\n            \n            \n            <tr>\n              \n              \n              <td>\n                \n                \n                <a href=\"codesystem-restful-interaction.html#restful-interaction-create\">create</a>\n              \n              \n              </td>\n              \n              \n              <td>create</td>\n              \n              \n              <td>Create a new resource with a server assigned id.</td>\n            \n            \n            </tr>\n            \n            \n            <tr>\n              \n              \n              <td>\n                \n                \n                <a href=\"codesystem-restful-interaction.html#restful-interaction-search-type\">search-type</a>\n              \n              \n              </td>\n              \n              \n              <td>search-type</td>\n              \n              \n              <td>Search all resources of the specified type based on some filter criteria.</td>\n            \n            \n            </tr>\n          \n          \n          </table>\n        \n        \n        </li>\n      \n      \n      </ul>\n    \n    \n    </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/ValueSet/type-restful-interaction",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.3.180"
  },
  {
    "use" : "old",
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.3.170"
  },
  {
    "use" : "old",
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.2.83"
  }],
  "version" : "5.0.0",
  "name" : "TypeRestfulInteraction",
  "title" : "Type Restful Interaction",
  "status" : "active",
  "experimental" : false,
  "date" : "2020-12-28T16:55:11+11:00",
  "publisher" : "HL7 (FHIR Project)",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    },
    {
      "system" : "email",
      "value" : "fhir@lists.hl7.org"
    }]
  }],
  "description" : "Operations supported by REST at the type or instance level.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "compose" : {
    "include" : [{
      "system" : "http://hl7.org/fhir/restful-interaction",
      "concept" : [{
        "code" : "read"
      },
      {
        "code" : "vread"
      },
      {
        "code" : "update"
      },
      {
        "code" : "patch"
      },
      {
        "code" : "delete"
      },
      {
        "code" : "history-instance"
      },
      {
        "code" : "history-type"
      },
      {
        "code" : "create"
      },
      {
        "code" : "search-type"
      }]
    }]
  }
}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.