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

200

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

200

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

200

Delete a form template

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

Path Parameters

Name	Type	Description
formTemplateId*	String

200

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

200

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

200

Gets a form

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

Path Parameters

Name	Type	Description
formId*	String

200

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

200

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

200

Gets a form template by guid

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

Path Parameters

Name	Type	Description
formTemplateId*	String

200

Gets all form templates for current user

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

Query Parameters

Name	Type	Description
loadLayout	Boolean

200

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

200

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

200

Gets all forms with given logicalUuid

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

Path Parameters

Name	Type	Description
logicalUuid*	String

200

Gets all forms by uniqueId

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

Path Parameters

Name	Type	Description
uniqueId*	String

200

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

200

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

200

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

200

Modify a form

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

Returns the modified form.

Request Body

Name	Type	Description
body*	Form

200

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

200

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

200

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

200

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

200

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

200