Introduction
NMS API Platform
The NMS API Platform provides a comprehensive set of endpoints for managing the end-to-end medical supply chain for National Medical Stores (NMS) in Uganda — from order creation and procurement planning through delivery tracking, patient statistics, and analytics reporting.
Base URL
All requests should be routed through the API Gateway unless you are performing direct health checks on individual microservices.
API Modules
The API is organized into the following functional modules:
Key Concepts
Financial Year & Cycle
All orders, deliveries, and statistics are scoped by a financial year (e.g., 2023/2024) and a cycle number (e.g., 1). These are the primary filters across all endpoints.
Facility Code
Each health facility in Uganda has a unique facility code (e.g., HF0124 for BUBULO HCIV) assigned by the NMS. This code is used to scope all facility-level operations.
Template Code
Program orders are identified by a template code that encodes the facility, financial year, cycle, and order type (e.g., HF0124-2023/24Cycle1-LAB). This is the primary identifier for order lifecycle operations.
Authentication
This API uses JWT Bearer Token authentication. See the Authentication Guide for details.
