oro-sdk-apis 1.15.0 → 1.17.0

package/dist/services/practice.d.ts

@@ -1,5 +1,5 @@
 import { ConsultRequestMetadata, PracticeAccount, Uuid } from '../models';
-import { Assignment, PlanType, Practice, PracticeConfigKind, PracticeConfigs, PracticeInvoice, PracticePayment, PracticePaymentIntent, PracticePlan, PracticePlanPrices, PracticeWorkflow, PracticeWorkflowWithTagSpecialty, Practitioner, PractitionerLicense, PractitionerPreference, PractitionerQuota, PractitionerRole, WorkflowType } from '../models/practice';
+import { Assignment, AssignmentRequest, PlanType, Practice, PracticeConfigKind, PracticeConfigs, PracticeInvoice, PracticePayment, PracticePaymentIntent, PracticePlan, PracticePlanPrices, PracticeWorkflow, PracticeWorkflowWithTagSpecialty, Practitioner, PractitionerLicense, PractitionerPreference, PractitionerQuota, PractitionerRole, WorkflowType } from '../models/practice';
 import { APIService } from './api';
 export declare class PracticeService {
     private api;
@@ -107,7 +107,7 @@ export declare class PracticeService {
      */
     practiceGetPractitionerSignature(practiceUuid: Uuid, practitionerUuid: Uuid): Promise<Blob>;
     practiceGetAssignments(practiceUuid: Uuid): Promise<Assignment[]>;
-    practiceCreateAssignment(practiceUuid: Uuid, requestBody: Assignment): Promise<Assignment>;
+    practiceCreateAssignment(practiceUuid: Uuid, requestBody: AssignmentRequest): Promise<Assignment>;
     practiceUpdateAssignment(practiceUuid: Uuid, assignmentId: number, requestBody: Assignment): Promise<Assignment>;
     practiceGetAssignment(practiceUuid: Uuid, assignmentId: number): Promise<Assignment>;
     practiceGetQuotas(practiceUuid: Uuid): Promise<PractitionerQuota[]>;

package/dist/services/teller.d.ts

@@ -6,4 +6,19 @@ export declare class TellerService {
     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>;
+    /**
+     * This function notifies teller that the fax sent for a specific consult did not get through
+     * @param practiceUuid the practice uuid linked to the consult
+     * @param consultationUuid the consultation uuid
+     * @param consultationShortId  the consultation short id
+     * @param fax the address where to send the fax
+     * @returns void
+     */
+    notifyFaxFailed(practiceUuid: Uuid, consultationUuid: Uuid, consultationShortId: string, fax: string): Promise<void>;
+    /**
+     * This function let's you reassign a practictioner to a consult and send a notification email
+     * @param uuidConsult the uuid of the consult to reassign
+     * @param newPractitionerUuid the uuid of the practitioner that will get reassigned
+     */
+    reassignmentEmail(uuidConsult: Uuid, newPractitionerUuid: Uuid): Promise<void>;
 }

package/package.json

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

package/src/models/guard.ts

@@ -1,4 +1,5 @@
 import { Uuid, Base64String, TokenData, RFC3339Date, Url } from './'
+import { AllRoleType } from './practice'
 
 export type AuthRefreshFunc = (refreshToken?: string) => Promise<AuthTokenResponse>
 export interface Tokens {
@@ -29,7 +30,6 @@ export interface M2MTokenRequest {
     practiceUuid: string
 }
 
-
 export interface AuthRecoverRequest {
     practiceUuid: string
     email: string
@@ -145,3 +145,9 @@ export interface LegalData {
     rpAcceptedVersion: Url
     rpAcceptedAtIP?: string
 }
+
+export type RoleBasedScopes = AllRoleType
+
+export type PermissionBasedScopes = 'consult.consults.get' | 'consult.consults.post' | 'practice.assignments.post'
+
+export type AllScopes = RoleBasedScopes | PermissionBasedScopes

package/src/models/practice.ts

@@ -1,4 +1,4 @@
-import { PlaceData } from "."
+import { PlaceData } from '.'
 
 export enum WorkflowType {
     Onboard = 'Onboard',
@@ -299,8 +299,18 @@ export interface ConsultRequestMetadata {
     isoLanguageRequired: string
 }
 
-export interface Assignment {
-    id?: number ///optional for insertion
+export interface AssignmentRequest {
+    uuidAssignor: string //defaulting for insertion to the default practice admin
+    uuidPractitioner?: string
+    status?: AssignmentStatus
+    uuidConsult?: string
+    tagSpecialty?: string
+    isoLocality?: string,
+    isoLanguage?: string,
+}
+
+export type Assignment = {
+    id: number ///optional for insertion
     uuidPractice: string
     uuidAssignor: string //defaulting for insertion to the default practice admin
     uuidPractitioner?: string

package/src/services/practice.ts

@@ -2,6 +2,7 @@ import { hashToBase64String } from '../helpers'
 import { ConsultRequestMetadata, PracticeAccount, Uuid } from '../models'
 import {
     Assignment,
+    AssignmentRequest,
     PlanType,
     Practice,
     PracticeConfigKind,
@@ -424,7 +425,7 @@ export class PracticeService {
         return this.api.get<Assignment[]>(`${this.baseURL}/v1/practices/${practiceUuid}/assignments`)
     }
 
-    public practiceCreateAssignment(practiceUuid: Uuid, requestBody: Assignment): Promise<Assignment> {
+    public practiceCreateAssignment(practiceUuid: Uuid, requestBody: AssignmentRequest): Promise<Assignment> {
         return this.api.post<Assignment>(`${this.baseURL}/v1/practices/${practiceUuid}/assignments`, requestBody)
     }
 

package/src/services/teller.ts

@@ -1,7 +1,7 @@
 import { APIService } from './api'
 import { Consult, DataCreateResponse, LockboxDataRequest, MedicalStatus, Uuid } from '../models'
 export class TellerService {
-    constructor(private api: APIService, private baseURL: string) { }
+    constructor(private api: APIService, private baseURL: string) {}
 
     public async lockboxDataStore(
         lockboxUuid: Uuid,
@@ -9,31 +9,57 @@ export class TellerService {
         lockboxOwnerUuid?: Uuid,
         previousDataUuid?: Uuid
     ): Promise<DataCreateResponse> {
-        return this.api.post<DataCreateResponse>(
-            `${this.baseURL}/v1/lockboxes/${lockboxUuid}/data`,
-            req,
-            {
-                params: {
-                    lockbox_owner_uuid: lockboxOwnerUuid,
-                    data_uuid: previousDataUuid,
-                },
-            }
-        )
+        return this.api.post<DataCreateResponse>(`${this.baseURL}/v1/lockboxes/${lockboxUuid}/data`, req, {
+            params: {
+                lockbox_owner_uuid: lockboxOwnerUuid,
+                data_uuid: previousDataUuid,
+            },
+        })
     }
 
     public updateConsultByUUID(
         patientUuid: Uuid,
         uuidConsult: Uuid,
         statusMedical: MedicalStatus,
-        neverExpires?: boolean,
+        neverExpires?: boolean
     ): Promise<Consult> {
-        return this.api.put<Consult>(
-            `${this.baseURL}/v1/consults/${uuidConsult}`,
+        return this.api.put<Consult>(`${this.baseURL}/v1/consults/${uuidConsult}`, {
+            patientUuid,
+            statusMedical,
+            neverExpires,
+        })
+    }
+
+    /**
+     * This function notifies teller that the fax sent for a specific consult did not get through
+     * @param practiceUuid the practice uuid linked to the consult
+     * @param consultationUuid the consultation uuid
+     * @param consultationShortId  the consultation short id
+     * @param fax the address where to send the fax
+     * @returns void
+     */
+    public notifyFaxFailed(practiceUuid: Uuid, consultationUuid: Uuid, consultationShortId: string, fax: string) {
+        return this.api.post<void>(
+            `${this.baseURL}/v1/fax-failed`,
             {
-                patientUuid,
-                statusMedical,
-                neverExpires,
+                consultationUuid,
+                consultationShortId,
+                fax,
             },
+            {
+                params: { practice_uuid: practiceUuid },
+            }
         )
     }
+
+    /**
+     * This function let's you reassign a practictioner to a consult and send a notification email
+     * @param uuidConsult the uuid of the consult to reassign
+     * @param newPractitionerUuid the uuid of the practitioner that will get reassigned
+     */
+    public reassignmentEmail(uuidConsult: Uuid, newPractitionerUuid: Uuid) {
+        return this.api.post<void>(`${this.baseURL}/v1/consult/${uuidConsult}/reassignment-email`, {
+            newPractitionerUuid,
+        })
+    }
 }