Contact
Close contacts for Healthcare Party and secret foreign keys.
PUT https://demo.icure.cloud/rest/v2/contact/byHcPartySecretForeignKeys/close
Keys must be delimited by coma
Query Parameters
| Name | Type | Description |
|---|---|---|
hcPartyId* | String | |
secretFKeys* | String |
Create a contact with the current user
POST https://demo.icure.cloud/rest/v2/contact
Returns an instance of created contact.
Request Body
| Name | Type | Description |
|---|---|---|
body* | Contact |
Create a batch of contacts
POST https://demo.icure.cloud/rest/v2/contact/batch
Returns the modified contacts.
Request Body
| Name | Type | Description |
|---|---|---|
body* | List |
Delete contacts.
POST https://demo.icure.cloud/rest/v2/contact/delete/batch
Response is a set containing the ID's of deleted contacts.
Request Body
| Name | Type | Description |
|---|---|---|
body* | ListOfIds |
List contacts for the current user (HcParty) or the given hcparty in the filter
POST https://demo.icure.cloud/rest/v2/contact/filter
Returns a list of contacts along with next start keys and Document ID. If the nextStartKey is Null it means that this is the last page.
Query Parameters
| Name | Type | Description |
|---|---|---|
startDocumentId | String | A Contact document ID |
limit | Integer | Number of rows |
Request Body
| Name | Type | Description |
|---|---|---|
body* | FilterChainContact |
List services for the current user (HcParty) or the given hcparty in the filter
POST https://demo.icure.cloud/rest/v2/contact/service/filter
Returns a list of contacts along with next start keys and Document ID. If the nextStartKey is Null it means that this is the last page.
Query Parameters
| Name | Type | Description |
|---|---|---|
startDocumentId | String | A Contact document ID |
limit | Integer | Number of rows |
Request Body
| Name | Type | Description |
|---|---|---|
body* | FilterChainService |
List contacts by opening date parties with(out) pagination
GET https://demo.icure.cloud/rest/v2/contact/byOpeningDate
Returns a list of contacts.
Query Parameters
| Name | Type | Description |
|---|---|---|
startKey* | Long | The contact openingDate |
endKey* | Long | The contact max openingDate |
hcpartyid* | String | hcpartyid |
startDocumentId | String | A contact party document ID |
limit | Integer | Number of rows |
Get a contact
GET https://demo.icure.cloud/rest/v2/contact/{contactId}
Path Parameters
| Name | Type | Description |
|---|---|---|
contactId* | String |
Get contacts
POST https://demo.icure.cloud/rest/v2/contact/byIds
Request Body
| Name | Type | Description |
|---|---|---|
body* | ListOfIds |
Get an empty content
GET https://demo.icure.cloud/rest/v2/contact/service/content/empty
Get the list of all used codes frequencies in services
GET https://demo.icure.cloud/rest/v2/contact/service/codes/{codeType}/{minOccurences}
Path Parameters
| Name | Type | Description |
|---|---|---|
codeType* | String | |
minOccurences* | Long |
List services with provided ids
POST https://demo.icure.cloud/rest/v2/contact/service
Returns a list of services
Request Body
| Name | Type | Description |
|---|---|---|
body* | ListOfIds |
List services linked to provided ids
POST https://demo.icure.cloud/rest/v2/contact/service/linkedTo
Returns a list of services
Query Parameters
| Name | Type | Description |
|---|---|---|
linkType | String | The type of the link |
Request Body
| Name | Type | Description |
|---|---|---|
body* | ListOfIds |
List contacts found By Healthcare Party and service Id.
GET https://demo.icure.cloud/rest/v2/contact/byHcPartyServiceId
Query Parameters
| Name | Type | Description |
|---|---|---|
hcPartyId* | String | |
serviceId* | String |
List contacts found By externalId.
POST https://demo.icure.cloud/rest/v2/contact/byExternalId
Query Parameters
| Name | Type | Description |
|---|---|---|
externalId* | String |
List contacts found By Healthcare Party and form Id.
GET https://demo.icure.cloud/rest/v2/contact/byHcPartyFormId
Query Parameters
| Name | Type | Description |
|---|---|---|
hcPartyId* | String | |
formId* | String |
List contacts found By Healthcare Party and form Id.
POST https://demo.icure.cloud/rest/v2/contact/byHcPartyFormIds
Query Parameters
| Name | Type | Description |
|---|---|---|
hcPartyId* | String |
Request Body
| Name | Type | Description |
|---|---|---|
body* | ListOfIds |
List contacts found By Healthcare Party and Patient foreign keys.
POST https://demo.icure.cloud/rest/v2/contact/byHcPartyPatientForeignKeys
Query Parameters
| Name | Type | Description |
|---|---|---|
hcPartyId* | String |
Request Body
| Name | Type | Description |
|---|---|---|
body* | ListOfIds |
List contacts found By Healthcare Party and secret foreign keys.
GET https://demo.icure.cloud/rest/v2/contact/byHcPartySecretForeignKeys
Keys must be delimited by coma
Query Parameters
| Name | Type | Description |
|---|---|---|
hcPartyId* | String | |
secretFKeys* | String | |
planOfActionsIds | String | |
skipClosedContacts | Boolean |
List contacts found By Healthcare Party and secret foreign keys.
GET https://demo.icure.cloud/rest/v2/contact/byHcPartySecretForeignKeys/delegations
Keys must be delimited by coma
Query Parameters
| Name | Type | Description |
|---|---|---|
hcPartyId* | String | |
secretFKeys* | String |
List services by related association id
GET https://demo.icure.cloud/rest/v2/contact/service/associationId
Returns a list of services
Query Parameters
| Name | Type | Description |
|---|---|---|
associationId* | String |
Get ids of contacts matching the provided filter for the current user (HcParty)
POST https://demo.icure.cloud/rest/v2/contact/match
Request Body
| Name | Type | Description |
|---|---|---|
body* | AbstractFilterContact |
Modify a contact
PUT https://demo.icure.cloud/rest/v2/contact
Returns the modified contact.
Request Body
| Name | Type | Description |
|---|---|---|
body* | Contact |
Modify a batch of contacts
PUT https://demo.icure.cloud/rest/v2/contact/batch
Returns the modified contacts.
Request Body
| Name | Type | Description |
|---|---|---|
body* | List |
Update delegations in healthElements.
PUT https://demo.icure.cloud/rest/v2/contact/delegations
Keys must be delimited by coma
Request Body
| Name | Type | Description |
|---|---|---|
body* | List |
Delegates a contact to a healthcare party
POST https://demo.icure.cloud/rest/v2/contact/{contactId}/delegate
It delegates a contact to a healthcare party (By current healthcare party). Returns the contact with new delegations.
Path Parameters
| Name | Type | Description |
|---|---|---|
contactId* | String |
Request Body
| Name | Type | Description |
|---|---|---|
body* | Delegation |
Update delegations in healthElements.
POST https://demo.icure.cloud/rest/v2/contact/delegations
Keys must be delimited by coma
Request Body
| Name | Type | Description |
|---|---|---|
body* | List |
Last updated