@icure/api 4.0.72 → 4.0.76

package/icc-api/model/Message.d.ts

@@ -0,0 +1,155 @@
+/**
+ * iCure Data Stack API Documentation
+ * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.
+ *
+ * OpenAPI spec version: v1
+ *
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ */
+import { CodeStub } from './CodeStub';
+import { Delegation } from './Delegation';
+import { MessageReadStatus } from './MessageReadStatus';
+/**
+ * This entity is a root level object. It represents a Message. It is serialized in JSON and saved in the underlying CouchDB database.
+ */
+export declare class Message {
+    constructor(json: JSON | any);
+    /**
+     * The ID of the message. We encourage using either a v4 UUID or a HL7 Id.
+     */
+    id?: string;
+    /**
+     * The revision of the message in the database, used for conflict management / optimistic locking.
+     */
+    rev?: string;
+    /**
+     * The timestamp (unix epoch in ms) of creation of this entity, will be filled automatically if missing. Not enforced by the application server.
+     */
+    created?: number;
+    /**
+     * The date (unix epoch in ms) of the latest modification of this entity, will be filled automatically if missing. Not enforced by the application server.
+     */
+    modified?: number;
+    /**
+     * The id of the User that has created this entity, will be filled automatically if missing. Not enforced by the application server.
+     */
+    author?: string;
+    /**
+     * The id of the HealthcareParty that is responsible for this entity, will be filled automatically if missing. Not enforced by the application server.
+     */
+    responsible?: string;
+    /**
+     * The id of the medical location where this entity was created.
+     */
+    medicalLocationId?: string;
+    /**
+     * A tag is an item from a codification system that qualifies an entity as being member of a certain class, whatever the value it might have taken. If the tag qualifies the content of a field, it means that whatever the content of the field, the tag will always apply. For example, the label of a field is qualified using a tag. LOINC is a codification system typically used for tags.
+     */
+    tags?: Array<CodeStub>;
+    /**
+     * A code is an item from a codification system that qualifies the content of this entity. SNOMED-CT, ICPC-2 or ICD-10 codifications systems can be used for codes
+     */
+    codes?: Array<CodeStub>;
+    /**
+     * Soft delete (unix epoch in ms) timestamp of the object.
+     */
+    endOfLife?: number;
+    /**
+     * hard delete (unix epoch in ms) timestamp of the object. Filled automatically when deletePatient is called.
+     */
+    deletionDate?: number;
+    /**
+     * Address of the sender of the message
+     */
+    fromAddress?: string;
+    /**
+     * ID of the healthcare party sending the message
+     */
+    fromHealthcarePartyId?: string;
+    formId?: string;
+    /**
+     * Status of the message
+     */
+    status?: number;
+    /**
+     * The type of user who is the recipient of this message
+     */
+    recipientsType?: string;
+    /**
+     * List of IDs of healthcare parties to whom the message is addressed
+     */
+    recipients?: Array<string>;
+    /**
+     * The address of the recipient of the message. Format is of an email address with extra domains defined for mycarenet and ehealth: (efact.mycarenet.be/eattest.mycarenet.be/chapter4.mycarenet.be/ehbox.ehealth.fgov.be)
+     */
+    toAddresses?: Array<string>;
+    /**
+     * The timestamp (unix epoch in ms) when the message was received
+     */
+    received?: number;
+    /**
+     * The timestamp (unix epoch in ms) when the message was sent
+     */
+    sent?: number;
+    metas?: {
+        [key: string]: string;
+    };
+    /**
+     * Status showing whether the message is read or not and the time of reading
+     */
+    readStatus?: {
+        [key: string]: MessageReadStatus;
+    };
+    transportGuid?: string;
+    remark?: string;
+    conversationGuid?: string;
+    /**
+     * Subject for the message
+     */
+    subject?: string;
+    /**
+     * Set of IDs for invoices in the message
+     */
+    invoiceIds?: Array<string>;
+    /**
+     * ID of a parent in a message conversation
+     */
+    parentId?: string;
+    externalRef?: string;
+    unassignedResults?: Array<string>;
+    assignedResults?: {
+        [key: string]: string;
+    };
+    senderReferences?: {
+        [key: string]: string;
+    };
+    /**
+     * The secretForeignKeys are filled at the to many end of a one to many relationship (for example inside Contact for the Patient -> Contacts relationship). Used when we want to find all contacts for a specific patient. These keys are in clear. You can have several to partition the medical document space.
+     */
+    secretForeignKeys?: Array<string>;
+    /**
+     * The secretForeignKeys are filled at the to many end of a one to many relationship (for example inside Contact for the Patient -> Contacts relationship). Used when we want to find the patient for a specific contact. These keys are the encrypted id (using the hcParty key for the delegate) that can be found in clear inside the patient. ids encrypted using the hcParty keys.
+     */
+    cryptedForeignKeys?: {
+        [key: string]: Array<Delegation>;
+    };
+    /**
+     * When a document is created, the responsible generates a cryptographically random master key (never to be used for something else than referencing from other entities). He/she encrypts it using his own AES exchange key and stores it as a delegation. The responsible is thus always in the delegations as well
+     */
+    delegations?: {
+        [key: string]: Array<Delegation>;
+    };
+    /**
+     * When a document needs to be encrypted, the responsible generates a cryptographically random master key (different from the delegation key, never to appear in clear anywhere in the db. He/she encrypts it using his own AES exchange key and stores it as a delegation
+     */
+    encryptionKeys?: {
+        [key: string]: Array<Delegation>;
+    };
+    /**
+     * The base64 encoded data of this object, formatted as JSON and encrypted in AES using the random master key from encryptionKeys.
+     */
+    encryptedSelf?: string;
+}

package/icc-api/model/MessageReadStatus.d.ts

@@ -0,0 +1,19 @@
+/**
+ * iCure Data Stack API Documentation
+ * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.
+ *
+ * OpenAPI spec version: v1
+ *
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ */
+/**
+ * Status showing whether the message is read or not and the time of reading
+ */
+export declare class MessageReadStatus {
+    constructor(json: JSON | any);
+    time?: number;
+    read?: boolean;
+}

package/icc-api/model/MessageWithBatch.d.ts

@@ -0,0 +1,18 @@
+/**
+ * iCure Data Stack API Documentation
+ * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.
+ *
+ * OpenAPI spec version: v1
+ *
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ */
+import { InvoicesBatch } from './InvoicesBatch';
+import { Message } from './Message';
+export declare class MessageWithBatch {
+    constructor(json: JSON | any);
+    invoicesBatch?: InvoicesBatch;
+    message?: Message;
+}

package/icc-api/model/MessagesReadStatusUpdate.d.ts

@@ -0,0 +1,18 @@
+/**
+ * iCure Data Stack API Documentation
+ * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.
+ *
+ * OpenAPI spec version: v1
+ *
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ */
+export declare class MessagesReadStatusUpdate {
+    constructor(json: JSON | any);
+    ids?: Array<string>;
+    time?: number;
+    status?: boolean;
+    userId?: string;
+}

package/icc-api/model/MikronoAppointmentTypeRest.d.ts

@@ -0,0 +1,25 @@
+/**
+ * iCure Data Stack API Documentation
+ * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.
+ *
+ * OpenAPI spec version: v1
+ *
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ */
+export declare class MikronoAppointmentTypeRest {
+    constructor(json: JSON | any);
+    color?: string;
+    durationInMinutes?: number;
+    externalRef?: string;
+    mikronoId?: string;
+    docIds?: Array<string>;
+    otherInfos?: {
+        [key: string]: string;
+    };
+    subjectByLanguage?: {
+        [key: string]: string;
+    };
+}

package/icc-api/model/MikronoCredentials.d.ts

@@ -0,0 +1,17 @@
+/**
+ * iCure Data Stack API Documentation
+ * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.
+ *
+ * OpenAPI spec version: v1
+ *
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ */
+export declare class MikronoCredentials {
+    constructor(json: JSON | any);
+    user?: string;
+    password?: string;
+    serverUrl?: string;
+}

package/icc-api/model/MimeAttachment.d.ts

@@ -0,0 +1,17 @@
+/**
+ * iCure Data Stack API Documentation
+ * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.
+ *
+ * OpenAPI spec version: v1
+ *
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ */
+export declare class MimeAttachment {
+    constructor(json: JSON | any);
+    data?: ArrayBuffer;
+    fileName?: string;
+    mimeType?: string;
+}

package/icc-api/model/ModelHelper.d.ts

@@ -0,0 +1 @@
+export declare function b64_2ab(v: any): any;

package/icc-api/model/Nmp.d.ts

@@ -0,0 +1,30 @@
+/**
+ * iCure Data Stack API Documentation
+ * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.
+ *
+ * OpenAPI spec version: v1
+ *
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ */
+import { SamText } from './SamText';
+export declare class Nmp {
+    constructor(json: JSON | any);
+    id?: string;
+    rev?: string;
+    /**
+     * hard delete (unix epoch in ms) timestamp of the object. Filled automatically when deletePatient is called.
+     */
+    deletionDate?: number;
+    from?: number;
+    to?: number;
+    code?: string;
+    productId?: string;
+    category?: string;
+    commercialStatus?: string;
+    name?: SamText;
+    producer?: SamText;
+    distributor?: SamText;
+}

package/icc-api/model/NoGenericPrescriptionReason.d.ts

@@ -0,0 +1,17 @@
+/**
+ * iCure Data Stack API Documentation
+ * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.
+ *
+ * OpenAPI spec version: v1
+ *
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ */
+import { SamText } from './SamText';
+export declare class NoGenericPrescriptionReason {
+    constructor(json: JSON | any);
+    code?: string;
+    description?: SamText;
+}

package/icc-api/model/NoSwitchReason.d.ts

@@ -0,0 +1,17 @@
+/**
+ * iCure Data Stack API Documentation
+ * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.
+ *
+ * OpenAPI spec version: v1
+ *
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ */
+import { SamText } from './SamText';
+export declare class NoSwitchReason {
+    constructor(json: JSON | any);
+    code?: string;
+    description?: SamText;
+}

package/icc-api/model/NumeratorRange.d.ts

@@ -0,0 +1,17 @@
+/**
+ * iCure Data Stack API Documentation
+ * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.
+ *
+ * OpenAPI spec version: v1
+ *
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ */
+export declare class NumeratorRange {
+    constructor(json: JSON | any);
+    min?: number;
+    max?: number;
+    unit?: string;
+}

package/icc-api/model/PackagingType.d.ts

@@ -0,0 +1,19 @@
+/**
+ * iCure Data Stack API Documentation
+ * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.
+ *
+ * OpenAPI spec version: v1
+ *
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ */
+import { SamText } from './SamText';
+export declare class PackagingType {
+    constructor(json: JSON | any);
+    code?: string;
+    name?: SamText;
+    edqmCode?: string;
+    edqmDefinition?: string;
+}

package/icc-api/model/PaginatedDocumentKeyIdPairObject.d.ts

@@ -0,0 +1,16 @@
+/**
+ * iCure Data Stack API Documentation
+ * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.
+ *
+ * OpenAPI spec version: v1
+ *
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ */
+export declare class PaginatedDocumentKeyIdPairObject {
+    constructor(json: JSON | any);
+    startKey?: any;
+    startKeyDocId?: string;
+}

package/icc-api/model/PaginatedListAccessLog.d.ts

@@ -0,0 +1,20 @@
+/**
+ * iCure Data Stack API Documentation
+ * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.
+ *
+ * OpenAPI spec version: v1
+ *
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ */
+import { AccessLog } from './AccessLog';
+import { PaginatedDocumentKeyIdPairObject } from './PaginatedDocumentKeyIdPairObject';
+export declare class PaginatedListAccessLog {
+    constructor(json: JSON | any);
+    pageSize?: number;
+    totalSize?: number;
+    rows?: Array<AccessLog>;
+    nextKeyPair?: PaginatedDocumentKeyIdPairObject;
+}

package/icc-api/model/PaginatedListAmp.d.ts

@@ -0,0 +1,20 @@
+/**
+ * iCure Data Stack API Documentation
+ * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.
+ *
+ * OpenAPI spec version: v1
+ *
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ */
+import { Amp } from './Amp';
+import { PaginatedDocumentKeyIdPairObject } from './PaginatedDocumentKeyIdPairObject';
+export declare class PaginatedListAmp {
+    constructor(json: JSON | any);
+    pageSize?: number;
+    totalSize?: number;
+    rows?: Array<Amp>;
+    nextKeyPair?: PaginatedDocumentKeyIdPairObject;
+}

package/icc-api/model/PaginatedListClassification.d.ts

@@ -0,0 +1,20 @@
+/**
+ * iCure Data Stack API Documentation
+ * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.
+ *
+ * OpenAPI spec version: v1
+ *
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ */
+import { Classification } from './Classification';
+import { PaginatedDocumentKeyIdPairObject } from './PaginatedDocumentKeyIdPairObject';
+export declare class PaginatedListClassification {
+    constructor(json: JSON | any);
+    pageSize?: number;
+    totalSize?: number;
+    rows?: Array<Classification>;
+    nextKeyPair?: PaginatedDocumentKeyIdPairObject;
+}

package/icc-api/model/PaginatedListClassificationTemplate.d.ts

@@ -0,0 +1,20 @@
+/**
+ * iCure Data Stack API Documentation
+ * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.
+ *
+ * OpenAPI spec version: v1
+ *
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ */
+import { ClassificationTemplate } from './ClassificationTemplate';
+import { PaginatedDocumentKeyIdPairObject } from './PaginatedDocumentKeyIdPairObject';
+export declare class PaginatedListClassificationTemplate {
+    constructor(json: JSON | any);
+    pageSize?: number;
+    totalSize?: number;
+    rows?: Array<ClassificationTemplate>;
+    nextKeyPair?: PaginatedDocumentKeyIdPairObject;
+}

package/icc-api/model/PaginatedListCode.d.ts

@@ -0,0 +1,20 @@
+/**
+ * iCure Data Stack API Documentation
+ * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.
+ *
+ * OpenAPI spec version: v1
+ *
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ */
+import { Code } from './Code';
+import { PaginatedDocumentKeyIdPairObject } from './PaginatedDocumentKeyIdPairObject';
+export declare class PaginatedListCode {
+    constructor(json: JSON | any);
+    pageSize?: number;
+    totalSize?: number;
+    rows?: Array<Code>;
+    nextKeyPair?: PaginatedDocumentKeyIdPairObject;
+}

package/icc-api/model/PaginatedListContact.d.ts

@@ -0,0 +1,20 @@
+/**
+ * iCure Data Stack API Documentation
+ * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.
+ *
+ * OpenAPI spec version: v1
+ *
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ */
+import { Contact } from './Contact';
+import { PaginatedDocumentKeyIdPairObject } from './PaginatedDocumentKeyIdPairObject';
+export declare class PaginatedListContact {
+    constructor(json: JSON | any);
+    pageSize?: number;
+    totalSize?: number;
+    rows?: Array<Contact>;
+    nextKeyPair?: PaginatedDocumentKeyIdPairObject;
+}

package/icc-api/model/PaginatedListDocument.d.ts

@@ -0,0 +1,20 @@
+/**
+ * iCure Data Stack API Documentation
+ * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.
+ *
+ * OpenAPI spec version: v1
+ *
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ */
+import { Document } from './Document';
+import { PaginatedDocumentKeyIdPairObject } from './PaginatedDocumentKeyIdPairObject';
+export declare class PaginatedListDocument {
+    constructor(json: JSON | any);
+    pageSize?: number;
+    totalSize?: number;
+    rows?: Array<Document>;
+    nextKeyPair?: PaginatedDocumentKeyIdPairObject;
+}