feat: add getCapabilities method to Search interface (#42)

src/search.ts

@@ -44,6 +44,21 @@ export interface SearchFilter {
     logicalOperator: 'AND' | 'OR';
 }
 
+export interface SearchCapabilityStatement {
+    [resourceType: string]: SearchCapabilities;
+}
+
+export interface SearchCapabilities {
+    searchParam: {
+        name: string;
+        definition?: string;
+        type: string;
+        documentation?: string;
+    }[];
+    searchInclude: string[];
+    searchRevInclude: string[];
+}
+
 export interface Search {
     /**
      * Searches a specific Resource Type based on some filter criteria
@@ -53,4 +68,9 @@ export interface Search {
      * Searches all Resource Types based on some filter criteria
      */
     globalSearch(request: GlobalSearchRequest): Promise<SearchResponse>;
+    /**
+     * Retrieve a subset of the CapabilityStatement with the search-related fields for all resources
+     * See https://www.hl7.org/fhir/capabilitystatement.html
+     */
+    getCapabilities(): Promise<SearchCapabilityStatement>;
 }

src/stubs.ts

@@ -4,7 +4,7 @@
  */
 
 /* eslint-disable @typescript-eslint/no-unused-vars */
-import { Search } from './search';
+import { Search, SearchCapabilityStatement } from './search';
 import { History } from './history';
 import { AccessBulkDataJobRequest, Authorization, GetSearchFilterBasedOnIdentityRequest } from './authorization';
 import { Persistence } from './persistence';
@@ -23,6 +23,9 @@ export module stubs {
     };
 
     export const search: Search = {
+        async getCapabilities(): Promise<SearchCapabilityStatement> {
+            throw new Error('Method not implemented.');
+        },
         typeSearch(request) {
             throw new Error('Method not implemented.');
         },