@icure/cardinal-sdk 2.1.1 → 2.1.2

package/model/embed/CareTeamMember.d.mts

@@ -3,29 +3,99 @@ import { Identifiable } from '../base/Identifiable.mjs';
 import { Base64String } from '../specializations/Base64String.mjs';
 import { CareTeamMemberType } from './CareTeamMemberType.mjs';
 import { Encryptable } from './Encryptable.mjs';
+/**
+ *
+ *  Represents a member of a care team involved in a patient's care, linking a healthcare party with
+ *  their role.
+ *  /
+ */
 export interface CareTeamMember extends Encryptable, Identifiable<string> {
+    /**
+     *
+     *  The type of care team member (physician, specialist, or other).
+     */
     careTeamMemberType: CareTeamMemberType | undefined;
+    /**
+     *
+     *  The identifier of the associated healthcare party.
+     */
     healthcarePartyId: string | undefined;
+    /**
+     *
+     *  A code describing the quality or qualification of this care team member.
+     */
     quality: CodeStub | undefined;
     readonly isEncrypted: boolean;
     toJSON(): object;
 }
+/**
+ *
+ *  Represents a member of a care team involved in a patient's care, linking a healthcare party with
+ *  their role.
+ *  /
+ */
 export declare class DecryptedCareTeamMember {
+    /**
+     *
+     *  The unique identifier of this care team member.
+     */
     id: string;
+    /**
+     *
+     *  The type of care team member (physician, specialist, or other).
+     */
     careTeamMemberType: CareTeamMemberType | undefined;
+    /**
+     *
+     *  The identifier of the associated healthcare party.
+     */
     healthcarePartyId: string | undefined;
+    /**
+     *
+     *  A code describing the quality or qualification of this care team member.
+     */
     quality: CodeStub | undefined;
+    /**
+     *
+     *  The base64-encoded encrypted content of this care team member.
+     */
     encryptedSelf: Base64String | undefined;
     readonly isEncrypted: false;
     constructor(partial: Partial<DecryptedCareTeamMember>);
     toJSON(): object;
     static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): DecryptedCareTeamMember;
 }
+/**
+ *
+ *  Represents a member of a care team involved in a patient's care, linking a healthcare party with
+ *  their role.
+ *  /
+ */
 export declare class EncryptedCareTeamMember {
+    /**
+     *
+     *  The unique identifier of this care team member.
+     */
     id: string;
+    /**
+     *
+     *  The type of care team member (physician, specialist, or other).
+     */
     careTeamMemberType: CareTeamMemberType | undefined;
+    /**
+     *
+     *  The identifier of the associated healthcare party.
+     */
     healthcarePartyId: string | undefined;
+    /**
+     *
+     *  A code describing the quality or qualification of this care team member.
+     */
     quality: CodeStub | undefined;
+    /**
+     *
+     *  The base64-encoded encrypted content of this care team member.
+     */
     encryptedSelf: Base64String | undefined;
     readonly isEncrypted: true;
     constructor(partial: Partial<EncryptedCareTeamMember>);

package/model/embed/CareTeamMember.mjs

@@ -3,12 +3,34 @@ import { expectObject, expectString, expectStringEnum, extractEntry } from '../.
 import { randomUuid } from '../../utils/Id.mjs';
 import { CodeStub } from '../base/CodeStub.mjs';
 import { CareTeamMemberType } from './CareTeamMemberType.mjs';
+/**
+ *
+ *  Represents a member of a care team involved in a patient's care, linking a healthcare party with
+ *  their role.
+ *  /
+ */
 export class DecryptedCareTeamMember {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The type of care team member (physician, specialist, or other).
+         */
         this.careTeamMemberType = undefined;
+        /**
+         *
+         *  The identifier of the associated healthcare party.
+         */
         this.healthcarePartyId = undefined;
+        /**
+         *
+         *  A code describing the quality or qualification of this care team member.
+         */
         this.quality = undefined;
+        /**
+         *
+         *  The base64-encoded encrypted content of this care team member.
+         */
         this.encryptedSelf = undefined;
         this.isEncrypted = false;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== false)
@@ -58,12 +80,34 @@ export class DecryptedCareTeamMember {
         return res;
     }
 }
+/**
+ *
+ *  Represents a member of a care team involved in a patient's care, linking a healthcare party with
+ *  their role.
+ *  /
+ */
 export class EncryptedCareTeamMember {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The type of care team member (physician, specialist, or other).
+         */
         this.careTeamMemberType = undefined;
+        /**
+         *
+         *  The identifier of the associated healthcare party.
+         */
         this.healthcarePartyId = undefined;
+        /**
+         *
+         *  A code describing the quality or qualification of this care team member.
+         */
         this.quality = undefined;
+        /**
+         *
+         *  The base64-encoded encrypted content of this care team member.
+         */
         this.encryptedSelf = undefined;
         this.isEncrypted = true;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== true)

package/model/embed/CareTeamMemberType.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *
+ *   Enumerates the possible types of a care team member.
+ */
 export declare enum CareTeamMemberType {
     Physician = "Physician",
     Specialist = "Specialist",

package/model/embed/CareTeamMemberType.mjs

@@ -1,4 +1,9 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Enumerates the possible types of a care team member.
+ */
 export var CareTeamMemberType;
 (function (CareTeamMemberType) {
     CareTeamMemberType["Physician"] = "Physician";

package/model/embed/CareTeamMembership.d.mts

@@ -1,30 +1,104 @@
 import { Base64String } from '../specializations/Base64String.mjs';
 import { Encryptable } from './Encryptable.mjs';
 import { MembershipType } from './MembershipType.mjs';
+/**
+ *
+ *  Represents a time-bounded membership of a care team member, specifying the period and type of
+ *  involvement.
+ *  /
+ */
 export interface CareTeamMembership extends Encryptable {
+    /**
+     *
+     *  The start date (unix epoch in ms) of this membership.
+     */
     startDate: number | undefined;
+    /**
+     *
+     *  The end date (unix epoch in ms) of this membership.
+     */
     endDate: number | undefined;
+    /**
+     *
+     *  The identifier of the care team member.
+     */
     careTeamMemberId: string | undefined;
+    /**
+     *
+     *  The type of membership.
+     */
     membershipType: MembershipType | undefined;
     readonly isEncrypted: boolean;
     toJSON(): object;
 }
+/**
+ *
+ *  Represents a time-bounded membership of a care team member, specifying the period and type of
+ *  involvement.
+ *  /
+ */
 export declare class DecryptedCareTeamMembership {
+    /**
+     *
+     *  The start date (unix epoch in ms) of this membership.
+     */
     startDate: number | undefined;
+    /**
+     *
+     *  The end date (unix epoch in ms) of this membership.
+     */
     endDate: number | undefined;
+    /**
+     *
+     *  The identifier of the care team member.
+     */
     careTeamMemberId: string | undefined;
+    /**
+     *
+     *  The type of membership.
+     */
     membershipType: MembershipType | undefined;
+    /**
+     *
+     *  The base64-encoded encrypted content of this membership.
+     */
     encryptedSelf: Base64String | undefined;
     readonly isEncrypted: false;
     constructor(partial: Partial<DecryptedCareTeamMembership>);
     toJSON(): object;
     static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): DecryptedCareTeamMembership;
 }
+/**
+ *
+ *  Represents a time-bounded membership of a care team member, specifying the period and type of
+ *  involvement.
+ *  /
+ */
 export declare class EncryptedCareTeamMembership {
+    /**
+     *
+     *  The start date (unix epoch in ms) of this membership.
+     */
     startDate: number | undefined;
+    /**
+     *
+     *  The end date (unix epoch in ms) of this membership.
+     */
     endDate: number | undefined;
+    /**
+     *
+     *  The identifier of the care team member.
+     */
     careTeamMemberId: string | undefined;
+    /**
+     *
+     *  The type of membership.
+     */
     membershipType: MembershipType | undefined;
+    /**
+     *
+     *  The base64-encoded encrypted content of this membership.
+     */
     encryptedSelf: Base64String | undefined;
     readonly isEncrypted: true;
     constructor(partial: Partial<EncryptedCareTeamMembership>);

package/model/embed/CareTeamMembership.mjs

@@ -1,12 +1,38 @@
 // auto-generated file
 import { expectNumber, expectString, expectStringEnum, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 import { MembershipType } from './MembershipType.mjs';
+/**
+ *
+ *  Represents a time-bounded membership of a care team member, specifying the period and type of
+ *  involvement.
+ *  /
+ */
 export class DecryptedCareTeamMembership {
     constructor(partial) {
+        /**
+         *
+         *  The start date (unix epoch in ms) of this membership.
+         */
         this.startDate = undefined;
+        /**
+         *
+         *  The end date (unix epoch in ms) of this membership.
+         */
         this.endDate = undefined;
+        /**
+         *
+         *  The identifier of the care team member.
+         */
         this.careTeamMemberId = undefined;
+        /**
+         *
+         *  The type of membership.
+         */
         this.membershipType = undefined;
+        /**
+         *
+         *  The base64-encoded encrypted content of this membership.
+         */
         this.encryptedSelf = undefined;
         this.isEncrypted = false;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== false)
@@ -58,12 +84,38 @@ export class DecryptedCareTeamMembership {
         return res;
     }
 }
+/**
+ *
+ *  Represents a time-bounded membership of a care team member, specifying the period and type of
+ *  involvement.
+ *  /
+ */
 export class EncryptedCareTeamMembership {
     constructor(partial) {
+        /**
+         *
+         *  The start date (unix epoch in ms) of this membership.
+         */
         this.startDate = undefined;
+        /**
+         *
+         *  The end date (unix epoch in ms) of this membership.
+         */
         this.endDate = undefined;
+        /**
+         *
+         *  The identifier of the care team member.
+         */
         this.careTeamMemberId = undefined;
+        /**
+         *
+         *  The type of membership.
+         */
         this.membershipType = undefined;
+        /**
+         *
+         *  The base64-encoded encrypted content of this membership.
+         */
         this.encryptedSelf = undefined;
         this.isEncrypted = true;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== true)

package/model/embed/ContactParticipant.d.mts

@@ -1,6 +1,19 @@
 import { ParticipantType } from '../base/ParticipantType.mjs';
+/**
+ *
+ *  Represents a healthcare party participating in a contact, along with their participation type.
+ *  /
+ */
 export declare class ContactParticipant {
+    /**
+     *
+     *  The type of participation in the contact.
+     */
     type: ParticipantType;
+    /**
+     *
+     *  The identifier of the participating healthcare party.
+     */
     hcpId: string;
     constructor(partial: Partial<ContactParticipant> & Pick<ContactParticipant, "type" | "hcpId">);
     toJSON(): object;

package/model/embed/ContactParticipant.mjs

@@ -1,6 +1,11 @@
 // auto-generated file
 import { expectString, expectStringEnum, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 import { ParticipantType } from '../base/ParticipantType.mjs';
+/**
+ *
+ *  Represents a healthcare party participating in a contact, along with their participation type.
+ *  /
+ */
 export class ContactParticipant {
     constructor(partial) {
         this.type = partial.type;

package/model/embed/Content.d.mts

@@ -2,55 +2,232 @@ import { Measure } from './Measure.mjs';
 import { Medication } from './Medication.mjs';
 import { DecryptedService, EncryptedService, Service } 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 interface Content {
+    /**
+     *
+     *  A string value.
+     */
     stringValue: string | undefined;
+    /**
+     *
+     *  A numeric value.
+     */
     numberValue: number | undefined;
+    /**
+     *
+     *  A boolean value.
+     */
     booleanValue: boolean | undefined;
+    /**
+     *
+     *  An instant value.
+     */
     instantValue: number | undefined;
+    /**
+     *
+     *  Value as a fuzzy date, which may contain day, month, and/or year components.
+     */
     fuzzyDateValue: number | undefined;
+    /**
+     *
+     *  A binary value encoded as a byte array.
+     */
     binaryValue: Int8Array | undefined;
+    /**
+     *
+     *  The identifier of a linked document.
+     */
     documentId: string | undefined;
+    /**
+     *
+     *  Values of measurements recorded, including value, range, severity, and unit.
+     */
     measureValue: Measure | undefined;
+    /**
+     *
+     *  The details of prescribed or suggested medication.
+     */
     medicationValue: Medication | undefined;
+    /**
+     *
+     *  A high frequency time-series containing timestamps in ms and their values.
+     */
     timeSeries: TimeSeries | undefined;
+    /**
+     *
+     *  A list of sub-services forming a compound value.
+     */
     compoundValue: Array<Service> | undefined;
+    /**
+     *
+     *  A list of measures representing a ratio.
+     */
     ratio: Array<Measure> | undefined;
+    /**
+     *
+     *  A list of measures representing a range.
+     */
     range: Array<Measure> | undefined;
     readonly isEncrypted: boolean;
     toJSON(): object;
 }
+/**
+ *
+ *  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 declare class DecryptedContent {
+    /**
+     *
+     *  A string value.
+     */
     stringValue: string | undefined;
+    /**
+     *
+     *  A numeric value.
+     */
     numberValue: number | undefined;
+    /**
+     *
+     *  A boolean value.
+     */
     booleanValue: boolean | undefined;
+    /**
+     *
+     *  An instant value.
+     */
     instantValue: number | undefined;
+    /**
+     *
+     *  Value as a fuzzy date, which may contain day, month, and/or year components.
+     */
     fuzzyDateValue: number | undefined;
+    /**
+     *
+     *  A binary value encoded as a byte array.
+     */
     binaryValue: Int8Array | undefined;
+    /**
+     *
+     *  The identifier of a linked document.
+     */
     documentId: string | undefined;
+    /**
+     *
+     *  Values of measurements recorded, including value, range, severity, and unit.
+     */
     measureValue: Measure | undefined;
+    /**
+     *
+     *  The details of prescribed or suggested medication.
+     */
     medicationValue: Medication | undefined;
+    /**
+     *
+     *  A high frequency time-series containing timestamps in ms and their values.
+     */
     timeSeries: TimeSeries | undefined;
+    /**
+     *
+     *  A list of sub-services forming a compound value.
+     */
     compoundValue: Array<DecryptedService> | undefined;
+    /**
+     *
+     *  A list of measures representing a ratio.
+     */
     ratio: Array<Measure> | undefined;
+    /**
+     *
+     *  A list of measures representing a range.
+     */
     range: Array<Measure> | undefined;
     readonly isEncrypted: false;
     constructor(partial: Partial<DecryptedContent>);
     toJSON(): object;
     static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): DecryptedContent;
 }
+/**
+ *
+ *  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 declare class EncryptedContent {
+    /**
+     *
+     *  A string value.
+     */
     stringValue: string | undefined;
+    /**
+     *
+     *  A numeric value.
+     */
     numberValue: number | undefined;
+    /**
+     *
+     *  A boolean value.
+     */
     booleanValue: boolean | undefined;
+    /**
+     *
+     *  An instant value.
+     */
     instantValue: number | undefined;
+    /**
+     *
+     *  Value as a fuzzy date, which may contain day, month, and/or year components.
+     */
     fuzzyDateValue: number | undefined;
+    /**
+     *
+     *  A binary value encoded as a byte array.
+     */
     binaryValue: Int8Array | undefined;
+    /**
+     *
+     *  The identifier of a linked document.
+     */
     documentId: string | undefined;
+    /**
+     *
+     *  Values of measurements recorded, including value, range, severity, and unit.
+     */
     measureValue: Measure | undefined;
+    /**
+     *
+     *  The details of prescribed or suggested medication.
+     */
     medicationValue: Medication | undefined;
+    /**
+     *
+     *  A high frequency time-series containing timestamps in ms and their values.
+     */
     timeSeries: TimeSeries | undefined;
+    /**
+     *
+     *  A list of sub-services forming a compound value.
+     */
     compoundValue: Array<EncryptedService> | undefined;
+    /**
+     *
+     *  A list of measures representing a ratio.
+     */
     ratio: Array<Measure> | undefined;
+    /**
+     *
+     *  A list of measures representing a range.
+     */
     range: Array<Measure> | undefined;
     readonly isEncrypted: true;
     constructor(partial: Partial<EncryptedContent>);