Release 4 5

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

Operation-resource-graphql.xml

Example OperationDefinition/Resource-graphql (XML)

FHIR Infrastructure Work Group Maturity Level : N/A Standards Status : Informative Compartments : Not linked to any defined compartments

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

Jump past Narrative

Operation Definition

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


  
  
    
    
      
      
      
      
      
        Execute a graphql statement on a since resource or against the entire system. See the
           
           page for further details.
        

        For the purposes of graphQL compatibility, this operation can also be invoked using a
           POST with the graphQL as the body, or a JSON body (see 
           for details)
        

      
      
      
      
      
        
          
            
          
          
            
          
          
            
          
          
            
          
          
            
          
          
            
          
        
        
          
          
          
          
            
          
          
          
        
        
          
          
          
          
            
          
          
          
            
              The content is always returned as application/json; this SHOULD be specified in the Accept
                 header

            
          
        
      
      
    
  
  
    
  
  
    
  
  
  
  
  
  
  
  
  
    
      
      
    
    
      
      
    
  
  Execute a graphql statement on a since resource or against the entire system. See the
   [Using GraphQL with FHIR](graphql.html) page for further details.

For the purposes of graphQL compatibility, this operation can also be invoked using a
   POST with the graphQL as the body, or a JSON body (see [graphQL spec](http://graphql.org/)
   for details)
  
  
  
  
  
  
    
    
    
    
    
  
  
    
    
    
    
    The content is always returned as application/json; this SHOULD be specified in the Accept
     header
    
  

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Resource-graphql"/> 
  <text> 
    <status value="extensions"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> URL: [base]/$graphql</p> 
      <p> URL: [base]/Resource/[id]/$graphql</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> query</td> 
          <td/>  
          <td> 1..1</td> 
          <td> 
            <a href="datatypes.html#string">string</a> 
          </td> 
          <td/>  
          <td/>  
        </tr> 
        <tr> 
          <td> OUT</td> 
          <td> result</td> 
          <td/>  
          <td> 1..1</td> 
          <td> 
            <a href="binary.html">Binary</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> The content is always returned as application/json; this SHOULD be specified in
                 the Accept header</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-graphql"/>   <version value="5.0.0"/>   <name value="Graphql"/>   <title value="Execute a graphql statement"/>   <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="Execute a graphql statement on a since resource or against the entire system. See

   the [Using GraphQL with FHIR](graphql.html) page for further details.
For the purposes of graphQL compatibility, this operation can also be invoked using
   a POST with the graphQL as the body, or a JSON body (see [graphQL spec](http://graphql.org/)
   for details)"/> 
  <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="graphql"/>   <resource value="Resource"/>   <system value="true"/>   <type value="false"/>   <instance value="true"/>   <parameter>     <name value="query"/>     <use value="in"/>     <min value="1"/>     <max value="1"/>     <type value="string"/>   </parameter>   <parameter>     <name value="result"/>     <use value="out"/>     <min value="1"/>     <max value="1"/>     <documentation value="The content is always returned as application/json; this SHOULD be specified in

     the Accept header"/> 
    <type value="Binary"/>   </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.