fix(multiframe): metadata handling of NM studies and loading order (#4554)

extensions/default/src/DicomJSONDataSource/index.js

@@ -93,7 +93,7 @@ function createDicomJSONApi(dicomJsonConfig) {
 
             const { query } = qs.parseUrl(instance.url);
 
-            // Add imageId specific mapping to this data as the URL isn't necessarliy WADO-URI.
+            // Add imageId specific mapping to this data as the URL isn't necessarily WADO-URI.
             metadataProvider.addImageIdToUIDs(imageId, {
               StudyInstanceUID,
               SeriesInstanceUID,

extensions/default/src/DicomLocalDataSource/index.js

@@ -142,9 +142,7 @@ function createDicomLocalApi(dicomLocalConfig) {
           study.series.forEach(aSeries => {
             const { SeriesInstanceUID } = aSeries;
 
-            const isMultiframe = aSeries.instances[0].NumberOfFrames > 1;
-
-            aSeries.instances.forEach((instance, index) => {
+            aSeries.instances.forEach(instance => {
               const {
                 url: imageId,
                 StudyInstanceUID,
@@ -153,14 +151,22 @@ function createDicomLocalApi(dicomLocalConfig) {
               } = instance;
 
               instance.imageId = imageId;
-
-              // Add imageId specific mapping to this data as the URL isn't necessarily WADO-URI.
-              metadataProvider.addImageIdToUIDs(imageId, {
-                StudyInstanceUID,
-                SeriesInstanceUID,
-                SOPInstanceUID,
-                frameIndex: isMultiframe ? index : 1,
-              });
+              const numberOfFrames = instance.NumberOfFrames || 1;
+              // Process all frames consistently, whether single or multiframe
+              for (let i = 0; i < numberOfFrames; i++) {
+                const frameNumber = i + 1;
+                const frameImageId = implementation.getImageIdsForInstance({
+                  instance,
+                  frame: frameNumber,
+                });
+                // Add imageId specific mapping to this data as the URL isn't necessarily WADO-URI.
+                metadataProvider.addImageIdToUIDs(frameImageId, {
+                  StudyInstanceUID,
+                  SeriesInstanceUID,
+                  SOPInstanceUID,
+                  frameNumber: numberOfFrames > 1 ? frameNumber : undefined,
+                });
+              }
             });
 
             DicomMetadataStore._broadcastEvent(EVENTS.INSTANCES_ADDED, {
@@ -209,9 +215,11 @@ function createDicomLocalApi(dicomLocalConfig) {
       return imageIds;
     },
     getImageIdsForInstance({ instance, frame }) {
-      if (instance.imageId) {
-        return instance.imageId;
-      }
+      // Important: Never use instance.imageId because it might be multiframe,
+      // which would make it an invalid imageId.
+      // if (instance.imageId) {
+      //   return instance.imageId;
+      // }
 
       const { StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID } = instance;
       const storedInstance = DicomMetadataStore.getInstance(

extensions/default/src/DicomWebDataSource/index.js

@@ -434,23 +434,32 @@ function createDicomWebApi(dicomWebConfig, servicesManager) {
           instance.wadoRoot = dicomWebConfig.wadoRoot;
           instance.wadoUri = dicomWebConfig.wadoUri;
 
-          const imageId = implementation.getImageIdsForInstance({
-            instance,
-          });
+          const { StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID } = instance;
+
+          const numberOfFrames = instance.NumberOfFrames || 1;
+          // Process all frames consistently, whether single or multiframe
+          for (let i = 0; i < numberOfFrames; i++) {
+            const frameNumber = i + 1;
+            const frameImageId = implementation.getImageIdsForInstance({
+              instance,
+              frame: frameNumber,
+            });
+            // Add imageId specific mapping to this data as the URL isn't necessarily WADO-URI.
+            metadataProvider.addImageIdToUIDs(frameImageId, {
+              StudyInstanceUID,
+              SeriesInstanceUID,
+              SOPInstanceUID,
+              frameNumber: numberOfFrames > 1 ? frameNumber : undefined,
+            });
+          }
 
           // Adding imageId to each instance
           // Todo: This is not the best way I can think of to let external
           // metadata handlers know about the imageId that is stored in the store
-          instance.imageId = imageId;
-
-          // Adding UIDs to metadataProvider
-          // Note: storing imageURI in metadataProvider since stack viewports
-          // will use the same imageURI
-          metadataProvider.addImageIdToUIDs(imageId, {
-            StudyInstanceUID,
-            SeriesInstanceUID: instance.SeriesInstanceUID,
-            SOPInstanceUID: instance.SOPInstanceUID,
+          const imageId = implementation.getImageIdsForInstance({
+            instance,
           });
+          instance.imageId = imageId;
         });
 
         DicomMetadataStore.addInstances(naturalizedInstances, madeInClient);