feat: support includefield

- See: https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_8.3.4.3
- Add `IncludeFieldsFactory` to handle every level's fields

api/dicom-web/controller/QIDO-RS/service/QIDO-RS.service.js

@@ -39,6 +39,17 @@ class QidoRsService {
         this.skip_ = parseInt(this.request.query.offset) || 0;
         delete this.request.query["offset"];
 
+        /**
+         * @private
+         */
+        this.includeFields_ = this.request.query["includefield"] || [];
+
+        if (this.includeFields_.includes("all")) {
+            this.includeFields_ = ["all"];
+        }
+
+        delete this.request.query["includefield"];
+
         this.initQuery_();
     }
 
@@ -65,6 +76,7 @@ class QidoRsService {
                 query: this.query,
                 skip: this.skip_,
                 limit: this.limit_,
+                includeFields: this.includeFields_,
                 retrieveBaseUrl: `${dicomWebService.getBasicURL()}/studies`,
                 requestParams: this.request.params
             };

api/dicom-web/qido-rs.route.js

@@ -1,9 +1,52 @@
 const express = require("express");
 const Joi = require("joi");
-const { validateParams, intArrayJoi } = require("../validator");
+const { validateParams, intArrayJoi, stringArrayJoi } = require("../validator");
 const router = express();
+const {
+    dictionary
+} = require("../../models/DICOM/dicom-tags-dic");
+
+const KEYWORD_KEYS = Object.keys(dictionary.keyword);
+const HEX_KEYS = Object.keys(dictionary.tag);
 
 //#region QIDO-RS
+const queryValidation = {
+    limit: Joi.number().integer().min(1).max(100),
+    offset: Joi.number().integer().min(0),
+    includefield: stringArrayJoi.stringArray().items(
+        Joi.string().custom(
+            (attribute, helper) => {
+                if (!isValidAttribute(attribute)) {
+                    return helper.message(`Invalid DICOM attribute: ${attribute}, please enter valid keyword or tag`);
+                }
+                return convertKeywordToHex(attribute);
+            }
+        )
+    ).single()
+};
+
+/**
+ * 
+ * @param {string} attribute 
+ */
+function isValidAttribute(attribute) {
+    if (KEYWORD_KEYS.indexOf(attribute) >= 0 ||
+        HEX_KEYS.indexOf(attribute) >= 0 ||
+        attribute === "all") {
+
+        return true;
+    }
+
+    return false;
+}
+
+function convertKeywordToHex(attribute) {
+    if (KEYWORD_KEYS.indexOf(attribute) >= 0) {
+        return dictionary.keyword[attribute];
+    }
+    return attribute;
+}
+
 
 /**
  *  @openapi
@@ -32,7 +75,9 @@ const router = express();
  *                  allOf:
  *                  - $ref: "#/components/schemas/StudyRequiredMatchingAttributes"
  */
-router.get("/studies", require("./controller/QIDO-RS/queryAllStudies"));
+router.get("/studies", validateParams(queryValidation, "query", {
+    allowUnknown: true
+}), require("./controller/QIDO-RS/queryAllStudies"));
 
 /**
  *  @openapi
@@ -66,7 +111,9 @@ router.get("/studies", require("./controller/QIDO-RS/queryAllStudies"));
  *                  - $ref: "#/components/schemas/SeriesRequiredMatchingAttributes"
  */
 router.get(
-    "/studies/:studyUID/series",
+    "/studies/:studyUID/series", validateParams(queryValidation, "query", {
+        allowUnknown: true
+    }),
     require("./controller/QIDO-RS/queryStudies-Series")
 );
 
@@ -105,7 +152,9 @@ router.get(
  *                  - $ref: "#/components/schemas/InstanceRequiredMatchingAttributes"
  */
 router.get(
-    "/studies/:studyUID/instances",
+    "/studies/:studyUID/instances", validateParams(queryValidation, "query", {
+        allowUnknown: true
+    }),
     require("./controller/QIDO-RS/queryStudies-Instances")
 );
 
@@ -145,7 +194,9 @@ router.get(
  *                  - $ref: "#/components/schemas/InstanceRequiredMatchingAttributes"
  */
 router.get(
-    "/studies/:studyUID/series/:seriesUID/instances",
+    "/studies/:studyUID/series/:seriesUID/instances", validateParams(queryValidation, "query", {
+        allowUnknown: true
+    }),
     require("./controller/QIDO-RS/queryStudies-Series-Instance")
 );
 
@@ -181,7 +232,9 @@ router.get(
  * 
  */
 router.get(
-    "/series",
+    "/series", validateParams(queryValidation, "query", {
+        allowUnknown: true
+    }),
     require("./controller/QIDO-RS/queryAllSeries")
 );
 
@@ -219,7 +272,9 @@ router.get(
  *                  - $ref: "#/components/schemas/InstanceRequiredMatchingAttributes"
  */
 router.get(
-    "/instances",
+    "/instances", validateParams(queryValidation, "query", {
+        allowUnknown: true
+    }),
     require("./controller/QIDO-RS/queryAllInstances")
 );
 

api/validator.js

@@ -6,14 +6,36 @@ const intArrayJoi = Joi.extend((joi) => {
         type: "intArray",
         base: joi.array(),
         coerce: (value, helper) => {
-            let item = (value.split ? value.split(',').map(v=> parseInt(v)) : parseInt(value));
+            let item = (value.split ? value.split(',').map(v => parseInt(v)) : parseInt(value));
             return {
                 value: item
             };
         }
     };
 });
 
+const stringArrayJoi = Joi.extend((joi) => {
+    return {
+        type: "stringArray",
+        base: joi.array(),
+        coerce: (value, helper) => {
+            if (lodash.isArray(value)) {
+                value = value.join(",");
+            }
+
+            if (typeof value !== 'string') {
+                return {
+                    value: value
+                };
+            }
+
+            return {
+                value: value.replace(/^,+|,+$/mg, '').split(',')
+            };
+        }
+    };
+});
+
 /**
  * @param {Object} paramSchema the valid scheama
  * @param {string} item body , query , param
@@ -81,3 +103,4 @@ module.exports = {
     intArrayJoi: intArrayJoi
 };
 module.exports.validateByJoi = validateByJoi;
+module.exports.stringArrayJoi = stringArrayJoi;

models/mongodb/models/dicom.js

@@ -5,11 +5,8 @@ const {
     dicomJsonAttributeDASchema,
     getVRSchema
 } = require("../schema/dicomJsonAttribute");
-const { getStoreDicomFullPath } = require("../service");
+const { getStoreDicomFullPath, IncludeFieldsFactory } = require("../service");
 const { logger } = require("../../../utils/logs/log");
-const { getStudyLevelFields } = require("./dicomStudy");
-const { getSeriesLevelFields } = require("./dicomSeries");
-const { tagsOfRequiredMatching } = require("../../DICOM/dicom-tags-mapping");
 
 let dicomModelSchema = new mongoose.Schema(
     {
@@ -318,17 +315,15 @@ async function updateStudyNumberOfStudyRelatedInstance(doc) {
  * @returns 
  */
 dicomModelSchema.statics.getDicomJson = async function (queryOptions) {
-    let studyFields = getStudyLevelFields();
-    let seriesFields = getSeriesLevelFields();
-    let instanceFields = getInstanceLevelFields();
+
+    let includeFieldsFactory = new IncludeFieldsFactory(queryOptions.includeFields);
+    let instanceFields = includeFieldsFactory.getInstanceLevelFields();
 
     try {
 
         let docs = await mongoose
         .model("dicom")
         .find(queryOptions.query, {
-            ...studyFields,
-            ...seriesFields,
             ...instanceFields
         })
         .setOptions({
@@ -359,14 +354,6 @@ dicomModelSchema.statics.getDicomJson = async function (queryOptions) {
 
 };
 
-function getInstanceLevelFields() {
-    let fields = {};
-    for (let tag in tagsOfRequiredMatching.Instance) {
-        fields[tag] = 1;
-    }
-    return fields;
-}
-
 /**
  * 
  * @param {object} iParam 

models/mongodb/models/dicomSeries.js

@@ -2,11 +2,7 @@ const mongoose = require("mongoose");
 const _ = require("lodash");
 const { tagsNeedStore } = require("../../DICOM/dicom-tags-mapping");
 const { getVRSchema } = require("../schema/dicomJsonAttribute");
-const { getStoreDicomFullPathGroup } = require("../service");
-const {
-    tagsOfRequiredMatching
-} = require("../../DICOM/dicom-tags-mapping");
-const { getStudyLevelFields } = require("./dicomStudy");
+const { getStoreDicomFullPathGroup, IncludeFieldsFactory } = require("../service");
 
 let dicomSeriesSchema = new mongoose.Schema(
     {
@@ -65,28 +61,20 @@ dicomSeriesSchema.index({
     "0020000E": 1
 });
 
-function getSeriesLevelFields() {
-    let fields = {};
-    for (let tag in tagsOfRequiredMatching.Series) {
-        fields[tag] = 1;
-    }
-    return fields;
-}
 
 /**
  * 
  * @param {import("../../../utils/typeDef/dicom").DicomJsonMongoQueryOptions} queryOptions
  * @returns 
  */
 dicomSeriesSchema.statics.getDicomJson = async function(queryOptions) {
-    let studyFields = getStudyLevelFields();
-    let seriesFields = getSeriesLevelFields();
+    let includeFieldsFactory = new IncludeFieldsFactory(queryOptions.includeFields);
+    let seriesFields = includeFieldsFactory.getSeriesLevelFields();
 
     try {
         let docs = await mongoose
             .model("dicomSeries")
             .find(queryOptions.query, {
-                ...studyFields,
                 ...seriesFields
             })
             .setOptions({
@@ -183,4 +171,3 @@ let dicomSeriesModel = mongoose.model(
 );
 
 module.exports = dicomSeriesModel;
-module.exports.getSeriesLevelFields = getSeriesLevelFields;

models/mongodb/models/dicomStudy.js

@@ -3,7 +3,10 @@ const mongoose = require("mongoose");
 const _ = require("lodash");
 const { tagsNeedStore } = require("../../DICOM/dicom-tags-mapping");
 const { getVRSchema } = require("../schema/dicomJsonAttribute");
-const { getStoreDicomFullPathGroup } = require("../service");
+const { 
+    getStoreDicomFullPathGroup,
+    IncludeFieldsFactory
+} = require("../service");
 const {
     tagsOfRequiredMatching
 } = require("../../DICOM/dicom-tags-mapping");
@@ -51,7 +54,8 @@ dicomStudySchema.index({
  * @returns 
  */
 dicomStudySchema.statics.getDicomJson = async function (queryOptions) {
-    let studyFields = getStudyLevelFields();
+    let includeFieldsFactory = new IncludeFieldsFactory(queryOptions.includeFields);
+    let studyFields = includeFieldsFactory.getStudyLevelFields();
 
     try {
         let docs = await mongoose.model("dicomStudy").find(queryOptions.query, studyFields)
@@ -80,14 +84,6 @@ dicomStudySchema.statics.getDicomJson = async function (queryOptions) {
     }
 };
 
-function getStudyLevelFields() {
-    let fields = {};
-    for (let tag in tagsOfRequiredMatching.Study) {
-        fields[tag] = 1;
-    }
-    return fields;
-}
-
 /**
  * 
  * @param {Object} iParam 
@@ -145,4 +141,3 @@ let dicomStudyModel = mongoose.model(
 );
 
 module.exports = dicomStudyModel;
-module.exports.getStudyLevelFields = getStudyLevelFields;