Release 5 Draft Ballot

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

2.27.6.7 Operation $graph on Resource

FHIR Infrastructure 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 official 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:
NameCardinalityTypeBindingProfileDocumentation
graph1..1uri

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:
NameCardinalityTypeBindingProfileDocumentation
result1..1Bundle

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.