---
type: "valueset"
title: "Type Restful Interaction"
valueset: "type-restful-interaction"
---
# Type Restful Interaction

- **Official URL**: http://hl7.org/fhir/ValueSet/type-restful-interaction
- **Version**: 6.0.0
- **Status**: active
- **Name**: TypeRestfulInteraction
- **Title**: Type Restful Interaction
- **Publisher**: HL7 (FHIR Project)
- **Description**: Operations supported by REST at the type or instance level.

## Narrative

-   Include these codes as defined in [`http://hl7.org/fhir/restful-interaction`](codesystem-restful-interaction)
    
    | **Code** | **Display** | **Definition** |
    | --- | --- | --- |
    | [read](codesystem-restful-interaction#restful-interaction-read) | read | Read the current state of the resource. |
    | [vread](codesystem-restful-interaction#restful-interaction-vread) | vread | Read the state of a specific version of the resource. |
    | [update](codesystem-restful-interaction#restful-interaction-update) | update | Update an existing resource by its id (or create it if it is new). |
    | [update-conditional](codesystem-restful-interaction#restful-interaction-update-conditional) | update-conditional | Update an existing resource based on some identification criteria (or create it if it is new). |
    | [patch](codesystem-restful-interaction#restful-interaction-patch) | patch | Update an existing resource by posting a set of changes to it. |
    | [patch-conditional](codesystem-restful-interaction#restful-interaction-patch) | patch-conditional | Update an existing resource, based on some identification criteria, by posting a set of changes to it. |
    | [delete](codesystem-restful-interaction#restful-interaction-delete) | delete | Delete a resource. |
    | [delete-conditional-single](codesystem-restful-interaction#restful-interaction-delete-conditional-single) | delete-conditional-single | Delete a single resource based on some identification criteria. |
    | [delete-conditional-multiple](codesystem-restful-interaction#restful-interaction-delete-conditional-multiple) | delete-conditional-multiple | Delete one or more resources based on some identification criteria. |
    | [delete-history](codesystem-restful-interaction#restful-interaction-delete-history) | delete-history | Delete all historical versions of a resource. |
    | [delete-history-version](codesystem-restful-interaction#restful-interaction-delete-history-version) | delete-history-version | Delete a specific version of a resource. |
    | [history-instance](codesystem-restful-interaction#restful-interaction-history-instance) | history-instance | Retrieve the change history for a particular resource. |
    | [history-type](codesystem-restful-interaction#restful-interaction-history-type) | history-type | Retrieve the change history for all resources of a particular type. |
    | [create](codesystem-restful-interaction#restful-interaction-create) | create | Create a new resource with a server assigned id. |
    | [create-conditional](codesystem-restful-interaction#restful-interaction-create-conditional) | create-conditional | Create a new resource with a server assigned id if an equivalent resource does not already exist. |
    | [search-type](codesystem-restful-interaction#restful-interaction-search-type) | search-type | Search all resources of the specified type based on some filter criteria. |

## Content (Compose)

- **System**: http://hl7.org/fhir/restful-interaction | **Concepts**: read, vread, update, update-conditional, patch, patch-conditional, delete, delete-conditional-single, delete-conditional-multiple, delete-history, delete-history-version, history-instance, history-type, create, create-conditional, search-type

## ValueSet XML



```xml
<?xml version="1.0" encoding="UTF-8"?>

<ValueSet xmlns="http://hl7.org/fhir">
  <id value="type-restful-interaction"/>
  <meta>
    <lastUpdated value="2020-12-28T16:55:11.085+11:00"/>
  </meta>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      
      <ul>
        
        <li>Include these codes as defined in 
          
          <a href="codesystem-restful-interaction.html">
            
            <code>http://hl7.org/fhir/restful-interaction</code>
          
          </a>
          
          <table class="none">
            
            <tr>
              
              <td style="white-space:nowrap">
                
                <b>Code</b>
              
              </td>
              
              <td>
                
                <b>Display</b>
              
              </td>
              
              <td>
                
                <b>Definition</b>
              
              </td>
            
            </tr>
            
            <tr>
              
              <td>
                
                <a href="codesystem-restful-interaction.html#restful-interaction-read">read</a>
              
              </td>
              
              <td>read</td>
              
              <td>Read the current state of the resource.</td>
            
            </tr>
            
            <tr>
              
              <td>
                
                <a href="codesystem-restful-interaction.html#restful-interaction-vread">vread</a>
              
              </td>
              
              <td>vread</td>
              
              <td>Read the state of a specific version of the resource.</td>
            
            </tr>
            
            <tr>
              
              <td>
                
                <a href="codesystem-restful-interaction.html#restful-interaction-update">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>
                
                <a href="codesystem-restful-interaction.html#restful-interaction-update-conditional">update-conditional</a>
              
              </td>
              
              <td>update-conditional</td>
              
              <td>Update an existing resource based on some identification criteria (or create it if it is new).</td>
            
            </tr>
            
            <tr>
              
              <td>
                
                <a href="codesystem-restful-interaction.html#restful-interaction-patch">patch</a>
              
              </td>
              
              <td>patch</td>
              
              <td>Update an existing resource by posting a set of changes to it.</td>
            
            </tr>
            
            <tr>
              
              <td>
                
                <a href="codesystem-restful-interaction.html#restful-interaction-patch">patch-conditional</a>
              
              </td>
              
              <td>patch-conditional</td>
              
              <td>Update an existing resource, based on some identification criteria, by posting a set of changes to it.</td>
            
            </tr>
            
            <tr>
              
              <td>
                
                <a href="codesystem-restful-interaction.html#restful-interaction-delete">delete</a>
              
              </td>
              
              <td>delete</td>
              
              <td>Delete a resource.</td>
            
            </tr>
            
            <tr>
              
              <td>
                
                <a href="codesystem-restful-interaction.html#restful-interaction-delete-conditional-single">delete-conditional-single</a>
              
              </td>
              
              <td>delete-conditional-single</td>
              
              <td>Delete a single resource based on some identification criteria.</td>
            
            </tr>
            
            <tr>
              
              <td>
                
                <a href="codesystem-restful-interaction.html#restful-interaction-delete-conditional-multiple">delete-conditional-multiple</a>
              
              </td>
              
              <td>delete-conditional-multiple</td>
              
              <td>Delete one or more resources based on some identification criteria.</td>
            
            </tr>
            
            <tr>
              
              <td>
                
                <a href="codesystem-restful-interaction.html#restful-interaction-delete-history">delete-history</a>
              
              </td>
              
              <td>delete-history</td>
              
              <td>Delete all historical versions of a resource.</td>
            
            </tr>
            
            <tr>
              
              <td>
                
                <a href="codesystem-restful-interaction.html#restful-interaction-delete-history-version">delete-history-version</a>
              
              </td>
              
              <td>delete-history-version</td>
              
              <td>Delete a specific version of a resource.</td>
            
            </tr>
            
            <tr>
              
              <td>
                
                <a href="codesystem-restful-interaction.html#restful-interaction-history-instance">history-instance</a>
              
              </td>
              
              <td>history-instance</td>
              
              <td>Retrieve the change history for a particular resource.</td>
            
            </tr>
            
            <tr>
              
              <td>
                
                <a href="codesystem-restful-interaction.html#restful-interaction-history-type">history-type</a>
              
              </td>
              
              <td>history-type</td>
              
              <td>Retrieve the change history for all resources of a particular type.</td>
            
            </tr>
            
            <tr>
              
              <td>
                
                <a href="codesystem-restful-interaction.html#restful-interaction-create">create</a>
              
              </td>
              
              <td>create</td>
              
              <td>Create a new resource with a server assigned id.</td>
            
            </tr>
            
            <tr>
              
              <td>
                
                <a href="codesystem-restful-interaction.html#restful-interaction-create-conditional">create-conditional</a>
              
              </td>
              
              <td>create-conditional</td>
              
              <td>Create a new resource with a server assigned id if an equivalent resource does not already exist.</td>
            
            </tr>
            
            <tr>
              
              <td>
                
                <a href="codesystem-restful-interaction.html#restful-interaction-search-type">search-type</a>
              
              </td>
              
              <td>search-type</td>
              
              <td>Search all resources of the specified type based on some filter criteria.</td>
            
            </tr>
          
          </table>
        
        </li>
      
      </ul>
    
    </div>
  </text>
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir"/>
  </extension>
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="normative"/>
  </extension>
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="5"/>
  </extension>
  <url value="http://hl7.org/fhir/ValueSet/type-restful-interaction"/>
  <identifier>
    <system value="urn:ietf:rfc:3986"/>
    <value value="urn:oid:2.16.840.1.113883.4.642.3.180"/>
  </identifier>
  <identifier>
    <use value="old"/>
    <system value="urn:ietf:rfc:3986"/>
    <value value="urn:oid:2.16.840.1.113883.4.642.3.170"/>
  </identifier>
  <identifier>
    <use value="old"/>
    <system value="urn:ietf:rfc:3986"/>
    <value value="urn:oid:2.16.840.1.113883.4.642.2.83"/>
  </identifier>
  <version value="6.0.0"/>
  <name value="TypeRestfulInteraction"/>
  <title value="Type Restful Interaction"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2020-12-28T16:55:11+11:00"/>
  <publisher value="HL7 (FHIR Project)"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="fhir@lists.hl7.org"/>
    </telecom>
  </contact>
  <description value="Operations supported by REST at the type or instance level."/>
  <compose>
    <include>
      <system value="http://hl7.org/fhir/restful-interaction"/>
      <concept>
        <code value="read"/>
      </concept>
      <concept>
        <code value="vread"/>
      </concept>
      <concept>
        <code value="update"/>
      </concept>
      <concept>
        <code value="update-conditional"/>
      </concept>
      <concept>
        <code value="patch"/>
      </concept>
      <concept>
        <code value="patch-conditional"/>
      </concept>
      <concept>
        <code value="delete"/>
      </concept>
      <concept>
        <code value="delete-conditional-single"/>
      </concept>
      <concept>
        <code value="delete-conditional-multiple"/>
      </concept>
      <concept>
        <code value="delete-history"/>
      </concept>
      <concept>
        <code value="delete-history-version"/>
      </concept>
      <concept>
        <code value="history-instance"/>
      </concept>
      <concept>
        <code value="history-type"/>
      </concept>
      <concept>
        <code value="create"/>
      </concept>
      <concept>
        <code value="create-conditional"/>
      </concept>
      <concept>
        <code value="search-type"/>
      </concept>
    </include>
  </compose>
</ValueSet>
```