@icure/api 4.0.72 → 4.0.76

package/icc-api/api/IccInvoiceApi.d.ts

@@ -0,0 +1,249 @@
+/**
+ * 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 { XHR } from './XHR';
+import { Delegation } from '../model/Delegation';
+import { DocIdentifier } from '../model/DocIdentifier';
+import { FilterChainInvoice } from '../model/FilterChainInvoice';
+import { IcureStub } from '../model/IcureStub';
+import { Invoice } from '../model/Invoice';
+import { InvoicingCode } from '../model/InvoicingCode';
+import { LabelledOccurence } from '../model/LabelledOccurence';
+import { ListOfIds } from '../model/ListOfIds';
+import { PaginatedListInvoice } from '../model/PaginatedListInvoice';
+export declare class IccInvoiceApi {
+    host: string;
+    headers: Array<XHR.Header>;
+    fetchImpl?: (input: RequestInfo, init?: RequestInit) => Promise<Response>;
+    constructor(host: string, headers: any, fetchImpl?: (input: RequestInfo, init?: RequestInit) => Promise<Response>);
+    setHeaders(h: Array<XHR.Header>): void;
+    handleError(e: XHR.XHRError): never;
+    /**
+     *
+     * @summary Gets all invoices for author at date
+     * @param body
+     * @param userId
+     * @param type
+     * @param sentMediumType
+     * @param secretFKeys
+     * @param insuranceId
+     * @param invoiceId
+     * @param gracePeriod
+     */
+    appendCodes(userId: string, type: string, sentMediumType: string, secretFKeys: string, insuranceId?: string, invoiceId?: string, gracePeriod?: number, body?: Array<InvoicingCode>): Promise<Array<Invoice>>;
+    /**
+     *
+     * @summary Creates an invoice
+     * @param body
+     */
+    createInvoice(body?: Invoice): Promise<Invoice>;
+    /**
+     * Returns the created invoices.
+     * @summary Create a batch of invoices
+     * @param body
+     */
+    createInvoices(body?: Array<Invoice>): Promise<Array<Invoice>>;
+    /**
+     *
+     * @summary Deletes an invoice
+     * @param invoiceId
+     */
+    deleteInvoice(invoiceId: string): Promise<DocIdentifier>;
+    /**
+     * Returns a list of invoices along with next start keys and Document ID. If the nextStartKey is Null it means that this is the last page.
+     * @summary Filter invoices for the current user (HcParty)
+     * @param body
+     */
+    filterInvoicesBy(body?: FilterChainInvoice): Promise<Array<Invoice>>;
+    /**
+     *
+     * @summary Gets all invoices for author at date
+     * @param hcPartyId
+     * @param fromDate
+     * @param toDate
+     * @param startKey The start key for pagination: a JSON representation of an array containing all the necessary components to form the Complex Key&#x27;s startKey
+     * @param startDocumentId A patient document ID
+     * @param limit Number of rows
+     */
+    findByAuthor(hcPartyId: string, fromDate?: number, toDate?: number, startKey?: string, startDocumentId?: string, limit?: number): Promise<PaginatedListInvoice>;
+    /**
+     * Keys have to delimited by coma
+     * @summary List invoices found By Healthcare Party and secret foreign patient keys.
+     * @param hcPartyId
+     * @param secretFKeys
+     */
+    findInvoicesByHCPartyPatientForeignKeys(hcPartyId: string, secretFKeys: string): Promise<Array<Invoice>>;
+    /**
+     * Keys must be delimited by coma
+     * @summary List helement stubs found By Healthcare Party and secret foreign keys.
+     * @param hcPartyId
+     * @param secretFKeys
+     */
+    findInvoicesDelegationsStubsByHCPartyPatientForeignKeys(hcPartyId: string, secretFKeys: string): Promise<Array<IcureStub>>;
+    /**
+     *
+     * @summary Gets an invoice
+     * @param invoiceId
+     */
+    getInvoice(invoiceId: string): Promise<Invoice>;
+    /**
+     *
+     * @summary Gets an invoice
+     * @param body
+     */
+    getInvoices(body?: ListOfIds): Promise<Array<Invoice>>;
+    /**
+     *
+     * @summary Get the list of all used tarifications frequencies in invoices
+     * @param minOccurences
+     */
+    getTarificationsCodesOccurences(minOccurences: number): Promise<Array<LabelledOccurence>>;
+    /**
+     *
+     * @summary Gets all invoices per status
+     * @param body
+     * @param status
+     * @param from
+     * @param to
+     */
+    listAllHcpsByStatus(status: string, from?: number, to?: number, body?: ListOfIds): Promise<Array<Invoice>>;
+    /**
+     *
+     * @summary Gets all invoices for author at date
+     * @param body
+     */
+    listByContactIds(body?: ListOfIds): Promise<Array<Invoice>>;
+    /**
+     * Keys have to delimited by coma
+     * @summary List invoices by groupId
+     * @param hcPartyId
+     * @param groupId
+     */
+    listByHcPartyGroupId(hcPartyId: string, groupId: string): Promise<Array<Invoice>>;
+    /**
+     * Keys have to delimited by coma
+     * @summary List invoices by type, sent or unsent
+     * @param hcPartyId
+     * @param sentMediumType
+     * @param invoiceType
+     * @param sent
+     * @param from
+     * @param to
+     */
+    listByHcPartySentMediumTypeInvoiceTypeSentDate(hcPartyId: string, sentMediumType: string, invoiceType: string, sent: boolean, from?: number, to?: number): Promise<Array<Invoice>>;
+    /**
+     *
+     * @summary Get all invoices by author, by sending mode, by status and by date
+     * @param hcPartyId
+     * @param sendingMode
+     * @param status
+     * @param from
+     * @param to
+     */
+    listByHcpartySendingModeStatusDate(hcPartyId: string, sendingMode?: string, status?: string, from?: number, to?: number): Promise<Array<Invoice>>;
+    /**
+     *
+     * @summary Gets all invoices for author at date
+     * @param invoiceIds
+     */
+    listByIds(invoiceIds: string): Promise<Array<Invoice>>;
+    /**
+     *
+     * @summary Gets all invoices for author at date
+     * @param recipientIds
+     */
+    listByRecipientsIds(recipientIds: string): Promise<Array<Invoice>>;
+    /**
+     *
+     * @summary Gets all invoices for author at date
+     * @param serviceIds
+     */
+    listByServiceIds(serviceIds: string): Promise<Array<Invoice>>;
+    /**
+     *
+     * @summary Gets all invoices for author at date
+     * @param userIds
+     */
+    listToInsurances(userIds?: string): Promise<Array<Invoice>>;
+    /**
+     *
+     * @summary Gets all invoices for author at date
+     * @param userIds
+     */
+    listToInsurancesUnsent(userIds?: string): Promise<Array<Invoice>>;
+    /**
+     *
+     * @summary Gets all invoices for author at date
+     * @param hcPartyId
+     */
+    listToPatients(hcPartyId?: string): Promise<Array<Invoice>>;
+    /**
+     *
+     * @summary Gets all invoices for author at date
+     * @param hcPartyId
+     */
+    listToPatientsUnsent(hcPartyId?: string): Promise<Array<Invoice>>;
+    /**
+     *
+     * @summary Gets all invoices for author at date
+     * @param body
+     * @param invoiceId
+     */
+    mergeTo(invoiceId: string, body?: ListOfIds): Promise<Invoice>;
+    /**
+     *
+     * @summary Modifies an invoice
+     * @param body
+     */
+    modifyInvoice(body?: Invoice): Promise<Invoice>;
+    /**
+     * Returns the modified invoices.
+     * @summary Modify a batch of invoices
+     * @param body
+     */
+    modifyInvoices(body?: Array<Invoice>): Promise<Array<Invoice>>;
+    /**
+     *
+     * @summary Adds a delegation to a invoice
+     * @param body
+     * @param invoiceId
+     */
+    newInvoiceDelegations(invoiceId: string, body?: Array<Delegation>): Promise<Invoice>;
+    /**
+     *
+     * @summary Modifies an invoice
+     * @param body
+     */
+    reassignInvoice(body?: Invoice): Promise<Invoice>;
+    /**
+     *
+     * @summary Gets all invoices for author at date
+     * @param body
+     * @param userId
+     * @param serviceId
+     * @param secretFKeys
+     */
+    removeCodes(userId: string, serviceId: string, secretFKeys: string, body?: Array<string>): Promise<Array<Invoice>>;
+    /**
+     * Keys must be delimited by coma
+     * @summary Update delegations in healthElements.
+     * @param body
+     */
+    setInvoicesDelegations(body?: Array<IcureStub>): Promise<Array<IcureStub>>;
+    /**
+     *
+     * @summary Gets all invoices for author at date
+     * @param invoiceId
+     * @param scheme
+     * @param forcedValue
+     */
+    validate(invoiceId: string, scheme: string, forcedValue: string): Promise<Invoice>;
+}

package/icc-api/api/IccKeywordApi.d.ts

@@ -0,0 +1,57 @@
+/**
+ * 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 { XHR } from './XHR';
+import { DocIdentifier } from '../model/DocIdentifier';
+import { Keyword } from '../model/Keyword';
+export declare class IccKeywordApi {
+    host: string;
+    headers: Array<XHR.Header>;
+    fetchImpl?: (input: RequestInfo, init?: RequestInit) => Promise<Response>;
+    constructor(host: string, headers: any, fetchImpl?: (input: RequestInfo, init?: RequestInit) => Promise<Response>);
+    setHeaders(h: Array<XHR.Header>): void;
+    handleError(e: XHR.XHRError): never;
+    /**
+     * Returns an instance of created keyword.
+     * @summary Create a keyword with the current user
+     * @param body
+     */
+    createKeyword(body?: Keyword): Promise<Keyword>;
+    /**
+     * Response is a set containing the ID's of deleted keywords.
+     * @summary Delete keywords.
+     * @param keywordIds
+     */
+    deleteKeywords(keywordIds: string): Promise<Array<DocIdentifier>>;
+    /**
+     *
+     * @summary Get a keyword
+     * @param keywordId
+     */
+    getKeyword(keywordId: string): Promise<Keyword>;
+    /**
+     *
+     * @summary Gets all keywords
+     */
+    getKeywords(): Promise<Array<Keyword>>;
+    /**
+     *
+     * @summary Get keywords by user
+     * @param userId
+     */
+    getKeywordsByUser(userId: string): Promise<Array<Keyword>>;
+    /**
+     * Returns the modified keyword.
+     * @summary Modify a keyword
+     * @param body
+     */
+    modifyKeyword(body?: Keyword): Promise<Keyword>;
+}

package/icc-api/api/IccMedexApi.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.
+ */
+import { XHR } from './XHR';
+import { MedexInfo } from '../model/MedexInfo';
+export declare class IccMedexApi {
+    host: string;
+    headers: Array<XHR.Header>;
+    fetchImpl?: (input: RequestInfo, init?: RequestInit) => Promise<Response>;
+    constructor(host: string, headers: any, fetchImpl?: (input: RequestInfo, init?: RequestInit) => Promise<Response>);
+    setHeaders(h: Array<XHR.Header>): void;
+    handleError(e: XHR.XHRError): never;
+    /**
+     *
+     * @summary Generate a Medex XML String
+     * @param body
+     */
+    generateMedex(body?: MedexInfo): Promise<string>;
+}

package/icc-api/api/IccMedicallocationApi.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 { XHR } from './XHR';
+import { DocIdentifier } from '../model/DocIdentifier';
+import { MedicalLocation } from '../model/MedicalLocation';
+export declare class IccMedicallocationApi {
+    host: string;
+    headers: Array<XHR.Header>;
+    fetchImpl?: (input: RequestInfo, init?: RequestInit) => Promise<Response>;
+    constructor(host: string, headers: any, fetchImpl?: (input: RequestInfo, init?: RequestInit) => Promise<Response>);
+    setHeaders(h: Array<XHR.Header>): void;
+    handleError(e: XHR.XHRError): never;
+    /**
+     *
+     * @summary Creates a medical location
+     * @param body
+     */
+    createMedicalLocation(body?: MedicalLocation): Promise<MedicalLocation>;
+    /**
+     *
+     * @summary Deletes a medical location
+     * @param locationIds
+     */
+    deleteMedicalLocation(locationIds: string): Promise<Array<DocIdentifier>>;
+    /**
+     *
+     * @summary Gets a medical location
+     * @param locationId
+     */
+    getMedicalLocation(locationId: string): Promise<MedicalLocation>;
+    /**
+     *
+     * @summary Gets all medical locations
+     */
+    getMedicalLocations(): Promise<Array<MedicalLocation>>;
+    /**
+     *
+     * @summary Modifies a medical location
+     * @param body
+     */
+    modifyMedicalLocation(body?: MedicalLocation): Promise<MedicalLocation>;
+}

package/icc-api/api/IccMessageApi.d.ts

@@ -0,0 +1,167 @@
+/**
+ * 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 { XHR } from './XHR';
+import { Delegation } from '../model/Delegation';
+import { DocIdentifier } from '../model/DocIdentifier';
+import { IcureStub } from '../model/IcureStub';
+import { ListOfIds } from '../model/ListOfIds';
+import { Message } from '../model/Message';
+import { MessagesReadStatusUpdate } from '../model/MessagesReadStatusUpdate';
+import { PaginatedListMessage } from '../model/PaginatedListMessage';
+export declare class IccMessageApi {
+    host: string;
+    headers: Array<XHR.Header>;
+    fetchImpl?: (input: RequestInfo, init?: RequestInit) => Promise<Response>;
+    constructor(host: string, headers: any, fetchImpl?: (input: RequestInfo, init?: RequestInit) => Promise<Response>);
+    setHeaders(h: Array<XHR.Header>): void;
+    handleError(e: XHR.XHRError): never;
+    /**
+     *
+     * @summary Creates a message
+     * @param body
+     */
+    createMessage(body?: Message): Promise<Message>;
+    /**
+     *
+     * @summary Deletes a message delegation
+     * @param messageId
+     * @param delegateId
+     */
+    deleteDelegation(messageId: string, delegateId: string): Promise<Message>;
+    /**
+     *
+     * @summary Deletes multiple messages
+     * @param messageIds
+     */
+    deleteMessages(messageIds: string): Promise<Array<DocIdentifier>>;
+    /**
+     *
+     * @summary Deletes multiple messages
+     * @param body
+     */
+    deleteMessagesBatch(body?: ListOfIds): Promise<Array<DocIdentifier>>;
+    /**
+     *
+     * @summary Get all messages (paginated) for current HC Party
+     * @param startKey
+     * @param startDocumentId
+     * @param limit
+     */
+    findMessages(startKey?: string, startDocumentId?: string, limit?: number): Promise<PaginatedListMessage>;
+    /**
+     *
+     * @summary Get all messages (paginated) for current HC Party and provided from address
+     * @param fromAddress
+     * @param startKey
+     * @param startDocumentId
+     * @param limit
+     * @param hcpId
+     */
+    findMessagesByFromAddress(fromAddress?: string, startKey?: string, startDocumentId?: string, limit?: number, hcpId?: string): Promise<PaginatedListMessage>;
+    /**
+     * Keys must be delimited by coma
+     * @summary List messages found By Healthcare Party and secret foreign keys.
+     * @param secretFKeys
+     */
+    findMessagesByHCPartyPatientForeignKeys(secretFKeys: string): Promise<Array<Message>>;
+    /**
+     *
+     * @summary Get all messages (paginated) for current HC Party and provided to address
+     * @param toAddress
+     * @param startKey
+     * @param startDocumentId
+     * @param limit
+     * @param reverse
+     * @param hcpId
+     */
+    findMessagesByToAddress(toAddress?: string, startKey?: string, startDocumentId?: string, limit?: number, reverse?: boolean, hcpId?: string): Promise<PaginatedListMessage>;
+    /**
+     *
+     * @summary Get all messages (paginated) for current HC Party and provided transportGuid
+     * @param transportGuid
+     * @param received
+     * @param startKey
+     * @param startDocumentId
+     * @param limit
+     * @param hcpId
+     */
+    findMessagesByTransportGuid(transportGuid?: string, received?: boolean, startKey?: string, startDocumentId?: string, limit?: number, hcpId?: string): Promise<PaginatedListMessage>;
+    /**
+     *
+     * @summary Get all messages starting by a prefix between two date
+     * @param transportGuid
+     * @param from
+     * @param to
+     * @param startKey
+     * @param startDocumentId
+     * @param limit
+     * @param hcpId
+     */
+    findMessagesByTransportGuidSentDate(transportGuid?: string, from?: number, to?: number, startKey?: string, startDocumentId?: string, limit?: number, hcpId?: string): Promise<PaginatedListMessage>;
+    /**
+     *
+     * @summary Get children messages of provided message
+     * @param messageId
+     */
+    getChildrenMessages(messageId: string): Promise<Array<Message>>;
+    /**
+     *
+     * @summary Get children messages of provided message
+     * @param body
+     */
+    getChildrenMessagesOfList(body?: ListOfIds): Promise<Array<Message>>;
+    /**
+     *
+     * @summary Gets a message
+     * @param messageId
+     */
+    getMessage(messageId: string): Promise<Message>;
+    /**
+     *
+     * @summary Get children messages of provided message
+     * @param body
+     */
+    listMessagesByInvoiceIds(body?: ListOfIds): Promise<Array<Message>>;
+    /**
+     *
+     * @summary Get all messages for current HC Party and provided transportGuids
+     * @param body
+     * @param hcpId
+     */
+    listMessagesByTransportGuids(hcpId: string, body?: ListOfIds): Promise<Array<Message>>;
+    /**
+     *
+     * @summary Updates a message
+     * @param body
+     */
+    modifyMessage(body?: Message): Promise<Message>;
+    /**
+     *
+     * @summary Adds a delegation to a message
+     * @param body
+     * @param messageId
+     */
+    newMessageDelegations(messageId: string, body?: Array<Delegation>): Promise<IcureStub>;
+    /**
+     *
+     * @summary Set read status for given list of messages
+     * @param body
+     */
+    setMessagesReadStatus(body?: MessagesReadStatusUpdate): Promise<Array<Message>>;
+    /**
+     *
+     * @summary Set status bits for given list of messages
+     * @param body
+     * @param status
+     */
+    setMessagesStatusBits(status: number, body?: ListOfIds): Promise<Array<Message>>;
+}