WHO SMART Trust
1.5.0 - release International flag

WHO SMART Trust, published by WHO. This guide is not an authorized publication; it is the continuous build for version 1.5.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-trust/ 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

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 (14 available)

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

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 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 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 Domains Schema

JSON Schema for WHO GDHCN Trust Domains 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 Transaction Codes Schema

JSON Schema for WHO GDHCN Transaction Codes 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 Trust Network Participant Schema

JSON Schema for WHO GDHCN Trust Network Participant 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 Key Usage ValueSet - DEV Schema

JSON Schema for WHO GDHCN Key Usage ValueSet - DEV 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 Regional Offices Schema

JSON Schema for WHO Regional Offices 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 Trust Domains - UAT Schema

JSON Schema for WHO GDHCN Trust Domains - UAT 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:

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

CBOR Web Token (CWT) Claim

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

OpenAPI Documentation

Complete API specification documentation for all available endpoints:

ValueSet-KeyUsage Endpoints

API endpoints for WHO GDHCN Key Usage ValueSet Schema

ValueSet-Actors Endpoints

API endpoints for WHO GDHCN Actor ValueSet of actor codes Schema

ValueSet-Participants-UAT Endpoints

API endpoints for WHO GDHCN Trust Network Participant - UAT Schema

ValueSet-Domains Endpoints

API endpoints for WHO GDHCN Trust Domains Schema

ValueSet-KeyUsage-UAT Endpoints

API endpoints for WHO GDHCN Key Usage ValueSet - UAT Schema

ValueSet-Transactions Endpoints

API endpoints for WHO GDHCN Transaction Codes Schema

ValueSet-Participants-DEV Endpoints

API endpoints for WHO GDHCN Trust Network Participant - DEV Schema

ValueSet-Participants Endpoints

API endpoints for WHO GDHCN Trust Network Participant Schema

ValueSet-Domains-DEV Endpoints

API endpoints for WHO GDHCN Trust Domains - DEV Schema

ValueSet-KeyUsage-DEV Endpoints

API endpoints for WHO GDHCN Key Usage ValueSet - DEV Schema

ValueSet-PayloadTypes Endpoints

API endpoints for WHO GDHCN Payload Types Schema

ValueSet-WHORegionalOffices Endpoints

API endpoints for WHO Regional Offices Schema

ValueSet-ConnectionTypes Endpoints

API endpoints for WHO GDHCN Connection Types Schema

ValueSet-Domains-UAT Endpoints

API endpoints for WHO GDHCN Trust Domains - UAT Schema

StructureDefinition-HCert Endpoints

API endpoints for Health Certificate

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-CWT Endpoints

API endpoints for CBOR Web Token (CWT) Claim

ValueSets Enumeration Endpoint

Complete list of all available ValueSet schemas

LogicalModels Enumeration Endpoint

Complete list of all available Logical Model schemas

ValueSet-ConnectionTypes API

OpenAPI specification for ValueSet-ConnectionTypes

ValueSet-Domains API

OpenAPI specification for ValueSet-Domains

ValueSet-WHORegionalOffices API

OpenAPI specification for ValueSet-WHORegionalOffices

ValueSet-KeyUsage-DEV API

OpenAPI specification for ValueSet-KeyUsage-DEV

ValueSet-Actors API

OpenAPI specification for ValueSet-Actors

ValueSet-Domains-UAT API

OpenAPI specification for ValueSet-Domains-UAT

ValueSet-PayloadTypes API

OpenAPI specification for ValueSet-PayloadTypes

StructureDefinition-CWTPayload API

OpenAPI specification for StructureDefinition-CWTPayload

StructureDefinition-SchemeInformation API

OpenAPI specification for StructureDefinition-SchemeInformation

StructureDefinition-HCert API

OpenAPI specification for StructureDefinition-HCert

ValueSet-Participants API

OpenAPI specification for ValueSet-Participants

ValueSet-Participants-DEV API

OpenAPI specification for ValueSet-Participants-DEV

ValueSet-KeyUsage API

OpenAPI specification for ValueSet-KeyUsage

StructureDefinition-COSEHeader API

OpenAPI specification for StructureDefinition-COSEHeader

StructureDefinition-CWT API

OpenAPI specification for StructureDefinition-CWT

ValueSet-Domains-DEV API

OpenAPI specification for ValueSet-Domains-DEV

ValueSet-KeyUsage-UAT API

OpenAPI specification for ValueSet-KeyUsage-UAT

ValueSet-Participants-UAT API

OpenAPI specification for ValueSet-Participants-UAT

ValueSet-Transactions API

OpenAPI specification for ValueSet-Transactions

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.

  • 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.

Integration with FHIR

All schemas are derived from the FHIR definitions in this implementation guide.

API Endpoints

The enumeration endpoints provide machine-readable lists of all available schemas.


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