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
  • Creates a document
  • Deletes a document's attachment
  • Deletes documents
  • List documents with no delegation
  • Gets a document
  • Load document's attachment
  • Gets a document
  • Gets a document
  • Get all documents with externalUuid
  • List documents found By type, By Healthcare Party and secret foreign keys.
  • List documents found By Healthcare Party and secret foreign keys.
  • Updates a document
  • Updates a batch of documents
  • Creates a document's attachment
  • Creates a document's attachment
  • Update delegations in healthElements.
  • Creates a document's attachment

Was this helpful?

  1. Data Stack Module
  2. REST API calls

Document

Creates a document

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

Request Body

Name
Type
Description

body*

Document

Deletes a document's attachment

DELETE https://demo.icure.cloud/rest/v2/document/{documentId}/attachment

Path Parameters

Name
Type
Description

documentId*

String

Deletes documents

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

Request Body

Name
Type
Description

body*

ListOfIds

List documents with no delegation

GET https://demo.icure.cloud/rest/v2/document/woDelegation

Keys must be delimited by coma

Query Parameters

Name
Type
Description

limit

Integer

Gets a document

GET https://demo.icure.cloud/rest/v2/document/{documentId}

Path Parameters

Name
Type
Description

documentId*

String

Load document's attachment

GET https://demo.icure.cloud/rest/v2/document/{documentId}/attachment/{attachmentId}

Path Parameters

Name
Type
Description

documentId*

String

attachmentId*

String

Query Parameters

Name
Type
Description

enckeys

String

fileName

String

Gets a document

GET https://demo.icure.cloud/rest/v2/document/externaluuid/{externalUuid}

Path Parameters

Name
Type
Description

externalUuid*

String

Gets a document

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

Request Body

Name
Type
Description

body*

ListOfIds

Get all documents with externalUuid

GET https://demo.icure.cloud/rest/v2/document/externaluuid/{externalUuid}/all

Path Parameters

Name
Type
Description

externalUuid*

String

List documents found By type, By Healthcare Party and secret foreign keys.

GET https://demo.icure.cloud/rest/v2/document/byTypeHcPartySecretForeignKeys

Keys must be delimited by coma

Query Parameters

Name
Type
Description

documentTypeCode*

String

hcPartyId*

String

secretFKeys*

String

List documents found By Healthcare Party and secret foreign keys.

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

Keys must be delimited by coma

Query Parameters

Name
Type
Description

hcPartyId*

String

secretFKeys*

String

Updates a document

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

Request Body

Name
Type
Description

body*

Document

Updates a batch of documents

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

Returns the modified documents.

Request Body

Name
Type
Description

body*

List

Creates a document's attachment

PUT https://demo.icure.cloud/rest/v2/document/{documentId}/attachment

Path Parameters

Name
Type
Description

documentId*

String

Query Parameters

Name
Type
Description

enckeys

String

Request Body

Name
Type
Description

body*

Object

Creates a document's attachment

PUT https://demo.icure.cloud/rest/v2/document/{documentId}/attachment/multipart

Path Parameters

Name
Type
Description

documentId*

String

Query Parameters

Name
Type
Description

enckeys

String

Update delegations in healthElements.

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

Keys must be delimited by coma

Request Body

Name
Type
Description

body*

List

Creates a document's attachment

PUT https://demo.icure.cloud/rest/v2/document/attachment

Query Parameters

Name
Type
Description

documentId*

String

enckeys

String

Request Body

Name
Type
Description

body*

Object

PreviousFormNextMessage

Last updated 3 years ago

Was this helpful?