SMART Product Catalog
0.2.0 - ci-build

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

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

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

Status for a Product Schema

JSON Schema for Status for a Product ValueSet codes. Generated from FHIR expansions using IRI format.

AttributeType for a Product Schema

JSON Schema for AttributeType for a Product ValueSet codes. Generated from FHIR expansions using IRI format.

Product Relationships Schema

JSON Schema for Product Relationships ValueSet codes. Generated from FHIR expansions using IRI format.

Logical Model Schemas (2 available)

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

Product

A Product represents a physical item or set of items which can be held in inventory, ordered, exchanged, dispensed or other utilized within the health system, clinical and supply chain workflows.

Product Authorization

A record of authorization or compliance for one or more Products with a set of regulatory, policy, (pre-)qualification, or legal requirements.

OpenAPI Documentation

Complete API specification documentation for all available endpoints:

ValueSet-Status Endpoints

API endpoints for Status for a Product Schema

ValueSet-AttributeType Endpoints

API endpoints for AttributeType for a Product Schema

ValueSet-ProductRelationship Endpoints

API endpoints for Product Relationships Schema

StructureDefinition-Product Endpoints

API endpoints for Product

StructureDefinition-ProductAuthorization Endpoints

API endpoints for Product Authorization

ValueSets Enumeration Endpoint

Complete list of all available ValueSet schemas

LogicalModels Enumeration Endpoint

Complete list of all available Logical Model schemas

StructureDefinition-Product API

OpenAPI specification for StructureDefinition-Product

ValueSet-AttributeType API

OpenAPI specification for ValueSet-AttributeType

StructureDefinition-ProductAuthorization API

OpenAPI specification for StructureDefinition-ProductAuthorization

ValueSet-ProductRelationship API

OpenAPI specification for ValueSet-ProductRelationship

ValueSet-Status API

OpenAPI specification for ValueSet-Status

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.