@icure/cardinal-sdk 2.1.0 → 2.1.2

package/model/Classification.d.mts

@@ -7,69 +7,256 @@ import { Delegation } from './embed/Delegation.mjs';
 import { Encryptable } from './embed/Encryptable.mjs';
 import { SecurityMetadata } from './embed/SecurityMetadata.mjs';
 import { Base64String } from './specializations/Base64String.mjs';
+/**
+ *
+ *  Represents a classification used to organize and categorize medical data. Classifications can be
+ *  nested
+ *  through parent-child relationships and linked to classification templates.
+ *  /
+ */
 export interface Classification extends StoredDocument, ICureDocument<string>, HasEncryptionMetadata, Encryptable, HasEndOfLife {
+    /**
+     *
+     *  The id of the parent classification, for nesting.
+     */
     parentId: string | undefined;
+    /**
+     *
+     *  A human-readable label for this classification.
+     */
     label: string;
+    /**
+     *
+     *  The id of the classification template this classification is based on.
+     */
     templateId: string | undefined;
     readonly isEncrypted: boolean;
     toJSON(): object;
 }
+/**
+ *
+ *  Represents a classification used to organize and categorize medical data. Classifications can be
+ *  nested
+ *  through parent-child relationships and linked to classification templates.
+ *  /
+ */
 export declare class DecryptedClassification {
+    /**
+     *
+     *  The Id of the classification. We encourage using either a v4 UUID or a HL7 Id.
+     */
     id: string;
+    /**
+     *
+     *  The revision of the classification in the database, used for conflict management / optimistic
+     *  locking.
+     */
     rev: string | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) of creation of this entity.
+     */
     created: number | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) of the latest modification of this entity.
+     */
     modified: number | undefined;
+    /**
+     *
+     *  The id of the User that created this classification.
+     */
     author: string | undefined;
+    /**
+     *
+     *  The id of the data owner that is responsible for this classification.
+     */
     responsible: string | undefined;
+    /**
+     *
+     *  Tags that qualify the classification as being member of a certain class.
+     */
     tags: Array<CodeStub>;
+    /**
+     *
+     *  Codes that identify or qualify this particular classification.
+     */
     codes: Array<CodeStub>;
+    /**
+     *
+     *  Soft delete (unix epoch in ms) timestamp of the object.
+     */
     endOfLife: number | undefined;
+    /**
+     *
+     *  Hard delete (unix epoch in ms) timestamp of the object.
+     */
     deletionDate: number | undefined;
+    /**
+     *
+     *  The id of the parent classification, for nesting.
+     */
     parentId: string | undefined;
+    /**
+     *
+     *  A human-readable label for this classification.
+     */
     label: string;
+    /**
+     *
+     *  The id of the classification template this classification is based on.
+     */
     templateId: string | undefined;
+    /**
+     *
+     *  The secret foreign keys, used for secure linking to patients.
+     */
     secretForeignKeys: Array<string>;
+    /**
+     *
+     *  The encrypted foreign keys.
+     */
     cryptedForeignKeys: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The delegations giving access to connected healthcare information.
+     */
     delegations: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The encryption keys used to encrypt secured properties, encrypted for separate Crypto Actors.
+     */
     encryptionKeys: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The base64-encoded encrypted fields of this classification.
+     */
     encryptedSelf: Base64String | undefined;
+    /**
+     *
+     *  The security metadata of this entity, for access control.
+     */
     securityMetadata: SecurityMetadata | undefined;
     readonly isEncrypted: false;
     constructor(partial: Partial<DecryptedClassification>);
     toJSON(): object;
     static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): DecryptedClassification;
 }
+/**
+ *
+ *  Represents a classification used to organize and categorize medical data. Classifications can be
+ *  nested
+ *  through parent-child relationships and linked to classification templates.
+ *  /
+ */
 export declare class EncryptedClassification {
+    /**
+     *
+     *  The Id of the classification. We encourage using either a v4 UUID or a HL7 Id.
+     */
     id: string;
+    /**
+     *
+     *  The revision of the classification in the database, used for conflict management / optimistic
+     *  locking.
+     */
     rev: string | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) of creation of this entity.
+     */
     created: number | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) of the latest modification of this entity.
+     */
     modified: number | undefined;
+    /**
+     *
+     *  The id of the User that created this classification.
+     */
     author: string | undefined;
+    /**
+     *
+     *  The id of the data owner that is responsible for this classification.
+     */
     responsible: string | undefined;
+    /**
+     *
+     *  Tags that qualify the classification as being member of a certain class.
+     */
     tags: Array<CodeStub>;
+    /**
+     *
+     *  Codes that identify or qualify this particular classification.
+     */
     codes: Array<CodeStub>;
+    /**
+     *
+     *  Soft delete (unix epoch in ms) timestamp of the object.
+     */
     endOfLife: number | undefined;
+    /**
+     *
+     *  Hard delete (unix epoch in ms) timestamp of the object.
+     */
     deletionDate: number | undefined;
+    /**
+     *
+     *  The id of the parent classification, for nesting.
+     */
     parentId: string | undefined;
+    /**
+     *
+     *  A human-readable label for this classification.
+     */
     label: string;
+    /**
+     *
+     *  The id of the classification template this classification is based on.
+     */
     templateId: string | undefined;
+    /**
+     *
+     *  The secret foreign keys, used for secure linking to patients.
+     */
     secretForeignKeys: Array<string>;
+    /**
+     *
+     *  The encrypted foreign keys.
+     */
     cryptedForeignKeys: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The delegations giving access to connected healthcare information.
+     */
     delegations: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The encryption keys used to encrypt secured properties, encrypted for separate Crypto Actors.
+     */
     encryptionKeys: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The base64-encoded encrypted fields of this classification.
+     */
     encryptedSelf: Base64String | undefined;
+    /**
+     *
+     *  The security metadata of this entity, for access control.
+     */
     securityMetadata: SecurityMetadata | undefined;
     readonly isEncrypted: true;
     constructor(partial: Partial<EncryptedClassification>);

package/model/Classification.mjs

@@ -4,26 +4,106 @@ import { randomUuid } from '../utils/Id.mjs';
 import { CodeStub } from './base/CodeStub.mjs';
 import { Delegation } from './embed/Delegation.mjs';
 import { SecurityMetadata } from './embed/SecurityMetadata.mjs';
+/**
+ *
+ *  Represents a classification used to organize and categorize medical data. Classifications can be
+ *  nested
+ *  through parent-child relationships and linked to classification templates.
+ *  /
+ */
 export class DecryptedClassification {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the classification in the database, used for conflict management / optimistic
+         *  locking.
+         */
         this.rev = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of creation of this entity.
+         */
         this.created = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of the latest modification of this entity.
+         */
         this.modified = undefined;
+        /**
+         *
+         *  The id of the User that created this classification.
+         */
         this.author = undefined;
+        /**
+         *
+         *  The id of the data owner that is responsible for this classification.
+         */
         this.responsible = undefined;
+        /**
+         *
+         *  Tags that qualify the classification as being member of a certain class.
+         */
         this.tags = [];
+        /**
+         *
+         *  Codes that identify or qualify this particular classification.
+         */
         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 id of the parent classification, for nesting.
+         */
         this.parentId = undefined;
+        /**
+         *
+         *  A human-readable label for this classification.
+         */
         this.label = "";
+        /**
+         *
+         *  The id of the classification template this classification is based on.
+         */
         this.templateId = undefined;
+        /**
+         *
+         *  The secret foreign keys, used for secure linking to patients.
+         */
         this.secretForeignKeys = [];
+        /**
+         *
+         *  The encrypted foreign keys.
+         */
         this.cryptedForeignKeys = {};
+        /**
+         *
+         *  The delegations giving access to connected healthcare information.
+         */
         this.delegations = {};
+        /**
+         *
+         *  The encryption keys used to encrypt secured properties, encrypted for separate Crypto Actors.
+         */
         this.encryptionKeys = {};
+        /**
+         *
+         *  The base64-encoded encrypted fields of this classification.
+         */
         this.encryptedSelf = undefined;
+        /**
+         *
+         *  The security metadata of this entity, for access control.
+         */
         this.securityMetadata = undefined;
         this.isEncrypted = false;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== false)
@@ -136,26 +216,106 @@ export class DecryptedClassification {
         return res;
     }
 }
+/**
+ *
+ *  Represents a classification used to organize and categorize medical data. Classifications can be
+ *  nested
+ *  through parent-child relationships and linked to classification templates.
+ *  /
+ */
 export class EncryptedClassification {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the classification in the database, used for conflict management / optimistic
+         *  locking.
+         */
         this.rev = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of creation of this entity.
+         */
         this.created = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of the latest modification of this entity.
+         */
         this.modified = undefined;
+        /**
+         *
+         *  The id of the User that created this classification.
+         */
         this.author = undefined;
+        /**
+         *
+         *  The id of the data owner that is responsible for this classification.
+         */
         this.responsible = undefined;
+        /**
+         *
+         *  Tags that qualify the classification as being member of a certain class.
+         */
         this.tags = [];
+        /**
+         *
+         *  Codes that identify or qualify this particular classification.
+         */
         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 id of the parent classification, for nesting.
+         */
         this.parentId = undefined;
+        /**
+         *
+         *  A human-readable label for this classification.
+         */
         this.label = "";
+        /**
+         *
+         *  The id of the classification template this classification is based on.
+         */
         this.templateId = undefined;
+        /**
+         *
+         *  The secret foreign keys, used for secure linking to patients.
+         */
         this.secretForeignKeys = [];
+        /**
+         *
+         *  The encrypted foreign keys.
+         */
         this.cryptedForeignKeys = {};
+        /**
+         *
+         *  The delegations giving access to connected healthcare information.
+         */
         this.delegations = {};
+        /**
+         *
+         *  The encryption keys used to encrypt secured properties, encrypted for separate Crypto Actors.
+         */
         this.encryptionKeys = {};
+        /**
+         *
+         *  The base64-encoded encrypted fields of this classification.
+         */
         this.encryptedSelf = undefined;
+        /**
+         *
+         *  The security metadata of this entity, for access control.
+         */
         this.securityMetadata = undefined;
         this.isEncrypted = true;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== true)

package/model/Code.d.mts

@@ -1,25 +1,88 @@
 import { CodeIdentification } from './base/CodeIdentification.mjs';
 import { StoredDocument } from './base/StoredDocument.mjs';
+/**
+ *
+ *  Represents a medical code from a terminology system (e.g., ICD, SNOMED). The code id is composed
+ *  of
+ *  type|code|version and must be unique.
+ *  /
+ */
 export declare class Code implements StoredDocument, CodeIdentification<string> {
+    /**
+     *
+     *  The Id of the code, formatted as type|code|version. Must be unique.
+     */
     id: string;
+    /**
+     *
+     *  The revision of the code 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 context in which this code is used when embedded.
+     */
     context: string | undefined;
+    /**
+     *
+     *  The code type (e.g., ICD). The type + version + code combination must be unique.
+     */
     type: string | undefined;
+    /**
+     *
+     *  The code value (e.g., I06.2). Local codes are encoded as LOCAL:SLLOCALFROMMYSOFT.
+     */
     code: string | undefined;
+    /**
+     *
+     *  The version of the code (e.g., 10). Must be lexicographically searchable.
+     */
     version: string | undefined;
+    /**
+     *
+     *  The human-readable label for the code, mapped by language (e.g., {en: "...", fr: "..."}).
+     */
     label: {
         [key: string]: string;
     };
+    /**
+     *
+     *  The id of the author of this code.
+     */
     author: string | undefined;
+    /**
+     *
+     *  The geographic regions where this code is applicable (e.g., be, fr).
+     */
     regions: Array<string>;
+    /**
+     *
+     *  Links towards related codes (corresponds to approximate links in qualifiedLinks).
+     */
     links: Array<string>;
+    /**
+     *
+     *  Qualified links towards related codes.
+     */
     qualifiedLinks: {
         [key: string]: Array<string>;
     };
+    /**
+     *
+     *  Extra search terms indexed by language.
+     */
     searchTerms: {
         [key: string]: Array<string>;
     };
+    /**
+     *
+     *  Whether this code is disabled.
+     */
     disabled: boolean;
     constructor(partial: Partial<Code>);
     toJSON(): object;

package/model/Code.mjs

@@ -1,21 +1,80 @@
 // auto-generated file
 import { expectArray, expectBoolean, expectMap, expectNumber, expectString, extractEntry } from '../internal/JsonDecodeUtils.mjs';
 import { randomUuid } from '../utils/Id.mjs';
+/**
+ *
+ *  Represents a medical code from a terminology system (e.g., ICD, SNOMED). The code id is composed
+ *  of
+ *  type|code|version and must be unique.
+ *  /
+ */
 export class Code {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the code 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 context in which this code is used when embedded.
+         */
         this.context = undefined;
+        /**
+         *
+         *  The code type (e.g., ICD). The type + version + code combination must be unique.
+         */
         this.type = undefined;
+        /**
+         *
+         *  The code value (e.g., I06.2). Local codes are encoded as LOCAL:SLLOCALFROMMYSOFT.
+         */
         this.code = undefined;
+        /**
+         *
+         *  The version of the code (e.g., 10). Must be lexicographically searchable.
+         */
         this.version = undefined;
+        /**
+         *
+         *  The human-readable label for the code, mapped by language (e.g., {en: "...", fr: "..."}).
+         */
         this.label = {};
+        /**
+         *
+         *  The id of the author of this code.
+         */
         this.author = undefined;
+        /**
+         *
+         *  The geographic regions where this code is applicable (e.g., be, fr).
+         */
         this.regions = [];
+        /**
+         *
+         *  Links towards related codes (corresponds to approximate links in qualifiedLinks).
+         */
         this.links = [];
+        /**
+         *
+         *  Qualified links towards related codes.
+         */
         this.qualifiedLinks = {};
+        /**
+         *
+         *  Extra search terms indexed by language.
+         */
         this.searchTerms = {};
+        /**
+         *
+         *  Whether this code is disabled.
+         */
         this.disabled = false;
         this.id = (_a = partial.id) !== null && _a !== void 0 ? _a : randomUuid();
         if ('rev' in partial)