Skip to main content

User

A User represents an actor that can log in to the iCure platform and instantiate the MedTech API. It can be associated to a Practitioner, to a Patient, or to a Device.
A Practitioner can create and invite a new User, as well as modifying or deactivating an existing one. A Data Owner without a User cannot access the iCure Platform.

When Should I Use a User?​

You should use a User when you want to allow a Practitioner, a Patient, or a Device to access the iCure platform.

A User can log in and instantiate the MedTech API. A Practitioner can create and invite a User. A User can be associated to a Practitioner, a Patient, or a Medical Device.

Examples​

A User Logging In​

A Patients wants to log in to iCure to use its functionalities. To do so, they use their User credentials to instantiate the EhrLite API.

const api = await new EHRLiteApi.Builder()
  .withICureBaseUrl(host)
  .withUserName(patientUserName)
  .withPassword(patientPassword)
  .withCrypto(webcrypto as any)
  .withCryptoStrategies(new SimpleEHRLiteCryptoStrategies([]))
  .build()

A Doctor Inviting a Patient​

A Doctor (Practitioner) visits for the first time a Patient. After the visit, they invite the patient to the iCure platform.

const createdUser = await api.userApi.createAndInviteFor(existingPatient)