@icure/api 8.6.5 → 8.6.7

package/icc-x-api/icc-patient-x-api.js

@@ -79,6 +79,11 @@ class IccPatientXApi extends icc_api_1.IccPatientApi {
             return new models.Patient(initialisationInfo.updatedEntity);
         });
     }
+    /**
+     * Ensures patient names are consistent by synchronizing names property with firstName/lastName/maidenName/alias fields.
+     * @param patient the patient to process
+     * @return the patient with completed names
+     */
     completeNames(patient) {
         var _a;
         let finalPatient = patient;
@@ -141,6 +146,12 @@ class IccPatientXApi extends icc_api_1.IccPatientApi {
     createPatient(body) {
         throw new Error('Cannot call a method that returns patients without providing a user for de/encryption');
     }
+    /**
+     * Creates a patient in the database with encryption.
+     * @param user the current user
+     * @param body the patient data to create
+     * @return the created patient
+     */
     createPatientWithUser(user, body) {
         return body
             ? this.encrypt(user, [_.cloneDeep(this.completeNames(body))])
@@ -165,6 +176,18 @@ class IccPatientXApi extends icc_api_1.IccPatientApi {
     filterBy(startKey, startDocumentId, limit, skip, sort, desc, body) {
         throw new Error('Cannot call a method that returns contacts without providing a user for de/encryption');
     }
+    /**
+     * Filters patients using a filter chain and returns decrypted results.
+     * @param user the current user
+     * @param filterChain the filter chain to apply
+     * @param startKey optional start key for pagination
+     * @param startDocumentId optional start document id for pagination
+     * @param limit optional maximum number of results
+     * @param skip optional number of results to skip
+     * @param sort optional sort field
+     * @param desc optional sort direction
+     * @return paginated list of decrypted patients
+     */
     filterByWithUser(user, filterChain, startKey, startDocumentId, limit, skip, sort, desc) {
         return super
             .filterPatientsBy(startKey, startDocumentId, limit, skip, sort, desc, filterChain)
@@ -173,6 +196,17 @@ class IccPatientXApi extends icc_api_1.IccPatientApi {
     findByAccessLogUserAfterDate(userId, accessType, startDate, startKey, startDocumentId, limit) {
         throw new Error('Cannot call a method that returns contacts without providing a user for de/encryption');
     }
+    /**
+     * Finds patients by access log user after a specific date and returns decrypted results.
+     * @param user the current user
+     * @param userId the user id to search for in access logs
+     * @param accessType optional type of access
+     * @param startDate optional start date timestamp
+     * @param startKey optional start key for pagination
+     * @param startDocumentId optional start document id for pagination
+     * @param limit optional maximum number of results
+     * @return paginated list of decrypted patients
+     */
     findByAccessLogUserAfterDateWithUser(user, userId, accessType, startDate, startKey, startDocumentId, limit) {
         return super
             .findByAccessLogUserAfterDate(userId, accessType, startDate, startKey, startDocumentId, limit)
@@ -181,6 +215,12 @@ class IccPatientXApi extends icc_api_1.IccPatientApi {
     findByAccessLogUserAfterDate_1(externalId) {
         throw new Error('Cannot call a method that returns contacts without providing a user for de/encryption');
     }
+    /**
+     * Finds a patient by external id and returns the decrypted result.
+     * @param user the current user
+     * @param externalId the external id to search for
+     * @return the decrypted patient
+     */
     findByExternalIdWithUser(user, externalId) {
         return super
             .findByExternalId(externalId)
@@ -190,6 +230,17 @@ class IccPatientXApi extends icc_api_1.IccPatientApi {
     findByNameBirthSsinAuto(healthcarePartyId, filterValue, startKey, startDocumentId, limit, sortDirection) {
         throw new Error('Cannot call a method that returns contacts without providing a user for de/encryption');
     }
+    /**
+     * Finds patients by name, birth date, or SSIN with automatic search and returns decrypted results.
+     * @param user the current user
+     * @param healthcarePartyId optional healthcare party id
+     * @param filterValue optional search value
+     * @param startKey optional start key for pagination
+     * @param startDocumentId optional start document id for pagination
+     * @param limit optional maximum number of results
+     * @param sortDirection optional sort direction
+     * @return paginated list of decrypted patients
+     */
     findByNameBirthSsinAutoWithUser(user, healthcarePartyId, filterValue, startKey, startDocumentId, limit, sortDirection) {
         return super
             .findByNameBirthSsinAuto(healthcarePartyId, filterValue, startKey, startDocumentId, limit, sortDirection)
@@ -198,21 +249,46 @@ class IccPatientXApi extends icc_api_1.IccPatientApi {
     fuzzySearch(firstName, lastName, dateOfBirth) {
         throw new Error('Cannot call a method that returns contacts without providing a user for de/encryption');
     }
+    /**
+     * Performs a fuzzy search for patients and returns decrypted results.
+     * @param user the current user
+     * @param firstName optional first name to search for
+     * @param lastName optional last name to search for
+     * @param dateOfBirth optional date of birth timestamp
+     * @return array of decrypted patients
+     */
     fuzzySearchWithUser(user, firstName, lastName, dateOfBirth) {
         return super.fuzzySearch(firstName, lastName, dateOfBirth).then((pats) => this.decrypt(user, pats));
     }
     getPatient(patientId) {
         throw new Error('Cannot call a method that returns contacts without providing a user for de/encryption');
     }
+    /**
+     * Gets a patient by id without decryption.
+     * @param patientId the patient id
+     * @return the encrypted patient
+     */
     getPatientRaw(patientId) {
         return super.getPatient(patientId);
     }
+    /**
+     * Gets a patient by id with decryption.
+     * @param user the current user
+     * @param patientId the patient id
+     * @return the decrypted patient
+     */
     getPatientWithUser(user, patientId) {
         return super
             .getPatient(patientId)
             .then((p) => this.tryDecryptOrReturnOriginal([p]))
             .then((pats) => pats[0].entity);
     }
+    /**
+     * Gets a patient by id and indicates whether it was successfully decrypted.
+     * @param user the current user
+     * @param patientId the patient id
+     * @return object containing the patient and a flag indicating if it was decrypted
+     */
     getPotentiallyEncryptedPatientWithUser(user, patientId) {
         return super
             .getPatient(patientId)
@@ -222,12 +298,29 @@ class IccPatientXApi extends icc_api_1.IccPatientApi {
     getPatients(body) {
         throw new Error('Cannot call a method that returns contacts without providing a user for de/encryption');
     }
+    /**
+     * Gets multiple patients by their ids with decryption.
+     * @param user the current user
+     * @param body list of patient ids
+     * @return array of decrypted patients
+     */
     getPatientsWithUser(user, body) {
         return super.getPatients(body).then((pats) => this.decrypt(user, pats));
     }
     listDeletedPatients(startDate, endDate, desc, startKey, startDocumentId, limit) {
         throw new Error('Cannot call a method that returns contacts without providing a user for de/encryption');
     }
+    /**
+     * Lists deleted patients with decryption.
+     * @param user the current user
+     * @param startDate optional start date timestamp
+     * @param endDate optional end date timestamp
+     * @param desc optional sort direction
+     * @param startKey optional start key for pagination
+     * @param startDocumentId optional start document id for pagination
+     * @param limit optional maximum number of results
+     * @return paginated list of decrypted deleted patients
+     */
     listDeletedPatientsWithUser(user, startDate, endDate, desc, startKey, startDocumentId, limit) {
         return super
             .listDeletedPatients(startDate, endDate, desc, startDocumentId, startKey, limit)
@@ -236,18 +329,40 @@ class IccPatientXApi extends icc_api_1.IccPatientApi {
     listDeletedPatients_2(firstName, lastName) {
         throw new Error('Cannot call a method that returns contacts without providing a user for de/encryption');
     }
+    /**
+     * Lists deleted patients by name with decryption.
+     * @param user the current user
+     * @param firstName optional first name to filter by
+     * @param lastName optional last name to filter by
+     * @return array of decrypted deleted patients
+     */
     listDeletedPatientsByNameWithUser(user, firstName, lastName) {
         return super.listDeletedPatientsByName(firstName, lastName).then((rows) => this.decrypt(user, rows, false));
     }
     listOfMergesAfter(date) {
         throw new Error('Cannot call a method that returns contacts without providing a user for de/encryption');
     }
+    /**
+     * Lists merged patients after a specific date with decryption.
+     * @param user the current user
+     * @param date timestamp to start from
+     * @return array of decrypted merged patients
+     */
     listOfMergesAfterWithUser(user, date) {
         return super.listOfMergesAfter(date).then((pats) => this.decrypt(user, pats, false));
     }
     listOfPatientsModifiedAfter(date, startKey, startDocumentId, limit) {
         throw new Error('Cannot call a method that returns contacts without providing a user for de/encryption');
     }
+    /**
+     * Lists patients modified after a specific date with decryption.
+     * @param user the current user
+     * @param date timestamp to start from
+     * @param startKey optional start key for pagination
+     * @param startDocumentId optional start document id for pagination
+     * @param limit optional maximum number of results
+     * @return paginated list of decrypted modified patients
+     */
     listOfPatientsModifiedAfterWithUser(user, date, startKey, startDocumentId, limit) {
         return super
             .listOfPatientsModifiedAfter(date, startKey, startDocumentId, limit)
@@ -256,6 +371,17 @@ class IccPatientXApi extends icc_api_1.IccPatientApi {
     listPatients(hcPartyId, sortField, startKey, startDocumentId, limit, sortDirection) {
         throw new Error('Cannot call a method that returns contacts without providing a user for de/encryption');
     }
+    /**
+     * Lists patients with decryption.
+     * @param user the current user
+     * @param hcPartyId optional healthcare party id
+     * @param sortField optional sort field
+     * @param startKey optional start key for pagination
+     * @param startDocumentId optional start document id for pagination
+     * @param limit optional maximum number of results
+     * @param sortDirection optional sort direction
+     * @return paginated list of decrypted patients
+     */
     listPatientsWithUser(user, hcPartyId, sortField, startKey, startDocumentId, limit, sortDirection) {
         return super
             .listPatients(hcPartyId, sortField, startKey, startDocumentId, limit, sortDirection)
@@ -264,6 +390,17 @@ class IccPatientXApi extends icc_api_1.IccPatientApi {
     listPatientsByHcParty(hcPartyId, sortField, startKey, startDocumentId, limit, sortDirection) {
         throw new Error('Cannot call a method that returns contacts without providing a user for de/encryption');
     }
+    /**
+     * Lists patients by healthcare party with decryption.
+     * @param user the current user
+     * @param hcPartyId the healthcare party id
+     * @param sortField optional sort field
+     * @param startKey optional start key for pagination
+     * @param startDocumentId optional start document id for pagination
+     * @param limit optional maximum number of results
+     * @param sortDirection optional sort direction
+     * @return paginated list of decrypted patients
+     */
     listPatientsByHcPartyWithUser(user, hcPartyId, sortField, startKey, startDocumentId, limit, sortDirection) {
         return super
             .listPatientsByHcParty(hcPartyId, sortField, startKey, startDocumentId, limit, sortDirection)
@@ -272,6 +409,17 @@ class IccPatientXApi extends icc_api_1.IccPatientApi {
     listPatientsOfHcParty(hcPartyId, sortField, startKey, startDocumentId, limit, sortDirection) {
         throw new Error('Cannot call a method that returns contacts without providing a user for de/encryption');
     }
+    /**
+     * Lists patients of a healthcare party with decryption.
+     * @param user the current user
+     * @param hcPartyId the healthcare party id
+     * @param sortField optional sort field
+     * @param startKey optional start key for pagination
+     * @param startDocumentId optional start document id for pagination
+     * @param limit optional maximum number of results
+     * @param sortDirection optional sort direction
+     * @return paginated list of decrypted patients
+     */
     listPatientsOfHcPartyWithUser(user, hcPartyId, sortField, startKey, startDocumentId, limit, sortDirection) {
         return super
             .listPatientsOfHcParty(hcPartyId, sortField, startKey, startDocumentId, limit, sortDirection)
@@ -280,6 +428,13 @@ class IccPatientXApi extends icc_api_1.IccPatientApi {
     mergeInto(toId, fromIds) {
         throw new Error('Cannot call a method that returns contacts without providing a user for de/encryption');
     }
+    /**
+     * Merges patients and returns the decrypted result.
+     * @param user the current user
+     * @param toId the target patient id
+     * @param fromIds the source patient ids to merge from
+     * @return the decrypted merged patient
+     */
     mergeIntoWithUser(user, toId, fromIds) {
         return super
             .mergeInto(toId, fromIds)
@@ -295,6 +450,12 @@ class IccPatientXApi extends icc_api_1.IccPatientApi {
     modifyPatientRaw(body) {
         return super.modifyPatient(body);
     }
+    /**
+     * Updates a patient with encryption.
+     * @param user the current user
+     * @param body the patient data to update
+     * @return the updated decrypted patient
+     */
     modifyPatientWithUser(user, body) {
         return body ? this.modifyPatientAs(this.dataOwnerApi.getDataOwnerIdOf(user), body) : Promise.resolve(null);
     }
@@ -307,12 +468,27 @@ class IccPatientXApi extends icc_api_1.IccPatientApi {
     modifyPatientReferral(patientId, referralId, start, end) {
         throw new Error('Cannot call a method that returns contacts without providing a user for de/encryption');
     }
+    /**
+     * Updates a patient referral and returns the decrypted result.
+     * @param user the current user
+     * @param patientId the patient id
+     * @param referralId the referral id
+     * @param start optional start timestamp
+     * @param end optional end timestamp
+     * @return the updated decrypted patient
+     */
     modifyPatientReferralWithUser(user, patientId, referralId, start, end) {
         return super
             .modifyPatientReferral(patientId, referralId, start, end)
             .then((p) => this.decrypt(user, [p]))
             .then((pats) => pats[0]);
     }
+    /**
+     * Encrypts patients using the current user's encryption keys.
+     * @param user the current user
+     * @param pats the patients to encrypt
+     * @return the encrypted patients
+     */
     encrypt(user, pats) {
         const dataOwnerId = this.dataOwnerApi.getDataOwnerIdOf(user);
         return this.encryptAs(dataOwnerId, pats);
@@ -320,13 +496,24 @@ class IccPatientXApi extends icc_api_1.IccPatientApi {
     encryptAs(dataOwner, pats) {
         return this.crypto.xapi.tryEncryptEntities(pats, EntityWithDelegationTypeName_1.EntityWithDelegationTypeName.Patient, this.encryptedFields, true, false, (x) => new models.Patient(x));
     }
-    // If patient can't be decrypted returns patient with encrypted data.
+    /**
+     * Decrypts patients using the current user's encryption keys. If a patient can't be decrypted, returns it with encrypted data.
+     * @param user the current user
+     * @param patients the patients to decrypt
+     * @param fillDelegations optional flag to fill delegations (defaults to true)
+     * @return the decrypted patients
+     */
     decrypt(user, patients, fillDelegations = true) {
         return this.decryptAs(this.dataOwnerApi.getDataOwnerIdOf(user), patients, fillDelegations);
     }
     decryptAs(dataOwner, patients, fillDelegations = true) {
         return this.tryDecryptOrReturnOriginal(patients).then((ps) => ps.map((p) => p.entity));
     }
+    /**
+     * Attempts to decrypt patients. If decryption fails, returns the original encrypted patients.
+     * @param patients the patients to decrypt
+     * @return array of objects containing the patient entity and a flag indicating if it was decrypted
+     */
     tryDecryptOrReturnOriginal(patients) {
         return __awaiter(this, void 0, void 0, function* () {
             return (yield this.crypto.xapi.tryDecryptEntities(patients, EntityWithDelegationTypeName_1.EntityWithDelegationTypeName.Patient, (x) => new models.Patient(x))).map((p) => {
@@ -349,6 +536,16 @@ class IccPatientXApi extends icc_api_1.IccPatientApi {
             return this.shareAllDataOfPatient(user, patId, ownerId, delegateIds, delegationTags, usingPost);
         });
     }
+    /**
+     * Shares a patient and all related data with specified delegates.
+     * @param user the current user
+     * @param patId the patient id
+     * @param ownerId the owner healthcare party id
+     * @param delegateIds the delegate ids to share with
+     * @param delegationTags tags specifying what data to share (e.g., medicalInformation, financialInformation, all)
+     * @param usingPost optional flag to use POST method instead of GET (defaults to false)
+     * @return object containing the updated patient and sharing statuses for each entity type
+     */
     shareAllDataOfPatient(user_1, patId_1, ownerId_1, delegateIds_1, delegationTags_1) {
         return __awaiter(this, arguments, void 0, function* (user, patId, ownerId, delegateIds, delegationTags, usingPost = false) {
             const allTags = _.uniq(_.flatMap(Object.values(delegationTags)));
@@ -530,6 +727,13 @@ class IccPatientXApi extends icc_api_1.IccPatientApi {
             });
         });
     }
+    /**
+     * Exports a patient and all related medical data.
+     * @param user the current user
+     * @param patId the patient id
+     * @param ownerId the owner healthcare party id
+     * @return object containing the patient and all related entities (contacts, forms, health elements, invoices, classifications, calendar items, documents)
+     */
     export(user, patId, ownerId) {
         return __awaiter(this, void 0, void 0, function* () {
             const parentId = yield this.dataOwnerApi.getCurrentDataOwnerHierarchyIds().then((h) => (h.length - 2 >= 0 ? h[h.length - 2] : h[0]));
@@ -628,6 +832,11 @@ class IccPatientXApi extends icc_api_1.IccPatientApi {
             };
         });
     }
+    /**
+     * Validates a Belgian INAMI number using modulo 97 check.
+     * @param inami the INAMI number to validate
+     * @return true if the INAMI number is valid, false otherwise
+     */
     checkInami(inami) {
         const num_inami = inami.replace(new RegExp('[^(0-9)]', 'g'), '');
         const checkDigit = num_inami.substring(6, 8);
@@ -642,6 +851,11 @@ class IccPatientXApi extends icc_api_1.IccPatientApi {
         }
         return retour;
     }
+    /**
+     * Validates a Belgian social security identification number (SSIN/NISS) including support for bis and ter numbers.
+     * @param ssin the SSIN to validate
+     * @return true if the SSIN is valid, false otherwise
+     */
     isValidSsin(ssin) {
         ssin = ssin.replace(new RegExp('[^(0-9)]', 'g'), '');
         let isValidNiss = false;
@@ -656,6 +870,13 @@ class IccPatientXApi extends icc_api_1.IccPatientApi {
         }
         return isValidNiss;
     }
+    /**
+     * Extracts the patient id from a child document, following merge chains if necessary.
+     * @param childDocument the child document (invoice, calendar item, contact, or access log)
+     * @param hcpId the healthcare party id
+     * @param childDocumentType the type of the child document
+     * @return the patient id after following any merge chains
+     */
     getPatientIdOfChildDocumentForHcpAndHcpParents(childDocument, hcpId, childDocumentType) {
         const _super = Object.create(null, {
             getPatient: { get: () => super.getPatient }
@@ -791,9 +1012,19 @@ class IccPatientXApi extends icc_api_1.IccPatientApi {
     decryptNonConfidentialSecretIdsOf(patient) {
         return this.crypto.xapi.getSecretIdsSharedWithParents({ entity: patient, type: EntityWithDelegationTypeName_1.EntityWithDelegationTypeName.Patient });
     }
+    /**
+     * Gets all data owners with access to the patient and their permission levels.
+     * @param entity the patient
+     * @return object containing permissions by data owner id and a flag indicating if there are unknown anonymous data owners
+     */
     getDataOwnersWithAccessTo(entity) {
         return this.crypto.delegationsDeAnonymization.getDataOwnersWithAccessTo({ entity, type: EntityWithDelegationTypeName_1.EntityWithDelegationTypeName.Patient });
     }
+    /**
+     * Gets all encryption keys of the patient that the current user can decrypt.
+     * @param entity the patient
+     * @return array of encryption keys
+     */
     getEncryptionKeysOf(entity) {
         return this.crypto.xapi.encryptionKeysOf({ entity, type: EntityWithDelegationTypeName_1.EntityWithDelegationTypeName.Patient }, undefined);
     }
@@ -844,12 +1075,25 @@ class IccPatientXApi extends icc_api_1.IccPatientApi {
             return (yield this.tryDecryptOrReturnOriginal([merged]))[0].entity;
         });
     }
+    /**
+     * Subscribes to patient events (create, update, delete) and automatically decrypts them.
+     * @param eventTypes the types of events to subscribe to
+     * @param filter optional filter to apply to events
+     * @param eventFired callback function to handle each event
+     * @param options optional subscription options
+     * @return connection object to manage the subscription
+     */
     subscribeToPatientEvents(eventTypes_1, filter_1, eventFired_1) {
         return __awaiter(this, arguments, void 0, function* (eventTypes, filter, eventFired, options = {}) {
             const currentUser = yield this.userApi.getCurrentUser();
             return (0, utils_1.subscribeToEntityEvents)(this.host, this.authApi, EntityWithDelegationTypeName_1.EntityWithDelegationTypeName.Patient, eventTypes, filter, eventFired, options, (encrypted) => __awaiter(this, void 0, void 0, function* () { return (yield this.decrypt(currentUser, [encrypted]))[0]; })).then((rs) => new Connection_1.ConnectionImpl(rs));
         });
     }
+    /**
+     * Creates or updates de-anonymization metadata for patient delegations.
+     * @param entity the patient
+     * @param delegates array of delegate ids to create metadata for
+     */
     createDelegationDeAnonymizationMetadata(entity, delegates) {
         return this.crypto.delegationsDeAnonymization.createOrUpdateDeAnonymizationInfo({ entity, type: EntityWithDelegationTypeName_1.EntityWithDelegationTypeName.Patient }, delegates);
     }