fhirsmith 0.11.1 → 0.12.0

package/tx/tx.js

@@ -249,6 +249,10 @@ class TXModule {
     // cacheTimeout is in minutes, default to 30 minutes
     const cacheTimeoutMs = cacheTimeoutMinutes * 60 * 1000;
     const pruneIntervalMs = 5 * 60 * 1000; // Run every 5 minutes
+    // Tell the cache what timeout it is being pruned against, so $cache-control?mode=check
+    // can report it and a client can size its keepalive interval to this server rather
+    // than guessing at a number it has no way to see.
+    endpointInfo.resourceCache.setIdleTimeout(cacheTimeoutMs);
     if (this.stats) {
       this.stats.addTask("Client Cache", "5 min");
     }
@@ -491,7 +495,7 @@ class TXModule {
     app.use(express.urlencoded({ extended: true }));
 
     // Set up routes
-    this.setupRoutes(router);
+    this.setupRoutes(router, endpointInfo.path);
 
     // Redirect /r5 → /r5/
     app.use((req, res, next) => {
@@ -512,8 +516,11 @@ class TXModule {
   /**
    * Set up routes for an endpoint
    * @param {express.Router} router - Express router
+   * @param {string} endpointPath - the endpoint these routes belong to, e.g.
+   *   '/tx/r4'. Captured by the handlers below so that every request is
+   *   counted against the endpoint that served it, not just the operation.
    */
-  setupRoutes(router) {
+  setupRoutes(router, endpointPath) {
     const resourceTypes = ['CodeSystem', 'ValueSet', 'ConceptMap'];
 
     // ===== Operations =====
@@ -526,7 +533,7 @@ class TXModule {
         let worker = new LookupWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handle(req, res);
       } finally {
-        this.countRequest('$lookup', Date.now() - start);
+        this.countRequest(endpointPath, '$lookup', Date.now() - start);
       }
     });
     router.post('/CodeSystem/\\$lookup', async (req, res) => {
@@ -535,7 +542,7 @@ class TXModule {
         let worker = new LookupWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handle(req, res);
       } finally {
-        this.countRequest('$lookup', Date.now() - start);
+        this.countRequest(endpointPath, '$lookup', Date.now() - start);
       }
     });
 
@@ -546,7 +553,7 @@ class TXModule {
         let worker = new SubsumesWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handle(req, res);
       } finally {
-        this.countRequest('$subsumes', Date.now() - start);
+        this.countRequest(endpointPath, '$subsumes', Date.now() - start);
       }
     });
     router.post('/CodeSystem/\\$subsumes', async (req, res) => {
@@ -555,7 +562,7 @@ class TXModule {
         let worker = new SubsumesWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handle(req, res);
       } finally {
-        this.countRequest('$subsumes', Date.now() - start);
+        this.countRequest(endpointPath, '$subsumes', Date.now() - start);
       }
     });
 
@@ -566,7 +573,7 @@ class TXModule {
         let worker = new ValidateWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handleCodeSystem(req, res);
       } finally {
-        this.countRequest('$validate', Date.now() - start);
+        this.countRequest(endpointPath, '$validate', Date.now() - start);
       }
     });
     router.post('/CodeSystem/\\$validate-code', async (req, res) => {
@@ -575,7 +582,7 @@ class TXModule {
         let worker = new ValidateWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handleCodeSystem(req, res);
       } finally {
-        this.countRequest('$validate', Date.now() - start);
+        this.countRequest(endpointPath, '$validate', Date.now() - start);
       }
     });
 
@@ -586,7 +593,7 @@ class TXModule {
         let worker = new BatchValidateWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handleCodeSystem(req, res);
       } finally {
-        this.countRequest('$batch', Date.now() - start);
+        this.countRequest(endpointPath, '$batch', Date.now() - start);
       }
     });
     router.post('/CodeSystem/\\$batch-validate-code', async (req, res) => {
@@ -595,7 +602,7 @@ class TXModule {
         let worker = new BatchValidateWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handleCodeSystem(req, res);
       } finally {
-        this.countRequest('$batch', Date.now() - start);
+        this.countRequest(endpointPath, '$batch', Date.now() - start);
       }
     });
     // ValueSet/$validate-code (GET and POST)
@@ -605,7 +612,7 @@ class TXModule {
         let worker = new ValidateWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handleValueSet(req, res);
       } finally {
-        this.countRequest('$validate', Date.now() - start);
+        this.countRequest(endpointPath, '$validate', Date.now() - start);
       }
     });
     router.post('/ValueSet/\\$validate-code', async (req, res) => {
@@ -614,7 +621,7 @@ class TXModule {
         let worker = new ValidateWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handleValueSet(req, res);
       } finally {
-        this.countRequest('$validate', Date.now() - start);
+        this.countRequest(endpointPath, '$validate', Date.now() - start);
       }
     });
 
@@ -625,7 +632,7 @@ class TXModule {
         let worker = new CompareWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handle(req, res);
       } finally {
-        this.countRequest('$compare', Date.now() - start);
+        this.countRequest(endpointPath, '$compare', Date.now() - start);
       }
     });
     router.post('/ValueSet/\\$compare', async (req, res) => {
@@ -634,7 +641,7 @@ class TXModule {
         let worker = new CompareWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handle(req, res);
       } finally {
-        this.countRequest('$compare', Date.now() - start);
+        this.countRequest(endpointPath, '$compare', Date.now() - start);
       }
     });
 
@@ -645,7 +652,7 @@ class TXModule {
         let worker = new BatchValidateWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handleValueSet(req, res);
       } finally {
-        this.countRequest('$batch', Date.now() - start);
+        this.countRequest(endpointPath, '$batch', Date.now() - start);
       }
     });
     router.post('/ValueSet/\\$batch-validate-code', async (req, res) => {
@@ -654,7 +661,7 @@ class TXModule {
         let worker = new BatchValidateWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handleValueSet(req, res);
       } finally {
-        this.countRequest('validate', Date.now() - start);
+        this.countRequest(endpointPath, 'validate', Date.now() - start);
       }
     });
 
@@ -665,7 +672,7 @@ class TXModule {
         let worker = new ExpandWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n, this.internalLimit(req), this.externalLimit(req));
         await worker.handle(req, res, this.log);
       } finally {
-        this.countRequest('$expand', Date.now() - start);
+        this.countRequest(endpointPath, '$expand', Date.now() - start);
       }
     });
     router.post('/ValueSet/\\$expand', async (req, res) => {
@@ -674,7 +681,7 @@ class TXModule {
         let worker = new ExpandWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n, this.internalLimit(req), this.externalLimit(req));
         await worker.handle(req, res, this.log);
       } finally {
-        this.countRequest('$expand', Date.now() - start);
+        this.countRequest(endpointPath, '$expand', Date.now() - start);
       }
     });
 
@@ -685,7 +692,7 @@ class TXModule {
         let worker = new CacheControlWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handle(req, res, this.log);
       } finally {
-        this.countRequest('$cache-control', Date.now() - start);
+        this.countRequest(endpointPath, '$cache-control', Date.now() - start);
       }
     });
     router.post('/\\$cache-control', async (req, res) => {
@@ -694,7 +701,7 @@ class TXModule {
         let worker = new CacheControlWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handle(req, res, this.log);
       } finally {
-        this.countRequest('$cache-control', Date.now() - start);
+        this.countRequest(endpointPath, '$cache-control', Date.now() - start);
       }
     });
 
@@ -705,7 +712,7 @@ class TXModule {
         let worker = new TranslateWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handle(req, res, this.log);
       } finally {
-        this.countRequest('$translate', Date.now() - start);
+        this.countRequest(endpointPath, '$translate', Date.now() - start);
       }
     });
     router.post('/ConceptMap/\\$translate', async (req, res) => {
@@ -714,7 +721,7 @@ class TXModule {
         let worker = new TranslateWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handle(req, res, this.log);
       } finally {
-        this.countRequest('$translate', Date.now() - start);
+        this.countRequest(endpointPath, '$translate', Date.now() - start);
       }
     });
 
@@ -725,7 +732,7 @@ class TXModule {
         let worker = new ClosureWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handle(req, res, this.log);
       } finally {
-        this.countRequest('$closure', Date.now() - start);
+        this.countRequest(endpointPath, '$closure', Date.now() - start);
       }
     });
     router.post('/ConceptMap/\\$closure', async (req, res) => {
@@ -734,7 +741,7 @@ class TXModule {
         let worker = new ClosureWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handle(req, res, this.log);
       } finally {
-        this.countRequest('$closure', Date.now() - start);
+        this.countRequest(endpointPath, '$closure', Date.now() - start);
       }
     });
 
@@ -747,7 +754,7 @@ class TXModule {
         let worker = new LookupWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handleInstance(req, res);
       } finally {
-        this.countRequest('$lookup', Date.now() - start);
+        this.countRequest(endpointPath, '$lookup', Date.now() - start);
       }
     });
     router.post('/CodeSystem/:id/\\$lookup', async (req, res) => {
@@ -756,7 +763,7 @@ class TXModule {
         let worker = new LookupWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handleInstance(req, res);
       } finally {
-        this.countRequest('$lookup', Date.now() - start);
+        this.countRequest(endpointPath, '$lookup', Date.now() - start);
       }
     });
 
@@ -767,7 +774,7 @@ class TXModule {
         let worker = new SubsumesWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handleInstance(req, res);
       } finally {
-        this.countRequest('$subsumes', Date.now() - start);
+        this.countRequest(endpointPath, '$subsumes', Date.now() - start);
       }
     });
     router.post('/CodeSystem/:id/\\$subsumes', async (req, res) => {
@@ -776,7 +783,7 @@ class TXModule {
         let worker = new SubsumesWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handleInstance(req, res);
       } finally {
-        this.countRequest('$subsumes', Date.now() - start);
+        this.countRequest(endpointPath, '$subsumes', Date.now() - start);
       }
     });
 
@@ -787,7 +794,7 @@ class TXModule {
         let worker = new ValidateWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handleCodeSystemInstance(req, res, this.log);
       } finally {
-        this.countRequest('$validate', Date.now() - start);
+        this.countRequest(endpointPath, '$validate', Date.now() - start);
       }
     });
     router.post('/CodeSystem/:id/\\$validate-code', async (req, res) => {
@@ -796,7 +803,7 @@ class TXModule {
         let worker = new ValidateWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handleCodeSystemInstance(req, res, this.log);
       } finally {
-        this.countRequest('$validate', Date.now() - start);
+        this.countRequest(endpointPath, '$validate', Date.now() - start);
       }
 
     });
@@ -808,7 +815,7 @@ class TXModule {
         let worker = new ValidateWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handleValueSetInstance(req, res, this.log);
       } finally {
-        this.countRequest('$validate', Date.now() - start);
+        this.countRequest(endpointPath, '$validate', Date.now() - start);
       }
     });
     router.post('/ValueSet/:id/\\$validate-code', async (req, res) => {
@@ -817,7 +824,7 @@ class TXModule {
         let worker = new ValidateWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handleValueSetInstance(req, res, this.log);
       } finally {
-        this.countRequest('$validate', Date.now() - start);
+        this.countRequest(endpointPath, '$validate', Date.now() - start);
       }
     });
 
@@ -829,7 +836,7 @@ class TXModule {
         let worker = new CompareWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handleInstance(req, res, this.log);
       } finally {
-        this.countRequest('$compare', Date.now() - start);
+        this.countRequest(endpointPath, '$compare', Date.now() - start);
       }
     });
     router.post('/ValueSet/:id/\\$compare', async (req, res) => {
@@ -838,7 +845,7 @@ class TXModule {
         let worker = new CompareWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handleInstance(req, res, this.log);
       } finally {
-        this.countRequest('$compare', Date.now() - start);
+        this.countRequest(endpointPath, '$compare', Date.now() - start);
       }
     });
 
@@ -849,7 +856,7 @@ class TXModule {
         let worker = new ExpandWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n, this.internalLimit(req), this.externalLimit(req));
         await worker.handleInstance(req, res, this.log);
       } finally {
-        this.countRequest('$expand', Date.now() - start);
+        this.countRequest(endpointPath, '$expand', Date.now() - start);
       }
     });
     router.post('/ValueSet/:id/\\$expand', async (req, res) => {
@@ -858,7 +865,7 @@ class TXModule {
         let worker = new ExpandWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n, this.internalLimit(req), this.externalLimit(req));
         await worker.handleInstance(req, res, this.log);
       } finally {
-        this.countRequest('$expand', Date.now() - start);
+        this.countRequest(endpointPath, '$expand', Date.now() - start);
       }
     });
 
@@ -869,7 +876,7 @@ class TXModule {
         let worker = new TranslateWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handleInstance(req, res, this.log);
       } finally {
-        this.countRequest('$translate', Date.now() - start);
+        this.countRequest(endpointPath, '$translate', Date.now() - start);
       }
     });
     router.post('/ConceptMap/:id/\\$translate', async (req, res) => {
@@ -878,7 +885,7 @@ class TXModule {
         let worker = new TranslateWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handleInstance(req, res, this.log);
       } finally {
-        this.countRequest('$translate', Date.now() - start);
+        this.countRequest(endpointPath, '$translate', Date.now() - start);
       }
     });
 
@@ -900,7 +907,7 @@ class TXModule {
           let worker = new ReadWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
           await worker.handle(req, res, resourceType);
         } finally {
-          this.countRequest('read', Date.now() - start);
+          this.countRequest(endpointPath, 'read', Date.now() - start);
         }
       });
     }
@@ -913,7 +920,7 @@ class TXModule {
           let worker = new SearchWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
           await worker.handle(req, res, resourceType);
         } finally {
-          this.countRequest('search', Date.now() - start);
+          this.countRequest(endpointPath, 'search', Date.now() - start);
         }
       });
       router.post(`/${resourceType}/_search`, async (req, res) => {
@@ -922,7 +929,7 @@ class TXModule {
           let worker = new SearchWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
           await worker.handle(req, res, resourceType);
         } finally {
-          this.countRequest('search', Date.now() - start);
+          this.countRequest(endpointPath, 'search', Date.now() - start);
         }
       });
     }
@@ -940,7 +947,7 @@ class TXModule {
             ));
           }
         } finally {
-          this.countRequest('$read', Date.now() - start);
+          this.countRequest(endpointPath, '$read', Date.now() - start);
         }
       });
     }
@@ -951,7 +958,7 @@ class TXModule {
         let worker = new OperationsWorker(req.txOpContext, this.log, req.txProvider, this.languages, this.i18n);
         await worker.handle(req, res);
       } finally {
-        this.countRequest('$op', Date.now() - start);
+        this.countRequest(endpointPath, '$op', Date.now() - start);
       }
     });
 
@@ -965,7 +972,7 @@ class TXModule {
         res.setHeader('Content-Type', 'text/html');
         res.send(html);
       } finally {
-        this.countRequest('problems', Date.now() - start);
+        this.countRequest(endpointPath, 'problems', Date.now() - start);
       }
     });
 
@@ -980,7 +987,7 @@ class TXModule {
           res.status(500).json(this.operationOutcome('error', 'exception', error.message));
         }
       } finally {
-        this.countRequest('metadata', Date.now() - start);
+        this.countRequest(endpointPath, 'metadata', Date.now() - start);
       }
     });
 
@@ -995,7 +1002,7 @@ class TXModule {
           res.status(500).json(this.operationOutcome('error', 'exception', error.message));
         }
       } finally {
-        this.countRequest('$versions', Date.now() - start);
+        this.countRequest(endpointPath, '$versions', Date.now() - start);
       }
     });
 
@@ -1012,7 +1019,7 @@ class TXModule {
           }]
         });
       } finally {
-        this.countRequest('home', Date.now() - start);
+        this.countRequest(endpointPath, 'home', Date.now() - start);
       }
     });
 
@@ -1037,7 +1044,7 @@ class TXModule {
         this.log.error(`Error rendering info page for ${req.params.id}: ${error.message}`);
         res.status(500).send('Internal server error');
       } finally {
-        this.countRequest('info', Date.now() - start);
+        this.countRequest(endpointPath, 'info', Date.now() - start);
       }
     };
     router.get('/info/:id', infoHandler);
@@ -1214,9 +1221,9 @@ class TXModule {
     return data;
   }
 
-  countRequest(name, tat) {
+  countRequest(endpoint, name, tat) {
     if (this.stats) {
-      this.stats.countRequest(name, tat);
+      this.stats.countRequest(name, tat, endpoint);
     }
   }
 

package/tx/workers/batch-validate.js

@@ -187,8 +187,11 @@ class BatchValidateWorker extends TerminologyWorker {
       return false;
     }
     if (!cache.has(cacheId)) {
-      throw new Issue('error', 'not-found', null, 'CACHE_ID_UNKNOWN',
-        this.i18n.translate('CACHE_ID_UNKNOWN', this.opContext.langs, [cacheId]),
+      // describeMissing names which fate the id met (never issued here / closed by
+      // the client / idle-expired); the coding stays cache-id-unknown either way.
+      const { messageId, params: msgParams } = cache.describeMissing(cacheId);
+      throw new Issue('error', 'not-found', null, messageId,
+        this.i18n.translate(messageId, this.opContext.langs, msgParams),
         'cache-id-unknown', 404);
     }
     if (cache.isSealed(cacheId)) {

package/tx/workers/cache-control.js

@@ -5,20 +5,18 @@
 // POST /$cache-control?mode=start   - as above, optionally front-loading resources
 // GET  /$cache-control?mode=end     - tell the server it can release the cache now
 // POST /$cache-control?mode=end
-// (mode=check is reserved for later - report whether a cache is still valid + stats)
+// GET  /$cache-control?mode=check   - is this cache still alive? (and keep it alive)
+// POST /$cache-control?mode=check
 //
 // This is the explicit replacement for the implicit `cache-id` parameter protocol:
 // the server owns the cache-id namespace, so it can authoritatively reject an
 // unknown/expired cache later instead of failing obscurely deep inside a validation.
 //
-// NOTE: this is scaffolding. start()/end() currently parse the request into a
-// Parameters resource (the same way validate.js does) but do not yet create or
-// release anything. The behaviour is filled in by later steps.
-//
 
 const crypto = require('crypto');
 const { TerminologyWorker, CACHE_ID_HEADER } = require('./worker');
 const { Parameters } = require('../library/parameters');
+const { Issue } = require('../library/operation-outcome');
 const { debugLog } = require('../operation-context');
 
 class CacheControlWorker extends TerminologyWorker {
@@ -61,9 +59,11 @@ class CacheControlWorker extends TerminologyWorker {
           return await this.start(req, res);
         case 'end':
           return await this.end(req, res);
+        case 'check':
+          return await this.check(req, res);
         default:
           return res.status(400).json(this.operationOutcome('error', 'invalid',
-            `$cache-control requires a 'mode' of 'start' or 'end'` +
+            `$cache-control requires a 'mode' of 'start', 'end' or 'check'` +
             (mode ? ` (got '${mode}')` : ` (none supplied)`)));
       }
     } catch (error) {
@@ -193,6 +193,82 @@ class CacheControlWorker extends TerminologyWorker {
     return res.status(200).json({ resourceType: 'Parameters', parameter: [] });
   }
 
+  /**
+   * mode=check: report whether the cache named by the `${CACHE_ID_HEADER}` header is
+   * still alive, and - if it is - reset its idle clock.
+   *
+   * This is a keepalive as much as a probe, and deliberately so. A client's own
+   * local cache absorbs most of its terminology work, so the server can see nothing
+   * from a client that is still very much running and still relying on its cache;
+   * the cache then times out mid-job and the next request that finally does reach
+   * the server fails. Checking is exactly what a client that still cares about its
+   * cache does, so a check counts as use. (The alternative - a read-only `check`
+   * plus a separate `touch` - is two operations for one job, and there is no useful
+   * case for asking "is my cache alive?" while wanting it to expire anyway.)
+   *
+   * An unknown cache-id here is a 200 with `valid` = false, NOT the 404 that the
+   * validation path returns. A probe must be able to tell "the server is up and
+   * says my cache is gone" from "I could not reach the server" - those call for
+   * opposite responses, and collapsing them into one failure loses that. This also
+   * matches mode=end, which likewise tolerates an id the server doesn't have. The
+   * `outcome` parameter carries the same coded issue the validation path would have
+   * raised, so a client that wants the reason (never issued here / closed by the
+   * client / expired after N minutes idle) has it without a second call.
+   *
+   * @param {express.Request} req
+   * @param {express.Response} res
+   */
+  async check(req, res) {
+    const cache = this.opContext.resourceCache;
+    if (!cache) {
+      return res.status(500).json(this.operationOutcome('error', 'exception',
+        'No resource cache is available on this endpoint'));
+    }
+
+    const cacheId = req.headers[CACHE_ID_HEADER];
+    if (!cacheId) {
+      return res.status(400).json(this.operationOutcome('error', 'invalid',
+        `$cache-control mode=check requires the cache-id in the '${CACHE_ID_HEADER}' header`));
+    }
+
+    // Read the status BEFORE touching: the idle time is the interesting part of the
+    // answer, and refreshing first would report zero every time.
+    const status = cache.status(cacheId);
+
+    if (!status.exists) {
+      const { messageId, params } = cache.describeMissing(cacheId);
+      const issue = new Issue('error', 'not-found', null, messageId,
+        this.i18n.translate(messageId, this.opContext.langs, params),
+        'cache-id-unknown', 404).asIssue();
+      this.log.info(`cache-id '${cacheId}': check -> not valid (${messageId})`);
+      return res.status(200).json({
+        resourceType: 'Parameters',
+        parameter: [
+          { name: 'cache-id', valueId: cacheId },
+          { name: 'valid', valueBoolean: false },
+          { name: 'outcome', resource: { resourceType: 'OperationOutcome', issue: [issue] } }
+        ]
+      });
+    }
+
+    cache.touch(cacheId);
+
+    const parameter = [
+      { name: 'cache-id', valueId: cacheId },
+      { name: 'valid', valueBoolean: true },
+      { name: 'sealed', valueBoolean: status.sealed },
+      { name: 'resource-count', valueUnsignedInt: status.resources },
+      { name: 'idle', valueUnsignedInt: Math.floor(status.idleMs / 1000) }
+    ];
+    // The timeout lets a client work out how often it needs to check, instead of
+    // guessing against a number it cannot see. Omitted if this server isn't saying.
+    if (status.timeoutMs !== null && status.timeoutMs !== undefined) {
+      parameter.push({ name: 'timeout', valueUnsignedInt: Math.floor(status.timeoutMs / 1000) });
+    }
+
+    return res.status(200).json({ resourceType: 'Parameters', parameter });
+  }
+
   /**
    * Build an OperationOutcome.
    * @param {string} severity - error, warning, information