This
page
is
part
of
the
Continuous
Integration
Build
of
FHIR
Specification
(v5.0.0:
R5
-
STU
).
This
is
the
current
published
version
in
it's
permanent
home
(it
will
always
(will
be
available
incorrect/inconsistent
at
this
URL).
For
a
full
list
of
available
versions,
see
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
Example
OperationDefinition/Resource-graphql
(XML)
Raw
XML
(
canonical
form
+
also
see
XML
Format
Specification
)
Operation
Definition
<?xml version="1.0" encoding="UTF-8"?>
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="Resource-graphql"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml">
<p class="res-header-id">
<b> Generated Narrative: OperationDefinition Resource-graphql</b>
</p>
<a name="Resource-graphql"> </a>
<a name="hcResource-graphql"> </a>
<p> URL: [base]/$graphql</p>
<p> URL: [base]/Resource/[id]/$graphql</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> 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="normative"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
<valueCode value="fhir"/>
</extension>
<url value="http://hl7.org/fhir/OperationDefinition/Resource-graphql"/>
<version value="6.0.0-ballot3"/>
<name value="Graphql"/>
<title value="Execute a graphql statement"/>
<status value="active"/>
<kind value="operation"/>
<experimental value="false"/>
<date value="2025-11-27T16:48:47+00: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="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.