R4 Ballot #1 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Codesystem-restful-interaction.json

FHIR Infrastructure Work GroupMaturity Level: N/ABallot Status: Informative

Raw JSON (canonical form)

Definition for Code System FHIR Restful Interactions

{
  "resourceType": "CodeSystem",
  "id": "restful-interaction",
  "meta": {
    "lastUpdated": "2018-04-03T12:05:46.262+10:00"
  },
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fhir"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status",
      "valueString": "Normative"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 3
    }
  ],
  "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",
  "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."
    }
  ]
}

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.