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
  • Create a healthcare party
  • Create a healthcare party
  • Delete healthcare parties
  • Delete a healthcare party
  • List healthcare parties with(out) pagination
  • Find healthcare parties by name with(out) pagination
  • Find healthcare parties by name with(out) pagination
  • Find healthcare parties by nihii or ssin with(out) pagination
  • Get the current healthcare party if logged in.
  • Get the HcParty encrypted AES keys indexed by owner
  • Get healthcareParties by their IDs
  • Get a healthcareParty by his ID
  • Get public key of a healthcare party
  • Find healthcare parties by name with(out) pagination
  • Find children of an healthcare parties
  • Modify a Healthcare Party.
  • Modify a Healthcare Party.

Was this helpful?

  1. Data Stack Module
  2. REST API calls

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

PreviousPatientNextContact

Last updated 3 years ago

Was this helpful?