feat: compile Implementation Guides StructureDefinitions (#59)

package.json

@@ -34,7 +34,7 @@
     "cors": "^2.8.5",
     "errorhandler": "^1.5.1",
     "express": "^4.17.1",
-    "fhir-works-on-aws-interface": "^8.0.0",
+    "fhir-works-on-aws-interface": "^8.0.1",
     "flat": "^5.0.0",
     "http-errors": "^1.8.0",
     "lodash": "^4.17.15",

src/app.ts

@@ -21,6 +21,7 @@ import RootRoute from './router/routes/rootRoute';
 import { applicationErrorMapper, httpErrorHandler, unknownErrorHandler } from './router/routes/errorHandling';
 import ExportRoute from './router/routes/exportRoute';
 import WellKnownUriRouteRoute from './router/routes/wellKnownUriRoute';
+import { FHIRStructureDefinitionRegistry } from './registry';
 
 const configVersionSupported: ConfigVersion = 1;
 
@@ -33,9 +34,11 @@ export function generateServerlessRouter(
         throw new Error(`This router does not support ${fhirConfig.configVersion} version`);
     }
     const configHandler: ConfigHandler = new ConfigHandler(fhirConfig, supportedGenericResources);
-    const { fhirVersion, genericResource } = fhirConfig.profile;
+    const { fhirVersion, genericResource, compiledImplementationGuides } = fhirConfig.profile;
     const serverUrl: string = fhirConfig.server.url;
     let hasCORSEnabled: boolean = false;
+    const registry = new FHIRStructureDefinitionRegistry(compiledImplementationGuides);
+
     const app = express();
     app.use(express.urlencoded({ extended: true }));
     app.use(
@@ -52,7 +55,7 @@ export function generateServerlessRouter(
     }
 
     // Metadata
-    const metadataRoute: MetadataRoute = new MetadataRoute(fhirVersion, configHandler, hasCORSEnabled);
+    const metadataRoute: MetadataRoute = new MetadataRoute(fhirVersion, configHandler, registry, hasCORSEnabled);
     app.use('/metadata', metadataRoute.router);
 
     if (fhirConfig.auth.strategy.service === 'SMART-on-FHIR') {

src/implementationGuides/index.test.ts

@@ -0,0 +1,56 @@
+/*
+ *  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *  SPDX-License-Identifier: Apache-2.0
+ */
+
+import { StructureDefinitionImplementationGuides } from './index';
+
+describe('StructureDefinitionImplementationGuides', () => {
+    describe(`compile`, async () => {
+        test(`valid StructureDefinition`, async () => {
+            const compiled = new StructureDefinitionImplementationGuides().compile([
+                {
+                    resourceType: 'StructureDefinition',
+                    id: 'CARIN-BB-Organization',
+                    url: 'http://hl7.org/fhir/us/carin/StructureDefinition/carin-bb-organization',
+                    version: '0.1.0',
+                    name: 'CARINBBOrganization',
+                    title: 'CARIN Blue Button Organization Profile',
+                    status: 'active',
+                    date: '2019-12-23T19:40:59+00:00',
+                    publisher: 'CARIN Alliance',
+                    description:
+                        'This profile builds on the USCoreOrganization Profile. It includes additional constraints relevant for the use cases addressed by this IG.',
+                    fhirVersion: '4.0.1',
+                    kind: 'resource',
+                    abstract: false,
+                    type: 'Organization',
+                    baseDefinition: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization',
+                    derivation: 'constraint',
+                },
+            ]);
+
+            await expect(compiled).resolves.toMatchInlineSnapshot(`
+                Array [
+                  Object {
+                    "baseDefinition": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization",
+                    "description": "This profile builds on the USCoreOrganization Profile. It includes additional constraints relevant for the use cases addressed by this IG.",
+                    "name": "CARINBBOrganization",
+                    "resourceType": "StructureDefinition",
+                    "type": "Organization",
+                    "url": "http://hl7.org/fhir/us/carin/StructureDefinition/carin-bb-organization",
+                  },
+                ]
+            `);
+        });
+
+        test(`invalid StructureDefinition`, async () => {
+            const compiled = new StructureDefinitionImplementationGuides().compile([
+                {
+                    foo: 'bar',
+                },
+            ]);
+            await expect(compiled).rejects.toThrowError();
+        });
+    });
+});

src/implementationGuides/index.ts

@@ -0,0 +1,63 @@
+/*
+ *  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *  SPDX-License-Identifier: Apache-2.0
+ */
+
+import { ImplementationGuides } from 'fhir-works-on-aws-interface';
+
+/**
+ * Based on the FHIR StructuredDefinition. This type only includes the fields that are required for the compile process.
+ * See: http://www.hl7.org/fhir/structuredefinition.html
+ */
+export type FhirStructureDefinition = {
+    resourceType: 'StructureDefinition';
+    url: string;
+    name: string;
+    description: string;
+    baseDefinition: string;
+    type: string;
+};
+
+/**
+ * This class compiles StructuredDefinitions from IG packages
+ */
+export class StructureDefinitionImplementationGuides implements ImplementationGuides {
+    /**
+     * Compiles the contents of an Implementation Guide into an internal representation used to build the Capability Statement
+     *
+     * @param resources - an array of FHIR resources. See: https://www.hl7.org/fhir/profiling.html
+     */
+    // eslint-disable-next-line class-methods-use-this
+    async compile(resources: any[]): Promise<any> {
+        const validStructureDefinitions: FhirStructureDefinition[] = [];
+        resources.forEach(s => {
+            if (StructureDefinitionImplementationGuides.isFhirStructureDefinition(s)) {
+                validStructureDefinitions.push(s);
+            } else {
+                throw new Error(`The following input is not a StructureDefinition: ${s.type} ${s.name}`);
+            }
+        });
+
+        return validStructureDefinitions.map((structureDefinition: any) => ({
+            name: structureDefinition.name,
+            url: structureDefinition.url,
+            type: structureDefinition.type,
+            resourceType: structureDefinition.resourceType,
+            description: structureDefinition.description,
+            baseDefinition: structureDefinition.baseDefinition,
+        }));
+    }
+
+    private static isFhirStructureDefinition(x: any): x is FhirStructureDefinition {
+        return (
+            typeof x === 'object' &&
+            x &&
+            x.resourceType === 'StructureDefinition' &&
+            typeof x.url === 'string' &&
+            typeof x.name === 'string' &&
+            typeof x.description === 'string' &&
+            typeof x.baseDefinition === 'string' &&
+            typeof x.type === 'string'
+        );
+    }
+}

src/registry/ResourceCapabilityInterface.ts

@@ -0,0 +1,13 @@
+/*
+ *  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *  SPDX-License-Identifier: Apache-2.0
+ */
+
+export interface ResourceCapability {
+    type: string;
+    supportedProfile: string[];
+}
+
+export interface ResourceCapabilityStatement {
+    [resourceType: string]: ResourceCapability;
+}

src/registry/index.test.ts

@@ -0,0 +1,58 @@
+/*
+ *  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *  SPDX-License-Identifier: Apache-2.0
+ */
+
+import { FHIRStructureDefinitionRegistry } from './index';
+
+const IGCompiledStructureDefinition = [
+    {
+        name: 'C4BBPatient',
+        url: 'http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Patient',
+        type: 'Patient',
+        resourceType: 'StructureDefinition',
+        description:
+            'This profile builds upon the US Core Patient profile. It is used to convey information about the patient who received the services described on the claim.',
+        baseDefinition: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient',
+    },
+    {
+        name: 'C4BBCoverage',
+        url: 'http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Coverage',
+        type: 'Coverage',
+        resourceType: 'StructureDefinition',
+        description:
+            'Data that reflect a payer’s coverage that was effective as of the date of service or the date of admission of the claim.',
+        baseDefinition: 'http://hl7.org/fhir/StructureDefinition/Coverage',
+    },
+];
+
+describe('FHIRStructureDefinitionRegistry', () => {
+    test('getCapabilities snapshot', () => {
+        expect(new FHIRStructureDefinitionRegistry(IGCompiledStructureDefinition).getCapabilities())
+            .toMatchInlineSnapshot(`
+            Object {
+              "Coverage": Object {
+                "supportedProfile": Array [
+                  "http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Coverage",
+                ],
+                "type": "Coverage",
+              },
+              "Patient": Object {
+                "supportedProfile": Array [
+                  "http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Patient",
+                ],
+                "type": "Patient",
+              },
+            }
+        `);
+    });
+
+    test('getProfiles snapshot', () => {
+        expect(new FHIRStructureDefinitionRegistry(IGCompiledStructureDefinition).getProfiles('Patient'))
+            .toMatchInlineSnapshot(`
+            Array [
+              "http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Patient",
+            ]
+        `);
+    });
+});

src/registry/index.ts

@@ -0,0 +1,56 @@
+/*
+ *  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *  SPDX-License-Identifier: Apache-2.0
+ */
+
+import { FhirStructureDefinition } from '../implementationGuides';
+import { ResourceCapabilityStatement } from './ResourceCapabilityInterface';
+
+/**
+ * This class is the single authority over the supported FHIR StructuredDefinition and their definitions
+ */
+export class FHIRStructureDefinitionRegistry {
+    private readonly capabilityStatement: ResourceCapabilityStatement;
+
+    constructor(compiledImplementationGuides?: any[]) {
+        let compiledStructureDefinitions: FhirStructureDefinition[] = [];
+
+        if (compiledImplementationGuides !== undefined) {
+            compiledStructureDefinitions = [...compiledImplementationGuides];
+        }
+
+        this.capabilityStatement = {};
+
+        compiledStructureDefinitions.forEach(compiledStructureDefinition => {
+            const structuredDefinition = this.capabilityStatement[compiledStructureDefinition.type];
+
+            if (structuredDefinition) {
+                this.capabilityStatement[compiledStructureDefinition.type].supportedProfile.push(
+                    compiledStructureDefinition.url,
+                );
+            } else {
+                this.capabilityStatement[compiledStructureDefinition.type] = {
+                    type: compiledStructureDefinition.type,
+                    supportedProfile: [compiledStructureDefinition.url],
+                };
+            }
+        });
+    }
+
+    /**
+     * Retrieve the profiles for a given resource type. Returns undefined if the parameter is not found on the registry.
+     * @param resourceType FHIR resource type
+     * @return a list of profiles
+     */
+    getProfiles(resourceType: string): string[] {
+        return this.capabilityStatement[resourceType]?.supportedProfile ?? [];
+    }
+
+    /**
+     * Retrieve a subset of the CapabilityStatement with the resource definitions
+     * See https://www.hl7.org/fhir/capabilitystatement.html
+     */
+    getCapabilities(): ResourceCapabilityStatement {
+        return this.capabilityStatement;
+    }
+}

src/router/metadata/cap.rest.resource.template.ts

@@ -10,13 +10,15 @@ import {
     SearchCapabilities,
     Resource,
 } from 'fhir-works-on-aws-interface';
+import { ResourceCapabilityStatement, ResourceCapability } from '../../registry/ResourceCapabilityInterface';
 
 function makeResourceObject(
     resourceType: string,
     resourceOperations: any[],
     updateCreate: boolean,
     hasTypeSearch: boolean,
     searchCapabilities?: SearchCapabilities,
+    resourceCapability?: ResourceCapability,
 ) {
     const result: any = {
         type: resourceType,
@@ -34,6 +36,10 @@ function makeResourceObject(
         Object.assign(result, searchCapabilities);
     }
 
+    if (resourceCapability) {
+        Object.assign(result, resourceCapability);
+    }
+
     return result;
 }
 
@@ -51,6 +57,7 @@ export function makeGenericResources(
     fhirResourcesToMake: string[],
     operations: TypeOperation[],
     searchCapabilityStatement: SearchCapabilityStatement,
+    resourceCapabilityStatement: ResourceCapabilityStatement,
     updateCreate: boolean,
 ) {
     const resources: any[] = [];
@@ -66,6 +73,7 @@ export function makeGenericResources(
                 updateCreate,
                 hasTypeSearch,
                 searchCapabilityStatement[resourceType],
+                resourceCapabilityStatement[resourceType],
             ),
         );
     });