Project-MONAI · mocsharp · Aug 16, 2023 · Aug 10, 2023 · Aug 11, 2023 · Aug 11, 2023
diff --git a/docs/api/rest/dicomweb-stow.md b/docs/api/rest/dicomweb-stow.md
@@ -23,14 +23,19 @@ interface for triggering new workflows.
 
 The *STOW-RS* service provides the following two endpoints.
 
-## POST /dicomweb/studies/[{study-instance-uid}]
+## POST /dicomweb/studies/[{study-instance-uid}/]
 
 Triggers a new workflow request with the uploaded DICOM dataset.
 
 > [!IMPORTANT]
 > Each HTTP POST request triggers a new workflow request; the service *does not* support waiting
   for additional instances like the DIMSE service.
 
+### Example Endpoints
+
+- POST /dicomweb/studies/
+- POST /dicomweb/studies/123.001.123.1.4.976.20160825112022727.3/
+
 ### Parameters
 
 #### Query Parameters:
@@ -52,30 +57,91 @@ Response Content Type: `JSON`
 
 | Code | Data Type                                                                                           | Description                                                                                  |
 | ---- | --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------         |
-| 200  | [DicomDataset](https://github.com/fo-dicom/fo-dicom/blob/development/FO-DICOM.Core/DicomDataset.cs) | All instances are received and stored succesfully.                                           |
+| 200  | [DicomDataset](https://github.com/fo-dicom/fo-dicom/blob/development/FO-DICOM.Core/DicomDataset.cs) | All instances are received and stored successfully.                                           |
 | 202  | [DicomDataset](https://github.com/fo-dicom/fo-dicom/blob/development/FO-DICOM.Core/DicomDataset.cs) | All instances are received and stored with warnings (e.g. for a mismatched StudyInstanceUID. |
 | 204  | `none`                                                                                              | No data is provided.                                                                         |
 | 400  | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807)                                    | Request contains invalid values.                                                             |
-| 415  | `none`                                                                                              | Unsupported media typ.                                                                       |
+| 415  | `none`                                                                                              | Unsupported media type.                                                                       |
 | 500  | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807)                                    | Server error.                                                                                |
 | 507  | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807)                                    | Insufficient storage.                                                                        |
 
 ---
 
 
-## POST /dicomweb/{workflow-id}/studies/[{study-instance-uid}]
+## POST /dicomweb/{workflow-id}/studies/[{study-instance-uid}/]
 
 Triggers the specified workflow with the uploaded DICOM dataset.
 
 > [!IMPORTANT]
 > Each HTTP POST request triggers a new workflow request; the service *does not* support waiting for additional instances like the DIMSE service.
 
+
+### Example Endpoints
+
+- POST /dicomweb/liver-segmentation/studies/
+- POST /dicomweb/my-awesome-workflow/studies/123.001.123.1.4.976.20160825112022727.3/
+
+### Parameters
+
+#### Query Parameters:
+
+| Name               | Type   | Description                                                                                                                                                                                                                                 |
+| ------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| workflow-id | string | The unique identifier of the workflow registered with the Workflow Manager. |
+| study-instance-uid | string | (Optional) Associate the DICOM dataset with a StudyInstanceUID. Note that the service records any mismatch between the StudyInstanceUID header and the provided value in the response as `Warning Reason (0008,1196)` = `B007`. |
+
+#### Request Body: 
+
+Supported Content-Types:
+
+- `application/dicom`
+- `multipart/related`
+
+### Responses
+
+Response Content Type: `JSON`
+
+| Code | Data Type                                                                                           | Description                                                                                  |
+| ---- | --------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| 200  | [DicomDataset](https://github.com/fo-dicom/fo-dicom/blob/development/FO-DICOM.Core/DicomDataset.cs) | All instances are received and stored successfully.                                           |
+| 202  | [DicomDataset](https://github.com/fo-dicom/fo-dicom/blob/development/FO-DICOM.Core/DicomDataset.cs) | All instances are received and stored with warnings (e.g. for a mismatched StudyInstanceUID. |
+| 204  | `none`                                                                                              | No data is provided.                                                                         |
+| 400  | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807)                                    | Request contains invalid values.                                                             |
+| 415  | `none`                                                                                              | Unsupported media type.                                                                       |
+| 500  | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807)                                    | Server error.                                                                                 |
+| 507  | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807)                                    | Insufficient storage.                                                                        |
+
+---
+
+
+## POST /dicomweb/u/{aet}/[{workflow-id}/]studies/[{study-instance-uid}/]
+
+A DICOMWeb STOW-RS endpoint associated with the specified *Virtual Application Entity*.
+
+This endpoint can either trigger workflows defined in a *Virtual Application Entity* or trigger the workflow specified in the URL segment where the latter
+takes precedence when specified.
+
+
+> [!IMPORTANT]
+> Each HTTP POST request triggers one or more workflow requests depending on number of workflows defined in the *Virtual Application Entity*;
+the service *does not* support waiting for additional instances like the DIMSE service.
+
+
+### Example Endpoints
+
+- POST /dicomweb/u/my-aet/studies/
+- POST /dicomweb/u/my-aet/studies/123.001.123.1.4.976.20160825112022727.3/
+- POST /dicomweb/u/my-aet/my-awesome-workflow/studies/
+- POST /dicomweb/u/my-aet/my-awesome-workflow/studies/123.001.123.1.4.976.20160825112022727.3/
+
+
 ### Parameters
 
 #### Query Parameters:
 
 | Name               | Type   | Description                                                                                                                                                                                                                                 |
 | ------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| aet | string | A registered Virtual Application Entity. |
 | workflow-id | string | The unique identifier of the workflow registered with the Workflow Manager. |
 | study-instance-uid | string | (Optional) Associate the DICOM dataset with a StudyInstanceUID. Note that the service records any mismatch between the StudyInstanceUID header and the provided value in the response as `Warning Reason (0008,1196)` = `B007`. |
 
@@ -92,10 +158,10 @@ Response Content Type: `JSON`
 
 | Code | Data Type                                                                                           | Description                                                                                  |
 | ---- | --------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
-| 200  | [DicomDataset](https://github.com/fo-dicom/fo-dicom/blob/development/FO-DICOM.Core/DicomDataset.cs) | All instances are received and stored succesfully.                                           |
+| 200  | [DicomDataset](https://github.com/fo-dicom/fo-dicom/blob/development/FO-DICOM.Core/DicomDataset.cs) | All instances are received and stored successfully.                                           |
 | 202  | [DicomDataset](https://github.com/fo-dicom/fo-dicom/blob/development/FO-DICOM.Core/DicomDataset.cs) | All instances are received and stored with warnings (e.g. for a mismatched StudyInstanceUID. |
 | 204  | `none`                                                                                              | No data is provided.                                                                         |
 | 400  | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807)                                    | Request contains invalid values.                                                             |
-| 415  | `none`                                                                                              | Unsupported media type                                                                       |
-| 500  | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807)                                    | Server error                                                                                 |
+| 415  | `none`                                                                                              | Unsupported media type.                                                                       |
+| 500  | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807)                                    | Server error.                                                                                 |
 | 507  | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807)                                    | Insufficient storage.                                                                        |
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -22,6 +22,7 @@
 [GitHub Milestone 0.4.0](https://github.com/Project-MONAI/monai-deploy-informatics-gateway/milestone/5)
 
 - gh-435 Fix CLI to read log dir path from NLog config file.
+- New Virtual Application Entity support for DICOMWeb STOW-RS APIs to enable dynamic endpoints.
 
 
 ## 0.3.21

diff --git a/src/Api/IInputDataPlugin.cs b/src/Api/IInputDataPlugin.cs
@@ -27,6 +27,8 @@ namespace Monai.Deploy.InformaticsGateway.Api
     /// </summary>
     public interface IInputDataPlugin
     {
+        string Name { get; }
+
         Task<(DicomFile dicomFile, FileStorageMetadata fileMetadata)> Execute(DicomFile dicomFile, FileStorageMetadata fileMetadata);
     }
 }
diff --git a/src/Api/IInputDataPluginEngine.cs b/src/Api/IInputDataPluginEngine.cs
@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+using System;
 using System.Collections.Generic;
 using System.Threading.Tasks;
 using FellowOakDicom;
@@ -28,14 +29,14 @@ namespace Monai.Deploy.InformaticsGateway.Api
     /// <list type="bullet">
     /// <item>SCP: A list of plug-ins can be configured with each AET, and each plug-in is executed in the order stored, enabling piping of the incoming data before each file is uploaded to the storage service.</item>
     /// <item>Incoming data is processed one file at a time and SHALL not wait for the entire study to arrive.</item>
-    /// <item>Plugins MUST be lightweight and not hinder the upload process.</item>
-    /// <item>Plugins SHALL not accumulate files in memory or storage for bulk processing.</item>
+    /// <item>Plug-ins MUST be lightweight and not hinder the upload process.</item>
+    /// <item>Plug-ins SHALL not accumulate files in memory or storage for bulk processing.</item>
     /// </list>
     /// </summary>
     public interface IInputDataPluginEngine
     {
         void Configure(IReadOnlyList<string> pluginAssemblies);
 
-        Task<(DicomFile dicomFile, FileStorageMetadata fileMetadata)> ExecutePlugins(DicomFile dicomFile, FileStorageMetadata fileMetadata);
+        Task<Tuple<DicomFile, FileStorageMetadata>> ExecutePlugins(DicomFile dicomFile, FileStorageMetadata fileMetadata);
     }
 }
diff --git a/src/Api/IOutputDataPlugin.cs b/src/Api/IOutputDataPlugin.cs
@@ -26,6 +26,8 @@ namespace Monai.Deploy.InformaticsGateway.Api
     /// </summary>
     public interface IOutputDataPlugin
     {
+        string Name { get; }
+
         Task<(DicomFile dicomFile, ExportRequestDataMessage exportRequestDataMessage)> Execute(DicomFile dicomFile, ExportRequestDataMessage exportRequestDataMessage);
     }
 }
diff --git a/src/Api/Monai.Deploy.InformaticsGateway.Api.csproj b/src/Api/Monai.Deploy.InformaticsGateway.Api.csproj
@@ -29,9 +29,9 @@
 
   <ItemGroup>
     <PackageReference Include="Macross.Json.Extensions" Version="3.0.0" />
-    <PackageReference Include="Microsoft.EntityFrameworkCore.Abstractions" Version="6.0.20" />
+    <PackageReference Include="Microsoft.EntityFrameworkCore.Abstractions" Version="6.0.21" />
     <PackageReference Include="Monai.Deploy.Messaging" Version="0.1.24" />
-    <PackageReference Include="Monai.Deploy.Storage" Version="0.2.16" />
+    <PackageReference Include="Monai.Deploy.Storage" Version="0.2.17" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/src/Api/Storage/FhirFileStorageMetadata.cs b/src/Api/Storage/FhirFileStorageMetadata.cs
@@ -28,7 +28,7 @@ public sealed record FhirFileStorageMetadata : FileStorageMetadata
     {
         public const string FhirSubDirectoryName = "ehr";
         public const string JsonFilExtension = ".json";
-        public const string XmlFilExtension = ".xml";
+        public const string XmlFileExtension = ".xml";
 
         /// <summary>
         /// The transaction ID of the original ACR request.
@@ -77,7 +77,7 @@ public FhirFileStorageMetadata(string transactionId, string resourceType, string
             ResourceType = resourceType;
             ResourceId = resourceId;
 
-            var fileExtension = fhirFileFormat == FhirStorageFormat.Json ? JsonFilExtension : XmlFilExtension;
+            var fileExtension = fhirFileFormat == FhirStorageFormat.Json ? JsonFilExtension : XmlFileExtension;
             File = new StorageObjectMetadata(fileExtension)
             {
                 TemporaryPath = string.Join(PathSeparator, transactionId, DataTypeDirectoryName, $"{Guid.NewGuid()}{fileExtension}"),

diff --git a/src/Api/Test/Storage/FhirFileStorageMetadataTest.cs b/src/Api/Test/Storage/FhirFileStorageMetadataTest.cs
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021-2022 MONAI Consortium
+ * Copyright 2021-2023 MONAI Consortium
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -24,7 +24,7 @@ namespace Monai.Deploy.InformaticsGateway.Api.Test
     public class FhirFileStorageMetadataTest
     {
         [Theory(DisplayName = "Shall return FHIR resource upload path")]
-        [InlineData(FhirStorageFormat.Xml, FhirFileStorageMetadata.XmlFilExtension)]
+        [InlineData(FhirStorageFormat.Xml, FhirFileStorageMetadata.XmlFileExtension)]
         [InlineData(FhirStorageFormat.Json, FhirFileStorageMetadata.JsonFilExtension)]
         public void GivenFhirFileStorageMetadataWithSpecifiedFormat_ExpectToHaveCorrectFileExtension(FhirStorageFormat fileFormat, string fileExtension)
         {