Developer Features in 24R3

We are pleased to bring you the following additions and enhancements to the EDC & CDB API features in 24R3. REST API features added in 24R3 only affect API v24.3, unless otherwise specified.

24R2.4

Set Coding Suggestions

Release Date: October 18, 2024 UPDATE

The existing endpoint Set Coding Suggestions now additionally allows for setting coding for Medical Coding Requests while editing suggestions of each.

The following pertains to this update:

• Your Vault must be enabled to perform this additional action.
  
• An approval step is required for all coding performed via the API.
• Not every coding request will allow the set of coding through the API. The following are examples:
  • Current status of Rejected , and attempt to set the same coding
  • Verbatim is on a Do Not Autocode list
  • Coding is set and the coding was already approved
• When suggestions are updated, but coding is not set, an entry level "responseStatus": "WARNING" will be returned. It includes a warnings array that provides details on why the coding could not be set.

Resources related to this update:

• Third-Party Suggestions
• About Autocoding, [Do Not Autocode List](https://cdmshelp.veeva.com/gr/coders/do-not-autocode-lists/
• Autocode from Dictionary Setting, Managing Synonym List
• Enable Approval Workflow Feature

Return individual failures for CDB API calls

Release Date: October 18, 2024 UPDATE

The CDB Open, Answer, and Close API calls now allow for successful execution of the call if a subset of the call is invalid. If multiple requests are included in a single call, with some requests being valid and some invalid, a message in the response will inform the end user of how many requests failed. The response status for each invalid request will display “FAILURE”, while the other requests will successfully execute.

24R2.3

Retrieve Event Group Definitions

Release Date: September 27, 2024 NEW

The new Retrieve Event Group Definitions endpoint allows the retrieval of Event Group definitions in a study, of a specific Casebook version. When building a Study through the API (with Create Event Group Definitions, v24.1 & v24.2), use this endpoint to inspect existing elements before proceeding.

Required permissions:

• API Access
• View Study (for viewing in a study)
• View Library (for viewing in a library study)

Retrieve Event Definitions

Release Date: September 27, 2024 NEW

The new Retrieve Event Definitions endpoint allows the retrieval of Event definitions in a study, of a specific Casebook version. When building a Study through the API (with Create Event Definitions, v24.1 & v24.2), use this endpoint to inspect existing elements before proceeding.

• API Access
• View Study (for viewing in a study)
• View Library (for viewing in a library study)

CDB Query Source

Release Date: September 27, 2024 UPDATE

In the 24R3 version of the CDB Query APIs, the following changes have been made:

• When Opening a Query (on an Item or on an Event):
  • origin_sys, origin_id, origin_name can be set for each query inside the queries array
  • origin_sys is required
  • origin_user is a new optional field available to be set for each query, which can be seen in the EDC UI if opened on EDC data
  • Users will no longer be able to mark a query as manual. Starting with this version, any query opened through the CDB API will have this setting set to false.
• When Answering or Closing a Query:
  • Users can specify additional fields for:
    • message_origin_sys
    • message_origin_user
    • message_origin_id
  • These fields can be seen in the EDC UI if opened on EDC data
• All queries posted by the CDB API are considered generated by an External System.

Query source information gives users clearer details about who opened a query and from which system, along with providing identification information to the external system. Learn more about External Queries.

24R2.2

Batch Limit for Open Query API

Release Date: August 23, 2024 UPDATE

To match the behavior of other CDB query APIs, we added a limit of 500 records per request for the Open Query by Item endpoint. This change applies to all versions of the CDB API.