SMART Base
0.3.0 - ci-build

SMART Base, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/litlfred/smart-base/ and changes regularly. See the Directory of published versions

Logical Model: Knowledge graph L1: graph document

Official URL: http://smart.who.int/base/StructureDefinition/KGGraphDocument Version: 0.3.0
Active as of 2026-10-06 Computable Name: KGGraphDocument

One L1 knowledge-graph document: typed nodes and reified edges, provenance-pinned to the sources it was extracted from. In JSON the context element is written @context.

Usages:

  • This Logical Model is not used by any profiles in this Specification

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. KGGraphDocument 0..* Base Knowledge graph L1: graph document
... context 1..1 uri Context
... id 1..1 string ID
... type 1..1 code Type
... generatedAt 1..1 dateTime Generated at
... wasDerivedFrom 0..* KGProvenanceSource Derived from
... nodes 0..* KGNode Nodes
... edges 0..* KGEdge Edges
... dak 0..1 BackboneElement DAK

doco Documentation for this format

API Information

Knowledge graph L1: graph document API

One L1 knowledge-graph document: typed nodes and reified edges, provenance-pinned to the sources it was extracted from. In JSON the context element is written @context.

Version: 1.0.0

Endpoints

GET /StructureDefinition-KGGraphDocument.schema.json

JSON Schema definition for the Logical Model StructureDefinition-KGGraphDocument

This endpoint serves the JSON Schema definition for the Logical Model StructureDefinition-KGGraphDocument.

Schema Definition

StructureDefinition-KGGraphDocument

Description: One L1 knowledge-graph document: typed nodes and reified edges, provenance-pinned to the sources it was extracted from. In JSON the context element is written @context.

Type: object

Full Schema (JSON)

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "http://smart.who.int/base/StructureDefinition-KGGraphDocument.schema.json",
  "title": "Knowledge graph L1: graph document",
  "description": "One L1 knowledge-graph document: typed nodes and reified edges, provenance-pinned to the sources it was extracted from. In JSON the context element is written @context.",
  "type": "object",
  "properties": {
    "resourceType": {
      "type": "string",
      "const": "KGGraphDocument",
      "description": "Resource type identifier for KGGraphDocument logical model"
    },
    "context": {
      "type": "string",
      "format": "uri",
      "description": "The JSON-LD context (written @context in JSON)."
    },
    "id": {
      "type": "string",
      "description": "IRI of this graph document."
    },
    "type": {
      "type": "string",
      "description": "Always Entity (prov:Entity)."
    },
    "ontologyVersion": {
      "type": "string",
      "description": "schemaVersion of the ontology this graph was built against."
    },
    "generatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "When the document was generated."
    },
    "wasDerivedFrom": {
      "type": "array",
      "items": {
        "$ref": "http://smart.who.int/base/StructureDefinition-KGProvenanceSource.schema.json"
      },
      "description": "The sources this graph was extracted from, each pinned by hash."
    },
    "nodes": {
      "type": "array",
      "items": {
        "$ref": "http://smart.who.int/base/StructureDefinition-KGNode.schema.json"
      },
      "description": "The nodes."
    },
    "edges": {
      "type": "array",
      "items": {
        "$ref": "http://smart.who.int/base/StructureDefinition-KGEdge.schema.json"
      },
      "description": "The edges."
    },
    "dak": {
      "type": "object",
      "description": "The DAK envelope: the fields of the DAK logical model."
    }
  },
  "required": [
    "resourceType",
    "context",
    "id",
    "type",
    "ontologyVersion",
    "generatedAt"
  ],
  "resourceDefinition": "http://smart.who.int/base/StructureDefinition/KGGraphDocument",
  "fhir:parent": "http://hl7.org/fhir/StructureDefinition/Base"
}

This documentation is automatically generated from the OpenAPI specification.

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. KGGraphDocument 0..* Base Knowledge graph L1: graph document
... context 1..1 uri Context
... id 1..1 string ID
... type 1..1 code Type
... generatedAt 1..1 dateTime Generated at
... wasDerivedFrom 0..* KGProvenanceSource Derived from
... nodes 0..* KGNode Nodes
... edges 0..* KGEdge Edges
... dak 0..1 BackboneElement DAK

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. KGGraphDocument 0..* Base Knowledge graph L1: graph document
... context 1..1 uri Context
... id 1..1 string ID
... type 1..1 code Type
... generatedAt 1..1 dateTime Generated at
... wasDerivedFrom 0..* KGProvenanceSource Derived from
... nodes 0..* KGNode Nodes
... edges 0..* KGEdge Edges
... dak 0..1 BackboneElement DAK

doco Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element(5 nested mandatory elements)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. KGGraphDocument 0..* Base Knowledge graph L1: graph document
... context 1..1 uri Context
... id 1..1 string ID
... type 1..1 code Type
... generatedAt 1..1 dateTime Generated at
... wasDerivedFrom 0..* KGProvenanceSource Derived from
... nodes 0..* KGNode Nodes
... edges 0..* KGEdge Edges
... dak 0..1 BackboneElement DAK

doco Documentation for this format

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. KGGraphDocument 0..* Base Knowledge graph L1: graph document
... context 1..1 uri Context
... id 1..1 string ID
... type 1..1 code Type
... generatedAt 1..1 dateTime Generated at
... wasDerivedFrom 0..* KGProvenanceSource Derived from
... nodes 0..* KGNode Nodes
... edges 0..* KGEdge Edges
... dak 0..1 BackboneElement DAK

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. KGGraphDocument 0..* Base Knowledge graph L1: graph document
... context 1..1 uri Context
... id 1..1 string ID
... type 1..1 code Type
... generatedAt 1..1 dateTime Generated at
... wasDerivedFrom 0..* KGProvenanceSource Derived from
... nodes 0..* KGNode Nodes
... edges 0..* KGEdge Edges
... dak 0..1 BackboneElement DAK

doco Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element(5 nested mandatory elements)

 

Other representations of profile: CSV, Excel