Clinical Conductor
v0.0.1
The CC API documentation can be accessed from any instance using the following path, replacing [URL] with the users URL:
- https://[URL]/CCSWeb/api/docs
- https://[URL]/CCEWeb/api/docs
Set up
- Api Key
CCS: To set up the API keys, navigate to System Admin > System Setup > API Keys > API Keys section
CCE: key management is found under System > System Setup > API Keys > API Keys section
- Domain name
You will need to provide your domanin name in the Source setup (not including https:// or .com)
Features
| Feature | Support | Notes |
|---|---|---|
| Backfill | ✅ | All time on all reports |
| Incremental | ❌ | Incremental not supported |
| API reliability | 🟢 | Reliable |
Reports detail
| ⬇️ Report | 🔑 Incremental key | 🔑 Primary key | 📄 Link to API endpoint |
|---|---|---|---|
| Patients | N/A | ID | Get Patients |
| Appointments | N/A | ID | Get Appointments |
| Studies | N/A | ID | Get Studies |
| Studies Warnings | N/A | N/A | Get Study Warnings |
| Studies Personnel | N/A | N/A | Get Study Personnel |
| Studies Integration Info | N/A | N/A | Get Study Integration Info |
| Subjects | N/A | ID | Get Subjects |
| Subject statuses | N/A | N/A | Get Subject Statuses |
| Subject statuses (by subject) | N/A | N/A | Get Subject Status |
| Patient visits | N/A | ID | Get Patient Visits |
| Visits | N/A | ID | Get Visits |
| Elements | N/A | ID | Get Elements |
| Study arms | N/A | ID | Get Study Arms |
| Study visit arm | N/A | ID, STUDY_ID, ARM_ID | Get Study Visit Arm |
| Staff | N/A | ID | Get Staff |
| Visit Element Relationship | N/A | VISIT_ID,ID | Visit Element Relationship |
API Limitation
The Patient Visits report will take longer to complete than the other ones. Depending on the amount of data you have it can take a few hours to finalize.
Updated about 1 year ago