Definition for Code System FHIR Restful Interactions SystemFHIRRestfulInteractions

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


  
  
    
  
  
    
    
      
      
        

      
      
      
        
          
            
          
          
            
          
          
            
          
          
            
          
        
        
          
          read
            
          
          
          
        
        
          
          vread
            
          
          
          
        
        
          
          update
            
          
          
          
        
        
          
          patch
            
          
          
          
        
        
          
          delete
            
          
          
          
        
        
          
          history
            
          
          
          Retrieve the change history for a particular resource, type of resource, or the entire
             system.
        
        
          
            history-instance
            
          
          
          
        
        
          
            history-type
            
          
          
          
        
        
          
            history-system
            
          
          
          
        
        
          
          create
            
          
          
          
        
        
          
          search
            
          
          
          
        
        
          
            search-type
            
          
          
          
        
        
          
            search-system
            
          
          
          
        
        
          
          capabilities
            
          
          
          
        
        
          
          transaction
            
          
          
          
        
        
          
          batch
            
          
          
          
        
        
          
          operation
            
          
          
          
        
      
    
  
  
    
  
  
    
  
  
    
  
  
    
  
  
  
  
  
  
  
  
  
  
  
  
  
    
    
    
  
  
    
    
    
  
  
    
    
    
  
  
    
    
    
  
  
    
    
    
  
  
    
    
    Retrieve the change history for a particular resource, type of resource, or the entire
     system.
    
      
      
      
    
    
      
      
      
    
    
      
      
      
    
  
  
    
    
    
  
  
    
    
    
    
      
      
      
    
    
      
      
      
    
  
  
    
    
    
  
  
    
    
    
  
  
    
    
    
  
  
    
    
    
  

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="restful-interaction"/> 
  <meta> 
    <lastUpdated value="2025-11-14T05:50:06.469+00:00"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p class="res-header-id">
        <b> Generated Narrative: CodeSystem restful-interaction</b> 
      </p> 
      <a name="restful-interaction"> </a> 
      <a name="hcrestful-interaction"> </a> 
      <p> 
        <b> Properties</b> 
      </p> 
      <p> 
        <b> This code system defines the following properties for its concepts</b> 
      </p> 
      <table class="grid">
        <tr> 
          <td> 
            <b> Name</b> 
          </td> 
          <td> 
            <b> Code</b> 
          </td> 
          <td> 
            <b> URI</b> 
          </td> 
          <td> 
            <b> Type</b> 
          </td> 
        </tr> 
        <tr> 
          <td> Not Selectable</td> 
          <td> abstract</td> 
          <td> http://hl7.org/fhir/concept-properties#notSelectable</td> 
          <td> boolean</td> 
        </tr> 
      </table> 
      <p> 
        <b> Concepts</b> 
      </p> 
      <p> This case-sensitive code system 
        <code> http://hl7.org/fhir/restful-interaction</code>  defines the following codes in a Is-A hierarchy:
      </p> 
      <table class="codes">
        <tr> 
          <td> 
            <b> Lvl</b> 
          </td> 
          <td style="white-space:nowrap">
            <b> Code</b> 
          </td> 
          <td> 
            <b> Definition</b> 
          </td> 
          <td> 
            <b> Not Selectable</b> 
          </td> 
        </tr> 
        <tr> 
          <td> 1</td> 
          <td style="white-space:nowrap">read
            <a name="restful-interaction-read"> </a> 
          </td> 
          <td> Read the current state of the resource.</td> 
          <td/>  
        </tr> 
        <tr> 
          <td> 1</td> 
          <td style="white-space:nowrap">vread
            <a name="restful-interaction-vread"> </a> 
          </td> 
          <td> Read the state of a specific version of the resource.</td> 
          <td/>  
        </tr> 
        <tr> 
          <td> 1</td> 
          <td style="white-space:nowrap">update
            <a name="restful-interaction-update"> </a> 
          </td> 
          <td> Update an existing resource by its id (or create it if it is new).</td> 
          <td/>  
        </tr> 
        <tr> 
          <td> 1</td> 
          <td style="white-space:nowrap">update-conditional
            <a name="restful-interaction-update-conditional"> </a> 
          </td> 
          <td> Update an existing resource based on some identification criteria (or create it
             if it is new).</td> 
          <td/>          </tr>         <tr>           <td> 1</td>           <td style="white-space:nowrap">patch            <a name="restful-interaction-patch"> </a>           </td>           <td> Update an existing resource by posting a set of changes to it.</td>           <td/>          </tr>         <tr>           <td> 1</td>           <td style="white-space:nowrap">patch-conditional            <a name="restful-interaction-patch-conditional"> </a>           </td>           <td> Update an existing resource, based on some identification criteria, by posting

             a set of changes to it.</td> 
          <td/>          </tr>         <tr>           <td> 1</td>           <td style="white-space:nowrap">delete            <a name="restful-interaction-delete"> </a>           </td>           <td> Delete a resource.</td>           <td/>          </tr>         <tr>           <td> 1</td>           <td style="white-space:nowrap">delete-conditional-single            <a name="restful-interaction-delete-conditional-single"> </a>           </td>           <td> Delete a single resource based on some identification criteria.</td>           <td/>          </tr>         <tr>           <td> 1</td>           <td style="white-space:nowrap">delete-conditional-multiple            <a name="restful-interaction-delete-conditional-multiple"> </a>           </td>           <td> Delete one or more resources based on some identification criteria.</td>           <td/>          </tr>         <tr>           <td> 1</td>           <td style="white-space:nowrap">delete-history            <a name="restful-interaction-delete-history"> </a>           </td>           <td> Delete all historical versions of a resource.</td>           <td/>          </tr>         <tr>           <td> 1</td>           <td style="white-space:nowrap">delete-history-version            <a name="restful-interaction-delete-history-version"> </a>           </td>           <td> Delete a specific version of a resource.</td>           <td/>          </tr>         <tr>           <td> 1</td>           <td style="white-space:nowrap">history            <a name="restful-interaction-history"> </a>           </td>           <td> Retrieve the change history for a particular resource, type of resource, or the

             entire system.</td> 
          <td> true</td>         </tr>         <tr>           <td> 2</td>           <td style="white-space:nowrap">  history-instance            <a name="restful-interaction-history-instance"> </a>           </td>           <td> Retrieve the change history for a particular resource.</td>           <td/>          </tr>         <tr>           <td> 2</td>           <td style="white-space:nowrap">  history-type            <a name="restful-interaction-history-type"> </a>           </td>           <td> Retrieve the change history for all resources of a particular type.</td>           <td/>          </tr>         <tr>           <td> 2</td>           <td style="white-space:nowrap">  history-system            <a name="restful-interaction-history-system"> </a>           </td>           <td> Retrieve the change history for all resources on a system.</td>           <td/>          </tr>         <tr>           <td> 1</td>           <td style="white-space:nowrap">create            <a name="restful-interaction-create"> </a>           </td>           <td> Create a new resource with a server assigned id.</td>           <td/>          </tr>         <tr>           <td> 1</td>           <td style="white-space:nowrap">create-conditional            <a name="restful-interaction-create-conditional"> </a>           </td>           <td> Create a new resource with a server assigned id if an equivalent resource does

             not already exist.</td> 
          <td/>          </tr>         <tr>           <td> 1</td>           <td style="white-space:nowrap">search            <a name="restful-interaction-search"> </a>           </td>           <td> Search a resource type or all resources based on some filter criteria.</td>           <td> true</td>         </tr>         <tr>           <td> 2</td>           <td style="white-space:nowrap">  search-type            <a name="restful-interaction-search-type"> </a>           </td>           <td> Search all resources of the specified type based on some filter criteria.</td>           <td/>          </tr>         <tr>           <td> 2</td>           <td style="white-space:nowrap">  search-system            <a name="restful-interaction-search-system"> </a>           </td>           <td> Search all resources based on some filter criteria.</td>           <td/>          </tr>         <tr>           <td> 2</td>           <td style="white-space:nowrap">  search-compartment            <a name="restful-interaction-search-compartment"> </a>           </td>           <td> Search resources in a compartment based on some filter criteria.</td>           <td/>          </tr>         <tr>           <td> 1</td>           <td style="white-space:nowrap">capabilities            <a name="restful-interaction-capabilities"> </a>           </td>           <td> Get a Capability Statement for the system.</td>           <td/>          </tr>         <tr>           <td> 1</td>           <td style="white-space:nowrap">transaction            <a name="restful-interaction-transaction"> </a>           </td>           <td> Update, create or delete a set of resources as a single transaction.</td>           <td/>          </tr>         <tr>           <td> 1</td>           <td style="white-space:nowrap">batch            <a name="restful-interaction-batch"> </a>           </td>           <td> perform a set of a separate interactions in a single http operation</td>           <td/>          </tr>         <tr>           <td> 1</td>           <td style="white-space:nowrap">operation            <a name="restful-interaction-operation"> </a>           </td>           <td> Perform an operation as defined by an OperationDefinition.</td>           <td/>          </tr>       </table>     </div>   </text>   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">    <valueCode value="normative"/>   </extension>   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">    <valueCode value="fhir"/>   </extension>   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">    <valueInteger value="5"/>   </extension>   <url value="http://hl7.org/fhir/restful-interaction"/>   <identifier>     <system value="urn:ietf:rfc:3986"/>     <value value="urn:oid:2.16.840.1.113883.4.642.4.1823"/>   </identifier>   <version value="6.0.0-ballot3"/>   <name value="FHIRRestfulInteractions"/>   <title value="FHIR Restful Interactions"/>   <status value="active"/>   <experimental value="false"/>   <publisher value="HL7 International / FHIR Infrastructure"/>   <contact>     <telecom>       <system value="url"/>       <value value="http://www.hl7.org/Special/committees/fiwg"/>     </telecom>   </contact>   <description value="The set of interactions defined by the RESTful part of the FHIR specification."/>   <jurisdiction>     <coding>       <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>       <code value="001"/>       <display value="World"/>     </coding>   </jurisdiction>   <caseSensitive value="true"/>   <valueSet value="http://hl7.org/fhir/ValueSet/restful-interaction"/>   <hierarchyMeaning value="is-a"/>   <content value="complete"/>   <property>     <code value="abstract"/>     <uri value="http://hl7.org/fhir/concept-properties#notSelectable"/>     <type value="boolean"/>   </property>   <concept>     <code value="read"/>     <display value="read"/>     <definition value="Read the current state of the resource."/>   </concept>   <concept>     <code value="vread"/>     <display value="vread"/>     <definition value="Read the state of a specific version of the resource."/>   </concept>   <concept>     <code value="update"/>     <display value="update"/>     <definition value="Update an existing resource by its id (or create it if it is new)."/>   </concept>   <concept>     <code value="update-conditional"/>     <display value="update-conditional"/>     <definition value="Update an existing resource based on some identification criteria (or create it

     if it is new)."/> 
  </concept>   <concept>     <code value="patch"/>     <display value="patch"/>     <definition value="Update an existing resource by posting a set of changes to it."/>   </concept>   <concept>     <code value="patch-conditional"/>     <display value="patch-conditional"/>     <definition value="Update an existing resource, based on some identification criteria, by posting

     a set of changes to it."/> 
  </concept>   <concept>     <code value="delete"/>     <display value="delete"/>     <definition value="Delete a resource."/>   </concept>   <concept>     <code value="delete-conditional-single"/>     <display value="delete-conditional-single"/>     <definition value="Delete a single resource based on some identification criteria."/>   </concept>   <concept>     <code value="delete-conditional-multiple"/>     <display value="delete-conditional-multiple"/>     <definition value="Delete one or more resources based on some identification criteria."/>   </concept>   <concept>     <code value="delete-history"/>     <display value="delete-history"/>     <definition value="Delete all historical versions of a resource."/>   </concept>   <concept>     <code value="delete-history-version"/>     <display value="delete-history-version"/>     <definition value="Delete a specific version of a resource."/>   </concept>   <concept>     <code value="history"/>     <display value="history"/>     <definition value="Retrieve the change history for a particular resource, type of resource, or the

     entire system."/> 
    <property>       <code value="abstract"/>       <valueBoolean value="true"/>     </property>     <concept>       <code value="history-instance"/>       <display value="history-instance"/>       <definition value="Retrieve the change history for a particular resource."/>     </concept>     <concept>       <code value="history-type"/>       <display value="history-type"/>       <definition value="Retrieve the change history for all resources of a particular type."/>     </concept>     <concept>       <code value="history-system"/>       <display value="history-system"/>       <definition value="Retrieve the change history for all resources on a system."/>     </concept>   </concept>   <concept>     <code value="create"/>     <display value="create"/>     <definition value="Create a new resource with a server assigned id."/>   </concept>   <concept>     <code value="create-conditional"/>     <display value="create-conditional"/>     <definition value="Create a new resource with a server assigned id if an equivalent resource does

     not already exist."/> 
  </concept>   <concept>     <code value="search"/>     <display value="search"/>     <definition value="Search a resource type or all resources based on some filter criteria."/>     <property>       <code value="abstract"/>       <valueBoolean value="true"/>     </property>     <concept>       <code value="search-type"/>       <display value="search-type"/>       <definition value="Search all resources of the specified type based on some filter criteria."/>     </concept>     <concept>       <code value="search-system"/>       <display value="search-system"/>       <definition value="Search all resources based on some filter criteria."/>     </concept>     <concept>       <code value="search-compartment"/>       <display value="search-compartment"/>       <definition value="Search resources in a compartment based on some filter criteria."/>     </concept>   </concept>   <concept>     <code value="capabilities"/>     <display value="capabilities"/>     <definition value="Get a Capability Statement for the system."/>   </concept>   <concept>     <code value="transaction"/>     <display value="transaction"/>     <definition value="Update, create or delete a set of resources as a single transaction."/>   </concept>   <concept>     <code value="batch"/>     <display value="batch"/>     <definition value="perform a set of a separate interactions in a single http operation"/>   </concept>   <concept>     <code value="operation"/>     <display value="operation"/>     <definition value="Perform an operation as defined by an OperationDefinition."/>   </concept> 


</

CodeSystem

>