3.12 to 3.13 Migration Guide
This guide covers changes when upgrading from OHIF version 3.12 to version 3.13.
The largest changes in 3.13 are infrastructure-level:
- Package Manager — the monorepo moves from
yarn + lerna to pnpm workspaces, with new install/run commands
and a
workspace:*syntax for cross-package dependencies. - Build Tooling — Webpack is replaced with Rspack v2 across the app and every extension/mode, with new plugin imports and faster build commands.
- Node Version — the minimum Node.js runtime is now 24.
- SegmentationService — the
removeSegmentationRepresentationsmethod was renamed. - DICOM video viewport — the
@ohif/extension-dicom-video.viewportModule.dicom-videonamespace was removed; route DICOM video display sets through the Cornerstone viewport. - Deployment recipes — the Keycloak recipes
now require a
.envfile and a generated client secret beforedocker compose up, and the nginx recipes no longer send wildcard CORS headers (cross-origin deployments must set an explicit origin).
SegmentationService
The SegmentationService method for removing segmentation representations from a viewport has been renamed to better reflect its behavior.
Package Manager (pnpm)
OHIF 3.13 replaces the yarn + lerna toolchain with pnpm workspaces.
Playwright Viewport Screenshots
Playwright tests whose assertions concern the viewport (rendering, overlays,
Build Tooling (Rspack)
OHIF 3.13 replaces Webpack with Rspack v2 as the
WorkList
3.13 ships a new study-list at /. The 3.12 study-list code has been preserved and renamed to LegacyWorkList; what is now mounted at / by default is the new WorkList.
formatDICOMDate
formatDICOMDate (exported from @ohif/ui-next) now takes its optional
Node Version
OHIF 3.13 bumps the minimum supported Node.js runtime from 18 to 24.
Study List paging
The study-list data fetch in DataSourceWrapper was simplified. This affects both the new WorkList and the LegacyWorkList, since both receive their studies from DataSourceWrapper.
Color System
This guide covers migrating from legacy color classes to the new ui-next color system.
Customization URL & config lockdown
3.13 adds the ability to load customizations at runtime from the
Escape / cancelActiveOperation hotkey
The default Escape hotkey behavior has been consolidated. Previously the
DICOM video viewport
The @ohif/extension-dicom-video extension no longer provides its own viewport module in 3.13. DICOM video rendering is handled by the Cornerstone viewport, which supports Cornerstone3D video viewports directly.
Deployment recipes
The deployment recipes under platform/app/.recipes no longer ship working
Mode panel lists & customization
3.13 lets a mode's sidebars be modified at runtime through the customization
Mode extensibility
3.13 makes the segmentation, tmtv and basic-test modes extend the basic