oro-sdk-apis 1.17.1 → 1.20.0

package/dist/services/teller.d.ts

@@ -8,6 +8,7 @@ export declare class TellerService {
     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
+     * @todo - Make service only exposed route
      * @param practiceUuid the practice uuid linked to the consult
      * @param consultationUuid the consultation uuid
      * @param consultationShortId  the consultation short id
@@ -17,8 +18,17 @@ export declare class TellerService {
     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
+     * @todo - Make service only exposed route
      * @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>;
+    /**
+     * This function will send an email to the patientUuid, saying that the online practice has been sent a fax successfully
+     * @todo - Make service only exposed route
+     * @param consult
+     * @param patientUuid
+     * @returns void
+     */
+    sendOnlineFaxSuccessfulEmail(consult: Consult, patientUuid: Uuid): Promise<void>;
 }

package/package.json

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

package/src/models/practice.ts

@@ -104,6 +104,12 @@ export enum PracticeEmailKind {
     FollowedUp = 'FollowedUp',
     Renewed = 'Renewed',
     DataRetrieved = 'DataRetrieved',
+    Closed = 'Closed',
+    PasswordRecovery = 'PasswordRecovery',
+    FaxFailed = 'FaxFailed',
+    ExamResult = 'ExamResult',
+    Reassigned = 'Reassigned',
+    OnlinePharmacyFaxSent = 'OnlinePharmacyFaxSent',
 }
 
 export interface PracticeAccount {

package/src/models/workflow.ts

@@ -1,3 +1,41 @@
+/**
+ * This type represents all the patient profile kind
+ */
+export type ProfileKind = 'myself' | 'child' | 'other'
+/**
+ * this type is done as an example on how to add another data kind
+ */
+export type OtherKind = 'otherKindOfType'
+
+/**
+ * This type represents all the kind a data that can define `ChoiceInputData` (`OtherKind` is here only as an example on how to add a new kind)
+ */
+export type AllChoiceInputDataKind = ProfileKind | OtherKind
+
+/**
+ * This interface represents a `StateTrigger` on selected profile kind
+ */
+export interface ProfileTrigger {
+    kind: 'profileTrigger'
+    value: ProfileKind
+}
+
+/**
+ * This interface is meant as an example of another kind of `StateTrigger`
+ */
+export interface OtherTrigger {
+    kind: 'otherTrigger'
+    field1: number
+    field2: string
+}
+
+/**
+ * This type represents all the state triggers that are defined.
+ *
+ * A state trigger is triggered onto app states. In other words, it is for triggers that cannot be defined thanks to pure workflow answers.
+ */
+export type StateTrigger = ProfileTrigger | OtherTrigger
+
 export interface IndexedData<T> {
     [key: string]: T
 }
@@ -9,6 +47,8 @@ export interface ChoiceInputData {
     text: string
     className?: string
     order?: number
+    /** If defined, the choice input contains a kind that can be used into app. For instance, to check if a specific `kind` of answer has been selected */
+    kind?: AllChoiceInputDataKind
 }
 
 export interface RadioInputIconOptionsData {
@@ -37,7 +77,14 @@ export interface EntryData {
     summaryLabel?: string
     summaryHidden?: boolean
     className?: string
+    /**
+     * This field represents a list of `selectedAnswers` that must be set for this entry to be displayed.
+     */
     triggers?: string[]
+    /**
+     * This field represents a list of `StateTrigger` that must be fulfilled for this entry to be displayed.
+     */
+    stateTriggers?: StateTrigger[]
 }
 
 export interface SlideData {
@@ -80,8 +127,23 @@ export interface GroupedGenericQuestionData<T, A = IndexedData<ChoiceInputData>>
     order?: number
 }
 
-export declare type QuestionData = GenericQuestionData<'title' | 'paragraph' | 'checkbox', void> | GenericQuestionData<'text' | 'text-area' | 'date' | 'number' | 'images' | 'images-alias' | 'body-parts' | 'pharmacy-picker' | 'place-address'> | GenericQuestionData<'checkbox-group' | 'select' | 'multiple' | 'text-select-group', IndexedData<ChoiceInputData>> | GroupedGenericQuestionData<'radio', IndexedData<RadioInputData>> | GroupedGenericQuestionData<'radio-card', IndexedData<RadioCardInputData>> | GroupedGenericQuestionData<'language-picker', IndexedData<LanguagePickerData>>;
-
+export declare type QuestionData =
+    | GenericQuestionData<'title' | 'paragraph' | 'checkbox', void>
+    | GenericQuestionData<
+          | 'text'
+          | 'text-area'
+          | 'date'
+          | 'number'
+          | 'images'
+          | 'images-alias'
+          | 'body-parts'
+          | 'pharmacy-picker'
+          | 'place-address'
+      >
+    | GenericQuestionData<'checkbox-group' | 'select' | 'multiple' | 'text-select-group', IndexedData<ChoiceInputData>>
+    | GroupedGenericQuestionData<'radio', IndexedData<RadioInputData>>
+    | GroupedGenericQuestionData<'radio-card', IndexedData<RadioCardInputData>>
+    | GroupedGenericQuestionData<'language-picker', IndexedData<LanguagePickerData>>
 
 export interface FieldData {
     type: 'field'
@@ -105,6 +167,10 @@ export interface WorkflowPageData {
     questions: IndexedData<QuestionData>
     title?: string
     triggers?: string[]
+    /**
+     * This field represents a list of `ids` which will be spliced from the workflow groups and inserted into a designated location
+     */
+    prioritizeIds?: string[]
 }
 
 export interface WorkflowData {

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,
@@ -32,6 +32,7 @@ export class TellerService {
 
     /**
      * This function notifies teller that the fax sent for a specific consult did not get through
+     * @todo - Make service only exposed route
      * @param practiceUuid the practice uuid linked to the consult
      * @param consultationUuid the consultation uuid
      * @param consultationShortId  the consultation short id
@@ -54,6 +55,7 @@ export class TellerService {
 
     /**
      * This function let's you reassign a practictioner to a consult and send a notification email
+     * @todo - Make service only exposed route
      * @param uuidConsult the uuid of the consult to reassign
      * @param newPractitionerUuid the uuid of the practitioner that will get reassigned
      */
@@ -62,4 +64,20 @@ export class TellerService {
             newPractitionerUuid,
         })
     }
+
+    /**
+     * This function will send an email to the patientUuid, saying that the online practice has been sent a fax successfully
+     * @todo - Make service only exposed route
+     * @param consult 
+     * @param patientUuid 
+     * @returns void
+     */
+    public sendOnlineFaxSuccessfulEmail(
+        consult: Consult,
+        patientUuid: Uuid,
+    ): Promise<void> {
+        return this.api.post(
+            `${this.baseURL}/v1/online-fax-notify`, { consult, patient_uuid: patientUuid }
+        )
+    }
 }