FHIR © HL7.org  |  Server Home  |  Health Intersections FHIR Server v1.0.287  |  FHIR Version 4.0.0  | User: ANONYMOUS (Unknown)  

Resource "Resource-graphql" Version "1" (OperationDefinition)

Tags:

XML or JSON representation . provenance for this resource

Execute a graphql statement

OPERATION: Execute a graphql statement

The official URL for this operation definition is:

http://hl7.org/fhir/OperationDefinition/Resource-graphql

Execute a graphql statement on a since resource or against the entire system. See the Using GraphQL with FHIR 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 for details)

URL: [base]/$graphql

URL: [base]/Resource/[id]/$graphql

Parameters

Use Name Cardinality Type Binding Documentation
IN query 1..1 string
OUT result 1..1 Binary

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


{
  "resourceType" : "OperationDefinition",
  "id" : "Resource-graphql",
  "meta" : {
    "versionId" : "1",
    "lastUpdated" : "2018-12-14T02:02:44.442Z"
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <h2>Execute a graphql statement</h2>\n <p>OPERATION: Execute a graphql statement</p>\n <p>The official URL for this operation definition is: </p>\n <pre>http://hl7.org/fhir/OperationDefinition/Resource-graphql</pre>\n <div>\n <p>Execute a graphql statement on a since resource or against the entire system. See the \n <a href=\"graphql.html\">Using GraphQL with FHIR</a> page for further details.\n </p>\n\n <p>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 \n <a href=\"http://graphql.org/\">graphQL spec</a> for details)\n </p>\n\n </div>\n <p>URL: [base]/$graphql</p>\n <p>URL: [base]/Resource/[id]/$graphql</p>\n <p>Parameters</p>\n <table class=\"grid\">\n <tr>\n <td>\n <b>Use</b>\n </td>\n <td>\n <b>Name</b>\n </td>\n <td>\n <b>Cardinality</b>\n </td>\n <td>\n <b>Type</b>\n </td>\n <td>\n <b>Binding</b>\n </td>\n <td>\n <b>Documentation</b>\n </td>\n </tr>\n <tr>\n <td>IN</td>\n <td>query</td>\n <td>1..1</td>\n <td>\n <a href=\"datatypes.html#string\">string</a>\n </td>\n <td/>\n <td/>\n </tr>\n <tr>\n <td>OUT</td>\n <td>result</td>\n <td>1..1</td>\n <td>\n <a href=\"binary.html\">Binary</a>\n </td>\n <td/>\n <td>\n <div>\n <p>The content is always returned as application/json; this SHOULD be specified in the Accept header</p>\n\n </div>\n </td>\n </tr>\n </table>\n <div/>\n </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.0",
  "name" : "Execute a graphql statement",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2018-12-14T01:14:32+00: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)",
  "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"
    }
  ]
}