oro-sdk 2.11.0 → 2.12.0

package/dist/helpers/patient-registration.d.ts

@@ -1,5 +1,25 @@
 import { ConsultRequest, MetadataCategory, Uuid, WorkflowData } from 'oro-sdk-apis';
 import { OroClient, RegisterPatientOutput } from '..';
+/**
+ * Completes a registration for a user retrying the complete flow a maximum of 15 times
+ *
+ * @description The order of importance when registering:
+ * Creates a consultation if none exist
+ * Retrieves or create's a lockbox if none exist
+ * Grants the lockbox (if new) to all practitioners in the practice
+ * Stores or fetches the patient data (without images)
+ * Indexes the lockbox to the consult for all practitioners (done after inserting since index can be rebuilt from grants)
+ * Stores the image data - done last since the majority of failure cases occur here
+ * Creates the recovery payloads if they don't exist
+ *
+ * @param patientUuid
+ * @param consultRequest
+ * @param workflow
+ * @param oroClient
+ * @param masterKey
+ * @param recoveryQA
+ * @returns the successful registration
+ */
 export declare function registerPatient(patientUuid: Uuid, consultRequest: ConsultRequest, workflow: WorkflowData, oroClient: OroClient, masterKey?: Uuid, recoveryQA?: {
     recoverySecurityQuestions: string[];
     recoverySecurityAnswers: string[];