This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
(v5.0.0-snapshot1:
Release
5
Snapshot
#1).
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
| FHIR Infrastructure Work Group | Maturity Level : N/A | Standards Status : Informative | Compartments : Not linked to any defined compartments |
Raw JSON ( canonical form + also see JSON Format Specification )
Operation Definition
{
"resourceType" : "OperationDefinition",
"id" : "Resource-graphql",
"text" : {
"status" : "generated",
"status" : "extensions",
"div" : "<div>!-- Snipped for Brevity --></div>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/Resource-graphql",
"version" : "4.0.1",
"name" : "Execute a graphql statement",
"version" : "5.0.0-snapshot1",
"name" : "graphql",
"title" : "Execute a graphql statement",
"status" : "draft",
"kind" : "operation",
"date" : "2019-11-01T09:29:23+11:00",
"date" : "2021-12-19T08:15:41+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "fhir@lists.hl7.org"
}]
}],
"description" : "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.\n\nFor 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)",
"affectsState" : false,
"code" : "graphql",
"resource" : ["Resource"],
"system" : true,
"type" : false,
"instance" : true,
"parameter" : [{
"name" : "query",
"use" : "in",
"min" : 1,
"max" : "1",
"type" : "string"
},
{
"name" : "result",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The content is always returned as application/json; this SHOULD be specified in the Accept header",
"type" : "Binary"
}]
}
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.