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
  • Get count of patients for a specific HcParty or for the current HcParty
  • Create a patient
  • Create patients in bulk
  • Delete patients.
  • Filter patients for the current user (HcParty)
  • Find deleted patients
  • Get Paginated List of Patients sorted by Access logs descending
  • List patients for a specific HcParty
  • Find patients for the current user (HcParty)
  • List patients by pages for a specific HcParty
  • List patients that have been modified after the provided date
  • Filter patients for the current user (HcParty)
  • Get patient
  • Get the patient having the provided externalId
  • Get patient by identifier
  • Get the patient (identified by patientId) hcparty keys. Those keys are AES keys (encrypted) used to share information between HCPs and a patient.
  • Get patients by id
  • Find deleted patients
  • List patients that have been merged towards another patient
  • Get ids of patients matching the provided filter for the current user (HcParty)
  • Merge a series of patients into another patient
  • Modify a patient
  • Set a patient referral doctor
  • Modify patients in bulk
  • Delegates a patients to a healthcare party
  • Register a patient
  • undelete previously deleted patients

Was this helpful?

  1. Data Stack Module
  2. REST API calls

Patient

Get count of patients for a specific HcParty or for the current HcParty

GET https://demo.icure.cloud/rest/v2/patient/hcParty/{hcPartyId}/count

Returns the count of patients

Path Parameters

Name
Type
Description

hcPartyId*

String

Healthcare party id

Create a patient

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

Name, last name, date of birth, and gender are required. After creation of the patient and obtaining the ID, you need to create an initial delegation.

Request Body

Name
Type
Description

body*

Patient

Create patients in bulk

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

Returns the id and _rev of created patients

Request Body

Name
Type
Description

body*

List

Delete patients.

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

Response is an array containing the ID of deleted patient..

Request Body

Name
Type
Description

body*

ListOfIds

Filter patients for the current user (HcParty)

POST https://demo.icure.cloud/rest/v2/patient/filter

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

Query Parameters

Name
Type
Description

startKey

String

The start key for pagination, depends on the filters used

startDocumentId

String

A patient document ID

limit

Integer

Number of rows

skip

Integer

Skip rows

sort

String

Sort key

desc

Boolean

Descending

Request Body

Name
Type
Description

body*

FilterChainPatient

Find deleted patients

GET https://demo.icure.cloud/rest/v2/patient/deleted/byDate

Returns a list of deleted patients, within the specified time period, if any.

Query Parameters

Name
Type
Description

startDate

Long

Filter deletions after this date (unix epoch), included

endDate

Long

Filter deletions before this date (unix epoch), included

desc

Boolean

Descending

startDocumentId

String

A patient document ID

limit

Integer

Number of rows

Get Paginated List of Patients sorted by Access logs descending

GET https://demo.icure.cloud/rest/v2/patient/byAccess/{userId}

Path Parameters

Name
Type
Description

userId*

String

A User ID

Query Parameters

Name
Type
Description

accessType

String

The type of access (COMPUTER or USER)

startDate

Long

The start search epoch

startKey

String

The start key for pagination

startDocumentId

String

A patient document ID

limit

Integer

Number of rows

List patients for a specific HcParty

GET https://demo.icure.cloud/rest/v2/patient

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

Query Parameters

Name
Type
Description

hcPartyId

String

Healthcare party id

sortField

String

Optional value for sorting results by a given field ('name', 'ssin', 'dateOfBirth'). Specifying this deactivates filtering

startKey

String

The start key for pagination: a JSON representation of an array containing all the necessary components to form the Complex Key's startKey

startDocumentId

String

A patient document ID

limit

Integer

Number of rows

sortDirection

String

Optional value for providing a sorting direction ('asc', 'desc'). Set to 'asc' by default.

Find patients for the current user (HcParty)

GET https://demo.icure.cloud/rest/v2/patient/byNameBirthSsinAuto

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

Query Parameters

Name
Type
Description

healthcarePartyId

String

HealthcareParty Id, if unset will user user's hcpId

filterValue

String

Optional value for filtering results

startKey

String

The start key for pagination: a JSON representation of an array containing all the necessary components to form the Complex Key's startKey

startDocumentId

String

A patient document ID

limit

Integer

Number of rows

sortDirection

String

Optional value for providing a sorting direction ('asc', 'desc'). Set to 'asc' by default.

List patients by pages for a specific HcParty

GET https://demo.icure.cloud/rest/v2/patient/byHcPartyId

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

Query Parameters

Name
Type
Description

hcPartyId*

String

Healthcare party id

startKey

String

The page first id

startDocumentId

String

A patient document ID

limit

Integer

Page size

List patients that have been modified after the provided date

GET https://demo.icure.cloud/rest/v2/patient/modifiedAfter/{date}

Returns a list of patients that have been modified after the provided date

Path Parameters

Name
Type
Description

date*

Long

Query Parameters

Name
Type
Description

startKey

Long

The start key for pagination the date of the first element of the new page

startDocumentId

String

A patient document ID

limit

Integer

Number of rows

Filter patients for the current user (HcParty)

GET https://demo.icure.cloud/rest/v2/patient/fuzzy

Returns a list of patients

Query Parameters

Name
Type
Description

firstName

String

The first name

lastName

String

The last name

dateOfBirth

Integer

The date of birth

Get patient

GET https://demo.icure.cloud/rest/v2/patient/{patientId}

It gets patient administrative data.

Path Parameters

Name
Type
Description

patientId*

String

Get the patient having the provided externalId

GET https://demo.icure.cloud/rest/v2/patient/byExternalId/{externalId}

Path Parameters

Name
Type
Description

externalId*

String

A external ID

Get patient by identifier

GET https://demo.icure.cloud/rest/v2/patient/{hcPartyId}/{id}

It gets patient administrative data based on the identifier (root & extension) parameters.

Path Parameters

Name
Type
Description

hcPartyId*

String

id*

String

Query Parameters

Name
Type
Description

system

String

Get the patient (identified by patientId) hcparty keys. Those keys are AES keys (encrypted) used to share information between HCPs and a patient.

GET https://demo.icure.cloud/rest/v2/patient/{patientId}/keys

This endpoint is used to recover all keys that have already been created and that can be used to share information with this patient. It returns a map with the following structure: ID of the owner of the encrypted AES key -> encrypted AES key. The returned encrypted AES keys will have to be decrypted using the patient's private key.

Path Parameters

Name
Type
Description

patientId*

String

The patient Id for which information is shared

Get patients by id

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

It gets patient administrative data.

Request Body

Name
Type
Description

body*

ListOfIds

Find deleted patients

GET https://demo.icure.cloud/rest/v2/patient/deleted/by_name

Returns a list of deleted patients, by name and/or firstname prefix, if any.

Query Parameters

Name
Type
Description

firstName

String

First name prefix

lastName

String

Last name prefix

List patients that have been merged towards another patient

GET https://demo.icure.cloud/rest/v2/patient/merges/{date}

Returns a list of patients that have been merged after the provided date

Path Parameters

Name
Type
Description

date*

Long

Get ids of patients matching the provided filter for the current user (HcParty)

POST https://demo.icure.cloud/rest/v2/patient/match

Request Body

Name
Type
Description

body*

AbstractFilterPatient

Merge a series of patients into another patient

PUT https://demo.icure.cloud/rest/v2/patient/mergeInto/{toId}/from/{fromIds}

Path Parameters

Name
Type
Description

toId*

String

fromIds*

String

Modify a patient

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

No particular return value. It's just a message.

Request Body

Name
Type
Description

body*

Patient

Set a patient referral doctor

PUT https://demo.icure.cloud/rest/v2/patient/{patientId}/referral/{referralId}

Path Parameters

Name
Type
Description

patientId*

String

referralId*

String

The referal id. Accepts 'none' for referral removal.

Query Parameters

Name
Type
Description

start

Long

Optional value for start of referral

end

Long

Optional value for end of referral

Modify patients in bulk

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

Returns the id and _rev of modified patients

Request Body

Name
Type
Description

body*

List

Delegates a patients to a healthcare party

POST https://demo.icure.cloud/rest/v2/patient/{patientId}/delegate

It delegates a patient to a healthcare party (By current healthcare party). A modified patient with new delegation gets returned.

Path Parameters

Name
Type
Description

patientId*

String

Request Body

Name
Type
Description

body*

List

Register a patient

POST https://demo.icure.cloud/rest/v2/patient/register/forHcp/{hcPartyId}/inGroup/{groupId}

Register a new patient into the system

Path Parameters

Name
Type
Description

hcPartyId*

String

groupId*

String

Request Body

Name
Type
Description

body*

Patient

undelete previously deleted patients

PUT https://demo.icure.cloud/rest/v2/patient/undelete/{patientIds}

Response is an array containing the ID of undeleted patient..

Path Parameters

Name
Type
Description

patientIds*

String

PreviousUserNextHealthcareParty

Last updated 3 years ago

Was this helpful?