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

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

A citation string exactly as it appears in an L2 or L3 artefact, together with what it was resolved to. Grounded directly in the BCG table, where every rule's annotationEntry[1] reads "WHO recommendations for routine immunization – summary tables (March 2023) (1)" — a citation that no tool can currently follow. This class is where that string becomes a link, and where the fact that resolving it was a judgement gets recorded. text is verbatim. location is the artefact path plus the element id — e.g. the DMN rule id. numbering preserves the "(1)" back-reference into the source document's own bibliography. resolutionStatus is unresolved resolved ambiguous; ambiguous is a legitimate terminal state and must not be collapsed to resolved. Class IRI: http://smart.who.int/kg/citation.

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
.. KGCitation 0..* Base Knowledge graph L1: Citation
... text 0..1 string Text
... location 0..1 string Location
... numbering 0..1 string Numbering

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
KGCitation.resolutionStatus Base required Knowledge graph: resolution status 📦0.3.0 This IG

API Information

Knowledge graph L1: Citation API

A citation string exactly as it appears in an L2 or L3 artefact, together with what it was resolved to. Grounded directly in the BCG table, where every rule's annotationEntry[1] reads "WHO recommendations for routine immunization – summary tables (March 2023) (1)" — a citation that no tool can currently follow. This class is where that string becomes a link, and where the fact that resolving it was a judgement gets recorded. text is verbatim. location is the artefact path plus the element id — e.g. the DMN rule id. numbering preserves the "(1)" back-reference into the source document's own bibliography. resolutionStatus is unresolved | resolved | ambiguous; ambiguous is a legitimate terminal state and must not be collapsed to resolved. Class IRI: http://smart.who.int/kg/citation.

Version: 1.0.0

Endpoints

GET /StructureDefinition-KGCitation.schema.json

JSON Schema definition for the Logical Model StructureDefinition-KGCitation

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

Schema Definition

StructureDefinition-KGCitation

Description: A citation string exactly as it appears in an L2 or L3 artefact, together with what it was resolved to. Grounded directly in the BCG table, where every rule's annotationEntry[1] reads "WHO recommendations for routine immunization – summary tables (March 2023) (1)" — a citation that no tool can currently follow. This class is where that string becomes a link, and where the fact that resolving it was a judgement gets recorded. text is verbatim. location is the artefact path plus the element id — e.g. the DMN rule id. numbering preserves the "(1)" back-reference into the source document's own bibliography. resolutionStatus is unresolved | resolved | ambiguous; ambiguous is a legitimate terminal state and must not be collapsed to resolved. Class IRI: http://smart.who.int/kg/citation.

Type: object

Full Schema (JSON)

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "http://smart.who.int/base/StructureDefinition-KGCitation.schema.json",
  "title": "Knowledge graph L1: Citation",
  "description": "A citation string exactly as it appears in an L2 or L3 artefact, together with what it was resolved to. Grounded directly in the BCG table, where every rule's annotationEntry[1] reads \"WHO recommendations for routine immunization \u2013 summary tables (March 2023) (1)\" \u2014 a citation that no tool can currently follow. This class is where that string becomes a link, and where the fact that resolving it was a judgement gets recorded. text is verbatim. location is the artefact path plus the element id \u2014 e.g. the DMN rule id. numbering preserves the \"(1)\" back-reference into the source document's own bibliography. resolutionStatus is unresolved | resolved | ambiguous; ambiguous is a legitimate terminal state and must not be collapsed to resolved. Class IRI: http://smart.who.int/kg/citation.",
  "type": "object",
  "properties": {
    "resourceType": {
      "type": "string",
      "const": "KGCitation",
      "description": "Resource type identifier for KGCitation 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 KGCitation logical model",
      "examples": [
        "LogicalModel-KGCitation"
      ]
    },
    "text": {
      "type": "string",
      "description": "The citation string, VERBATIM as it appears in the citing artefact."
    },
    "location": {
      "type": "string",
      "description": "The citing artefact's path plus the element id (a DMN rule id, a page)."
    },
    "numbering": {
      "type": "string",
      "description": "The '(1)' back-reference into the citing document's own bibliography."
    },
    "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": "unresolved | resolved | ambiguous. Ambiguous is a legitimate terminal state."
    }
  },
  "required": [
    "resourceType"
  ],
  "resourceDefinition": "http://smart.who.int/base/StructureDefinition/KGCitation",
  "fhir:parent": "http://hl7.org/fhir/StructureDefinition/Base",
  "jsonld:valuesets": [
    "KGResolutionStatusVS"
  ],
  "jsonld:contextTemplate": {
    "@version": 1.1,
    "fhir": "http://hl7.org/fhir/",
    "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
.. KGCitation 0..* Base Knowledge graph L1: Citation
... text 0..1 string Text
... location 0..1 string Location
... numbering 0..1 string Numbering

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
KGCitation.resolutionStatus Base required Knowledge graph: resolution status 📦0.3.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. KGCitation 0..* Base Knowledge graph L1: Citation
... text 0..1 string Text
... location 0..1 string Location
... numbering 0..1 string Numbering

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
KGCitation.resolutionStatus Base required Knowledge graph: resolution status 📦0.3.0 This IG

This structure is derived from Base

Summary

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. KGCitation 0..* Base Knowledge graph L1: Citation
... text 0..1 string Text
... location 0..1 string Location
... numbering 0..1 string Numbering

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
KGCitation.resolutionStatus Base required Knowledge graph: resolution status 📦0.3.0 This IG

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. KGCitation 0..* Base Knowledge graph L1: Citation
... text 0..1 string Text
... location 0..1 string Location
... numbering 0..1 string Numbering

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
KGCitation.resolutionStatus Base required Knowledge graph: resolution status 📦0.3.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. KGCitation 0..* Base Knowledge graph L1: Citation
... text 0..1 string Text
... location 0..1 string Location
... numbering 0..1 string Numbering

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
KGCitation.resolutionStatus Base required Knowledge graph: resolution status 📦0.3.0 This IG

This structure is derived from Base

Summary

 

Other representations of profile: CSV, Excel