FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagehl7.fhir.uv.api-incubator
Resource TypeOperationDefinition
IdOperationDefinition-Resource-graph.json
FHIR VersionR6
Sourcehttps://build.fhir.org/ig/HL7/api-incubator-ig/OperationDefinition-Resource-graph.html
URLhttp://hl7.org/fhir/OperationDefinition/Resource-graph
Version0.1.0
Statusactive
Date2021-01-05T10:01:24+11:00
NameGraph
TitleReturn a graph of resources
Realmuv
Authorityhl7
DescriptionReturn an entire graph of resources based on a [GraphDefinition](http://build.fhir.org/HL7/api-incubator/StructureDefinition-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
Typefalse
Kindoperation

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: OperationDefinition Resource-graph

Last updated: 2021-01-05 10:01:24+1100

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

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INgraph1..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

OUTresult1..1Bundle

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


Source1

{
  "resourceType": "OperationDefinition",
  "id": "Resource-graph",
  "meta": {
    "lastUpdated": "2021-01-05T10:01:24.148+11:00"
  },
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "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/StructureDefinition/structuredefinition-wg",
      "valueCode": "fhir"
    }
  ],
  "url": "http://hl7.org/fhir/OperationDefinition/Resource-graph",
  "version": "0.1.0",
  "name": "Graph",
  "title": "Return a graph of resources",
  "status": "active",
  "kind": "operation",
  "date": "2021-01-05T10:01:24+11:00",
  "publisher": "HL7 International / FHIR Infrastructure",
  "contact": [
    {
      "name": "HL7 International / FHIR Infrastructure",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fiwg"
        }
      ]
    }
  ],
  "description": "Return an entire graph of resources based on a [GraphDefinition](http://build.fhir.org/HL7/api-incubator/StructureDefinition-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",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "affectsState": false,
  "code": "graph",
  "resource": [
    "Resource"
  ],
  "system": false,
  "type": false,
  "instance": true,
  "parameter": [
    {
      "name": "graph",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "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",
      "type": "uri"
    },
    {
      "name": "result",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "The set of resources that were in the graph based on the provided definition",
      "type": "Bundle"
    }
  ]
}