@icure/cardinal-sdk 2.1.1 → 2.1.2

package/model/embed/ResourceGroupAllocationSchedule.mjs

@@ -2,14 +2,48 @@
 import { expectArray, expectNumber, expectObject, expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 import { CodeStub } from '../base/CodeStub.mjs';
 import { EmbeddedTimeTableItem } from './EmbeddedTimeTableItem.mjs';
+/**
+ *
+ *  Represents an allocation schedule for a resource group, defining time table items within a date
+ *  range.
+ *  /
+ */
 export class ResourceGroupAllocationSchedule {
     constructor(partial) {
+        /**
+         *
+         *  The code identifying the resource group.
+         */
         this.resourceGroup = undefined;
+        /**
+         *
+         *  Tags associated with this schedule.
+         */
         this.tags = [];
+        /**
+         *
+         *  Codes associated with this schedule.
+         */
         this.codes = [];
+        /**
+         *
+         *  The name of this allocation schedule.
+         */
         this.name = undefined;
+        /**
+         *
+         *  The start date-time in YYYYMMDDHHMMSS format.
+         */
         this.startDateTime = undefined;
+        /**
+         *
+         *  The end date-time in YYYYMMDDHHMMSS format.
+         */
         this.endDateTime = undefined;
+        /**
+         *
+         *  The list of time table items in this schedule.
+         */
         this.items = [];
         if ('resourceGroup' in partial)
             this.resourceGroup = partial.resourceGroup;

package/model/embed/RoleConfiguration.d.mts

@@ -1,5 +1,19 @@
+/**
+ *
+ *
+ *   Represents the role configuration for a user, specifying the source of the roles and the set of
+ *  assigned roles.
+ */
 export declare class RoleConfiguration {
+    /**
+     *
+     *  The source from which the roles are derived (configuration, inherited, or default).
+     */
     source: RoleConfiguration.Source;
+    /**
+     *
+     *  The set of role identifiers assigned.
+     */
     roles: Array<string>;
     constructor(partial: Partial<RoleConfiguration> & Pick<RoleConfiguration, "source">);
     toJSON(): object;

package/model/embed/RoleConfiguration.mjs

@@ -1,7 +1,17 @@
 // auto-generated file
 import { expectArray, expectString, expectStringEnum, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *
+ *   Represents the role configuration for a user, specifying the source of the roles and the set of
+ *  assigned roles.
+ */
 export class RoleConfiguration {
     constructor(partial) {
+        /**
+         *
+         *  The set of role identifiers assigned.
+         */
         this.roles = [];
         this.source = partial.source;
         if ('roles' in partial && partial.roles !== undefined)

package/model/embed/SecureDelegation.d.mts

@@ -1,14 +1,55 @@
 import { Base64String } from '../specializations/Base64String.mjs';
 import { SecureDelegationKeyString } from '../specializations/SecureDelegationKeyString.mjs';
 import { AccessLevel } from './AccessLevel.mjs';
+/**
+ *
+ *  Represents a delegation which allows a data owner to access the encrypted data of an entity and
+ *  specifies
+ *  the access control level. Created by a delegator data owner and usable by a delegate data owner,
+ *  using
+ *  exchange data for encryption and access control.
+ *  /
+ */
 export declare class SecureDelegation {
+    /**
+     *
+     *  Optionally the id of the delegator data owner. May be null to prevent data leakages.
+     */
     delegator: string | undefined;
+    /**
+     *
+     *  Optionally the id of the delegate data owner. May be null to prevent data leakages.
+     */
     delegate: string | undefined;
+    /**
+     *
+     *  Encrypted secret ids of the entity holding this delegation.
+     */
     secretIds: Array<Base64String>;
+    /**
+     *
+     *  Encrypted AES keys used for the encryption of the entity's data.
+     */
     encryptionKeys: Array<Base64String>;
+    /**
+     *
+     *  Encrypted ids of the owning entity (e.g., patient id for a contact).
+     */
     owningEntityIds: Array<Base64String>;
+    /**
+     *
+     *  Keys of parent delegations in the security metadata.
+     */
     parentDelegations: Array<SecureDelegationKeyString>;
+    /**
+     *
+     *  The id of the exchange data used for encryption, if both delegator and delegate are explicit.
+     */
     exchangeDataId: string | undefined;
+    /**
+     *
+     *  The access level permissions for users with access to this delegation.
+     */
     permissions: AccessLevel;
     constructor(partial: Partial<SecureDelegation> & Pick<SecureDelegation, "permissions">);
     toJSON(): object;

package/model/embed/SecureDelegation.mjs

@@ -1,14 +1,51 @@
 // auto-generated file
 import { expectArray, expectString, expectStringEnum, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 import { AccessLevel } from './AccessLevel.mjs';
+/**
+ *
+ *  Represents a delegation which allows a data owner to access the encrypted data of an entity and
+ *  specifies
+ *  the access control level. Created by a delegator data owner and usable by a delegate data owner,
+ *  using
+ *  exchange data for encryption and access control.
+ *  /
+ */
 export class SecureDelegation {
     constructor(partial) {
+        /**
+         *
+         *  Optionally the id of the delegator data owner. May be null to prevent data leakages.
+         */
         this.delegator = undefined;
+        /**
+         *
+         *  Optionally the id of the delegate data owner. May be null to prevent data leakages.
+         */
         this.delegate = undefined;
+        /**
+         *
+         *  Encrypted secret ids of the entity holding this delegation.
+         */
         this.secretIds = [];
+        /**
+         *
+         *  Encrypted AES keys used for the encryption of the entity's data.
+         */
         this.encryptionKeys = [];
+        /**
+         *
+         *  Encrypted ids of the owning entity (e.g., patient id for a contact).
+         */
         this.owningEntityIds = [];
+        /**
+         *
+         *  Keys of parent delegations in the security metadata.
+         */
         this.parentDelegations = [];
+        /**
+         *
+         *  The id of the exchange data used for encryption, if both delegator and delegate are explicit.
+         */
         this.exchangeDataId = undefined;
         if ('delegator' in partial)
             this.delegator = partial.delegator;

package/model/embed/SecurityMetadata.d.mts

@@ -1,5 +1,16 @@
 import { SecureDelegation } from './SecureDelegation.mjs';
+/**
+ *
+ *  Holds the security metadata for user-based access control and encryption of entities.
+ *  Maps access control key hashes to their corresponding secure delegations.
+ *  /
+ */
 export declare class SecurityMetadata {
+    /**
+     *
+     *  A map from hex-encoded SHA-256 hash of an access control key to its corresponding secure
+     *  delegation.
+     */
     secureDelegations: {
         [key: string]: SecureDelegation;
     };

package/model/embed/SecurityMetadata.mjs

@@ -1,6 +1,12 @@
 // auto-generated file
 import { expectMap, expectObject, expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 import { SecureDelegation } from './SecureDelegation.mjs';
+/**
+ *
+ *  Holds the security metadata for user-based access control and encryption of entities.
+ *  Maps access control key hashes to their corresponding secure delegations.
+ *  /
+ */
 export class SecurityMetadata {
     constructor(partial) {
         this.secureDelegations = partial.secureDelegations;

package/model/embed/Substanceproduct.d.mts

@@ -1,9 +1,34 @@
 import { CodeStub } from '../base/CodeStub.mjs';
+/**
+ *
+ *  Represents a substance product with its intended and actually delivered codes and names.
+ *  /
+ */
 export declare class Substanceproduct {
+    /**
+     *
+     *  The list of coded identifiers for the intended substance product.
+     */
     intendedcds: Array<CodeStub>;
+    /**
+     *
+     *  The list of coded identifiers for the actually delivered substance product.
+     */
     deliveredcds: Array<CodeStub>;
+    /**
+     *
+     *  The name of the intended substance product.
+     */
     intendedname: string | undefined;
+    /**
+     *
+     *  The name of the actually delivered substance product.
+     */
     deliveredname: string | undefined;
+    /**
+     *
+     *  The product identifier.
+     */
     productId: string | undefined;
     constructor(partial: Partial<Substanceproduct>);
     toJSON(): object;

package/model/embed/Substanceproduct.mjs

@@ -1,12 +1,37 @@
 // auto-generated file
 import { expectArray, expectObject, expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 import { CodeStub } from '../base/CodeStub.mjs';
+/**
+ *
+ *  Represents a substance product with its intended and actually delivered codes and names.
+ *  /
+ */
 export class Substanceproduct {
     constructor(partial) {
+        /**
+         *
+         *  The list of coded identifiers for the intended substance product.
+         */
         this.intendedcds = [];
+        /**
+         *
+         *  The list of coded identifiers for the actually delivered substance product.
+         */
         this.deliveredcds = [];
+        /**
+         *
+         *  The name of the intended substance product.
+         */
         this.intendedname = undefined;
+        /**
+         *
+         *  The name of the actually delivered substance product.
+         */
         this.deliveredname = undefined;
+        /**
+         *
+         *  The product identifier.
+         */
         this.productId = undefined;
         if ('intendedcds' in partial && partial.intendedcds !== undefined)
             this.intendedcds = partial.intendedcds;

package/model/embed/SuspensionReason.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *
+ *   Enumerates the possible reasons for suspending a medical house contract.
+ */
 export declare enum SuspensionReason {
     NotInsured = "NotInsured",
     NoReasonGiven = "NoReasonGiven",

package/model/embed/SuspensionReason.mjs

@@ -1,4 +1,9 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Enumerates the possible reasons for suspending a medical house contract.
+ */
 export var SuspensionReason;
 (function (SuspensionReason) {
     SuspensionReason["NotInsured"] = "NotInsured";

package/model/embed/TaskStatus.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *
+ *   Enumerates the possible statuses of a task in its lifecycle.
+ */
 export declare enum TaskStatus {
     Pending = "Pending",
     Ongoing = "Ongoing",

package/model/embed/TaskStatus.mjs

@@ -1,4 +1,9 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Enumerates the possible statuses of a task in its lifecycle.
+ */
 export var TaskStatus;
 (function (TaskStatus) {
     TaskStatus["Pending"] = "Pending";

package/model/embed/TelecomType.d.mts

@@ -1,3 +1,9 @@
+/**
+ *
+ *
+ *   Enumerates the types of telecommunication channels available for contacting a person or
+ *  organization.
+ */
 export declare enum TelecomType {
     Mobile = "Mobile",
     Phone = "Phone",

package/model/embed/TelecomType.mjs

@@ -1,4 +1,10 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Enumerates the types of telecommunication channels available for contacting a person or
+ *  organization.
+ */
 export var TelecomType;
 (function (TelecomType) {
     TelecomType["Mobile"] = "Mobile";

package/model/embed/TimeSeries.d.mts

@@ -1,10 +1,44 @@
+/**
+ *
+ *
+ *   Represents a high-frequency time series with named fields, sample data, and statistical
+ *  summaries.
+ */
 export declare class TimeSeries {
+    /**
+     *
+     *  The names of the fields (columns) in the time series.
+     */
     fields: Array<string>;
+    /**
+     *
+     *  The sample data, where each inner list represents one sample across all fields.
+     */
     samples: Array<Array<number>>;
+    /**
+     *
+     *  The minimum values for each field.
+     */
     min: Array<number>;
+    /**
+     *
+     *  The maximum values for each field.
+     */
     max: Array<number>;
+    /**
+     *
+     *  The mean values for each field.
+     */
     mean: Array<number>;
+    /**
+     *
+     *  The median values for each field.
+     */
     median: Array<number>;
+    /**
+     *
+     *  The variance values for each field.
+     */
     variance: Array<number>;
     constructor(partial: Partial<TimeSeries>);
     toJSON(): object;

package/model/embed/TimeSeries.mjs

@@ -1,13 +1,47 @@
 // auto-generated file
 import { expectArray, expectNumber, expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *
+ *   Represents a high-frequency time series with named fields, sample data, and statistical
+ *  summaries.
+ */
 export class TimeSeries {
     constructor(partial) {
+        /**
+         *
+         *  The names of the fields (columns) in the time series.
+         */
         this.fields = [];
+        /**
+         *
+         *  The sample data, where each inner list represents one sample across all fields.
+         */
         this.samples = [];
+        /**
+         *
+         *  The minimum values for each field.
+         */
         this.min = [];
+        /**
+         *
+         *  The maximum values for each field.
+         */
         this.max = [];
+        /**
+         *
+         *  The mean values for each field.
+         */
         this.mean = [];
+        /**
+         *
+         *  The median values for each field.
+         */
         this.median = [];
+        /**
+         *
+         *  The variance values for each field.
+         */
         this.variance = [];
         if ('fields' in partial && partial.fields !== undefined)
             this.fields = partial.fields;

package/model/embed/TypedValue.d.mts

@@ -1,36 +1,137 @@
 import { Base64String } from '../specializations/Base64String.mjs';
 import { Encryptable } from './Encryptable.mjs';
 import { TypedValuesType } from './TypedValuesType.mjs';
+/**
+ *
+ *  Represents a typed value that can hold one of several primitive types (boolean, integer, double,
+ *  string, or date).
+ *  The actual value is stored in the corresponding typed field based on the [type].
+ *  /
+ */
 export interface TypedValue extends Encryptable {
+    /**
+     *
+     *  The type of the value stored.
+     */
     type: TypedValuesType | undefined;
+    /**
+     *
+     *  The boolean value, if type is BOOLEAN.
+     */
     booleanValue: boolean | undefined;
+    /**
+     *
+     *  The integer value, if type is INTEGER.
+     */
     integerValue: number | undefined;
+    /**
+     *
+     *  The double value, if type is DOUBLE.
+     */
     doubleValue: number | undefined;
+    /**
+     *
+     *  The string value, if type is STRING, JSON, or CLOB.
+     */
     stringValue: string | undefined;
+    /**
+     *
+     *  The date value as an Instant, if type is DATE.
+     */
     dateValue: number | undefined;
     readonly isEncrypted: boolean;
     toJSON(): object;
 }
+/**
+ *
+ *  Represents a typed value that can hold one of several primitive types (boolean, integer, double,
+ *  string, or date).
+ *  The actual value is stored in the corresponding typed field based on the [type].
+ *  /
+ */
 export declare class DecryptedTypedValue {
+    /**
+     *
+     *  The type of the value stored.
+     */
     type: TypedValuesType | undefined;
+    /**
+     *
+     *  The boolean value, if type is BOOLEAN.
+     */
     booleanValue: boolean | undefined;
+    /**
+     *
+     *  The integer value, if type is INTEGER.
+     */
     integerValue: number | undefined;
+    /**
+     *
+     *  The double value, if type is DOUBLE.
+     */
     doubleValue: number | undefined;
+    /**
+     *
+     *  The string value, if type is STRING, JSON, or CLOB.
+     */
     stringValue: string | undefined;
+    /**
+     *
+     *  The date value as an Instant, if type is DATE.
+     */
     dateValue: number | undefined;
+    /**
+     *
+     *  The base64-encoded encrypted content.
+     */
     encryptedSelf: Base64String | undefined;
     readonly isEncrypted: false;
     constructor(partial: Partial<DecryptedTypedValue>);
     toJSON(): object;
     static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): DecryptedTypedValue;
 }
+/**
+ *
+ *  Represents a typed value that can hold one of several primitive types (boolean, integer, double,
+ *  string, or date).
+ *  The actual value is stored in the corresponding typed field based on the [type].
+ *  /
+ */
 export declare class EncryptedTypedValue {
+    /**
+     *
+     *  The type of the value stored.
+     */
     type: TypedValuesType | undefined;
+    /**
+     *
+     *  The boolean value, if type is BOOLEAN.
+     */
     booleanValue: boolean | undefined;
+    /**
+     *
+     *  The integer value, if type is INTEGER.
+     */
     integerValue: number | undefined;
+    /**
+     *
+     *  The double value, if type is DOUBLE.
+     */
     doubleValue: number | undefined;
+    /**
+     *
+     *  The string value, if type is STRING, JSON, or CLOB.
+     */
     stringValue: string | undefined;
+    /**
+     *
+     *  The date value as an Instant, if type is DATE.
+     */
     dateValue: number | undefined;
+    /**
+     *
+     *  The base64-encoded encrypted content.
+     */
     encryptedSelf: Base64String | undefined;
     readonly isEncrypted: true;
     constructor(partial: Partial<EncryptedTypedValue>);