fhirsmith 0.11.2 → 0.13.0

package/tx/workers/lookup.js

@@ -12,8 +12,9 @@ const { FhirCodeSystemProvider } = require('../cs/cs-cs');
 const { Designations} = require("../library/designations");
 const {TxParameters} = require("../params");
 const {Parameters} = require("../library/parameters");
-const {Issue, OperationOutcome} = require("../library/operation-outcome");
+const { Issue, OperationOutcome, buildOperationOutcome, outcomeFromError } = require('../library/operation-outcome');
 const {debugLog} = require("../operation-context");
+const {checkAddedParameters} = require("../library/parameter-check");
 
 class LookupWorker extends TerminologyWorker {
   /**
@@ -48,16 +49,7 @@ class LookupWorker extends TerminologyWorker {
       this.log.error(error);
       debugLog(error);
       req.logInfo = this.usedSources.join("|")+" - error"+(error.msgId  ? " "+error.msgId : "");
-      const statusCode = error.statusCode || 500;
-      const issueCode = error.issueCode || 'exception';
-      return res.status(statusCode).json({
-        resourceType: 'OperationOutcome',
-        issue: [{
-          severity: 'error',
-          code: issueCode,
-          diagnostics: error.message
-        }]
-      });
+      return res.status(error.statusCode || 500).json(outcomeFromError(error));
     }
   }
 
@@ -75,15 +67,7 @@ class LookupWorker extends TerminologyWorker {
       this.log.error(error);
       debugLog(error);
       req.logInfo = this.usedSources.join("|")+" - error"+(error.msgId  ? " "+error.msgId : "");
-      const issueCode = error.issueCode || 'exception';
-      return res.status(400).json({
-        resourceType: 'OperationOutcome',
-        issue: [{
-          severity: 'error',
-          code: issueCode,
-          diagnostics: error.message
-        }]
-      });
+      return res.status(400).json(outcomeFromError(error));
     }
   }
 
@@ -139,8 +123,11 @@ class LookupWorker extends TerminologyWorker {
       }
 
       if (!csProvider) {
-        const systemUrl = params.system || params.coding?.system;
-        const versionStr = params.version || params.coding?.version;
+        // params is a Map-like: params.system is always undefined, so the message read
+        // "CodeSystem not found: undefined" for every unknown system or version.
+        const coding = params.has('coding') ? params.get('coding') : null;
+        const systemUrl = params.has('system') ? params.get('system') : coding?.system;
+        const versionStr = params.has('version') ? params.get('version') : coding?.version;
         const msg = versionStr
           ? `CodeSystem not found: ${systemUrl} version ${versionStr}`
           : `CodeSystem not found: ${systemUrl}`;
@@ -168,8 +155,7 @@ class LookupWorker extends TerminologyWorker {
         oo.addIssue(error);
         return res.status(error.statusCode || 500).json(oo.jsonObj);
       } else {
-        return res.status(error.statusCode || 500).json(this.operationOutcome(
-          'error', error.issueCode || 'exception', error.message));
+        return res.status(error.statusCode || 500).json(outcomeFromError(error));
       }
     }
   }
@@ -232,8 +218,7 @@ class LookupWorker extends TerminologyWorker {
         oo.addIssue(error);
         return res.status(error.statusCode || 500).json(oo.jsonObj);
       } else {
-        return res.status(error.statusCode || 500).json(this.operationOutcome(
-          'error', error.issueCode || 'exception', error.message));
+        return res.status(error.statusCode || 500).json(outcomeFromError(error));
       }
     }
   }
@@ -270,7 +255,9 @@ class LookupWorker extends TerminologyWorker {
       if (locateResult?.message) {
         message += ' ('+locateResult.message+')';
       }
-      throw new Issue('error', 'not-found', null, null, message, null, 404);
+      // invalid-code, not not-found: the code system was found, the code in it was not.
+      // not-found is for a code system or value set that could not be resolved at all.
+      throw new Issue('error', 'not-found', null, null, message, 'invalid-code', 404);
     }
 
     const ctxt = locateResult.context;
@@ -393,8 +380,20 @@ class LookupWorker extends TerminologyWorker {
       }
     }
 
-    // Let the provider add additional properties
+    // Let the provider add additional properties. Some providers pass content
+    // through from a remote API, where a value can be any JSON at all, so what
+    // comes back is checked before it goes out: a structure where a FHIR
+    // primitive belongs is a provider bug, and shipping it would produce a
+    // response that isn't valid FHIR (and, in XML, isn't even parseable).
+    const providerParamsFrom = responseParams.length;
     await csProvider.extendLookup(ctxt, params.properties || [], responseParams);
+    let providerName;
+    try {
+      providerName = csProvider.system();
+    } catch (e) {
+      providerName = 'unknown';
+    }
+    checkAddedParameters(responseParams, providerParamsFrom, providerName);
 
     if (reportedSupplements) {
       for (const supplement of reportedSupplements) {
@@ -428,21 +427,17 @@ class LookupWorker extends TerminologyWorker {
   }
 
   /**
-   * Build an OperationOutcome
+   * Build an OperationOutcome. Delegates to the shared builder so that every outcome this
+   * server emits has details.text and a tx-issue-type coding: diagnostics is stripped by
+   * the test harness, so nothing a caller needs may live there.
    * @param {string} severity - error, warning, information
-   * @param {string} code - Issue code
-   * @param {string} message - Diagnostic message
+   * @param {string} code - FHIR issue type
+   * @param {string} message - the human readable account of the problem
+   * @param {string} [txIssueType] - tx-issue-type; defaulted from code when not given
    * @returns {Object} OperationOutcome resource
    */
-  operationOutcome(severity, code, message) {
-    return {
-      resourceType: 'OperationOutcome',
-      issue: [{
-        severity,
-        code,
-        details: {text : message}
-      }]
-    };
+  operationOutcome(severity, code, message, txIssueType = null) {
+    return buildOperationOutcome(severity, code, message, txIssueType);
   }
 }
 

package/tx/workers/read.js

@@ -7,6 +7,7 @@
 const { TerminologyWorker } = require('./worker');
 const {debugLog} = require("../operation-context");
 
+const { buildOperationOutcome } = require('../library/operation-outcome');
 class ReadWorker extends TerminologyWorker {
   /**
    * @param {OperationContext} opContext - Operation context
@@ -50,27 +51,13 @@ class ReadWorker extends TerminologyWorker {
           return await this.handleConceptMap(req, res, id);
 
         default:
-          return res.status(404).json({
-            resourceType: 'OperationOutcome',
-            issue: [{
-              severity: 'error',
-              code: 'not-found',
-              diagnostics: `Unknown resource type: ${resourceType}`
-            }]
-          });
+          return res.status(404).json(buildOperationOutcome('error', 'not-found', `Unknown resource type: ${resourceType}`));
       }
     } catch (error) {
       this.log.error(error);
       debugLog(error);
       req.logInfo = this.usedSources.join("|")+" - error"+(error.msgId  ? " "+error.msgId : "");
-      return res.status(500).json({
-        resourceType: 'OperationOutcome',
-        issue: [{
-          severity: 'error',
-          code: 'exception',
-          diagnostics: error.message
-        }]
-      });
+      return res.status(500).json(buildOperationOutcome('error', 'exception', error.message));
     }
   }
 
@@ -127,14 +114,7 @@ class ReadWorker extends TerminologyWorker {
       }
     }
 
-    return res.status(404).json({
-      resourceType: 'OperationOutcome',
-      issue: [{
-        severity: 'error',
-        code: 'not-found',
-        diagnostics: `CodeSystem/${id} not found`
-      }]
-    });
+    return res.status(404).json(buildOperationOutcome('error', 'not-found', `CodeSystem/${id} not found`));
   }
 
   /**
@@ -151,14 +131,7 @@ class ReadWorker extends TerminologyWorker {
       }
     }
 
-    return res.status(404).json({
-      resourceType: 'OperationOutcome',
-      issue: [{
-        severity: 'error',
-        code: 'not-found',
-        diagnostics: `ValueSet/${id} not found`
-      }]
-    });
+    return res.status(404).json(buildOperationOutcome('error', 'not-found', `ValueSet/${id} not found`));
   }
   /**
    * Handle ConceptMap read
@@ -174,14 +147,7 @@ class ReadWorker extends TerminologyWorker {
       }
     }
 
-    return res.status(404).json({
-      resourceType: 'OperationOutcome',
-      issue: [{
-        severity: 'error',
-        code: 'not-found',
-        diagnostics: `ConceptMap/${id} not found`
-      }]
-    });
+    return res.status(404).json(buildOperationOutcome('error', 'not-found', `ConceptMap/${id} not found`));
   }
 }
 

package/tx/workers/search.js

@@ -10,6 +10,7 @@ const {Utilities} = require("../../library/utilities");
 const {debugLog} = require("../operation-context");
 const {acceptsHtml} = require("../tx-html");
 
+const { buildOperationOutcome } = require('../library/operation-outcome');
 class SearchWorker extends TerminologyWorker {
   /**
    * @param {OperationContext} opContext - Operation context
@@ -127,14 +128,7 @@ class SearchWorker extends TerminologyWorker {
       this.log.error(error);
       debugLog(error);
       req.logInfo = "error "+(error.msgId || error.className);
-      return res.status(500).json({
-        resourceType: 'OperationOutcome',
-        issue: [{
-          severity: 'error',
-          code: 'exception',
-          diagnostics: error.message
-        }]
-      });
+      return res.status(500).json(buildOperationOutcome('error', 'exception', error.message));
     }
   }
 

package/tx/workers/subsumes.js

@@ -7,7 +7,7 @@
 // POST /CodeSystem/{id}/$subsumes
 //
 
-const { TerminologyWorker } = require('./worker');
+const { TerminologyWorker, Unknown_Code_in_VersionSCT, SCTVersion } = require('./worker');
 const { FhirCodeSystemProvider } = require('../cs/cs-cs');
 const {TxParameters} = require("../params");
 const {Parameters} = require("../library/parameters");
@@ -51,8 +51,7 @@ class SubsumesWorker extends TerminologyWorker {
         oo.addIssue(error);
         return res.status(error.statusCode || 500).json(oo.jsonObj);
       } else {
-        return res.status(error.statusCode || 500).json(this.operationOutcome(
-          'error', error.issueCode || 'exception', error.message));
+        return res.status(error.statusCode || 500).json(this.unexpectedErrorOutcome(error));
       }
     }
   }
@@ -74,8 +73,7 @@ class SubsumesWorker extends TerminologyWorker {
         oo.addIssue(error);
         return res.status(error.statusCode || 500).json(oo.jsonObj);
       } else {
-        return res.status(error.statusCode || 500).json(this.operationOutcome(
-          'error', error.issueCode || 'exception', error.message));
+        return res.status(error.statusCode || 500).json(this.unexpectedErrorOutcome(error));
       }
     }
   }
@@ -87,13 +85,14 @@ class SubsumesWorker extends TerminologyWorker {
   async handleTypeLevelSubsumes(req, res) {
     this.deadCheck('subsumes-type-level');
 
-    // Handle tx-resource and cache-id parameters from Parameters resource
-    if (req.body && req.body.resourceType === 'Parameters') {
-      this.setupAdditionalResources(req.body);
-    }
-
-    // Parse parameters from request
+    // Parse the parameters first, then hand them to setupAdditionalResources. It used to be
+    // handed req.body, which meant a GET (no body) never reached the cache-id handling: when a
+    // client front-loads a suite's resources into a server-side cache the request carries no
+    // tx-resource at all, only the X-Cache-Id header, and every code system supplied that way
+    // was invisible. On a GET parseParameters turns the query string into the same Parameters
+    // shape, and the cache-id comes off the operation context
     const params = new Parameters(this.parseParameters(req));
+    this.setupAdditionalResources(params.jsonObj);
     const txp = new TxParameters(this.opContext.i18n.languageDefinitions, this.opContext.i18n);
     txp.readParams(params.jsonObj);
 
@@ -101,7 +100,9 @@ class SubsumesWorker extends TerminologyWorker {
     let codingA, codingB;
     let csProvider;
 
+    let names = ['codeA', 'codeB'];
     if (params.has('codingA') && params.has('codingB')) {
+      names = ['codingA', 'codingB'];
       // Using codingA and codingB (only from Parameters resource)
       codingA = params.get('codingA');
       codingB = params.get('codingB');
@@ -138,7 +139,7 @@ class SubsumesWorker extends TerminologyWorker {
     }
 
     // Perform the subsumes check
-    const result = await this.doSubsumes(csProvider, codingA, codingB);
+    const result = await this.doSubsumes(csProvider, codingA, codingB, txp, names);
     req.logInfo = this.usedSources.join("|")+txp.logInfo();
     return res.status(200).json(result);
   }
@@ -159,13 +160,9 @@ class SubsumesWorker extends TerminologyWorker {
       throw new Issue('error', 'not found', null, null, `CodeSystem/${id} not found`, null, 404);
     }
 
-    // Handle tx-resource and cache-id parameters from Parameters resource
-    if (req.body && req.body.resourceType === 'Parameters') {
-      this.setupAdditionalResources(req.body);
-    }
-
-    // Parse parameters from request
+    // See handleTypeLevelSubsumes: parse first, so a GET reaches the cache-id handling too
     const params = new Parameters(this.parseParameters(req));
+    this.setupAdditionalResources(params.jsonObj);
     const txp = new TxParameters(this.opContext.i18n.languageDefinitions, this.opContext.i18n);
     txp.readParams(params.jsonObj);
 
@@ -178,7 +175,9 @@ class SubsumesWorker extends TerminologyWorker {
     // Get the codings
     let codingA, codingB;
 
+    let names = ['codeA', 'codeB'];
     if (params.has('codingA') && params.has('codingB')) {
+      names = ['codingA', 'codingB'];
       codingA = params.get('codingA');
       codingB = params.get('codingB');
     } else if (params.has('codeA') && params.has('codeB')) {
@@ -198,7 +197,7 @@ class SubsumesWorker extends TerminologyWorker {
     }
 
     // Perform the subsumes check
-    const result = await this.doSubsumes(csProvider, codingA, codingB);
+    const result = await this.doSubsumes(csProvider, codingA, codingB, txp, names);
     req.logInfo = this.usedSources.join("|")+txp.logInfo();
     return res.json(result);
   }
@@ -263,9 +262,11 @@ class SubsumesWorker extends TerminologyWorker {
    * @param {CodeSystemProvider} csProvider - CodeSystem provider
    * @param {Object} codingA - First coding
    * @param {Object} codingB - Second coding
+   * @param {TxParameters} txp - parsed parameters (for languages)
+   * @param {Array<string>} names - the parameters the two codes came from, for `expression`
    * @returns {Object} Parameters resource with subsumes result
    */
-  async doSubsumes(csProvider, codingA, codingB) {
+  async doSubsumes(csProvider, codingA, codingB, txp, names = ['codeA', 'codeB']) {
     this.deadCheck('doSubsumes');
 
     const csSystem = csProvider.system();
@@ -287,18 +288,12 @@ class SubsumesWorker extends TerminologyWorker {
     // Validate both codes exist
     const locateA = await csProvider.locate(codingA.code);
     if (!locateA || !locateA.context) {
-      const error = new Error(`Invalid code: '${codingA.code}' not found in CodeSystem '${csSystem}'`);
-      error.statusCode = 404;
-      error.issueCode = 'not-found';
-      throw error;
+      throw this.unknownCodeIssue(csProvider, codingA.code, names[0], locateA ? locateA.message : null, txp);
     }
 
     const locateB = await csProvider.locate(codingB.code);
     if (!locateB || !locateB.context) {
-      const error = new Error(`Invalid code: '${codingB.code}' not found in CodeSystem '${csSystem}'`);
-      error.statusCode = 404;
-      error.issueCode = 'not-found';
-      throw error;
+      throw this.unknownCodeIssue(csProvider, codingB.code, names[1], locateB ? locateB.message : null, txp);
     }
 
     let equal = false;
@@ -324,21 +319,43 @@ class SubsumesWorker extends TerminologyWorker {
   }
 
   /**
-   * Build an OperationOutcome
-   * @param {string} severity - error, warning, information
-   * @param {string} code - Issue code
-   * @param {string} message - Diagnostic message
+   * Build the Issue for a code that isn't in the code system. Uses the same message ids
+   * and tx-issue-type detail code as $validate-code, so clients get consistent errors
+   * @param {CodeSystemProvider} csProvider - CodeSystem provider
+   * @param {string} code - the code that wasn't found
+   * @param {string} path - the parameter the code came from ('codeA' / 'codeB')
+   * @param {string} message - any explanation the provider gave for not finding it
+   * @param {TxParameters} txp - parsed parameters (for languages)
+   * @returns {Issue}
+   */
+  unknownCodeIssue(csProvider, code, path, message, txp) {
+    const system = csProvider.system();
+    const version = csProvider.version();
+    const msgId = Unknown_Code_in_VersionSCT(system, version);
+    const langs = txp ? txp.HTTPLanguages : null;
+    const msg = this.i18n.translate(msgId, langs, [code, system, version, SCTVersion(system, version)]);
+    const issue = new Issue('error', 'code-invalid', path, msgId, msg, 'invalid-code', 404);
+    if (message) {
+      issue.withDiagnostics(message);
+    }
+    return issue;
+  }
+
+  /**
+   * Wrap an error we did not expect as an OperationOutcome. The message goes in details.text,
+   * not diagnostics: TxTester strips diagnostics from every issue it compares, so anything
+   * reported that way is invisible in a failing test - all you see is 'exception'
+   * @param {Error} error - the error that escaped
    * @returns {Object} OperationOutcome resource
    */
-  operationOutcome(severity, code, message) {
-    return {
-      resourceType: 'OperationOutcome',
-      issue: [{
-        severity,
-        code,
-        diagnostics: message
-      }]
-    };
+  unexpectedErrorOutcome(error) {
+    // txIssueType, when the thrower set one, becomes the details.coding - that is where
+    // a client looks for the machine-readable reason (e.g. cannot-determine).
+    const issue = new Issue('error', error.issueCode || 'exception', null, null,
+      error.message || String(error), error.txIssueType || null, error.statusCode || 500);
+    const oo = new OperationOutcome();
+    oo.addIssue(issue);
+    return oo.jsonObj;
   }
 }