@icure/cardinal-sdk 2.1.1 → 2.1.2

package/model/Contact.mjs

@@ -10,35 +10,172 @@ import { Delegation } from './embed/Delegation.mjs';
 import { SecurityMetadata } from './embed/SecurityMetadata.mjs';
 import { DecryptedService, EncryptedService } from './embed/Service.mjs';
 import { DecryptedSubContact, EncryptedSubContact } from './embed/SubContact.mjs';
+/**
+ *
+ *  This entity is a root-level object. It represents a contact. It is serialized in JSON and saved
+ *  in the underlying
+ *  icure-contact CouchDB database.
+ *
+ *  A contact is an entry in the day-to-day journal of the medical file of a patient. A contact
+ *  happens between one
+ *  patient, one or several healthcare parties (with one healthcare party promoted as the responsible
+ *  of the contact),
+ *  at one place during one (fairly short) period of time.
+ *  A contact contains a series of services (acts, observations, exchanges) performed on the patient.
+ *  These services
+ *  can be linked to healthcare elements.
+ *
+ *  A contact can occur with or without direct interaction between the patient and the healthcare
+ *  party. For example,
+ *  when a healthcare party encodes data received from laboratory's test result, this is done in the
+ *  absence of a patient.
+ *  /
+ */
 export class DecryptedContact {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the contact in the database, used for conflict management / optimistic locking.
+         */
         this.rev = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of creation of the contact, will be filled automatically if
+         *  missing. Not enforced by the application server.
+         */
         this.created = undefined;
+        /**
+         *
+         *  The date (unix epoch in ms) of the latest modification of the contact, will be filled
+         *  automatically if missing. Not enforced by the application server.
+         */
         this.modified = undefined;
+        /**
+         *
+         *  The id of the User that has created this contact, will be filled automatically if missing. Not
+         *  enforced by the application server.
+         */
         this.author = undefined;
+        /**
+         *
+         *  The id of the HealthcareParty that is responsible for this contact, will be filled automatically
+         *  if missing. Not enforced by the application server.
+         */
         this.responsible = undefined;
+        /**
+         *
+         *  Tags that qualify the contact as being member of a certain class.
+         */
         this.tags = [];
+        /**
+         *
+         *  Codes that identify or qualify this particular contact.
+         */
         this.codes = [];
+        /**
+         *
+         *  The identifiers of the Contact.
+         */
         this.identifier = [];
+        /**
+         *
+         *  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;
+        /**
+         *
+         *  Separate contacts can be merged in one logical contact if they share the same groupId. When a
+         *  contact must be split to selectively assign rights to healthcare parties, the split contacts all
+         *  share the same groupId.
+         */
         this.groupId = undefined;
+        /**
+         *
+         *  The date (YYYYMMDDhhmmss) of the start of the contact.
+         */
         this.openingDate = undefined;
+        /**
+         *
+         *  The date (YYYYMMDDhhmmss) marking the end of the contact.
+         */
         this.closingDate = undefined;
+        /**
+         *
+         *  Description of the contact.
+         */
         this.descr = undefined;
+        /**
+         *
+         *  Location where the contact was recorded.
+         */
         this.location = undefined;
+        /**
+         *
+         *  The type of encounter made for the contact.
+         */
         this.encounterType = undefined;
+        /**
+         *
+         *  The location where the encounter took place.
+         */
         this.encounterLocation = undefined;
+        /**
+         *
+         *  Set of all sub-contacts recorded during the given contact. Sub-contacts are used to link
+         *  services embedded inside this contact to healthcare elements, healthcare approaches and/or forms.
+         */
         this.subContacts = [];
+        /**
+         *
+         *  Set of all services provided to the patient during the contact.
+         */
         this.services = [];
+        /**
+         *
+         *  The list of participants to the contact, with their type and data owner id.
+         */
         this.participantList = [];
+        /**
+         *
+         *  The secret patient key, encrypted in the patient document, in clear here.
+         */
         this.secretForeignKeys = [];
+        /**
+         *
+         *  The public patient key, encrypted here for separate Crypto Actors.
+         */
         this.cryptedForeignKeys = {};
+        /**
+         *
+         *  The delegations giving access to connected healthcare information.
+         */
         this.delegations = {};
+        /**
+         *
+         *  The contact secret encryption key used to encrypt the secured properties (like services for
+         *  example), encrypted for separate Crypto Actors.
+         */
         this.encryptionKeys = {};
+        /**
+         *
+         *  The encrypted fields of this contact.
+         */
         this.encryptedSelf = undefined;
+        /**
+         *
+         *  The security metadata of this contact, tracking access control information.
+         */
         this.securityMetadata = undefined;
+        /**
+         *
+         *  Comments and notes recorded by a healthcare party about this contact.
+         */
         this.notes = [];
         this.isEncrypted = false;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== false)
@@ -192,35 +329,172 @@ export class DecryptedContact {
         return res;
     }
 }
+/**
+ *
+ *  This entity is a root-level object. It represents a contact. It is serialized in JSON and saved
+ *  in the underlying
+ *  icure-contact CouchDB database.
+ *
+ *  A contact is an entry in the day-to-day journal of the medical file of a patient. A contact
+ *  happens between one
+ *  patient, one or several healthcare parties (with one healthcare party promoted as the responsible
+ *  of the contact),
+ *  at one place during one (fairly short) period of time.
+ *  A contact contains a series of services (acts, observations, exchanges) performed on the patient.
+ *  These services
+ *  can be linked to healthcare elements.
+ *
+ *  A contact can occur with or without direct interaction between the patient and the healthcare
+ *  party. For example,
+ *  when a healthcare party encodes data received from laboratory's test result, this is done in the
+ *  absence of a patient.
+ *  /
+ */
 export class EncryptedContact {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the contact in the database, used for conflict management / optimistic locking.
+         */
         this.rev = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of creation of the contact, will be filled automatically if
+         *  missing. Not enforced by the application server.
+         */
         this.created = undefined;
+        /**
+         *
+         *  The date (unix epoch in ms) of the latest modification of the contact, will be filled
+         *  automatically if missing. Not enforced by the application server.
+         */
         this.modified = undefined;
+        /**
+         *
+         *  The id of the User that has created this contact, will be filled automatically if missing. Not
+         *  enforced by the application server.
+         */
         this.author = undefined;
+        /**
+         *
+         *  The id of the HealthcareParty that is responsible for this contact, will be filled automatically
+         *  if missing. Not enforced by the application server.
+         */
         this.responsible = undefined;
+        /**
+         *
+         *  Tags that qualify the contact as being member of a certain class.
+         */
         this.tags = [];
+        /**
+         *
+         *  Codes that identify or qualify this particular contact.
+         */
         this.codes = [];
+        /**
+         *
+         *  The identifiers of the Contact.
+         */
         this.identifier = [];
+        /**
+         *
+         *  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;
+        /**
+         *
+         *  Separate contacts can be merged in one logical contact if they share the same groupId. When a
+         *  contact must be split to selectively assign rights to healthcare parties, the split contacts all
+         *  share the same groupId.
+         */
         this.groupId = undefined;
+        /**
+         *
+         *  The date (YYYYMMDDhhmmss) of the start of the contact.
+         */
         this.openingDate = undefined;
+        /**
+         *
+         *  The date (YYYYMMDDhhmmss) marking the end of the contact.
+         */
         this.closingDate = undefined;
+        /**
+         *
+         *  Description of the contact.
+         */
         this.descr = undefined;
+        /**
+         *
+         *  Location where the contact was recorded.
+         */
         this.location = undefined;
+        /**
+         *
+         *  The type of encounter made for the contact.
+         */
         this.encounterType = undefined;
+        /**
+         *
+         *  The location where the encounter took place.
+         */
         this.encounterLocation = undefined;
+        /**
+         *
+         *  Set of all sub-contacts recorded during the given contact. Sub-contacts are used to link
+         *  services embedded inside this contact to healthcare elements, healthcare approaches and/or forms.
+         */
         this.subContacts = [];
+        /**
+         *
+         *  Set of all services provided to the patient during the contact.
+         */
         this.services = [];
+        /**
+         *
+         *  The list of participants to the contact, with their type and data owner id.
+         */
         this.participantList = [];
+        /**
+         *
+         *  The secret patient key, encrypted in the patient document, in clear here.
+         */
         this.secretForeignKeys = [];
+        /**
+         *
+         *  The public patient key, encrypted here for separate Crypto Actors.
+         */
         this.cryptedForeignKeys = {};
+        /**
+         *
+         *  The delegations giving access to connected healthcare information.
+         */
         this.delegations = {};
+        /**
+         *
+         *  The contact secret encryption key used to encrypt the secured properties (like services for
+         *  example), encrypted for separate Crypto Actors.
+         */
         this.encryptionKeys = {};
+        /**
+         *
+         *  The encrypted fields of this contact.
+         */
         this.encryptedSelf = undefined;
+        /**
+         *
+         *  The security metadata of this contact, tracking access control information.
+         */
         this.securityMetadata = undefined;
+        /**
+         *
+         *  Comments and notes recorded by a healthcare party about this contact.
+         */
         this.notes = [];
         this.isEncrypted = true;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== true)

package/model/CryptoActorStub.d.mts

@@ -3,6 +3,12 @@ import { CryptoActor } from './base/CryptoActor.mjs';
 import { Versionable } from './base/Versionable.mjs';
 import { HexString } from './specializations/HexString.mjs';
 import { SpkiHexString } from './specializations/SpkiHexString.mjs';
+/**
+ *
+ *
+ *   Holds only data specific for crypto actors without any additional information (from patient,
+ *  hcparty, device).
+ */
 export declare class CryptoActorStub implements Versionable<string>, CryptoActor {
     id: string;
     rev: string;

package/model/CryptoActorStub.mjs

@@ -2,6 +2,12 @@
 import { expectArray, expectMap, expectObject, expectString, extractEntry } from '../internal/JsonDecodeUtils.mjs';
 import { randomUuid } from '../utils/Id.mjs';
 import { DecryptedPropertyStub } from './PropertyStub.mjs';
+/**
+ *
+ *
+ *   Holds only data specific for crypto actors without any additional information (from patient,
+ *  hcparty, device).
+ */
 export class CryptoActorStub {
     constructor(partial) {
         var _a;

package/model/CryptoActorStubWithType.d.mts

@@ -1,7 +1,21 @@
 import { CryptoActorStub } from './CryptoActorStub.mjs';
 import { DataOwnerType } from './DataOwnerType.mjs';
+/**
+ *
+ *  DTO that pairs a crypto actor stub with its data owner type, used for identifying data owners
+ *  and their cryptographic metadata.
+ *  /
+ */
 export declare class CryptoActorStubWithType {
+    /**
+     *
+     *  The type of data owner (healthcare party, device, or patient).
+     */
     type: DataOwnerType;
+    /**
+     *
+     *  The cryptographic actor stub containing encryption keys and related metadata.
+     */
     stub: CryptoActorStub;
     constructor(partial: Partial<CryptoActorStubWithType> & Pick<CryptoActorStubWithType, "type" | "stub">);
     toJSON(): object;

package/model/CryptoActorStubWithType.mjs

@@ -2,6 +2,12 @@
 import { expectObject, expectStringEnum, extractEntry } from '../internal/JsonDecodeUtils.mjs';
 import { CryptoActorStub } from './CryptoActorStub.mjs';
 import { DataOwnerType } from './DataOwnerType.mjs';
+/**
+ *
+ *  DTO that pairs a crypto actor stub with its data owner type, used for identifying data owners
+ *  and their cryptographic metadata.
+ *  /
+ */
 export class CryptoActorStubWithType {
     constructor(partial) {
         this.type = partial.type;

package/model/DataOwnerRegistrationSuccess.d.mts

@@ -1,6 +1,24 @@
+/**
+ *
+ *  DTO returned upon successful registration of a data owner, containing the credentials needed for
+ *  initial login.
+ *  /
+ */
 export declare class DataOwnerRegistrationSuccess {
+    /**
+     *
+     *  The login identifier of the newly registered user.
+     */
     userLogin: string;
+    /**
+     *
+     *  The unique identifier of the newly created user.
+     */
     userId: string;
+    /**
+     *
+     *  The authentication token for the newly registered user.
+     */
     token: string;
     constructor(partial: Partial<DataOwnerRegistrationSuccess> & Pick<DataOwnerRegistrationSuccess, "userLogin" | "userId" | "token">);
     toJSON(): object;

package/model/DataOwnerRegistrationSuccess.mjs

@@ -1,5 +1,11 @@
 // auto-generated file
 import { expectString, extractEntry } from '../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  DTO returned upon successful registration of a data owner, containing the credentials needed for
+ *  initial login.
+ *  /
+ */
 export class DataOwnerRegistrationSuccess {
     constructor(partial) {
         this.userLogin = partial.userLogin;

package/model/DataOwnerType.d.mts

@@ -1,3 +1,9 @@
+/**
+ *
+ *
+ *   Enumeration of the possible types of data owners in the iCure platform: healthcare parties,
+ *  devices, and patients.
+ */
 export declare enum DataOwnerType {
     Hcp = "Hcp",
     Device = "Device",

package/model/DataOwnerType.mjs

@@ -1,4 +1,10 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Enumeration of the possible types of data owners in the iCure platform: healthcare parties,
+ *  devices, and patients.
+ */
 export var DataOwnerType;
 (function (DataOwnerType) {
     DataOwnerType["Hcp"] = "Hcp";

package/model/DataOwnerWithType.d.mts

@@ -1,6 +1,12 @@
 import { Device } from './Device.mjs';
 import { HealthcareParty } from './HealthcareParty.mjs';
 import { EncryptedPatient } from './Patient.mjs';
+/**
+ *
+ *  Sealed interface representing a data owner paired with its type. Each subtype wraps a specific
+ *  kind of data owner (healthcare party, patient, or device) as a polymorphic type.
+ *  /
+ */
 export type DataOwnerWithType = DataOwnerWithType.HcpDataOwner | DataOwnerWithType.PatientDataOwner | DataOwnerWithType.DeviceDataOwner;
 export declare namespace DataOwnerWithType {
     class HcpDataOwner {

package/model/DatabaseInitialisation.d.mts

@@ -1,10 +1,32 @@
 import { HealthcareParty } from './HealthcareParty.mjs';
 import { Replication } from './Replication.mjs';
 import { User } from './User.mjs';
+/**
+ *
+ *  DTO containing the initial data required to set up a new database environment, including
+ *  seed users, healthcare parties, and replication configuration.
+ *  /
+ */
 export declare class DatabaseInitialisation {
+    /**
+     *
+     *  The list of initial users to create during database initialisation.
+     */
     users: Array<User> | undefined;
+    /**
+     *
+     *  The list of initial healthcare parties to create during database initialisation.
+     */
     healthcareParties: Array<HealthcareParty> | undefined;
+    /**
+     *
+     *  The replication configuration to apply during database initialisation.
+     */
     replication: Replication | undefined;
+    /**
+     *
+     *  The minimum required Kraken version for this database configuration.
+     */
     minimumKrakenVersion: string | undefined;
     constructor(partial: Partial<DatabaseInitialisation>);
     toJSON(): object;

package/model/DatabaseInitialisation.mjs

@@ -3,11 +3,33 @@ import { expectArray, expectObject, expectString, extractEntry } from '../intern
 import { HealthcareParty } from './HealthcareParty.mjs';
 import { Replication } from './Replication.mjs';
 import { User } from './User.mjs';
+/**
+ *
+ *  DTO containing the initial data required to set up a new database environment, including
+ *  seed users, healthcare parties, and replication configuration.
+ *  /
+ */
 export class DatabaseInitialisation {
     constructor(partial) {
+        /**
+         *
+         *  The list of initial users to create during database initialisation.
+         */
         this.users = [];
+        /**
+         *
+         *  The list of initial healthcare parties to create during database initialisation.
+         */
         this.healthcareParties = [];
+        /**
+         *
+         *  The replication configuration to apply during database initialisation.
+         */
         this.replication = undefined;
+        /**
+         *
+         *  The minimum required Kraken version for this database configuration.
+         */
         this.minimumKrakenVersion = undefined;
         if ('users' in partial)
             this.users = partial.users;