@icure/cardinal-sdk 2.1.1 → 2.1.2

package/model/HealthElement.mjs

@@ -10,39 +10,175 @@ import { DecryptedEpisode, EncryptedEpisode } from './embed/Episode.mjs';
 import { Laterality } from './embed/Laterality.mjs';
 import { DecryptedPlanOfAction, EncryptedPlanOfAction } from './embed/PlanOfAction.mjs';
 import { SecurityMetadata } from './embed/SecurityMetadata.mjs';
+/**
+ *
+ *  Represents a healthcare element. A healthcare element is a patient-centric representation of a
+ *  healthcare problem
+ *  that evolves over time in its name/label and characteristics. It is a central element in the
+ *  organisation of the
+ *  electronic health record, used to filter and link medical data in a meaningful way.
+ *  /
+ */
 export class DecryptedHealthElement {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The identifiers of the healthcare element.
+         */
         this.identifiers = [];
+        /**
+         *
+         *  The revision of the healthcare element 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 healthcare element.
+         */
         this.author = undefined;
+        /**
+         *
+         *  The id of the HealthcareParty that is responsible for this healthcare element.
+         */
         this.responsible = undefined;
+        /**
+         *
+         *  Tags that qualify the healthcare element as being member of a certain class.
+         */
         this.tags = [];
+        /**
+         *
+         *  Codes that identify or qualify this particular healthcare element.
+         */
         this.codes = [];
+        /**
+         *
+         *  Soft delete (unix epoch in ms) timestamp of the object.
+         */
         this.endOfLife = undefined;
+        /**
+         *
+         *  Hard delete (unix epoch in ms) timestamp of the object.
+         */
         this.deletionDate = undefined;
+        /**
+         *
+         *  The logical id of the healthcare element, used to link together different versions of the same
+         *  healthcare element.
+         */
         this.healthElementId = undefined;
+        /**
+         *
+         *  The date (unix epoch in ms) when the healthcare element is noted to have started and also closes
+         *  on the same date.
+         */
         this.valueDate = undefined;
+        /**
+         *
+         *  The date (unix epoch in ms) of the start of the healthcare element.
+         */
         this.openingDate = undefined;
+        /**
+         *
+         *  The date (unix epoch in ms) marking the end of the healthcare element.
+         */
         this.closingDate = undefined;
+        /**
+         *
+         *  Description of the healthcare element.
+         */
         this.descr = undefined;
+        /**
+         *
+         *  A text note (can be confidential, encrypted by default).
+         */
         this.note = undefined;
+        /**
+         *
+         *  Localized text annotations for the healthcare element.
+         */
         this.notes = [];
+        /**
+         *
+         *  Whether the healthcare element is relevant or not.
+         */
         this.relevant = true;
+        /**
+         *
+         *  Id of the opening contact when the healthcare element was created.
+         */
         this.idOpeningContact = undefined;
+        /**
+         *
+         *  Id of the closing contact for the healthcare element.
+         */
         this.idClosingContact = undefined;
+        /**
+         *
+         *  Id of the service when a service is used to create a healthcare element.
+         */
         this.idService = undefined;
+        /**
+         *
+         *  Left or right dominance/preference.
+         */
         this.laterality = undefined;
+        /**
+         *
+         *  List of healthcare approaches.
+         */
         this.plansOfAction = [];
+        /**
+         *
+         *  List of episodes of occurrences of the healthcare element.
+         */
         this.episodes = [];
+        /**
+         *
+         *  List of care team members assigned for the healthcare element.
+         */
         this.careTeam = [];
+        /**
+         *
+         *  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 the entity is stored encrypted.
+         */
         this.encryptionKeys = {};
+        /**
+         *
+         *  The base64-encoded encrypted fields of this entity.
+         */
         this.encryptedSelf = undefined;
+        /**
+         *
+         *  The security metadata of the entity.
+         */
         this.securityMetadata = undefined;
         this.isEncrypted = false;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== false)
@@ -215,39 +351,175 @@ export class DecryptedHealthElement {
         return res;
     }
 }
+/**
+ *
+ *  Represents a healthcare element. A healthcare element is a patient-centric representation of a
+ *  healthcare problem
+ *  that evolves over time in its name/label and characteristics. It is a central element in the
+ *  organisation of the
+ *  electronic health record, used to filter and link medical data in a meaningful way.
+ *  /
+ */
 export class EncryptedHealthElement {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The identifiers of the healthcare element.
+         */
         this.identifiers = [];
+        /**
+         *
+         *  The revision of the healthcare element 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 healthcare element.
+         */
         this.author = undefined;
+        /**
+         *
+         *  The id of the HealthcareParty that is responsible for this healthcare element.
+         */
         this.responsible = undefined;
+        /**
+         *
+         *  Tags that qualify the healthcare element as being member of a certain class.
+         */
         this.tags = [];
+        /**
+         *
+         *  Codes that identify or qualify this particular healthcare element.
+         */
         this.codes = [];
+        /**
+         *
+         *  Soft delete (unix epoch in ms) timestamp of the object.
+         */
         this.endOfLife = undefined;
+        /**
+         *
+         *  Hard delete (unix epoch in ms) timestamp of the object.
+         */
         this.deletionDate = undefined;
+        /**
+         *
+         *  The logical id of the healthcare element, used to link together different versions of the same
+         *  healthcare element.
+         */
         this.healthElementId = undefined;
+        /**
+         *
+         *  The date (unix epoch in ms) when the healthcare element is noted to have started and also closes
+         *  on the same date.
+         */
         this.valueDate = undefined;
+        /**
+         *
+         *  The date (unix epoch in ms) of the start of the healthcare element.
+         */
         this.openingDate = undefined;
+        /**
+         *
+         *  The date (unix epoch in ms) marking the end of the healthcare element.
+         */
         this.closingDate = undefined;
+        /**
+         *
+         *  Description of the healthcare element.
+         */
         this.descr = undefined;
+        /**
+         *
+         *  A text note (can be confidential, encrypted by default).
+         */
         this.note = undefined;
+        /**
+         *
+         *  Localized text annotations for the healthcare element.
+         */
         this.notes = [];
+        /**
+         *
+         *  Whether the healthcare element is relevant or not.
+         */
         this.relevant = true;
+        /**
+         *
+         *  Id of the opening contact when the healthcare element was created.
+         */
         this.idOpeningContact = undefined;
+        /**
+         *
+         *  Id of the closing contact for the healthcare element.
+         */
         this.idClosingContact = undefined;
+        /**
+         *
+         *  Id of the service when a service is used to create a healthcare element.
+         */
         this.idService = undefined;
+        /**
+         *
+         *  Left or right dominance/preference.
+         */
         this.laterality = undefined;
+        /**
+         *
+         *  List of healthcare approaches.
+         */
         this.plansOfAction = [];
+        /**
+         *
+         *  List of episodes of occurrences of the healthcare element.
+         */
         this.episodes = [];
+        /**
+         *
+         *  List of care team members assigned for the healthcare element.
+         */
         this.careTeam = [];
+        /**
+         *
+         *  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 the entity is stored encrypted.
+         */
         this.encryptionKeys = {};
+        /**
+         *
+         *  The base64-encoded encrypted fields of this entity.
+         */
         this.encryptedSelf = undefined;
+        /**
+         *
+         *  The security metadata of the entity.
+         */
         this.securityMetadata = undefined;
         this.isEncrypted = true;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== true)

package/model/HealthcareParty.d.mts

@@ -14,45 +14,197 @@ import { Gender } from './embed/Gender.mjs';
 import { PersonName } from './embed/PersonName.mjs';
 import { HexString } from './specializations/HexString.mjs';
 import { SpkiHexString } from './specializations/SpkiHexString.mjs';
+/**
+ *
+ *  Represents a healthcare party. A healthcare party is a person or organization that provides
+ *  healthcare services,
+ *  such as a physician, nurse, hospital, or medical practice. It is serialized in JSON and saved in
+ *  the underlying
+ *  icure-healthdata CouchDB database.
+ *  /
+ */
 export declare class HealthcareParty implements StoredDocument, Named, Person, CryptoActor, DataOwner, HasCodes, HasTags {
+    /**
+     *
+     *  The Id of the healthcare party. We encourage using either a v4 UUID or a HL7 Id.
+     */
     id: string;
+    /**
+     *
+     *  The revision of the healthcare party in the database, used for conflict management / optimistic
+     *  locking.
+     */
     rev: string | undefined;
+    /**
+     *
+     *  Creation timestamp (unix epoch in ms) of the object.
+     */
     created: number | undefined;
+    /**
+     *
+     *  Last modification timestamp (unix epoch in ms) of the object.
+     */
     modified: number | undefined;
+    /**
+     *
+     *  Hard delete (unix epoch in ms) timestamp of the object.
+     */
     deletionDate: number | undefined;
+    /**
+     *
+     *  The healthcare party's identifiers, used by the client to identify uniquely and unambiguously
+     *  the HCP.
+     */
     identifier: Array<Identifier>;
+    /**
+     *
+     *  Tags that qualify the healthcare party as being member of a certain class.
+     */
     tags: Array<CodeStub>;
+    /**
+     *
+     *  Codes that identify or qualify this particular healthcare party.
+     */
     codes: Array<CodeStub>;
+    /**
+     *
+     *  The full name of the healthcare party, used mainly when the healthcare party is an organization.
+     *
+     */
     name: string | undefined;
+    /**
+     *
+     *  The lastname (surname) of the healthcare party.
+     */
     lastName: string | undefined;
+    /**
+     *
+     *  The firstname (name) of the healthcare party.
+     */
     firstName: string | undefined;
+    /**
+     *
+     *  The list of all names of the healthcare party, ordered by preference of use.
+     */
     names: Array<PersonName>;
+    /**
+     *
+     *  The gender of the healthcare party.
+     */
     gender: Gender | undefined;
+    /**
+     *
+     *  Mr., Ms., Pr., Dr. ...
+     */
     civility: string | undefined;
+    /**
+     *
+     *  The name of the company this healthcare party is member of.
+     */
     companyName: string | undefined;
+    /**
+     *
+     *  Medical specialty of the healthcare party.
+     */
     speciality: string | undefined;
+    /**
+     *
+     *  Bank Account identifier of the healthcare party (IBAN).
+     */
     bankAccount: string | undefined;
+    /**
+     *
+     *  Bank Identifier Code (SWIFT Address) assigned to the bank.
+     */
     bic: string | undefined;
+    /**
+     *
+     *  Proxy bank account number.
+     */
     proxyBankAccount: string | undefined;
+    /**
+     *
+     *  Proxy bank identifier code.
+     */
     proxyBic: string | undefined;
+    /**
+     *
+     *  All details included in the invoice header.
+     */
     invoiceHeader: string | undefined;
+    /**
+     *
+     *  The id of the parent healthcare party.
+     */
     parentId: string | undefined;
+    /**
+     *
+     *  Social security inscription number.
+     */
     ssin: string | undefined;
+    /**
+     *
+     *  The list of addresses (with address type).
+     */
     addresses: Array<DecryptedAddress>;
+    /**
+     *
+     *  The list of languages spoken by the healthcare party ordered by fluency (alpha-2 code).
+     */
     languages: Array<string>;
+    /**
+     *
+     *  Medical specialty of the healthcare party codified using FHIR or Kmehr codification scheme.
+     */
     specialityCodes: Array<CodeStub>;
+    /**
+     *
+     *  Text notes.
+     */
     notes: string | undefined;
+    /**
+     *
+     *  List of financial information (Bank, bank account).
+     */
     financialInstitutionInformation: Array<DecryptedFinancialInstitutionInformation>;
+    /**
+     *
+     *  A description of the HCP, meant for the public and in multiple languages.
+     */
     descr: {
         [key: string]: string;
     };
+    /**
+     *
+     *  Extra properties for the healthcare party.
+     */
     properties: Array<DecryptedPropertyStub>;
+    /**
+     *
+     *  Whether the healthcare party profile is publicly visible.
+     */
     public: boolean;
+    /**
+     *
+     *  Properties that are publicly visible.
+     */
     publicProperties: Array<DecryptedPropertyStub> | undefined;
+    /**
+     *
+     *  Properties related to crypto actor functionality.
+     */
     cryptoActorProperties: Array<DecryptedPropertyStub>;
+    /**
+     *
+     *  For each couple of HcParties (delegate and owner), this map contains the AES exchange key.
+     */
     hcPartyKeys: {
         [key: string]: Array<HexString>;
     };
+    /**
+     *
+     *  Extra AES exchange keys, indexed by the owner of the pair and target data owner id.
+     */
     aesExchangeKeys: {
         [key: string]: {
             [key: string]: {
@@ -60,15 +212,31 @@ export declare class HealthcareParty implements StoredDocument, Named, Person, C
             };
         };
     };
+    /**
+     *
+     *  Keys used to transfer ownership of encrypted data between key pairs.
+     */
     transferKeys: {
         [key: string]: {
             [key: string]: HexString;
         };
     };
+    /**
+     *
+     *  Shamir partitions of the private key.
+     */
     privateKeyShamirPartitions: {
         [key: string]: HexString;
     };
+    /**
+     *
+     *  The public key of this HCP, used to encrypt data for this HCP.
+     */
     publicKey: SpkiHexString | undefined;
+    /**
+     *
+     *  Public keys for OAEP with SHA-256 encryption.
+     */
     publicKeysForOaepWithSha256: Array<SpkiHexString>;
     readonly $ktClass: 'com.icure.cardinal.sdk.model.HealthcareParty';
     constructor(partial: Partial<HealthcareParty>);