Release 5 R6 Ballot (3rd Draft)
This page is part of the FHIR Specification (v5.0.0: R5 - STU ). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Publish-box (todo)

Example OperationDefinition/Resource-add (XML)

FHIR Infrastructure Work Group Maturity Level : N/A Standards Status : Informative

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

Operation Definition

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


  
  
    
    
      
      
      
        
          
            
          
          
            
          
          
            
          
          
            
          
          
            
          
          
            
          
          
            
          
        
        
          
          
          
          
          
            
          
          
          
            
              Resource containing content to add. See 
                .
              

            
          
        
        
          
          
          
          
          
            
          
          
          
            
              Resource containing content added. See 
                .
              

            
          
        
      
    
  
  
    
  
  
    
  
  
  
  
  
  
  
  
  
  
  
    
      
      
    
    
      
      
    
  

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Resource-add"/> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p class="res-header-id">
        <b> Generated Narrative: OperationDefinition Resource-add</b> 
      </p> 
      <a name="Resource-add"> </a> 
      <a name="hcResource-add"> </a> 
      <a name="Resource-add-en-AU"> </a> 
      <p> URL: [base]/Resource/[id]/$add</p> 
      <h3> Parameters</h3> 
      <table class="grid">
        <tr> 
          <td> 
            <b> Use</b> 
          </td> 
          <td> 
            <b> Name</b> 
          </td> 
          <td> 
            <b> Scope</b> 
          </td> 
          <td> 
            <b> Cardinality</b> 
          </td> 
          <td> 
            <b> Type</b> 
          </td> 
          <td> 
            <b> Binding</b> 
          </td> 
          <td> 
            <b> Documentation</b> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> additions</td> 
          <td/>  
          <td> 1..1</td> 
          <td> 
            <a href="resource.html">Resource</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> Resource containing content to add. See 
                <a href="operations-for-large-resources.html">Operations for Large Resources</a> .
              </p> 
            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> OUT</td> 
          <td> return</td> 
          <td/>  
          <td> 0..1</td> 
          <td> 
            <a href="resource.html">Resource</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> Resource containing content added. See 
                <a href="operations-for-large-resources.html">Operations for Large Resources</a> .
              </p> 
            </div> 
          </td> 
        </tr> 
      </table> 
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="0"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir"/> 
  </extension> 
  <url value="http://hl7.org/fhir/OperationDefinition/Resource-add"/> 
  <version value="6.0.0-ballot3"/> 
  <name value="Add"/> 
  <title value="Add to an array in a large resource"/> 
  <status value="draft"/> 
  <kind value="operation"/> 
  <experimental value="false"/> 
  <date value="2025-04-01T12:16:37+11:00"/> 
  <publisher value="HL7 International / FHIR Infrastructure"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
    <telecom> 
      <system value="email"/> 
      <value value="fhir@lists.hl7.org"/> 
    </telecom> 
  </contact> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://www.hl7.org/Special/committees/fiwg"/> 
    </telecom> 
  </contact> 
  <description value="Add content to an array in a large resource such as List or Group. See [Operations
   for Large Resources](operations-for-large-resources.html).
  
    
      
      
      
    
  
  
  
  
  
  
  
  
    
    
    
    

   for Large Resources](operations-for-large-resources.html)."/> 
  <jurisdiction>     <coding>       <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>       <code value="001"/>       <display value="World"/>     </coding>   </jurisdiction>   <affectsState value="true"/>   <code value="add"/>   <resource value="Resource"/>   <system value="false"/>   <type value="false"/>   <instance value="true"/>   <parameter>     <name value="additions"/>     <use value="in"/>     <min value="1"/>     <max value="1"/> 
    <documentation value="Resource containing content to add. See [Operations for Large Resources](operations-for-large
    -resources.html).
    
  
  
    
    
    
    

    -resources.html)."/> 
    <type value="Resource"/>   </parameter>   <parameter>     <name value="return"/>     <use value="out"/>     <min value="0"/>     <max value="1"/> 
    <documentation value="Resource containing content added. See [Operations for Large Resources](operations-for-large-
    resources.html).
    
  

    resources.html)."/> 
    <type value="Resource"/>   </parameter> 


</

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.