API Documentation
Explore all available endpoints, request / response schemas, and try requests directly in the browser.
Swagger UIAuthentication
All endpoints require a valid Azure AD bearer token. Register your application in Azure AD and request an access token via the OAuth 2.0 client credentials flow.
Azure AD / JWTHealth Check
Verify the API is running. No authentication required — suitable for load balancer and uptime probes.
GET /healthGetting Started
Obtain an access token, then call GET /api/v1/client/me to verify your identity, then POST /api/v1/lab/results to retrieve lab results.
Available Endpoints
| Method | Endpoint | Auth | Description |
|---|---|---|---|
GET |
/health |
None | Health check probe — returns Healthy with HTTP 200. |
GET |
/api/v1/client/me |
Bearer | Returns the authenticated client details and mapped account codes. |
POST |
/api/v1/lab/results |
Bearer | Returns a paginated list of patient lab results filtered by account, patient IDs, and date range. |
GET |
/api/v1/lab/result |
Bearer | Returns a single patient result by barcode and orderId query parameters. |
POST |
/api/v1/lab/pdf-results |
Bearer | Returns PDF result files for the supplied list of barcodes. Links valid for 15 minutes. |
Rate Limits & Versioning
| Rate limit | 100 requests / minute per client IP (HTTP 429 when exceeded) |
|---|---|
| API version | Specified in the URL path — /api/v1/ — or via the X-Api-Version header |
| Formats | JSON (default) and XML — use the Accept header to select |