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 form with the current user
  • Create a form template with the current user
  • Create a batch of forms
  • Delete a form template
  • Delete forms.
  • Get a list of forms by parents ids
  • Gets a form
  • Gets the most recent form with the given logicalUuid
  • Gets the most recent form with the given uniqueId
  • Gets a form template by guid
  • Gets all form templates for current user
  • Gets a form template
  • Get a list of forms by ids
  • Gets all forms with given logicalUuid
  • Gets all forms by uniqueId
  • Gets all form templates
  • List forms found By Healthcare Party and secret foreign keys.
  • List form stubs found By Healthcare Party and secret foreign keys.
  • Modify a form
  • Modify a batch of forms
  • Delegates a form to a healthcare party
  • Update delegations in form.
  • Update a form template's layout
  • Modify a form template with the current user

Was this helpful?

  1. Data Stack Module
  2. REST API calls

Form

Create a form with the current user

POST https://demo.icure.cloud/rest/v2/form

Returns an instance of created form.

Request Body

Name
Type
Description

body*

Form

Create a form template with the current user

POST https://demo.icure.cloud/rest/v2/form/template

Returns an instance of created form template.

Request Body

Name
Type
Description

body*

FormTemplate

Create a batch of forms

POST https://demo.icure.cloud/rest/v2/form/batch

Returns the created forms.

Request Body

Name
Type
Description

body*

List

Delete a form template

DELETE https://demo.icure.cloud/rest/v2/form/template/{formTemplateId}

Path Parameters

Name
Type
Description

formTemplateId*

String

Delete forms.

POST https://demo.icure.cloud/rest/v2/form/delete/batch

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

Request Body

Name
Type
Description

body*

ListOfIds

Get a list of forms by parents ids

GET https://demo.icure.cloud/rest/v2/form/childrenOf/{formId}/{hcPartyId}

Keys must be delimited by coma

Path Parameters

Name
Type
Description

formId*

String

hcPartyId*

String

Gets a form

GET https://demo.icure.cloud/rest/v2/form/{formId}

Path Parameters

Name
Type
Description

formId*

String

Gets the most recent form with the given logicalUuid

GET https://demo.icure.cloud/rest/v2/form/logicalUuid/{logicalUuid}

Path Parameters

Name
Type
Description

logicalUuid*

String

Gets the most recent form with the given uniqueId

GET https://demo.icure.cloud/rest/v2/form/uniqueId/{uniqueId}

Path Parameters

Name
Type
Description

uniqueId*

String

Gets a form template by guid

GET https://demo.icure.cloud/rest/v2/form/template/{formTemplateId}

Path Parameters

Name
Type
Description

formTemplateId*

String

Gets all form templates for current user

GET https://demo.icure.cloud/rest/v2/form/template

Query Parameters

Name
Type
Description

loadLayout

Boolean

Gets a form template

GET https://demo.icure.cloud/rest/v2/form/template/{specialityCode}/guid/{formTemplateGuid}

Path Parameters

Name
Type
Description

formTemplateGuid*

String

specialityCode*

String

Get a list of forms by ids

POST https://demo.icure.cloud/rest/v2/form/byIds

Keys must be delimited by coma

Request Body

Name
Type
Description

body*

ListOfIds

Gets all forms with given logicalUuid

GET https://demo.icure.cloud/rest/v2/form/all/logicalUuid/{logicalUuid}

Path Parameters

Name
Type
Description

logicalUuid*

String

Gets all forms by uniqueId

GET https://demo.icure.cloud/rest/v2/form/all/uniqueId/{uniqueId}

Path Parameters

Name
Type
Description

uniqueId*

String

Gets all form templates

GET https://demo.icure.cloud/rest/v2/form/template/bySpecialty/{specialityCode}

Path Parameters

Name
Type
Description

specialityCode*

String

Query Parameters

Name
Type
Description

loadLayout

Boolean

List forms found By Healthcare Party and secret foreign keys.

GET https://demo.icure.cloud/rest/v2/form/byHcPartySecretForeignKeys

Keys must be delimited by coma

Query Parameters

Name
Type
Description

hcPartyId*

String

secretFKeys*

String

healthElementId

String

planOfActionId

String

formTemplateId

String

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

GET https://demo.icure.cloud/rest/v2/form/byHcPartySecretForeignKeys/delegations

Keys must be delimited by coma

Query Parameters

Name
Type
Description

hcPartyId*

String

secretFKeys*

String

Modify a form

PUT https://demo.icure.cloud/rest/v2/form

Returns the modified form.

Request Body

Name
Type
Description

body*

Form

Modify a batch of forms

PUT https://demo.icure.cloud/rest/v2/form/batch

Returns the modified forms.

Request Body

Name
Type
Description

body*

List

Delegates a form to a healthcare party

POST https://demo.icure.cloud/rest/v2/form/delegate/{formId}

It delegates a form to a healthcare party. Returns the form with the new delegations.

Path Parameters

Name
Type
Description

formId*

String

Request Body

Name
Type
Description

body*

List

Update delegations in form.

POST https://demo.icure.cloud/rest/v2/form/delegations

Keys must be delimited by coma

Request Body

Name
Type
Description

body*

List

Update a form template's layout

PUT https://demo.icure.cloud/rest/v2/form/template/{formTemplateId}/attachment/multipart

Path Parameters

Name
Type
Description

formTemplateId*

String

Modify a form template with the current user

PUT https://demo.icure.cloud/rest/v2/form/template/{formTemplateId}

Returns an instance of created form template.

Path Parameters

Name
Type
Description

formTemplateId*

String

Request Body

Name
Type
Description

body*

FormTemplate

PreviousHealthcareElementNextDocument

Last updated 3 years ago

Was this helpful?