@icure/cardinal-sdk 2.1.1 → 2.1.2

package/model/HealthcareParty.mjs

@@ -8,46 +8,210 @@ import { DecryptedAddress } from './embed/Address.mjs';
 import { DecryptedFinancialInstitutionInformation } from './embed/FinancialInstitutionInformation.mjs';
 import { Gender } from './embed/Gender.mjs';
 import { PersonName } from './embed/PersonName.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 class HealthcareParty {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the healthcare party in the database, used for conflict management / optimistic
+         *  locking.
+         */
         this.rev = undefined;
+        /**
+         *
+         *  Creation timestamp (unix epoch in ms) of the object.
+         */
         this.created = undefined;
+        /**
+         *
+         *  Last modification timestamp (unix epoch in ms) of the object.
+         */
         this.modified = undefined;
+        /**
+         *
+         *  Hard delete (unix epoch in ms) timestamp of the object.
+         */
         this.deletionDate = undefined;
+        /**
+         *
+         *  The healthcare party's identifiers, used by the client to identify uniquely and unambiguously
+         *  the HCP.
+         */
         this.identifier = [];
+        /**
+         *
+         *  Tags that qualify the healthcare party as being member of a certain class.
+         */
         this.tags = [];
+        /**
+         *
+         *  Codes that identify or qualify this particular healthcare party.
+         */
         this.codes = [];
+        /**
+         *
+         *  The full name of the healthcare party, used mainly when the healthcare party is an organization.
+         *
+         */
         this.name = undefined;
+        /**
+         *
+         *  The lastname (surname) of the healthcare party.
+         */
         this.lastName = undefined;
+        /**
+         *
+         *  The firstname (name) of the healthcare party.
+         */
         this.firstName = undefined;
+        /**
+         *
+         *  The list of all names of the healthcare party, ordered by preference of use.
+         */
         this.names = [];
+        /**
+         *
+         *  The gender of the healthcare party.
+         */
         this.gender = undefined;
+        /**
+         *
+         *  Mr., Ms., Pr., Dr. ...
+         */
         this.civility = undefined;
+        /**
+         *
+         *  The name of the company this healthcare party is member of.
+         */
         this.companyName = undefined;
+        /**
+         *
+         *  Medical specialty of the healthcare party.
+         */
         this.speciality = undefined;
+        /**
+         *
+         *  Bank Account identifier of the healthcare party (IBAN).
+         */
         this.bankAccount = undefined;
+        /**
+         *
+         *  Bank Identifier Code (SWIFT Address) assigned to the bank.
+         */
         this.bic = undefined;
+        /**
+         *
+         *  Proxy bank account number.
+         */
         this.proxyBankAccount = undefined;
+        /**
+         *
+         *  Proxy bank identifier code.
+         */
         this.proxyBic = undefined;
+        /**
+         *
+         *  All details included in the invoice header.
+         */
         this.invoiceHeader = undefined;
+        /**
+         *
+         *  The id of the parent healthcare party.
+         */
         this.parentId = undefined;
+        /**
+         *
+         *  Social security inscription number.
+         */
         this.ssin = undefined;
+        /**
+         *
+         *  The list of addresses (with address type).
+         */
         this.addresses = [];
+        /**
+         *
+         *  The list of languages spoken by the healthcare party ordered by fluency (alpha-2 code).
+         */
         this.languages = [];
+        /**
+         *
+         *  Medical specialty of the healthcare party codified using FHIR or Kmehr codification scheme.
+         */
         this.specialityCodes = [];
+        /**
+         *
+         *  Text notes.
+         */
         this.notes = undefined;
+        /**
+         *
+         *  List of financial information (Bank, bank account).
+         */
         this.financialInstitutionInformation = [];
+        /**
+         *
+         *  A description of the HCP, meant for the public and in multiple languages.
+         */
         this.descr = {};
+        /**
+         *
+         *  Extra properties for the healthcare party.
+         */
         this.properties = [];
+        /**
+         *
+         *  Whether the healthcare party profile is publicly visible.
+         */
         this.public = false;
+        /**
+         *
+         *  Properties that are publicly visible.
+         */
         this.publicProperties = undefined;
+        /**
+         *
+         *  Properties related to crypto actor functionality.
+         */
         this.cryptoActorProperties = [];
+        /**
+         *
+         *  For each couple of HcParties (delegate and owner), this map contains 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 HCP, used to encrypt data for this HCP.
+         */
         this.publicKey = undefined;
+        /**
+         *
+         *  Public keys for OAEP with SHA-256 encryption.
+         */
         this.publicKeysForOaepWithSha256 = [];
         this.$ktClass = 'com.icure.cardinal.sdk.model.HealthcareParty';
         this.id = (_a = partial.id) !== null && _a !== void 0 ? _a : randomUuid();

package/model/IdWithRev.d.mts

@@ -1,5 +1,19 @@
+/**
+ *
+ *
+ *   DTO representing an entity identifier paired with its optional revision. Commonly used in
+ *   bulk operations and responses to identify stored documents.
+ */
 export declare class IdWithRev {
+    /**
+     *
+     *  The unique identifier of the entity.
+     */
     id: string;
+    /**
+     *
+     *  The revision of the entity, used for optimistic locking.
+     */
     rev: string | undefined;
     constructor(partial: Partial<IdWithRev>);
     toJSON(): object;

package/model/IdWithRev.mjs

@@ -1,9 +1,19 @@
 // auto-generated file
 import { expectString, extractEntry } from '../internal/JsonDecodeUtils.mjs';
 import { randomUuid } from '../utils/Id.mjs';
+/**
+ *
+ *
+ *   DTO representing an entity identifier paired with its optional revision. Commonly used in
+ *   bulk operations and responses to identify stored documents.
+ */
 export class IdWithRev {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the entity, used for optimistic locking.
+         */
         this.rev = undefined;
         this.id = (_a = partial.id) !== null && _a !== void 0 ? _a : randomUuid();
         if ('rev' in partial)

package/model/IndexingInfo.d.mts

@@ -1,4 +1,14 @@
+/**
+ *
+ *
+ *   DTO providing information about the current indexing status of the database views.
+ */
 export declare class IndexingInfo {
+    /**
+     *
+     *  A map of indexing statuses, keyed by view name, where the value represents the indexing progress
+     *  percentage.
+     */
     statuses: {
         [key: string]: number;
     } | undefined;

package/model/IndexingInfo.mjs

@@ -1,7 +1,17 @@
 // auto-generated file
 import { expectMap, expectNumber, expectString, extractEntry } from '../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *
+ *   DTO providing information about the current indexing status of the database views.
+ */
 export class IndexingInfo {
     constructor(partial) {
+        /**
+         *
+         *  A map of indexing statuses, keyed by view name, where the value represents the indexing progress
+         *  percentage.
+         */
         this.statuses = undefined;
         if ('statuses' in partial)
             this.statuses = partial.statuses;

package/model/Insurance.d.mts

@@ -1,18 +1,69 @@
 import { StoredDocument } from './base/StoredDocument.mjs';
 import { DecryptedAddress } from './embed/Address.mjs';
+/**
+ *
+ *  Represents an insurance entity. An insurance can be a mutual fund, a private insurance company,
+ *  or any other type of insurance organization that covers healthcare costs.
+ *  /
+ */
 export declare class Insurance implements StoredDocument {
+    /**
+     *
+     *  The unique identifier of the insurance.
+     */
     id: string;
+    /**
+     *
+     *  The revision of the insurance in the database, used for conflict management / optimistic
+     *  locking.
+     */
     rev: string | undefined;
+    /**
+     *
+     *  Hard delete (unix epoch in ms) timestamp of the object.
+     */
     deletionDate: number | undefined;
+    /**
+     *
+     *  The name of the insurance in different languages.
+     */
     name: {
         [key: string]: string;
     };
+    /**
+     *
+     *  Whether this is a private insurance.
+     */
     privateInsurance: boolean;
+    /**
+     *
+     *  Whether this insurance covers hospitalisation.
+     */
     hospitalisationInsurance: boolean;
+    /**
+     *
+     *  Whether this insurance covers ambulatory care.
+     */
     ambulatoryInsurance: boolean;
+    /**
+     *
+     *  The insurance code.
+     */
     code: string | undefined;
+    /**
+     *
+     *  The agreement number for the insurance.
+     */
     agreementNumber: string | undefined;
+    /**
+     *
+     *  The id of the parent insurance entity.
+     */
     parent: string | undefined;
+    /**
+     *
+     *  The address of the insurance company.
+     */
     address: DecryptedAddress;
     constructor(partial: Partial<Insurance> & Pick<Insurance, "address">);
     toJSON(): object;

package/model/Insurance.mjs

@@ -2,17 +2,60 @@
 import { expectBoolean, expectMap, expectNumber, expectObject, expectString, extractEntry } from '../internal/JsonDecodeUtils.mjs';
 import { randomUuid } from '../utils/Id.mjs';
 import { DecryptedAddress } from './embed/Address.mjs';
+/**
+ *
+ *  Represents an insurance entity. An insurance can be a mutual fund, a private insurance company,
+ *  or any other type of insurance organization that covers healthcare costs.
+ *  /
+ */
 export class Insurance {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the insurance in the database, used for conflict management / optimistic
+         *  locking.
+         */
         this.rev = undefined;
+        /**
+         *
+         *  Hard delete (unix epoch in ms) timestamp of the object.
+         */
         this.deletionDate = undefined;
+        /**
+         *
+         *  The name of the insurance in different languages.
+         */
         this.name = {};
+        /**
+         *
+         *  Whether this is a private insurance.
+         */
         this.privateInsurance = false;
+        /**
+         *
+         *  Whether this insurance covers hospitalisation.
+         */
         this.hospitalisationInsurance = false;
+        /**
+         *
+         *  Whether this insurance covers ambulatory care.
+         */
         this.ambulatoryInsurance = false;
+        /**
+         *
+         *  The insurance code.
+         */
         this.code = undefined;
+        /**
+         *
+         *  The agreement number for the insurance.
+         */
         this.agreementNumber = undefined;
+        /**
+         *
+         *  The id of the parent insurance entity.
+         */
         this.parent = undefined;
         this.id = (_a = partial.id) !== null && _a !== void 0 ? _a : randomUuid();
         if ('rev' in partial)