oro-sdk-apis 1.35.0 → 1.38.0

package/dist/services/consult.d.ts

@@ -1,5 +1,5 @@
 import { APIService } from './api';
-import { Uuid, Consult, ConsultRequest, MedicalStatus, ConsultTransmission, TransmissionStatus } from '../models';
+import { Uuid, Consult, ConsultRequest, MedicalStatus, ConsultTransmission, ClosedReasonType, TransmissionStatus } from '../models';
 export declare class ConsultService {
     private api;
     private baseURL;
@@ -43,6 +43,8 @@ export declare class ConsultService {
     getConsultByUUID(uuidConsult: Uuid, uuidPractice?: Uuid): Promise<Consult>;
     updateConsultByUUID(uuidConsult: Uuid, consult: {
         statusMedical?: MedicalStatus;
+        closedReasonType?: ClosedReasonType;
+        closedReasonDescription?: string;
         uuidAssignedDoctor?: Uuid;
         neverExpires?: boolean;
     }, uuidPractice?: Uuid, uuidRequester?: Uuid): Promise<Consult>;

package/dist/services/index.d.ts

@@ -4,6 +4,7 @@ export * from './axios';
 export * from './consult';
 export * from './diagnosis';
 export * from './guard';
+export * from './search';
 export * from './practice';
 export * from './teller';
 export * from './vault';

package/dist/services/practice.d.ts

@@ -75,7 +75,17 @@ export declare class PracticeService {
      */
     practiceCreatePaymentsIntent(practiceUuid: Uuid, planId: number, userEmail: string, isoLocality?: string, url_subdomain?: string, consultRequest?: ConsultRequestMetadata): Promise<PracticePaymentIntent>;
     practiceGetPaymentsIntent(practiceUuid: Uuid, paymentIntentId: number): Promise<PracticePaymentIntent>;
-    practiceUpdatePaymentsIntent(practiceUuid: string, idPraticePaymentIntent: number, practicePaymentIntent: PracticePaymentIntent, userEmail: string, promotionCode?: string): Promise<PracticePaymentIntent>;
+    /**
+     * Updates a PracticePaymentIntent
+     * @param practiceUuid the practice uuid
+     * @param idPraticePaymentIntent the id of the PracticePaymentIntent to update
+     * @param practicePaymentIntent the desired PracticePaymentIntent
+     * @param userEmail the email of the user
+     * @param promotionCode (optional) promotional code to apply
+     * @param finalize (optional) if true will finalize the PracticePaymentIntent and related Stripe.Invoice. Once, finalized you cannot modify the PracticePaymentIntent anymore.
+     * @returns the updated PracticePaymentIntent
+     */
+    practiceUpdatePaymentsIntent(practiceUuid: string, idPraticePaymentIntent: number, practicePaymentIntent: PracticePaymentIntent, userEmail: string, promotionCode?: string, finalize?: boolean): Promise<PracticePaymentIntent>;
     /**
      * Invoice
      * @param practiceUuid UUID of the practice to get the invoice from

package/dist/services/search.d.ts

@@ -0,0 +1,18 @@
+import { APIService } from "./api";
+import { SearchResponse, Terms } from "../models/search";
+export declare class SearchService {
+    private api;
+    private baseURL;
+    constructor(api: APIService, baseURL: string);
+    /**
+     * Creates search indexes for the terms passed in order to be able to search for it in the future
+     * @param consultUUID
+     * @param terms the search terms to be indexed
+     */
+    index(consultUUID: string, terms: Terms): Promise<any>;
+    /**
+     * Searches for the consultations corresponding to the search terms entered in the query
+     * @param terms array of search terms
+     */
+    search(terms: Terms): Promise<SearchResponse>;
+}

package/dist/services/teller.d.ts

@@ -1,11 +1,11 @@
 import { APIService } from './api';
-import { Consult, DataCreateResponse, LockboxDataRequest, MedicalStatus, Uuid, ResumeConsultEmailRequest } from '../models';
+import { ClosedReasonType, Consult, DataCreateResponse, LockboxDataRequest, MedicalStatus, ResumeConsultEmailRequest, Uuid } from '../models';
 export declare class TellerService {
     private api;
     private baseURL;
     constructor(api: APIService, baseURL: string);
     lockboxDataStore(lockboxUuid: Uuid, req: LockboxDataRequest, lockboxOwnerUuid?: Uuid, previousDataUuid?: Uuid): Promise<DataCreateResponse>;
-    updateConsultByUUID(patientUuid: Uuid, uuidConsult: Uuid, statusMedical: MedicalStatus, neverExpires?: boolean): Promise<Consult>;
+    updateConsultByUUID(patientUuid: Uuid, uuidConsult: Uuid, statusMedical: MedicalStatus, closedReasonType?: ClosedReasonType, closedReasonDescription?: string, neverExpires?: boolean): Promise<Consult>;
     /**
      * This function notifies teller that the fax sent for a specific consult did not get through
      * @todo - Make service only exposed route

package/package.json

@@ -1,5 +1,5 @@
 {
-    "version": "1.35.0",
+    "version": "1.38.0",
     "main": "dist/index.js",
     "typings": "dist/index.d.ts",
     "files": [

package/src/helpers/init.ts

@@ -5,6 +5,7 @@ import {
     DiagnosisService,
     GuardService,
     PracticeService,
+    SearchService,
     TellerService,
     VaultService,
     WorkflowService,
@@ -28,6 +29,7 @@ export const init = (
         consultBaseURL,
         vaultBaseURL,
         guardBaseURL,
+        searchBaseURL,
         workflowBaseURL,
         diagnosisBaseURL,
     } = services
@@ -41,6 +43,7 @@ export const init = (
         consultService: consultBaseURL ? new ConsultService(apiService, consultBaseURL) : undefined,
         vaultService: vaultBaseURL ? new VaultService(apiService, vaultBaseURL) : undefined,
         guardService: guardBaseURL ? new GuardService(apiService, guardBaseURL) : undefined,
+        searchService: searchBaseURL ? new SearchService(apiService, searchBaseURL) : undefined,
         workflowService: workflowBaseURL ? new WorkflowService(apiService, workflowBaseURL) : undefined,
         diagnosisService: diagnosisBaseURL ? new DiagnosisService(apiService, diagnosisBaseURL) : undefined,
     }

package/src/models/consult.ts

@@ -82,6 +82,59 @@ export enum TaskStatus {
     Done = 'Done',
 }
 
+export enum ClosedReasonType {
+    /**
+     * A completed consultation
+     */
+     Completed = "Completed",
+     /**
+      * The conclusion was that what the patient submitted was not a disease
+      */
+     NotADisease = "NotADisease",
+     /**
+      * The consultation was not appropriate for virtual
+      */
+     NotAppropriateForVirtual = "NotAppropriateForVirtual",
+     /**
+      * Any other reason why the consultation was closed
+      */
+     Other = "Other",
+     /**
+      * A consultation that is required to be done in person
+      */
+     RequiresInPerson = "RequiresInPerson"
+}
+
+export interface ClosedConsultReasonInsertFields {
+    /**
+     * The uuid of the consultation
+     */
+    consult_uuid: string
+    /**
+     * The reason why the consultation was closed
+     */
+    closed_reason_type: ClosedReasonType
+    /**
+     * The description why the consultation was closed
+     */
+    closed_reason_description: string
+    /**
+     * When the consultation was closed
+     */
+    created_at: string
+}
+
+export interface ConsultClosedReason {
+    /**
+     * The reason why the consultation was closed
+     */
+    closedReasonType: ClosedReasonType
+    /**
+     * The description why the consultation was closed
+     */
+    closedReasonDescription?: string
+}
+
 export interface ConsultRequest {
     uuidPractice: string
     tagSpecialtyRequired: string
@@ -104,6 +157,7 @@ export interface Consult {
     statusTask?: TaskStatus
     hasTransmissions?: boolean
     assignedAssistant?: ConsultAssignedAssistant[]
+    closeConsultReason?: ConsultClosedReason
     shortId?: string
     createdAt?: string
     expiresAt?: string

package/src/models/init.ts

@@ -3,6 +3,7 @@ import {
     ConsultService,
     DiagnosisService,
     GuardService,
+    SearchService,
     PracticeService,
     TellerService,
     VaultService,
@@ -16,6 +17,7 @@ export interface ServiceCollectionRequest {
     tellerBaseURL?: string
     vaultBaseURL?: string
     guardBaseURL?: string
+    searchBaseURL?: string
     practiceBaseURL?: string
     consultBaseURL?: string
     workflowBaseURL?: string
@@ -32,6 +34,7 @@ export interface ServiceCollection {
     consultService?: ConsultService
     vaultService?: VaultService
     guardService?: GuardService
+    searchService?: SearchService
     workflowService?: WorkflowService
     diagnosisService?: DiagnosisService
 }

package/src/models/practice.ts

@@ -143,40 +143,40 @@ export enum PracticeConfigKind {
     PracticePharmacyPicker = 'PracticePharmacyPicker',
     PracticePrescriptionFields = 'PracticePrescriptionFields',
     PractitionerChatbox = 'PractitionerChatbox',
-    PractitionerConsultList = 'PractitionerConsultList'
+    PractitionerConsultList = 'PractitionerConsultList',
 }
 
 /**
  * Defines the close consultation types to hide in the close consultation modal of a practice
  */
- export type PracticeConfigPracticeCloseConsultationTypes = PracticeConfig<
- PracticeConfigKind.PracticeCloseConsultationTypes,
- {
-     /**
-      * Should hide item with value "Completed"
-      */
-     hideCompleted?: boolean
-
-     /**
-      * Should hide item with value "Requires-in-person"
-      */
-     hideRequiresInPerson?: boolean
-
-     /**
-      * Should hide item with value "Other"
-      */
-     hideOther?: boolean
-
-     /**
-      * Should hide item with value "Not-a-disease"
-      */
-     hideNotADisease?: boolean
-
-     /**
-      * Should hide item with value "Appropriate-for-virtual"
-      */
-     hideNotAppropriateForVirtual?: boolean
- }
+export type PracticeConfigPracticeCloseConsultationTypes = PracticeConfig<
+    PracticeConfigKind.PracticeCloseConsultationTypes,
+    {
+        /**
+         * Should hide item with value "Completed"
+         */
+        hideCompleted?: boolean
+
+        /**
+         * Should hide item with value "Requires-in-person"
+         */
+        hideRequiresInPerson?: boolean
+
+        /**
+         * Should hide item with value "Other"
+         */
+        hideOther?: boolean
+
+        /**
+         * Should hide item with value "Not-a-disease"
+         */
+        hideNotADisease?: boolean
+
+        /**
+         * Should hide item with value "Appropriate-for-virtual"
+         */
+        hideNotAppropriateForVirtual?: boolean
+    }
 >
 
 /**
@@ -202,95 +202,95 @@ export interface PracticeConfig<K, T> {
 
 /**
  * This type is for test (do not remove without updating the integration tests)
- */ 
- export type PracticeConfigPracticeConfigExample = PracticeConfig<
- PracticeConfigKind.PracticeConfigExample,
- { primaryColor?: string }
+ */
+export type PracticeConfigPracticeConfigExample = PracticeConfig<
+    PracticeConfigKind.PracticeConfigExample,
+    { primaryColor?: string }
 >
 
 /**
  * Defines the practice cookie banner
  */
- export type PracticeConfigPracticeCookieBanner = PracticeConfig<
- PracticeConfigKind.PracticeCookieBanner,
- {
-     showCookieBanner?: boolean
-     policyLink?: string
-     useOfCookieLink?: string
- }
+export type PracticeConfigPracticeCookieBanner = PracticeConfig<
+    PracticeConfigKind.PracticeCookieBanner,
+    {
+        showCookieBanner?: boolean
+        policyLink?: string
+        useOfCookieLink?: string
+    }
 >
 
 /**
  * This interface describes all practice css variables
  * The keys should reflect the exact css name
  */
- export type PracticeConfigPracticeCssVariables = PracticeConfig<
- PracticeConfigKind.PracticeCssVariables,
- Record<string, string>
+export type PracticeConfigPracticeCssVariables = PracticeConfig<
+    PracticeConfigKind.PracticeCssVariables,
+    Record<string, string>
 >
 
 /**
  * Defines the font of the practice css url
  */
- export type PracticeConfigPracticeFontsLinks = PracticeConfig<
- PracticeConfigKind.PracticeFontsLinks,
- {
-     /**
-      * sans serif font family
-      */
-     sansSerif?: string
-     /**
-      * serif font family
-      */
-     serif?: string
- }
+export type PracticeConfigPracticeFontsLinks = PracticeConfig<
+    PracticeConfigKind.PracticeFontsLinks,
+    {
+        /**
+         * sans serif font family
+         */
+        sansSerif?: string
+        /**
+         * serif font family
+         */
+        serif?: string
+    }
 >
 
 /**
  * Defines the locale switcher config
  */
- export type PracticeConfigPracticeLocaleSwitcher = PracticeConfig<
- PracticeConfigKind.PracticeLocaleSwitcher,
- {
-     /**
-      * Should hide the locale switcher
-      */
-     hideLocaleSwitcher?: boolean
- }
+export type PracticeConfigPracticeLocaleSwitcher = PracticeConfig<
+    PracticeConfigKind.PracticeLocaleSwitcher,
+    {
+        /**
+         * Should hide the locale switcher
+         */
+        hideLocaleSwitcher?: boolean
+    }
 >
 
 /**
- * Defines the online pharmacy address of the practice 
+ * Defines the online pharmacy address of the practice
  */
- export type PracticeConfigPracticeOnlinePharmacy = PracticeConfig<
- PracticeConfigKind.PracticePharmacyPicker,
- {
-     /**
-      * The address of the online pharmacy
-      */
-     onlinePharmacy?: PlaceData
- }
+export type PracticeConfigPracticeOnlinePharmacy = PracticeConfig<
+    PracticeConfigKind.PracticePharmacyPicker,
+    {
+        /**
+         * The address of the online pharmacy
+         */
+        onlinePharmacy?: PlaceData
+    }
 >
 
 /**
  * Defines the consultation chatbox configs
  */
- export type PracticeConfigPractitionerChatbox = PracticeConfig<
- PracticeConfigKind.PractitionerChatbox,
- {
-     /**
-      * If defined will replace the automatic chatbox comment notifiying the patient a new treatment plan has been added. Indexed by locale.
-      */
-     planAddedMessage?: { [languageISO639_3: string]: string }
-     /**
-      * If defined will replace the automatic chatbox comment notifiying the patient a new treatment plan has been updated. Indexed by locale.
-      */
-     planUpdatedMessage?: { [languageISO639_3: string]: string }
-     /**
-      * If defined will replace the automatic chatbox comment notifiying the patient a new exam has been dispatched. Indexed by locale.
-      */
-     examsUpdatedMessage?: { [languageISO639_3: string]: string }
- }
+export type PracticeConfigPractitionerChatbox = PracticeConfig<
+    PracticeConfigKind.PractitionerChatbox,
+    {
+        /**
+         * If defined will replace the automatic chatbox comment notifiying the patient a new treatment plan has been added. Indexed by locale.
+         */
+        planAddedMessage?: { [languageISO639_3: string]: string }
+        /**
+         * If defined will replace the automatic chatbox comment notifiying the patient a new treatment plan has been updated. Indexed by locale.
+         */
+        planUpdatedMessage?: { [languageISO639_3: string]: string }
+        /**
+         * If defined will replace the automatic chatbox comment notifiying the patient a new exam has been dispatched. Indexed by locale.
+         */
+        examsUpdatedMessage?: { [languageISO639_3: string]: string }
+    }
 >
 
 /**
@@ -329,7 +329,7 @@ export type PracticeConfigPracticePrescriptionFields = PracticeConfig<
          */
         yCoordinate?: number
     }
-    >
+>
 
 export type PracticeConfigs =
     | PracticeConfigPractitionerConsultList
@@ -444,7 +444,10 @@ export interface PracticePaymentIntent {
     numPlatformFeeAmount: number
     idStripeInvoice: string
     idStripePaymtIntent: string
-    stripeClientSecret: string
+    /**
+     * This value is set only after the PracticePaymentIntent has been finalized and ready to be paid
+     */
+    stripeClientSecret?: string
     dateCreatedAt?: Date
     dateUpdateAt?: Date
 }
@@ -612,4 +615,4 @@ export interface PracticeInvoice {
     subtotal: number
     currency: string
     discount: number
-}
+}

package/src/models/search.ts

@@ -0,0 +1,34 @@
+export interface SearchRequest {
+    terms: Terms
+}
+
+export interface SearchResponse {
+    results: SearchResult[]
+}
+
+export interface SearchResult {
+    consultUUID: string
+    kind: string
+    score: number
+}
+
+export interface IndexRequest {
+    consultUUID: string
+    terms: Terms
+}
+
+export type Terms = Term[]
+export interface Term {
+    kind?: string
+    value: string
+}
+
+
+export enum IndexKind {
+    consultUuid,
+    consultShortid,
+    firstName,
+    lastName,
+    healthId,
+    dob,
+}

package/src/services/consult.ts

@@ -5,6 +5,7 @@ import {
     ConsultRequest,
     MedicalStatus,
     ConsultTransmission,
+    ClosedReasonType,
     TransmissionKind,
     TransmissionStatus,
 } from '../models'
@@ -141,6 +142,8 @@ export class ConsultService {
         uuidConsult: Uuid,
         consult: {
             statusMedical?: MedicalStatus
+            closedReasonType?: ClosedReasonType
+            closedReasonDescription?: string
             uuidAssignedDoctor?: Uuid
             neverExpires?: boolean
         },

package/src/services/index.ts

@@ -4,6 +4,7 @@ export * from './axios'
 export * from './consult'
 export * from './diagnosis'
 export * from './guard'
+export * from './search'
 export * from './practice'
 export * from './teller'
 export * from './vault'

package/src/services/practice.ts

@@ -215,12 +215,23 @@ export class PracticeService {
         )
     }
 
+    /**
+     * Updates a PracticePaymentIntent
+     * @param practiceUuid the practice uuid
+     * @param idPraticePaymentIntent the id of the PracticePaymentIntent to update
+     * @param practicePaymentIntent the desired PracticePaymentIntent
+     * @param userEmail the email of the user
+     * @param promotionCode (optional) promotional code to apply
+     * @param finalize (optional) if true will finalize the PracticePaymentIntent and related Stripe.Invoice. Once, finalized you cannot modify the PracticePaymentIntent anymore.
+     * @returns the updated PracticePaymentIntent
+     */
     public practiceUpdatePaymentsIntent(
         practiceUuid: string,
         idPraticePaymentIntent: number,
         practicePaymentIntent: PracticePaymentIntent,
         userEmail: string,
-        promotionCode?: string
+        promotionCode?: string,
+        finalize?: boolean
     ) {
         return this.api.put<PracticePaymentIntent>(
             `${this.baseURL}/v1/practices/${practiceUuid}/payments/intents/${idPraticePaymentIntent}`,
@@ -228,7 +239,7 @@ export class PracticeService {
                 ...practicePaymentIntent,
                 hashUserEmail: userEmail ? this.getPaymentIntentHashedEmail(userEmail) : undefined,
             },
-            { params: { promotionCode } }
+            { params: { promotionCode, finalize } }
         )
     }
 

package/src/services/search.ts

@@ -0,0 +1,39 @@
+import {APIService} from "./api";
+import {IndexRequest, SearchRequest, SearchResponse, Terms} from "../models/search";
+
+export class SearchService {
+    constructor(private api: APIService, private baseURL: string) {}
+
+    /**
+     * Creates search indexes for the terms passed in order to be able to search for it in the future
+     * @param consultUUID
+     * @param terms the search terms to be indexed
+     */
+    public index(
+        consultUUID: string,
+        terms: Terms
+    ): Promise<any> {
+        return this.api.post<IndexRequest>(
+            `${this.baseURL}/v1/search`,
+            <IndexRequest> {
+                consultUUID,
+                terms
+            }
+        )
+    }
+
+    /**
+     * Searches for the consultations corresponding to the search terms entered in the query
+     * @param terms array of search terms
+     */
+    public search(
+        terms: Terms
+    ): Promise<SearchResponse> {
+        return this.api.post<SearchResponse>(
+            `${this.baseURL}/v1/search`,
+            <SearchRequest> {
+                terms
+            }
+        )
+    }
+}

package/src/services/teller.ts

@@ -1,11 +1,12 @@
 import { APIService } from './api'
 import {
+    ClosedReasonType,
     Consult,
     DataCreateResponse,
     LockboxDataRequest,
     MedicalStatus,
-    Uuid,
     ResumeConsultEmailRequest,
+    Uuid,
 } from '../models'
 export class TellerService {
     constructor(private api: APIService, private baseURL: string) {}
@@ -28,11 +29,15 @@ export class TellerService {
         patientUuid: Uuid,
         uuidConsult: Uuid,
         statusMedical: MedicalStatus,
+        closedReasonType?: ClosedReasonType,
+        closedReasonDescription?: string,
         neverExpires?: boolean
     ): Promise<Consult> {
         return this.api.put<Consult>(`${this.baseURL}/v1/consults/${uuidConsult}`, {
             patientUuid,
             statusMedical,
+            closedReasonType,
+            closedReasonDescription,
             neverExpires,
         })
     }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2021 ORO Health Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.