HealthcareParty
Create a healthcare party
POST https://demo.icure.cloud/rest/v2/hcparty
One of Name or Last name+First name, Nihii, and Public key are required.
Request Body
| Name | Type | Description |
|---|---|---|
body* | HealthcareParty |
Create a healthcare party
POST https://demo.icure.cloud/rest/v2/hcparty/inGroup/{groupId}
One of Name or Last name+First name, Nihii, and Public key are required.
Path Parameters
| Name | Type | Description |
|---|---|---|
groupId* | String |
Request Body
| Name | Type | Description |
|---|---|---|
body* | HealthcareParty |
Delete healthcare parties
POST https://demo.icure.cloud/rest/v2/hcparty/delete/batch
Deleting healthcareParties. Response is an array containing the id of deleted healthcare parties.
Request Body
| Name | Type | Description |
|---|---|---|
body* | ListOfIds |
Delete a healthcare party
POST https://demo.icure.cloud/rest/v2/hcparty/delete/batch/inGroup/{groupId}
Deleting a healthcareParty. Response is an array containing the id of deleted healthcare party.
Path Parameters
| Name | Type | Description |
|---|---|---|
groupId* | String |
Request Body
| Name | Type | Description |
|---|---|---|
body* | ListOfIds |
List healthcare parties with(out) pagination
GET https://demo.icure.cloud/rest/v2/hcparty
Returns a list of healthcare parties.
Query Parameters
| Name | Type | Description |
|---|---|---|
startKey | String | A healthcare party Last name |
startDocumentId | String | A healthcare party document ID |
limit | Integer | Number of rows |
desc | Boolean | Descending |
Find healthcare parties by name with(out) pagination
GET https://demo.icure.cloud/rest/v2/hcparty/byName
Returns a list of healthcare parties.
Query Parameters
| Name | Type | Description |
|---|---|---|
name | String | The Last name search value |
startKey | String | A healthcare party Last name |
startDocumentId | String | A healthcare party document ID |
limit | Integer | Number of rows |
desc | Boolean | Descending |
Find healthcare parties by name with(out) pagination
GET https://demo.icure.cloud/rest/v2/hcparty/bySpecialityAndPostCode/{type}/{spec}/{firstCode}/to/{lastCode}
Returns a list of healthcare parties.
Path Parameters
| Name | Type | Description |
|---|---|---|
type* | String | The type of the HCP (persphysician) |
spec* | String | The speciality of the HCP |
firstCode* | String | The first postCode for the HCP |
lastCode* | String | The last postCode for the HCP |
Query Parameters
| Name | Type | Description |
|---|---|---|
limit | Integer | Number of rows |
Find healthcare parties by nihii or ssin with(out) pagination
GET https://demo.icure.cloud/rest/v2/hcparty/byNihiiOrSsin/{searchValue}
Returns a list of healthcare parties.
Path Parameters
| Name | Type | Description |
|---|---|---|
searchValue* | String |
Query Parameters
| Name | Type | Description |
|---|---|---|
startKey | String | A healthcare party Last name |
startDocumentId | String | A healthcare party document ID |
limit | Integer | Number of rows |
desc | Boolean | Descending |
Get the current healthcare party if logged in.
GET https://demo.icure.cloud/rest/v2/hcparty/current
General information about the current healthcare Party
Get the HcParty encrypted AES keys indexed by owner
GET https://demo.icure.cloud/rest/v2/hcparty/byKeys/{healthcarePartyId}
(key, value) of the map is as follows: (ID of the owner of the encrypted AES key, encrypted AES key)
Path Parameters
| Name | Type | Description |
|---|---|---|
healthcarePartyId* | String |
Get healthcareParties by their IDs
POST https://demo.icure.cloud/rest/v2/hcparty/byIds
General information about the healthcare Party
Request Body
| Name | Type | Description |
|---|---|---|
body* | ListOfIds |
Get a healthcareParty by his ID
GET https://demo.icure.cloud/rest/v2/hcparty/{healthcarePartyId}
General information about the healthcare Party
Path Parameters
| Name | Type | Description |
|---|---|---|
healthcarePartyId* | String |
Get public key of a healthcare party
GET https://demo.icure.cloud/rest/v2/hcparty/{healthcarePartyId}/publicKey
Returns the public key of a healthcare party in Hex
Path Parameters
| Name | Type | Description |
|---|---|---|
healthcarePartyId* | String |
Find healthcare parties by name with(out) pagination
GET https://demo.icure.cloud/rest/v2/hcparty/byNameStrict/{name}
Returns a list of healthcare parties.
Path Parameters
| Name | Type | Description |
|---|---|---|
name* | String | The Last name search value |
Find children of an healthcare parties
GET https://demo.icure.cloud/rest/v2/hcparty/{parentId}/children
Return a list of children hcp.
Path Parameters
| Name | Type | Description |
|---|---|---|
parentId* | String |
Modify a Healthcare Party.
PUT https://demo.icure.cloud/rest/v2/hcparty
No particular return value. It's just a message.
Request Body
| Name | Type | Description |
|---|---|---|
body* | HealthcareParty |
Modify a Healthcare Party.
PUT https://demo.icure.cloud/rest/v2/hcparty/inGroup/{groupId}
No particular return value. It's just a message.
Path Parameters
| Name | Type | Description |
|---|---|---|
groupId* | String |
Request Body
| Name | Type | Description |
|---|---|---|
body* | HealthcareParty |
Last updated