Package @icure/medical-device-sdk

Table of contents

Entry points APIs

• AnonymousMedTechApi
• MedTechApi

Builders

• AnonymousMedTechApiBuilder
• MedTechApiBuilder

APIs

• AuthenticationApi
• CodingApi
• DataOwnerApi
• DataSampleApi
• HealthcareElementApi
• HealthcareProfessionalApi
• MedicalDeviceApi
• NotificationApi
• PatientApi
• UserApi

Interfaces

• Connection
• EmailMessageFactory
• KeyStorageFacade
• MsgGtwMessageFactory
• PotentiallyEncryptedPatient
• SMSMessageFactory
• StorageFacade

Domain classes

• Address
• AuthenticationToken
• Coding
• CodingReference
• ConnectionImpl
• Content
• DataSample
• Delegation
• Document
• EncryptedPatient
• HealthcareElement
• HealthcareProfessional
• ICureRegistrationEmail
• ICureRegistrationSMS
• Identifier
• InlineResponse403
• KeyStorageImpl
• LocalStorageImpl
• Measure
• MedicalDevice
• PaginatedDocumentKeyAndIdPairObject
• PaginatedListCoding
• PaginatedListDataSample
• PaginatedListHealthcareElement
• PaginatedListHealthcareProfessional
• PaginatedListMedicalDevice
• PaginatedListPatient
• PaginatedListUser
• Partnership
• Patient
• PatientHealthCareParty
• PersonName
• Property
• PropertyType
• SystemMetaDataEncrypted
• SystemMetaDataOwner
• SystemMetaDataOwnerEncrypted
• Telecom
• TimeSeries
• TypedValueObject
• User
• UuidEncoder

Filters

• CodingFilter
• DataSampleFilter
• Filter
• HealthcareElementFilter
• HealthcareProfessionalFilter
• MedicalDeviceFilter
• NotificationFilter
• PatientFilter
• UserFilter

Utility functions

• a2b
• amount
• b2a
• b64Url2ua
• b64_2ab
• b64_2ua
• b64_2uas
• dateDecode
• dateEncode
• hex2string
• hex2ua
• ibanFormat
• ibanValidate
• isValidIBAN
• medTechApi
• money
• nihiiFormat
• nihiiValidate
• personName
• personNameAbbrev
• phoneNumberFormat
• phoneNumberValidate
• ssinFormat
• ssinValidate
• string2ab
• string2hex
• string2ua
• timeDecode
• timeEncode
• toMoment
• toUrlParams
• ua2ab
• ua2b64
• ua2b64Url
• ua2hex
• ua2string
• ua2utf8
• unit
• utf8_2ua

Utility Functions Documentation

a2b

▸ a2b(s): string

Parameters

Name	Type
s	string

Returns

string

Defined in

node_modules/@icure/api/icc-api/model/ModelHelper.d.ts:9

---

amount

▸ amount(value): number

0.1 + 0.2 = 0.30000000000000004. Use this function to be better at maths.

Parameters

Name	Type
value	number

Returns

number

the rounded number, two after the comma

Defined in

node_modules/@icure/api/icc-x-api/utils/formatting-util.d.ts:58

---

b2a

▸ b2a(a): string

Parameters

Name	Type
a	string

Returns

string

Defined in

node_modules/@icure/api/icc-api/model/ModelHelper.d.ts:8

---

b64Url2ua

▸ b64Url2ua(ua): ArrayBuffer

Parameters

Name	Type
ua	string

Returns

ArrayBuffer

Defined in

node_modules/@icure/api/icc-x-api/utils/binary-utils.d.ts:20

---

b64_2ab

▸ b64_2ab(s): ArrayBuffer

Parameters

Name	Type
s	string

Returns

ArrayBuffer

Defined in

node_modules/@icure/api/icc-api/model/ModelHelper.d.ts:5

---

b64_2ua

▸ b64_2ua(s): Uint8Array

Parameters

Name	Type
s	string

Returns

Uint8Array

Defined in

node_modules/@icure/api/icc-api/model/ModelHelper.d.ts:6

---

b64_2uas

▸ b64_2uas(s): Uint8Array[]

Parameters

Name	Type
s	string

Returns

Uint8Array[]

Defined in

node_modules/@icure/api/icc-x-api/utils/binary-utils.d.ts:18

---

dateDecode

▸ dateDecode(dateNumber): Date | undefined

Converts a backend date number (e.g., patient birth date) into a Date object.

Throws

Error if it is impossible to create a date from the number, other if dateNumber is negative.

See

• #dateEncode
• #timeDecode

Parameters

Name	Type	Description
dateNumber	number	a YYYYMMDD date number from the backend

Returns

Date | undefined

a Date object

Defined in

node_modules/@icure/api/icc-x-api/utils/formatting-util.d.ts:22

---

dateEncode

▸ dateEncode(date): number | undefined

Encodes a Date object into a backend date number (e.g., patient birth date).

See

• #dateDecode
• #timeEncode

Parameters

Name	Type	Description
date	Date	a Date object

Returns

number | undefined

a YYYYMMDD date number for the backend

Defined in

node_modules/@icure/api/icc-x-api/utils/formatting-util.d.ts:38

---

hex2string

▸ hex2string(hexStr): string

Parameters

Name	Type
hexStr	string

Returns

string

Defined in

node_modules/@icure/api/icc-x-api/utils/binary-utils.d.ts:21

---

hex2ua

▸ hex2ua(s): Uint8Array

Parameters

Name	Type
s	string

Returns

Uint8Array

Defined in

node_modules/@icure/api/icc-x-api/utils/binary-utils.d.ts:10

---

ibanFormat

▸ ibanFormat(iban): string

Parameters

Name	Type
iban	string

Returns

string

Defined in

node_modules/@icure/api/icc-x-api/utils/formatting-util.d.ts:7

---

ibanValidate

▸ ibanValidate(iban): boolean

Parameters

Name	Type
iban	string

Returns

boolean

Defined in

node_modules/@icure/api/icc-x-api/utils/formatting-util.d.ts:6

---

isValidIBAN

▸ isValidIBAN(iban): boolean

Parameters

Name	Type
iban	string

Returns

boolean

Defined in

node_modules/@icure/api/icc-x-api/utils/formatting-util.d.ts:5

---

medTechApi

▸ medTechApi(api?): MedTechApiBuilder

Parameters

Name	Type
api?	MedTechApi

Returns

MedTechApiBuilder

Defined in

src/apis/MedTechApi.ts:384

---

money

▸ money(value): string

A simple formatter to keep the logic across the app. Input: 2.1 ; Output: 2.10€

Parameters

Name	Type
value	number

Returns

string

Defined in

node_modules/@icure/api/icc-x-api/utils/formatting-util.d.ts:63

---

nihiiFormat

▸ nihiiFormat(nihii): string

Parameters

Name	Type
nihii	string

Returns

string

Defined in

node_modules/@icure/api/icc-x-api/utils/formatting-util.d.ts:8

---

nihiiValidate

▸ nihiiValidate(nihii): boolean

Parameters

Name	Type
nihii	string

Returns

boolean

Defined in

node_modules/@icure/api/icc-x-api/utils/formatting-util.d.ts:9

---

personName

▸ personName(person): string

Parameters

Name	Type
person	Object
person.firstName?	string
person.lastName?	string

Returns

string

Defined in

node_modules/@icure/api/icc-x-api/utils/formatting-util.d.ts:71

---

personNameAbbrev

▸ personNameAbbrev(person): string

Parameters

Name	Type
person	Object
person.firstName?	string
person.lastName?	string

Returns

string

Defined in

node_modules/@icure/api/icc-x-api/utils/formatting-util.d.ts:75

---

phoneNumberFormat

▸ phoneNumberFormat(phoneNumber): string

Parameters

Name	Type
phoneNumber	string

Returns

string

Defined in

node_modules/@icure/api/icc-x-api/utils/formatting-util.d.ts:13

---

phoneNumberValidate

▸ phoneNumberValidate(phoneNumber): boolean

Parameters

Name	Type
phoneNumber	string

Returns

boolean

Defined in

node_modules/@icure/api/icc-x-api/utils/formatting-util.d.ts:12

---

ssinFormat

▸ ssinFormat(ssin): string

Parameters

Name	Type
ssin	string

Returns

string

Defined in

node_modules/@icure/api/icc-x-api/utils/formatting-util.d.ts:10

---

ssinValidate

▸ ssinValidate(ssin): boolean

Parameters

Name	Type
ssin	string

Returns

boolean

Defined in

node_modules/@icure/api/icc-x-api/utils/formatting-util.d.ts:11

---

string2ab

▸ string2ab(s): ArrayBuffer

Parameters

Name	Type
s	string

Returns

ArrayBuffer

Defined in

node_modules/@icure/api/icc-api/model/ModelHelper.d.ts:3

---

string2hex

▸ string2hex(text): string

Parameters

Name	Type
text	string

Returns

string

Defined in

node_modules/@icure/api/icc-x-api/utils/binary-utils.d.ts:22

---

string2ua

▸ string2ua(s): Uint8Array

Parameters

Name	Type
s	string

Returns

Uint8Array

Defined in

node_modules/@icure/api/icc-api/model/ModelHelper.d.ts:2

---

timeDecode

▸ timeDecode(timeNumber): Date | undefined

Converts a backend time number (e.g., health element openingDate) into a Date object.

See

• #timeEncode
• #dateDecode

Parameters

Name	Type	Description
timeNumber	number	a YYYYMMDD date number from the backend

Returns

Date | undefined

a Date object

Defined in

node_modules/@icure/api/icc-x-api/utils/formatting-util.d.ts:30

---

timeEncode

▸ timeEncode(date): number | undefined

Encodes a Date object into a backend time number (e.g., health element openingDate).

See

• #timeDecode
• #dateEncode

Parameters

Name	Type	Description
date	Date	a Date object

Returns

number | undefined

a YYYYMMDDHHmmss date number for the backend

Defined in

node_modules/@icure/api/icc-x-api/utils/formatting-util.d.ts:46

---

toMoment

▸ toMoment(epochOrLongCalendar): Moment | null

Parameters

Name	Type
epochOrLongCalendar	number

Returns

Moment | null

Defined in

node_modules/@icure/api/icc-x-api/utils/formatting-util.d.ts:79

---

toUrlParams

▸ toUrlParams(params): string

Transform a dictionary to a url params. From { key1: value1, key2: value2, ... } returns key1=value1&key2=value2&...=...

Parameters

Name	Type
params	Object

Returns

string

Defined in

node_modules/@icure/api/icc-x-api/utils/formatting-util.d.ts:68

---

ua2ab

▸ ua2ab(ua): ArrayBuffer

Parameters

Name	Type
ua	Uint8Array

Returns

ArrayBuffer

Defined in

node_modules/@icure/api/icc-api/model/ModelHelper.d.ts:4

---

ua2b64

▸ ua2b64(_ua): string

Parameters

Name	Type
_ua	ArrayBuffer | Uint8Array

Returns

string

Defined in

node_modules/@icure/api/icc-api/model/ModelHelper.d.ts:7

---

ua2b64Url

▸ ua2b64Url(ua): string

Parameters

Name	Type
ua	ArrayBuffer | Uint8Array

Returns

string

Defined in

node_modules/@icure/api/icc-x-api/utils/binary-utils.d.ts:19

---

ua2hex

▸ ua2hex(_ua): string

Uint8Array/ArrayBuffer to hex String

Parameters

Name	Type	Description
_ua	ArrayBuffer | Uint8Array	{Uint8Array} or ArrayBuffer

Returns

string

Hex String

Defined in

node_modules/@icure/api/icc-x-api/utils/binary-utils.d.ts:17

---

ua2string

▸ ua2string(_ua): string

Parameters

Name	Type
_ua	ArrayBuffer | Uint8Array

Returns

string

Defined in

node_modules/@icure/api/icc-api/model/ModelHelper.d.ts:1

---

ua2utf8

▸ ua2utf8(_ua): string

Uint8Array/ArrayBuffer to utf-8 strring

Parameters

Name	Type	Description
_ua	ArrayBuffer | Uint8Array	{Uint8Array} or ArrayBuffer

Returns

string

a UTF-8 encoded string

Defined in

node_modules/@icure/api/icc-x-api/utils/binary-utils.d.ts:9

---

unit

▸ unit(value, unit): string

Formats a value and a physical unit into text.

Parameters

Name	Type	Description
value	string | number	the numerical or string value to encode
unit	null | string	the unit represented as a string (an empty string is also supported)

Returns

string

Defined in

node_modules/@icure/api/icc-x-api/utils/formatting-util.d.ts:52

---

utf8_2ua

▸ utf8_2ua(str): Uint8Array

Parameters

Name	Type
str	string

Returns

Uint8Array

Defined in

node_modules/@icure/api/icc-x-api/utils/binary-utils.d.ts:3