Skip to content

REST APIs

This section documents the REST interfaces of the Kastoria Health imaging services: the DICOMweb Studies Service, the viewer-token authorization that gates its read interfaces, and the SMART on FHIR service that launches the viewer and issues those tokens.

DICOMweb

The Kastoria Health DICOMweb Service exposes medical imaging data over the DICOMweb REST API as defined in DICOM PS3.18. It supports the Studies Service transactions:

Transaction Operation Documentation
Store STOW-RS STOW-RS — Store Instances
Retrieve WADO-RS WADO-RS — Retrieve Instances
Search QIDO-RS QIDO-RS — Search for Instances

Note: The specifics of configuring the DICOMweb service will be provided in the associated Docker image page.

Service base URL

The service base URL follows the pattern:

https://{host}/

The service also provides two endpoints outside the Studies Service:

Method Path Description
GET /health Liveness check
GET / Basic server information

Common conventions

  • DICOM JSON — Metadata and search responses use the DICOM JSON format (PS3.18 Annex F), returned as application/dicom+json. Attribute names are encoded as either a DICOM keyword (PatientID) or an Attribute ID (00100020).
  • Transfer syntaxes — A fixed set of transfer syntaxes is recognized for ingest-time and retrieve-time transcoding. See Transfer syntax support.
  • Character sets — All DICOM-defined character sets are supported.

JWT Authorization

Authentication of the DICOMweb read interfaces (WADO-RS, QIDO-RS) with viewer bearer tokens: the token format and claims, study scoping, the 401/403 responses, and client guidance. See JWT Authorization.

SMART on FHIR

The smart-launch-api service implements the SMART on FHIR App Launch EHR Launch sequence: an EHR launches the OHIF viewer with study context, and the service mints the viewer tokens the DICOMweb read interfaces accept. See SMART on FHIR — smart-launch-api.

Examples in this section

The pages in this section contain worked examples — requests, response bodies, redirects, and the Warning header fields the DICOMweb service uses to report partial results.