@icure/api 4.0.72 → 4.0.76

package/icc-api/model/TimeTableHour.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 TimeTableHour {
+    constructor(json: JSON | any);
+    startHour?: number;
+    endHour?: number;
+}

package/icc-api/model/TimeTableItem.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.
+ */
+import { TimeTableHour } from './TimeTableHour';
+export declare class TimeTableItem {
+    constructor(json: JSON | any);
+    days?: Array<string>;
+    hours?: Array<TimeTableHour>;
+    recurrenceTypes?: Array<string>;
+    calendarItemTypeId?: string;
+    homeVisit?: boolean;
+    placeId?: string;
+    unavailable?: boolean;
+}

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

@@ -0,0 +1,36 @@
+/**
+ * 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 TypedValueObject {
+    constructor(json: JSON | any);
+    type?: TypedValueObject.TypeEnum;
+    booleanValue?: boolean;
+    integerValue?: number;
+    doubleValue?: number;
+    stringValue?: string;
+    dateValue?: number;
+    /**
+     * 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 TypedValueObject {
+    type TypeEnum = 'BOOLEAN' | 'INTEGER' | 'DOUBLE' | 'STRING' | 'DATE' | 'CLOB' | 'JSON';
+    const TypeEnum: {
+        BOOLEAN: TypeEnum;
+        INTEGER: TypeEnum;
+        DOUBLE: TypeEnum;
+        STRING: TypeEnum;
+        DATE: TypeEnum;
+        CLOB: TypeEnum;
+        JSON: TypeEnum;
+    };
+}

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

@@ -0,0 +1,14 @@
+/**
+ * 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 Unit {
+    constructor(json: JSON | any);
+}

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

@@ -0,0 +1,126 @@
+/**
+ * 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 { AuthenticationToken } from './AuthenticationToken';
+import { Permission } from './Permission';
+import { PropertyStub } from './PropertyStub';
+/**
+ * This entity is a root level object. It represents an user that can log in to the iCure platform. It is serialized in JSON and saved in the underlying icure-base CouchDB database.
+ */
+export declare class User {
+    constructor(json: JSON | any);
+    /**
+     * the Id of the user. We encourage using either a v4 UUID or a HL7 Id.
+     */
+    id?: string;
+    /**
+     * the revision of the user in the database, used for conflict management / optimistic locking.
+     */
+    rev?: string;
+    /**
+     * hard delete (unix epoch in ms) timestamp of the object. Filled automatically when deletePatient is called.
+     */
+    deletionDate?: number;
+    created?: number;
+    /**
+     * Last name of the user. This is the official last name that should be used for official administrative purposes.
+     */
+    name?: string;
+    /**
+     * Extra properties for the user. Those properties are typed (see class Property)
+     */
+    properties?: Array<PropertyStub>;
+    /**
+     * If permission to modify patient data is granted or revoked
+     */
+    permissions?: Array<Permission>;
+    /**
+     * Roles specified for the user
+     */
+    roles?: Array<string>;
+    /**
+     * Authorization source for user. 'Database', 'ldap' or 'token'
+     */
+    type?: User.TypeEnum;
+    /**
+     * State of user's activeness: 'Active', 'Disabled' or 'Registering'
+     */
+    status?: User.StatusEnum;
+    /**
+     * Username for this user. We encourage using an email address
+     */
+    login?: string;
+    /**
+     * Hashed version of the password (BCrypt is used for hashing)
+     */
+    passwordHash?: string;
+    /**
+     * Secret token used to verify 2fa
+     */
+    secret?: string;
+    /**
+     * Whether the user has activated two factors authentication
+     */
+    use2fa?: boolean;
+    /**
+     * id of the group (practice/hospital) the user is member of
+     */
+    groupId?: string;
+    /**
+     * Id of the healthcare party if the user is a healthcare party.
+     */
+    healthcarePartyId?: string;
+    /**
+     * Id of the patient if the user is a patient
+     */
+    patientId?: string;
+    /**
+     * Delegations that are automatically generated client side when a new database object is created by this user
+     */
+    autoDelegations?: {
+        [key: string]: Array<string>;
+    };
+    /**
+     * the timestamp (unix epoch in ms) of creation of the user, will be filled automatically if missing. Not enforced by the application server.
+     */
+    createdDate?: number;
+    /**
+     * the timestamp (unix epoch in ms) of the latest validation of the terms of use of the application
+     */
+    termsOfUseDate?: number;
+    /**
+     * email address of the user.
+     */
+    email?: string;
+    applicationTokens?: {
+        [key: string]: string;
+    };
+    /**
+     * Encrypted and time-limited Authentication tokens used for inter-applications authentication
+     */
+    authenticationTokens?: {
+        [key: string]: AuthenticationToken;
+    };
+}
+export declare namespace User {
+    type TypeEnum = 'database' | 'ldap' | 'token';
+    const TypeEnum: {
+        Database: TypeEnum;
+        Ldap: TypeEnum;
+        Token: TypeEnum;
+    };
+    type StatusEnum = 'ACTIVE' | 'DISABLED' | 'REGISTERING';
+    const StatusEnum: {
+        ACTIVE: StatusEnum;
+        DISABLED: StatusEnum;
+        REGISTERING: StatusEnum;
+    };
+}

package/icc-api/model/UserGroup.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 UserGroup {
+    constructor(json: JSON | any);
+    groupId?: string;
+    userId?: string;
+    groupName?: string;
+}

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

@@ -0,0 +1,29 @@
+/**
+ * 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 Valorisation {
+    constructor(json: JSON | any);
+    startOfValidity?: number;
+    endOfValidity?: number;
+    predicate?: string;
+    totalAmount?: number;
+    reimbursement?: number;
+    patientIntervention?: number;
+    doctorSupplement?: number;
+    vat?: number;
+    label?: {
+        [key: string]: 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/VirtualForm.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 { CodeStub } from './CodeStub';
+import { SamText } from './SamText';
+export declare class VirtualForm {
+    constructor(json: JSON | any);
+    name?: SamText;
+    standardForms?: Array<CodeStub>;
+}

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

@@ -0,0 +1,29 @@
+/**
+ * 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 { StrengthRange } from './StrengthRange';
+import { SubstanceStub } from './SubstanceStub';
+export declare class VirtualIngredient {
+    constructor(json: JSON | any);
+    from?: number;
+    to?: number;
+    rank?: number;
+    type?: VirtualIngredient.TypeEnum;
+    strengthRange?: StrengthRange;
+    substance?: SubstanceStub;
+}
+export declare namespace VirtualIngredient {
+    type TypeEnum = 'ACTIVE_SUBSTANCE' | 'EXCIPIENT';
+    const TypeEnum: {
+        ACTIVESUBSTANCE: TypeEnum;
+        EXCIPIENT: TypeEnum;
+    };
+}

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

@@ -0,0 +1,36 @@
+/**
+ * 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 { CommentedClassification } from './CommentedClassification';
+import { SamText } from './SamText';
+import { VmpComponent } from './VmpComponent';
+import { VmpGroupStub } from './VmpGroupStub';
+import { Vtm } from './Vtm';
+import { Wada } from './Wada';
+export declare class Vmp {
+    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;
+    vmpGroup?: VmpGroupStub;
+    name?: SamText;
+    abbreviation?: SamText;
+    vtm?: Vtm;
+    wadas?: Array<Wada>;
+    components?: Array<VmpComponent>;
+    commentedClassifications?: Array<CommentedClassification>;
+}

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

@@ -0,0 +1,24 @@
+/**
+ * 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 { RouteOfAdministration } from './RouteOfAdministration';
+import { SamText } from './SamText';
+import { VirtualForm } from './VirtualForm';
+import { VirtualIngredient } from './VirtualIngredient';
+export declare class VmpComponent {
+    constructor(json: JSON | any);
+    code?: string;
+    virtualForm?: VirtualForm;
+    routeOfAdministrations?: Array<RouteOfAdministration>;
+    name?: SamText;
+    phaseNumber?: number;
+    virtualIngredients?: Array<VirtualIngredient>;
+}

package/icc-api/model/VmpGroup.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 { NoGenericPrescriptionReason } from './NoGenericPrescriptionReason';
+import { NoSwitchReason } from './NoSwitchReason';
+import { SamText } from './SamText';
+export declare class VmpGroup {
+    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;
+    productId?: string;
+    code?: string;
+    name?: SamText;
+    noGenericPrescriptionReason?: NoGenericPrescriptionReason;
+    noSwitchReason?: NoSwitchReason;
+}

package/icc-api/model/VmpGroupStub.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 VmpGroupStub {
+    constructor(json: JSON | any);
+    id?: string;
+    code?: string;
+    name?: SamText;
+    productId?: string;
+}

package/icc-api/model/VmpStub.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 { SamText } from './SamText';
+import { VmpGroupStub } from './VmpGroupStub';
+export declare class VmpStub {
+    constructor(json: JSON | any);
+    id?: string;
+    code?: string;
+    vmpGroup?: VmpGroupStub;
+    name?: SamText;
+}

package/icc-api/model/Vtm.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 Vtm {
+    constructor(json: JSON | any);
+    from?: number;
+    to?: number;
+    code?: string;
+    name?: SamText;
+}

package/icc-api/model/Wada.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 { SamText } from './SamText';
+export declare class Wada {
+    constructor(json: JSON | any);
+    code?: string;
+    name?: SamText;
+    description?: SamText;
+}

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

@@ -0,0 +1,24 @@
+/**
+ * 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 { WebSessionMaxIdleTime } from './WebSessionMaxIdleTime';
+export declare class WebSession {
+    constructor(json: JSON | any);
+    id?: string;
+    attributes?: {
+        [key: string]: any;
+    };
+    started?: boolean;
+    expired?: boolean;
+    creationTime?: number;
+    lastAccessTime?: number;
+    maxIdleTime?: WebSessionMaxIdleTime;
+}

package/icc-api/model/WebSessionMaxIdleTime.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 { WebSessionMaxIdleTimeUnits } from './WebSessionMaxIdleTimeUnits';
+export declare class WebSessionMaxIdleTime {
+    constructor(json: JSON | any);
+    seconds?: number;
+    units?: Array<WebSessionMaxIdleTimeUnits>;
+    zero?: boolean;
+    negative?: boolean;
+    nano?: number;
+}

package/icc-api/model/WebSessionMaxIdleTimeUnits.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 WebSessionMaxIdleTimeUnits {
+    constructor(json: JSON | any);
+    durationEstimated?: boolean;
+    dateBased?: boolean;
+    timeBased?: boolean;
+}