Skip to main content

@icure/medical-device-sdk

Table of contents

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

AddressAddressTypeEnum

Ƭ AddressAddressTypeEnum: "home" | "work" | "vacation" | "hospital" | "clinic" | "hq" | "other" | "temporary" | "postal" | "diplomatic" | "reference"

Defined in

src/models/Address.ts:52


AuthenticationProcessBody

Ƭ AuthenticationProcessBody: Object

Type declaration

NameType
emailstring | undefined
firstNamestring
fromstring | undefined
g-recaptcha-responsestring
hcpIdstring | undefined
lastNamestring
mobilePhonestring | undefined

Defined in

src/utils/msgGtwMessageFactory.ts:8


EmailMessage

Ƭ EmailMessage: Object

Type declaration

NameType
fromstring
htmlstring
subjectstring

Defined in

src/utils/msgGtwMessageFactory.ts:7


HealthcareProfessionalGenderEnum

Ƭ HealthcareProfessionalGenderEnum: "male" | "female" | "indeterminate" | "changed" | "changedToMale" | "changedToFemale" | "unknown"

Defined in

src/models/HealthcareProfessional.ts:125


PartnershipStatusEnum

Ƭ PartnershipStatusEnum: "active" | "complicated" | "past"

Defined in

src/models/Partnership.ts:36


PartnershipTypeEnum

Ƭ PartnershipTypeEnum: "primary_contact" | "primary_contact_for" | "family" | "friend" | "counselor" | "contact" | "brother" | "brotherinlaw" | "child" | "daughter" | "employer" | "father" | "grandchild" | "grandparent" | "husband" | "lawyer" | "mother" | "neighbour" | "notary" | "partner" | "sister" | "sisterinlaw" | "son" | "spouse" | "stepdaughter" | "stepfather" | "stepmother" | "stepson" | "tutor" | "next_of_kin" | "federal_agency" | "insurance_company" | "state_agency" | "unknown" | "seealso" | "refer"

Defined in

src/models/Partnership.ts:35


PatientBirthSexEnum

Ƭ PatientBirthSexEnum: "male" | "female" | "indeterminate" | "changed" | "changedToMale" | "changedToFemale" | "unknown"

Defined in

src/models/Patient.ts:282


PatientDeactivationReasonEnum

Ƭ PatientDeactivationReasonEnum: "deceased" | "moved" | "other_doctor" | "retired" | "no_contact" | "unknown" | "none"

Defined in

src/models/Patient.ts:283


PatientGenderEnum

Ƭ PatientGenderEnum: "male" | "female" | "indeterminate" | "changed" | "changedToMale" | "changedToFemale" | "unknown"

Defined in

src/models/Patient.ts:281


PatientHealthCarePartyTypeEnum

Ƭ PatientHealthCarePartyTypeEnum: "doctor" | "referral" | "medicalhouse" | "retirementhome" | "hospital" | "other" | "referringphysician" | "managingorganization"

Defined in

src/models/PatientHealthCareParty.ts:33


PatientPersonalStatusEnum

Ƭ PatientPersonalStatusEnum: "single" | "in_couple" | "married" | "separated" | "divorced" | "divorcing" | "widowed" | "widower" | "complicated" | "unknown" | "contract" | "other" | "annulled" | "polygamous"

Defined in

src/models/Patient.ts:284


PersonNameUseEnum

Ƭ PersonNameUseEnum: "usual" | "official" | "temp" | "nickname" | "anonymous" | "maiden" | "old" | "other"

Defined in

src/models/PersonName.ts:45


PropertyTypeTypeEnum

Ƭ PropertyTypeTypeEnum: "BOOLEAN" | "INTEGER" | "DOUBLE" | "STRING" | "DATE" | "CLOB" | "JSON"

Defined in

src/models/PropertyType.ts:30


SMSMessage

Ƭ SMSMessage: Object

Type declaration

NameType
messagestring

Defined in

src/utils/msgGtwMessageFactory.ts:6


SharedDataType

Ƭ SharedDataType: "all" | "administrativeData" | "generalInformation" | "financialInformation" | "medicalInformation" | "sensitiveInformation" | "confidentialInformation"

Defined in

src/models/User.ts:100


TelecomTelecomTypeEnum

Ƭ TelecomTelecomTypeEnum: "mobile" | "phone" | "email" | "fax" | "skype" | "im" | "medibridge" | "ehealthbox" | "apicrypt" | "web" | "print" | "disk" | "other" | "pager"

Defined in

src/models/Telecom.ts:32


TypedValueObjectTypeEnum

Ƭ TypedValueObjectTypeEnum: "BOOLEAN" | "INTEGER" | "DOUBLE" | "STRING" | "DATE" | "CLOB" | "JSON"

Defined in

src/models/TypedValueObject.ts:38

Variables

ibanRegExp

Const ibanRegExp: RegExp

Defined in

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


nihiiRegExp

Const nihiiRegExp: RegExp

Defined in

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


ssinRegExp

Const ssinRegExp: RegExp

Defined in

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

Functions

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:334


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