@icure/cardinal-sdk 2.1.1 → 2.1.3

package/model/embed/MedicalHouseContract.mjs

@@ -3,40 +3,179 @@ import { expectBoolean, expectMap, expectNumber, expectString, expectStringEnum,
 import { ContractChangeType } from './ContractChangeType.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 class DecryptedMedicalHouseContract {
     constructor(partial) {
+        /**
+         *
+         *  The identifier of the contract.
+         */
         this.contractId = undefined;
+        /**
+         *
+         *  The start of the contract period (yyyyMMdd).
+         */
         this.validFrom = undefined;
+        /**
+         *
+         *  The end of the contract period (yyyyMMdd).
+         */
         this.validTo = undefined;
+        /**
+         *
+         *  The NIHII number of the medical house.
+         */
         this.mmNihii = undefined;
+        /**
+         *
+         *  The identifier of the healthcare party.
+         */
         this.hcpId = undefined;
+        /**
+         *
+         *  The type of contract change (inscription, coverageChange, suspension).
+         */
         this.changeType = undefined;
+        /**
+         *
+         *  The identifier of the parent contract.
+         */
         this.parentContractId = undefined;
+        /**
+         *
+         *  Who changed the contract (user or mcn).
+         */
         this.changedBy = undefined;
+        /**
+         *
+         *  The contract signature date (yyyyMMdd).
+         */
         this.startOfContract = undefined;
+        /**
+         *
+         *  The start of coverage date (yyyyMMdd).
+         */
         this.startOfCoverage = undefined;
+        /**
+         *
+         *  The contract end signature date (yyyyMMdd).
+         */
         this.endOfContract = undefined;
+        /**
+         *
+         *  The end of coverage date (yyyyMMdd).
+         */
         this.endOfCoverage = undefined;
+        /**
+         *
+         *  Whether kinesitherapy is covered.
+         */
         this.kine = false;
+        /**
+         *
+         *  Whether general practitioner care is covered.
+         */
         this.gp = false;
+        /**
+         *
+         *  Whether PTD is covered.
+         */
         this.ptd = false;
+        /**
+         *
+         *  Whether nursing care is covered.
+         */
         this.nurse = false;
+        /**
+         *
+         *  Whether kinesitherapy is excluded.
+         */
         this.noKine = false;
+        /**
+         *
+         *  Whether general practitioner care is excluded.
+         */
         this.noGp = false;
+        /**
+         *
+         *  Whether nursing care is excluded.
+         */
         this.noNurse = false;
+        /**
+         *
+         *  The reason identifier for unsubscription.
+         */
         this.unsubscriptionReasonId = undefined;
+        /**
+         *
+         *  The start date of PTD coverage.
+         */
         this.ptdStart = undefined;
+        /**
+         *
+         *  The end date of PTD coverage.
+         */
         this.ptdEnd = undefined;
+        /**
+         *
+         *  The date PTD was last invoiced.
+         */
         this.ptdLastInvoiced = undefined;
+        /**
+         *
+         *  The start of suspension date (yyyyMMdd).
+         */
         this.startOfSuspension = undefined;
+        /**
+         *
+         *  The end of suspension date (yyyyMMdd).
+         */
         this.endOfSuspension = undefined;
+        /**
+         *
+         *  The reason for suspension.
+         */
         this.suspensionReason = undefined;
+        /**
+         *
+         *  The source of the suspension.
+         */
         this.suspensionSource = undefined;
+        /**
+         *
+         *  Whether the suspension is forced (no automatic unsuspension).
+         */
         this.forcedSuspension = false;
+        /**
+         *
+         *  The type of signature used for the contract.
+         */
         this.signatureType = undefined;
+        /**
+         *
+         *  The contract status.
+         */
         this.status = undefined;
+        /**
+         *
+         *  Additional options as key-value pairs.
+         */
         this.options = {};
+        /**
+         *
+         *  Receipt identifiers as key-value pairs.
+         */
         this.receipts = {};
+        /**
+         *
+         *  The base64-encoded encrypted content.
+         */
         this.encryptedSelf = undefined;
         this.isEncrypted = false;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== false)
@@ -218,40 +357,179 @@ export class DecryptedMedicalHouseContract {
         return res;
     }
 }
+/**
+ *
+ *  Represents a medical house contract (inscription period) for a patient, including coverage
+ *  details,
+ *  suspension periods, and signature information.
+ *  /
+ */
 export class EncryptedMedicalHouseContract {
     constructor(partial) {
+        /**
+         *
+         *  The identifier of the contract.
+         */
         this.contractId = undefined;
+        /**
+         *
+         *  The start of the contract period (yyyyMMdd).
+         */
         this.validFrom = undefined;
+        /**
+         *
+         *  The end of the contract period (yyyyMMdd).
+         */
         this.validTo = undefined;
+        /**
+         *
+         *  The NIHII number of the medical house.
+         */
         this.mmNihii = undefined;
+        /**
+         *
+         *  The identifier of the healthcare party.
+         */
         this.hcpId = undefined;
+        /**
+         *
+         *  The type of contract change (inscription, coverageChange, suspension).
+         */
         this.changeType = undefined;
+        /**
+         *
+         *  The identifier of the parent contract.
+         */
         this.parentContractId = undefined;
+        /**
+         *
+         *  Who changed the contract (user or mcn).
+         */
         this.changedBy = undefined;
+        /**
+         *
+         *  The contract signature date (yyyyMMdd).
+         */
         this.startOfContract = undefined;
+        /**
+         *
+         *  The start of coverage date (yyyyMMdd).
+         */
         this.startOfCoverage = undefined;
+        /**
+         *
+         *  The contract end signature date (yyyyMMdd).
+         */
         this.endOfContract = undefined;
+        /**
+         *
+         *  The end of coverage date (yyyyMMdd).
+         */
         this.endOfCoverage = undefined;
+        /**
+         *
+         *  Whether kinesitherapy is covered.
+         */
         this.kine = false;
+        /**
+         *
+         *  Whether general practitioner care is covered.
+         */
         this.gp = false;
+        /**
+         *
+         *  Whether PTD is covered.
+         */
         this.ptd = false;
+        /**
+         *
+         *  Whether nursing care is covered.
+         */
         this.nurse = false;
+        /**
+         *
+         *  Whether kinesitherapy is excluded.
+         */
         this.noKine = false;
+        /**
+         *
+         *  Whether general practitioner care is excluded.
+         */
         this.noGp = false;
+        /**
+         *
+         *  Whether nursing care is excluded.
+         */
         this.noNurse = false;
+        /**
+         *
+         *  The reason identifier for unsubscription.
+         */
         this.unsubscriptionReasonId = undefined;
+        /**
+         *
+         *  The start date of PTD coverage.
+         */
         this.ptdStart = undefined;
+        /**
+         *
+         *  The end date of PTD coverage.
+         */
         this.ptdEnd = undefined;
+        /**
+         *
+         *  The date PTD was last invoiced.
+         */
         this.ptdLastInvoiced = undefined;
+        /**
+         *
+         *  The start of suspension date (yyyyMMdd).
+         */
         this.startOfSuspension = undefined;
+        /**
+         *
+         *  The end of suspension date (yyyyMMdd).
+         */
         this.endOfSuspension = undefined;
+        /**
+         *
+         *  The reason for suspension.
+         */
         this.suspensionReason = undefined;
+        /**
+         *
+         *  The source of the suspension.
+         */
         this.suspensionSource = undefined;
+        /**
+         *
+         *  Whether the suspension is forced (no automatic unsuspension).
+         */
         this.forcedSuspension = false;
+        /**
+         *
+         *  The type of signature used for the contract.
+         */
         this.signatureType = undefined;
+        /**
+         *
+         *  The contract status.
+         */
         this.status = undefined;
+        /**
+         *
+         *  Additional options as key-value pairs.
+         */
         this.options = {};
+        /**
+         *
+         *  Receipt identifiers as key-value pairs.
+         */
         this.receipts = {};
+        /**
+         *
+         *  The base64-encoded encrypted content.
+         */
         this.encryptedSelf = undefined;
         this.isEncrypted = true;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== true)

package/model/embed/Medication.d.mts

@@ -11,6 +11,11 @@ export declare class Medication {
     medicinalProduct: Medicinalproduct | undefined;
     numberOfPackages: number | undefined;
     batch: string | undefined;
+    /**
+     *
+     *
+     *   The expiration date of the medication. Format: yyyyMMdd
+     */
     expirationDate: number | undefined;
     instructionForPatient: string | undefined;
     instructionForReimbursement: string | undefined;

package/model/embed/Medication.mjs

@@ -14,6 +14,11 @@ export class Medication {
         this.medicinalProduct = undefined;
         this.numberOfPackages = undefined;
         this.batch = undefined;
+        /**
+         *
+         *
+         *   The expiration date of the medication. Format: yyyyMMdd
+         */
         this.expirationDate = undefined;
         this.instructionForPatient = undefined;
         this.instructionForReimbursement = undefined;

package/model/embed/Medicinalproduct.d.mts

@@ -1,9 +1,34 @@
 import { CodeStub } from '../base/CodeStub.mjs';
+/**
+ *
+ *  Represents a medicinal product with its intended and actually delivered codes and names.
+ *  /
+ */
 export declare class Medicinalproduct {
+    /**
+     *
+     *  The list of coded identifiers for the intended medicinal product.
+     */
     intendedcds: Array<CodeStub>;
+    /**
+     *
+     *  The list of coded identifiers for the actually delivered medicinal product.
+     */
     deliveredcds: Array<CodeStub>;
+    /**
+     *
+     *  The name of the intended medicinal product.
+     */
     intendedname: string | undefined;
+    /**
+     *
+     *  The name of the actually delivered medicinal product.
+     */
     deliveredname: string | undefined;
+    /**
+     *
+     *  The product identifier.
+     */
     productId: string | undefined;
     constructor(partial: Partial<Medicinalproduct>);
     toJSON(): object;

package/model/embed/Medicinalproduct.mjs

@@ -1,12 +1,37 @@
 // auto-generated file
 import { expectArray, expectObject, expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 import { CodeStub } from '../base/CodeStub.mjs';
+/**
+ *
+ *  Represents a medicinal product with its intended and actually delivered codes and names.
+ *  /
+ */
 export class Medicinalproduct {
     constructor(partial) {
+        /**
+         *
+         *  The list of coded identifiers for the intended medicinal product.
+         */
         this.intendedcds = [];
+        /**
+         *
+         *  The list of coded identifiers for the actually delivered medicinal product.
+         */
         this.deliveredcds = [];
+        /**
+         *
+         *  The name of the intended medicinal product.
+         */
         this.intendedname = undefined;
+        /**
+         *
+         *  The name of the actually delivered medicinal product.
+         */
         this.deliveredname = undefined;
+        /**
+         *
+         *  The product identifier.
+         */
         this.productId = undefined;
         if ('intendedcds' in partial && partial.intendedcds !== undefined)
             this.intendedcds = partial.intendedcds;

package/model/embed/MediumType.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *
+ *   Enumerates the medium types through which invoices or documents can be transmitted.
+ */
 export declare enum MediumType {
     Cdrom = "Cdrom",
     Eattest = "Eattest",

package/model/embed/MediumType.mjs

@@ -1,4 +1,9 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Enumerates the medium types through which invoices or documents can be transmitted.
+ */
 export var MediumType;
 (function (MediumType) {
     MediumType["Cdrom"] = "Cdrom";

package/model/embed/MembershipType.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *
+ *   Enumerates the types of membership a care team member can hold.
+ */
 export declare enum MembershipType {
     Doctor = "Doctor",
     Mutuality = "Mutuality",

package/model/embed/MembershipType.mjs

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

package/model/embed/MessageReadStatus.d.mts

@@ -1,5 +1,19 @@
+/**
+ *
+ *  Represents the read status of a message for a specific user, tracking whether it has been read
+ *  and when.
+ *  /
+ */
 export declare class MessageReadStatus {
+    /**
+     *
+     *  The timestamp (unix epoch in ms) when the message was read.
+     */
     time: number | undefined;
+    /**
+     *
+     *  Whether the message has been read.
+     */
     read: boolean;
     constructor(partial: Partial<MessageReadStatus>);
     toJSON(): object;

package/model/embed/MessageReadStatus.mjs

@@ -1,8 +1,22 @@
 // auto-generated file
 import { expectBoolean, expectNumber, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  Represents the read status of a message for a specific user, tracking whether it has been read
+ *  and when.
+ *  /
+ */
 export class MessageReadStatus {
     constructor(partial) {
+        /**
+         *
+         *  The timestamp (unix epoch in ms) when the message was read.
+         */
         this.time = undefined;
+        /**
+         *
+         *  Whether the message has been read.
+         */
         this.read = false;
         if ('time' in partial)
             this.time = partial.time;

package/model/embed/MhcSignatureType.d.mts

@@ -1,3 +1,9 @@
+/**
+ *
+ *
+ *   Enumerates the types of signatures used for medical house contracts, by holder or legal
+ *  representative, via eID or paper.
+ */
 export declare enum MhcSignatureType {
     HolderEid = "HolderEid",
     HolderPaper = "HolderPaper",

package/model/embed/MhcSignatureType.mjs

@@ -1,4 +1,10 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Enumerates the types of signatures used for medical house contracts, by holder or legal
+ *  representative, via eID or paper.
+ */
 export var MhcSignatureType;
 (function (MhcSignatureType) {
     MhcSignatureType["HolderEid"] = "HolderEid";

package/model/embed/Partnership.d.mts

@@ -1,8 +1,26 @@
 import { PartnershipStatus } from './PartnershipStatus.mjs';
 import { PartnershipType } from './PartnershipType.mjs';
+/**
+ *
+ *  Represents a relationship between a patient and another person (contact person or another
+ *  patient).
+ *  /
+ */
 export declare class Partnership {
+    /**
+     *
+     *  The type of relationship (from CD-CONTACT-PERSON codes).
+     */
     type: PartnershipType | undefined;
+    /**
+     *
+     *  The status of the relationship.
+     */
     status: PartnershipStatus | undefined;
+    /**
+     *
+     *  The UUID of the contact person or patient in this relationship.
+     */
     partnerId: string | undefined;
     constructor(partial: Partial<Partnership>);
     toJSON(): object;

package/model/embed/Partnership.mjs

@@ -2,10 +2,28 @@
 import { expectString, expectStringEnum, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 import { PartnershipStatus } from './PartnershipStatus.mjs';
 import { PartnershipType } from './PartnershipType.mjs';
+/**
+ *
+ *  Represents a relationship between a patient and another person (contact person or another
+ *  patient).
+ *  /
+ */
 export class Partnership {
     constructor(partial) {
+        /**
+         *
+         *  The type of relationship (from CD-CONTACT-PERSON codes).
+         */
         this.type = undefined;
+        /**
+         *
+         *  The status of the relationship.
+         */
         this.status = undefined;
+        /**
+         *
+         *  The UUID of the contact person or patient in this relationship.
+         */
         this.partnerId = undefined;
         if ('type' in partial)
             this.type = partial.type;

package/model/embed/PartnershipStatus.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *
+ *   Enumerates the possible statuses of a partnership (relationship between persons).
+ */
 export declare enum PartnershipStatus {
     Active = "Active",
     Complicated = "Complicated",

package/model/embed/PartnershipStatus.mjs

@@ -1,4 +1,9 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Enumerates the possible statuses of a partnership (relationship between persons).
+ */
 export var PartnershipStatus;
 (function (PartnershipStatus) {
     PartnershipStatus["Active"] = "Active";

package/model/embed/PartnershipType.d.mts

@@ -1,3 +1,9 @@
+/**
+ *
+ *
+ *   Enumerates the types of partnerships (relationships) between persons, based on CD-CONTACT-PERSON
+ *  and FHIR codes.
+ */
 export declare enum PartnershipType {
     PrimaryContact = "PrimaryContact",
     PrimaryContactFor = "PrimaryContactFor",

package/model/embed/PartnershipType.mjs

@@ -1,4 +1,10 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Enumerates the types of partnerships (relationships) between persons, based on CD-CONTACT-PERSON
+ *  and FHIR codes.
+ */
 export var PartnershipType;
 (function (PartnershipType) {
     PartnershipType["PrimaryContact"] = "PrimaryContact";