Skip to main content

Castor EDC Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a Castor EDC location.
castor_edc_api.png

Castor EDC

Create a Castor EDC Destination​

  1. Click the + icon on the Nexset that will be sent to the Castor EDC destination, and select the Send to Destination option from the menu.

  2. Select the Castor EDC connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Castor EDC organization, and click Next; or, create a new Castor EDC credential for use in this flow.

  3. In Nexla, Castor EDC destinations can be created using pre-built endpoint templates, which expedite destination setup for common Castor EDC endpoints. Each template is designed specifically for the corresponding Castor EDC endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    Castor EDC destinations can also be configured manually, allowing you to send data to Castor EDC endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Castor EDC endpoints. Each template is designed specifically for the corresponding Castor EDC endpoint, making destination setup easy and efficient.

Several Castor EDC write endpoints are scoped to a specific study, participant (record), or survey package instance, and require you to supply the relevant identifiers. These identifiers can be obtained from the corresponding list endpoints on the Castor EDC data source (for example, Get Study for Study IDs and List Study Records for Record IDs).

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Create Record

    Enrolls a new participant (record) in a study. Use this endpoint to automate participant enrollment from an upstream data source.

    • Enter the identifier of the study in the Study ID field. Study IDs can be obtained from the Get Study endpoint on the data source.
    • Map the Nexset fields to the participant attributes expected by Castor in the request body, such as the assigned site.

    Update Record

    Updates participant metadata on an existing record, such as status, site assignment, or randomization details.

    • Enter the identifier of the study in the Study ID field. Study IDs can be obtained from the Get Study endpoint on the data source.
    • Enter the identifier of the participant to update in the Record ID field. Record IDs can be obtained from the List Study Records endpoint on the data source.

    Randomize Record

    Triggers randomization for a participant record using the study's configured randomization module. Use this endpoint to automate randomization as participants become eligible.

    • Enter the identifier of the study in the Study ID field. Study IDs can be obtained from the Get Study endpoint on the data source.
    • Enter the identifier of the participant to randomize in the Record ID field. Record IDs can be obtained from the List Study Records endpoint on the data source.

    Randomization can only be triggered for studies that have a randomization module configured and for participants that meet the study's randomization criteria.

    Create Site

    Creates a new site within a study. Use this endpoint to automate study setup workflows that provision clinical sites.

    • Enter the identifier of the study in the Study ID field. Study IDs can be obtained from the Get Study endpoint on the data source.
    • Map the Nexset fields to the site attributes expected by Castor in the request body, such as name and abbreviation.

    Update Site

    Updates the attributes of an existing site, such as its name or abbreviation.

    • Enter the identifier of the study in the Study ID field. Study IDs can be obtained from the Get Study endpoint on the data source.
    • Enter the identifier of the site to update in the Site ID field. Site IDs can be obtained from the List Study Sites endpoint on the data source.

    Post Study Data Points

    Writes or updates study-form data points (CRF answers) for a participant. Use this endpoint to push collected field values into a participant's study forms.

    • Enter the identifier of the study in the Study ID field. Study IDs can be obtained from the Get Study endpoint on the data source.
    • Enter the identifier of the participant in the Record ID field. Record IDs can be obtained from the List Study Records endpoint on the data source.

    Create Repeating Data Instance

    Creates a new repeating-data (report form) instance for a participant. A repeating-data instance must exist before data points can be posted to it.

    • Enter the identifier of the study in the Study ID field. Study IDs can be obtained from the Get Study endpoint on the data source.
    • Enter the identifier of the participant in the Record ID field. Record IDs can be obtained from the List Study Records endpoint on the data source.

    Update Repeating Data Instance

    Updates the metadata of an existing repeating-data instance, such as its status or name.

    • Enter the identifier of the study in the Study ID field. Study IDs can be obtained from the Get Study endpoint on the data source.
    • Enter the identifier of the participant in the Record ID field. Record IDs can be obtained from the List Study Records endpoint on the data source.
    • Enter the identifier of the repeating-data instance to update in the Repeating Data Instance ID field. These IDs can be obtained from the List Record Repeating Data Instances endpoint on the data source.

    Post Repeating Data Data Points

    Posts or upserts data points into an existing repeating-data instance for a participant.

    • Enter the identifier of the study in the Study ID field. Study IDs can be obtained from the Get Study endpoint on the data source.
    • Enter the identifier of the participant in the Record ID field. Record IDs can be obtained from the List Study Records endpoint on the data source.
    • Enter the identifier of the repeating-data instance in the Repeating Data Instance ID field. These IDs can be obtained from the List Record Repeating Data Instances endpoint on the data source.

    Delete Repeating Data Instance

    Deletes a repeating-data instance from a participant record.

    • Enter the identifier of the study in the Study ID field. Study IDs can be obtained from the Get Study endpoint on the data source.
    • Enter the identifier of the participant in the Record ID field. Record IDs can be obtained from the List Study Records endpoint on the data source.
    • Enter the identifier of the repeating-data instance to delete in the Repeating Data Instance ID field. These IDs can be obtained from the List Record Repeating Data Instances endpoint on the data source.

    Deleting a repeating-data instance removes the instance and its associated data points. Confirm that the instance is no longer needed before sending data to this endpoint.

    Create Survey Package Instance

    Creates and dispatches a new survey package instance (ePRO) to a participant. Use this endpoint to automate sending surveys to participants.

    • Enter the identifier of the study in the Study ID field. Study IDs can be obtained from the Get Study endpoint on the data source.
    • Map the Nexset fields to the survey package and participant attributes expected by Castor in the request body.

    Update Survey Package Instance

    Updates an existing survey package instance—for example, to reschedule the send date, mark it as finished, or resend it.

    • Enter the identifier of the study in the Study ID field. Study IDs can be obtained from the Get Study endpoint on the data source.
    • Enter the identifier of the survey package instance to update in the Survey Package Instance ID field. These IDs can be obtained from the List Record Survey Package Instances endpoint on the data source.

    Post Survey Package Instance Data Points

    Writes (creates or updates) data points for a survey package instance. Use this endpoint to pre-fill or correct ePRO survey responses.

    • Enter the identifier of the study in the Study ID field. Study IDs can be obtained from the Get Study endpoint on the data source.
    • Enter the identifier of the survey package instance in the Survey Package Instance ID field. These IDs can be obtained from the List Record Survey Package Instances endpoint on the data source.

Configure Manually​

Castor EDC destinations can be manually configured to send data to any valid Castor EDC API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Castor EDC API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Castor EDC API from the Method pulldown menu. Castor EDC write endpoints typically use POST to create resources or write data points, PATCH to update existing resources, and DELETE to remove resources.

Data Format​

  1. Select the format in which the Nexset data will be sent to the Castor EDC API from the Content Format pulldown menu. Castor EDC API endpoints accept JSON, so select the JSON format. Nexla will automatically convert the data to the selected format for each API call.

API Endpoint URL​

  1. Enter the URL of the Castor EDC API endpoint to which you want to send the Nexset data in the URL field. Castor endpoints are built on your environment base URL—for example, https://data.castoredc.com/api/study/{'{study_id}'}/record to create a record, where {'{study_id}'} is the identifier of your study. For update operations, include the ID of the object to be updated at the end of the URL.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include any headers already present in the credentials. The OAuth 2.0 Authorization header is added automatically by Nexla based on your credential configuration.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Castor EDC destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

    Property Inside JSON Object

    1. Enter the name of the JSON property that should contain the batched records in the Property Name field.
    2. If any additional properties should be included in the request, enter the properties in the Other Props field in JSON format.

    Code

    1. Enter the code that will be used to create the batched request in the code editor below the Grouping Algorithm field.

Response Webhook​

Optional

Nexla can automatically send the response received from the Castor EDC API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call, such as the IDs assigned to newly created records or sites.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the Castor EDC API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the Castor EDC API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Castor EDC API using the current settings.

Castor EDC write endpoints modify live study data. When testing against a production study, use sample payloads carefully, or test against the Sandbox environment to avoid creating or altering real participant data.

Save & Activate the Destination​

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Castor EDC endpoint, open the destination resource menu, and select Activate.

    The Nexset data will not be sent to Castor EDC until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.