icure_dart_sdk

The iCure Data Stack Application API is the native interface to iCure.

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: v2
  • Build package: org.openapitools.codegen.languages.DartClientCodegen

Requirements

Dart 2.12 or later

Installation & Usage

Github

If this Dart package is published to Github, add the following dependency to your pubspec.yaml

dependencies:
  icure_dart_sdk:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git

Local

To use the package in your local drive, add the following dependency to your pubspec.yaml

dependencies:
  icure_dart_sdk:
    path: /path/to/icure_dart_sdk

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

import 'package:icure_dart_sdk/api.dart';


final api_instance = AccessLogApi();
final accessLogDto = AccessLogDto(); // AccessLogDto |

try {
    final result = api_instance.createAccessLog(accessLogDto);
    print(result);
} catch (e) {
    print('Exception when calling AccessLogApi->createAccessLog: $e\n');
}

Documentation for API Endpoints

All URIs are relative to https://kraken.icure.dev

ClassMethodHTTP requestDescription
AccessLogApicreateAccessLog**
POST** /rest/v1/accesslogCreates an access log
AccessLogApideleteAccessLogs**
POST** /rest/v1/accesslog/delete/batchDeletes an access log
AccessLogApifindAccessLogsBy**
GET** /rest/v1/accesslogGet Paginated List of Access logs
AccessLogApifindAccessLogsByUserAfterDate**
GET** /rest/v1/accesslog/byUserGet Paginated List of Access logs by user after date
AccessLogApigetAccessLog**
GET** /rest/v1/accesslog/{accessLogId}Gets an access log
AccessLogApi[**
listAccessLogsByHCPartyAndPatientForeignKeys**](doc//AccessLogApi.md#listaccesslogsbyhcpartyandpatientforeignkeys)**
GET** /rest/v1/accesslog/byHcPartySecretForeignKeysList access logs found By Healthcare Party and secret foreign keyelementIds.
AccessLogApimodifyAccessLog**
PUT** /rest/v1/accesslogModifies an access log
AgendaApicreateAgendaPOST /rest/v1/agendaCreates a agenda
AgendaApideleteAgendas**
POST** /rest/v1/agenda/delete/batchDeletes agendas
AgendaApigetAgendaGET /rest/v1/agenda/{agendaId}Gets an agenda
AgendaApigetAgendasGET /rest/v1/agendaGets all agendas
AgendaApigetAgendasForUser**
GET** /rest/v1/agenda/byUserGets all agendas for user
AgendaApigetReadableAgendasForUser**
GET** /rest/v1/agenda/readableForUserGets readable agendas for user
AgendaApimodifyAgendaPUT /rest/v1/agendaModifies an agenda
AnonymousAccessApi[**
getAvailabilitiesByPeriodAndCalendarItemTypeId**](doc//AnonymousAccessApi.md#getavailabilitiesbyperiodandcalendaritemtypeid)**
GET** /rest/v1/aa/available/inGroup/{groupId}/forUser/{userId}/type/{getCalendarItemTypeId}Get Availabilities for HCP and appointmentType
AnonymousAccessApilistAppointmentTypesForUser**
GET** /rest/v1/aa/appointmentType/inGroup/{groupId}/forUser/{userId}List Calendar Item types for a provided group id and user id
AnonymousAccessApilistHealthcarePartiesInGroup**
GET** /rest/v1/aa/hcparty/inGroup/{groupId}List healthcare parties for a provided group id
ApplicationsettingsApigetApplicationSettings**
GET** /rest/v1/appsettingsGets all application settings
ArticleApicreateArticlePOST /rest/v1/articleCreates a article
ArticleApideleteArticles**
POST** /rest/v1/article/delete/batchDeletes articles
ArticleApigetArticleGET /rest/v1/article/{articleId}Gets an article
ArticleApigetArticlesGET /rest/v1/articleGets all articles
ArticleApimodifyArticlePUT /rest/v1/articleModifies an article
AuthApiloginPOST /rest/v1/auth/loginlogin
AuthApilogoutGET /rest/v1/auth/logoutlogout
AuthApilogoutPostPOST /rest/v1/auth/logoutlogout
AuthApitokenGET /rest/v1/auth/token/{method}/{path}token
BeefactApicreateBatchAndMessage**
POST** /rest/v1/be_efact/{insuranceId}/{newMessageId}/{numericalRef}create batch and message
BekmehrApicheckIfSMFPatientsExists**
POST** /rest/v1/be_kmehr/smf/{documentId}/checkIfSMFPatientsExistsCheck whether patients in SMF already exists in DB
BekmehrApigenerateContactreportExport**
POST** /rest/v1/be_kmehr/contactreport/{patientId}/export/{id}Get Kmehr contactreport
BekmehrApigenerateDiaryNote**
POST** /rest/v1/be_kmehr/diarynote/{patientId}/exportGenerate diarynote
BekmehrApigenerateLabresultExport**
POST** /rest/v1/be_kmehr/labresult/{patientId}/export/{id}Get Kmehr labresult
BekmehrApigenerateMedicationSchemeExport**
POST** /rest/v1/be_kmehr/medicationscheme/{patientId}/exportGet Medicationscheme export
BekmehrApigenerateNoteExport**
POST** /rest/v1/be_kmehr/note/{patientId}/export/{id}Get Kmehr note
BekmehrApigeneratePatientInfoExport**
POST** /rest/v1/be_kmehr/patientinfo/{patientId}/exportGet KMEHR Patient Info export
BekmehrApigeneratePrescriptionExport**
POST** /rest/v1/be_kmehr/prescription/{patientId}/export/{id}Get Kmehr prescription
BekmehrApigenerateReportExport**
POST** /rest/v1/be_kmehr/report/{patientId}/export/{id}Get Kmehr report
BekmehrApigenerateRequestExport**
POST** /rest/v1/be_kmehr/request/{patientId}/export/{id}Get Kmehr request
BekmehrApigenerateResultExport**
POST** /rest/v1/be_kmehr/result/{patientId}/export/{id}Get Kmehr result
BekmehrApigenerateSmfExport**
POST** /rest/v1/be_kmehr/smf/{patientId}/exportGet SMF (Software Medical File) export
BekmehrApigenerateSumehr**
POST** /rest/v1/be_kmehr/sumehr/{patientId}/exportGenerate sumehr
BekmehrApigenerateSumehrV2**
POST** /rest/v1/be_kmehr/sumehrv2/{patientId}/exportGenerate sumehr
BekmehrApigetSumehrContent**
POST** /rest/v1/be_kmehr/sumehr/{patientId}/contentGet sumehr elements
BekmehrApigetSumehrMd5**
POST** /rest/v1/be_kmehr/sumehr/{patientId}/md5Check sumehr signature
BekmehrApigetSumehrV2Content**
POST** /rest/v1/be_kmehr/sumehrv2/{patientId}/contentGet sumehr elements
BekmehrApigetSumehrV2Md5**
POST** /rest/v1/be_kmehr/sumehrv2/{patientId}/md5Check sumehr signature
BekmehrApiimportMedicationScheme**
POST** /rest/v1/be_kmehr/medicationscheme/{documentId}/importImport MedicationScheme into patient(s) using existing document
BekmehrApiimportSmf**
POST** /rest/v1/be_kmehr/smf/{documentId}/importImport SMF into patient(s) using existing document
BekmehrApiimportSumehr**
POST** /rest/v1/be_kmehr/sumehr/{documentId}/importImport sumehr into patient(s) using existing document
BekmehrApiimportSumehrByItemId**
POST** /rest/v1/be_kmehr/sumehr/{documentId}/importbyitemidImport sumehr into patient(s) using existing document
BekmehrApiisSumehrV2Valid**
POST** /rest/v1/be_kmehr/sumehrv2/{patientId}/validGet sumehr validity
BekmehrApiisSumehrValid**
POST** /rest/v1/be_kmehr/sumehr/{patientId}/validGet sumehr validity
BekmehrApivalidateSumehr**
POST** /rest/v1/be_kmehr/sumehr/{patientId}/validateValidate sumehr
BekmehrApivalidateSumehrV2**
POST** /rest/v1/be_kmehr/sumehrv2/{patientId}/validateValidate sumehr
BeresultexportApiexportHealthOne**
POST** /rest/v1/be_result_export/hl1/{fromHcpId}/{toHcpId}/{patId}/{date}/{ref}Export data
BeresultexportApiexportKmehrReport**
POST** /rest/v1/be_result_export/kmehrreport/{fromHcpId}/{toHcpId}/{patId}/{date}/{ref}Export data
BeresultexportApiexportMedidoc**
POST** /rest/v1/be_result_export/medidoc/{fromHcpId}/{toHcpId}/{patId}/{date}/{ref}Export data
BeresultimportApicanHandle**
GET** /rest/v1/be_result_import/canhandle/{id}Can we handle this document
BeresultimportApidoImport**
GET** /rest/v1/be_result_import/import/{documentId}/{hcpId}/{language}import document
BeresultimportApigetInfos**
GET** /rest/v1/be_result_import/infos/{id}Extract general infos from document
Besamv2ApifindAmpsByDmppCode**
GET** /rest/v1/be_samv2/amp/byDmppCode/{dmppCode}Finding AMPs by dmpp code
Besamv2ApifindPaginatedAmpsByAtc**
GET** /rest/v1/be_samv2/vmp/byAtc/{atcCode}Finding AMPs by atc code with pagination.
Besamv2ApifindPaginatedAmpsByGroupCode**
GET** /rest/v1/be_samv2/amp/byGroupCode/{vmpgCode}Finding AMPs by group with pagination.
Besamv2ApifindPaginatedAmpsByGroupId**
GET** /rest/v1/be_samv2/amp/byGroupId/{vmpgId}Finding AMPs by group with pagination.
Besamv2ApifindPaginatedAmpsByLabel**
GET** /rest/v1/be_samv2/ampFinding AMPs by label with pagination.
Besamv2ApifindPaginatedAmpsByVmpCode**
GET** /rest/v1/be_samv2/amp/byVmpCode/{vmpCode}Finding AMPs by vmp code with pagination.
Besamv2ApifindPaginatedAmpsByVmpId**
GET** /rest/v1/be_samv2/amp/byVmpId/{vmpId}Finding AMPs by vmp id with pagination.
Besamv2ApifindPaginatedNmpsByLabel**
GET** /rest/v1/be_samv2/nmpFinding NMPs by label with pagination.
Besamv2ApifindPaginatedVmpGroupsByLabel**
GET** /rest/v1/be_samv2/vmpgroupFinding VMP groups by language label with pagination.
Besamv2ApifindPaginatedVmpGroupsByVmpGroupCode**
GET** /rest/v1/be_samv2/vmpgroup/byGroupCode/{vmpgCode}Finding VMP groups by cmpgCode with pagination.
Besamv2ApifindPaginatedVmpsByGroupCode**
GET** /rest/v1/be_samv2/vmp/byGroupCode/{vmpgCode}Finding VMPs by group with pagination.
Besamv2ApifindPaginatedVmpsByGroupId**
GET** /rest/v1/be_samv2/vmp/byGroupId/{vmpgId}Finding VMPs by group with pagination.
Besamv2ApifindPaginatedVmpsByLabel**
GET** /rest/v1/be_samv2/vmpFinding VMPs by label with pagination.
Besamv2ApifindPaginatedVmpsByVmpCode**
GET** /rest/v1/be_samv2/vmp/byVmpCode/{vmpCode}Finding VMPs by group with pagination.
Besamv2ApigetSamVersionGET /rest/v1/be_samv2/vGet Samv2 version.
Besamv2ApilistAmpsByDmppCodes**
POST** /rest/v1/be_samv2/amp/byDmppCodesFinding AMPs by dmpp code
Besamv2ApilistAmpsByGroupCodes**
POST** /rest/v1/be_samv2/amp/byGroupCodesFinding AMPs by group.
Besamv2ApilistAmpsByGroupIds**
POST** /rest/v1/be_samv2/amp/byGroupIdsFinding AMPs by group.
Besamv2ApilistAmpsByVmpCodes**
POST** /rest/v1/be_samv2/amp/byVmpCodesFinding AMPs by vmp code.
Besamv2ApilistAmpsByVmpIds**
POST** /rest/v1/be_samv2/amp/byVmpIdsFinding AMPs by vmp id.
Besamv2ApilistNmpsByCnks**
POST** /rest/v1/be_samv2/nmp/byCnksFinding NMPs by cnk id.
Besamv2ApilistPharmaceuticalForms**
GET** /rest/v1/be_samv2/pharmaformList all pharmaceutical forms.
Besamv2ApilistSubstances**
GET** /rest/v1/be_samv2/substanceList all substances.
Besamv2ApilistVmpGroupsByVmpGroupCodes**
POST** /rest/v1/be_samv2/vmpgroup/byGroupCodesFinding AMPs by group.
Besamv2ApilistVmpsByGroupIds**
POST** /rest/v1/be_samv2/vmp/byGroupIdsFinding VMPs by group.
Besamv2ApilistVmpsByVmpCodes**
POST** /rest/v1/be_samv2/vmp/byVmpCodesFinding VMPs by group.
CalendarItemApicreateCalendarItem**
POST** /rest/v1/calendarItemCreates a calendarItem
CalendarItemApideleteCalendarItem**
POST** /rest/v1/calendarItem/{calendarItemIds}Deletes an calendarItem
CalendarItemApideleteCalendarItems**
POST** /rest/v1/calendarItem/delete/batchDeletes calendarItems
CalendarItemApi[**
findCalendarItemsByHCPartyPatientForeignKeys**](doc//CalendarItemApi.md#findcalendaritemsbyhcpartypatientforeignkeys)**
GET** /rest/v1/calendarItem/byHcPartySecretForeignKeysFind CalendarItems by hcparty and patient
CalendarItemApifindCalendarItemsByRecurrenceId**
GET** /rest/v1/calendarItem/byRecurrenceIdFind CalendarItems by recurrenceId
CalendarItemApigetCalendarItem**
GET** /rest/v1/calendarItem/{calendarItemId}Gets an calendarItem
CalendarItemApigetCalendarItems**
GET** /rest/v1/calendarItemGets all calendarItems
CalendarItemApi[**
getCalendarItemsByPeriodAndHcPartyId**](doc//CalendarItemApi.md#getcalendaritemsbyperiodandhcpartyid)**
POST** /rest/v1/calendarItem/byPeriodAndHcPartyIdGet CalendarItems by Period and HcPartyId
CalendarItemApigetCalendarItemsWithIds**
POST** /rest/v1/calendarItem/byIdsGet calendarItems by ids
CalendarItemApigetCalendarsByPeriodAndAgendaId**
POST** /rest/v1/calendarItem/byPeriodAndAgendaIdGet CalendarItems by Period and AgendaId
CalendarItemApimodifyCalendarItem**
PUT** /rest/v1/calendarItemModifies an calendarItem
CalendarItemApisetCalendarItemsDelegations**
POST** /rest/v1/calendarItem/delegationsUpdate delegations in calendarItems
CalendarItemTypeApicreateCalendarItemType**
POST** /rest/v1/calendarItemTypeCreates a calendarItemType
CalendarItemTypeApideleteCalendarItemTypes**
POST** /rest/v1/calendarItemType/delete/batchDeletes calendarItemTypes
CalendarItemTypeApigetCalendarItemType**
GET** /rest/v1/calendarItemType/{calendarItemTypeId}Gets a calendarItemType
CalendarItemTypeApigetCalendarItemTypes**
GET** /rest/v1/calendarItemTypeGets all calendarItemTypes
CalendarItemTypeApi[**
getCalendarItemTypesIncludeDeleted**](doc//CalendarItemTypeApi.md#getcalendaritemtypesincludedeleted)**
GET** /rest/v1/calendarItemType/includeDeletedGets all calendarItemTypes include deleted
CalendarItemTypeApimodifyCalendarItemType**
PUT** /rest/v1/calendarItemTypeModifies an calendarItemType
ClassificationApicreateClassification**
POST** /rest/v1/classificationCreate a classification with the current user
ClassificationApideleteClassifications**
POST** /rest/v1/classification/delete/batchDelete classification Templates.
ClassificationApi[**
findClassificationsByHCPartyPatientForeignKeys**](doc//ClassificationApi.md#findclassificationsbyhcpartypatientforeignkeys)**
GET** /rest/v1/classification/byHcPartySecretForeignKeysList classification Templates found By Healthcare Party and secret foreign keyelementIds.
ClassificationApigetClassification**
GET** /rest/v1/classification/{classificationId}Get a classification Template
ClassificationApigetClassificationByHcPartyId**
GET** /rest/v1/classification/byIds/{ids}Get a list of classifications
ClassificationApimodifyClassification**
PUT** /rest/v1/classificationModify a classification Template
ClassificationApinewClassificationDelegations**
POST** /rest/v1/classification/{classificationId}/delegateDelegates a classification to a healthcare party
ClassificationApisetClassificationsDelegations**
POST** /rest/v1/classification/delegationsUpdate delegations in classification
ClassificationTemplateApi[**
createClassificationTemplate**](doc//ClassificationTemplateApi.md#createclassificationtemplate)**
POST** /rest/v1/classificationTemplateCreate a classification Template with the current user
ClassificationTemplateApi[**
deleteClassificationTemplates**](doc//ClassificationTemplateApi.md#deleteclassificationtemplates)**
POST** /rest/v1/classificationTemplate/delete/batchDelete classification Templates.
ClassificationTemplateApi[**
findClassificationTemplatesBy**](doc//ClassificationTemplateApi.md#findclassificationtemplatesby)**
GET** /rest/v1/classificationTemplateList all classification templates with pagination
ClassificationTemplateApi[**
getClassificationTemplate**](doc//ClassificationTemplateApi.md#getclassificationtemplate)**
GET** /rest/v1/classificationTemplate/{classificationTemplateId}Get a classification Template
ClassificationTemplateApi[**
getClassificationTemplateByIds**](doc//ClassificationTemplateApi.md#getclassificationtemplatebyids)**
GET** /rest/v1/classificationTemplate/byIds/{ids}Get a list of classifications Templates
ClassificationTemplateApi[**
listClassificationTemplatesByHCPartyPatientForeignKeys**](doc//ClassificationTemplateApi.md#listclassificationtemplatesbyhcpartypatientforeignkeys)**
GET** /rest/v1/classificationTemplate/byHcPartySecretForeignKeysList classification Templates found By Healthcare Party and secret foreign keyelementIds.
ClassificationTemplateApi[**
modifyClassificationTemplate**](doc//ClassificationTemplateApi.md#modifyclassificationtemplate)**
PUT** /rest/v1/classificationTemplateModify a classification Template
ClassificationTemplateApi[**
newClassificationTemplateDelegations**](doc//ClassificationTemplateApi.md#newclassificationtemplatedelegations)**
POST** /rest/v1/classificationTemplate/{classificationTemplateId}/delegateDelegates a classification Template to a healthcare party
CodeApicreateCodePOST /rest/v1/codeCreate a Code
CodeApifilterCodesByPOST /rest/v1/code/filterFilter codes
CodeApifindCodesByLabel**
GET** /rest/v1/code/byLabelFinding codes by code, type and version with pagination.
CodeApifindCodesByLink**
GET** /rest/v1/code/byLink/{linkType}Finding codes by code, type and version with pagination.
CodeApifindCodesByType**
GET** /rest/v1/codeFinding codes by code, type and version with pagination.
CodeApigetCodeGET /rest/v1/code/{codeId}Get a code
CodeApigetCodeWithParts**
GET** /rest/v1/code/{type}/{code}/{version}Get a code
CodeApigetCodesPOST /rest/v1/code/byIdsGet a list of codes by ids
CodeApiimportCodesPOST /rest/v1/code/{codeType}Import codes
CodeApilistCodeTypesBy**
GET** /rest/v1/code/codetype/byRegionTypeFinding code types.
CodeApilistCodesByRegionTypeCodeVersion**
GET** /rest/v1/code/byRegionTypeCodeFinding codes by code, type and version
CodeApilistTagTypesBy**
GET** /rest/v1/code/tagtype/byRegionTypeFinding tag types.
CodeApimatchCodesBy**
POST** /rest/v1/code/matchGet ids of code matching the provided filter for the current user (HcParty)
CodeApimodifyCodePUT /rest/v1/codeModify a code
ContactApicloseForHCPartyPatientForeignKeys**
PUT** /rest/v1/contact/byHcPartySecretForeignKeys/closeClose contacts for Healthcare Party and secret foreign keys.
ContactApicreateContact**
POST** /rest/v1/contactCreate a contact with the current user
ContactApicreateContacts**
POST** /rest/v1/contact/batchCreate a batch of contacts
ContactApideleteContacts**
POST** /rest/v1/contact/delete/batchDelete contacts.
ContactApifilterContactsBy**
POST** /rest/v1/contact/filterList contacts for the current user (HcParty) or the given hcparty in the filter
ContactApifilterServicesBy**
POST** /rest/v1/contact/service/filterList services for the current user (HcParty) or the given hcparty in the filter
ContactApifindContactsByOpeningDate**
GET** /rest/v1/contact/byOpeningDateList contacts by opening date parties with(out) pagination
ContactApigetContactGET /rest/v1/contact/{contactId}Get a contact
ContactApigetContactsPOST /rest/v1/contact/byIdsGet contacts
ContactApigetEmptyContent**
GET** /rest/v1/contact/service/content/emptyGet an empty content
ContactApigetServiceCodesOccurences**
GET** /rest/v1/contact/service/codes/{codeType}/{minOccurences}Get the list of all used codes frequencies in services
ContactApigetServices**
POST** /rest/v1/contact/serviceList services with provided ids
ContactApigetServicesLinkedTo**
POST** /rest/v1/contact/service/linkedToList services linked to provided ids
ContactApilistContactByHCPartyServiceId**
GET** /rest/v1/contact/byHcPartyServiceIdList contacts found By Healthcare Party and service Id.
ContactApilistContactsByExternalId**
POST** /rest/v1/contact/byExternalIdList contacts found By externalId.
ContactApilistContactsByHCPartyAndFormId**
GET** /rest/v1/contact/byHcPartyFormIdList contacts found By Healthcare Party and form Id.
ContactApilistContactsByHCPartyAndFormIds**
POST** /rest/v1/contact/byHcPartyFormIdsList contacts found By Healthcare Party and form Id.
ContactApi[**
listContactsByHCPartyAndPatientForeignKeys**](doc//ContactApi.md#listcontactsbyhcpartyandpatientforeignkeys)**
POST** /rest/v1/contact/byHcPartyPatientForeignKeysList contacts found By Healthcare Party and Patient foreign keys.
ContactApi[**
listContactsByHCPartyAndPatientSecretFKeys**](doc//ContactApi.md#listcontactsbyhcpartyandpatientsecretfkeys)**
GET** /rest/v1/contact/byHcPartySecretForeignKeysList contacts found By Healthcare Party and secret foreign keys.
ContactApi[**
listContactsDelegationsStubsByHCPartyAndPatientForeignKeys**](doc//ContactApi.md#listcontactsdelegationsstubsbyhcpartyandpatientforeignkeys)**
GET** /rest/v1/contact/byHcPartySecretForeignKeys/delegationsList contacts found By Healthcare Party and secret foreign keys.
ContactApilistServicesByAssociationId**
GET** /rest/v1/contact/service/associationIdList services by related association id
ContactApilistServicesByHealthElementId**
GET** /rest/v1/contact/service/healthElementId/{healthElementId}List services linked to a health element
ContactApimatchContactsBy**
POST** /rest/v1/contact/matchGet ids of contacts matching the provided filter for the current user (HcParty)
ContactApimodifyContactPUT /rest/v1/contactModify a contact
ContactApimodifyContacts**
PUT** /rest/v1/contact/batchModify a batch of contacts
ContactApimodifyContactsDelegations**
PUT** /rest/v1/contact/delegationsUpdate delegations in healthElements.
ContactApinewContactDelegations**
POST** /rest/v1/contact/{contactId}/delegateDelegates a contact to a healthcare party
ContactApisetContactsDelegations**
POST** /rest/v1/contact/delegationsUpdate delegations in healthElements.
DeviceApicreateDevicePOST /rest/v1/deviceCreate a device
DeviceApicreateDevices**
POST** /rest/v1/device/batchCreate devices in bulk
DeviceApicreateDevices1**
POST** /rest/v1/device/bulkCreate devices in bulk
DeviceApideleteDevice**
DELETE** /rest/v1/device/{deviceId}Delete device.
DeviceApideleteDevices**
POST** /rest/v1/device/delete/batchDelete devices.
DeviceApifilterDevicesBy**
POST** /rest/v1/device/filterFilter devices for the current user (HcParty)
DeviceApigetDeviceGET /rest/v1/device/{deviceId}Get Device
DeviceApigetDevicesPOST /rest/v1/device/byIdsGet devices by id
DeviceApimatchDevicesBy**
POST** /rest/v1/device/matchGet ids of devices matching the provided filter for the current user (HcParty)
DeviceApiupdateDevicePUT /rest/v1/deviceModify a device
DeviceApiupdateDevices**
PUT** /rest/v1/device/batchModify devices in bulk
DeviceApiupdateDevices1**
PUT** /rest/v1/device/bulkModify devices in bulk
DocumentApicreateDocument**
POST** /rest/v1/documentCreates a document
DocumentApideleteAttachment**
DELETE** /rest/v1/document/{documentId}/attachmentDeletes a document's attachment
DocumentApideleteDocument**
POST** /rest/v1/document/delete/batchDeletes documents
DocumentApifindWithoutDelegation**
GET** /rest/v1/document/woDelegationList documents with no delegation
DocumentApigetDocument**
GET** /rest/v1/document/{documentId}Gets a document
DocumentApigetDocumentAttachment**
GET** /rest/v1/document/{documentId}/attachment/{attachmentId}Load document's attachment
DocumentApigetDocumentByExternalUuid**
GET** /rest/v1/document/externaluuid/{externalUuid}Gets a document
DocumentApigetDocuments**
POST** /rest/v1/document/byIdsGets a document
DocumentApigetDocumentsByExternalUuid**
GET** /rest/v1/document/externaluuid/{externalUuid}/allGet all documents with externalUuid
DocumentApi[**
listDocumentByTypeHCPartyMessageSecretFKeys**](doc//DocumentApi.md#listdocumentbytypehcpartymessagesecretfkeys)**
GET** /rest/v1/document/byTypeHcPartySecretForeignKeysList documents found By type, By Healthcare Party and secret foreign keys.
DocumentApi[**
listDocumentsByHCPartyAndPatientForeignKeys**](doc//DocumentApi.md#listdocumentsbyhcpartyandpatientforeignkeys)**
GET** /rest/v1/document/byHcPartySecretForeignKeysList documents found By Healthcare Party and secret foreign keys.
DocumentApimodifyDocument**
PUT** /rest/v1/documentUpdates a document
DocumentApimodifyDocuments**
PUT** /rest/v1/document/batchUpdates a batch of documents
DocumentApisetDocumentAttachment**
PUT** /rest/v1/document/{documentId}/attachmentCreates a document's attachment
DocumentApisetDocumentAttachmentMulti**
PUT** /rest/v1/document/{documentId}/attachment/multipartCreates a document's attachment
DocumentApisetDocumentsDelegations**
POST** /rest/v1/document/delegationsUpdate delegations in healthElements.
DocumentApisetSafeDocumentAttachment**
PUT** /rest/v1/document/attachmentCreates a document's attachment
DocumentTemplateApicreateDocumentTemplate**
POST** /rest/v1/doctemplateCreate a document template with the current user
DocumentTemplateApideleteDocumentTemplates**
POST** /rest/v1/doctemplate/delete/batchDeletes document templates
DocumentTemplateApigetAttachmentText**
GET** /rest/v1/doctemplate/{documentTemplateId}/attachmentText/{attachmentId}Download a the document template attachment
DocumentTemplateApigetDocumentTemplate**
GET** /rest/v1/doctemplate/{documentTemplateId}Gets a document template
DocumentTemplateApi[**
getDocumentTemplateAttachment**](doc//DocumentTemplateApi.md#getdocumenttemplateattachment)**
GET** /rest/v1/doctemplate/{documentTemplateId}/attachment/{attachmentId}Download a the document template attachment
DocumentTemplateApilistAllDocumentTemplates**
GET** /rest/v1/doctemplate/find/allGets all document templates for all users
DocumentTemplateApilistDocumentTemplates**
GET** /rest/v1/doctemplateGets all document templates for current user
DocumentTemplateApi[**
listDocumentTemplatesByDocumentType**](doc//DocumentTemplateApi.md#listdocumenttemplatesbydocumenttype)**
GET** /rest/v1/doctemplate/byDocumentType/{documentTypeCode}Gets all document templates by Type
DocumentTemplateApi[**
listDocumentTemplatesByDocumentTypeForCurrentUser**](doc//DocumentTemplateApi.md#listdocumenttemplatesbydocumenttypeforcurrentuser)**
GET** /rest/v1/doctemplate/byDocumentTypeForCurrentUser/{documentTypeCode}Gets all document templates by Type For currentUser
DocumentTemplateApi[**
listDocumentTemplatesBySpeciality**](doc//DocumentTemplateApi.md#listdocumenttemplatesbyspeciality)**
GET** /rest/v1/doctemplate/bySpecialty/{specialityCode}Gets all document templates
DocumentTemplateApimodifyDocumentTemplate**
PUT** /rest/v1/doctemplate/{documentTemplateId}Modify a document template with the current user
DocumentTemplateApi[**
setDocumentTemplateAttachment**](doc//DocumentTemplateApi.md#setdocumenttemplateattachment)**
PUT** /rest/v1/doctemplate/{documentTemplateId}/attachmentCreates a document's attachment
DocumentTemplateApi[**
setDocumentTemplateAttachmentJson**](doc//DocumentTemplateApi.md#setdocumenttemplateattachmentjson)**
PUT** /rest/v1/doctemplate/{documentTemplateId}/attachmentJsonCreates a document's attachment
EntityTemplateApicreateEntityTemplate**
POST** /rest/v1/entitytemplateCreate a EntityTemplate
EntityTemplateApicreateEntityTemplates**
POST** /rest/v1/entitytemplate/batchCreate a batch of entityTemplates
EntityTemplateApideleteEntityTemplate**
POST** /rest/v1/entitytemplate/delete/batchDelete entity templates
EntityTemplateApi[**
findAllEntityTemplatesByKeyword**](doc//EntityTemplateApi.md#findallentitytemplatesbykeyword)**
GET** /rest/v1/entitytemplate/findAll/{type}/keyword/{keyword}Finding entityTemplates by entityTemplate, type and version with pagination.
EntityTemplateApigetEntityTemplate**
GET** /rest/v1/entitytemplate/{entityTemplateId}Get a entityTemplate
EntityTemplateApigetEntityTemplates**
POST** /rest/v1/entitytemplate/byIdsGet a list of entityTemplates by ids
EntityTemplateApilistAllEntityTemplatesBy**
GET** /rest/v1/entitytemplate/findAll/{type}Finding entityTemplates by entityTemplate, type and version with pagination.
EntityTemplateApilistEntityTemplatesBy**
GET** /rest/v1/entitytemplate/find/{userId}/{type}Finding entityTemplates by userId, entityTemplate, type and version with pagination.
EntityTemplateApilistEntityTemplatesByKeyword**
GET** /rest/v1/entitytemplate/find/{userId}/{type}/keyword/{keyword}Finding entityTemplates by userId, type and keyword.
EntityTemplateApimodifyEntityTemplate**
PUT** /rest/v1/entitytemplateModify a entityTemplate
EntityTemplateApimodifyEntityTemplates**
PUT** /rest/v1/entitytemplate/batchModify a batch of entityTemplates
EntityrefApicreateEntityReference**
POST** /rest/v1/entityrefCreate an entity reference
EntityrefApigetLatest**
GET** /rest/v1/entityref/latest/{prefix}Find latest reference for a prefix
FormApicreateFormPOST /rest/v1/formCreate a form with the current user
FormApicreateFormTemplate**
POST** /rest/v1/form/templateCreate a form template with the current user
FormApicreateFormsPOST /rest/v1/form/batchCreate a batch of forms
FormApideleteFormTemplate**
DELETE** /rest/v1/form/template/{formTemplateId}Delete a form template
FormApideleteFormsPOST /rest/v1/form/delete/batchDelete forms.
FormApigetChildrenForms**
GET** /rest/v1/form/childrenOf/{formId}/{hcPartyId}Get a list of forms by parents ids
FormApigetFormGET /rest/v1/form/{formId}Gets a form
FormApigetFormByLogicalUuid**
GET** /rest/v1/form/logicalUuid/{logicalUuid}Gets the most recent form with the given logicalUuid
FormApigetFormByUniqueId**
GET** /rest/v1/form/uniqueId/{uniqueId}Gets the most recent form with the given uniqueId
FormApigetFormTemplate**
GET** /rest/v1/form/template/{formTemplateId}Gets a form template by guid
FormApigetFormTemplates**
GET** /rest/v1/form/templateGets all form templates for current user
FormApigetFormTemplatesByGuid**
GET** /rest/v1/form/template/{specialityCode}/guid/{formTemplateGuid}Gets a form template
FormApigetFormsPOST /rest/v1/form/byIdsGet a list of forms by ids
FormApigetFormsByLogicalUuid**
GET** /rest/v1/form/all/logicalUuid/{logicalUuid}Gets all forms with given logicalUuid
FormApigetFormsByUniqueId**
GET** /rest/v1/form/all/uniqueId/{uniqueId}Gets all forms by uniqueId
FormApilistFormTemplatesBySpeciality**
GET** /rest/v1/form/template/bySpecialty/{specialityCode}Gets all form templates
FormApilistFormsByHCPartyAndPatientForeignKeys**
GET** /rest/v1/form/byHcPartySecretForeignKeysList forms found By Healthcare Party and secret foreign keys.
FormApi[**
listFormsDelegationsStubsByHCPartyAndPatientForeignKeys**](doc//FormApi.md#listformsdelegationsstubsbyhcpartyandpatientforeignkeys)**
GET** /rest/v1/form/byHcPartySecretForeignKeys/delegationsList form stubs found By Healthcare Party and secret foreign keys.
FormApimodifyFormPUT /rest/v1/formModify a form
FormApimodifyFormsPUT /rest/v1/form/batchModify a batch of forms
FormApinewFormDelegations**
POST** /rest/v1/form/delegate/{formId}Delegates a form to a healthcare party
FormApisetFormsDelegations**
POST** /rest/v1/form/delegationsUpdate delegations in form.
FormApisetTemplateAttachmentMulti**
PUT** /rest/v1/form/template/{formTemplateId}/attachment/multipartUpdate a form template's layout
FormApiupdateFormTemplate**
PUT** /rest/v1/form/template/{formTemplateId}Modify a form template with the current user
FrontEndMigrationApicreateFrontEndMigration**
POST** /rest/v1/frontendmigrationCreates a front end migration
FrontEndMigrationApideleteFrontEndMigration**
DELETE** /rest/v1/frontendmigration/{frontEndMigrationId}Deletes a front end migration
FrontEndMigrationApigetFrontEndMigration**
GET** /rest/v1/frontendmigration/{frontEndMigrationId}Gets a front end migration
FrontEndMigrationApigetFrontEndMigrationByName**
GET** /rest/v1/frontendmigration/byName/{frontEndMigrationName}Gets an front end migration
FrontEndMigrationApigetFrontEndMigrations**
GET** /rest/v1/frontendmigrationGets a front end migration
FrontEndMigrationApimodifyFrontEndMigration**
PUT** /rest/v1/frontendmigrationModifies a front end migration
GroupApicreateGroupPOST /rest/v1/group/{id}Create a group
GroupApigetGroupGET /rest/v1/group/{id}Get a group by id
GroupApigetReplicationInfo1**
GET** /rest/v1/group/{id}/rGet index info
GroupApiinitDesignDocsPUT /rest/v1/group/{id}/ddInit design docs
GroupApilistGroupsGET /rest/v1/groupList groups
GroupApimodifyGroupName**
PUT** /rest/v1/group/{id}/name/{name}Update group name
GroupApimodifyGroupProperties**
PUT** /rest/v1/group/{id}/propertiesUpdate group properties
GroupApiregisterNewGroupAdministrator**
POST** /rest/v1/group/register/trialCreate a group
GroupApiresetStorage**
POST** /rest/v1/group/{id}/reset/storageReset storage for group
GroupApisetGroupPassword**
PUT** /rest/v1/group/{id}/passwordSet group password
GroupApisolveConflicts**
POST** /rest/v1/group/{id}/conflictsSolve conflicts for group
HealthElementApicreateHealthElement**
POST** /rest/v1/helementCreate a health element with the current user
HealthElementApicreateHealthElements**
POST** /rest/v1/helement/batchCreate a batch of healthcare elements
HealthElementApideleteHealthElements**
POST** /rest/v1/helement/delete/batchDelete health elements.
HealthElementApifilterHealthElementsBy**
POST** /rest/v1/helement/filterFilter health elements for the current user (HcParty)
HealthElementApigetHealthElement**
GET** /rest/v1/helement/{healthElementId}Get a health element
HealthElementApigetHealthElements**
POST** /rest/v1/helement/byIdsGet healthElements by batch
HealthElementApi[**
listHealthElementsByHCPartyAndPatientForeignKeys**](doc//HealthElementApi.md#listhealthelementsbyhcpartyandpatientforeignkeys)**
GET** /rest/v1/helement/byHcPartySecretForeignKeysList health elements found By Healthcare Party and secret foreign keyelementIds.
HealthElementApi[**
listHealthElementsDelegationsStubsByHCPartyAndPatientForeignKeys**](doc//HealthElementApi.md#listhealthelementsdelegationsstubsbyhcpartyandpatientforeignkeys)**
GET** /rest/v1/helement/byHcPartySecretForeignKeys/delegationsList helement stubs found By Healthcare Party and secret foreign keys.
HealthElementApimatchHealthElementsBy**
POST** /rest/v1/helement/matchGet ids of health element matching the provided filter for the current user (HcParty)
HealthElementApimodifyHealthElement**
PUT** /rest/v1/helementModify a health element
HealthElementApimodifyHealthElements**
PUT** /rest/v1/helement/batchModify a batch of health elements
HealthElementApinewHealthElementDelegations**
POST** /rest/v1/helement/{healthElementId}/delegateDelegates a health element to a healthcare party
HealthElementApisetHealthElementsDelegations**
POST** /rest/v1/helement/delegationsUpdate delegations in healthElements.
HealthcarePartyApicreateHealthcareParty**
POST** /rest/v1/hcpartyCreate a healthcare party
HealthcarePartyApicreateHealthcarePartyInGroup**
POST** /rest/v1/hcparty/inGroup/{groupId}Create a healthcare party
HealthcarePartyApideleteHealthcareParties**
POST** /rest/v1/hcparty/delete/batchDelete healthcare parties
HealthcarePartyApi[**
deleteHealthcarePartiesInGroup**](doc//HealthcarePartyApi.md#deletehealthcarepartiesingroup)**
POST** /rest/v1/hcparty/delete/batch/inGroup/{groupId}Delete a healthcare party
HealthcarePartyApifilterHealthPartiesBy**
POST** /rest/v1/hcparty/filterFilter healthcare parties for the current user (HcParty)
HealthcarePartyApifindHealthcarePartiesBy**
GET** /rest/v1/hcpartyList healthcare parties with(out) pagination
HealthcarePartyApifindHealthcarePartiesByName**
GET** /rest/v1/hcparty/byNameFind healthcare parties by name with(out) pagination
HealthcarePartyApi[**
findHealthcarePartiesBySpecialityAndPostCode**](doc//HealthcarePartyApi.md#findhealthcarepartiesbyspecialityandpostcode)**
GET** /rest/v1/hcparty/bySpecialityAndPostCode/{type}/{spec}/{firstCode}/to/{lastCode}Find healthcare parties by name with(out) pagination
HealthcarePartyApi[**
findHealthcarePartiesBySsinOrNihii**](doc//HealthcarePartyApi.md#findhealthcarepartiesbyssinornihii)**
GET** /rest/v1/hcparty/byNihiiOrSsin/{searchValue}Find healthcare parties by nihii or ssin with(out) pagination
HealthcarePartyApigetCurrentHealthcareParty**
GET** /rest/v1/hcparty/currentGet the current healthcare party if logged in.
HealthcarePartyApigetHcPartyKeysForDelegate**
GET** /rest/v1/hcparty/byKeys/{healthcarePartyId}Get the HcParty encrypted AES keys indexed by owner
HealthcarePartyApigetHealthcareParties**
POST** /rest/v1/hcparty/byIdsGet healthcareParties by their IDs
HealthcarePartyApigetHealthcareParty**
GET** /rest/v1/hcparty/{healthcarePartyId}Get a healthcareParty by his ID
HealthcarePartyApigetPublicKey**
GET** /rest/v1/hcparty/{healthcarePartyId}/publicKeyGet public key of a healthcare party
HealthcarePartyApilistHealthcarePartiesByName**
GET** /rest/v1/hcparty/byNameStrict/{name}Find healthcare parties by name with(out) pagination
HealthcarePartyApi[**
listHealthcarePartiesByParentId**](doc//HealthcarePartyApi.md#listhealthcarepartiesbyparentid)**
GET** /rest/v1/hcparty/{parentId}/childrenFind children of an healthcare parties
HealthcarePartyApimatchHealthcarePartiesBy**
POST** /rest/v1/hcparty/matchGet ids of healthcare party matching the provided filter for the current user (HcParty)
HealthcarePartyApimodifyHealthcareParty**
PUT** /rest/v1/hcpartyModify a Healthcare Party.
HealthcarePartyApimodifyHealthcarePartyInGroup**
PUT** /rest/v1/hcparty/inGroup/{groupId}Modify a Healthcare Party.
IcureApigetIndexingInfoGET /rest/v1/icure/iGet index info
IcureApigetProcessInfoGET /rest/v1/icure/pGet process info
IcureApigetReplicationInfo**
GET** /rest/v1/icure/rGet replication info
IcureApigetReplicatorInfo**
GET** /rest/v1/icure/r/{id}Get replication info
IcureApigetVersionGET /rest/v1/icure/vGet version
IcureApiisReadyGET /rest/v1/icure/okCheck if a user exists
IcureApiresolveContactsConflicts**
POST** /rest/v1/icure/conflicts/contactResolve contacts conflicts
IcureApiresolveDocumentsConflicts**
POST** /rest/v1/icure/conflicts/documentresolve documents conflicts
IcureApiresolveFormsConflicts**
POST** /rest/v1/icure/conflicts/formresolve forms conflicts
IcureApiresolveHealthElementsConflicts**
POST** /rest/v1/icure/conflicts/healthelementresolve healthcare elements conflicts
IcureApiresolveInvoicesConflicts**
POST** /rest/v1/icure/conflicts/invoiceresolve invoices conflicts
IcureApiresolveMessagesConflicts**
POST** /rest/v1/icure/conflicts/messageresolve messages conflicts
IcureApiresolvePatientsConflicts**
POST** /rest/v1/icure/conflicts/patientResolve patients conflicts
IcureApiupdateDesignDoc**
POST** /rest/v1/icure/dd/{entityName}Force update design doc
InsuranceApicreateInsurance**
POST** /rest/v1/insuranceCreates an insurance
InsuranceApideleteInsurance**
DELETE** /rest/v1/insurance/{insuranceId}Deletes an insurance
InsuranceApigetInsurance**
GET** /rest/v1/insurance/{insuranceId}Gets an insurance
InsuranceApigetInsurances**
POST** /rest/v1/insurance/byIdsGets insurances by id
InsuranceApilistInsurancesByCode**
GET** /rest/v1/insurance/byCode/{insuranceCode}Gets an insurance
InsuranceApilistInsurancesByName**
GET** /rest/v1/insurance/byName/{insuranceName}Gets an insurance
InsuranceApimodifyInsurance**
PUT** /rest/v1/insuranceModifies an insurance
InvoiceApiappendCodes**
POST** /rest/v1/invoice/byauthor/{userId}/append/{type}/{sentMediumType}Gets all invoices for author at date
InvoiceApicreateInvoicePOST /rest/v1/invoiceCreates an invoice
InvoiceApicreateInvoices**
POST** /rest/v1/invoice/batchCreate a batch of invoices
InvoiceApideleteInvoice**
DELETE** /rest/v1/invoice/{invoiceId}Deletes an invoice
InvoiceApifilterInvoicesBy**
POST** /rest/v1/invoice/filterFilter invoices for the current user (HcParty)
InvoiceApifindInvoicesByAuthor**
GET** /rest/v1/invoice/byauthor/{hcPartyId}Gets all invoices for author at date
InvoiceApigetInvoiceGET /rest/v1/invoice/{invoiceId}Gets an invoice
InvoiceApigetInvoicesPOST /rest/v1/invoice/byIdsGets an invoice
InvoiceApigetTarificationsCodesOccurences**
GET** /rest/v1/invoice/codes/{minOccurences}Get the list of all used tarifications frequencies in invoices
InvoiceApilistAllHcpsByStatus**
POST** /rest/v1/invoice/allHcpsByStatus/{status}Gets all invoices per status
InvoiceApilistInvoicesByContactIds**
POST** /rest/v1/invoice/byContactsGets all invoices for author at date
InvoiceApi[**
listInvoicesByHCPartyAndPatientForeignKeys**](doc//InvoiceApi.md#listinvoicesbyhcpartyandpatientforeignkeys)**
GET** /rest/v1/invoice/byHcPartySecretForeignKeysList invoices found By Healthcare Party and secret foreign patient keys.
InvoiceApilistInvoicesByHcPartyAndGroupId**
GET** /rest/v1/invoice/byHcPartyGroupId/{hcPartyId}/{groupId}List invoices by groupId
InvoiceApi[**
listInvoicesByHcPartySentMediumTypeInvoiceTypeSentDate**](doc//InvoiceApi.md#listinvoicesbyhcpartysentmediumtypeinvoicetypesentdate)**
GET** /rest/v1/invoice/byHcParty/{hcPartyId}/mediumType/{sentMediumType}/invoiceType/{invoiceType}/sent/{sent}List invoices by type, sent or unsent
InvoiceApi[**
listInvoicesByHcpartySendingModeStatusDate**](doc//InvoiceApi.md#listinvoicesbyhcpartysendingmodestatusdate)**
GET** /rest/v1/invoice/byHcpartySendingModeStatusDate/{hcPartyId}Get all invoices by author, by sending mode, by status and by date
InvoiceApilistInvoicesByIds**
GET** /rest/v1/invoice/byIds/{invoiceIds}Gets all invoices for author at date
InvoiceApilistInvoicesByRecipientsIds**
GET** /rest/v1/invoice/to/{recipientIds}Gets all invoices for author at date
InvoiceApilistInvoicesByServiceIds**
GET** /rest/v1/invoice/byServiceIds/{serviceIds}Gets all invoices for author at date
InvoiceApi[**
listInvoicesDelegationsStubsByHCPartyAndPatientForeignKeys**](doc//InvoiceApi.md#listinvoicesdelegationsstubsbyhcpartyandpatientforeignkeys)**
GET** /rest/v1/invoice/byHcPartySecretForeignKeys/delegationsList helement stubs found By Healthcare Party and secret foreign keys.
InvoiceApilistToInsurances**
GET** /rest/v1/invoice/toInsurancesGets all invoices for author at date
InvoiceApilistToInsurancesUnsent**
GET** /rest/v1/invoice/toInsurances/unsentGets all invoices for author at date
InvoiceApilistToPatients**
GET** /rest/v1/invoice/toPatientsGets all invoices for author at date
InvoiceApilistToPatientsUnsent**
GET** /rest/v1/invoice/toPatients/unsentGets all invoices for author at date
InvoiceApimergeTo**
POST** /rest/v1/invoice/mergeTo/{invoiceId}Gets all invoices for author at date
InvoiceApimodifyInvoicePUT /rest/v1/invoiceModifies an invoice
InvoiceApimodifyInvoices**
PUT** /rest/v1/invoice/batchModify a batch of invoices
InvoiceApinewInvoiceDelegations**
PUT** /rest/v1/invoice/{invoiceId}/delegateAdds a delegation to a invoice
InvoiceApireassignInvoice**
POST** /rest/v1/invoice/reassignModifies an invoice
InvoiceApiremoveCodes**
POST** /rest/v1/invoice/byauthor/{userId}/service/{serviceId}Remove an invoice of an user
InvoiceApisetInvoicesDelegations**
POST** /rest/v1/invoice/delegationsUpdate delegations in healthElements.
InvoiceApivalidate**
POST** /rest/v1/invoice/validate/{invoiceId}Gets all invoices for author at date
KeywordApicreateKeyword**
POST** /rest/v1/keywordCreate a keyword with the current user
KeywordApideleteKeywords**
POST** /rest/v1/keyword/delete/batchDelete keywords.
KeywordApigetKeywordGET /rest/v1/keyword/{keywordId}Get a keyword
KeywordApigetKeywordsGET /rest/v1/keywordGets all keywords
KeywordApigetKeywordsByUser**
GET** /rest/v1/keyword/byUser/{userId}Get keywords by user
KeywordApimodifyKeywordPUT /rest/v1/keywordModify a keyword
MedexApigenerateMedex**
POST** /rest/v1/medex/generateGenerate a Medex XML String
MedicalLocationApicreateMedicalLocation**
POST** /rest/v1/medicallocationCreates a medical location
MedicalLocationApideleteMedicalLocations**
POST** /rest/v1/medicallocation/delete/batchDeletes medical locations
MedicalLocationApigetMedicalLocation**
GET** /rest/v1/medicallocation/{locationId}Gets a medical location
MedicalLocationApigetMedicalLocations**
GET** /rest/v1/medicallocationGets all medical locations
MedicalLocationApimodifyMedicalLocation**
PUT** /rest/v1/medicallocationModifies a medical location
MessageApicreateMessagePOST /rest/v1/messageCreates a message
MessageApideleteDelegation**
DELETE** /rest/v1/message/{messageId}/delegate/{delegateId}Deletes a message delegation
MessageApideleteMessages**
POST** /rest/v1/message/delete/batchDeletes multiple messages
MessageApifindMessages**
GET** /rest/v1/messageGet all messages (paginated) for current HC Party
MessageApifindMessagesByFromAddress**
GET** /rest/v1/message/byFromAddressGet all messages (paginated) for current HC Party and provided from address
MessageApi[**
findMessagesByHCPartyPatientForeignKeys**](doc//MessageApi.md#findmessagesbyhcpartypatientforeignkeys)**
GET** /rest/v1/message/byHcPartySecretForeignKeysList messages found By Healthcare Party and secret foreign keys.
MessageApifindMessagesByToAddress**
GET** /rest/v1/message/byToAddressGet all messages (paginated) for current HC Party and provided to address
MessageApifindMessagesByTransportGuid**
GET** /rest/v1/message/byTransportGuidGet all messages (paginated) for current HC Party and provided transportGuid
MessageApifindMessagesByTransportGuidSentDate**
GET** /rest/v1/message/byTransportGuidSentDateGet all messages starting by a prefix between two date
MessageApigetChildrenMessages**
GET** /rest/v1/message/{messageId}/childrenGet children messages of provided message
MessageApigetMessageGET /rest/v1/message/{messageId}Gets a message
MessageApigetMessagesChildren**
POST** /rest/v1/message/children/batchGet children messages of provided message
MessageApilistMessagesByInvoices**
POST** /rest/v1/message/byInvoiceGet children messages of provided message
MessageApilistMessagesByTransportGuids**
POST** /rest/v1/message/byTransportGuid/listGet all messages for current HC Party and provided transportGuids
MessageApimodifyMessagePUT /rest/v1/messageUpdates a message
MessageApinewMessageDelegations**
PUT** /rest/v1/message/{messageId}/delegateAdds a delegation to a message
MessageApisetMessagesReadStatus**
PUT** /rest/v1/message/readstatusSet read status for given list of messages
MessageApisetMessagesStatusBits**
PUT** /rest/v1/message/status/{status}Set status bits for given list of messages
PatientApicountOfPatients**
GET** /rest/v1/patient/hcParty/{hcPartyId}/countGet count of patients for a specific HcParty or for the current HcParty
PatientApicreatePatientPOST /rest/v1/patientCreate a patient
PatientApicreatePatients**
POST** /rest/v1/patient/batchCreate patients in bulk
PatientApideletePatients**
POST** /rest/v1/patient/delete/batchDelete patients.
PatientApifilterPatientsBy**
POST** /rest/v1/patient/filterFilter patients for the current user (HcParty)
PatientApifindDeletedPatients**
GET** /rest/v1/patient/deleted/byDateFind deleted patients
PatientApifindDuplicatesByName**
POST** /rest/v1/patient/duplicates/nameProvides a paginated list of patients with duplicate name for an hecparty
PatientApifindDuplicatesBySsin**
POST** /rest/v1/patient/duplicates/ssinProvides a paginated list of patients with duplicate ssin for an hecparty
PatientApifindPatientsByAccessLogUserAfterDate**
GET** /rest/v1/patient/byAccess/{userId}Get Paginated List of Patients sorted by Access logs descending
PatientApifindPatientsByHealthcareParty**
GET** /rest/v1/patientList patients for a specific HcParty
PatientApifindPatientsByNameBirthSsinAuto**
GET** /rest/v1/patient/byNameBirthSsinAutoFind patients for the current user (HcParty)
PatientApifindPatientsIdsByHealthcareParty**
GET** /rest/v1/patient/byHcPartyIdList patients by pages for a specific HcParty
PatientApifindPatientsModifiedAfter**
GET** /rest/v1/patient/modifiedAfter/{date}List patients that have been modified after the provided date
PatientApifuzzySearch**
GET** /rest/v1/patient/fuzzyFilter patients for the current user (HcParty)
PatientApigetPatientGET /rest/v1/patient/{patientId}Get patient
PatientApigetPatientByExternalId**
GET** /rest/v1/patient/byExternalId/{externalId}Get the patient having the provided externalId
PatientApi[**
getPatientByHealthcarepartyAndIdentifier**](doc//PatientApi.md#getpatientbyhealthcarepartyandidentifier)**
GET** /rest/v1/patient/{hcPartyId}/{id}Get patient by identifier
PatientApigetPatientHcPartyKeysForDelegate**
GET** /rest/v1/patient/{patientId}/keysGet the patient (identified by patientId) hcparty keys. Those keys are AES keys (encrypted) used to share information between HCPs and a patient.
PatientApigetPatientsPOST /rest/v1/patient/byIdsGet patients by id
PatientApilistDeletedPatientsByName**
GET** /rest/v1/patient/deleted/by_nameFind deleted patients
PatientApilistOfMergesAfter**
GET** /rest/v1/patient/merges/{date}List patients that have been merged towards another patient
PatientApimatchPatientsBy**
POST** /rest/v1/patient/matchGet ids of patients matching the provided filter for the current user (HcParty)
PatientApimergeInto**
PUT** /rest/v1/patient/mergeInto/{toId}/from/{fromIds}Merge a series of patients into another patient
PatientApimodifyPatientPUT /rest/v1/patientModify a patient
PatientApimodifyPatientReferral**
PUT** /rest/v1/patient/{patientId}/referral/{referralId}Set a patient referral doctor
PatientApimodifyPatients**
PUT** /rest/v1/patient/batchModify patients in bulk
PatientApinewPatientDelegations**
POST** /rest/v1/patient/{patientId}/delegateDelegates a patients to a healthcare party
PatientApiregisterPatient**
POST** /rest/v1/patient/register/forHcp/{hcPartyId}/inGroup/{groupId}Register a patient
PatientApiundeletePatient**
PUT** /rest/v1/patient/undelete/{patientIds}undelete previously deleted patients
PermissionApimodifyUserPermissions**
PUT** /rest/v1/permissions/{userId}Add / Revoke permissions to user
PlaceApicreatePlacePOST /rest/v1/placeCreates a place
PlaceApideletePlacesPOST /rest/v1/place/delete/batchDeletes places
PlaceApigetPlaceGET /rest/v1/place/{placeId}Gets an place
PlaceApigetPlacesGET /rest/v1/placeGets all places
PlaceApimodifyPlacePUT /rest/v1/placeModifies an place
ReceiptApicreateReceiptPOST /rest/v1/receiptCreates a receipt
ReceiptApideleteReceipts**
POST** /rest/v1/receipt/delete/batchDeletes receipts
ReceiptApigetReceiptGET /rest/v1/receipt/{receiptId}Gets a receipt
ReceiptApigetReceiptAttachment**
GET** /rest/v1/receipt/{receiptId}/attachment/{attachmentId}Get an attachment
ReceiptApilistByReference**
GET** /rest/v1/receipt/byRef/{ref}Gets a receipt
ReceiptApimodifyReceiptPUT /rest/v1/receiptUpdates a receipt
ReceiptApisetReceiptAttachment**
PUT** /rest/v1/receipt/{receiptId}/attachment/{blobType}Creates a receipt's attachment
TarificationApicreateTarification**
POST** /rest/v1/tarificationCreate a Tarification
TarificationApifindTarificationsBy**
GET** /rest/v1/tarificationFinding tarifications by tarification, type and version with pagination.
TarificationApifindTarificationsBy1**
GET** /rest/v1/tarification/byRegionTypeTarificationFinding tarifications by tarification, type and version
TarificationApifindTarificationsByLabel**
GET** /rest/v1/tarification/byLabelFinding tarifications by tarification, type and version with pagination.
TarificationApigetTarification**
GET** /rest/v1/tarification/{tarificationId}Get a tarification
TarificationApigetTarificationWithParts**
GET** /rest/v1/tarification/{type}/{tarification}/{version}Get a tarification
TarificationApigetTarifications**
POST** /rest/v1/tarification/byIdsGet a list of tarifications by ids
TarificationApimodifyTarification**
PUT** /rest/v1/tarificationModify a tarification
TimeTableApicreateTimeTable**
POST** /rest/v1/timeTableCreates a timeTable
TimeTableApideleteTimeTable**
POST** /rest/v1/timeTable/delete/batchDeletes an timeTable
TimeTableApigetTimeTable**
GET** /rest/v1/timeTable/{timeTableId}Gets a timeTable
TimeTableApigetTimeTablesByAgendaId**
POST** /rest/v1/timeTable/byAgendaIdGet TimeTables by AgendaId
TimeTableApigetTimeTablesByPeriodAndAgendaId**
POST** /rest/v1/timeTable/byPeriodAndAgendaIdGet TimeTables by Period and AgendaId
TimeTableApimodifyTimeTable**
PUT** /rest/v1/timeTableModifies an timeTable
TmpApicreateTmpClassification**
POST** /rest/v1/tmp/classificationCreate a classification with the current user
TmpApicreateTmpClassifications**
POST** /rest/v1/tmp/classification/batchCreate a classification with the current user
TmpApicreateTmpContact**
POST** /rest/v1/tmp/contactCreate a contact with the current user
TmpApicreateTmpContacts**
POST** /rest/v1/tmp/contact/batchCreate a contact with the current user
TmpApicreateTmpDatabase**
POST** /rest/v1/tmpCreate tmp database for current user
TmpApicreateTmpDocument**
POST** /rest/v1/tmp/documentCreate a document with the current user
TmpApicreateTmpDocuments**
POST** /rest/v1/tmp/document/batchCreate a document with the current user
TmpApicreateTmpEntityTemplate**
POST** /rest/v1/tmp/entityTemplateCreate a entityTemplate with the current user
TmpApicreateTmpEntityTemplates**
POST** /rest/v1/tmp/entityTemplate/batchCreate a entityTemplate with the current user
TmpApicreateTmpForm**
POST** /rest/v1/tmp/formCreate a form with the current user
TmpApicreateTmpForms**
POST** /rest/v1/tmp/form/batchCreate a form with the current user
TmpApicreateTmpHealthElement**
POST** /rest/v1/tmp/healthElementCreate a healthElement with the current user
TmpApicreateTmpHealthElements**
POST** /rest/v1/tmp/healthElement/batchCreate a healthElement with the current user
TmpApicreateTmpInvoice**
POST** /rest/v1/tmp/invoiceCreate a invoice with the current user
TmpApicreateTmpInvoices**
POST** /rest/v1/tmp/invoice/batchCreate a invoice with the current user
TmpApicreateTmpMessage**
POST** /rest/v1/tmp/messageCreate a message with the current user
TmpApicreateTmpMessages**
POST** /rest/v1/tmp/message/batchCreate a message with the current user
TmpApicreateTmpPatient**
POST** /rest/v1/tmp/patientCreate a patient with the current user
TmpApicreateTmpPatients**
POST** /rest/v1/tmp/patient/batchCreate a patient with the current user
TmpApideleteTmpItemsPOST /rest/v1/tmp/batch/deleteSoft delete items.
TmpApidestroyTmpDatabase**
DELETE** /rest/v1/tmpDestroy tmp database for current user
TmpApigetTmpClassification**
GET** /rest/v1/tmp/classification/byId/{id}Get a classification by id
TmpApigetTmpClassifications**
POST** /rest/v1/tmp/classification/getGet classifications by ids with the current user
TmpApigetTmpContact**
GET** /rest/v1/tmp/contact/byId/{id}Get a contact by id
TmpApigetTmpContacts**
POST** /rest/v1/tmp/contact/getGet contacts by ids with the current user
TmpApigetTmpDocument**
GET** /rest/v1/tmp/document/byId/{id}Get a document by id
TmpApigetTmpDocuments**
POST** /rest/v1/tmp/document/getGet documents by ids with the current user
TmpApigetTmpEntityTemplate**
GET** /rest/v1/tmp/entityTemplate/byId/{id}Get a entityTemplate by id
TmpApigetTmpEntityTemplates**
POST** /rest/v1/tmp/entityTemplate/getGet entityTemplates by ids with the current user
TmpApigetTmpFormGET /rest/v1/tmp/form/byId/{id}Get a form by id
TmpApigetTmpForms**
POST** /rest/v1/tmp/form/getGet forms by ids with the current user
TmpApigetTmpHealthElement**
GET** /rest/v1/tmp/healthElement/byId/{id}Get a healthElement by id
TmpApigetTmpHealthElements**
POST** /rest/v1/tmp/healthElement/getGet healthElements by ids with the current user
TmpApigetTmpInvoice**
GET** /rest/v1/tmp/invoice/byId/{id}Get a invoice by id
TmpApigetTmpInvoices**
POST** /rest/v1/tmp/invoice/getGet invoices by ids with the current user
TmpApigetTmpMessage**
GET** /rest/v1/tmp/message/byId/{id}Get a message by id
TmpApigetTmpMessages**
POST** /rest/v1/tmp/message/getGet messages by ids with the current user
TmpApigetTmpPatient**
GET** /rest/v1/tmp/patient/byId/{id}Get a patient by id
TmpApigetTmpPatients**
POST** /rest/v1/tmp/patient/getGet patients by ids with the current user
TmpApilistTmpClassifications**
GET** /rest/v1/tmp/classification/listList classifications with the current user
TmpApilistTmpContacts**
GET** /rest/v1/tmp/contact/listList contacts with the current user
TmpApilistTmpDocuments**
GET** /rest/v1/tmp/document/listList documents with the current user
TmpApilistTmpEntityTemplates**
GET** /rest/v1/tmp/entityTemplate/listList entityTemplates with the current user
TmpApilistTmpForms**
GET** /rest/v1/tmp/form/listList forms with the current user
TmpApilistTmpHealthElements**
GET** /rest/v1/tmp/healthElement/listList healthElements with the current user
TmpApilistTmpInvoices**
GET** /rest/v1/tmp/invoice/listList invoices with the current user
TmpApilistTmpMessages**
GET** /rest/v1/tmp/message/listList messages with the current user
TmpApilistTmpPatients**
GET** /rest/v1/tmp/patient/listList patients with the current user
TmpApimodifyTmpClassification**
PUT** /rest/v1/tmp/classificationModify a classification
TmpApimodifyTmpClassifications**
PUT** /rest/v1/tmp/classification/batchModify a batch of healthcare elements
TmpApimodifyTmpContactPUT /rest/v1/tmp/contactModify a contact
TmpApimodifyTmpContacts**
PUT** /rest/v1/tmp/contact/batchModify a batch of healthcare elements
TmpApimodifyTmpDocumentPUT /rest/v1/tmp/documentModify a document
TmpApimodifyTmpDocuments**
PUT** /rest/v1/tmp/document/batchModify a batch of healthcare elements
TmpApimodifyTmpEntityTemplate**
PUT** /rest/v1/tmp/entityTemplateModify a entityTemplate
TmpApimodifyTmpEntityTemplates**
PUT** /rest/v1/tmp/entityTemplate/batchModify a batch of healthcare elements
TmpApimodifyTmpFormPUT /rest/v1/tmp/formModify a form
TmpApimodifyTmpForms**
PUT** /rest/v1/tmp/form/batchModify a batch of healthcare elements
TmpApimodifyTmpHealthElement**
PUT** /rest/v1/tmp/healthElementModify a healthElement
TmpApimodifyTmpHealthElements**
PUT** /rest/v1/tmp/healthElement/batchModify a batch of healthcare elements
TmpApimodifyTmpInvoicePUT /rest/v1/tmp/invoiceModify a invoice
TmpApimodifyTmpInvoices**
PUT** /rest/v1/tmp/invoice/batchModify a batch of healthcare elements
TmpApimodifyTmpMessagePUT /rest/v1/tmp/messageModify a message
TmpApimodifyTmpMessages**
PUT** /rest/v1/tmp/message/batchModify a batch of healthcare elements
TmpApimodifyTmpPatientPUT /rest/v1/tmp/patientModify a patient
TmpApimodifyTmpPatients**
PUT** /rest/v1/tmp/patient/batchModify a batch of healthcare elements
TmpApipurgeTmpItemsPOST /rest/v1/tmp/batch/purgeHard delete items.
TmpApireplicateToTmpDatabase**
POST** /rest/v1/tmp/replicate/from/{from}
UserApiassignHealthcareParty**
PUT** /rest/v1/user/current/hcparty/{healthcarePartyId}Assign a healthcare party ID to current user
UserApicheckPasswordGET /rest/v1/user/checkPassword
UserApicheckTokenValidity**
GET** /rest/v1/user/token/{userId}Check token validity
UserApicreateUserPOST /rest/v1/userCreate a user
UserApicreateUserInGroup**
POST** /rest/v1/user/inGroup/{groupId}Create a user
UserApideleteUser**
DELETE** /rest/v1/user/{userId}Delete a User based on his/her ID.
UserApideleteUserInGroup**
DELETE** /rest/v1/user/inGroup/{groupId}/{userId}Delete a User based on his/her ID.
UserApiencodePasswordGET /rest/v1/user/encodePassword
UserApifilterUsersBy**
POST** /rest/v1/user/filterFilter users for the current user (HcParty)
UserApifindByHcpartyId**
GET** /rest/v1/user/byHealthcarePartyId/{id}Get the list of users by healthcare party id
UserApiforgottenPassword**
POST** /rest/v1/user/forgottenPassword/{email}Send a forgotten email message to an user
UserApigetCurrentSession**
GET** /rest/v1/user/sessionGet Currently logged-in user session.
UserApigetCurrentUser**
GET** /rest/v1/user/currentGet presently logged-in user.
UserApigetMatchingUsers**
GET** /rest/v1/user/matchesGet presently logged-in user.
UserApigetToken**
POST** /rest/v1/user/token/{userId}/{key}Request a new temporary token for authentication
UserApigetUserGET /rest/v1/user/{userId}Get a user by his ID
UserApigetUserByEmail**
GET** /rest/v1/user/byEmail/{email}Get a user by his Email/Login
UserApilistUsersByGET /rest/v1/userList users with(out) pagination
UserApilistUsersInGroup**
GET** /rest/v1/user/inGroup/{groupId}List users with(out) pagination
UserApimatchUsersBy**
POST** /rest/v1/user/matchGet ids of healthcare party matching the provided filter for the current user (HcParty)
UserApimodifyProperties**
PUT** /rest/v1/user/{userId}/propertiesModify a User property
UserApimodifyUserPUT /rest/v1/userModify a user.
UserApimodifyUserInGroup**
PUT** /rest/v1/user/inGroup/{groupId}Modify a user.

Documentation For Models

Documentation For Authorization

basicSchema

  • Type: HTTP Basic authentication

Author

Libraries

binary_utils
collection_utils
crypto
data_owner_resolver
functional_utils
icure_dart_sdk.api