SMART Base
0.2.0 - ci-build

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

Logical Model: Core Data Element (DAK)

Official URL: http://smart.who.int/base/StructureDefinition/CoreDataElement Version: 0.2.0
Active as of 2025-10-14 Computable Name: CoreDataElement

Logical Model for representing Core Data Elements from a DAK. A core data element can be one of: a ValueSet, a CodeSystem, a ConceptMap, or a Logical Model adherent to SGLogicalModel. This is the ONE EXCEPTION to allowing FHIR R4 models into the DAK LMs.

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
.. CoreDataElement 0..* Base Core Data Element (DAK)
... type 1..1 code Type
Binding: Core Data Element Type Value Set (required)
... canonical 1..1 uri Canonical
... id 0..1 id Element ID
.... descriptionString string
.... descriptionUri uri

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CoreDataElement.type Base required Core Data Element Type Value Set 📦0.2.0 This IG

API Information

Core Data Element (DAK) API

Logical Model for representing Core Data Elements from a DAK. A core data element can be one of: a ValueSet, a CodeSystem, a ConceptMap, or a Logical Model adherent to SGLogicalModel. This is the ONE EXCEPTION to allowing FHIR R4 models into the DAK LMs.

Version: 1.0.0

Endpoints

GET /StructureDefinition-CoreDataElement.schema.json

JSON Schema definition for the Logical Model StructureDefinition-CoreDataElement

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

Schema Definition

StructureDefinition-CoreDataElement

Description: Logical Model for representing Core Data Elements from a DAK. A core data element can be one of: a ValueSet, a CodeSystem, a ConceptMap, or a Logical Model adherent to SGLogicalModel. This is the ONE EXCEPTION to allowing FHIR R4 models into the DAK LMs.

Type: object

Schema ID: https://worldhealthorganization.github.io/smart-base/StructureDefinition-CoreDataElement.schema.json

Properties

  • resourceType (string): Resource type identifier for CoreDataElement logical model
  • @context (unknown): JSON-LD context for this logical model with ValueSet vocabularies
  • @type (string): JSON-LD type identifier for CoreDataElement logical model
  • type (unknown): Type of core data element: valueset, codesystem, conceptmap, or logicalmodel
  • canonical (string): Canonical URI/IRI pointing to the ValueSet, CodeSystem, ConceptMap, or Logical Model definition
  • id (string): Identifier for the core data element
  • description[x] (unknown): Description of the core data element - either Markdown content or a URI to a Markdown file (absolute or relative to repository root)

Required fields: resourceType, type, canonical

Full Schema (JSON)
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://worldhealthorganization.github.io/smart-base/StructureDefinition-CoreDataElement.schema.json",
  "title": "Core Data Element (DAK)",
  "description": "Logical Model for representing Core Data Elements from a DAK. A core data element can be one of: a ValueSet, a CodeSystem, a ConceptMap, or a Logical Model adherent to SGLogicalModel. This is the ONE EXCEPTION to allowing FHIR R4 models into the DAK LMs.",
  "type": "object",
  "properties": {
    "resourceType": {
      "type": "string",
      "const": "CoreDataElement",
      "description": "Resource type identifier for CoreDataElement 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 CoreDataElement logical model",
      "examples": [
        "LogicalModel-CoreDataElement"
      ]
    },
    "type": {
      "oneOf": [
        {
          "type": "string",
          "description": "Code from ValueSet CoreDataElementTypeVS (plain string)"
        },
        {
          "type": "object",
          "description": "Code from ValueSet CoreDataElementTypeVS (JSON-LD structure)",
          "properties": {
            "@type": {
              "type": "string",
              "const": "http://smart.who.int/base/ValueSet-CoreDataElementTypeVS.jsonld",
              "description": "JSON-LD type reference to ValueSet CoreDataElementTypeVS"
            },
            "@id": {
              "type": "string",
              "format": "uri",
              "description": "Full IRI of the code from ValueSet CoreDataElementTypeVS"
            }
          },
          "required": [
            "@type",
            "@id"
          ],
          "additionalProperties": false
        }
      ],
      "description": "Type of core data element: valueset, codesystem, conceptmap, or logicalmodel"
    },
    "canonical": {
      "type": "string",
      "format": "uri",
      "description": "Canonical URI/IRI pointing to the ValueSet, CodeSystem, ConceptMap, or Logical Model definition"
    },
    "id": {
      "type": "string",
      "description": "Identifier for the core data element"
    },
    "description[x]": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "string",
          "format": "uri"
        }
      ],
      "description": "Description of the core data element - either Markdown content or a URI to a Markdown file (absolute or relative to repository root)"
    }
  },
  "required": [
    "resourceType",
    "type",
    "canonical"
  ],
  "resourceDefinition": "http://smart.who.int/base/StructureDefinition/CoreDataElement",
  "fhir:parent": "http://hl7.org/fhir/StructureDefinition/Base",
  "jsonld:valuesets": [
    "CoreDataElementTypeVS"
  ],
  "jsonld:contextTemplate": {
    "@version": 1.1,
    "fhir": "http://hl7.org/fhir/",
    "CoreDataElementTypeVS": "http://smart.who.int/base/ValueSet-CoreDataElementTypeVS.jsonld"
  }
}

This documentation is automatically generated from the OpenAPI specification.

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CoreDataElement 0..* Base Core Data Element (DAK)
... type 1..1 code Type
Binding: Core Data Element Type Value Set (required)
... canonical 1..1 uri Canonical
... id 0..1 id Element ID
.... descriptionString string
.... descriptionUri uri

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
CoreDataElement.type Base required Core Data Element Type Value Set 📦0.2.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CoreDataElement 0..* Base Core Data Element (DAK)
... type 1..1 code Type
Binding: Core Data Element Type Value Set (required)
... canonical 1..1 uri Canonical
... id 0..1 id Element ID
.... descriptionString string
.... descriptionUri uri

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CoreDataElement.type Base required Core Data Element Type Value Set 📦0.2.0 This IG

This structure is derived from Base

Summary

Mandatory: 0 element(2 nested mandatory elements)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CoreDataElement 0..* Base Core Data Element (DAK)
... type 1..1 code Type
Binding: Core Data Element Type Value Set (required)
... canonical 1..1 uri Canonical
... id 0..1 id Element ID
.... descriptionString string
.... descriptionUri uri

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CoreDataElement.type Base required Core Data Element Type Value Set 📦0.2.0 This IG

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CoreDataElement 0..* Base Core Data Element (DAK)
... type 1..1 code Type
Binding: Core Data Element Type Value Set (required)
... canonical 1..1 uri Canonical
... id 0..1 id Element ID
.... descriptionString string
.... descriptionUri uri

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
CoreDataElement.type Base required Core Data Element Type Value Set 📦0.2.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CoreDataElement 0..* Base Core Data Element (DAK)
... type 1..1 code Type
Binding: Core Data Element Type Value Set (required)
... canonical 1..1 uri Canonical
... id 0..1 id Element ID
.... descriptionString string
.... descriptionUri uri

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CoreDataElement.type Base required Core Data Element Type Value Set 📦0.2.0 This IG

This structure is derived from Base

Summary

Mandatory: 0 element(2 nested mandatory elements)

 

Other representations of profile: CSV, Excel