Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot). 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

FHIR Infrastructure Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: Not linked to any defined compartments

This is the narrative for the resource. See also the XML, JSON or Turtle format.

graphql

OPERATION: graphql

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

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.