feat!: add methods to support FHIR Subscriptions (#100)

* feat: add getActiveSubscriptions interface (#95)
* feat!: search and validate update for subscription data validation(#94)
* feat: Validator change (#97)

Co-authored-by: Sukeerth Vegaraju <ssvegaraju@yahoo.co.in>
Co-authored-by: Yanyu Zheng <yz2690@columbia.edu>

BREAKING CHANGE: add new required methods `getActiveSubscriptions` and `validateSubscriptionSearchCriteria`

src/persistence.ts

@@ -131,4 +131,10 @@ export interface Persistence {
      * the appropriate action to take.
      */
     conditionalDeleteResource(request: ConditionalDeleteResourceRequest, queryParams: any): Promise<GenericResponse>;
+
+    /**
+     * Returns an array of all active Subscriptions.
+     * If tenantId is supplied, this method will only return Subscriptions owned by that tenant.
+     */
+    getActiveSubscriptions(params: { tenantId?: string }): Promise<Record<string, any>[]>;
 }

src/search.ts

@@ -78,4 +78,8 @@ export interface Search {
      * See https://www.hl7.org/fhir/capabilitystatement.html
      */
     getCapabilities(): Promise<SearchCapabilityStatement>;
+    /**
+     * Verify that a search string used as criteria in Subscription resource is valid
+     */
+    validateSubscriptionSearchCriteria(searchCriteria: string): void;
 }

src/stubs.ts

@@ -33,6 +33,10 @@ export module stubs {
         globalSearch(request) {
             throw new Error('Method not implemented.');
         },
+
+        validateSubscriptionSearchCriteria(searchCriteria) {
+            throw new Error('Method not implemented.');
+        },
     };
 
     export const history: History = {
@@ -258,6 +262,10 @@ export module stubs {
         conditionalDeleteResource(request, queryParams) {
             throw new Error('Method not implemented.');
         },
+
+        getActiveSubscriptions(params: { tenantId: string }) {
+            throw new Error('Method not implemented.');
+        },
     };
 
     export const bulkDataAccess: BulkDataAccess = {

src/validator.ts

@@ -1,7 +1,12 @@
+import { TypeOperation } from './constants';
+
 export interface Validator {
     /**
      * returns a resolved Promise if the resource is valid. Otherwise throws an error
      * @throws InvalidResourceError
      */
-    validate(resource: any): Promise<void>;
+    validate(
+        resource: any,
+        { tenantId, typeOperation }: { tenantId?: string; typeOperation?: TypeOperation },
+    ): Promise<void>;
 }