Release 4B 5

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0: R5 - STU ). The This is the current published version which supercedes in it's permanent home (it will always be available at this version is 5.0.0 . URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R5 R4B R4

Operation-resource-graph.xml

Example OperationDefinition/Resource-graph (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"?>


  
  
    
    
      
      
      
      
      
        Return an entire graph of resources based on a 
          . The operation is invoked on a specific instance of a resource, and the graph definition
           tells the server what other resources to return in the same packaage
        

      
      
      
      
        
          
            
          
          
            
          
          
            
          
          
            
          
          
            
          
          
            
          
        
        
          
          
          
          
            
          
          
          
            
              Servers MAY choose to allow any graph definition to be specified, but MAY require that
                 the client choose a graph definition from a specific list of known supported definitions.
                 The server is not required to support a formal definition of the graph on the end point

            
          
        
        
          
          
          
          
            
          
          
          
            
              

            
          
        
      
      
    
  
  
    
  
  
    
  
  
  
  
  
  
  
  
  
  
  
    
      
      
    
    
      
      
    
  

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Resource-graph"/> 
  <text> 
    <status value="extensions"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> URL: [base]/Resource/[id]/$graph</p> 
      <p> Parameters</p> 
      <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> graph</td> 
          <td/>  
          <td> 1..1</td> 
          <td> 
            <a href="datatypes.html#uri">uri</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> Servers MAY choose to allow any graph definition to be specified, but MAY require
                 that the client choose a graph definition from a specific list of known supported
                 definitions. The server is not required to support a formal definition of the graph
                 on the end point</p> 
            </div>           </td>         </tr>         <tr>           <td> OUT</td>           <td> result</td>           <td/>            <td> 1..1</td>           <td>             <a href="bundle.html">Bundle</a>           </td>           <td/>            <td>             <div>               <p> The set of resources that were in the graph based on the provided definition</p>             </div>           </td>         </tr>       </table>     </div>   </text>   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">    <valueInteger value="1"/>   </extension>   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">    <valueCode value="trial-use"/>   </extension>   <url value="http://hl7.org/fhir/OperationDefinition/Resource-graph"/>   <version value="5.0.0"/>   <name value="Graph"/>   <title value="Return a graph of resources"/>   <status value="draft"/>   <kind value="operation"/>   <experimental value="false"/>   <date value="2023-03-26T15:21:02+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="Return an entire graph of resources based on a [GraphDefinition](graphdefinition.html).
   The operation is invoked on a specific instance of a resource, and the graph definition
   tells the server what other resources to return in the same packaage
  
  
  
  
  
  
  
    
    
    
    
    Servers MAY choose to allow any graph definition to be specified, but MAY require that
     the client choose a graph definition from a specific list of known supported definitions.
     The server is not required to support a formal definition of the graph on the end point
    
  
  
    
    
    
    
    
    
  

   tells the server what other resources to return in the same packaage"/> 
  <jurisdiction>     <coding>       <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>       <code value="001"/>       <display value="World"/>     </coding>   </jurisdiction>   <affectsState value="false"/>   <code value="graph"/>   <resource value="Resource"/>   <system value="false"/>   <type value="false"/>   <instance value="true"/>   <parameter>     <name value="graph"/>     <use value="in"/>     <min value="1"/>     <max value="1"/>     <documentation value="Servers MAY choose to allow any graph definition to be specified, but MAY require

     that the client choose a graph definition from a specific list of known supported
     definitions. The server is not required to support a formal definition of the graph
     on the end point"/> 
    <type value="uri"/>   </parameter>   <parameter>     <name value="result"/>     <use value="out"/>     <min value="1"/>     <max value="1"/>     <documentation value="The set of resources that were in the graph based on the provided definition"/>     <type value="Bundle"/>   </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.