Skip to main content

Package @icure/medical-device-sdk

Table of contents​

Entry points APIs​

Builders​

APIs​

Interfaces​

Domain classes​

Filters​

Utility functions​

Utility Functions Documentation​

a2b​

â–¸ a2b(s): string

Parameters​

NameType
sstring

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​

NameType
valuenumber

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​

NameType
astring

Returns​

string

Defined in​

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

b64Url2ua​

â–¸ b64Url2ua(ua): ArrayBuffer

Parameters​

NameType
uastring

Returns​

ArrayBuffer

Defined in​

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

b64_2ab​

â–¸ b64_2ab(s): ArrayBuffer

Parameters​

NameType
sstring

Returns​

ArrayBuffer

Defined in​

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

b64_2ua​

â–¸ b64_2ua(s): Uint8Array

Parameters​

NameType
sstring

Returns​

Uint8Array

Defined in​

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

b64_2uas​

â–¸ b64_2uas(s): Uint8Array[]

Parameters​

NameType
sstring

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​

NameTypeDescription
dateNumbernumbera 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​

NameTypeDescription
dateDatea 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​

NameType
hexStrstring

Returns​

string

Defined in​

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

hex2ua​

â–¸ hex2ua(s): Uint8Array

Parameters​

NameType
sstring

Returns​

Uint8Array

Defined in​

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

ibanFormat​

â–¸ ibanFormat(iban): string

Parameters​

NameType
ibanstring

Returns​

string

Defined in​

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

ibanValidate​

â–¸ ibanValidate(iban): boolean

Parameters​

NameType
ibanstring

Returns​

boolean

Defined in​

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

isValidIBAN​

â–¸ isValidIBAN(iban): boolean

Parameters​

NameType
ibanstring

Returns​

boolean

Defined in​

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

medTechApi​

â–¸ medTechApi(api?): MedTechApiBuilder

Parameters​

NameType
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​

NameType
valuenumber

Returns​

string

Defined in​

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

nihiiFormat​

â–¸ nihiiFormat(nihii): string

Parameters​

NameType
nihiistring

Returns​

string

Defined in​

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

nihiiValidate​

â–¸ nihiiValidate(nihii): boolean

Parameters​

NameType
nihiistring

Returns​

boolean

Defined in​

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

personName​

â–¸ personName(person): string

Parameters​

NameType
personObject
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​

NameType
personObject
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​

NameType
phoneNumberstring

Returns​

string

Defined in​

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

phoneNumberValidate​

â–¸ phoneNumberValidate(phoneNumber): boolean

Parameters​

NameType
phoneNumberstring

Returns​

boolean

Defined in​

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

ssinFormat​

â–¸ ssinFormat(ssin): string

Parameters​

NameType
ssinstring

Returns​

string

Defined in​

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

ssinValidate​

â–¸ ssinValidate(ssin): boolean

Parameters​

NameType
ssinstring

Returns​

boolean

Defined in​

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

string2ab​

â–¸ string2ab(s): ArrayBuffer

Parameters​

NameType
sstring

Returns​

ArrayBuffer

Defined in​

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

string2hex​

â–¸ string2hex(text): string

Parameters​

NameType
textstring

Returns​

string

Defined in​

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

string2ua​

â–¸ string2ua(s): Uint8Array

Parameters​

NameType
sstring

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​

NameTypeDescription
timeNumbernumbera 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​

NameTypeDescription
dateDatea 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​

NameType
epochOrLongCalendarnumber

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​

NameType
paramsObject

Returns​

string

Defined in​

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

ua2ab​

â–¸ ua2ab(ua): ArrayBuffer

Parameters​

NameType
uaUint8Array

Returns​

ArrayBuffer

Defined in​

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

ua2b64​

â–¸ ua2b64(_ua): string

Parameters​

NameType
_uaArrayBuffer | Uint8Array

Returns​

string

Defined in​

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

ua2b64Url​

â–¸ ua2b64Url(ua): string

Parameters​

NameType
uaArrayBuffer | 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​

NameTypeDescription
_uaArrayBuffer | 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​

NameType
_uaArrayBuffer | 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​

NameTypeDescription
_uaArrayBuffer | 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​

NameTypeDescription
valuestring | numberthe numerical or string value to encode
unitnull | stringthe 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​

NameType
strstring

Returns​

Uint8Array

Defined in​

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