2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Valueset-restful-interaction.json

Raw JSON (canonical form)

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

{
  "resourceType": "ValueSet",
  "id": "valueset-restful-interaction",
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/vs/restful-interaction",
  "name": "FHIR Restful Interactions",
  "publisher": "FHIR Project",
  "description": "The set of interactions defined by the RESTful part of the FHIR specification",
  "status": "draft",
  "define": {
    "system": "http://hl7.org/fhir/restful-interaction",
    "caseSensitive": true,
    "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",
        "abstract": false,
        "display": "history",
        "definition": "Retrieve the update history for a particular resource, type of resource, or the entire system",
        "concept": [
          {
            "code": "history-instance",
            "display": "history-instance",
            "definition": "Retrieve the update history for a particular resource"
          },
          {
            "code": "history-type",
            "display": "history-type",
            "definition": "Retrieve the update history for a all resources of a particular type"
          },
          {
            "code": "history-system",
            "display": "history-system",
            "definition": "Retrieve the update history for all resources on a system"
          }
        ]
      },
      {
        "code": "create",
        "display": "create",
        "definition": "Create a new resource with a server assigned id"
      },
      {
        "code": "search",
        "abstract": false,
        "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": "validate",
        "display": "validate",
        "definition": "Check that the content would be acceptable as an update"
      },
      {
        "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": "operation",
        "display": "operation",
        "definition": "Perform an operation as defined by an OperationDefinition"
      }
    ]
  }
}

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.