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 element with the current user.
  • Delete healthcare elements..
  • Filter healthcare elements for the current user (HcParty).
  • List healthcare elements found By Healthcare Party and secret foreign keyelementIds..
  • List helement stubs found By Healthcare Party and secret foreign keys..
  • Get a healthcare element.
  • Modify a healthcare element.
  • Modify a batch of healthcare elements.
  • Delegates a healthcare element to a healthcare party.
  • Update delegations in healthElements..

Was this helpful?

  1. Data Stack Module
  2. REST API calls

HealthcareElement

Create a healthcare element with the current user.

POST https://demo.icure.cloud/rest/v1/helement

Returns an instance of created healthcare element.

Request Body

Name
Type
Description

body

HealthElement

Delete healthcare elements..

DELETE https://demo.icure.cloud/rest/v1/helement/{healthElementIds}

Response is a set containing the ID's of deleted healthcare elements.

Path Parameters

Name
Type
Description

healthElementIds

String

Filter healthcare elements for the current user (HcParty).

POST https://demo.icure.cloud/rest/v1/helement/filter

Returns a list of healthcare elements along with next start keys and Document ID. If the nextStartKey is Null it means that this is the last page.

Request Body

Name
Type
Description

body

FilterChainHealthElement

List healthcare elements found By Healthcare Party and secret foreign keyelementIds..

GET https://demo.icure.cloud/rest/v1/helement/byHcPartySecretForeignKeys

Keys hast to delimited by coma

Query Parameters

Name
Type
Description

hcPartyId

String

secretFKeys

String

List helement stubs found By Healthcare Party and secret foreign keys..

GET https://demo.icure.cloud/rest/v1/helement/byHcPartySecretForeignKeys/delegations

Keys must be delimited by coma

Query Parameters

Name
Type
Description

hcPartyId

String

secretFKeys

String

Get a healthcare element.

GET https://demo.icure.cloud/rest/v1/helement/{healthElementId}

Path Parameters

Name
Type
Description

healthElementId

String

Modify a healthcare element.

PUT https://demo.icure.cloud/rest/v1/helement

Returns the modified healthcare element.

Request Body

Name
Type
Description

body

HealthElement

Modify a batch of healthcare elements.

PUT https://demo.icure.cloud/rest/v1/helement/batch

Returns the modified healthcare elements.

Request Body

Name
Type
Description

body

List

Delegates a healthcare element to a healthcare party.

POST https://demo.icure.cloud/rest/v1/helement/{healthElementId}/delegate

It delegates a healthcare element to a healthcare party (By current healthcare party). Returns the element with new delegations.

Path Parameters

Name
Type
Description

healthElementId

String

Request Body

Name
Type
Description

body

List

Update delegations in healthElements..

POST https://demo.icure.cloud/rest/v1/helement/delegations

Keys must be delimited by coma

Request Body

Name
Type
Description

body

List

PreviousContactNextForm

Last updated 3 years ago

Was this helpful?