@icure/cardinal-sdk 2.1.1 → 2.1.2

package/model/embed/Content.mjs

@@ -5,20 +5,79 @@ import { Measure } from './Measure.mjs';
 import { Medication } from './Medication.mjs';
 import { DecryptedService, EncryptedService } from './Service.mjs';
 import { TimeSeries } from './TimeSeries.mjs';
+/**
+ *
+ *  Represents the value content of a medical service. A content can hold different types of values
+ *  such as strings, numbers, dates, measurements, medications, time series, or compound
+ *  sub-services.
+ *  /
+ */
 export class DecryptedContent {
     constructor(partial) {
+        /**
+         *
+         *  A string value.
+         */
         this.stringValue = undefined;
+        /**
+         *
+         *  A numeric value.
+         */
         this.numberValue = undefined;
+        /**
+         *
+         *  A boolean value.
+         */
         this.booleanValue = undefined;
+        /**
+         *
+         *  An instant value.
+         */
         this.instantValue = undefined;
+        /**
+         *
+         *  Value as a fuzzy date, which may contain day, month, and/or year components.
+         */
         this.fuzzyDateValue = undefined;
+        /**
+         *
+         *  A binary value encoded as a byte array.
+         */
         this.binaryValue = undefined;
+        /**
+         *
+         *  The identifier of a linked document.
+         */
         this.documentId = undefined;
+        /**
+         *
+         *  Values of measurements recorded, including value, range, severity, and unit.
+         */
         this.measureValue = undefined;
+        /**
+         *
+         *  The details of prescribed or suggested medication.
+         */
         this.medicationValue = undefined;
+        /**
+         *
+         *  A high frequency time-series containing timestamps in ms and their values.
+         */
         this.timeSeries = undefined;
+        /**
+         *
+         *  A list of sub-services forming a compound value.
+         */
         this.compoundValue = undefined;
+        /**
+         *
+         *  A list of measures representing a ratio.
+         */
         this.ratio = undefined;
+        /**
+         *
+         *  A list of measures representing a range.
+         */
         this.range = undefined;
         this.isEncrypted = false;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== false)
@@ -110,20 +169,79 @@ export class DecryptedContent {
         return res;
     }
 }
+/**
+ *
+ *  Represents the value content of a medical service. A content can hold different types of values
+ *  such as strings, numbers, dates, measurements, medications, time series, or compound
+ *  sub-services.
+ *  /
+ */
 export class EncryptedContent {
     constructor(partial) {
+        /**
+         *
+         *  A string value.
+         */
         this.stringValue = undefined;
+        /**
+         *
+         *  A numeric value.
+         */
         this.numberValue = undefined;
+        /**
+         *
+         *  A boolean value.
+         */
         this.booleanValue = undefined;
+        /**
+         *
+         *  An instant value.
+         */
         this.instantValue = undefined;
+        /**
+         *
+         *  Value as a fuzzy date, which may contain day, month, and/or year components.
+         */
         this.fuzzyDateValue = undefined;
+        /**
+         *
+         *  A binary value encoded as a byte array.
+         */
         this.binaryValue = undefined;
+        /**
+         *
+         *  The identifier of a linked document.
+         */
         this.documentId = undefined;
+        /**
+         *
+         *  Values of measurements recorded, including value, range, severity, and unit.
+         */
         this.measureValue = undefined;
+        /**
+         *
+         *  The details of prescribed or suggested medication.
+         */
         this.medicationValue = undefined;
+        /**
+         *
+         *  A high frequency time-series containing timestamps in ms and their values.
+         */
         this.timeSeries = undefined;
+        /**
+         *
+         *  A list of sub-services forming a compound value.
+         */
         this.compoundValue = undefined;
+        /**
+         *
+         *  A list of measures representing a ratio.
+         */
         this.ratio = undefined;
+        /**
+         *
+         *  A list of measures representing a range.
+         */
         this.range = undefined;
         this.isEncrypted = true;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== true)

package/model/embed/ContractChangeType.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *
+ *   Enumerates the types of changes that can occur on a medical house contract.
+ */
 export declare enum ContractChangeType {
     InscriptionStart = "InscriptionStart",
     InscriptionEnd = "InscriptionEnd",

package/model/embed/ContractChangeType.mjs

@@ -1,4 +1,9 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Enumerates the types of changes that can occur on a medical house contract.
+ */
 export var ContractChangeType;
 (function (ContractChangeType) {
     ContractChangeType["InscriptionStart"] = "InscriptionStart";

package/model/embed/DataAttachment.d.mts

@@ -1,6 +1,24 @@
+/**
+ *
+ *  Represents a data attachment that can be stored either as a CouchDB attachment or via object
+ *  storage.
+ *  /
+ */
 export declare class DataAttachment {
+    /**
+     *
+     *  The identifier of the attachment if stored as a CouchDB attachment.
+     */
     couchDbAttachmentId: string | undefined;
+    /**
+     *
+     *  The identifier of the attachment if stored using the object storage service.
+     */
     objectStoreAttachmentId: string | undefined;
+    /**
+     *
+     *  The Uniform Type Identifiers of the attachment, ordered by priority.
+     */
     utis: Array<string>;
     constructor(partial: Partial<DataAttachment>);
     toJSON(): object;

package/model/embed/DataAttachment.mjs

@@ -1,9 +1,27 @@
 // auto-generated file
 import { expectArray, expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  Represents a data attachment that can be stored either as a CouchDB attachment or via object
+ *  storage.
+ *  /
+ */
 export class DataAttachment {
     constructor(partial) {
+        /**
+         *
+         *  The identifier of the attachment if stored as a CouchDB attachment.
+         */
         this.couchDbAttachmentId = undefined;
+        /**
+         *
+         *  The identifier of the attachment if stored using the object storage service.
+         */
         this.objectStoreAttachmentId = undefined;
+        /**
+         *
+         *  The Uniform Type Identifiers of the attachment, ordered by priority.
+         */
         this.utis = [];
         if ('couchDbAttachmentId' in partial)
             this.couchDbAttachmentId = partial.couchDbAttachmentId;

package/model/embed/DatabaseSynchronization.d.mts

@@ -1,7 +1,29 @@
+/**
+ *
+ *  Represents a database synchronization configuration between a source and a target, with optional
+ *  filtering.
+ *  /
+ */
 export declare class DatabaseSynchronization {
+    /**
+     *
+     *  The source database URL or identifier.
+     */
     source: string | undefined;
+    /**
+     *
+     *  The target database URL or identifier.
+     */
     target: string | undefined;
+    /**
+     *
+     *  A filter expression to apply during synchronization.
+     */
     filter: string | undefined;
+    /**
+     *
+     *  The local target type for the synchronization (base, healthdata, or patient).
+     */
     localTarget: DatabaseSynchronization.Target | undefined;
     constructor(partial: Partial<DatabaseSynchronization>);
     toJSON(): object;

package/model/embed/DatabaseSynchronization.mjs

@@ -1,10 +1,32 @@
 // auto-generated file
 import { expectString, expectStringEnum, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  Represents a database synchronization configuration between a source and a target, with optional
+ *  filtering.
+ *  /
+ */
 export class DatabaseSynchronization {
     constructor(partial) {
+        /**
+         *
+         *  The source database URL or identifier.
+         */
         this.source = undefined;
+        /**
+         *
+         *  The target database URL or identifier.
+         */
         this.target = undefined;
+        /**
+         *
+         *  A filter expression to apply during synchronization.
+         */
         this.filter = undefined;
+        /**
+         *
+         *  The local target type for the synchronization (base, healthdata, or patient).
+         */
         this.localTarget = undefined;
         if ('source' in partial)
             this.source = partial.source;

package/model/embed/DelegationTag.d.mts

@@ -1,3 +1,9 @@
+/**
+ *
+ *
+ *   Enumerates the categories of medical data that can be used to tag delegations,
+ *   controlling access to specific types of information.
+ */
 export declare enum DelegationTag {
     All = "All",
     AdministrativeData = "AdministrativeData",

package/model/embed/DelegationTag.mjs

@@ -1,4 +1,10 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Enumerates the categories of medical data that can be used to tag delegations,
+ *   controlling access to specific types of information.
+ */
 export var DelegationTag;
 (function (DelegationTag) {
     DelegationTag["All"] = "All";

package/model/embed/DeletedAttachment.d.mts

@@ -1,7 +1,30 @@
+/**
+ *
+ *  Represents metadata about an attachment that has been deleted, preserving its former storage
+ *  identifiers and deletion time.
+ *  /
+ */
 export declare class DeletedAttachment {
+    /**
+     *
+     *  The former CouchDB attachment identifier, if the attachment was stored as a CouchDB attachment.
+     */
     couchDbAttachmentId: string | undefined;
+    /**
+     *
+     *  The former object storage identifier, if the attachment was stored using the object storage
+     *  service.
+     */
     objectStoreAttachmentId: string | undefined;
+    /**
+     *
+     *  The key the attachment was associated to, or null for main attachments.
+     */
     key: string | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) when the attachment was deleted.
+     */
     deletionTime: number | undefined;
     constructor(partial: Partial<DeletedAttachment>);
     toJSON(): object;

package/model/embed/DeletedAttachment.mjs

@@ -1,10 +1,33 @@
 // auto-generated file
 import { expectNumber, expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  Represents metadata about an attachment that has been deleted, preserving its former storage
+ *  identifiers and deletion time.
+ *  /
+ */
 export class DeletedAttachment {
     constructor(partial) {
+        /**
+         *
+         *  The former CouchDB attachment identifier, if the attachment was stored as a CouchDB attachment.
+         */
         this.couchDbAttachmentId = undefined;
+        /**
+         *
+         *  The former object storage identifier, if the attachment was stored using the object storage
+         *  service.
+         */
         this.objectStoreAttachmentId = undefined;
+        /**
+         *
+         *  The key the attachment was associated to, or null for main attachments.
+         */
         this.key = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) when the attachment was deleted.
+         */
         this.deletionTime = undefined;
         if ('couchDbAttachmentId' in partial)
             this.couchDbAttachmentId = partial.couchDbAttachmentId;

package/model/embed/DocumentGroup.d.mts

@@ -1,5 +1,18 @@
+/**
+ *
+ *  Represents a grouping of documents, identified by a GUID and a human-readable name.
+ *  /
+ */
 export declare class DocumentGroup {
+    /**
+     *
+     *  The globally unique identifier for this document group.
+     */
     guid: string | undefined;
+    /**
+     *
+     *  The human-readable name of the document group.
+     */
     name: string | undefined;
     constructor(partial: Partial<DocumentGroup>);
     toJSON(): object;

package/model/embed/DocumentGroup.mjs

@@ -1,8 +1,21 @@
 // auto-generated file
 import { expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  Represents a grouping of documents, identified by a GUID and a human-readable name.
+ *  /
+ */
 export class DocumentGroup {
     constructor(partial) {
+        /**
+         *
+         *  The globally unique identifier for this document group.
+         */
         this.guid = undefined;
+        /**
+         *
+         *  The human-readable name of the document group.
+         */
         this.name = undefined;
         if ('guid' in partial)
             this.guid = partial.guid;

package/model/embed/DocumentStatus.d.mts

@@ -1,3 +1,9 @@
+/**
+ *
+ *
+ *   Enumerates the lifecycle statuses of a document, from draft through finalization, review,
+ *  signature, and delivery.
+ */
 export declare enum DocumentStatus {
     Draft = "Draft",
     Finalized = "Finalized",

package/model/embed/DocumentStatus.mjs

@@ -1,4 +1,10 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Enumerates the lifecycle statuses of a document, from draft through finalization, review,
+ *  signature, and delivery.
+ */
 export var DocumentStatus;
 (function (DocumentStatus) {
     DocumentStatus["Draft"] = "Draft";

package/model/embed/DocumentType.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *
+ *   Enumerates the types of medical and administrative documents that can be managed in the system.
+ */
 export declare enum DocumentType {
     Admission = "Admission",
     Alert = "Alert",

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;
 }