@icure/cardinal-sdk 2.1.0 → 2.1.2

package/model/embed/PatientHealthCareParty.d.mts

@@ -4,6 +4,11 @@ import { Encryptable } from './Encryptable.mjs';
 import { PatientHealthCarePartyType } from './PatientHealthCarePartyType.mjs';
 import { ReferralPeriod } from './ReferralPeriod.mjs';
 import { TelecomType } from './TelecomType.mjs';
+/**
+ *
+ *
+ *   Created by aduchate on 02/07/13, 11:59
+ */
 export interface PatientHealthCareParty extends Encryptable {
     type: PatientHealthCarePartyType | undefined;
     healthcarePartyId: string | undefined;
@@ -15,6 +20,11 @@ export interface PatientHealthCareParty extends Encryptable {
     readonly isEncrypted: boolean;
     toJSON(): object;
 }
+/**
+ *
+ *
+ *   Created by aduchate on 02/07/13, 11:59
+ */
 export declare class DecryptedPatientHealthCareParty {
     type: PatientHealthCarePartyType | undefined;
     healthcarePartyId: string | undefined;
@@ -29,6 +39,11 @@ export declare class DecryptedPatientHealthCareParty {
     toJSON(): object;
     static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): DecryptedPatientHealthCareParty;
 }
+/**
+ *
+ *
+ *   Created by aduchate on 02/07/13, 11:59
+ */
 export declare class EncryptedPatientHealthCareParty {
     type: PatientHealthCarePartyType | undefined;
     healthcarePartyId: string | undefined;

package/model/embed/PatientHealthCareParty.mjs

@@ -4,6 +4,11 @@ import { DecryptedPropertyStub, EncryptedPropertyStub } from '../PropertyStub.mj
 import { PatientHealthCarePartyType } from './PatientHealthCarePartyType.mjs';
 import { ReferralPeriod } from './ReferralPeriod.mjs';
 import { TelecomType } from './TelecomType.mjs';
+/**
+ *
+ *
+ *   Created by aduchate on 02/07/13, 11:59
+ */
 export class DecryptedPatientHealthCareParty {
     constructor(partial) {
         this.type = undefined;
@@ -65,6 +70,11 @@ export class DecryptedPatientHealthCareParty {
         return res;
     }
 }
+/**
+ *
+ *
+ *   Created by aduchate on 02/07/13, 11:59
+ */
 export class EncryptedPatientHealthCareParty {
     constructor(partial) {
         this.type = undefined;

package/model/embed/PatientHealthCarePartyType.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *
+ *   Enumerates the types of relationships between a patient and a healthcare party.
+ */
 export declare enum PatientHealthCarePartyType {
     Doctor = "Doctor",
     Referral = "Referral",

package/model/embed/PatientHealthCarePartyType.mjs

@@ -1,4 +1,9 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Enumerates the types of relationships between a patient and a healthcare party.
+ */
 export var PatientHealthCarePartyType;
 (function (PatientHealthCarePartyType) {
     PatientHealthCarePartyType["Doctor"] = "Doctor";

package/model/embed/Payment.d.mts

@@ -1,7 +1,24 @@
 import { PaymentType } from './PaymentType.mjs';
+/**
+ *
+ *  Represents a payment record with date, type, and amount.
+ *  /
+ */
 export declare class Payment {
+    /**
+     *
+     *  The date of the payment (unix epoch in ms).
+     */
     paymentDate: number;
+    /**
+     *
+     *  The type of payment method used.
+     */
     paymentType: PaymentType | undefined;
+    /**
+     *
+     *  The amount paid.
+     */
     paid: number | undefined;
     constructor(partial: Partial<Payment>);
     toJSON(): object;

package/model/embed/Payment.mjs

@@ -1,10 +1,27 @@
 // auto-generated file
 import { expectNumber, expectStringEnum, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 import { PaymentType } from './PaymentType.mjs';
+/**
+ *
+ *  Represents a payment record with date, type, and amount.
+ *  /
+ */
 export class Payment {
     constructor(partial) {
+        /**
+         *
+         *  The date of the payment (unix epoch in ms).
+         */
         this.paymentDate = 0;
+        /**
+         *
+         *  The type of payment method used.
+         */
         this.paymentType = undefined;
+        /**
+         *
+         *  The amount paid.
+         */
         this.paid = undefined;
         if ('paymentDate' in partial && partial.paymentDate !== undefined)
             this.paymentDate = partial.paymentDate;

package/model/embed/PaymentType.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *
+ *   Enumerates the possible payment methods.
+ */
 export declare enum PaymentType {
     Cash = "Cash",
     Wired = "Wired",

package/model/embed/PaymentType.mjs

@@ -1,4 +1,9 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Enumerates the possible payment methods.
+ */
 export var PaymentType;
 (function (PaymentType) {
     PaymentType["Cash"] = "Cash";

package/model/embed/PersonName.d.mts

@@ -1,12 +1,51 @@
 import { PersonNameUse } from './PersonNameUse.mjs';
+/**
+ *
+ *  Represents name information for a person, following FHIR HumanName conventions. Includes family
+ *  name,
+ *  given names, prefixes, suffixes, and a validity period.
+ *  /
+ */
 export declare class PersonName {
+    /**
+     *
+     *  Family name (often called 'Surname').
+     */
     lastName: string | undefined;
+    /**
+     *
+     *  Given names (not always 'first'), including middle names, in the correct order for presentation.
+     */
     firstNames: Array<string>;
+    /**
+     *
+     *  Starting date of the period when the name is valid (fuzzy date, YYYYMMDD).
+     */
     start: number | undefined;
+    /**
+     *
+     *  Ending date of the period when the name is valid (fuzzy date, YYYYMMDD).
+     */
     end: number | undefined;
+    /**
+     *
+     *  Parts that come before the name, in the correct order for presentation.
+     */
     prefix: Array<string>;
+    /**
+     *
+     *  Parts that come after the name, in the correct order for presentation.
+     */
     suffix: Array<string>;
+    /**
+     *
+     *  Text representation of the full name.
+     */
     text: string | undefined;
+    /**
+     *
+     *  The use of this name (usual, official, temp, etc.).
+     */
     use: PersonNameUse | undefined;
     constructor(partial: Partial<PersonName>);
     toJSON(): object;

package/model/embed/PersonName.mjs

@@ -1,15 +1,54 @@
 // auto-generated file
 import { expectArray, expectNumber, expectString, expectStringEnum, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 import { PersonNameUse } from './PersonNameUse.mjs';
+/**
+ *
+ *  Represents name information for a person, following FHIR HumanName conventions. Includes family
+ *  name,
+ *  given names, prefixes, suffixes, and a validity period.
+ *  /
+ */
 export class PersonName {
     constructor(partial) {
+        /**
+         *
+         *  Family name (often called 'Surname').
+         */
         this.lastName = undefined;
+        /**
+         *
+         *  Given names (not always 'first'), including middle names, in the correct order for presentation.
+         */
         this.firstNames = [];
+        /**
+         *
+         *  Starting date of the period when the name is valid (fuzzy date, YYYYMMDD).
+         */
         this.start = undefined;
+        /**
+         *
+         *  Ending date of the period when the name is valid (fuzzy date, YYYYMMDD).
+         */
         this.end = undefined;
+        /**
+         *
+         *  Parts that come before the name, in the correct order for presentation.
+         */
         this.prefix = [];
+        /**
+         *
+         *  Parts that come after the name, in the correct order for presentation.
+         */
         this.suffix = [];
+        /**
+         *
+         *  Text representation of the full name.
+         */
         this.text = undefined;
+        /**
+         *
+         *  The use of this name (usual, official, temp, etc.).
+         */
         this.use = undefined;
         if ('lastName' in partial)
             this.lastName = partial.lastName;

package/model/embed/PersonNameUse.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *  Enumerates the possible uses of a person name, following FHIR HumanName use codes.
+ *  /
+ */
 export declare enum PersonNameUse {
     Usual = "Usual",
     Official = "Official",

package/model/embed/PersonNameUse.mjs

@@ -1,4 +1,9 @@
 // auto-generated file
+/**
+ *
+ *  Enumerates the possible uses of a person name, following FHIR HumanName use codes.
+ *  /
+ */
 export var PersonNameUse;
 (function (PersonNameUse) {
     PersonNameUse["Usual"] = "Usual";

package/model/embed/PersonalStatus.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *
+ *   Enumerates the possible personal (marital/civil) statuses of a patient.
+ */
 export declare enum PersonalStatus {
     Single = "Single",
     InCouple = "InCouple",

package/model/embed/PersonalStatus.mjs

@@ -1,4 +1,9 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Enumerates the possible personal (marital/civil) statuses of a patient.
+ */
 export var PersonalStatus;
 (function (PersonalStatus) {
     PersonalStatus["Single"] = "Single";

package/model/embed/Range.d.mts

@@ -1,5 +1,18 @@
+/**
+ *
+ *
+ *   Represents a numeric range defined by a low and high bound.
+ */
 export declare class Range {
+    /**
+     *
+     *  The lower bound of the range.
+     */
     low: number | undefined;
+    /**
+     *
+     *  The upper bound of the range.
+     */
     high: number | undefined;
     constructor(partial: Partial<Range>);
     toJSON(): object;

package/model/embed/Range.mjs

@@ -1,8 +1,21 @@
 // auto-generated file
 import { expectNumber, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *
+ *   Represents a numeric range defined by a low and high bound.
+ */
 export class Range {
     constructor(partial) {
+        /**
+         *
+         *  The lower bound of the range.
+         */
         this.low = undefined;
+        /**
+         *
+         *  The upper bound of the range.
+         */
         this.high = undefined;
         if ('low' in partial)
             this.low = partial.low;

package/model/embed/ReferenceRange.d.mts

@@ -1,13 +1,47 @@
 import { CodeStub } from '../base/CodeStub.mjs';
 import { Annotation } from './Annotation.mjs';
 import { Range } from './Range.mjs';
+/**
+ *
+ *
+ *   Represents a reference range for a measurement, including bounds, applicable age range, tags,
+ *  codes, and notes.
+ */
 export declare class ReferenceRange {
+    /**
+     *
+     *  The lower bound of the reference range.
+     */
     low: number | undefined;
+    /**
+     *
+     *  The upper bound of the reference range.
+     */
     high: number | undefined;
+    /**
+     *
+     *  A string representation of the reference range.
+     */
     stringValue: string | undefined;
+    /**
+     *
+     *  Tags associated with this reference range.
+     */
     tags: Array<CodeStub>;
+    /**
+     *
+     *  Codes associated with this reference range.
+     */
     codes: Array<CodeStub>;
+    /**
+     *
+     *  Annotations providing additional context.
+     */
     notes: Array<Annotation>;
+    /**
+     *
+     *  The age range to which this reference range applies.
+     */
     age: Range | undefined;
     constructor(partial: Partial<ReferenceRange>);
     toJSON(): object;

package/model/embed/ReferenceRange.mjs

@@ -3,14 +3,48 @@ import { expectArray, expectNumber, expectObject, expectString, extractEntry } f
 import { CodeStub } from '../base/CodeStub.mjs';
 import { Annotation } from './Annotation.mjs';
 import { Range } from './Range.mjs';
+/**
+ *
+ *
+ *   Represents a reference range for a measurement, including bounds, applicable age range, tags,
+ *  codes, and notes.
+ */
 export class ReferenceRange {
     constructor(partial) {
+        /**
+         *
+         *  The lower bound of the reference range.
+         */
         this.low = undefined;
+        /**
+         *
+         *  The upper bound of the reference range.
+         */
         this.high = undefined;
+        /**
+         *
+         *  A string representation of the reference range.
+         */
         this.stringValue = undefined;
+        /**
+         *
+         *  Tags associated with this reference range.
+         */
         this.tags = [];
+        /**
+         *
+         *  Codes associated with this reference range.
+         */
         this.codes = [];
+        /**
+         *
+         *  Annotations providing additional context.
+         */
         this.notes = [];
+        /**
+         *
+         *  The age range to which this reference range applies.
+         */
         this.age = undefined;
         if ('low' in partial)
             this.low = partial.low;

package/model/embed/ReferralPeriod.d.mts

@@ -1,6 +1,23 @@
+/**
+ *
+ *  Represents a time-bounded referral period between a patient and a healthcare party.
+ *  /
+ */
 export declare class ReferralPeriod {
+    /**
+     *
+     *  The date when the referral period started.
+     */
     startDate: number | undefined;
+    /**
+     *
+     *  The date when the referral period ended.
+     */
     endDate: number | undefined;
+    /**
+     *
+     *  Comments made during the referral.
+     */
     comment: string | undefined;
     constructor(partial: Partial<ReferralPeriod>);
     toJSON(): object;

package/model/embed/ReferralPeriod.mjs

@@ -1,9 +1,26 @@
 // auto-generated file
 import { expectNumber, expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  Represents a time-bounded referral period between a patient and a healthcare party.
+ *  /
+ */
 export class ReferralPeriod {
     constructor(partial) {
+        /**
+         *
+         *  The date when the referral period started.
+         */
         this.startDate = undefined;
+        /**
+         *
+         *  The date when the referral period ended.
+         */
         this.endDate = undefined;
+        /**
+         *
+         *  Comments made during the referral.
+         */
         this.comment = undefined;
         if ('startDate' in partial)
             this.startDate = partial.startDate;

package/model/embed/RegimenItem.d.mts

@@ -1,12 +1,44 @@
 import { CodeStub } from '../base/CodeStub.mjs';
 import { AdministrationQuantity } from './AdministrationQuantity.mjs';
 import { Weekday } from './Weekday.mjs';
+/**
+ *
+ *  Represents a single item in a medication regimen, defining when and how much medication should be
+ *  administered.
+ *  The day can be specified as a specific date, day number in treatment, or weekday. The time can be
+ *  a day period or exact time.
+ *  /
+ */
 export declare class RegimenItem {
+    /**
+     *
+     *  A specific date (yyyyMMdd) for this regimen item.
+     */
     date: number | undefined;
+    /**
+     *
+     *  The day number in the treatment (1-based).
+     */
     dayNumber: number | undefined;
+    /**
+     *
+     *  The weekday for this regimen item.
+     */
     weekday: Weekday | undefined;
+    /**
+     *
+     *  The period of the day (CD-DAYPERIOD) for administration.
+     */
     dayPeriod: CodeStub | undefined;
+    /**
+     *
+     *  The time of day (hhmmss) for administration.
+     */
     timeOfDay: number | undefined;
+    /**
+     *
+     *  The quantity to administer.
+     */
     administratedQuantity: AdministrationQuantity | undefined;
     constructor(partial: Partial<RegimenItem>);
     toJSON(): object;

package/model/embed/RegimenItem.mjs

@@ -3,13 +3,45 @@ import { expectNumber, expectObject, extractEntry } from '../../internal/JsonDec
 import { CodeStub } from '../base/CodeStub.mjs';
 import { AdministrationQuantity } from './AdministrationQuantity.mjs';
 import { Weekday } from './Weekday.mjs';
+/**
+ *
+ *  Represents a single item in a medication regimen, defining when and how much medication should be
+ *  administered.
+ *  The day can be specified as a specific date, day number in treatment, or weekday. The time can be
+ *  a day period or exact time.
+ *  /
+ */
 export class RegimenItem {
     constructor(partial) {
+        /**
+         *
+         *  A specific date (yyyyMMdd) for this regimen item.
+         */
         this.date = undefined;
+        /**
+         *
+         *  The day number in the treatment (1-based).
+         */
         this.dayNumber = undefined;
+        /**
+         *
+         *  The weekday for this regimen item.
+         */
         this.weekday = undefined;
+        /**
+         *
+         *  The period of the day (CD-DAYPERIOD) for administration.
+         */
         this.dayPeriod = undefined;
+        /**
+         *
+         *  The time of day (hhmmss) for administration.
+         */
         this.timeOfDay = undefined;
+        /**
+         *
+         *  The quantity to administer.
+         */
         this.administratedQuantity = undefined;
         if ('date' in partial)
             this.date = partial.date;

package/model/embed/Renewal.d.mts

@@ -1,6 +1,20 @@
 import { Duration } from './Duration.mjs';
+/**
+ *
+ *  Represents the renewal information for a medication prescription, including the number of
+ *  renewals and their duration.
+ *  /
+ */
 export declare class Renewal {
+    /**
+     *
+     *  The number of authorized renewals.
+     */
     decimal: number | undefined;
+    /**
+     *
+     *  The duration of each renewal period.
+     */
     duration: Duration | undefined;
     constructor(partial: Partial<Renewal>);
     toJSON(): object;

package/model/embed/Renewal.mjs

@@ -1,9 +1,23 @@
 // auto-generated file
 import { expectNumber, expectObject, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 import { Duration } from './Duration.mjs';
+/**
+ *
+ *  Represents the renewal information for a medication prescription, including the number of
+ *  renewals and their duration.
+ *  /
+ */
 export class Renewal {
     constructor(partial) {
+        /**
+         *
+         *  The number of authorized renewals.
+         */
         this.decimal = undefined;
+        /**
+         *
+         *  The duration of each renewal period.
+         */
         this.duration = undefined;
         if ('decimal' in partial)
             this.decimal = partial.decimal;

package/model/embed/ResourceGroupAllocationSchedule.d.mts

@@ -1,12 +1,46 @@
 import { CodeStub } from '../base/CodeStub.mjs';
 import { EmbeddedTimeTableItem } from './EmbeddedTimeTableItem.mjs';
+/**
+ *
+ *  Represents an allocation schedule for a resource group, defining time table items within a date
+ *  range.
+ *  /
+ */
 export declare class ResourceGroupAllocationSchedule {
+    /**
+     *
+     *  The code identifying the resource group.
+     */
     resourceGroup: CodeStub | undefined;
+    /**
+     *
+     *  Tags associated with this schedule.
+     */
     tags: Array<CodeStub>;
+    /**
+     *
+     *  Codes associated with this schedule.
+     */
     codes: Array<CodeStub>;
+    /**
+     *
+     *  The name of this allocation schedule.
+     */
     name: string | undefined;
+    /**
+     *
+     *  The start date-time in YYYYMMDDHHMMSS format.
+     */
     startDateTime: number | undefined;
+    /**
+     *
+     *  The end date-time in YYYYMMDDHHMMSS format.
+     */
     endDateTime: number | undefined;
+    /**
+     *
+     *  The list of time table items in this schedule.
+     */
     items: Array<EmbeddedTimeTableItem>;
     constructor(partial: Partial<ResourceGroupAllocationSchedule>);
     toJSON(): object;