WHO SMART Trust
1.1.6 - CI Build
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
This page provides access to Data Access Kit (DAK) API documentation and schemas.
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.
These endpoints provide lists of all available schemas and vocabularies of each type:
Enumeration of all available ValueSet schemas
Enumeration of all available Logical Model schemas
JSON Schema definitions for FHIR ValueSets, providing structured enumeration of allowed code values:
JSON Schema for WHO GDHCN Actor ValueSet of actor codes ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for WHO GDHCN Payload Types ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for WHO GDHCN Key Usage ValueSet ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for WHO GDHCN Connection Types ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for WHO GDHCN Key Usage ValueSet - UAT ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for WHO GDHCN Trust Domains - UAT ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for WHO GDHCN Trust Domains - DEV ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for WHO GDHCN Trust Domains ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for WHO GDHCN Transaction Codes ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for WHO GDHCN Trust Network Participant - UAT ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for WHO GDHCN Trust Network Participant ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for WHO GDHCN Trust Network Participant - DEV ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for WHO GDHCN Key Usage ValueSet - DEV ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema definitions for FHIR Logical Models, defining structured data elements and their relationships:
Logical Model for Data elements in CBOR Web Token (CWT) https://www.iana.org/assignments/cwt/cwt.xhtml
Data elements for COSE Headers https://www.iana.org/assignments/cose/cose.xhtml#header-parameters
Logical Model for CBOR Web Token (CWT) Payload Logical Modelin CWT Payload https://www.iana.org/assignments/cwt/cwt.xhtml
Logical Model for Information on the trusted list and its issuing scheme
Complete API specification documentation for all available endpoints:
API endpoints for WHO GDHCN Actor ValueSet of actor codes Schema
API endpoints for WHO GDHCN Payload Types Schema
API endpoints for WHO GDHCN Key Usage ValueSet Schema
API endpoints for WHO GDHCN Connection Types Schema
API endpoints for WHO GDHCN Key Usage ValueSet - UAT Schema
API endpoints for WHO GDHCN Trust Domains - UAT Schema
API endpoints for WHO GDHCN Trust Domains - DEV Schema
API endpoints for WHO GDHCN Trust Domains Schema
API endpoints for WHO GDHCN Transaction Codes Schema
API endpoints for WHO GDHCN Trust Network Participant - UAT Schema
API endpoints for WHO GDHCN Trust Network Participant Schema
API endpoints for WHO GDHCN Trust Network Participant - DEV Schema
API endpoints for WHO GDHCN Key Usage ValueSet - DEV Schema
API endpoints for CBOR Web Token (CWT) Claim
API endpoints for COSE Headers (DRAFT)
API endpoints for CBOR Web Token (CWT) Payload (Common)
API endpoints for Scheme Information
Complete list of all available ValueSet schemas
Complete list of all available Logical Model schemas
OpenAPI specification for ValueSet-PayloadTypes
OpenAPI specification for ValueSet-Participants
OpenAPI specification for Requirements-DistributePKIMaterialAPI
OpenAPI specification for StructureDefinition-CWT
OpenAPI specification for ValueSet-Domains-DEV
OpenAPI specification for ValueSet-Domains-UAT
OpenAPI specification for ValueSet-Participants-DEV
OpenAPI specification for StructureDefinition-COSEHeader
OpenAPI specification for ValueSet-Participants-UAT
OpenAPI specification for ValueSet-Transactions
OpenAPI specification for ValueSet-KeyUsage-DEV
OpenAPI specification for Requirements-PublishPKIMaterialAPI
OpenAPI specification for ValueSet-KeyUsage-UAT
OpenAPI specification for StructureDefinition-HCert
OpenAPI specification for ValueSet-ConnectionTypes
OpenAPI specification for StructureDefinition-SchemeInformation
OpenAPI specification for StructureDefinition-CWTPayload
OpenAPI specification for Requirements-ReceivePKUMaterialAPI
OpenAPI specification for Requirements-RetrievePKIMaterialAPI
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:
The JSON-LD vocabularies provide semantic web integration for ValueSet enumerations. Each vocabulary includes:
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.
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.