R6 Ballot (2nd Draft)

Publish-box (todo)

2.1.27.5.8.7 Operation $graph on Resource

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

Return an entire graph of resources based on a GraphDefinition. The operation is invoked on a specific instance of a resource, and the graph definition tells the server what other resources to return in the same packaage.

The canonical URL for this operation definition is

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

Formal Definition (as a OperationDefinition).

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

This is an idempotent operation

In Parameters:
Name Scope Cardinality Type Binding Profile Documentation
graph 1..1 uri

Servers MAY choose to allow any graph definition to be specified, but MAY require that the client choose a graph definition from a specific list of known supported definitions. The server is not required to support a formal definition of the graph on the end point

Out Parameters:
Name Scope Cardinality Type Binding Profile Documentation
result 1..1 Bundle

The set of resources that were in the graph based on the provided definition

 

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