R6 Ballot (1st Draft)

This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions

2.1.27.5.8.6 Operation $graphql on Resource

FHIR Infrastructure icon Work Group Maturity Level: 1Trial Use Compartments: N/A

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 icon for details).

The canonical URL for this operation definition is

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

Formal Definition (as a OperationDefinition).

URL: [base]/$graphql

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

This is an idempotent operation

In Parameters:
NameScopeCardinalityTypeBindingProfileDocumentation
query1..1string
Out Parameters:
NameScopeCardinalityTypeBindingProfileDocumentation
result1..1Binary

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

 

For more information about operations, including how they are invoked, see Operations.