Operation-resource-graph.xml

Operation Definition

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

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Resource-graph"/> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2> Return a graph of resources</h2> 
      <p> OPERATION: Return a graph of resources</p> 
      <p> The official URL for this operation definition is: </p> 
      <pre> http://hl7.org/fhir/OperationDefinition/Resource-graph</pre> 
      <div> 
        <p> Return an entire graph of resources based on a 
          <a href="graphdefinition.html">GraphDefinition</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
        </p> 

      </div> 
      <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> 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> 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> 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/>  
    </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="4.0.1"/> 
  <name value="Return a graph of resources"/> 
  <status value="draft"/> 
  <kind value="operation"/> 
  <date value="2021-01-21T15:34:20+00: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"/> 
  <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>