@icure/api 4.0.72 → 4.0.76

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

@@ -0,0 +1,27 @@
+/**
+ * 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 Formula {
+    constructor(json: JSON | any);
+    value?: string;
+    lifecycle?: Formula.LifecycleEnum;
+}
+export declare namespace Formula {
+    type LifecycleEnum = 'OnCreate' | 'OnLoad' | 'OnChange' | 'OnSave' | 'OnDestroy' | 'OnLoadPropertiesEditor';
+    const LifecycleEnum: {
+        OnCreate: LifecycleEnum;
+        OnLoad: LifecycleEnum;
+        OnChange: LifecycleEnum;
+        OnSave: LifecycleEnum;
+        OnDestroy: LifecycleEnum;
+        OnLoadPropertiesEditor: LifecycleEnum;
+    };
+}

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

@@ -0,0 +1,43 @@
+/**
+ * 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 { PropertyStub } from './PropertyStub';
+export declare class FrontEndMigration {
+    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;
+    name?: string;
+    startDate?: number;
+    endDate?: number;
+    status?: FrontEndMigration.StatusEnum;
+    logs?: string;
+    userId?: string;
+    startKey?: string;
+    startKeyDocId?: string;
+    processCount?: number;
+    /**
+     * Extra properties for the fem. Those properties are typed (see class Property)
+     */
+    properties?: Array<PropertyStub>;
+}
+export declare namespace FrontEndMigration {
+    type StatusEnum = 'STARTED' | 'PAUSED' | 'ERROR' | 'SUCCESS';
+    const StatusEnum: {
+        STARTED: StatusEnum;
+        PAUSED: StatusEnum;
+        ERROR: StatusEnum;
+        SUCCESS: StatusEnum;
+    };
+}

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

@@ -0,0 +1,51 @@
+/**
+ * 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 { PropertyStub } from './PropertyStub';
+/**
+ * This entity represents a group
+ */
+export declare class Group {
+    constructor(json: JSON | any);
+    /**
+     * The id of the group. We encourage using either a v4 UUID or a HL7 Id.
+     */
+    id?: string;
+    /**
+     * The revision of the group 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;
+    /**
+     * Username for the group
+     */
+    name?: string;
+    /**
+     * Password for the group access
+     */
+    password?: string;
+    /**
+     * List of servers accessible to the group
+     */
+    servers?: Array<string>;
+    /**
+     * Whether the group has a super admin permission, originally set to no access.
+     */
+    superAdmin?: boolean;
+    /**
+     * Extra properties for the user. Those properties are typed (see class Property)
+     */
+    properties?: Array<PropertyStub>;
+    superGroup?: string;
+}

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

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

@@ -0,0 +1,15 @@
+/**
+ * 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 GuiCodeType {
+    constructor(json: JSON | any);
+    type?: string;
+}

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

@@ -0,0 +1,159 @@
+/**
+ * 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 { CareTeamMember } from './CareTeamMember';
+import { CodeStub } from './CodeStub';
+import { Delegation } from './Delegation';
+import { Episode } from './Episode';
+import { PlanOfAction } from './PlanOfAction';
+/**
+ * This entity is a root level object. It represents a healthcare element. It is serialized in JSON and saved in the underlying CouchDB database.
+ */
+export declare class HealthElement {
+    constructor(json: JSON | any);
+    /**
+     * The Id of the healthcare element. We encourage using either a v4 UUID or a HL7 Id.
+     */
+    id?: string;
+    /**
+     * The revision of the patient 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;
+    /**
+     * The logical id of the healthcare element, used to link together different versions of the same healthcare element. We encourage using either a v4 UUID or a HL7 Id.
+     */
+    healthElementId?: string;
+    /**
+     * The date (unix epoch in ms) when the healthcare element is noted to have started and also closes on the same date
+     */
+    valueDate?: number;
+    /**
+     * The date (unix epoch in ms) of the start of the healthcare element.
+     */
+    openingDate?: number;
+    /**
+     * The date (unix epoch in ms) marking the end of the healthcare element.
+     */
+    closingDate?: number;
+    /**
+     * Description of the healthcare element.
+     */
+    descr?: string;
+    /**
+     * A text note (can be confidential, encrypted by default).
+     */
+    note?: string;
+    /**
+     * If the healthcare element is relevant or not (Set relevant by default).
+     */
+    relevant?: boolean;
+    /**
+     * Id of the opening contact when the healthcare element was created.
+     */
+    idOpeningContact?: string;
+    /**
+     * Id of the closing contact for the healthcare element.
+     */
+    idClosingContact?: string;
+    /**
+     * Id of the service when a service is used to create a healthcare element.
+     */
+    idService?: string;
+    /**
+     * bit 0: active/inactive, bit 1: relevant/irrelevant, bit 2 : present/absent, ex: 0 = active,relevant and present
+     */
+    status?: number;
+    /**
+     * Left or Right dominance/preference.
+     */
+    laterality?: HealthElement.LateralityEnum;
+    /**
+     * List of healthcare approaches.
+     */
+    plansOfAction?: Array<PlanOfAction>;
+    /**
+     * List of episodes of occurrences of the healthcare element.
+     */
+    episodes?: Array<Episode>;
+    /**
+     * List of care team members assigned for the healthcare element.
+     */
+    careTeam?: Array<CareTeamMember>;
+    /**
+     * 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;
+}
+export declare namespace HealthElement {
+    type LateralityEnum = 'left' | 'right';
+    const LateralityEnum: {
+        Left: LateralityEnum;
+        Right: LateralityEnum;
+    };
+}

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

@@ -0,0 +1,186 @@
+/**
+ * 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 { Address } from './Address';
+import { CodeStub } from './CodeStub';
+import { FinancialInstitutionInformation } from './FinancialInstitutionInformation';
+import { FlatRateTarification } from './FlatRateTarification';
+import { HealthcarePartyHistoryStatus } from './HealthcarePartyHistoryStatus';
+export declare class HealthcareParty {
+    constructor(json: JSON | any);
+    /**
+     * the Id of the healthcare party. We encourage using either a v4 UUID or a HL7 Id.
+     */
+    id?: string;
+    /**
+     * the revision of the healthcare party 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;
+    /**
+     * The full name of the healthcare party, used mainly when the healthcare party is an organization
+     */
+    name?: string;
+    /**
+     * the lastname (surname) of the healthcare party. This is the official lastname that should be used for official administrative purposes.
+     */
+    lastName?: string;
+    /**
+     * the firstname (name) of the healthcare party.
+     */
+    firstName?: string;
+    /**
+     * the gender of the healthcare party: male, female, indeterminate, changed, changedToMale, changedToFemale, unknown
+     */
+    gender?: HealthcareParty.GenderEnum;
+    /**
+     * Mr., Ms., Pr., Dr. ...
+     */
+    civility?: string;
+    /**
+     * The name of the company this healthcare party is member of
+     */
+    companyName?: string;
+    /**
+     * Medical specialty of the healthcare party
+     */
+    speciality?: string;
+    /**
+     * Bank Account identifier of the healhtcare party, IBAN, deprecated, use financial institutions instead
+     */
+    bankAccount?: string;
+    /**
+     * Bank Identifier Code, the SWIFT Address assigned to the bank, use financial institutions instead
+     */
+    bic?: string;
+    proxyBankAccount?: string;
+    proxyBic?: string;
+    /**
+     * All details included in the invoice header
+     */
+    invoiceHeader?: string;
+    /**
+     * Identifier number for institution type if the healthcare party is an enterprise
+     */
+    cbe?: string;
+    /**
+     * Identifier number for the institution if the healthcare party is an organization
+     */
+    ehp?: string;
+    /**
+     * The id of the user that usually handles this healthcare party.
+     */
+    userId?: string;
+    /**
+     * Id of parent of the user representing the healthcare party.
+     */
+    parentId?: string;
+    convention?: number;
+    /**
+     * National Institute for Health and Invalidity Insurance number assigned to healthcare parties (institution or person).
+     */
+    nihii?: string;
+    nihiiSpecCode?: string;
+    /**
+     * Social security inscription number.
+     */
+    ssin?: string;
+    /**
+     * The list of addresses (with address type).
+     */
+    addresses?: Array<Address>;
+    /**
+     * The list of languages spoken by the patient ordered by fluency (alpha-2 code http://www.loc.gov/standards/iso639-2/ascii_8bits.html).
+     */
+    languages?: Array<string>;
+    /**
+     * A picture usually saved in JPEG format.
+     */
+    picture?: ArrayBuffer;
+    /**
+     * The healthcare party's status: 'trainee' or 'withconvention' or 'accredited'
+     */
+    statuses?: Array<HealthcareParty.StatusesEnum>;
+    /**
+     * The healthcare party's status history
+     */
+    statusHistory?: Array<HealthcarePartyHistoryStatus>;
+    /**
+     * Medical specialty of the healthcare party codified using FHIR or Kmehr codificaiton scheme
+     */
+    specialityCodes?: Array<CodeStub>;
+    /**
+     * The type of format for contacting the healthcare party, ex: mobile, phone, email, etc.
+     */
+    sendFormats?: {
+        [key: string]: string;
+    };
+    /**
+     * Text notes.
+     */
+    notes?: string;
+    /**
+     * List of financial information (Bank, bank account).
+     */
+    financialInstitutionInformation?: Array<FinancialInstitutionInformation>;
+    /**
+     * The invoicing scheme this healthcare party adheres to : 'service fee' or 'flat rate'
+     */
+    billingType?: string;
+    type?: string;
+    contactPerson?: string;
+    contactPersonHcpId?: string;
+    supervisorId?: string;
+    flatRateTarifications?: Array<FlatRateTarification>;
+    importedData?: {
+        [key: string]: string;
+    };
+    options?: {
+        [key: string]: string;
+    };
+    /**
+     * For each couple of HcParties (delegator and delegate), this map contains the exchange AES key. The delegator is always this hcp, the key of the map is the id of the delegate. The AES exchange key is encrypted using RSA twice : once using this hcp public key (index 0 in the Array) and once using the other hcp public key (index 1 in the Array). For a pair of HcParties. Each HcParty always has one AES exchange key for himself.
+     */
+    hcPartyKeys?: {
+        [key: string]: Array<string>;
+    };
+    /**
+     * The privateKeyShamirPartitions are used to share this hcp's private RSA key with a series of other hcParties using Shamir's algorithm. The key of the map is the hcp Id with whom this partition has been shared. The value is \"threshold⎮partition in hex\" encrypted using the the partition's holder's public RSA key
+     */
+    privateKeyShamirPartitions?: {
+        [key: string]: string;
+    };
+    /**
+     * The public key of this hcp
+     */
+    publicKey?: string;
+}
+export declare namespace HealthcareParty {
+    type GenderEnum = 'male' | 'female' | 'indeterminate' | 'changed' | 'changedToMale' | 'changedToFemale' | 'unknown';
+    const GenderEnum: {
+        Male: GenderEnum;
+        Female: GenderEnum;
+        Indeterminate: GenderEnum;
+        Changed: GenderEnum;
+        ChangedToMale: GenderEnum;
+        ChangedToFemale: GenderEnum;
+        Unknown: GenderEnum;
+    };
+    type StatusesEnum = 'trainee' | 'withconvention' | 'accreditated';
+    const StatusesEnum: {
+        Trainee: StatusesEnum;
+        Withconvention: StatusesEnum;
+        Accreditated: StatusesEnum;
+    };
+}

package/icc-api/model/HealthcareParty.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HealthcareParty.js","sourceRoot":"","sources":["../../../icc-api/model/HealthcareParty.ts"],"names":[],"mappings":";;;AAiBA;;GAEG;AACH,+CAAuC;AACvC,MAAa,eAAe;IAC1B,YAAY,IAAgB;QAC1B,MAAM,CAAC,MAAM,CAAC,IAAuB,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,qBAAO,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;IACtG,CAAC;CA6IF;AAhJD,0CAgJC;AACD,WAAiB,eAAe;IAEjB,0BAAU,GAAG;QACxB,IAAI,EAAE,MAAoB;QAC1B,MAAM,EAAE,QAAsB;QAC9B,aAAa,EAAE,eAA6B;QAC5C,OAAO,EAAE,SAAuB;QAChC,aAAa,EAAE,eAA6B;QAC5C,eAAe,EAAE,iBAA+B;QAChD,OAAO,EAAE,SAAuB;KACjC,CAAA;IAEY,4BAAY,GAAG;QAC1B,OAAO,EAAE,SAAyB;QAClC,cAAc,EAAE,gBAAgC;QAChD,YAAY,EAAE,cAA8B;KAC7C,CAAA;AACH,CAAC,EAjBgB,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAiB/B"}

package/icc-api/model/HealthcarePartyHistoryStatus.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.
+ */
+/**
+ * The healthcare party's status history
+ */
+export declare class HealthcarePartyHistoryStatus {
+    constructor(json: JSON | any);
+    status?: HealthcarePartyHistoryStatus.StatusEnum;
+    specialisationCode?: string;
+    startDate?: number;
+    active?: boolean;
+}
+export declare namespace HealthcarePartyHistoryStatus {
+    type StatusEnum = 'trainee' | 'withconvention' | 'accreditated';
+    const StatusEnum: {
+        Trainee: StatusEnum;
+        Withconvention: StatusEnum;
+        Accreditated: StatusEnum;
+    };
+}

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

@@ -0,0 +1,76 @@
+/**
+ * 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 IcureStub {
+    constructor(json: JSON | any);
+    id?: string;
+    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;
+    /**
+     * 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/IdWithRev.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 IdWithRev {
+    constructor(json: JSON | any);
+    id?: string;
+    rev?: string;
+}