DAK API Documentation Hub

This page provides access to Data Access Kit (DAK) API documentation and schemas.

DAK API Documentation Hub

This page provides access to all available DAK (Data Access Kit) API endpoints and schemas. The DAK API provides structured access to ValueSet enumerations and Logical Model definitions used throughout this implementation guide.

OpenAPI Documentation

Interactive Swagger UI documentation for all generated schemas and external API specifications is available in the OpenAPI documentation hub:

📖 View OpenAPI Documentation

Using the DAK API

Schema Validation

Each JSON Schema can be used to validate data structures in your applications. The schemas follow the JSON Schema Draft 2020-12 specification and include:

Type definitions and constraints
Property descriptions and examples
Required field specifications
Enumeration values with links to definitions

JSON-LD Semantic Integration

The JSON-LD vocabularies provide semantic web integration for ValueSet enumerations. Each vocabulary includes:

Enumeration class definitions with schema.org compatibility
Individual code instances with canonical IRIs
Property definitions with range constraints
FHIR metadata integration (system URIs, ValueSet references)

Integration with FHIR

All schemas are derived from the FHIR definitions in this implementation guide. Each schema page includes links to the corresponding FHIR resource definitions for complete context.

API Endpoints

The enumeration endpoints provide machine-readable lists of all available schemas, making it easy to discover and integrate with the available data structures programmatically.

API Enumeration Endpoints

These endpoints provide lists of all available schemas and vocabularies of each type:

ValueSets.schema.json

Enumeration of all available ValueSet schemas

Available Endpoints:

ValueSet-CDHIv1.schema.json - JSON Schema for Classification of Digital Health Interventions v1 Schema
ValueSet-CDHIv1.jsonld - JSON-LD vocabulary for Classification of Digital Health Interventions v1 Schema
ValueSet-CoreDataElementTypeVS.schema.json - JSON Schema for Core Data Element Type Value Set Schema
ValueSet-CoreDataElementTypeVS.jsonld - JSON-LD vocabulary for Core Data Element Type Value Set Schema
ValueSets.schema.json - JSON Schema for ValueSet Enumeration Schema
ValueSet-DecisionTableActions.schema.json - JSON Schema for Smart Guidelines Decision Table Actions Schema
ValueSet-DecisionTableActions.jsonld - JSON-LD vocabulary for Smart Guidelines Decision Table Actions Schema
ValueSet-ISCO08ValueSet.schema.json - JSON Schema for ISCO-08 Value Set Schema
ValueSet-ISCO08ValueSet.jsonld - JSON-LD vocabulary for ISCO-08 Value Set Schema
ValueSet-SGPersonaTypesVS.schema.json - JSON Schema for Smart Guidelines Persona Types Value Set Schema
ValueSet-SGPersonaTypesVS.jsonld - JSON-LD vocabulary for Smart Guidelines Persona Types Value Set Schema
ValueSet-CDSCv1.schema.json - JSON Schema for Classification of Digital Health System Categories v1 Schema
ValueSet-CDSCv1.jsonld - JSON-LD vocabulary for Classification of Digital Health System Categories v1 Schema

LogicalModels.schema.json

Enumeration of all available Logical Model schemas

Available Endpoints:

StructureDefinition-DecisionSupportLogicSource.schema.json - JSON Schema for Decision Support Logic Source
StructureDefinition-DublinCore.schema.json - JSON Schema for Dublin Core Metadata Element Set
StructureDefinition-DAK.schema.json - JSON Schema for Digital Adaptation Kit (DAK)
StructureDefinition-NonFunctionalRequirement.schema.json - JSON Schema for Non-Functional Requirement (DAK)
StructureDefinition-CoreDataElementSource.schema.json - JSON Schema for Core Data Element Source
StructureDefinition-ProgramIndicator.schema.json - JSON Schema for Program Indicator (DAK)
StructureDefinition-HealthInterventions.schema.json - JSON Schema for Health Interventions and Recommendations (DAK)
StructureDefinition-DecisionSupportLogic.schema.json - JSON Schema for Decision-Support Logic (DAK)
StructureDefinition-UserScenarioSource.schema.json - JSON Schema for User Scenario Source
StructureDefinition-HealthInterventionsSource.schema.json - JSON Schema for Health Interventions Source
StructureDefinition-UserScenario.schema.json - JSON Schema for User Scenario (DAK)
StructureDefinition-ProgramIndicatorSource.schema.json - JSON Schema for Program Indicator Source
StructureDefinition-GenericPersona.schema.json - JSON Schema for Generic Persona (DAK)
StructureDefinition-FunctionalRequirement.schema.json - JSON Schema for Functional Requirement (DAK)
StructureDefinition-TestScenarioSource.schema.json - JSON Schema for Test Scenario Source
StructureDefinition-TestScenario.schema.json - JSON Schema for Test Scenario (DAK)
StructureDefinition-Persona.schema.json - JSON Schema for Persona (DAK)
LogicalModels.schema.json - JSON Schema for Logical Model Enumeration Schema
StructureDefinition-BusinessProcessWorkflow.schema.json - JSON Schema for Business Process Workflow (DAK)
StructureDefinition-GenericPersonaSource.schema.json - JSON Schema for Generic Persona Source
StructureDefinition-Requirements.schema.json - JSON Schema for Functional and Non-Functional Requirements (DAK)
StructureDefinition-SushiConfigLogicalModel.schema.json - JSON Schema for SUSHI Configuration Logical Model
StructureDefinition-CoreDataElement.schema.json - JSON Schema for Core Data Element (DAK)
StructureDefinition-RequirementsSource.schema.json - JSON Schema for Requirements Source
StructureDefinition-BusinessProcessWorkflowSource.schema.json - JSON Schema for Business Process Workflow Source

This documentation hub is automatically generated from the available schema and API definitions.