DAK API Documentation Hub

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

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.

Logical Models

The following logical models define the structure for computable representations of WHO DAK content:

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

ValueSets.schema.json - JSON Schema for ValueSet Enumeration Schema
ValueSet-Actors.schema.json - JSON Schema for WHO GDHCN Actor ValueSet of actor codes Schema
ValueSet-Actors.jsonld - JSON-LD vocabulary for WHO GDHCN Actor ValueSet of actor codes Schema
ValueSet-PayloadTypes.schema.json - JSON Schema for WHO GDHCN Payload Types Schema
ValueSet-PayloadTypes.jsonld - JSON-LD vocabulary for WHO GDHCN Payload Types Schema
ValueSet-Participants-UAT.schema.json - JSON Schema for WHO GDHCN Trust Network Participant - UAT Schema
ValueSet-Participants-UAT.jsonld - JSON-LD vocabulary for WHO GDHCN Trust Network Participant - UAT Schema
ValueSet-KeyUsage-DEV.schema.json - JSON Schema for WHO GDHCN Key Usage ValueSet - DEV Schema
ValueSet-KeyUsage-DEV.jsonld - JSON-LD vocabulary for WHO GDHCN Key Usage ValueSet - DEV Schema
ValueSet-Domains-UAT.schema.json - JSON Schema for WHO GDHCN Trust Domains - UAT Schema
ValueSet-Domains-UAT.jsonld - JSON-LD vocabulary for WHO GDHCN Trust Domains - UAT Schema
ValueSet-Domains-DEV.schema.json - JSON Schema for WHO GDHCN Trust Domains - DEV Schema
ValueSet-Domains-DEV.jsonld - JSON-LD vocabulary for WHO GDHCN Trust Domains - DEV Schema
ValueSet-Domains.schema.json - JSON Schema for WHO GDHCN Trust Domains Schema
ValueSet-Domains.jsonld - JSON-LD vocabulary for WHO GDHCN Trust Domains Schema
ValueSet-KeyUsage.schema.json - JSON Schema for WHO GDHCN Key Usage ValueSet Schema
ValueSet-KeyUsage.jsonld - JSON-LD vocabulary for WHO GDHCN Key Usage ValueSet Schema
ValueSet-Participants.schema.json - JSON Schema for WHO GDHCN Trust Network Participant Schema
ValueSet-Participants.jsonld - JSON-LD vocabulary for WHO GDHCN Trust Network Participant Schema
ValueSet-Transactions.schema.json - JSON Schema for WHO GDHCN Transaction Codes Schema
ValueSet-Transactions.jsonld - JSON-LD vocabulary for WHO GDHCN Transaction Codes Schema
ValueSet-Participants-DEV.schema.json - JSON Schema for WHO GDHCN Trust Network Participant - DEV Schema
ValueSet-Participants-DEV.jsonld - JSON-LD vocabulary for WHO GDHCN Trust Network Participant - DEV Schema
ValueSet-KeyUsage-UAT.schema.json - JSON Schema for WHO GDHCN Key Usage ValueSet - UAT Schema
ValueSet-KeyUsage-UAT.jsonld - JSON-LD vocabulary for WHO GDHCN Key Usage ValueSet - UAT Schema
ValueSet-WHORegionalOffices.schema.json - JSON Schema for WHO Regional Offices Schema
ValueSet-WHORegionalOffices.jsonld - JSON-LD vocabulary for WHO Regional Offices Schema
ValueSet-ConnectionTypes.schema.json - JSON Schema for WHO GDHCN Connection Types Schema
ValueSet-ConnectionTypes.jsonld - JSON-LD vocabulary for WHO GDHCN Connection Types Schema

LogicalModels.schema.json

Enumeration of all available Logical Model schemas

Available Endpoints:

StructureDefinition-CWTPayload.schema.json - JSON Schema for CBOR Web Token (CWT) Payload (Common)
StructureDefinition-COSEHeader.schema.json - JSON Schema for COSE Headers (DRAFT)
StructureDefinition-HCert.schema.json - JSON Schema for Health Certificate
StructureDefinition-CWT.schema.json - JSON Schema for CBOR Web Token (CWT) Claim
StructureDefinition-SchemeInformation.schema.json - JSON Schema for Scheme Information
LogicalModels.schema.json - JSON Schema for Logical Model Enumeration Schema

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