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
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.
Create patients in bulk
POST https://demo.icure.cloud/rest/v2/patient/batch
Returns the id and _rev of created patients
Delete patients.
POST https://demo.icure.cloud/rest/v2/patient/delete/batch
Response is an array containing the ID of deleted patient..
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
The start key for pagination, depends on the filters used
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
Filter deletions after this date (unix epoch), included
Filter deletions before this date (unix epoch), included
Get Paginated List of Patients sorted by Access logs descending
GET https://demo.icure.cloud/rest/v2/patient/byAccess/{userId}
Path Parameters
Query Parameters
The type of access (COMPUTER or USER)
The start key for pagination
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
Optional value for sorting results by a given field ('name', 'ssin', 'dateOfBirth'). Specifying this deactivates filtering
The start key for pagination: a JSON representation of an array containing all the necessary components to form the Complex Key's startKey
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
HealthcareParty Id, if unset will user user's hcpId
Optional value for filtering results
The start key for pagination: a JSON representation of an array containing all the necessary components to form the Complex Key's startKey
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
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
Query Parameters
The start key for pagination the date of the first element of the new page
Filter patients for the current user (HcParty)
GET https://demo.icure.cloud/rest/v2/patient/fuzzy
Returns a list of patients
Query Parameters
GET https://demo.icure.cloud/rest/v2/patient/{patientId}
It gets patient administrative data.
Path Parameters
Get the patient having the provided externalId
GET https://demo.icure.cloud/rest/v2/patient/byExternalId/{externalId}
Path Parameters
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
Query Parameters
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
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.
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
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
Get ids of patients matching the provided filter for the current user (HcParty)
POST https://demo.icure.cloud/rest/v2/patient/match
Merge a series of patients into another patient
PUT https://demo.icure.cloud/rest/v2/patient/mergeInto/{toId}/from/{fromIds}
Path Parameters
Modify a patient
PUT https://demo.icure.cloud/rest/v2/patient
No particular return value. It's just a message.
Set a patient referral doctor
PUT https://demo.icure.cloud/rest/v2/patient/{patientId}/referral/{referralId}
Path Parameters
The referal id. Accepts 'none' for referral removal.
Query Parameters
Optional value for start of referral
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
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
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
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
