@icure/cardinal-sdk 2.1.1 → 2.1.2

package/model/User.mjs

@@ -8,29 +8,121 @@ import { UsersStatus } from './enums/UsersStatus.mjs';
 import { AuthenticationToken } from './security/AuthenticationToken.mjs';
 import { LoginIdentifier } from './security/LoginIdentifier.mjs';
 import { Permission } from './security/Permission.mjs';
+/**
+ *
+ *  Represents a user that can log in to the iCure platform. A user can be linked to a healthcare
+ *  party,
+ *  a patient, or a device, and holds authentication credentials, roles, and permissions.
+ *  /
+ */
 export class User {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the user 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 timestamp (unix epoch in ms) of creation.
+         */
         this.created = undefined;
+        /**
+         *
+         *  The identifiers of the user.
+         */
         this.identifier = [];
+        /**
+         *
+         *  Last name of the user.
+         */
         this.name = undefined;
+        /**
+         *
+         *  Extra properties for the user. Those properties are typed (see class Property).
+         */
         this.properties = [];
+        /**
+         *
+         *  Local permissions specified for the user.
+         */
         this.permissions = [];
+        /**
+         *
+         *  Local roles specified for the user.
+         */
         this.roles = [];
+        /**
+         *
+         *  State of user's activeness: 'Active', 'Disabled' or 'Registering'.
+         */
         this.status = undefined;
+        /**
+         *
+         *  Username for this user. We encourage using an email address.
+         */
         this.login = undefined;
+        /**
+         *
+         *  Hashed version of the password (BCrypt is used for hashing).
+         */
         this.passwordHash = undefined;
+        /**
+         *
+         *  The id of the group (practice/hospital) the user is member of.
+         */
         this.groupId = undefined;
+        /**
+         *
+         *  Id of the healthcare party if the user is a healthcare party.
+         */
         this.healthcarePartyId = undefined;
+        /**
+         *
+         *  Id of the patient if the user is a patient.
+         */
         this.patientId = undefined;
+        /**
+         *
+         *  Id of the device if the user is a device.
+         */
         this.deviceId = undefined;
+        /**
+         *
+         *  Delegations that are automatically generated client side when a new database object is created
+         *  by this user.
+         */
         this.autoDelegations = {};
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of the latest validation of the terms of use.
+         */
         this.termsOfUseDate = undefined;
+        /**
+         *
+         *  Email address of the user (used for token exchange or password recovery).
+         */
         this.email = undefined;
+        /**
+         *
+         *  Mobile phone of the user (used for token exchange or password recovery).
+         */
         this.mobilePhone = undefined;
+        /**
+         *
+         *  Encrypted and time-limited authentication tokens used for inter-applications authentication.
+         */
         this.authenticationTokens = {};
+        /**
+         *
+         *  Metadata used to enrich the user with information from the cloud environment.
+         */
         this.systemMetadata = undefined;
         this.id = (_a = partial.id) !== null && _a !== void 0 ? _a : randomUuid();
         if ('rev' in partial)

package/model/UserGroup.d.mts

@@ -1,16 +1,70 @@
 import { Group } from './Group.mjs';
+/**
+ *
+ *
+ *   DTO representing a user within the context of a specific group, including the group hierarchy
+ *   and the user's associated data owner identifiers.
+ */
 export declare class UserGroup {
+    /**
+     *
+     *  The identifier of the group this user belongs to.
+     */
     groupId: string | undefined;
+    /**
+     *
+     *  The name of the group this user belongs to.
+     */
     groupName: string | undefined;
+    /**
+     *
+     *  The list of groups forming the hierarchy from the topmost group down to this group.
+     */
     groupsHierarchy: Array<Group>;
+    /**
+     *
+     *  The identifier of the user.
+     */
     userId: string | undefined;
+    /**
+     *
+     *  The login identifier of the user.
+     */
     login: string | undefined;
+    /**
+     *
+     *  The display name of the user.
+     */
     name: string | undefined;
+    /**
+     *
+     *  The email address of the user.
+     */
     email: string | undefined;
+    /**
+     *
+     *  The phone number of the user.
+     */
     phone: string | undefined;
+    /**
+     *
+     *  The identifier of the patient linked to this user, if any.
+     */
     patientId: string | undefined;
+    /**
+     *
+     *  The identifier of the healthcare party linked to this user, if any.
+     */
     healthcarePartyId: string | undefined;
+    /**
+     *
+     *  The identifier of the device linked to this user, if any.
+     */
     deviceId: string | undefined;
+    /**
+     *
+     *  The name of the parent group of the topmost group in the hierarchy.
+     */
     nameOfParentOfTopmostGroupInHierarchy: string | undefined;
     constructor(partial: Partial<UserGroup>);
     toJSON(): object;

package/model/UserGroup.mjs

@@ -1,19 +1,73 @@
 // auto-generated file
 import { expectArray, expectObject, expectString, extractEntry } from '../internal/JsonDecodeUtils.mjs';
 import { Group } from './Group.mjs';
+/**
+ *
+ *
+ *   DTO representing a user within the context of a specific group, including the group hierarchy
+ *   and the user's associated data owner identifiers.
+ */
 export class UserGroup {
     constructor(partial) {
+        /**
+         *
+         *  The identifier of the group this user belongs to.
+         */
         this.groupId = undefined;
+        /**
+         *
+         *  The name of the group this user belongs to.
+         */
         this.groupName = undefined;
+        /**
+         *
+         *  The list of groups forming the hierarchy from the topmost group down to this group.
+         */
         this.groupsHierarchy = [];
+        /**
+         *
+         *  The identifier of the user.
+         */
         this.userId = undefined;
+        /**
+         *
+         *  The login identifier of the user.
+         */
         this.login = undefined;
+        /**
+         *
+         *  The display name of the user.
+         */
         this.name = undefined;
+        /**
+         *
+         *  The email address of the user.
+         */
         this.email = undefined;
+        /**
+         *
+         *  The phone number of the user.
+         */
         this.phone = undefined;
+        /**
+         *
+         *  The identifier of the patient linked to this user, if any.
+         */
         this.patientId = undefined;
+        /**
+         *
+         *  The identifier of the healthcare party linked to this user, if any.
+         */
         this.healthcarePartyId = undefined;
+        /**
+         *
+         *  The identifier of the device linked to this user, if any.
+         */
         this.deviceId = undefined;
+        /**
+         *
+         *  The name of the parent group of the topmost group in the hierarchy.
+         */
         this.nameOfParentOfTopmostGroupInHierarchy = undefined;
         if ('groupId' in partial)
             this.groupId = partial.groupId;

package/model/base/CodeIdentification.d.mts

@@ -1,3 +1,9 @@
+/**
+ *
+ *
+ *   Interface for entities that can be identified by a code from a codification system.
+ *   The id is typically composed as type|code|version.
+ */
 export interface CodeIdentification<K> {
     id: K;
     code: string | undefined;

package/model/base/CodeStub.d.mts

@@ -1,10 +1,41 @@
 import { CodeIdentification } from './CodeIdentification.mjs';
+/**
+ *
+ *  A lightweight reference to a code from a codification system, used as a stub in entities that
+ *  reference codes
+ *  without embedding the full code definition. The id is typically formatted as type|code|version.
+ *  /
+ */
 export declare class CodeStub implements CodeIdentification<string | undefined> {
+    /**
+     *
+     *  The unique identifier, formatted as type|code|version.
+     */
     id: string | undefined;
+    /**
+     *
+     *  The context where this code is used when embedded in another entity.
+     */
     context: string | undefined;
+    /**
+     *
+     *  The codification system type (e.g. ICD, ICPC-2).
+     */
     type: string | undefined;
+    /**
+     *
+     *  The code value within the codification system.
+     */
     code: string | undefined;
+    /**
+     *
+     *  The version of the codification system.
+     */
     version: string | undefined;
+    /**
+     *
+     *  A human-readable label for the context.
+     */
     contextLabel: string | undefined;
     constructor(partial: Partial<CodeStub>);
     toJSON(): object;

package/model/base/CodeStub.mjs

@@ -1,12 +1,43 @@
 // auto-generated file
 import { expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  A lightweight reference to a code from a codification system, used as a stub in entities that
+ *  reference codes
+ *  without embedding the full code definition. The id is typically formatted as type|code|version.
+ *  /
+ */
 export class CodeStub {
     constructor(partial) {
+        /**
+         *
+         *  The unique identifier, formatted as type|code|version.
+         */
         this.id = undefined;
+        /**
+         *
+         *  The context where this code is used when embedded in another entity.
+         */
         this.context = undefined;
+        /**
+         *
+         *  The codification system type (e.g. ICD, ICPC-2).
+         */
         this.type = undefined;
+        /**
+         *
+         *  The code value within the codification system.
+         */
         this.code = undefined;
+        /**
+         *
+         *  The version of the codification system.
+         */
         this.version = undefined;
+        /**
+         *
+         *  A human-readable label for the context.
+         */
         this.contextLabel = undefined;
         if ('id' in partial)
             this.id = partial.id;

package/model/base/CryptoActor.d.mts

@@ -2,6 +2,13 @@ import { DecryptedPropertyStub } from '../PropertyStub.mjs';
 import { HexString } from '../specializations/HexString.mjs';
 import { SpkiHexString } from '../specializations/SpkiHexString.mjs';
 import { Versionable } from './Versionable.mjs';
+/**
+ *
+ *
+ *   Interface for entities that participate in the iCure end-to-end encryption system.
+ *   A CryptoActor holds the cryptographic keys and key exchange material needed for secure data
+ *  sharing.
+ */
 export interface CryptoActor extends Versionable<string> {
     hcPartyKeys: {
         [key: string]: Array<HexString>;

package/model/base/DataOwner.d.mts

@@ -1,4 +1,11 @@
 import { PropertyStub } from '../PropertyStub.mjs';
+/**
+ *
+ *
+ *   Interface for entities that own and control access to encrypted data in the iCure system.
+ *   Data owners (such as healthcare parties, patients, and devices) can grant access to their data
+ *  through delegations.
+ */
 export interface DataOwner {
     properties: Array<PropertyStub>;
 }

package/model/base/HasCodes.d.mts

@@ -1,4 +1,10 @@
 import { CodeStub } from './CodeStub.mjs';
+/**
+ *
+ *
+ *   Interface for entities that can be qualified with codes from codification systems such as
+ *  SNOMED-CT, ICPC-2, or ICD-10.
+ */
 export interface HasCodes {
     codes: Array<CodeStub>;
 }

package/model/base/HasEncryptionMetadata.d.mts

@@ -1,6 +1,13 @@
 import { Delegation } from '../embed/Delegation.mjs';
 import { SecurityMetadata } from '../embed/SecurityMetadata.mjs';
 import { Versionable } from './Versionable.mjs';
+/**
+ *
+ *
+ *   Interface for entities that hold encryption metadata used for end-to-end encryption and access
+ *  control.
+ *   This includes delegation keys, encrypted foreign keys, and security metadata.
+ */
 export interface HasEncryptionMetadata extends Versionable<string> {
     secretForeignKeys: Array<string>;
     cryptedForeignKeys: {

package/model/base/HasEndOfLife.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *
+ *   Interface for entities that support soft deletion through an end-of-life timestamp.
+ */
 export interface HasEndOfLife {
     endOfLife: number | undefined;
 }

package/model/base/HasTags.d.mts

@@ -1,4 +1,11 @@
 import { CodeStub } from './CodeStub.mjs';
+/**
+ *
+ *
+ *   Interface for entities that can be classified using tags from codification systems such as
+ *  LOINC.
+ *   Tags qualify an entity as belonging to a certain class regardless of its value.
+ */
 export interface HasTags {
     tags: Array<CodeStub>;
 }

package/model/base/ICureDocument.d.mts

@@ -1,6 +1,13 @@
 import { HasCodes } from './HasCodes.mjs';
 import { HasTags } from './HasTags.mjs';
 import { Identifiable } from './Identifiable.mjs';
+/**
+ *
+ *
+ *   Interface for iCure document entities that track creation and modification metadata.
+ *   Extends [IdentifiableDto], [HasTagsDto], and [HasCodesDto] to provide a common base for all
+ *  medical documents.
+ */
 export interface ICureDocument<T> extends Identifiable<T>, HasTags, HasCodes {
     created: number | undefined;
     modified: number | undefined;

package/model/base/Identifiable.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *
+ *   Base interface for all entities that have a unique identifier.
+ */
 export interface Identifiable<T> {
     id: T;
 }

package/model/base/Identifier.d.mts

@@ -1,12 +1,55 @@
 import { CodeStub } from './CodeStub.mjs';
+/**
+ *
+ *
+ *   An identifier intended for computation
+ *
+ *   An identifier - identifies some entity uniquely and unambiguously. Typically this is used for
+ *   business identifiers.
+ */
 export declare class Identifier {
+    /**
+     *
+     *
+     *   Unique id for inter-element referencing
+     */
     id: string | undefined;
+    /**
+     *
+     *
+     *   Organization that issued id (may be just text)
+     */
     assigner: string | undefined;
+    /**
+     *
+     *
+     *   Time period when id is/was valid for use
+     */
     start: string | undefined;
     end: string | undefined;
+    /**
+     *
+     *
+     *   The namespace for the identifier value
+     */
     system: string | undefined;
+    /**
+     *
+     *
+     *   Description of identifier
+     */
     type: CodeStub | undefined;
+    /**
+     *
+     *
+     *   usual | official | temp | secondary | old (If known)
+     */
     use: string | undefined;
+    /**
+     *
+     *
+     *   The value that is unique
+     */
     value: string | undefined;
     constructor(partial: Partial<Identifier>);
     toJSON(): object;

package/model/base/Identifier.mjs

@@ -1,15 +1,58 @@
 // auto-generated file
 import { expectObject, expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 import { CodeStub } from './CodeStub.mjs';
+/**
+ *
+ *
+ *   An identifier intended for computation
+ *
+ *   An identifier - identifies some entity uniquely and unambiguously. Typically this is used for
+ *   business identifiers.
+ */
 export class Identifier {
     constructor(partial) {
+        /**
+         *
+         *
+         *   Unique id for inter-element referencing
+         */
         this.id = undefined;
+        /**
+         *
+         *
+         *   Organization that issued id (may be just text)
+         */
         this.assigner = undefined;
+        /**
+         *
+         *
+         *   Time period when id is/was valid for use
+         */
         this.start = undefined;
         this.end = undefined;
+        /**
+         *
+         *
+         *   The namespace for the identifier value
+         */
         this.system = undefined;
+        /**
+         *
+         *
+         *   Description of identifier
+         */
         this.type = undefined;
+        /**
+         *
+         *
+         *   usual | official | temp | secondary | old (If known)
+         */
         this.use = undefined;
+        /**
+         *
+         *
+         *   The value that is unique
+         */
         this.value = undefined;
         if ('id' in partial)
             this.id = partial.id;

package/model/base/LinkQualification.d.mts

@@ -1,3 +1,34 @@
+/**
+ *
+ *
+ *   The qualification of a link between two concepts
+ *
+ *   - [narrower] means that the linked codes have a narrower interpretation
+ *   - [parent] means that the linked code(s) is the parent of this code
+ *   - [sequence] means that the linked codes are a sequence of codes that are part of the current
+ *  code
+ *   - [basedOn] means a plan, proposal or order that is fulfilled in whole or in part by this event.
+ *  For example, a MedicationRequest may require a patient to have laboratory test performed before it
+ *  is dispensed.
+ *   - [derivedFrom] means the target resource that represents a measurement from which the service
+ *  value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound
+ *  image.
+ *   - [device] means the device used to generate the service data
+ *   - [focus] means the actual focus of a service when it is not the patient of record representing
+ *  something or someone associated with the patient such as a spouse, parent, fetus, or donor. For
+ *  example, fetus observations in a mother's record.
+ *   - [hasMember] means this service is a group service (e.g. a battery, a panel of tests, a set of
+ *  vital sign measurements) that includes the target as a member of the group
+ *   - [performer] means who was responsible for asserting the observed value as "true".
+ *   - [specimen] means the specimen that was used when this service was made
+ *   - [request] why the specimen was collected
+ *
+ *   When creating a link, we encourage creating single direction links. The reverse link can be
+ *  found through a view
+ *
+ *   Favour parent over child as it is better (for conflicts) to change 5 different documents once
+ *  instead of changing 5 times the same document
+ */
 export declare enum LinkQualification {
     Exact = "Exact",
     Narrower = "Narrower",

package/model/base/LinkQualification.mjs

@@ -1,4 +1,35 @@
 // auto-generated file
+/**
+ *
+ *
+ *   The qualification of a link between two concepts
+ *
+ *   - [narrower] means that the linked codes have a narrower interpretation
+ *   - [parent] means that the linked code(s) is the parent of this code
+ *   - [sequence] means that the linked codes are a sequence of codes that are part of the current
+ *  code
+ *   - [basedOn] means a plan, proposal or order that is fulfilled in whole or in part by this event.
+ *  For example, a MedicationRequest may require a patient to have laboratory test performed before it
+ *  is dispensed.
+ *   - [derivedFrom] means the target resource that represents a measurement from which the service
+ *  value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound
+ *  image.
+ *   - [device] means the device used to generate the service data
+ *   - [focus] means the actual focus of a service when it is not the patient of record representing
+ *  something or someone associated with the patient such as a spouse, parent, fetus, or donor. For
+ *  example, fetus observations in a mother's record.
+ *   - [hasMember] means this service is a group service (e.g. a battery, a panel of tests, a set of
+ *  vital sign measurements) that includes the target as a member of the group
+ *   - [performer] means who was responsible for asserting the observed value as "true".
+ *   - [specimen] means the specimen that was used when this service was made
+ *   - [request] why the specimen was collected
+ *
+ *   When creating a link, we encourage creating single direction links. The reverse link can be
+ *  found through a view
+ *
+ *   Favour parent over child as it is better (for conflicts) to change 5 different documents once
+ *  instead of changing 5 times the same document
+ */
 export var LinkQualification;
 (function (LinkQualification) {
     LinkQualification["Exact"] = "Exact";

package/model/base/Named.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *
+ *   Interface for entities that have a human-readable name.
+ */
 export interface Named {
     name: string | undefined;
 }

package/model/base/ParticipantType.d.mts

@@ -1,3 +1,10 @@
+/**
+ *
+ *
+ *   Enum class representing the participant types for an encounter/contact
+ *
+ *   Mostly based on HL7 FHIR R4
+ */
 export declare enum ParticipantType {
     Admitter = "Admitter",
     Attender = "Attender",

package/model/base/ParticipantType.mjs

@@ -1,4 +1,11 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Enum class representing the participant types for an encounter/contact
+ *
+ *   Mostly based on HL7 FHIR R4
+ */
 export var ParticipantType;
 (function (ParticipantType) {
     ParticipantType["Admitter"] = "Admitter";