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: edge

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

One reified statement: a predicate from a source node to a target node, with its derivation and evidence.

Usages:

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
.. KGEdge 0..* Base Knowledge graph: edge
... type 1..1 code Type
... predicate 1..1 code Predicate
Binding: Knowledge graph L1: predicates (required)
... source 1..1 string Source
... qualifier 0..1 string Qualifier
... derivation 1..1 code Derivation
Binding: Knowledge graph: derivation (required)
... note 0..1 string Note
... evidence 0..1 KGEvidenceLocation Evidence
... flagRef 0..1 string Flag
... skill 0..1 string Skill
... properties 0..1 BackboneElement Properties
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... resolutionStatus 0..1 code Resolution status
Binding: Knowledge graph: resolution status (required)
.... matchedOn 0..1 string Matched on

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
KGEdge.predicate Base required Knowledge graph L1: predicates 📦0.3.0 This IG
KGEdge.derivation Base required Knowledge graph: derivation 📦0.3.0 This IG
KGEdge.properties.resolutionStatus Base required Knowledge graph: resolution status 📦0.3.0 This IG

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

API Information

Knowledge graph: edge API

One reified statement: a predicate from a source node to a target node, with its derivation and evidence.

Version: 1.0.0

Endpoints

GET /StructureDefinition-KGEdge.schema.json

JSON Schema definition for the Logical Model StructureDefinition-KGEdge

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

Schema Definition

StructureDefinition-KGEdge

Description: One reified statement: a predicate from a source node to a target node, with its derivation and evidence.

Type: object

Full Schema (JSON)

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "http://smart.who.int/base/StructureDefinition-KGEdge.schema.json",
  "title": "Knowledge graph: edge",
  "description": "One reified statement: a predicate from a source node to a target node, with its derivation and evidence.",
  "type": "object",
  "properties": {
    "resourceType": {
      "type": "string",
      "const": "KGEdge",
      "description": "Resource type identifier for KGEdge logical model"
    },
    "@context": {
      "description": "JSON-LD context for this logical model with ValueSet vocabularies",
      "anyOf": [
        {
          "type": "string",
          "format": "uri",
          "description": "URI reference to external JSON-LD context"
        },
        {
          "type": "object",
          "description": "Inline JSON-LD context",
          "properties": {
            "@version": {
              "type": "number",
              "const": 1.1
            },
            "fhir": {
              "type": "string",
              "const": "http://hl7.org/fhir/"
            }
          },
          "additionalProperties": {
            "type": "string",
            "format": "uri"
          }
        },
        {
          "type": "array",
          "description": "Array of JSON-LD context objects/URIs",
          "items": {
            "anyOf": [
              {
                "type": "string",
                "format": "uri"
              },
              {
                "type": "object"
              }
            ]
          }
        }
      ]
    },
    "@type": {
      "type": "string",
      "description": "JSON-LD type identifier for KGEdge logical model",
      "examples": [
        "LogicalModel-KGEdge"
      ]
    },
    "type": {
      "type": "string",
      "description": "Always Statement (rdf:Statement)."
    },
    "predicate": {
      "oneOf": [
        {
          "type": "string",
          "description": "Code from ValueSet KGL1PredicatesVS (plain string)"
        },
        {
          "type": "object",
          "description": "Code from ValueSet KGL1PredicatesVS (JSON-LD structure)",
          "properties": {
            "@type": {
              "type": "string",
              "const": "http://smart.who.int/base/ValueSet-KGL1PredicatesVS.jsonld",
              "description": "JSON-LD type reference to ValueSet KGL1PredicatesVS"
            },
            "@id": {
              "type": "string",
              "format": "uri",
              "description": "Full IRI of the code from ValueSet KGL1PredicatesVS"
            }
          },
          "required": [
            "@type",
            "@id"
          ],
          "additionalProperties": false
        }
      ],
      "description": "The predicate; the layer's edge table says which (source, target) pairs it licenses."
    },
    "source": {
      "type": "string",
      "description": "IRI of the source node."
    },
    "target": {
      "type": "string",
      "description": "IRI of the target node."
    },
    "qualifier": {
      "type": "string",
      "description": "A label on the relationship."
    },
    "derivation": {
      "oneOf": [
        {
          "type": "string",
          "description": "Code from ValueSet KGDerivationVS (plain string)"
        },
        {
          "type": "object",
          "description": "Code from ValueSet KGDerivationVS (JSON-LD structure)",
          "properties": {
            "@type": {
              "type": "string",
              "const": "http://smart.who.int/base/ValueSet-KGDerivationVS.jsonld",
              "description": "JSON-LD type reference to ValueSet KGDerivationVS"
            },
            "@id": {
              "type": "string",
              "format": "uri",
              "description": "Full IRI of the code from ValueSet KGDerivationVS"
            }
          },
          "required": [
            "@type",
            "@id"
          ],
          "additionalProperties": false
        }
      ],
      "description": "derived | inferred | decided."
    },
    "note": {
      "type": "string",
      "description": "Why it is what it is. Required unless derived."
    },
    "evidence": {
      "$ref": "http://smart.who.int/base/StructureDefinition-KGEvidenceLocation.schema.json",
      "description": "Where it came from. Required unless derived."
    },
    "flagRef": {
      "type": "string",
      "description": "Id of a flag raised while extracting this edge."
    },
    "skill": {
      "type": "string",
      "description": "Skill id that produced this edge."
    },
    "properties": {
      "type": "object",
      "description": "Fields of the statement itself."
    },
    "id": {
      "type": "object",
      "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."
    },
    "modifierExtension": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "FHIR Extension"
      },
      "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."
    },
    "resolutionStatus": {
      "oneOf": [
        {
          "type": "string",
          "description": "Code from ValueSet KGResolutionStatusVS (plain string)"
        },
        {
          "type": "object",
          "description": "Code from ValueSet KGResolutionStatusVS (JSON-LD structure)",
          "properties": {
            "@type": {
              "type": "string",
              "const": "http://smart.who.int/base/ValueSet-KGResolutionStatusVS.jsonld",
              "description": "JSON-LD type reference to ValueSet KGResolutionStatusVS"
            },
            "@id": {
              "type": "string",
              "format": "uri",
              "description": "Full IRI of the code from ValueSet KGResolutionStatusVS"
            }
          },
          "required": [
            "@type",
            "@id"
          ],
          "additionalProperties": false
        }
      ],
      "description": "For a cross-format join: unresolved | resolved | ambiguous."
    },
    "matchedOn": {
      "type": "string",
      "description": "What the join was matched on."
    }
  },
  "required": [
    "resourceType",
    "type",
    "predicate",
    "source",
    "target",
    "derivation"
  ],
  "resourceDefinition": "http://smart.who.int/base/StructureDefinition/KGEdge",
  "fhir:parent": "http://hl7.org/fhir/StructureDefinition/Base",
  "jsonld:valuesets": [
    "KGDerivationVS",
    "KGL1PredicatesVS",
    "KGResolutionStatusVS"
  ],
  "jsonld:contextTemplate": {
    "@version": 1.1,
    "fhir": "http://hl7.org/fhir/",
    "KGDerivationVS": "http://smart.who.int/base/ValueSet-KGDerivationVS.jsonld",
    "KGL1PredicatesVS": "http://smart.who.int/base/ValueSet-KGL1PredicatesVS.jsonld",
    "KGResolutionStatusVS": "http://smart.who.int/base/ValueSet-KGResolutionStatusVS.jsonld"
  }
}

This documentation is automatically generated from the OpenAPI specification.

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. KGEdge 0..* Base Knowledge graph: edge
... type 1..1 code Type
... predicate 1..1 code Predicate
Binding: Knowledge graph L1: predicates (required)
... source 1..1 string Source
... qualifier 0..1 string Qualifier
... derivation 1..1 code Derivation
Binding: Knowledge graph: derivation (required)
... note 0..1 string Note
... evidence 0..1 KGEvidenceLocation Evidence
... flagRef 0..1 string Flag
... skill 0..1 string Skill
... properties 0..1 BackboneElement Properties
.... resolutionStatus 0..1 code Resolution status
Binding: Knowledge graph: resolution status (required)
.... matchedOn 0..1 string Matched on

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
KGEdge.predicate Base required Knowledge graph L1: predicates 📦0.3.0 This IG
KGEdge.derivation Base required Knowledge graph: derivation 📦0.3.0 This IG
KGEdge.properties.resolutionStatus Base required Knowledge graph: resolution status 📦0.3.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. KGEdge 0..* Base Knowledge graph: edge
... type 1..1 code Type
... predicate 1..1 code Predicate
Binding: Knowledge graph L1: predicates (required)
... source 1..1 string Source
... qualifier 0..1 string Qualifier
... derivation 1..1 code Derivation
Binding: Knowledge graph: derivation (required)
... note 0..1 string Note
... evidence 0..1 KGEvidenceLocation Evidence
... flagRef 0..1 string Flag
... skill 0..1 string Skill
... properties 0..1 BackboneElement Properties
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... resolutionStatus 0..1 code Resolution status
Binding: Knowledge graph: resolution status (required)
.... matchedOn 0..1 string Matched on

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
KGEdge.predicate Base required Knowledge graph L1: predicates 📦0.3.0 This IG
KGEdge.derivation Base required Knowledge graph: derivation 📦0.3.0 This IG
KGEdge.properties.resolutionStatus Base required Knowledge graph: resolution status 📦0.3.0 This IG

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element(5 nested mandatory elements)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. KGEdge 0..* Base Knowledge graph: edge
... type 1..1 code Type
... predicate 1..1 code Predicate
Binding: Knowledge graph L1: predicates (required)
... source 1..1 string Source
... qualifier 0..1 string Qualifier
... derivation 1..1 code Derivation
Binding: Knowledge graph: derivation (required)
... note 0..1 string Note
... evidence 0..1 KGEvidenceLocation Evidence
... flagRef 0..1 string Flag
... skill 0..1 string Skill
... properties 0..1 BackboneElement Properties
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... resolutionStatus 0..1 code Resolution status
Binding: Knowledge graph: resolution status (required)
.... matchedOn 0..1 string Matched on

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
KGEdge.predicate Base required Knowledge graph L1: predicates 📦0.3.0 This IG
KGEdge.derivation Base required Knowledge graph: derivation 📦0.3.0 This IG
KGEdge.properties.resolutionStatus Base required Knowledge graph: resolution status 📦0.3.0 This IG

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. KGEdge 0..* Base Knowledge graph: edge
... type 1..1 code Type
... predicate 1..1 code Predicate
Binding: Knowledge graph L1: predicates (required)
... source 1..1 string Source
... qualifier 0..1 string Qualifier
... derivation 1..1 code Derivation
Binding: Knowledge graph: derivation (required)
... note 0..1 string Note
... evidence 0..1 KGEvidenceLocation Evidence
... flagRef 0..1 string Flag
... skill 0..1 string Skill
... properties 0..1 BackboneElement Properties
.... resolutionStatus 0..1 code Resolution status
Binding: Knowledge graph: resolution status (required)
.... matchedOn 0..1 string Matched on

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
KGEdge.predicate Base required Knowledge graph L1: predicates 📦0.3.0 This IG
KGEdge.derivation Base required Knowledge graph: derivation 📦0.3.0 This IG
KGEdge.properties.resolutionStatus Base required Knowledge graph: resolution status 📦0.3.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. KGEdge 0..* Base Knowledge graph: edge
... type 1..1 code Type
... predicate 1..1 code Predicate
Binding: Knowledge graph L1: predicates (required)
... source 1..1 string Source
... qualifier 0..1 string Qualifier
... derivation 1..1 code Derivation
Binding: Knowledge graph: derivation (required)
... note 0..1 string Note
... evidence 0..1 KGEvidenceLocation Evidence
... flagRef 0..1 string Flag
... skill 0..1 string Skill
... properties 0..1 BackboneElement Properties
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... resolutionStatus 0..1 code Resolution status
Binding: Knowledge graph: resolution status (required)
.... matchedOn 0..1 string Matched on

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
KGEdge.predicate Base required Knowledge graph L1: predicates 📦0.3.0 This IG
KGEdge.derivation Base required Knowledge graph: derivation 📦0.3.0 This IG
KGEdge.properties.resolutionStatus Base required Knowledge graph: resolution status 📦0.3.0 This IG

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element(5 nested mandatory elements)

 

Other representations of profile: CSV, Excel