iCure. eHealth Solutions
  • Developer Documentation
  • iCure Software Modules
  • Get Started
    • Create your own Database
      • Receive an invitation
      • Create new User
      • Create a new Healthcare Party
    • Structure your Database
    • Access your database
    • Use the Console
  • Data Stack Module
    • The Data Stack
      • Install iCure
      • Get Started with a Database
    • iCure Data Model
      • Overview
      • User
        • Permission
      • Healthcare Party
      • Patient
        • Insurability
        • Relationship
        • Patient Hcp care period
          • Referral period
      • Contact
        • Service
          • Content
            • Medication
              • Regimen item
            • Measure
        • SubContact
      • Healthcare Element
        • Care team member
        • Healthcare approach
      • Form
      • Additional Classes
        • AccessLog
        • Address
          • Telecom
        • Message
        • Document
        • FilterChain
          • Filter
          • Predicate
        • Group
        • Insurance
        • Invoice
          • Invoicing code
        • Tarification
          • Valorisation
    • Hybrid Cloud Storage
    • Mobile/Web SDKs
      • JavaScript/Typescript
        • Setting up your environment
        • Logging in
        • Managing patients
        • iCure for MedTech: Getting Started
          • Exchange data using FHIR model
          • Exchange data using iCure SDK
      • Java/Kotlin
      • Swift/Objective C
    • REST API calls
      • User
      • Patient
      • HealthcareParty
      • Contact
      • HealthcareElement
      • Form
      • Document
      • Message
      • Invoice
      • Additional endpoints
        • AccessLog
        • Authentication
        • Codification
        • Document template
        • Entity reference
        • Entity template
        • Insurance
        • Receipt
        • Tarification
    • Access Rights management
    • End-to-End-Encryption
    • ATNA Audit Records
  • Interoperability Module
    • IHE XDS calls
      • The XDS Concept
      • ITI-18 get associations api call
      • ITI-41 provide and register document set api call
      • Iti-42 register document set api call
    • IHE IPS call
      • The IPS Concept
    • FHIR API Data Exchange
      • The FHIR Concept
    • Freehealth Connector 🇧🇪
    • Encrypted Data Exchange
      • Internal
      • External
  • Customizable Features Module
    • Input Forms
    • Medical Records
    • Data Dashboards
    • Custom Connectors
    • Secure Log-in App
  • Support
    • Download
    • Contact Us
  • Advanced topics
    • Healthcare Data
      • Business intelligence
      • Anonymized Data
    • Encryption Key Creation and Storage
    • Multi-Master database replication
    • Cross Databases Sharing
    • Complex queries
Powered by GitBook
On this page
  • Close contacts for Healthcare Party and secret foreign keys.
  • Create a contact with the current user
  • Create a batch of contacts
  • Delete contacts.
  • List contacts for the current user (HcParty) or the given hcparty in the filter
  • List services for the current user (HcParty) or the given hcparty in the filter
  • List contacts by opening date parties with(out) pagination
  • Get a contact
  • Get contacts
  • Get an empty content
  • Get the list of all used codes frequencies in services
  • List services with provided ids
  • List services linked to provided ids
  • List contacts found By Healthcare Party and service Id.
  • List contacts found By externalId.
  • List contacts found By Healthcare Party and form Id.
  • List contacts found By Healthcare Party and form Id.
  • List contacts found By Healthcare Party and Patient foreign keys.
  • List contacts found By Healthcare Party and secret foreign keys.
  • List contacts found By Healthcare Party and secret foreign keys.
  • List services by related association id
  • Get ids of contacts matching the provided filter for the current user (HcParty)
  • Modify a contact
  • Modify a batch of contacts
  • Update delegations in healthElements.
  • Delegates a contact to a healthcare party
  • Update delegations in healthElements.

Was this helpful?

  1. Data Stack Module
  2. REST API calls

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

PreviousHealthcarePartyNextHealthcareElement

Last updated 3 years ago

Was this helpful?