@icure/cardinal-sdk 2.1.1 → 2.1.3

package/model/Group.mjs

@@ -7,24 +7,95 @@ import { AuthenticationClass } from './embed/AuthenticationClass.mjs';
 import { UserType } from './embed/UserType.mjs';
 import { ExternalJwtConfig } from './security/ExternalJwtConfig.mjs';
 import { OperationToken } from './security/OperationToken.mjs';
+/**
+ *
+ *  Represents a group in the iCure platform. A group corresponds to a practice, hospital, or
+ *  organization
+ *  that contains its own set of databases and users.
+ *  /
+ */
 export class Group {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the group 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;
+        /**
+         *
+         *  Tags that qualify the group as being member of a certain class.
+         */
         this.tags = [];
+        /**
+         *
+         *  Tags that are publicly visible for the group.
+         */
         this.publicTags = [];
+        /**
+         *
+         *  Username for the group.
+         */
         this.name = undefined;
+        /**
+         *
+         *  Password for the group access.
+         */
         this.password = undefined;
+        /**
+         *
+         *  List of servers accessible to the group.
+         */
         this.servers = undefined;
+        /**
+         *
+         *  Whether the group has a super admin permission.
+         */
         this.superAdmin = false;
+        /**
+         *
+         *  Extra properties for the group. Those properties are typed (see class Property).
+         */
         this.properties = [];
+        /**
+         *
+         *  The default roles for each user type, if not otherwise specified on the user.
+         */
         this.defaultUserRoles = {};
+        /**
+         *
+         *  Single-used token to perform specific operations.
+         */
         this.operationTokens = {};
+        /**
+         *
+         *  List of entities that have to be collected from a shared database.
+         */
         this.sharedEntities = {};
+        /**
+         *
+         *  Minimum version of Kraken required to access API.
+         */
         this.minimumKrakenVersion = undefined;
+        /**
+         *
+         *  Verified public keys that can be used to allow log in with external JWTs.
+         */
         this.externalJwtConfig = {};
+        /**
+         *
+         *  The id of the parent super group, if any.
+         */
         this.superGroup = undefined;
+        /**
+         *
+         *  A user-chosen identifier for the applications for which this group holds data.
+         */
         this.projectId = undefined;
         this.templates = undefined;
         this.id = (_a = partial.id) !== null && _a !== void 0 ? _a : randomUuid();

package/model/GroupDeletionReport.d.mts

@@ -1,6 +1,23 @@
+/**
+ *
+ *
+ *   DTO representing a report generated after a group deletion operation.
+ */
 export declare class GroupDeletionReport {
+    /**
+     *
+     *  The type of the deleted resource.
+     */
     type: string;
+    /**
+     *
+     *  The unique identifier of the deleted group.
+     */
     id: string;
+    /**
+     *
+     *  The server on which the group was deleted.
+     */
     server: string;
     constructor(partial: Partial<GroupDeletionReport> & Pick<GroupDeletionReport, "type" | "server">);
     toJSON(): object;

package/model/GroupDeletionReport.mjs

@@ -1,6 +1,11 @@
 // auto-generated file
 import { expectString, extractEntry } from '../internal/JsonDecodeUtils.mjs';
 import { randomUuid } from '../utils/Id.mjs';
+/**
+ *
+ *
+ *   DTO representing a report generated after a group deletion operation.
+ */
 export class GroupDeletionReport {
     constructor(partial) {
         var _a;

package/model/GroupScoped.d.mts

@@ -1,3 +1,13 @@
+/**
+ *
+ *  Wraps an entity and associates it with the group it exists in.
+ *
+ *  In-group api methods take in input and return group scoped entities.
+ *
+ *  To prevent mistakes, you shouldn't instantiate this class yourself, instead you should always get the GroupScoped
+ *  entity from the `inGroup` methods of the apis. Using GroupScoped entities with the wrong groupId, or created by
+ *  instances of the SDK working on a different base group, can cause errors and other unexpected behavior.
+ */
 export declare class GroupScoped<E> {
     entity: E;
     groupId: string;

package/model/GroupScoped.mjs

@@ -1,4 +1,14 @@
 // auto-generated file
+/**
+ *
+ *  Wraps an entity and associates it with the group it exists in.
+ *
+ *  In-group api methods take in input and return group scoped entities.
+ *
+ *  To prevent mistakes, you shouldn't instantiate this class yourself, instead you should always get the GroupScoped
+ *  entity from the `inGroup` methods of the apis. Using GroupScoped entities with the wrong groupId, or created by
+ *  instances of the SDK working on a different base group, can cause errors and other unexpected behavior.
+ */
 export class GroupScoped {
     constructor(partial) {
         this.entity = partial.entity;

package/model/HealthElement.d.mts

@@ -13,108 +13,463 @@ import { Laterality } from './embed/Laterality.mjs';
 import { DecryptedPlanOfAction, EncryptedPlanOfAction, PlanOfAction } from './embed/PlanOfAction.mjs';
 import { SecurityMetadata } from './embed/SecurityMetadata.mjs';
 import { Base64String } from './specializations/Base64String.mjs';
+/**
+ *
+ *  Represents a healthcare element. A healthcare element is a patient-centric representation of a
+ *  healthcare problem
+ *  that evolves over time in its name/label and characteristics. It is a central element in the
+ *  organisation of the
+ *  electronic health record, used to filter and link medical data in a meaningful way.
+ *  /
+ */
 export interface HealthElement extends StoredDocument, ICureDocument<string>, HasEncryptionMetadata, Encryptable, HasEndOfLife {
+    /**
+     *
+     *  The identifiers of the healthcare element.
+     */
     identifiers: Array<Identifier>;
+    /**
+     *
+     *  The logical id of the healthcare element, used to link together different versions of the same
+     *  healthcare element.
+     */
     healthElementId: string | undefined;
+    /**
+     *
+     *  The date (unix epoch in ms) when the healthcare element is noted to have started and also closes
+     *  on the same date.
+     */
     valueDate: number | undefined;
+    /**
+     *
+     *  The date (unix epoch in ms) of the start of the healthcare element.
+     */
     openingDate: number | undefined;
+    /**
+     *
+     *  The date (unix epoch in ms) marking the end of the healthcare element.
+     */
     closingDate: number | undefined;
+    /**
+     *
+     *  Description of the healthcare element.
+     */
     descr: string | undefined;
+    /**
+     *
+     *  A text note (can be confidential, encrypted by default).
+     */
     note: string | undefined;
+    /**
+     *
+     *  Localized text annotations for the healthcare element.
+     */
     notes: Array<Annotation>;
+    /**
+     *
+     *  Whether the healthcare element is relevant or not.
+     */
     relevant: boolean;
+    /**
+     *
+     *  Id of the opening contact when the healthcare element was created.
+     */
     idOpeningContact: string | undefined;
+    /**
+     *
+     *  Id of the closing contact for the healthcare element.
+     */
     idClosingContact: string | undefined;
+    /**
+     *
+     *  Id of the service when a service is used to create a healthcare element.
+     */
     idService: string | undefined;
+    /**
+     *
+     *  Left or right dominance/preference.
+     */
     laterality: Laterality | undefined;
+    /**
+     *
+     *  List of healthcare approaches.
+     */
     plansOfAction: Array<PlanOfAction>;
+    /**
+     *
+     *  List of episodes of occurrences of the healthcare element.
+     */
     episodes: Array<Episode>;
+    /**
+     *
+     *  List of care team members assigned for the healthcare element.
+     */
     careTeam: Array<CareTeamMember>;
     readonly isEncrypted: boolean;
     toJSON(): object;
 }
+/**
+ *
+ *  Represents a healthcare element. A healthcare element is a patient-centric representation of a
+ *  healthcare problem
+ *  that evolves over time in its name/label and characteristics. It is a central element in the
+ *  organisation of the
+ *  electronic health record, used to filter and link medical data in a meaningful way.
+ *  /
+ */
 export declare class DecryptedHealthElement {
+    /**
+     *
+     *  The Id of the healthcare element. We encourage using either a v4 UUID or a HL7 Id.
+     */
     id: string;
+    /**
+     *
+     *  The identifiers of the healthcare element.
+     */
     identifiers: Array<Identifier>;
+    /**
+     *
+     *  The revision of the healthcare element in the database, used for conflict management /
+     *  optimistic locking.
+     */
     rev: string | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) of creation.
+     */
     created: number | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) of the latest modification.
+     */
     modified: number | undefined;
+    /**
+     *
+     *  The id of the User that created this healthcare element.
+     */
     author: string | undefined;
+    /**
+     *
+     *  The id of the HealthcareParty that is responsible for this healthcare element.
+     */
     responsible: string | undefined;
+    /**
+     *
+     *  Tags that qualify the healthcare element as being member of a certain class.
+     */
     tags: Array<CodeStub>;
+    /**
+     *
+     *  Codes that identify or qualify this particular healthcare element.
+     */
     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 logical id of the healthcare element, used to link together different versions of the same
+     *  healthcare element.
+     */
     healthElementId: string | undefined;
+    /**
+     *
+     *  The date (unix epoch in ms) when the healthcare element is noted to have started and also closes
+     *  on the same date.
+     */
     valueDate: number | undefined;
+    /**
+     *
+     *  The date (unix epoch in ms) of the start of the healthcare element.
+     */
     openingDate: number | undefined;
+    /**
+     *
+     *  The date (unix epoch in ms) marking the end of the healthcare element.
+     */
     closingDate: number | undefined;
+    /**
+     *
+     *  Description of the healthcare element.
+     */
     descr: string | undefined;
+    /**
+     *
+     *  A text note (can be confidential, encrypted by default).
+     */
     note: string | undefined;
+    /**
+     *
+     *  Localized text annotations for the healthcare element.
+     */
     notes: Array<Annotation>;
+    /**
+     *
+     *  Whether the healthcare element is relevant or not.
+     */
     relevant: boolean;
+    /**
+     *
+     *  Id of the opening contact when the healthcare element was created.
+     */
     idOpeningContact: string | undefined;
+    /**
+     *
+     *  Id of the closing contact for the healthcare element.
+     */
     idClosingContact: string | undefined;
+    /**
+     *
+     *  Id of the service when a service is used to create a healthcare element.
+     */
     idService: string | undefined;
+    /**
+     *
+     *  Left or right dominance/preference.
+     */
     laterality: Laterality | undefined;
+    /**
+     *
+     *  List of healthcare approaches.
+     */
     plansOfAction: Array<DecryptedPlanOfAction>;
+    /**
+     *
+     *  List of episodes of occurrences of the healthcare element.
+     */
     episodes: Array<DecryptedEpisode>;
+    /**
+     *
+     *  List of care team members assigned for the healthcare element.
+     */
     careTeam: Array<DecryptedCareTeamMember>;
+    /**
+     *
+     *  The secret patient key, encrypted in the patient's own AES key.
+     */
     secretForeignKeys: Array<string>;
+    /**
+     *
+     *  The patient id encrypted in the delegates' AES keys.
+     */
     cryptedForeignKeys: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The delegations giving access to connected healthcare information.
+     */
     delegations: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The keys used to encrypt this entity when the entity is stored encrypted.
+     */
     encryptionKeys: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The base64-encoded encrypted fields of this entity.
+     */
     encryptedSelf: Base64String | undefined;
+    /**
+     *
+     *  The security metadata of the entity.
+     */
     securityMetadata: SecurityMetadata | undefined;
     readonly isEncrypted: false;
     constructor(partial: Partial<DecryptedHealthElement>);
     toJSON(): object;
     static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): DecryptedHealthElement;
 }
+/**
+ *
+ *  Represents a healthcare element. A healthcare element is a patient-centric representation of a
+ *  healthcare problem
+ *  that evolves over time in its name/label and characteristics. It is a central element in the
+ *  organisation of the
+ *  electronic health record, used to filter and link medical data in a meaningful way.
+ *  /
+ */
 export declare class EncryptedHealthElement {
+    /**
+     *
+     *  The Id of the healthcare element. We encourage using either a v4 UUID or a HL7 Id.
+     */
     id: string;
+    /**
+     *
+     *  The identifiers of the healthcare element.
+     */
     identifiers: Array<Identifier>;
+    /**
+     *
+     *  The revision of the healthcare element in the database, used for conflict management /
+     *  optimistic locking.
+     */
     rev: string | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) of creation.
+     */
     created: number | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) of the latest modification.
+     */
     modified: number | undefined;
+    /**
+     *
+     *  The id of the User that created this healthcare element.
+     */
     author: string | undefined;
+    /**
+     *
+     *  The id of the HealthcareParty that is responsible for this healthcare element.
+     */
     responsible: string | undefined;
+    /**
+     *
+     *  Tags that qualify the healthcare element as being member of a certain class.
+     */
     tags: Array<CodeStub>;
+    /**
+     *
+     *  Codes that identify or qualify this particular healthcare element.
+     */
     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 logical id of the healthcare element, used to link together different versions of the same
+     *  healthcare element.
+     */
     healthElementId: string | undefined;
+    /**
+     *
+     *  The date (unix epoch in ms) when the healthcare element is noted to have started and also closes
+     *  on the same date.
+     */
     valueDate: number | undefined;
+    /**
+     *
+     *  The date (unix epoch in ms) of the start of the healthcare element.
+     */
     openingDate: number | undefined;
+    /**
+     *
+     *  The date (unix epoch in ms) marking the end of the healthcare element.
+     */
     closingDate: number | undefined;
+    /**
+     *
+     *  Description of the healthcare element.
+     */
     descr: string | undefined;
+    /**
+     *
+     *  A text note (can be confidential, encrypted by default).
+     */
     note: string | undefined;
+    /**
+     *
+     *  Localized text annotations for the healthcare element.
+     */
     notes: Array<Annotation>;
+    /**
+     *
+     *  Whether the healthcare element is relevant or not.
+     */
     relevant: boolean;
+    /**
+     *
+     *  Id of the opening contact when the healthcare element was created.
+     */
     idOpeningContact: string | undefined;
+    /**
+     *
+     *  Id of the closing contact for the healthcare element.
+     */
     idClosingContact: string | undefined;
+    /**
+     *
+     *  Id of the service when a service is used to create a healthcare element.
+     */
     idService: string | undefined;
+    /**
+     *
+     *  Left or right dominance/preference.
+     */
     laterality: Laterality | undefined;
+    /**
+     *
+     *  List of healthcare approaches.
+     */
     plansOfAction: Array<EncryptedPlanOfAction>;
+    /**
+     *
+     *  List of episodes of occurrences of the healthcare element.
+     */
     episodes: Array<EncryptedEpisode>;
+    /**
+     *
+     *  List of care team members assigned for the healthcare element.
+     */
     careTeam: Array<EncryptedCareTeamMember>;
+    /**
+     *
+     *  The secret patient key, encrypted in the patient's own AES key.
+     */
     secretForeignKeys: Array<string>;
+    /**
+     *
+     *  The patient id encrypted in the delegates' AES keys.
+     */
     cryptedForeignKeys: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The delegations giving access to connected healthcare information.
+     */
     delegations: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The keys used to encrypt this entity when the entity is stored encrypted.
+     */
     encryptionKeys: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The base64-encoded encrypted fields of this entity.
+     */
     encryptedSelf: Base64String | undefined;
+    /**
+     *
+     *  The security metadata of the entity.
+     */
     securityMetadata: SecurityMetadata | undefined;
     readonly isEncrypted: true;
     constructor(partial: Partial<EncryptedHealthElement>);