@icure/cardinal-sdk 2.1.1 → 2.1.2

package/model/Patient.mjs

@@ -16,74 +16,347 @@ import { DecryptedPatientHealthCareParty, EncryptedPatientHealthCareParty } from
 import { PersonName } from './embed/PersonName.mjs';
 import { PersonalStatus } from './embed/PersonalStatus.mjs';
 import { SecurityMetadata } from './embed/SecurityMetadata.mjs';
+/**
+ *
+ *  Represents a patient in the iCure platform. A patient is a person who receives healthcare
+ *  services.
+ *  This entity stores personal, administrative, and medical information about the patient, and
+ *  supports
+ *  end-to-end encryption of sensitive data.
+ *  /
+ */
 export class DecryptedPatient {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The patient's identifiers, used by the client to uniquely identify the patient.
+         */
         this.identifier = [];
+        /**
+         *
+         *  The revision of the patient in the database, used for conflict management / optimistic locking.
+         */
         this.rev = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of creation.
+         */
         this.created = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of the latest modification.
+         */
         this.modified = undefined;
+        /**
+         *
+         *  The id of the User that created this patient.
+         */
         this.author = undefined;
+        /**
+         *
+         *  The id of the HealthcareParty that is responsible for this patient.
+         */
         this.responsible = undefined;
+        /**
+         *
+         *  Tags that qualify the patient as being member of a certain class.
+         */
         this.tags = [];
+        /**
+         *
+         *  Codes that identify or qualify this particular patient.
+         */
         this.codes = [];
+        /**
+         *
+         *  Hard delete (unix epoch in ms) timestamp of the object.
+         */
         this.deletionDate = undefined;
+        /**
+         *
+         *  The firstname (name) of the patient.
+         */
         this.firstName = undefined;
+        /**
+         *
+         *  The lastname (surname) of the patient.
+         */
         this.lastName = undefined;
+        /**
+         *
+         *  The list of all names of the patient, ordered by preference of use.
+         */
         this.names = [];
+        /**
+         *
+         *  The name of the company this patient is member of.
+         */
         this.companyName = undefined;
+        /**
+         *
+         *  The list of languages spoken by the patient ordered by fluency (alpha-2 code).
+         */
         this.languages = [];
+        /**
+         *
+         *  The list of addresses (with address type).
+         */
         this.addresses = [];
+        /**
+         *
+         *  Mr., Ms., Pr., Dr. ...
+         */
         this.civility = undefined;
+        /**
+         *
+         *  The gender of the patient.
+         */
         this.gender = Gender.Unknown;
+        /**
+         *
+         *  The birth sex of the patient.
+         */
         this.birthSex = Gender.Unknown;
+        /**
+         *
+         *  The id of the patient this patient has been merged with.
+         */
         this.mergeToPatientId = undefined;
+        /**
+         *
+         *  The ids of the patients that have been merged inside this patient.
+         */
         this.mergedIds = [];
+        /**
+         *
+         *  An alias of the person, nickname, ...
+         */
         this.alias = undefined;
+        /**
+         *
+         *  Whether the patient is active.
+         */
         this.active = true;
+        /**
+         *
+         *  When not active, the reason for deactivation.
+         */
         this.deactivationReason = "none";
+        /**
+         *
+         *  Deactivation date of the patient.
+         */
         this.deactivationDate = undefined;
+        /**
+         *
+         *  Social security inscription number.
+         */
         this.ssin = undefined;
+        /**
+         *
+         *  Lastname at birth (can be different from the current name).
+         */
         this.maidenName = undefined;
+        /**
+         *
+         *  Lastname of the spouse for a married woman.
+         */
         this.spouseName = undefined;
+        /**
+         *
+         *  Lastname of the partner.
+         */
         this.partnerName = undefined;
+        /**
+         *
+         *  The personal/marital status of the patient.
+         */
         this.personalStatus = PersonalStatus.Unknown;
+        /**
+         *
+         *  The birthdate encoded as a fuzzy date on 8 positions (YYYYMMDD).
+         */
         this.dateOfBirth = undefined;
+        /**
+         *
+         *  The date of death encoded as a fuzzy date on 8 positions (YYYYMMDD).
+         */
         this.dateOfDeath = undefined;
+        /**
+         *
+         *  Timestamp of the latest validation of the eID of the person.
+         */
         this.timestampOfLatestEidReading = undefined;
+        /**
+         *
+         *  The place of birth.
+         */
         this.placeOfBirth = undefined;
+        /**
+         *
+         *  The place of death.
+         */
         this.placeOfDeath = undefined;
+        /**
+         *
+         *  Whether the patient is deceased.
+         */
         this.deceased = undefined;
+        /**
+         *
+         *  The level of education (college degree, undergraduate, phd).
+         */
         this.education = undefined;
+        /**
+         *
+         *  The current professional activity.
+         */
         this.profession = undefined;
+        /**
+         *
+         *  Localized text notes (can be confidential).
+         */
         this.notes = [];
+        /**
+         *
+         *  A text note (can be confidential, encrypted by default).
+         */
         this.note = undefined;
+        /**
+         *
+         *  An administrative note, not confidential.
+         */
         this.administrativeNote = undefined;
+        /**
+         *
+         *  The nationality of the patient.
+         */
         this.nationality = undefined;
+        /**
+         *
+         *  The race of the patient.
+         */
         this.race = undefined;
+        /**
+         *
+         *  The ethnicity of the patient.
+         */
         this.ethnicity = undefined;
+        /**
+         *
+         *  The id of the user that usually handles this patient.
+         */
         this.preferredUserId = undefined;
+        /**
+         *
+         *  List of insurance coverages.
+         */
         this.insurabilities = [];
+        /**
+         *
+         *  List of partners, or persons of contact.
+         */
         this.partnerships = [];
+        /**
+         *
+         *  Links between this patient and healthcare parties.
+         */
         this.patientHealthCareParties = [];
+        /**
+         *
+         *  Financial information used to reimburse the patient.
+         */
         this.financialInstitutionInformation = [];
+        /**
+         *
+         *  Contracts between the patient and the healthcare entity.
+         */
         this.medicalHouseContracts = [];
+        /**
+         *
+         *  Codified list of professions exercised by this patient.
+         */
         this.patientProfessions = [];
+        /**
+         *
+         *  Extra parameters.
+         */
         this.parameters = {};
+        /**
+         *
+         *  Extra properties.
+         */
         this.properties = [];
+        /**
+         *
+         *  For each couple of HcParties, the AES exchange key.
+         */
         this.hcPartyKeys = {};
+        /**
+         *
+         *  Extra AES exchange keys, indexed by the owner of the pair and target data owner id.
+         */
         this.aesExchangeKeys = {};
+        /**
+         *
+         *  Keys used to transfer ownership of encrypted data between key pairs.
+         */
         this.transferKeys = {};
+        /**
+         *
+         *  Shamir partitions of the private key.
+         */
         this.privateKeyShamirPartitions = {};
+        /**
+         *
+         *  The public key of this patient, used to encrypt data for this patient.
+         */
         this.publicKey = undefined;
+        /**
+         *
+         *  Public keys for OAEP with SHA-256 encryption.
+         */
         this.publicKeysForOaepWithSha256 = [];
+        /**
+         *
+         *  The secret patient key, encrypted in the patient's own AES key.
+         */
         this.secretForeignKeys = [];
+        /**
+         *
+         *  The patient id encrypted in the delegates' AES keys.
+         */
         this.cryptedForeignKeys = {};
+        /**
+         *
+         *  The delegations giving access to connected healthcare information.
+         */
         this.delegations = {};
+        /**
+         *
+         *  The keys used to encrypt this entity when stored encrypted.
+         */
         this.encryptionKeys = {};
+        /**
+         *
+         *  The base64-encoded encrypted fields of this entity.
+         */
         this.encryptedSelf = undefined;
+        /**
+         *
+         *  The security metadata of the entity.
+         */
         this.securityMetadata = undefined;
+        /**
+         *
+         *  Properties related to crypto actor functionality.
+         */
         this.cryptoActorProperties = [];
+        /**
+         *
+         *  Always null for patients.
+         */
         this.parentId = undefined;
         this.isEncrypted = false;
         this.$ktClass = 'com.icure.cardinal.sdk.model.DecryptedPatient';
@@ -419,74 +692,347 @@ export class DecryptedPatient {
         return res;
     }
 }
+/**
+ *
+ *  Represents a patient in the iCure platform. A patient is a person who receives healthcare
+ *  services.
+ *  This entity stores personal, administrative, and medical information about the patient, and
+ *  supports
+ *  end-to-end encryption of sensitive data.
+ *  /
+ */
 export class EncryptedPatient {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The patient's identifiers, used by the client to uniquely identify the patient.
+         */
         this.identifier = [];
+        /**
+         *
+         *  The revision of the patient in the database, used for conflict management / optimistic locking.
+         */
         this.rev = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of creation.
+         */
         this.created = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of the latest modification.
+         */
         this.modified = undefined;
+        /**
+         *
+         *  The id of the User that created this patient.
+         */
         this.author = undefined;
+        /**
+         *
+         *  The id of the HealthcareParty that is responsible for this patient.
+         */
         this.responsible = undefined;
+        /**
+         *
+         *  Tags that qualify the patient as being member of a certain class.
+         */
         this.tags = [];
+        /**
+         *
+         *  Codes that identify or qualify this particular patient.
+         */
         this.codes = [];
+        /**
+         *
+         *  Hard delete (unix epoch in ms) timestamp of the object.
+         */
         this.deletionDate = undefined;
+        /**
+         *
+         *  The firstname (name) of the patient.
+         */
         this.firstName = undefined;
+        /**
+         *
+         *  The lastname (surname) of the patient.
+         */
         this.lastName = undefined;
+        /**
+         *
+         *  The list of all names of the patient, ordered by preference of use.
+         */
         this.names = [];
+        /**
+         *
+         *  The name of the company this patient is member of.
+         */
         this.companyName = undefined;
+        /**
+         *
+         *  The list of languages spoken by the patient ordered by fluency (alpha-2 code).
+         */
         this.languages = [];
+        /**
+         *
+         *  The list of addresses (with address type).
+         */
         this.addresses = [];
+        /**
+         *
+         *  Mr., Ms., Pr., Dr. ...
+         */
         this.civility = undefined;
+        /**
+         *
+         *  The gender of the patient.
+         */
         this.gender = Gender.Unknown;
+        /**
+         *
+         *  The birth sex of the patient.
+         */
         this.birthSex = Gender.Unknown;
+        /**
+         *
+         *  The id of the patient this patient has been merged with.
+         */
         this.mergeToPatientId = undefined;
+        /**
+         *
+         *  The ids of the patients that have been merged inside this patient.
+         */
         this.mergedIds = [];
+        /**
+         *
+         *  An alias of the person, nickname, ...
+         */
         this.alias = undefined;
+        /**
+         *
+         *  Whether the patient is active.
+         */
         this.active = true;
+        /**
+         *
+         *  When not active, the reason for deactivation.
+         */
         this.deactivationReason = "none";
+        /**
+         *
+         *  Deactivation date of the patient.
+         */
         this.deactivationDate = undefined;
+        /**
+         *
+         *  Social security inscription number.
+         */
         this.ssin = undefined;
+        /**
+         *
+         *  Lastname at birth (can be different from the current name).
+         */
         this.maidenName = undefined;
+        /**
+         *
+         *  Lastname of the spouse for a married woman.
+         */
         this.spouseName = undefined;
+        /**
+         *
+         *  Lastname of the partner.
+         */
         this.partnerName = undefined;
+        /**
+         *
+         *  The personal/marital status of the patient.
+         */
         this.personalStatus = PersonalStatus.Unknown;
+        /**
+         *
+         *  The birthdate encoded as a fuzzy date on 8 positions (YYYYMMDD).
+         */
         this.dateOfBirth = undefined;
+        /**
+         *
+         *  The date of death encoded as a fuzzy date on 8 positions (YYYYMMDD).
+         */
         this.dateOfDeath = undefined;
+        /**
+         *
+         *  Timestamp of the latest validation of the eID of the person.
+         */
         this.timestampOfLatestEidReading = undefined;
+        /**
+         *
+         *  The place of birth.
+         */
         this.placeOfBirth = undefined;
+        /**
+         *
+         *  The place of death.
+         */
         this.placeOfDeath = undefined;
+        /**
+         *
+         *  Whether the patient is deceased.
+         */
         this.deceased = undefined;
+        /**
+         *
+         *  The level of education (college degree, undergraduate, phd).
+         */
         this.education = undefined;
+        /**
+         *
+         *  The current professional activity.
+         */
         this.profession = undefined;
+        /**
+         *
+         *  Localized text notes (can be confidential).
+         */
         this.notes = [];
+        /**
+         *
+         *  A text note (can be confidential, encrypted by default).
+         */
         this.note = undefined;
+        /**
+         *
+         *  An administrative note, not confidential.
+         */
         this.administrativeNote = undefined;
+        /**
+         *
+         *  The nationality of the patient.
+         */
         this.nationality = undefined;
+        /**
+         *
+         *  The race of the patient.
+         */
         this.race = undefined;
+        /**
+         *
+         *  The ethnicity of the patient.
+         */
         this.ethnicity = undefined;
+        /**
+         *
+         *  The id of the user that usually handles this patient.
+         */
         this.preferredUserId = undefined;
+        /**
+         *
+         *  List of insurance coverages.
+         */
         this.insurabilities = [];
+        /**
+         *
+         *  List of partners, or persons of contact.
+         */
         this.partnerships = [];
+        /**
+         *
+         *  Links between this patient and healthcare parties.
+         */
         this.patientHealthCareParties = [];
+        /**
+         *
+         *  Financial information used to reimburse the patient.
+         */
         this.financialInstitutionInformation = [];
+        /**
+         *
+         *  Contracts between the patient and the healthcare entity.
+         */
         this.medicalHouseContracts = [];
+        /**
+         *
+         *  Codified list of professions exercised by this patient.
+         */
         this.patientProfessions = [];
+        /**
+         *
+         *  Extra parameters.
+         */
         this.parameters = {};
+        /**
+         *
+         *  Extra properties.
+         */
         this.properties = [];
+        /**
+         *
+         *  For each couple of HcParties, the AES exchange key.
+         */
         this.hcPartyKeys = {};
+        /**
+         *
+         *  Extra AES exchange keys, indexed by the owner of the pair and target data owner id.
+         */
         this.aesExchangeKeys = {};
+        /**
+         *
+         *  Keys used to transfer ownership of encrypted data between key pairs.
+         */
         this.transferKeys = {};
+        /**
+         *
+         *  Shamir partitions of the private key.
+         */
         this.privateKeyShamirPartitions = {};
+        /**
+         *
+         *  The public key of this patient, used to encrypt data for this patient.
+         */
         this.publicKey = undefined;
+        /**
+         *
+         *  Public keys for OAEP with SHA-256 encryption.
+         */
         this.publicKeysForOaepWithSha256 = [];
+        /**
+         *
+         *  The secret patient key, encrypted in the patient's own AES key.
+         */
         this.secretForeignKeys = [];
+        /**
+         *
+         *  The patient id encrypted in the delegates' AES keys.
+         */
         this.cryptedForeignKeys = {};
+        /**
+         *
+         *  The delegations giving access to connected healthcare information.
+         */
         this.delegations = {};
+        /**
+         *
+         *  The keys used to encrypt this entity when stored encrypted.
+         */
         this.encryptionKeys = {};
+        /**
+         *
+         *  The base64-encoded encrypted fields of this entity.
+         */
         this.encryptedSelf = undefined;
+        /**
+         *
+         *  The security metadata of the entity.
+         */
         this.securityMetadata = undefined;
+        /**
+         *
+         *  Properties related to crypto actor functionality.
+         */
         this.cryptoActorProperties = [];
+        /**
+         *
+         *  Always null for patients.
+         */
         this.parentId = undefined;
         this.isEncrypted = true;
         this.$ktClass = 'com.icure.cardinal.sdk.model.EncryptedPatient';