@icure/api 4.0.72 → 4.0.76

package/icc-api/model/FilterChainCode.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 { AbstractFilterCode } from './AbstractFilterCode';
+import { Predicate } from './Predicate';
+export declare class FilterChainCode {
+    constructor(json: JSON | any);
+    filter?: AbstractFilterCode;
+    predicate?: Predicate;
+}

package/icc-api/model/FilterChainContact.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 { AbstractFilterContact } from './AbstractFilterContact';
+import { Predicate } from './Predicate';
+export declare class FilterChainContact {
+    constructor(json: JSON | any);
+    filter?: AbstractFilterContact;
+    predicate?: Predicate;
+}

package/icc-api/model/FilterChainHealthElement.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 { AbstractFilterHealthElement } from './AbstractFilterHealthElement';
+import { Predicate } from './Predicate';
+export declare class FilterChainHealthElement {
+    constructor(json: JSON | any);
+    filter?: AbstractFilterHealthElement;
+    predicate?: Predicate;
+}

package/icc-api/model/FilterChainInvoice.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 { AbstractFilterInvoice } from './AbstractFilterInvoice';
+import { Predicate } from './Predicate';
+export declare class FilterChainInvoice {
+    constructor(json: JSON | any);
+    filter?: AbstractFilterInvoice;
+    predicate?: Predicate;
+}

package/icc-api/model/FilterChainPatient.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 { AbstractFilterPatient } from './AbstractFilterPatient';
+import { Predicate } from './Predicate';
+export declare class FilterChainPatient {
+    constructor(json: JSON | any);
+    filter?: AbstractFilterPatient;
+    predicate?: Predicate;
+}

package/icc-api/model/FilterChainService.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 { AbstractFilterService } from './AbstractFilterService';
+import { Predicate } from './Predicate';
+export declare class FilterChainService {
+    constructor(json: JSON | any);
+    filter?: AbstractFilterService;
+    predicate?: Predicate;
+}

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

@@ -0,0 +1,28 @@
+/**
+ * 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.
+ */
+/**
+ * Financial information (Bank, bank account) used to reimburse the patient.
+ */
+export declare class FinancialInstitutionInformation {
+    constructor(json: JSON | any);
+    name?: string;
+    key?: string;
+    bankAccount?: string;
+    bic?: string;
+    proxyBankAccount?: string;
+    proxyBic?: string;
+    preferredFiiForPartners?: Array<string>;
+    /**
+     * 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/FlatRateTarification.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 { Valorisation } from './Valorisation';
+export declare class FlatRateTarification {
+    constructor(json: JSON | any);
+    code?: string;
+    flatRateType?: FlatRateTarification.FlatRateTypeEnum;
+    label?: {
+        [key: string]: string;
+    };
+    valorisations?: Array<Valorisation>;
+    /**
+     * The base64 encoded data of this object, formatted as JSON and encrypted in AES using the random master key from encryptionKeys.
+     */
+    encryptedSelf?: string;
+}
+export declare namespace FlatRateTarification {
+    type FlatRateTypeEnum = 'physician' | 'physiotherapist' | 'nurse' | 'ptd';
+    const FlatRateTypeEnum: {
+        Physician: FlatRateTypeEnum;
+        Physiotherapist: FlatRateTypeEnum;
+        Nurse: FlatRateTypeEnum;
+        Ptd: FlatRateTypeEnum;
+    };
+}

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

@@ -0,0 +1,45 @@
+/**
+ * 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 FlowItem {
+    constructor(json: JSON | any);
+    id?: string;
+    title?: string;
+    comment?: string;
+    receptionDate?: number;
+    processingDate?: number;
+    processer?: string;
+    cancellationDate?: number;
+    canceller?: string;
+    cancellationReason?: string;
+    cancellationNote?: string;
+    status?: string;
+    homeVisit?: boolean;
+    municipality?: string;
+    town?: string;
+    zipCode?: string;
+    street?: string;
+    building?: string;
+    buildingNumber?: string;
+    doorbellName?: string;
+    floor?: string;
+    letterBox?: string;
+    notesOps?: string;
+    notesContact?: string;
+    latitude?: string;
+    longitude?: string;
+    type?: string;
+    emergency?: boolean;
+    phoneNumber?: string;
+    patientId?: string;
+    patientLastName?: string;
+    patientFirstName?: string;
+}

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

@@ -0,0 +1,118 @@
+/**
+ * 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';
+export declare class Form {
+    constructor(json: JSON | any);
+    /**
+     * the Id of the form. We encourage using either a v4 UUID or a HL7 Id.
+     */
+    id?: string;
+    /**
+     * the revision of the form 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;
+    openingDate?: number;
+    status?: string;
+    version?: number;
+    logicalUuid?: string;
+    /**
+     * Name/basic description of the form
+     */
+    descr?: string;
+    /**
+     * A unique external id (from another external source).
+     */
+    uniqueId?: string;
+    /**
+     * Id of the form template being used to display the form
+     */
+    formTemplateId?: string;
+    /**
+     * Id of the contact for which the form is being used.
+     */
+    contactId?: string;
+    /**
+     * The healthcare element to which this form is attached.
+     */
+    healthElementId?: string;
+    /**
+     * The healthcare approach to which this form is attached.
+     */
+    planOfActionId?: string;
+    /**
+     * The parent of this form, used to determine the forms hierarchy
+     */
+    parent?: 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/FormColumn.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 { FormLayoutData } from './FormLayoutData';
+export declare class FormColumn {
+    constructor(json: JSON | any);
+    formDataList?: Array<FormLayoutData>;
+    columns?: string;
+    shouldDisplay?: boolean;
+}

package/icc-api/model/FormDataOption.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 FormDataOption {
+    constructor(json: JSON | any);
+    key?: string;
+    value?: string;
+}

package/icc-api/model/FormLayout.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.
+ */
+import { FormSection } from './FormSection';
+import { Tag } from './Tag';
+export declare class FormLayout {
+    constructor(json: JSON | any);
+    name?: string;
+    width?: number;
+    height?: number;
+    descr?: string;
+    tag?: Tag;
+    guid?: string;
+    group?: string;
+    sections?: Array<FormSection>;
+    importedServiceXPaths?: Array<string>;
+}

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

@@ -0,0 +1,42 @@
+/**
+ * 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 { Content } from './Content';
+import { Editor } from './Editor';
+import { FormDataOption } from './FormDataOption';
+import { FormPlanning } from './FormPlanning';
+import { Formula } from './Formula';
+import { GuiCode } from './GuiCode';
+import { GuiCodeType } from './GuiCodeType';
+import { Suggest } from './Suggest';
+export declare class FormLayoutData {
+    constructor(json: JSON | any);
+    subForm?: boolean;
+    irrelevant?: boolean;
+    determinesSscontactName?: boolean;
+    type?: string;
+    name?: string;
+    sortOrder?: number;
+    options?: {
+        [key: string]: FormDataOption;
+    };
+    descr?: string;
+    label?: string;
+    editor?: Editor;
+    defaultValue?: Array<Content>;
+    defaultStatus?: number;
+    suggest?: Array<Suggest>;
+    plannings?: Array<FormPlanning>;
+    tags?: Array<GuiCode>;
+    codes?: Array<GuiCode>;
+    codeTypes?: Array<GuiCodeType>;
+    formulas?: Array<Formula>;
+}

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

@@ -0,0 +1,22 @@
+/**
+ * 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 FormPlanning {
+    constructor(json: JSON | any);
+    planninfForAnyDoctor?: boolean;
+    planningForDelegate?: boolean;
+    planningForPatientDoctor?: boolean;
+    planningForMe?: boolean;
+    codedDelayInDays?: number;
+    repetitions?: number;
+    repetitionsUnit?: number;
+    descr?: string;
+}

package/icc-api/model/FormSection.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 { FormColumn } from './FormColumn';
+export declare class FormSection {
+    constructor(json: JSON | any);
+    icon?: string;
+    title?: string;
+    columns?: number;
+    formColumns?: Array<FormColumn>;
+}

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

@@ -0,0 +1,41 @@
+/**
+ * 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 { DocumentGroup } from './DocumentGroup';
+import { FormLayout } from './FormLayout';
+import { FormTemplateLayout } from './FormTemplateLayout';
+export declare class FormTemplate {
+    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;
+    layout?: FormLayout;
+    templateLayout?: FormTemplateLayout;
+    name?: string;
+    guid?: string;
+    group?: DocumentGroup;
+    descr?: string;
+    disabled?: string;
+    specialty?: CodeStub;
+    author?: string;
+    formInstancePreferredLocation?: string;
+    keyboardShortcut?: string;
+    shortReport?: string;
+    mediumReport?: string;
+    longReport?: string;
+    reports?: Array<string>;
+    tags?: Array<CodeStub>;
+    layoutAttachmentId?: string;
+}

package/icc-api/model/FormTemplateLayout.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 { Section } from './Section';
+export declare class FormTemplateLayout {
+    constructor(json: JSON | any);
+    form?: string;
+    sections?: Array<Section>;
+    description?: string;
+    keywords?: Array<string>;
+}