@icure/cardinal-sdk 2.1.1 → 2.1.2

package/model/embed/Measure.mjs

@@ -3,19 +3,73 @@ import { expectArray, expectNumber, expectObject, expectString, extractEntry } f
 import { CodeStub } from '../base/CodeStub.mjs';
 import { ReferenceRange } from './ReferenceRange.mjs';
 import { ValueWithPrecision } from './ValueWithPrecision.mjs';
+/**
+ *
+ *  Represents a measured value with its unit, reference value, severity, evolution, and reference
+ *  ranges.
+ *  /
+ */
 export class Measure {
     constructor(partial) {
+        /**
+         *
+         *  The measured numeric value.
+         */
         this.value = undefined;
+        /**
+         *
+         *  The reference value for comparison.
+         */
         this.ref = undefined;
+        /**
+         *
+         *  The severity level as an integer.
+         */
         this.severity = undefined;
+        /**
+         *
+         *  The severity code as a string.
+         */
         this.severityCode = undefined;
+        /**
+         *
+         *  The evolution indicator as an integer.
+         */
         this.evolution = undefined;
+        /**
+         *
+         *  The unit of measurement as a string.
+         */
         this.unit = undefined;
+        /**
+         *
+         *  The coded units of measurement.
+         */
         this.unitCodes = undefined;
+        /**
+         *
+         *  A comment about the measurement.
+         */
         this.comment = undefined;
+        /**
+         *
+         *  A comparator string (e.g., "<", ">", "<=").
+         */
         this.comparator = undefined;
+        /**
+         *
+         *  The sign of the value.
+         */
         this.sign = undefined;
+        /**
+         *
+         *  The list of reference ranges for this measurement.
+         */
         this.referenceRanges = [];
+        /**
+         *
+         *  The value with its precision information.
+         */
         this.valueWithPrecision = undefined;
         if ('value' in partial)
             this.value = partial.value;

package/model/embed/MedicalHouseContract.d.mts

@@ -3,126 +3,539 @@ import { ContractChangeType } from './ContractChangeType.mjs';
 import { Encryptable } from './Encryptable.mjs';
 import { MhcSignatureType } from './MhcSignatureType.mjs';
 import { SuspensionReason } from './SuspensionReason.mjs';
+/**
+ *
+ *  Represents a medical house contract (inscription period) for a patient, including coverage
+ *  details,
+ *  suspension periods, and signature information.
+ *  /
+ */
 export interface MedicalHouseContract extends Encryptable {
+    /**
+     *
+     *  The identifier of the contract.
+     */
     contractId: string | undefined;
+    /**
+     *
+     *  The start of the contract period (yyyyMMdd).
+     */
     validFrom: number | undefined;
+    /**
+     *
+     *  The end of the contract period (yyyyMMdd).
+     */
     validTo: number | undefined;
+    /**
+     *
+     *  The NIHII number of the medical house.
+     */
     mmNihii: string | undefined;
+    /**
+     *
+     *  The identifier of the healthcare party.
+     */
     hcpId: string | undefined;
+    /**
+     *
+     *  The type of contract change (inscription, coverageChange, suspension).
+     */
     changeType: ContractChangeType | undefined;
+    /**
+     *
+     *  The identifier of the parent contract.
+     */
     parentContractId: string | undefined;
+    /**
+     *
+     *  Who changed the contract (user or mcn).
+     */
     changedBy: string | undefined;
+    /**
+     *
+     *  The contract signature date (yyyyMMdd).
+     */
     startOfContract: number | undefined;
+    /**
+     *
+     *  The start of coverage date (yyyyMMdd).
+     */
     startOfCoverage: number | undefined;
+    /**
+     *
+     *  The contract end signature date (yyyyMMdd).
+     */
     endOfContract: number | undefined;
+    /**
+     *
+     *  The end of coverage date (yyyyMMdd).
+     */
     endOfCoverage: number | undefined;
+    /**
+     *
+     *  Whether kinesitherapy is covered.
+     */
     kine: boolean;
+    /**
+     *
+     *  Whether general practitioner care is covered.
+     */
     gp: boolean;
+    /**
+     *
+     *  Whether PTD is covered.
+     */
     ptd: boolean;
+    /**
+     *
+     *  Whether nursing care is covered.
+     */
     nurse: boolean;
+    /**
+     *
+     *  Whether kinesitherapy is excluded.
+     */
     noKine: boolean;
+    /**
+     *
+     *  Whether general practitioner care is excluded.
+     */
     noGp: boolean;
+    /**
+     *
+     *  Whether nursing care is excluded.
+     */
     noNurse: boolean;
+    /**
+     *
+     *  The reason identifier for unsubscription.
+     */
     unsubscriptionReasonId: number | undefined;
+    /**
+     *
+     *  The start date of PTD coverage.
+     */
     ptdStart: number | undefined;
+    /**
+     *
+     *  The end date of PTD coverage.
+     */
     ptdEnd: number | undefined;
+    /**
+     *
+     *  The date PTD was last invoiced.
+     */
     ptdLastInvoiced: number | undefined;
+    /**
+     *
+     *  The start of suspension date (yyyyMMdd).
+     */
     startOfSuspension: number | undefined;
+    /**
+     *
+     *  The end of suspension date (yyyyMMdd).
+     */
     endOfSuspension: number | undefined;
+    /**
+     *
+     *  The reason for suspension.
+     */
     suspensionReason: SuspensionReason | undefined;
+    /**
+     *
+     *  The source of the suspension.
+     */
     suspensionSource: string | undefined;
+    /**
+     *
+     *  Whether the suspension is forced (no automatic unsuspension).
+     */
     forcedSuspension: boolean;
+    /**
+     *
+     *  The type of signature used for the contract.
+     */
     signatureType: MhcSignatureType | undefined;
+    /**
+     *
+     *  The contract status.
+     */
     status: number | undefined;
+    /**
+     *
+     *  Additional options as key-value pairs.
+     */
     options: {
         [key: string]: string;
     };
+    /**
+     *
+     *  Receipt identifiers as key-value pairs.
+     */
     receipts: {
         [key: string]: string;
     };
     readonly isEncrypted: boolean;
     toJSON(): object;
 }
+/**
+ *
+ *  Represents a medical house contract (inscription period) for a patient, including coverage
+ *  details,
+ *  suspension periods, and signature information.
+ *  /
+ */
 export declare class DecryptedMedicalHouseContract {
+    /**
+     *
+     *  The identifier of the contract.
+     */
     contractId: string | undefined;
+    /**
+     *
+     *  The start of the contract period (yyyyMMdd).
+     */
     validFrom: number | undefined;
+    /**
+     *
+     *  The end of the contract period (yyyyMMdd).
+     */
     validTo: number | undefined;
+    /**
+     *
+     *  The NIHII number of the medical house.
+     */
     mmNihii: string | undefined;
+    /**
+     *
+     *  The identifier of the healthcare party.
+     */
     hcpId: string | undefined;
+    /**
+     *
+     *  The type of contract change (inscription, coverageChange, suspension).
+     */
     changeType: ContractChangeType | undefined;
+    /**
+     *
+     *  The identifier of the parent contract.
+     */
     parentContractId: string | undefined;
+    /**
+     *
+     *  Who changed the contract (user or mcn).
+     */
     changedBy: string | undefined;
+    /**
+     *
+     *  The contract signature date (yyyyMMdd).
+     */
     startOfContract: number | undefined;
+    /**
+     *
+     *  The start of coverage date (yyyyMMdd).
+     */
     startOfCoverage: number | undefined;
+    /**
+     *
+     *  The contract end signature date (yyyyMMdd).
+     */
     endOfContract: number | undefined;
+    /**
+     *
+     *  The end of coverage date (yyyyMMdd).
+     */
     endOfCoverage: number | undefined;
+    /**
+     *
+     *  Whether kinesitherapy is covered.
+     */
     kine: boolean;
+    /**
+     *
+     *  Whether general practitioner care is covered.
+     */
     gp: boolean;
+    /**
+     *
+     *  Whether PTD is covered.
+     */
     ptd: boolean;
+    /**
+     *
+     *  Whether nursing care is covered.
+     */
     nurse: boolean;
+    /**
+     *
+     *  Whether kinesitherapy is excluded.
+     */
     noKine: boolean;
+    /**
+     *
+     *  Whether general practitioner care is excluded.
+     */
     noGp: boolean;
+    /**
+     *
+     *  Whether nursing care is excluded.
+     */
     noNurse: boolean;
+    /**
+     *
+     *  The reason identifier for unsubscription.
+     */
     unsubscriptionReasonId: number | undefined;
+    /**
+     *
+     *  The start date of PTD coverage.
+     */
     ptdStart: number | undefined;
+    /**
+     *
+     *  The end date of PTD coverage.
+     */
     ptdEnd: number | undefined;
+    /**
+     *
+     *  The date PTD was last invoiced.
+     */
     ptdLastInvoiced: number | undefined;
+    /**
+     *
+     *  The start of suspension date (yyyyMMdd).
+     */
     startOfSuspension: number | undefined;
+    /**
+     *
+     *  The end of suspension date (yyyyMMdd).
+     */
     endOfSuspension: number | undefined;
+    /**
+     *
+     *  The reason for suspension.
+     */
     suspensionReason: SuspensionReason | undefined;
+    /**
+     *
+     *  The source of the suspension.
+     */
     suspensionSource: string | undefined;
+    /**
+     *
+     *  Whether the suspension is forced (no automatic unsuspension).
+     */
     forcedSuspension: boolean;
+    /**
+     *
+     *  The type of signature used for the contract.
+     */
     signatureType: MhcSignatureType | undefined;
+    /**
+     *
+     *  The contract status.
+     */
     status: number | undefined;
+    /**
+     *
+     *  Additional options as key-value pairs.
+     */
     options: {
         [key: string]: string;
     };
+    /**
+     *
+     *  Receipt identifiers as key-value pairs.
+     */
     receipts: {
         [key: string]: string;
     };
+    /**
+     *
+     *  The base64-encoded encrypted content.
+     */
     encryptedSelf: Base64String | undefined;
     readonly isEncrypted: false;
     constructor(partial: Partial<DecryptedMedicalHouseContract>);
     toJSON(): object;
     static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): DecryptedMedicalHouseContract;
 }
+/**
+ *
+ *  Represents a medical house contract (inscription period) for a patient, including coverage
+ *  details,
+ *  suspension periods, and signature information.
+ *  /
+ */
 export declare class EncryptedMedicalHouseContract {
+    /**
+     *
+     *  The identifier of the contract.
+     */
     contractId: string | undefined;
+    /**
+     *
+     *  The start of the contract period (yyyyMMdd).
+     */
     validFrom: number | undefined;
+    /**
+     *
+     *  The end of the contract period (yyyyMMdd).
+     */
     validTo: number | undefined;
+    /**
+     *
+     *  The NIHII number of the medical house.
+     */
     mmNihii: string | undefined;
+    /**
+     *
+     *  The identifier of the healthcare party.
+     */
     hcpId: string | undefined;
+    /**
+     *
+     *  The type of contract change (inscription, coverageChange, suspension).
+     */
     changeType: ContractChangeType | undefined;
+    /**
+     *
+     *  The identifier of the parent contract.
+     */
     parentContractId: string | undefined;
+    /**
+     *
+     *  Who changed the contract (user or mcn).
+     */
     changedBy: string | undefined;
+    /**
+     *
+     *  The contract signature date (yyyyMMdd).
+     */
     startOfContract: number | undefined;
+    /**
+     *
+     *  The start of coverage date (yyyyMMdd).
+     */
     startOfCoverage: number | undefined;
+    /**
+     *
+     *  The contract end signature date (yyyyMMdd).
+     */
     endOfContract: number | undefined;
+    /**
+     *
+     *  The end of coverage date (yyyyMMdd).
+     */
     endOfCoverage: number | undefined;
+    /**
+     *
+     *  Whether kinesitherapy is covered.
+     */
     kine: boolean;
+    /**
+     *
+     *  Whether general practitioner care is covered.
+     */
     gp: boolean;
+    /**
+     *
+     *  Whether PTD is covered.
+     */
     ptd: boolean;
+    /**
+     *
+     *  Whether nursing care is covered.
+     */
     nurse: boolean;
+    /**
+     *
+     *  Whether kinesitherapy is excluded.
+     */
     noKine: boolean;
+    /**
+     *
+     *  Whether general practitioner care is excluded.
+     */
     noGp: boolean;
+    /**
+     *
+     *  Whether nursing care is excluded.
+     */
     noNurse: boolean;
+    /**
+     *
+     *  The reason identifier for unsubscription.
+     */
     unsubscriptionReasonId: number | undefined;
+    /**
+     *
+     *  The start date of PTD coverage.
+     */
     ptdStart: number | undefined;
+    /**
+     *
+     *  The end date of PTD coverage.
+     */
     ptdEnd: number | undefined;
+    /**
+     *
+     *  The date PTD was last invoiced.
+     */
     ptdLastInvoiced: number | undefined;
+    /**
+     *
+     *  The start of suspension date (yyyyMMdd).
+     */
     startOfSuspension: number | undefined;
+    /**
+     *
+     *  The end of suspension date (yyyyMMdd).
+     */
     endOfSuspension: number | undefined;
+    /**
+     *
+     *  The reason for suspension.
+     */
     suspensionReason: SuspensionReason | undefined;
+    /**
+     *
+     *  The source of the suspension.
+     */
     suspensionSource: string | undefined;
+    /**
+     *
+     *  Whether the suspension is forced (no automatic unsuspension).
+     */
     forcedSuspension: boolean;
+    /**
+     *
+     *  The type of signature used for the contract.
+     */
     signatureType: MhcSignatureType | undefined;
+    /**
+     *
+     *  The contract status.
+     */
     status: number | undefined;
+    /**
+     *
+     *  Additional options as key-value pairs.
+     */
     options: {
         [key: string]: string;
     };
+    /**
+     *
+     *  Receipt identifiers as key-value pairs.
+     */
     receipts: {
         [key: string]: string;
     };
+    /**
+     *
+     *  The base64-encoded encrypted content.
+     */
     encryptedSelf: Base64String | undefined;
     readonly isEncrypted: true;
     constructor(partial: Partial<EncryptedMedicalHouseContract>);