HealthcareProfessionalApi
@icure/medical-device-sdk / HealthcareProfessionalApi
SDK API: HealthcareProfessionalApi
The HealthcareProfessionalApi interface provides methods to manage practitioners.
Table of contents
Methods
- createOrModifyHealthcareProfessional
- deleteHealthcareProfessional
- filterHealthcareProfessionalBy
- getHealthcareProfessional
- matchHealthcareProfessionalBy
Methods
createOrModifyHealthcareProfessional
▸ createOrModifyHealthcareProfessional(healthcareProfessional): Promise<HealthcareProfessional>
A practitioner must have a login, an email or a mobilePhone defined, a practitioner should be linked to either a Healthcare Professional, a Patient or a Device. When modifying an practitioner, you must ensure that the rev obtained when getting or creating the practitioner is present as the rev is used to guarantee that the practitioner has not been modified by a third party. Create a new Practitioner or modify an existing one.
Parameters
| Name | Type | Description |
|---|---|---|
healthcareProfessional | HealthcareProfessional | The practitioner that must be created in the database. |
Returns
Promise<HealthcareProfessional>
Defined in
src/apis/HealthcareProfessionalApi.ts:15
deleteHealthcareProfessional
▸ deleteHealthcareProfessional(hcpId): Promise<string>
Deletes the practitioner identified by the provided unique hcpId. Delete an existing practitioner.
Parameters
| Name | Type | Description |
|---|---|---|
hcpId | string | The UUID that uniquely identifies the practitioner to be deleted. |
Returns
Promise<string>
Defined in
src/apis/HealthcareProfessionalApi.ts:21
filterHealthcareProfessionalBy
▸ filterHealthcareProfessionalBy(filter, nextHcpId?, limit?): Promise<PaginatedListHealthcareProfessional>
Filters are complex selectors that are built by combining basic building blocks. Examples of filters available for Practitioners are AllHealthcareProfessionalsFilter and HealthcareProfessionalsByIdsFilter. This method returns a paginated list of practitioners (with a cursor that lets you query the following items). Load practitioners from the database by filtering them using the provided Filter.
Parameters
| Name | Type | Description |
|---|---|---|
filter | Filter<HealthcareProfessional> | The Filter object that describes which condition(s) the elements whose the ids should be returned must fulfill |
nextHcpId? | string | The id of the first Practitioner in the next page |
limit? | number | The number of practitioners to return in the queried page |
Returns
Promise<PaginatedListHealthcareProfessional>
Defined in
src/apis/HealthcareProfessionalApi.ts:29
getHealthcareProfessional
▸ getHealthcareProfessional(hcpId): Promise<HealthcareProfessional>
Each practitioner is uniquely identified by a practitioner id. The practitioner id is a UUID. This hcpId is the preferred method to retrieve one specific practitioner. Get a Practitioner by id.
Parameters
| Name | Type | Description |
|---|---|---|
hcpId | string | The UUID that identifies the practitioner uniquely |
Returns
Promise<HealthcareProfessional>
Defined in
src/apis/HealthcareProfessionalApi.ts:35
matchHealthcareProfessionalBy
▸ matchHealthcareProfessionalBy(filter): Promise<string[]>
Filters are complex selectors that are built by combining basic building blocks. Examples of filters available for Practitioners are AllPractitionersFilter and PractitionersByIdsFilter. This method returns the list of the ids of the practitioners matching the filter. Load practitioner ids from the database by filtering them using the provided Filter.
Parameters
| Name | Type | Description |
|---|---|---|
filter | Filter<HealthcareProfessional> | The Filter object that describes which condition(s) the elements whose the ids should be returned must fulfill |
Returns
Promise<string[]>