Skip to main content

MedTechApi

@icure/medical-device-sdk / MedTechApi

Class: MedTechApi

Table of contents​

Constructors​

Properties​

Accessors​

Methods​

Constructors​

constructor​

• new MedTechApi(api, basePath, username, password, msgGtwUrl?, msgGtwSpecId?, authProcessByEmailId?, authProcessBySmsId?, storage?, keyStorage?)

Parameters​

NameTypeDefault value
apiObjectundefined
api.accessLogApiIccAccesslogXApiundefined
api.agendaApiIccAgendaApiundefined
api.authApiIccAuthApiundefined
api.calendarItemApiIccCalendarItemXApiundefined
api.classificationApiIccClassificationXApiundefined
api.codeApiIccCodeXApiundefined
api.contactApiIccContactXApiundefined
api.cryptoApiIccCryptoXApiundefined
api.dataOwnerApiIccDataOwnerXApiundefined
api.deviceApiIccDeviceApiundefined
api.documentApiIccDocumentXApiundefined
api.entityReferenceApiIccEntityrefApiundefined
api.formApiIccFormXApiundefined
api.groupApiIccGroupApiundefined
api.healthcareElementApiIccHelementXApiundefined
api.healthcarePartyApiIccHcpartyXApiundefined
api.insuranceApiIccInsuranceApiundefined
api.invoiceApiIccInvoiceXApiundefined
api.maintenanceTaskApiIccMaintenanceTaskXApiundefined
api.messageApiIccMessageXApiundefined
api.patientApiIccPatientXApiundefined
api.receiptApiIccReceiptXApiundefined
api.timetableApiIccTimeTableXApiundefined
api.userApiIccUserXApiundefined
basePathstringundefined
usernamestringundefined
passwordstringundefined
msgGtwUrlundefined | stringundefined
msgGtwSpecIdundefined | stringundefined
authProcessByEmailIdundefined | stringundefined
authProcessBySmsIdundefined | stringundefined
storage?StorageFacade<string>undefined
keyStorage?KeyStorageFacadeundefined

Defined in​

src/apis/MedTechApi.ts:111

Properties​

_authenticationApi​

• Private Readonly _authenticationApi: undefined | AuthenticationApi

Defined in​

src/apis/MedTechApi.ts:79

_baseApi​

• Private Readonly _baseApi: Object

Type declaration​

NameType
accessLogApiIccAccesslogXApi
authApiIccAuthApi
calendarItemApiIccCalendarItemXApi
classificationApiIccClassificationXApi
codeApiIccCodeXApi
contactApiIccContactXApi
cryptoApiIccCryptoXApi
dataOwnerApiIccDataOwnerXApi
deviceApiIccDeviceApi
documentApiIccDocumentXApi
entityReferenceApiIccEntityrefApi
formApiIccFormXApi
groupApiIccGroupApi
healthcareElementApiIccHelementXApi
healthcarePartyApiIccHcpartyXApi
insuranceApiIccInsuranceApi
invoiceApiIccInvoiceXApi
maintenanceTaskApiIccMaintenanceTaskXApi
messageApiIccMessageXApi
patientApiIccPatientXApi
receiptApiIccReceiptXApi
timetableApiIccTimeTableXApi
userApiIccUserXApi

Defined in​

src/apis/MedTechApi.ts:85

_codingApi​

• Private Readonly _codingApi: CodingApi

Defined in​

src/apis/MedTechApi.ts:64

_cryptoApi​

• Private Readonly _cryptoApi: IccCryptoXApi

Defined in​

src/apis/MedTechApi.ts:73

_dataOwnerApi​

• Private Readonly _dataOwnerApi: DataOwnerApi

Defined in​

src/apis/MedTechApi.ts:72

_dataSampleApi​

• Private Readonly _dataSampleApi: DataSampleApi

Defined in​

src/apis/MedTechApi.ts:71

_errorHandler​

• Private Readonly _errorHandler: ErrorHandler

Defined in​

src/apis/MedTechApi.ts:81

_healthcareElementApi​

• Private Readonly _healthcareElementApi: HealthcareElementApi

Defined in​

src/apis/MedTechApi.ts:67

_healthcareProfessionalApi​

• Private Readonly _healthcareProfessionalApi: HealthcareProfessionalApi

Defined in​

src/apis/MedTechApi.ts:70

_iCureBaseUrl​

• Private Readonly _iCureBaseUrl: string

Defined in​

src/apis/MedTechApi.ts:75

_keyStorage​

• Private Readonly _keyStorage: KeyStorageFacade

Defined in​

src/apis/MedTechApi.ts:84

_medicalDeviceApi​

• Private Readonly _medicalDeviceApi: MedicalDeviceApi

Defined in​

src/apis/MedTechApi.ts:69

_messageGatewayApi​

• Private Readonly _messageGatewayApi: undefined | MessageGatewayApi

Defined in​

src/apis/MedTechApi.ts:80

_notificationApi​

• Private Readonly _notificationApi: NotificationApi

Defined in​

src/apis/MedTechApi.ts:68

_password​

• Private Readonly _password: string

Defined in​

src/apis/MedTechApi.ts:77

_patientApi​

• Private Readonly _patientApi: PatientApi

Defined in​

src/apis/MedTechApi.ts:66

_sanitizer​

• Private Readonly _sanitizer: Sanitizer

Defined in​

src/apis/MedTechApi.ts:82

_storage​

• Private Readonly _storage: StorageFacade<string>

Defined in​

src/apis/MedTechApi.ts:83

_userApi​

• Private Readonly _userApi: UserApi

Defined in​

src/apis/MedTechApi.ts:65

_username​

• Private Readonly _username: string

Defined in​

src/apis/MedTechApi.ts:76

Accessors​

authenticationApi​

• get authenticationApi(): AuthenticationApi

Returns​

AuthenticationApi

Defined in​

src/apis/MedTechApi.ts:231

codingApi​

• get codingApi(): CodingApi

Returns​

CodingApi

Defined in​

src/apis/MedTechApi.ts:191

cryptoApi​

• get cryptoApi(): IccCryptoXApi

Returns​

IccCryptoXApi

Defined in​

src/apis/MedTechApi.ts:227

dataOwnerApi​

• get dataOwnerApi(): DataOwnerApi

Returns​

DataOwnerApi

Defined in​

src/apis/MedTechApi.ts:223

dataSampleApi​

• get dataSampleApi(): DataSampleApi

Returns​

DataSampleApi

Defined in​

src/apis/MedTechApi.ts:219

healthcareElementApi​

• get healthcareElementApi(): HealthcareElementApi

Returns​

HealthcareElementApi

Defined in​

src/apis/MedTechApi.ts:203

healthcareProfessionalApi​

• get healthcareProfessionalApi(): HealthcareProfessionalApi

Returns​

HealthcareProfessionalApi

Defined in​

src/apis/MedTechApi.ts:215

iCureBaseUrl​

• get iCureBaseUrl(): string

Returns​

string

Defined in​

src/apis/MedTechApi.ts:241

keyStorage​

• get keyStorage(): KeyStorageFacade

Returns​

KeyStorageFacade

Defined in​

src/apis/MedTechApi.ts:257

medicalDeviceApi​

• get medicalDeviceApi(): MedicalDeviceApi

Returns​

MedicalDeviceApi

Defined in​

src/apis/MedTechApi.ts:211

notificationApi​

• get notificationApi(): NotificationApi

Returns​

NotificationApi

Defined in​

src/apis/MedTechApi.ts:207

password​

• get password(): string

Returns​

string

Defined in​

src/apis/MedTechApi.ts:249

patientApi​

• get patientApi(): PatientApi

Returns​

PatientApi

Defined in​

src/apis/MedTechApi.ts:199

storage​

• get storage(): StorageFacade<string>

Returns​

StorageFacade<string>

Defined in​

src/apis/MedTechApi.ts:253

userApi​

• get userApi(): UserApi

Returns​

UserApi

Defined in​

src/apis/MedTechApi.ts:195

username​

• get username(): string

Returns​

string

Defined in​

src/apis/MedTechApi.ts:245

Methods​

addKeyPair​

▸ addKeyPair(dataOwnerId, keyPair): Promise<void>

Parameters​

NameType
dataOwnerIdstring
keyPairObject
keyPair.privateKeystring
keyPair.publicKeystring

Returns​

Promise<void>

Defined in​

src/apis/MedTechApi.ts:261

initUserCrypto​

▸ initUserCrypto(keyPair?): Promise<{ privateKey: string ; publicKey: string }[]>

Parameters​

NameType
keyPair?Object
keyPair.privateKeystring
keyPair.publicKeystring

Returns​

Promise<{ privateKey: string ; publicKey: string }[]>

Defined in​

src/apis/MedTechApi.ts:270