@icure/cardinal-sdk 2.1.1 → 2.1.3

package/model/embed/InvoicingCode.d.mts

@@ -1,189 +1,878 @@
 import { Base64String } from '../specializations/Base64String.mjs';
 import { Encryptable } from './Encryptable.mjs';
 import { PaymentType } from './PaymentType.mjs';
+/**
+ *
+ *  Represents an invoicing code within an invoice, containing tarification details, amounts,
+ *  prescriber information,
+ *  and lifecycle status flags. Each invoicing code corresponds to a billable medical act or service.
+ *  /
+ */
 export interface InvoicingCode extends Encryptable {
+    /**
+     *
+     *  The unique identifier of this invoicing code.
+     */
     id: string | undefined;
+    /**
+     *
+     *  The date of the invoicing code as a long (yyyyMMdd format).
+     */
     dateCode: number | undefined;
+    /**
+     *
+     *  A logical identifier that remains stable when a code is resent to the insuring organization.
+     */
     logicalId: string | undefined;
+    /**
+     *
+     *  The label of the invoicing code.
+     */
     label: string | undefined;
+    /**
+     *
+     *  The identifier of the user who created this invoicing code.
+     */
     userId: string | undefined;
+    /**
+     *
+     *  The identifier of the associated contact.
+     */
     contactId: string | undefined;
+    /**
+     *
+     *  The identifier of the associated service.
+     */
     serviceId: string | undefined;
+    /**
+     *
+     *  The identifier of the associated tarification.
+     */
     pricingId: string | undefined;
+    /**
+     *
+     *  The code value, for obsolete codes or codes not linked to a tarification.
+     */
     code: string | undefined;
+    /**
+     *
+     *  The type of payment.
+     */
     paymentType: PaymentType | undefined;
+    /**
+     *
+     *  The amount already paid.
+     */
     paid: number | undefined;
+    /**
+     *
+     *  The total amount (reimbursement + doctor supplement + intervention).
+     */
     totalAmount: number | undefined;
+    /**
+     *
+     *  The reimbursement amount.
+     */
     reimbursement: number | undefined;
+    /**
+     *
+     *  The patient intervention amount.
+     */
     patientIntervention: number | undefined;
+    /**
+     *
+     *  The AMI (insurance) intervention amount.
+     */
     amiIntervention: number | undefined;
+    /**
+     *
+     *  The doctor supplement amount.
+     */
     doctorSupplement: number | undefined;
+    /**
+     *
+     *  The convention amount (reimbursement + intervention).
+     */
     conventionAmount: number | undefined;
+    /**
+     *
+     *  The VAT amount.
+     */
     vat: number | undefined;
+    /**
+     *
+     *  The error message from eTarif, if any.
+     */
     error: string | undefined;
+    /**
+     *
+     *  The contract identifier.
+     */
     contract: string | undefined;
+    /**
+     *
+     *  The contract date.
+     */
     contractDate: number | undefined;
+    /**
+     *
+     *  The number of units.
+     */
     units: number | undefined;
+    /**
+     *
+     *  The side indicator.
+     */
     side: number | undefined;
+    /**
+     *
+     *  The time of day.
+     */
     timeOfDay: number | undefined;
+    /**
+     *
+     *  The hour when the eID was read.
+     */
     eidReadingHour: number | undefined;
+    /**
+     *
+     *  The value read from the eID.
+     */
     eidReadingValue: string | undefined;
+    /**
+     *
+     *  The override code for third-party payer.
+     */
     override3rdPayerCode: number | undefined;
+    /**
+     *
+     *  The reason for overriding the third-party payer.
+     */
     override3rdPayerReason: string | undefined;
+    /**
+     *
+     *  The transplantation code.
+     */
     transplantationCode: number | undefined;
+    /**
+     *
+     *  The prescriber norm code.
+     */
     prescriberNorm: number | undefined;
+    /**
+     *
+     *  The label of the product.
+     */
     productLabel: string | undefined;
+    /**
+     *
+     *  The percent norm.
+     */
     percentNorm: number | undefined;
+    /**
+     *
+     *  The NIHII number of the prescriber.
+     */
     prescriberNihii: string | undefined;
+    /**
+     *
+     *  A related code.
+     */
     relatedCode: string | undefined;
+    /**
+     *
+     *  The prescription date (yyyyMMdd).
+     */
     prescriptionDate: number | undefined;
+    /**
+     *
+     *  The maximum derogation number.
+     */
     derogationMaxNumber: number | undefined;
+    /**
+     *
+     *  The SSIN of the prescriber.
+     */
     prescriberSsin: string | undefined;
+    /**
+     *
+     *  The last name of the prescriber.
+     */
     prescriberLastName: string | undefined;
+    /**
+     *
+     *  The first name of the prescriber.
+     */
     prescriberFirstName: string | undefined;
+    /**
+     *
+     *  The CD-HCPARTY code of the prescriber.
+     */
     prescriberCdHcParty: string | undefined;
+    /**
+     *
+     *  The NIHII number of the location.
+     */
     locationNihii: string | undefined;
+    /**
+     *
+     *  The CD-HCPARTY code of the location.
+     */
     locationCdHcParty: string | undefined;
+    /**
+     *
+     *  The service code of the location.
+     */
     locationService: number | undefined;
+    /**
+     *
+     *  The admission date.
+     */
     admissionDate: number | undefined;
+    /**
+     *
+     *  Whether this code has been canceled.
+     */
     canceled: boolean | undefined;
+    /**
+     *
+     *  Whether this code has been accepted.
+     */
     accepted: boolean | undefined;
+    /**
+     *
+     *  Whether this code is pending.
+     */
     pending: boolean | undefined;
+    /**
+     *
+     *  Whether this code has been resent.
+     */
     resent: boolean | undefined;
+    /**
+     *
+     *  Whether this code has been archived.
+     */
     archived: boolean | undefined;
+    /**
+     *
+     *  Whether this code has been lost.
+     */
     lost: boolean | undefined;
+    /**
+     *
+     *  The insurance justification code.
+     */
     insuranceJustification: number | undefined;
+    /**
+     *
+     *  The reason for canceling patient intervention.
+     */
     cancelPatientInterventionReason: number | undefined;
+    /**
+     *
+     *  The status bitmask of this invoicing code.
+     */
     status: number | undefined;
+    /**
+     *
+     *  The label of the code.
+     */
     codeLabel: string | undefined;
+    /**
+     *
+     *  Additional options as key-value pairs.
+     */
     options: {
         [key: string]: string;
     };
     readonly isEncrypted: boolean;
     toJSON(): object;
 }
+/**
+ *
+ *  Represents an invoicing code within an invoice, containing tarification details, amounts,
+ *  prescriber information,
+ *  and lifecycle status flags. Each invoicing code corresponds to a billable medical act or service.
+ *  /
+ */
 export declare class DecryptedInvoicingCode {
+    /**
+     *
+     *  The unique identifier of this invoicing code.
+     */
     id: string | undefined;
+    /**
+     *
+     *  The date of the invoicing code as a long (yyyyMMdd format).
+     */
     dateCode: number | undefined;
+    /**
+     *
+     *  A logical identifier that remains stable when a code is resent to the insuring organization.
+     */
     logicalId: string | undefined;
+    /**
+     *
+     *  The label of the invoicing code.
+     */
     label: string | undefined;
+    /**
+     *
+     *  The identifier of the user who created this invoicing code.
+     */
     userId: string | undefined;
+    /**
+     *
+     *  The identifier of the associated contact.
+     */
     contactId: string | undefined;
+    /**
+     *
+     *  The identifier of the associated service.
+     */
     serviceId: string | undefined;
+    /**
+     *
+     *  The identifier of the associated tarification.
+     */
     pricingId: string | undefined;
+    /**
+     *
+     *  The code value, for obsolete codes or codes not linked to a tarification.
+     */
     code: string | undefined;
+    /**
+     *
+     *  The type of payment.
+     */
     paymentType: PaymentType | undefined;
+    /**
+     *
+     *  The amount already paid.
+     */
     paid: number | undefined;
+    /**
+     *
+     *  The total amount (reimbursement + doctor supplement + intervention).
+     */
     totalAmount: number | undefined;
+    /**
+     *
+     *  The reimbursement amount.
+     */
     reimbursement: number | undefined;
+    /**
+     *
+     *  The patient intervention amount.
+     */
     patientIntervention: number | undefined;
+    /**
+     *
+     *  The AMI (insurance) intervention amount.
+     */
     amiIntervention: number | undefined;
+    /**
+     *
+     *  The doctor supplement amount.
+     */
     doctorSupplement: number | undefined;
+    /**
+     *
+     *  The convention amount (reimbursement + intervention).
+     */
     conventionAmount: number | undefined;
+    /**
+     *
+     *  The VAT amount.
+     */
     vat: number | undefined;
+    /**
+     *
+     *  The error message from eTarif, if any.
+     */
     error: string | undefined;
+    /**
+     *
+     *  The contract identifier.
+     */
     contract: string | undefined;
+    /**
+     *
+     *  The contract date.
+     */
     contractDate: number | undefined;
+    /**
+     *
+     *  The number of units.
+     */
     units: number | undefined;
+    /**
+     *
+     *  The side indicator.
+     */
     side: number | undefined;
+    /**
+     *
+     *  The time of day.
+     */
     timeOfDay: number | undefined;
+    /**
+     *
+     *  The hour when the eID was read.
+     */
     eidReadingHour: number | undefined;
+    /**
+     *
+     *  The value read from the eID.
+     */
     eidReadingValue: string | undefined;
+    /**
+     *
+     *  The override code for third-party payer.
+     */
     override3rdPayerCode: number | undefined;
+    /**
+     *
+     *  The reason for overriding the third-party payer.
+     */
     override3rdPayerReason: string | undefined;
+    /**
+     *
+     *  The transplantation code.
+     */
     transplantationCode: number | undefined;
+    /**
+     *
+     *  The prescriber norm code.
+     */
     prescriberNorm: number | undefined;
+    /**
+     *
+     *  The label of the product.
+     */
     productLabel: string | undefined;
+    /**
+     *
+     *  The percent norm.
+     */
     percentNorm: number | undefined;
+    /**
+     *
+     *  The NIHII number of the prescriber.
+     */
     prescriberNihii: string | undefined;
+    /**
+     *
+     *  A related code.
+     */
     relatedCode: string | undefined;
+    /**
+     *
+     *  The prescription date (yyyyMMdd).
+     */
     prescriptionDate: number | undefined;
+    /**
+     *
+     *  The maximum derogation number.
+     */
     derogationMaxNumber: number | undefined;
+    /**
+     *
+     *  The SSIN of the prescriber.
+     */
     prescriberSsin: string | undefined;
+    /**
+     *
+     *  The last name of the prescriber.
+     */
     prescriberLastName: string | undefined;
+    /**
+     *
+     *  The first name of the prescriber.
+     */
     prescriberFirstName: string | undefined;
+    /**
+     *
+     *  The CD-HCPARTY code of the prescriber.
+     */
     prescriberCdHcParty: string | undefined;
+    /**
+     *
+     *  The NIHII number of the location.
+     */
     locationNihii: string | undefined;
+    /**
+     *
+     *  The CD-HCPARTY code of the location.
+     */
     locationCdHcParty: string | undefined;
+    /**
+     *
+     *  The service code of the location.
+     */
     locationService: number | undefined;
+    /**
+     *
+     *  The admission date.
+     */
     admissionDate: number | undefined;
+    /**
+     *
+     *  Whether this code has been canceled.
+     */
     canceled: boolean | undefined;
+    /**
+     *
+     *  Whether this code has been accepted.
+     */
     accepted: boolean | undefined;
+    /**
+     *
+     *  Whether this code is pending.
+     */
     pending: boolean | undefined;
+    /**
+     *
+     *  Whether this code has been resent.
+     */
     resent: boolean | undefined;
+    /**
+     *
+     *  Whether this code has been archived.
+     */
     archived: boolean | undefined;
+    /**
+     *
+     *  Whether this code has been lost.
+     */
     lost: boolean | undefined;
+    /**
+     *
+     *  The insurance justification code.
+     */
     insuranceJustification: number | undefined;
+    /**
+     *
+     *  The reason for canceling patient intervention.
+     */
     cancelPatientInterventionReason: number | undefined;
+    /**
+     *
+     *  The status bitmask of this invoicing code.
+     */
     status: number | undefined;
+    /**
+     *
+     *  The label of the code.
+     */
     codeLabel: string | undefined;
+    /**
+     *
+     *  Additional options as key-value pairs.
+     */
     options: {
         [key: string]: string;
     };
+    /**
+     *
+     *  The base64-encoded encrypted content.
+     */
     encryptedSelf: Base64String | undefined;
     readonly isEncrypted: false;
     constructor(partial: Partial<DecryptedInvoicingCode> & Pick<DecryptedInvoicingCode, "id">);
     toJSON(): object;
     static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): DecryptedInvoicingCode;
 }
+/**
+ *
+ *  Represents an invoicing code within an invoice, containing tarification details, amounts,
+ *  prescriber information,
+ *  and lifecycle status flags. Each invoicing code corresponds to a billable medical act or service.
+ *  /
+ */
 export declare class EncryptedInvoicingCode {
+    /**
+     *
+     *  The unique identifier of this invoicing code.
+     */
     id: string | undefined;
+    /**
+     *
+     *  The date of the invoicing code as a long (yyyyMMdd format).
+     */
     dateCode: number | undefined;
+    /**
+     *
+     *  A logical identifier that remains stable when a code is resent to the insuring organization.
+     */
     logicalId: string | undefined;
+    /**
+     *
+     *  The label of the invoicing code.
+     */
     label: string | undefined;
+    /**
+     *
+     *  The identifier of the user who created this invoicing code.
+     */
     userId: string | undefined;
+    /**
+     *
+     *  The identifier of the associated contact.
+     */
     contactId: string | undefined;
+    /**
+     *
+     *  The identifier of the associated service.
+     */
     serviceId: string | undefined;
+    /**
+     *
+     *  The identifier of the associated tarification.
+     */
     pricingId: string | undefined;
+    /**
+     *
+     *  The code value, for obsolete codes or codes not linked to a tarification.
+     */
     code: string | undefined;
+    /**
+     *
+     *  The type of payment.
+     */
     paymentType: PaymentType | undefined;
+    /**
+     *
+     *  The amount already paid.
+     */
     paid: number | undefined;
+    /**
+     *
+     *  The total amount (reimbursement + doctor supplement + intervention).
+     */
     totalAmount: number | undefined;
+    /**
+     *
+     *  The reimbursement amount.
+     */
     reimbursement: number | undefined;
+    /**
+     *
+     *  The patient intervention amount.
+     */
     patientIntervention: number | undefined;
+    /**
+     *
+     *  The AMI (insurance) intervention amount.
+     */
     amiIntervention: number | undefined;
+    /**
+     *
+     *  The doctor supplement amount.
+     */
     doctorSupplement: number | undefined;
+    /**
+     *
+     *  The convention amount (reimbursement + intervention).
+     */
     conventionAmount: number | undefined;
+    /**
+     *
+     *  The VAT amount.
+     */
     vat: number | undefined;
+    /**
+     *
+     *  The error message from eTarif, if any.
+     */
     error: string | undefined;
+    /**
+     *
+     *  The contract identifier.
+     */
     contract: string | undefined;
+    /**
+     *
+     *  The contract date.
+     */
     contractDate: number | undefined;
+    /**
+     *
+     *  The number of units.
+     */
     units: number | undefined;
+    /**
+     *
+     *  The side indicator.
+     */
     side: number | undefined;
+    /**
+     *
+     *  The time of day.
+     */
     timeOfDay: number | undefined;
+    /**
+     *
+     *  The hour when the eID was read.
+     */
     eidReadingHour: number | undefined;
+    /**
+     *
+     *  The value read from the eID.
+     */
     eidReadingValue: string | undefined;
+    /**
+     *
+     *  The override code for third-party payer.
+     */
     override3rdPayerCode: number | undefined;
+    /**
+     *
+     *  The reason for overriding the third-party payer.
+     */
     override3rdPayerReason: string | undefined;
+    /**
+     *
+     *  The transplantation code.
+     */
     transplantationCode: number | undefined;
+    /**
+     *
+     *  The prescriber norm code.
+     */
     prescriberNorm: number | undefined;
+    /**
+     *
+     *  The label of the product.
+     */
     productLabel: string | undefined;
+    /**
+     *
+     *  The percent norm.
+     */
     percentNorm: number | undefined;
+    /**
+     *
+     *  The NIHII number of the prescriber.
+     */
     prescriberNihii: string | undefined;
+    /**
+     *
+     *  A related code.
+     */
     relatedCode: string | undefined;
+    /**
+     *
+     *  The prescription date (yyyyMMdd).
+     */
     prescriptionDate: number | undefined;
+    /**
+     *
+     *  The maximum derogation number.
+     */
     derogationMaxNumber: number | undefined;
+    /**
+     *
+     *  The SSIN of the prescriber.
+     */
     prescriberSsin: string | undefined;
+    /**
+     *
+     *  The last name of the prescriber.
+     */
     prescriberLastName: string | undefined;
+    /**
+     *
+     *  The first name of the prescriber.
+     */
     prescriberFirstName: string | undefined;
+    /**
+     *
+     *  The CD-HCPARTY code of the prescriber.
+     */
     prescriberCdHcParty: string | undefined;
+    /**
+     *
+     *  The NIHII number of the location.
+     */
     locationNihii: string | undefined;
+    /**
+     *
+     *  The CD-HCPARTY code of the location.
+     */
     locationCdHcParty: string | undefined;
+    /**
+     *
+     *  The service code of the location.
+     */
     locationService: number | undefined;
+    /**
+     *
+     *  The admission date.
+     */
     admissionDate: number | undefined;
+    /**
+     *
+     *  Whether this code has been canceled.
+     */
     canceled: boolean | undefined;
+    /**
+     *
+     *  Whether this code has been accepted.
+     */
     accepted: boolean | undefined;
+    /**
+     *
+     *  Whether this code is pending.
+     */
     pending: boolean | undefined;
+    /**
+     *
+     *  Whether this code has been resent.
+     */
     resent: boolean | undefined;
+    /**
+     *
+     *  Whether this code has been archived.
+     */
     archived: boolean | undefined;
+    /**
+     *
+     *  Whether this code has been lost.
+     */
     lost: boolean | undefined;
+    /**
+     *
+     *  The insurance justification code.
+     */
     insuranceJustification: number | undefined;
+    /**
+     *
+     *  The reason for canceling patient intervention.
+     */
     cancelPatientInterventionReason: number | undefined;
+    /**
+     *
+     *  The status bitmask of this invoicing code.
+     */
     status: number | undefined;
+    /**
+     *
+     *  The label of the code.
+     */
     codeLabel: string | undefined;
+    /**
+     *
+     *  Additional options as key-value pairs.
+     */
     options: {
         [key: string]: string;
     };
+    /**
+     *
+     *  The base64-encoded encrypted content.
+     */
     encryptedSelf: Base64String | undefined;
     readonly isEncrypted: true;
     constructor(partial: Partial<EncryptedInvoicingCode> & Pick<EncryptedInvoicingCode, "id">);