WHO SMART Trust
1.1.6 - CI Build International flag

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

DAK API Documentation Hub

DAK API Documentation Hub

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

Table of Contents

  1. DAK API Documentation Hub

DAK API Documentation Hub

This page provides comprehensive documentation for 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.

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:

LogicalModels.schema.json

Enumeration of all available Logical Model schemas

Available Endpoints:

ValueSet Schemas (13 available)

JSON Schema definitions for FHIR ValueSets, providing structured enumeration of allowed code values:

WHO GDHCN Actor ValueSet of actor codes Schema

JSON Schema for WHO GDHCN Actor ValueSet of actor codes ValueSet codes. Generated from FHIR expansions using IRI format.

WHO GDHCN Payload Types Schema

JSON Schema for WHO GDHCN Payload Types ValueSet codes. Generated from FHIR expansions using IRI format.

WHO GDHCN Key Usage ValueSet Schema

JSON Schema for WHO GDHCN Key Usage ValueSet ValueSet codes. Generated from FHIR expansions using IRI format.

WHO GDHCN Connection Types Schema

JSON Schema for WHO GDHCN Connection Types ValueSet codes. Generated from FHIR expansions using IRI format.

WHO GDHCN Key Usage ValueSet - UAT Schema

JSON Schema for WHO GDHCN Key Usage ValueSet - UAT ValueSet codes. Generated from FHIR expansions using IRI format.

WHO GDHCN Trust Domains - UAT Schema

JSON Schema for WHO GDHCN Trust Domains - UAT ValueSet codes. Generated from FHIR expansions using IRI format.

WHO GDHCN Trust Domains - DEV Schema

JSON Schema for WHO GDHCN Trust Domains - DEV ValueSet codes. Generated from FHIR expansions using IRI format.

WHO GDHCN Trust Domains Schema

JSON Schema for WHO GDHCN Trust Domains ValueSet codes. Generated from FHIR expansions using IRI format.

WHO GDHCN Transaction Codes Schema

JSON Schema for WHO GDHCN Transaction Codes ValueSet codes. Generated from FHIR expansions using IRI format.

WHO GDHCN Trust Network Participant - UAT Schema

JSON Schema for WHO GDHCN Trust Network Participant - UAT ValueSet codes. Generated from FHIR expansions using IRI format.

WHO GDHCN Trust Network Participant Schema

JSON Schema for WHO GDHCN Trust Network Participant ValueSet codes. Generated from FHIR expansions using IRI format.

WHO GDHCN Trust Network Participant - DEV Schema

JSON Schema for WHO GDHCN Trust Network Participant - DEV ValueSet codes. Generated from FHIR expansions using IRI format.

WHO GDHCN Key Usage ValueSet - DEV Schema

JSON Schema for WHO GDHCN Key Usage ValueSet - DEV ValueSet codes. Generated from FHIR expansions using IRI format.

Logical Model Schemas (5 available)

JSON Schema definitions for FHIR Logical Models, defining structured data elements and their relationships:

CBOR Web Token (CWT) Claim

Logical Model for Data elements in CBOR Web Token (CWT) https://www.iana.org/assignments/cwt/cwt.xhtml

COSE Headers (DRAFT)

Data elements for COSE Headers https://www.iana.org/assignments/cose/cose.xhtml#header-parameters

CBOR Web Token (CWT) Payload (Common)

Logical Model for CBOR Web Token (CWT) Payload Logical Modelin CWT Payload https://www.iana.org/assignments/cwt/cwt.xhtml

Scheme Information

Logical Model for Information on the trusted list and its issuing scheme

OpenAPI Documentation

Complete API specification documentation for all available endpoints:

ValueSet-Actors Endpoints

API endpoints for WHO GDHCN Actor ValueSet of actor codes Schema

ValueSet-PayloadTypes Endpoints

API endpoints for WHO GDHCN Payload Types Schema

ValueSet-KeyUsage Endpoints

API endpoints for WHO GDHCN Key Usage ValueSet Schema

ValueSet-ConnectionTypes Endpoints

API endpoints for WHO GDHCN Connection Types Schema

ValueSet-KeyUsage-UAT Endpoints

API endpoints for WHO GDHCN Key Usage ValueSet - UAT Schema

ValueSet-Domains-UAT Endpoints

API endpoints for WHO GDHCN Trust Domains - UAT Schema

ValueSet-Domains-DEV Endpoints

API endpoints for WHO GDHCN Trust Domains - DEV Schema

ValueSet-Domains Endpoints

API endpoints for WHO GDHCN Trust Domains Schema

ValueSet-Transactions Endpoints

API endpoints for WHO GDHCN Transaction Codes Schema

ValueSet-Participants-UAT Endpoints

API endpoints for WHO GDHCN Trust Network Participant - UAT Schema

ValueSet-Participants Endpoints

API endpoints for WHO GDHCN Trust Network Participant Schema

ValueSet-Participants-DEV Endpoints

API endpoints for WHO GDHCN Trust Network Participant - DEV Schema

ValueSet-KeyUsage-DEV Endpoints

API endpoints for WHO GDHCN Key Usage ValueSet - DEV Schema

StructureDefinition-CWT Endpoints

API endpoints for CBOR Web Token (CWT) Claim

StructureDefinition-COSEHeader Endpoints

API endpoints for COSE Headers (DRAFT)

StructureDefinition-CWTPayload Endpoints

API endpoints for CBOR Web Token (CWT) Payload (Common)

StructureDefinition-SchemeInformation Endpoints

API endpoints for Scheme Information

StructureDefinition-HCert Endpoints

API endpoints for Health Certificate

ValueSets Enumeration Endpoint

Complete list of all available ValueSet schemas

LogicalModels Enumeration Endpoint

Complete list of all available Logical Model schemas

ValueSet-PayloadTypes API

OpenAPI specification for ValueSet-PayloadTypes

ValueSet-Participants API

OpenAPI specification for ValueSet-Participants

Requirements-DistributePKIMaterialAPI API

OpenAPI specification for Requirements-DistributePKIMaterialAPI

StructureDefinition-CWT API

OpenAPI specification for StructureDefinition-CWT

ValueSet-Domains-DEV API

OpenAPI specification for ValueSet-Domains-DEV

ValueSet-Domains-UAT API

OpenAPI specification for ValueSet-Domains-UAT

ValueSet-Participants-DEV API

OpenAPI specification for ValueSet-Participants-DEV

StructureDefinition-COSEHeader API

OpenAPI specification for StructureDefinition-COSEHeader

ValueSet-Participants-UAT API

OpenAPI specification for ValueSet-Participants-UAT

ValueSet-Transactions API

OpenAPI specification for ValueSet-Transactions

ValueSet-Domains API

OpenAPI specification for ValueSet-Domains

LogicalModels-enumeration API

OpenAPI specification for LogicalModels-enumeration

ValueSet-KeyUsage-DEV API

OpenAPI specification for ValueSet-KeyUsage-DEV

ValueSet-KeyUsage API

OpenAPI specification for ValueSet-KeyUsage

ValueSets-enumeration API

OpenAPI specification for ValueSets-enumeration

Requirements-PublishPKIMaterialAPI API

OpenAPI specification for Requirements-PublishPKIMaterialAPI

ValueSet-Actors API

OpenAPI specification for ValueSet-Actors

ValueSet-KeyUsage-UAT API

OpenAPI specification for ValueSet-KeyUsage-UAT

StructureDefinition-HCert API

OpenAPI specification for StructureDefinition-HCert

ValueSet-ConnectionTypes API

OpenAPI specification for ValueSet-ConnectionTypes

StructureDefinition-SchemeInformation API

OpenAPI specification for StructureDefinition-SchemeInformation

StructureDefinition-CWTPayload API

OpenAPI specification for StructureDefinition-CWTPayload

Requirements-ReceivePKUMaterialAPI API

OpenAPI specification for Requirements-ReceivePKUMaterialAPI

Requirements-RetrievePKIMaterialAPI API

OpenAPI specification for Requirements-RetrievePKIMaterialAPI

openapi API

OpenAPI specification for openapi

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.


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