MedicalDeviceApi
@icure/medical-device-sdk / MedicalDeviceApi
SDK API: MedicalDeviceApi
The MedicalDeviceApi interface provides methods to manage medical devices.
Table of contents
Methods
- createOrModifyMedicalDevice
- createOrModifyMedicalDevices
- deleteMedicalDevice
- deleteMedicalDevices
- filterMedicalDevices
- getMedicalDevice
- matchMedicalDevices
Methods
createOrModifyMedicalDevice
▸ createOrModifyMedicalDevice(medicalDevice): Promise<MedicalDevice>
When modifying a device, you must ensure that the rev obtained when getting or creating the device is present as the rev is used to guarantee that the device has not been modified by a third party. Create or update a [MedicalDevice]
Parameters
| Name | Type |
|---|---|
medicalDevice | MedicalDevice |
Returns
Promise<MedicalDevice>
Defined in
src/apis/MedicalDeviceApi.ts:15
createOrModifyMedicalDevices
▸ createOrModifyMedicalDevices(medicalDevice): Promise<MedicalDevice[]>
When modifying a device, you must ensure that the rev obtained when getting or creating the device is present as the rev is used to guarantee that the device has not been modified by a third party. Create or update a batch of [MedicalDevice]
Parameters
| Name | Type |
|---|---|
medicalDevice | MedicalDevice[] |
Returns
Promise<MedicalDevice[]>
Defined in
src/apis/MedicalDeviceApi.ts:21
deleteMedicalDevice
▸ deleteMedicalDevice(medicalDeviceId): Promise<string>
Deletes the medical device identified by the provided unique [medicalDeviceId]. Delete a [MedicalDevice]
Parameters
| Name | Type |
|---|---|
medicalDeviceId | string |
Returns
Promise<string>
Defined in
src/apis/MedicalDeviceApi.ts:27
deleteMedicalDevices
▸ deleteMedicalDevices(requestBody): Promise<string[]>
Deletes the batch of medical device identified by the provided [medicalDeviceIds]. Delete a batch of [MedicalDevice]
Parameters
| Name | Type |
|---|---|
requestBody | string[] |
Returns
Promise<string[]>
Defined in
src/apis/MedicalDeviceApi.ts:33
filterMedicalDevices
▸ filterMedicalDevices(filter, nextDeviceId?, limit?): Promise<PaginatedListMedicalDevice>
Filters are complex selectors that are built by combining basic building blocks. Examples of filters available for [MedicalDevice] are AllDevicesFilter and DevicesByIdsFilter. This method returns a paginated list of medical devices (with a cursor that lets you query the following items). Load devices from the database by filtering them using the provided [filter].
Parameters
| Name | Type | Description |
|---|---|---|
filter | Filter<MedicalDevice> | The Filter object that describes which condition(s) the elements whose the ids should be returned must fulfill |
nextDeviceId? | string | The id of the first device in the next page |
limit? | number | The number of devices to return in the queried page |
Returns
Promise<PaginatedListMedicalDevice>
Defined in
src/apis/MedicalDeviceApi.ts:41
getMedicalDevice
▸ getMedicalDevice(medicalDeviceId): Promise<MedicalDevice>
Each medical device is uniquely identified by a device id. The device id is a UUID. This [medicalDeviceId] is the preferred method to retrieve one specific device. Get a Medical Device
Parameters
| Name | Type |
|---|---|
medicalDeviceId | string |
Returns
Promise<MedicalDevice>
Defined in
src/apis/MedicalDeviceApi.ts:47
matchMedicalDevices
▸ matchMedicalDevices(filter): Promise<string[]>
Filters are complex selectors that are built by combining basic building blocks. Examples of filters available for [MedicalDevice] are AllDevicesFilter and DevicesByIdsFilter. This method returns the list of the ids of the users matching the filter. Load medical device ids from the database by filtering them using the provided Filter.
Parameters
| Name | Type | Description |
|---|---|---|
filter | Filter<MedicalDevice> | The Filter object that describes which condition(s) the elements whose the ids should be returned must fulfill |
Returns
Promise<string[]>