@icure/cardinal-sdk 2.1.0 → 2.1.2

package/model/embed/DocumentType.mjs

@@ -1,4 +1,9 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Enumerates the types of medical and administrative documents that can be managed in the system.
+ */
 export var DocumentType;
 (function (DocumentType) {
     DocumentType["Admission"] = "Admission";

package/model/embed/Duration.d.mts

@@ -1,6 +1,19 @@
 import { CodeStub } from '../base/CodeStub.mjs';
+/**
+ *
+ *  Represents a duration with a numeric value and a time unit code.
+ *  /
+ */
 export declare class Duration {
+    /**
+     *
+     *  The numeric value of the duration.
+     */
     value: number | undefined;
+    /**
+     *
+     *  The coded time unit (CD-TIMEUNIT) for this duration.
+     */
     unit: CodeStub | undefined;
     constructor(partial: Partial<Duration>);
     toJSON(): object;

package/model/embed/Duration.mjs

@@ -1,9 +1,22 @@
 // auto-generated file
 import { expectNumber, expectObject, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 import { CodeStub } from '../base/CodeStub.mjs';
+/**
+ *
+ *  Represents a duration with a numeric value and a time unit code.
+ *  /
+ */
 export class Duration {
     constructor(partial) {
+        /**
+         *
+         *  The numeric value of the duration.
+         */
         this.value = undefined;
+        /**
+         *
+         *  The coded time unit (CD-TIMEUNIT) for this duration.
+         */
         this.unit = undefined;
         if ('value' in partial)
             this.value = partial.value;

package/model/embed/EmbeddedTimeTableHour.d.mts

@@ -1,5 +1,18 @@
+/**
+ *
+ *  Represents a time range within a time table, defined by a start and end hour.
+ *  /
+ */
 export declare class EmbeddedTimeTableHour {
+    /**
+     *
+     *  The start hour encoded as an integer.
+     */
     startHour: number;
+    /**
+     *
+     *  The end hour encoded as an integer.
+     */
     endHour: number;
     constructor(partial: Partial<EmbeddedTimeTableHour> & Pick<EmbeddedTimeTableHour, "startHour" | "endHour">);
     toJSON(): object;

package/model/embed/EmbeddedTimeTableHour.mjs

@@ -1,5 +1,10 @@
 // auto-generated file
 import { expectNumber, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  Represents a time range within a time table, defined by a start and end hour.
+ *  /
+ */
 export class EmbeddedTimeTableHour {
     constructor(partial) {
         this.startHour = partial.startHour;

package/model/embed/EmbeddedTimeTableItem.d.mts

@@ -1,13 +1,55 @@
 import { EmbeddedTimeTableHour } from './EmbeddedTimeTableHour.mjs';
+/**
+ *
+ *  Represents a recurring time table item with scheduling rules, availability slots, and access
+ *  control.
+ *  /
+ */
 export declare class EmbeddedTimeTableItem {
+    /**
+     *
+     *  The recurrence rule (RFC 5545 RRULE format) defining the schedule pattern.
+     */
     rrule: string;
+    /**
+     *
+     *  The start date of the recurrence rule as an integer (YYYYMMDD).
+     */
     rruleStartDate: number | undefined;
+    /**
+     *
+     *  Minimum number of minutes before the slot that booking is allowed.
+     */
     notBeforeInMinutes: number | undefined;
+    /**
+     *
+     *  Maximum number of minutes after the slot start that booking is allowed.
+     */
     notAfterInMinutes: number | undefined;
+    /**
+     *
+     *  The list of hour ranges within this time table item.
+     */
     hours: Array<EmbeddedTimeTableHour>;
+    /**
+     *
+     *  The set of calendar item type identifiers associated with this item.
+     */
     calendarItemTypesIds: Array<string>;
+    /**
+     *
+     *  The number of available slots for this time table item.
+     */
     availabilities: number;
+    /**
+     *
+     *  The set of identifiers for parties allowed to reserve slots.
+     */
     reservingRights: Array<string>;
+    /**
+     *
+     *  Whether this time table item is publicly visible.
+     */
     public: boolean;
     constructor(partial: Partial<EmbeddedTimeTableItem> & Pick<EmbeddedTimeTableItem, "rrule" | "hours" | "calendarItemTypesIds">);
     toJSON(): object;

package/model/embed/EmbeddedTimeTableItem.mjs

@@ -1,13 +1,43 @@
 // auto-generated file
 import { expectArray, expectBoolean, expectNumber, expectObject, expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 import { EmbeddedTimeTableHour } from './EmbeddedTimeTableHour.mjs';
+/**
+ *
+ *  Represents a recurring time table item with scheduling rules, availability slots, and access
+ *  control.
+ *  /
+ */
 export class EmbeddedTimeTableItem {
     constructor(partial) {
+        /**
+         *
+         *  The start date of the recurrence rule as an integer (YYYYMMDD).
+         */
         this.rruleStartDate = undefined;
+        /**
+         *
+         *  Minimum number of minutes before the slot that booking is allowed.
+         */
         this.notBeforeInMinutes = undefined;
+        /**
+         *
+         *  Maximum number of minutes after the slot start that booking is allowed.
+         */
         this.notAfterInMinutes = undefined;
+        /**
+         *
+         *  The number of available slots for this time table item.
+         */
         this.availabilities = 1;
+        /**
+         *
+         *  The set of identifiers for parties allowed to reserve slots.
+         */
         this.reservingRights = [];
+        /**
+         *
+         *  Whether this time table item is publicly visible.
+         */
         this.public = false;
         this.rrule = partial.rrule;
         if ('rruleStartDate' in partial)

package/model/embed/Encryptable.d.mts

@@ -1,4 +1,11 @@
 import { Base64String } from '../specializations/Base64String.mjs';
+/**
+ *
+ *
+ *   Interface for DTOs that support end-to-end encryption. Implementing classes carry an encrypted
+ *  payload
+ *   that can be decrypted using the appropriate encryption keys.
+ */
 export interface Encryptable {
     encryptedSelf: Base64String | undefined;
 }

package/model/embed/Episode.d.mts

@@ -2,31 +2,109 @@ import { Identifiable } from '../base/Identifiable.mjs';
 import { Named } from '../base/Named.mjs';
 import { Base64String } from '../specializations/Base64String.mjs';
 import { Encryptable } from './Encryptable.mjs';
+/**
+ *
+ *  Represents a medical episode, which is a time-bounded grouping of healthcare elements related to
+ *  a specific concern.
+ *  /
+ */
 export interface Episode extends Encryptable, Identifiable<string>, Named {
+    /**
+     *
+     *  A comment associated with the episode.
+     */
     comment: string | undefined;
+    /**
+     *
+     *  The start date in YYYYMMDDHHMMSS format. Unknown components are set to 00.
+     */
     startDate: number | undefined;
+    /**
+     *
+     *  The end date in YYYYMMDDHHMMSS format. Unknown components are set to 00.
+     */
     endDate: number | undefined;
     readonly isEncrypted: boolean;
     toJSON(): object;
 }
+/**
+ *
+ *  Represents a medical episode, which is a time-bounded grouping of healthcare elements related to
+ *  a specific concern.
+ *  /
+ */
 export declare class DecryptedEpisode {
+    /**
+     *
+     *  The unique identifier of this episode.
+     */
     id: string;
+    /**
+     *
+     *  The name of the episode.
+     */
     name: string | undefined;
+    /**
+     *
+     *  A comment associated with the episode.
+     */
     comment: string | undefined;
+    /**
+     *
+     *  The start date in YYYYMMDDHHMMSS format. Unknown components are set to 00.
+     */
     startDate: number | undefined;
+    /**
+     *
+     *  The end date in YYYYMMDDHHMMSS format. Unknown components are set to 00.
+     */
     endDate: number | undefined;
+    /**
+     *
+     *  The base64-encoded encrypted content of this episode.
+     */
     encryptedSelf: Base64String | undefined;
     readonly isEncrypted: false;
     constructor(partial: Partial<DecryptedEpisode>);
     toJSON(): object;
     static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): DecryptedEpisode;
 }
+/**
+ *
+ *  Represents a medical episode, which is a time-bounded grouping of healthcare elements related to
+ *  a specific concern.
+ *  /
+ */
 export declare class EncryptedEpisode {
+    /**
+     *
+     *  The unique identifier of this episode.
+     */
     id: string;
+    /**
+     *
+     *  The name of the episode.
+     */
     name: string | undefined;
+    /**
+     *
+     *  A comment associated with the episode.
+     */
     comment: string | undefined;
+    /**
+     *
+     *  The start date in YYYYMMDDHHMMSS format. Unknown components are set to 00.
+     */
     startDate: number | undefined;
+    /**
+     *
+     *  The end date in YYYYMMDDHHMMSS format. Unknown components are set to 00.
+     */
     endDate: number | undefined;
+    /**
+     *
+     *  The base64-encoded encrypted content of this episode.
+     */
     encryptedSelf: Base64String | undefined;
     readonly isEncrypted: true;
     constructor(partial: Partial<EncryptedEpisode>);

package/model/embed/Episode.mjs

@@ -1,13 +1,39 @@
 // auto-generated file
 import { expectNumber, expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 import { randomUuid } from '../../utils/Id.mjs';
+/**
+ *
+ *  Represents a medical episode, which is a time-bounded grouping of healthcare elements related to
+ *  a specific concern.
+ *  /
+ */
 export class DecryptedEpisode {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The name of the episode.
+         */
         this.name = undefined;
+        /**
+         *
+         *  A comment associated with the episode.
+         */
         this.comment = undefined;
+        /**
+         *
+         *  The start date in YYYYMMDDHHMMSS format. Unknown components are set to 00.
+         */
         this.startDate = undefined;
+        /**
+         *
+         *  The end date in YYYYMMDDHHMMSS format. Unknown components are set to 00.
+         */
         this.endDate = undefined;
+        /**
+         *
+         *  The base64-encoded encrypted content of this episode.
+         */
         this.encryptedSelf = undefined;
         this.isEncrypted = false;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== false)
@@ -62,13 +88,39 @@ export class DecryptedEpisode {
         return res;
     }
 }
+/**
+ *
+ *  Represents a medical episode, which is a time-bounded grouping of healthcare elements related to
+ *  a specific concern.
+ *  /
+ */
 export class EncryptedEpisode {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The name of the episode.
+         */
         this.name = undefined;
+        /**
+         *
+         *  A comment associated with the episode.
+         */
         this.comment = undefined;
+        /**
+         *
+         *  The start date in YYYYMMDDHHMMSS format. Unknown components are set to 00.
+         */
         this.startDate = undefined;
+        /**
+         *
+         *  The end date in YYYYMMDDHHMMSS format. Unknown components are set to 00.
+         */
         this.endDate = undefined;
+        /**
+         *
+         *  The base64-encoded encrypted content of this episode.
+         */
         this.encryptedSelf = undefined;
         this.isEncrypted = true;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== true)

package/model/embed/FinancialInstitutionInformation.d.mts

@@ -1,38 +1,148 @@
 import { Base64String } from '../specializations/Base64String.mjs';
 import { Encryptable } from './Encryptable.mjs';
+/**
+ *
+ *  Represents information about a financial institution, including bank account details and proxy
+ *  account configuration.
+ *  /
+ */
 export interface FinancialInstitutionInformation extends Encryptable {
+    /**
+     *
+     *  The name of the financial institution.
+     */
     name: string | undefined;
+    /**
+     *
+     *  The key identifying this financial institution information entry.
+     */
     key: string | undefined;
+    /**
+     *
+     *  The bank account number (e.g., IBAN).
+     */
     bankAccount: string | undefined;
+    /**
+     *
+     *  The BIC/SWIFT code of the bank.
+     */
     bic: string | undefined;
+    /**
+     *
+     *  The proxy bank account number.
+     */
     proxyBankAccount: string | undefined;
+    /**
+     *
+     *  The BIC/SWIFT code for the proxy bank.
+     */
     proxyBic: string | undefined;
+    /**
+     *
+     *  Set of insurance or healthcare party identifiers that prefer this financial institution.
+     */
     preferredFiiForPartners: Array<string>;
     readonly isEncrypted: boolean;
     toJSON(): object;
 }
+/**
+ *
+ *  Represents information about a financial institution, including bank account details and proxy
+ *  account configuration.
+ *  /
+ */
 export declare class DecryptedFinancialInstitutionInformation {
+    /**
+     *
+     *  The name of the financial institution.
+     */
     name: string | undefined;
+    /**
+     *
+     *  The key identifying this financial institution information entry.
+     */
     key: string | undefined;
+    /**
+     *
+     *  The bank account number (e.g., IBAN).
+     */
     bankAccount: string | undefined;
+    /**
+     *
+     *  The BIC/SWIFT code of the bank.
+     */
     bic: string | undefined;
+    /**
+     *
+     *  The proxy bank account number.
+     */
     proxyBankAccount: string | undefined;
+    /**
+     *
+     *  The BIC/SWIFT code for the proxy bank.
+     */
     proxyBic: string | undefined;
+    /**
+     *
+     *  Set of insurance or healthcare party identifiers that prefer this financial institution.
+     */
     preferredFiiForPartners: Array<string>;
+    /**
+     *
+     *  The base64-encoded encrypted content.
+     */
     encryptedSelf: Base64String | undefined;
     readonly isEncrypted: false;
     constructor(partial: Partial<DecryptedFinancialInstitutionInformation>);
     toJSON(): object;
     static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): DecryptedFinancialInstitutionInformation;
 }
+/**
+ *
+ *  Represents information about a financial institution, including bank account details and proxy
+ *  account configuration.
+ *  /
+ */
 export declare class EncryptedFinancialInstitutionInformation {
+    /**
+     *
+     *  The name of the financial institution.
+     */
     name: string | undefined;
+    /**
+     *
+     *  The key identifying this financial institution information entry.
+     */
     key: string | undefined;
+    /**
+     *
+     *  The bank account number (e.g., IBAN).
+     */
     bankAccount: string | undefined;
+    /**
+     *
+     *  The BIC/SWIFT code of the bank.
+     */
     bic: string | undefined;
+    /**
+     *
+     *  The proxy bank account number.
+     */
     proxyBankAccount: string | undefined;
+    /**
+     *
+     *  The BIC/SWIFT code for the proxy bank.
+     */
     proxyBic: string | undefined;
+    /**
+     *
+     *  Set of insurance or healthcare party identifiers that prefer this financial institution.
+     */
     preferredFiiForPartners: Array<string>;
+    /**
+     *
+     *  The base64-encoded encrypted content.
+     */
     encryptedSelf: Base64String | undefined;
     readonly isEncrypted: true;
     constructor(partial: Partial<EncryptedFinancialInstitutionInformation>);

package/model/embed/FinancialInstitutionInformation.mjs

@@ -1,14 +1,52 @@
 // auto-generated file
 import { expectArray, expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  Represents information about a financial institution, including bank account details and proxy
+ *  account configuration.
+ *  /
+ */
 export class DecryptedFinancialInstitutionInformation {
     constructor(partial) {
+        /**
+         *
+         *  The name of the financial institution.
+         */
         this.name = undefined;
+        /**
+         *
+         *  The key identifying this financial institution information entry.
+         */
         this.key = undefined;
+        /**
+         *
+         *  The bank account number (e.g., IBAN).
+         */
         this.bankAccount = undefined;
+        /**
+         *
+         *  The BIC/SWIFT code of the bank.
+         */
         this.bic = undefined;
+        /**
+         *
+         *  The proxy bank account number.
+         */
         this.proxyBankAccount = undefined;
+        /**
+         *
+         *  The BIC/SWIFT code for the proxy bank.
+         */
         this.proxyBic = undefined;
+        /**
+         *
+         *  Set of insurance or healthcare party identifiers that prefer this financial institution.
+         */
         this.preferredFiiForPartners = [];
+        /**
+         *
+         *  The base64-encoded encrypted content.
+         */
         this.encryptedSelf = undefined;
         this.isEncrypted = false;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== false)
@@ -74,15 +112,53 @@ export class DecryptedFinancialInstitutionInformation {
         return res;
     }
 }
+/**
+ *
+ *  Represents information about a financial institution, including bank account details and proxy
+ *  account configuration.
+ *  /
+ */
 export class EncryptedFinancialInstitutionInformation {
     constructor(partial) {
+        /**
+         *
+         *  The name of the financial institution.
+         */
         this.name = undefined;
+        /**
+         *
+         *  The key identifying this financial institution information entry.
+         */
         this.key = undefined;
+        /**
+         *
+         *  The bank account number (e.g., IBAN).
+         */
         this.bankAccount = undefined;
+        /**
+         *
+         *  The BIC/SWIFT code of the bank.
+         */
         this.bic = undefined;
+        /**
+         *
+         *  The proxy bank account number.
+         */
         this.proxyBankAccount = undefined;
+        /**
+         *
+         *  The BIC/SWIFT code for the proxy bank.
+         */
         this.proxyBic = undefined;
+        /**
+         *
+         *  Set of insurance or healthcare party identifiers that prefer this financial institution.
+         */
         this.preferredFiiForPartners = [];
+        /**
+         *
+         *  The base64-encoded encrypted content.
+         */
         this.encryptedSelf = undefined;
         this.isEncrypted = true;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== true)

package/model/embed/FrontEndMigrationStatus.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *
+ *   Enumerates the possible statuses of a front-end migration process.
+ */
 export declare enum FrontEndMigrationStatus {
     Started = "Started",
     Paused = "Paused",

package/model/embed/FrontEndMigrationStatus.mjs

@@ -1,4 +1,9 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Enumerates the possible statuses of a front-end migration process.
+ */
 export var FrontEndMigrationStatus;
 (function (FrontEndMigrationStatus) {
     FrontEndMigrationStatus["Started"] = "Started";

package/model/embed/Gender.d.mts

@@ -1,3 +1,9 @@
+/**
+ *
+ *
+ *   Enumerates the possible gender values for a patient, including original gender, changed gender,
+ *  and unknown.
+ */
 export declare enum Gender {
     Male = "Male",
     Female = "Female",

package/model/embed/Gender.mjs

@@ -1,4 +1,10 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Enumerates the possible gender values for a patient, including original gender, changed gender,
+ *  and unknown.
+ */
 export var Gender;
 (function (Gender) {
     Gender["Male"] = "Male";

package/model/embed/GroupType.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *
+ *   Enumerates the types of groups in the system hierarchy: root, app, or database.
+ */
 export declare enum GroupType {
     Root = "Root",
     App = "App",