Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Contact Us
  • Home
  • CDMS
  • Frequently Asked Questions
  • Application Programming Interface (API)

Parameters used in the API in EDC/CDMS

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • CDMS
    Castor CDMS Manual Castor CDMS Calculations Manual Frequently Asked Questions Articles for Data Managers Castor CDMS Compliance Release Documents
  • eConsent
    Castor eConsent Manual Castor eConsent Compliance Release Documents
  • SMS
    Castor SMS Manual Castor SMS Compliance Release Documents
  • Castor Connect
    Castor Connect Compliance Release Documents Castor Connect Manual Castor Connect - Participant Quick Start Guide
  • Helpdesk
    News Other Resources Castor products knowledge resources
  • Status page
  • Completing a Study
+ More

Table of Contents

What is the difference between ID and instance ID?

The Castor CDMS API Documentation page gathers the methods and requirements of the fields in Castor to be used with an API.

  • EU API endpoints
  • UK API endpoints
  • US API endpoints
  • AU API endpoints

The Changelog of the Castor CDMS API can be reviewed here.

 

There are a handful of parameters that are used to locate the data in the database and retrieve it or update it. See the table below:

Parameter
 
Description
 
{user_id} Numeric identifier of the user (UUID)
{country_id} Numeric identifier of the country (use the GET method for a list of IDs)
{study_id} ID of the study (found in Settings > Study)
{field_id} Identifier of the field
{record_id} RecordID as shown in the Participants tab
{report_id} Identifier of a repeating data (structure) 
{report_instance_id} Identifier of a repeating data instance added for a Record
{survey_id} Identifier of a survey (structure) 
{survey_instance_id} Identifier of a survey added for a Record
{survey_package_id} Identifier of a survey package (structure)
{survey_package_instance_id} Identifier of a survey package added for a Participant
{survey_step_id} Identifier of a survey form

What is the difference between ID and instance ID?

Each component of the study is identified by a unique ID: field, user, etc. Some of them are simply referenced by "ID", like the studyID and the recordID. In the user interface these items locate in the Study structure and Study forms tabs:

However, some components can appear repeatedly in the study even within the same participant. Such is the case of repeating data instances, surveys and survey packages. For this reason we need a unique ID to identify each of the occurrences of these components across the study. This unique identifier is the instanceID. 

These items that are referenced with an "instanceID" are always located in the menu inside each participant, in the Participants tab of the user interface:

 

The following chart shows an example for the relation between ID and instance ID for a repeating data structure called "Medication":

 

 

See also Where can I find IDs for the study/field/repeating data instance/... for the API? article to learn how to find the IDs for the API, and The structure of Castor for a comprehensive description of the parts of a study.

edc cdms api parameters

Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

  • Where can I find IDs for the study/field/repeating data instance/... for the API in EDC/CDMS?
  • Where can I find my user/client credentials to use the API/R package in EDC/CDMS?
ISO 27001
FDA - 21 CFR part 11
ICH GCP compliant
HIPAA compliant
CDISC
ISO 9001
gdpr compliant

Products & Industries

  • Electronic Data Capture (EDC)
  • ePRO
  • eConsent
  • Decentralized Clinical Trials (DCT)
  • Clinical Data Management
  • Medical Device & Diagnostics
  • Biotech & Pharma
  • CROs
  • Academic Research

Resources

  • Thought Leadership
  • Blog
  • Castor Academy
  • Knowledge Base

 

Company

  • About Us
  • Careers
  • News
  • Contact Support
  • Contact Us

Legal & Compliance

  • Terms of Use
  • Privacy & Cookie Statement
  • Responsible Disclosure Policy
  • Good Clinical Practice (GCP)
  • ISO Compliance Certificates
  • GDPR & HIPAA Compliance
  • Security Statement

© 2022, Castor. All Rights Reserved.

Follow us on social media


Knowledge Base Software powered by Helpjuice

Definition by Author

0
0
Expand