Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. 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 (XML)

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

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

Definition for Value SetType Restful Interaction

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

<ValueSet xmlns="http://hl7.org/fhir">
  <id value="type-restful-interaction"/> 
  <meta> 
    <lastUpdated value="2023-03-26T15:21:02.749+11:00"/> 
    <profile value="http://hl7.org/fhir/StructureDefinition/shareablevalueset"/> 
  </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-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-delete">delete</a> 
              
              
              
              </td> 
              
              
              
              <td> delete</td> 
              
              
              
              <td> Delete 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-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-normative-version">
    <valueCode value="4.0.0"/> 
  </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="5.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."/> 
  <jurisdiction> 
    <coding> 
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> 
      <code value="001"/> 
      <display value="World"/> 
    </coding> 
  </jurisdiction> 
  <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="patch"/> 
      </concept> 
      <concept> 
        <code value="delete"/> 
      </concept> 
      <concept> 
        <code value="history-instance"/> 
      </concept> 
      <concept> 
        <code value="history-type"/> 
      </concept> 
      <concept> 
        <code value="create"/> 
      </concept> 
      <concept> 
        <code value="search-type"/> 
      </concept> 
    </include> 
  </compose> 
</ValueSet> 

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.