WHO SMART Trust
1.6.0 - active

WHO SMART Trust - Downloaded Version 1.6.0 See the Directory of published versions

## DAK API Documentation Hub

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

## Table of Contents

### 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-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-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-Domains.schema.json - JSON Schema for WHO GDHCN Trust Domains Schema
- ValueSet-Domains.jsonld - JSON-LD vocabulary for WHO GDHCN Trust Domains 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-Transactions.schema.json - JSON Schema for WHO GDHCN Transaction Codes Schema
- ValueSet-Transactions.jsonld - JSON-LD vocabulary for WHO GDHCN Transaction Codes 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-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-WHORegionalOffices.schema.json - JSON Schema for WHO Regional Offices Schema
- ValueSet-WHORegionalOffices.jsonld - JSON-LD vocabulary for WHO Regional Offices 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-ConnectionTypes.schema.json - JSON Schema for WHO GDHCN Connection Types Schema
- ValueSet-ConnectionTypes.jsonld - JSON-LD vocabulary for WHO GDHCN Connection 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-PayloadTypes.schema.json - JSON Schema for WHO GDHCN Payload Types Schema
- ValueSet-PayloadTypes.jsonld - JSON-LD vocabulary for WHO GDHCN Payload Types 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-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

#### ​LogicalModels.schema.json

Enumeration of all available Logical Model schemas

##### Available Endpoints:

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

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

🩺 FHIR 📄 JSON Schema 🏷️ Displays 🗂️ JSON-LD 🔗 OpenAPI

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

🩺 FHIR 📄 JSON Schema 🏷️ Displays 🗂️ JSON-LD 🔗 OpenAPI

#### WHO GDHCN Trust Domains Schema

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

🩺 FHIR 📄 JSON Schema 🏷️ Displays 🗂️ JSON-LD 🔗 OpenAPI

#### WHO GDHCN Trust Domains - UAT Schema

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

🩺 FHIR 📄 JSON Schema 🏷️ Displays 🗂️ JSON-LD 🔗 OpenAPI

#### WHO GDHCN Transaction Codes Schema

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

🩺 FHIR 📄 JSON Schema 🏷️ Displays 🗂️ JSON-LD 🔗 OpenAPI

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

🩺 FHIR 📄 JSON Schema 🏷️ Displays 🗂️ JSON-LD 🔗 OpenAPI

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

🩺 FHIR 📄 JSON Schema 🏷️ Displays 🗂️ JSON-LD 🔗 OpenAPI

#### WHO Regional Offices Schema

JSON Schema for WHO Regional Offices ValueSet codes. Generated from FHIR expansions using IRI format.

🩺 FHIR 📄 JSON Schema 🏷️ Displays 🗂️ JSON-LD 🔗 OpenAPI

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

🩺 FHIR 📄 JSON Schema 🏷️ Displays 🗂️ JSON-LD 🔗 OpenAPI

#### WHO GDHCN Connection Types Schema

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

🩺 FHIR 📄 JSON Schema 🏷️ Displays 🗂️ JSON-LD 🔗 OpenAPI

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

🩺 FHIR 📄 JSON Schema 🏷️ Displays 🗂️ JSON-LD 🔗 OpenAPI

#### WHO GDHCN Payload Types Schema

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

🩺 FHIR 📄 JSON Schema 🏷️ Displays 🗂️ JSON-LD 🔗 OpenAPI

#### WHO GDHCN Trust Domains - DEV Schema

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

🩺 FHIR 📄 JSON Schema 🏷️ Displays 🗂️ JSON-LD 🔗 OpenAPI

#### WHO GDHCN Trust Network Participant Schema

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

🩺 FHIR 📄 JSON Schema 🏷️ Displays 🗂️ JSON-LD 🔗 OpenAPI

### Logical Model Schemas (5 available)

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

#### Health Certificate

Logical Model for the HCERT

🩺 FHIR 📄 JSON Schema 🔗 OpenAPI

#### Scheme Information

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

🩺 FHIR 📄 JSON Schema 🔗 OpenAPI

#### 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

🩺 FHIR 📄 JSON Schema 🔗 OpenAPI

#### CBOR Web Token (CWT) Claim

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

🩺 FHIR 📄 JSON Schema 🔗 OpenAPI

#### COSE Headers (DRAFT)

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

🩺 FHIR 📄 JSON Schema 🔗 OpenAPI

### OpenAPI Documentation

Complete API specification documentation for all available endpoints:

#### ValueSet-KeyUsage Endpoints

API endpoints for WHO GDHCN Key Usage ValueSet Schema

📄 JSON Schema 🗂️ JSON-LD 🔗 OpenAPI

#### ValueSet-Participants-DEV Endpoints

API endpoints for WHO GDHCN Trust Network Participant - DEV Schema

📄 JSON Schema 🗂️ JSON-LD 🔗 OpenAPI

#### ValueSet-Domains Endpoints

API endpoints for WHO GDHCN Trust Domains Schema

📄 JSON Schema 🗂️ JSON-LD 🔗 OpenAPI

#### ValueSet-Domains-UAT Endpoints

API endpoints for WHO GDHCN Trust Domains - UAT Schema

📄 JSON Schema 🗂️ JSON-LD 🔗 OpenAPI

#### ValueSet-Transactions Endpoints

API endpoints for WHO GDHCN Transaction Codes Schema

📄 JSON Schema 🗂️ JSON-LD 🔗 OpenAPI

#### ValueSet-Actors Endpoints

API endpoints for WHO GDHCN Actor ValueSet of actor codes Schema

📄 JSON Schema 🗂️ JSON-LD 🔗 OpenAPI

#### ValueSet-KeyUsage-DEV Endpoints

API endpoints for WHO GDHCN Key Usage ValueSet - DEV Schema

📄 JSON Schema 🗂️ JSON-LD 🔗 OpenAPI

#### ValueSet-WHORegionalOffices Endpoints

API endpoints for WHO Regional Offices Schema

📄 JSON Schema 🗂️ JSON-LD 🔗 OpenAPI

#### ValueSet-KeyUsage-UAT Endpoints

API endpoints for WHO GDHCN Key Usage ValueSet - UAT Schema

📄 JSON Schema 🗂️ JSON-LD 🔗 OpenAPI

#### ValueSet-ConnectionTypes Endpoints

API endpoints for WHO GDHCN Connection Types Schema

📄 JSON Schema 🗂️ JSON-LD 🔗 OpenAPI

#### ValueSet-Participants-UAT Endpoints

API endpoints for WHO GDHCN Trust Network Participant - UAT Schema

📄 JSON Schema 🗂️ JSON-LD 🔗 OpenAPI

#### ValueSet-PayloadTypes Endpoints

API endpoints for WHO GDHCN Payload Types Schema

📄 JSON Schema 🗂️ JSON-LD 🔗 OpenAPI

#### ValueSet-Domains-DEV Endpoints

API endpoints for WHO GDHCN Trust Domains - DEV Schema

📄 JSON Schema 🗂️ JSON-LD 🔗 OpenAPI

#### ValueSet-Participants Endpoints

API endpoints for WHO GDHCN Trust Network Participant Schema

📄 JSON Schema 🗂️ JSON-LD 🔗 OpenAPI

#### StructureDefinition-HCert Endpoints

API endpoints for Health Certificate

📄 JSON Schema 🔗 OpenAPI

#### StructureDefinition-SchemeInformation Endpoints

API endpoints for Scheme Information

📄 JSON Schema 🔗 OpenAPI

#### StructureDefinition-CWTPayload Endpoints

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

📄 JSON Schema 🔗 OpenAPI

#### StructureDefinition-CWT Endpoints

API endpoints for CBOR Web Token (CWT) Claim

📄 JSON Schema 🔗 OpenAPI

#### StructureDefinition-COSEHeader Endpoints

API endpoints for COSE Headers (DRAFT)

📄 JSON Schema 🔗 OpenAPI

#### ValueSets Enumeration Endpoint

Complete list of all available ValueSet schemas

📄 JSON Schema 🔗 OpenAPI

#### LogicalModels Enumeration Endpoint

Complete list of all available Logical Model schemas

📄 JSON Schema 🔗 OpenAPI

#### StructureDefinition-COSEHeader API

OpenAPI specification for StructureDefinition-COSEHeader

📖 Documentation 🔗 OpenAPI Spec

#### ValueSet-PayloadTypes API

OpenAPI specification for ValueSet-PayloadTypes

📖 Documentation 🔗 OpenAPI Spec

#### StructureDefinition-CWT API

OpenAPI specification for StructureDefinition-CWT

📖 Documentation 🔗 OpenAPI Spec

#### ValueSet-Participants-DEV API

OpenAPI specification for ValueSet-Participants-DEV

📖 Documentation 🔗 OpenAPI Spec

#### ValueSet-KeyUsage-UAT API

OpenAPI specification for ValueSet-KeyUsage-UAT

📖 Documentation 🔗 OpenAPI Spec

#### ValueSet-KeyUsage-DEV API

OpenAPI specification for ValueSet-KeyUsage-DEV

📖 Documentation 🔗 OpenAPI Spec

#### StructureDefinition-CWTPayload API

OpenAPI specification for StructureDefinition-CWTPayload

📖 Documentation 🔗 OpenAPI Spec

#### ValueSet-WHORegionalOffices API

OpenAPI specification for ValueSet-WHORegionalOffices

📖 Documentation 🔗 OpenAPI Spec

#### StructureDefinition-HCert API

OpenAPI specification for StructureDefinition-HCert

📖 Documentation 🔗 OpenAPI Spec

#### ValueSet-Transactions API

OpenAPI specification for ValueSet-Transactions

📖 Documentation 🔗 OpenAPI Spec

#### ValueSet-Domains-DEV API

OpenAPI specification for ValueSet-Domains-DEV

📖 Documentation 🔗 OpenAPI Spec

#### ValueSet-Participants API

OpenAPI specification for ValueSet-Participants

📖 Documentation 🔗 OpenAPI Spec

#### ValueSet-Domains API

OpenAPI specification for ValueSet-Domains

📖 Documentation 🔗 OpenAPI Spec

#### ValueSet-Participants-UAT API

OpenAPI specification for ValueSet-Participants-UAT

📖 Documentation 🔗 OpenAPI Spec

#### ValueSet-Domains-UAT API

OpenAPI specification for ValueSet-Domains-UAT

📖 Documentation 🔗 OpenAPI Spec

#### ValueSet-Actors API

OpenAPI specification for ValueSet-Actors

📖 Documentation 🔗 OpenAPI Spec

#### ValueSet-KeyUsage API

OpenAPI specification for ValueSet-KeyUsage

📖 Documentation 🔗 OpenAPI Spec

#### StructureDefinition-SchemeInformation API

OpenAPI specification for StructureDefinition-SchemeInformation

📖 Documentation 🔗 OpenAPI Spec

#### ValueSet-ConnectionTypes API

OpenAPI specification for ValueSet-ConnectionTypes

📖 Documentation 🔗 OpenAPI Spec

#### openapi API

OpenAPI specification for openapi

​ 🔗 OpenAPI Spec

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