oro-sdk-apis 1.24.1 → 1.27.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, ReasonWhyClosed, 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[], reasonsWhyClosed?: ReasonWhyClosed[], reasonsWhyOther?: 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,7 +39,7 @@ 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[], reasonsWhyClosed?: ReasonWhyClosed[], reasonsWhyOther?: 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;

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, ReasonWhyClosed } 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, reasonWhyClosed?: ReasonWhyClosed, reasonWhyOther?: 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.24.1",
+    "version": "1.27.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 ReasonWhyClosed {
+    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
+    reasonWhyClosed?: ReasonWhyClosed
+    reasonWhyOther?: string
     hasTransmissions?: boolean
     assignedAssistant?: ConsultAssignedAssistant[]
     shortId?: string

package/src/models/practice.ts

@@ -110,7 +110,7 @@ export enum PracticeEmailKind {
     ExamResult = 'ExamResult',
     Reassigned = 'Reassigned',
     OnlinePharmacyFaxSent = 'OnlinePharmacyFaxSent',
-    ResumeConsult = 'ResumeConsult'
+    ResumeConsult = 'ResumeConsult',
 }
 
 export interface PracticeAccount {
@@ -125,10 +125,11 @@ export interface PracticeAccount {
 export enum PracticeConfigKind {
     PractitionerConsultList = 'PractitionerConsultList',
     PractitionerChatbox = 'PractitionerChatbox',
-    PracticeTheme = 'PracticeTheme',
+    PracticeConfigExample = 'PracticeConfigExample',
     PracticeLocaleSwitcher = 'PracticeLocaleSwitcher',
     PracticeCookieBanner = 'PracticeCookieBanner',
     PracticePharmacyPicker = 'PracticePharmacyPicker',
+    PracticeCssVariables = 'PracticeCssVariables',
 }
 
 export interface PracticeConfig<K, T> {
@@ -143,6 +144,7 @@ export type PracticeConfigPractitionerConsultList = PracticeConfig<
         hideLocality?: boolean
         hideFax?: boolean
         hideExpiresAt?: boolean
+        showExpirationInDays?: boolean
     }
 >
 
@@ -179,7 +181,19 @@ export type PracticeConfigPracticeCookieBanner = PracticeConfig<
 >
 
 // This type is for demonstration only for now
-export type PracticeConfigPracticeTheme = PracticeConfig<PracticeConfigKind.PracticeTheme, { primaryColor?: string }>
+export type PracticeConfigPracticeConfigExample = PracticeConfig<
+    PracticeConfigKind.PracticeConfigExample,
+    { primaryColor?: 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 PracticeConfigs =
     | PracticeConfigPractitionerConsultList
@@ -187,7 +201,8 @@ export type PracticeConfigs =
     | PracticeConfigPracticeLocaleSwitcher
     | PracticeConfigPracticeCookieBanner
     | PracticeConfigPracticeOnlinePharmacy
-    | PracticeConfigPracticeTheme // Here for demonstration only
+    | PracticeConfigPracticeCssVariables
+    | PracticeConfigPracticeConfigExample // Here for demonstration only
 
 export interface PracticeWorkflow {
     id?: number ///optional for insertion
@@ -312,8 +327,8 @@ export interface AssignmentRequest {
     status?: AssignmentStatus
     uuidConsult?: string
     tagSpecialty?: string
-    isoLocality?: string,
-    isoLanguage?: string,
+    isoLocality?: string
+    isoLanguage?: string
 }
 
 export type Assignment = {
@@ -388,10 +403,11 @@ export interface Practitioner {
 export interface HydratedPracticeConfigs {
     [PracticeConfigKind.PractitionerConsultList]?: PracticeConfigPractitionerConsultList
     [PracticeConfigKind.PractitionerChatbox]?: PracticeConfigPractitionerChatbox
-    [PracticeConfigKind.PracticeTheme]?: PracticeConfigPracticeTheme
+    [PracticeConfigKind.PracticeConfigExample]?: PracticeConfigPracticeConfigExample
     [PracticeConfigKind.PracticeLocaleSwitcher]?: PracticeConfigPracticeLocaleSwitcher
     [PracticeConfigKind.PracticeCookieBanner]?: PracticeConfigPracticeCookieBanner
     [PracticeConfigKind.PracticePharmacyPicker]?: PracticeConfigPracticeOnlinePharmacy
+    [PracticeConfigKind.PracticeCssVariables]?: PracticeConfigPracticeCssVariables
 }
 
 export interface Practice {

package/src/models/workflow.ts

@@ -111,7 +111,26 @@ export enum MetadataCategory { //these are generic metadata categories
     Raw = 'Raw',
 }
 
-export interface GenericQuestionData<T, A = IndexedData<ChoiceInputData>> extends EntryData {
+/**
+ * This interface describes all images-alias question kind options
+ */
+export interface ImagesAliasQuestionOptions {
+    /**
+     * Comma separated list of accepted formats. Will be given to the input html element.
+     * Use same format as described [here](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#accept)
+     */
+    accept?: string
+    /**
+     * Should allow multiple uploads or not
+     */
+    multiple?: boolean
+    /**
+     * Should display photo guide instructions or not
+     */
+     photoGuide?: boolean
+}
+
+export interface GenericQuestionData<T, A = IndexedData<ChoiceInputData>, O = undefined> extends EntryData {
     kind: T
     metaCategory: MetadataCategory
     answers?: A
@@ -119,6 +138,10 @@ export interface GenericQuestionData<T, A = IndexedData<ChoiceInputData>> extend
     placeholder?: string
     defaultValue?: any
     value?: string
+    /**
+     * Options to forward to the workflow component
+     */
+    options?: O
 }
 
 export interface GroupedGenericQuestionData<T, A = IndexedData<ChoiceInputData>> extends GenericQuestionData<T, A> {
@@ -135,12 +158,12 @@ export declare type QuestionData =
           | 'date'
           | 'number'
           | 'images'
-          | 'images-alias'
           | 'body-parts'
           | 'pharmacy-picker'
           | 'online-pharmacy-picker'
           | 'place-address'
       >
+    | GenericQuestionData<'images-alias', IndexedData<ChoiceInputData>, ImagesAliasQuestionOptions>
     | GenericQuestionData<'checkbox-group' | 'select' | 'multiple' | 'text-select-group', IndexedData<ChoiceInputData>>
     | GroupedGenericQuestionData<'radio', IndexedData<RadioInputData>>
     | GroupedGenericQuestionData<'radio-card' | 'profile-selector', IndexedData<RadioCardInputData>>
@@ -187,13 +210,28 @@ export interface WorkflowData {
 }
 
 /**
- * This interface describes a workflow prepared and ready to be sent to vault
+ * This interface describes an upload of an image (could be a picture, a pdf, a text file, etc.)
  */
 export interface WorkflowUploadedImage {
+    /**
+     * Depending on the driver used by WorkflowInput:
+     * - 'indexdb': will fetch the image in IndexDB with this id
+     * - 'vault': will fetch the image in the vault with this id
+     */
     idbId?: string
+    /**
+     * The name of the image
+     */
     name: string
+    /**
+     * the image data (could be a picture, a pdf, a text file, etc.)
+     */
     imageData?: string
 }
+
+/**
+ * This interface describes a workflow prepared and ready to be sent to vault
+ */
 export interface PopulatedWorkflowField {
     answer: SelectedAnswerData | WorkflowUploadedImage[] // Actual answer from the workflow
     displayedAnswer?: any // This answer is to be used only when it's impossible to get data from workflow

package/src/services/consult.ts

@@ -5,6 +5,7 @@ import {
     ConsultRequest,
     MedicalStatus,
     ConsultTransmission,
+    ReasonWhyClosed,
     TransmissionKind,
     TransmissionStatus,
 } from '../models'
@@ -38,6 +39,8 @@ export class ConsultService {
         uuidRequester?: Uuid,
         statusesMedical?: MedicalStatus[],
         statusesExclude?: MedicalStatus[],
+        reasonsWhyClosed?: ReasonWhyClosed[],
+        reasonsWhyOther?: string[],
         shortId?: string,
         columnToSortTo?: string[],
         orderToSortTo?: string[],
@@ -57,6 +60,8 @@ export class ConsultService {
                         uuidRequester,
                         statusesMedical,
                         statusesExclude,
+                        reasonsWhyClosed,
+                        reasonsWhyOther,
                         shortId,
                         perPage,
                         page: indexPage,
@@ -104,6 +109,8 @@ export class ConsultService {
         uuidRequester?: Uuid,
         statusesMedical?: MedicalStatus[],
         statusesExclude?: MedicalStatus[],
+        reasonsWhyClosed?: ReasonWhyClosed[],
+        reasonsWhyOther?: string[],
         shortId?: string,
         columnToSortTo?: string[],
         orderToSortTo?: string[],
@@ -120,6 +127,8 @@ export class ConsultService {
                 uuidRequester,
                 statusesMedical,
                 statusesExclude,
+                reasonsWhyClosed,
+                reasonsWhyOther,
                 shortId,
                 perPage,
                 page: indexPage,

package/src/services/teller.ts

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