oro-sdk-apis 1.28.0 → 1.29.0-dev1

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;
@@ -22,7 +22,7 @@ export declare class ConsultService {
      * @param filterAssignee array of practitioner uuids with which you want to filter the consultations
      * @returns a number of consult
      */
-    countConsults(uuidPractice?: Uuid, uuidRequester?: Uuid, statusesMedical?: MedicalStatus[], statusesExclude?: MedicalStatus[], shortId?: string, columnToSortTo?: string[], orderToSortTo?: string[], perPage?: number, indexPage?: number, filterAssignedDoctor?: string, filterCurrentPractitioner?: string, filterIsoLocality?: string[], filterAssignee?: string[]): Promise<number>;
+    countConsults(uuidPractice?: Uuid, uuidRequester?: Uuid, statusesMedical?: MedicalStatus[], statusesExclude?: MedicalStatus[], closedReasonTypes?: ClosedReasonType[], closedReasonMsgs?: string[], shortId?: string, columnToSortTo?: string[], orderToSortTo?: string[], perPage?: number, indexPage?: number, filterAssignedDoctor?: string, filterCurrentPractitioner?: string, filterIsoLocality?: string[], filterAssignee?: string[]): Promise<number>;
     /**
      * This function get consults using parameters
      * @param uuidPractice the practice uuid
@@ -39,10 +39,12 @@ export declare class ConsultService {
      * @param filterIsoLocality the of isoLocality to filter with
      * @returns a list of consult
      */
-    getConsults(uuidPractice?: Uuid, uuidRequester?: Uuid, statusesMedical?: MedicalStatus[], statusesExclude?: MedicalStatus[], shortId?: string, columnToSortTo?: string[], orderToSortTo?: string[], perPage?: number, indexPage?: number, filterAssignedDoctor?: string, filterCurrentPractitioner?: string, filterIsoLocality?: string[], filterAssignee?: string[]): Promise<Consult[]>;
+    getConsults(uuidPractice?: Uuid, uuidRequester?: Uuid, statusesMedical?: MedicalStatus[], statusesExclude?: MedicalStatus[], closedReasonTypes?: ClosedReasonType[], closedReasonMsgs?: string[], shortId?: string, columnToSortTo?: string[], orderToSortTo?: string[], perPage?: number, indexPage?: number, filterAssignedDoctor?: string, filterCurrentPractitioner?: string, filterIsoLocality?: string[], filterAssignee?: string[]): Promise<Consult[]>;
     getConsultByUUID(uuidConsult: Uuid, uuidPractice?: Uuid): Promise<Consult>;
     updateConsultByUUID(uuidConsult: Uuid, consult: {
         statusMedical?: MedicalStatus;
+        closedReasonType?: ClosedReasonType;
+        closedReasonMsg?: string;
         uuidAssignedDoctor?: Uuid;
         neverExpires?: boolean;
     }, uuidPractice?: Uuid, uuidRequester?: Uuid): Promise<Consult>;

package/dist/services/teller.d.ts

@@ -1,11 +1,11 @@
 import { APIService } from './api';
-import { Consult, DataCreateResponse, LockboxDataRequest, MedicalStatus, Uuid, ResumeConsultEmailRequest } from '../models';
+import { Consult, DataCreateResponse, LockboxDataRequest, MedicalStatus, Uuid, ResumeConsultEmailRequest, ClosedReasonType } 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, closedReasonMsg?: 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.28.0",
+    "version": "1.29.0-dev1",
     "main": "dist/index.js",
     "typings": "dist/index.d.ts",
     "files": [

package/src/models/consult.ts

@@ -82,6 +82,14 @@ export enum TaskStatus {
     Done = 'Done',
 }
 
+export enum ClosedReasonType {
+    Completed = "Completed",
+    NotADisease = "NotADisease",
+    NotAppropriateForVirtual = "NotAppropriateForVirtual",
+    Other = "Other",
+    RequiresInPerson = "RequiresInPerson"
+}
+
 export interface ConsultRequest {
     uuidPractice: string
     tagSpecialtyRequired: string
@@ -102,6 +110,8 @@ export interface Consult {
     uuidAssignedDoctor: string
     uuidCurrentAssigned: string
     statusTask?: TaskStatus
+    closedReasonType?: ClosedReasonType
+    closedReasonMsg?: string
     hasTransmissions?: boolean
     assignedAssistant?: ConsultAssignedAssistant[]
     shortId?: string

package/src/models/practice.ts

@@ -122,85 +122,194 @@ export interface PracticeAccount {
     urlSubdomain?: string
 }
 
+/**
+ * Defines all the practice config kind.
+ *
+ * Please respect the following when defining a new practice config:
+ * - be really specific on its role
+ * - all configs needs to have default values in app
+ * - the default behavior should always to be display the feature.
+ * In other words, practice configs should either be used to hide a functionnality or overwrite a default behavior.
+ * To be extra explicit, if you want to show a functionnality only in one practice, you will have to add a practice configs in all other practice to hide it (yes it is cumbersome).
+ *
+ */
 export enum PracticeConfigKind {
-    PractitionerConsultList = 'PractitionerConsultList',
-    PractitionerChatbox = 'PractitionerChatbox',
+    PracticeCloseConsultationTypes = 'PracticeCloseConsultationTypes',
     PracticeConfigExample = 'PracticeConfigExample',
-    PracticeLocaleSwitcher = 'PracticeLocaleSwitcher',
     PracticeCookieBanner = 'PracticeCookieBanner',
-    PracticePharmacyPicker = 'PracticePharmacyPicker',
     PracticeCssVariables = 'PracticeCssVariables',
     PracticeFontsLinks = 'PracticeFontsLinks',
+    PracticeLocaleSwitcher = 'PracticeLocaleSwitcher',
+    PracticePharmacyPicker = 'PracticePharmacyPicker',
+    PractitionerChatbox = 'PractitionerChatbox',
+    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
+ }
+>
+
+/**
+ * Generic interface of a practice config
+ *
+ * Practice configs needs to have a JSDoc for **all** interface and fields.
+ *
+ */
 export interface PracticeConfig<K, T> {
+    /**
+     * The uuid of the practice to apply the config
+     */
     uuidPractice: string
-    kind: K // PracticeConfigKind
+    /**
+     * The kind of the practice config. Used as a discriminator to help auto-completion.
+     */
+    kind: PracticeConfigKind
+    /**
+     * The actual interface of the config
+     */
     config: T
 }
 
-export type PracticeConfigPractitionerConsultList = PracticeConfig<
-    PracticeConfigKind.PractitionerConsultList,
-    {
-        hideLocality?: boolean
-        hideFax?: boolean
-        hideExpiresAt?: boolean
-        showExpirationInDays?: boolean
-    }
+/**
+ * This type is for test (do not remove without updating the integration tests)
+ */ 
+ export type PracticeConfigPracticeConfigExample = PracticeConfig<
+ PracticeConfigKind.PracticeConfigExample,
+ { primaryColor?: string }
 >
 
-export type PracticeConfigPracticeLocaleSwitcher = PracticeConfig<
-    PracticeConfigKind.PracticeLocaleSwitcher,
-    {
-        hideLocaleSwitcher?: boolean
-    }
+/**
+ * Defines the practice cookie banner
+ */
+ export type PracticeConfigPracticeCookieBanner = PracticeConfig<
+ PracticeConfigKind.PracticeCookieBanner,
+ {
+     showCookieBanner?: boolean
+     policyLink?: string
+     useOfCookieLink?: string
+ }
 >
 
-export type PracticeConfigPractitionerChatbox = PracticeConfig<
-    PracticeConfigKind.PractitionerChatbox,
-    {
-        planAddedMessage?: { [languageISO639_3: string]: string }
-        planUpdatedMessage?: { [languageISO639_3: string]: string }
-        examsUpdatedMessage?: { [languageISO639_3: string]: 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 PracticeConfigPracticeOnlinePharmacy = PracticeConfig<
-    PracticeConfigKind.PracticePharmacyPicker,
-    {
-        onlinePharmacy?: PlaceData
-    }
+/**
+ * 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 PracticeConfigPracticeCookieBanner = PracticeConfig<
-    PracticeConfigKind.PracticeCookieBanner,
-    {
-        showCookieBanner?: boolean
-        policyLink?: string
-        useOfCookieLink?: string
-    }
+/**
+ * Defines the locale switcher config
+ */
+ export type PracticeConfigPracticeLocaleSwitcher = PracticeConfig<
+ PracticeConfigKind.PracticeLocaleSwitcher,
+ {
+     /**
+      * Should hide the locale switcher
+      */
+     hideLocaleSwitcher?: boolean
+ }
 >
 
-// This type is for demonstration only for now
-export type PracticeConfigPracticeConfigExample = PracticeConfig<
-    PracticeConfigKind.PracticeConfigExample,
-    { primaryColor?: string }
+/**
+ * Defines the online pharmacy address of the practice 
+ */
+ export type PracticeConfigPracticeOnlinePharmacy = PracticeConfig<
+ PracticeConfigKind.PracticePharmacyPicker,
+ {
+     /**
+      * The address of the online pharmacy
+      */
+     onlinePharmacy?: PlaceData
+ }
 >
 
 /**
- * This interface describes all practice css variables
- * The keys should reflect the exact css name
+ * Defines the consultation chatbox configs
  */
-export type PracticeConfigPracticeCssVariables = PracticeConfig<
-    PracticeConfigKind.PracticeCssVariables,
-    Record<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 }
+ }
 >
 
-export type PracticeConfigPracticeFontsLinks = PracticeConfig<
-    PracticeConfigKind.PracticeFontsLinks,
+/**
+ * This config is used to configure the layout of the consult list for practitioners
+ */
+export type PracticeConfigPractitionerConsultList = PracticeConfig<
+    PracticeConfigKind.PractitionerConsultList,
     {
-        sansSerif?: string,
-        serif?: string
+        /**
+         * Should hide the locality column
+         */
+        hideLocality?: boolean
+        /**
+         * Should hide the fax column
+         */
+        hideFax?: boolean
+        /**
+         * Should hide the expires at column
+         */
+        hideExpiresAt?: boolean
     }
 >
 
@@ -212,7 +321,7 @@ export type PracticeConfigs =
     | PracticeConfigPracticeOnlinePharmacy
     | PracticeConfigPracticeCssVariables
     | PracticeConfigPracticeFontsLinks
-    | PracticeConfigPracticeConfigExample // Here for demonstration only
+    | PracticeConfigPracticeConfigExample // Here for integration tests only
 
 export interface PracticeWorkflow {
     id?: number ///optional for insertion
@@ -411,14 +520,15 @@ export interface Practitioner {
 }
 
 export interface HydratedPracticeConfigs {
-    [PracticeConfigKind.PractitionerConsultList]?: PracticeConfigPractitionerConsultList
-    [PracticeConfigKind.PractitionerChatbox]?: PracticeConfigPractitionerChatbox
+    [PracticeConfigKind.PracticeCloseConsultationTypes]?: PracticeConfigPracticeCloseConsultationTypes
     [PracticeConfigKind.PracticeConfigExample]?: PracticeConfigPracticeConfigExample
-    [PracticeConfigKind.PracticeLocaleSwitcher]?: PracticeConfigPracticeLocaleSwitcher
     [PracticeConfigKind.PracticeCookieBanner]?: PracticeConfigPracticeCookieBanner
-    [PracticeConfigKind.PracticePharmacyPicker]?: PracticeConfigPracticeOnlinePharmacy
     [PracticeConfigKind.PracticeCssVariables]?: PracticeConfigPracticeCssVariables
     [PracticeConfigKind.PracticeFontsLinks]?: PracticeConfigPracticeFontsLinks
+    [PracticeConfigKind.PracticeLocaleSwitcher]?: PracticeConfigPracticeLocaleSwitcher
+    [PracticeConfigKind.PracticePharmacyPicker]?: PracticeConfigPracticeOnlinePharmacy
+    [PracticeConfigKind.PractitionerChatbox]?: PracticeConfigPractitionerChatbox
+    [PracticeConfigKind.PractitionerConsultList]?: PracticeConfigPractitionerConsultList
 }
 
 export interface Practice {

package/src/services/consult.ts

@@ -5,6 +5,7 @@ import {
     ConsultRequest,
     MedicalStatus,
     ConsultTransmission,
+    ClosedReasonType,
     TransmissionKind,
     TransmissionStatus,
 } from '../models'
@@ -38,6 +39,8 @@ export class ConsultService {
         uuidRequester?: Uuid,
         statusesMedical?: MedicalStatus[],
         statusesExclude?: MedicalStatus[],
+        closedReasonTypes?: ClosedReasonType[],
+        closedReasonMsgs?: string[],
         shortId?: string,
         columnToSortTo?: string[],
         orderToSortTo?: string[],
@@ -57,6 +60,8 @@ export class ConsultService {
                         uuidRequester,
                         statusesMedical,
                         statusesExclude,
+                        closedReasonTypes,
+                        closedReasonMsgs,
                         shortId,
                         perPage,
                         page: indexPage,
@@ -104,6 +109,8 @@ export class ConsultService {
         uuidRequester?: Uuid,
         statusesMedical?: MedicalStatus[],
         statusesExclude?: MedicalStatus[],
+        closedReasonTypes?: ClosedReasonType[],
+        closedReasonMsgs?: string[],
         shortId?: string,
         columnToSortTo?: string[],
         orderToSortTo?: string[],
@@ -120,6 +127,8 @@ export class ConsultService {
                 uuidRequester,
                 statusesMedical,
                 statusesExclude,
+                closedReasonTypes,
+                closedReasonMsgs,
                 shortId,
                 perPage,
                 page: indexPage,
@@ -141,6 +150,8 @@ export class ConsultService {
         uuidConsult: Uuid,
         consult: {
             statusMedical?: MedicalStatus
+            closedReasonType?: ClosedReasonType
+            closedReasonMsg?: string
             uuidAssignedDoctor?: Uuid
             neverExpires?: boolean
         },

package/src/services/teller.ts

@@ -6,6 +6,7 @@ import {
     MedicalStatus,
     Uuid,
     ResumeConsultEmailRequest,
+    ClosedReasonType,
 } 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,
+        closedReasonMsg?: string,
         neverExpires?: boolean
     ): Promise<Consult> {
         return this.api.put<Consult>(`${this.baseURL}/v1/consults/${uuidConsult}`, {
             patientUuid,
             statusMedical,
+            closedReasonType,
+            closedReasonMsg,
             neverExpires,
         })
     }