Developer Features in 23R1

We are pleased to bring you the following additions and enhancements to Developer Portal features in 23R1. REST API features added in 23R1 only affect API v23.1, unless otherwise specified.

Combination Form Data API

Release Date: March 3, 2023

At this release, Veeva recommends targeted updates to a form (specific subject/form) using the Combination Form Data API, going forward. Existing APIs for ongoing integrations must move / adjust to use this new endpoint, as existing are not moved forward in these respects. New studies should look to take advantage of this new and improved method.

This API comprises the concepts of:

• Upsert Forms (i.e. when forms repeat)
• Upsert Item Groups (i.e. when item groups in the form repeat)
• Upsert Items (i.e. the actual setting of values to items on the form)
• Edit Submitted Form (i.e. to reopen form currently in submitted state)
• Submit Form (i.e. submit the form when finished, which runs study rules)

The key here is that ONE API call now be used instead of conditional singular APIs, done in an appropriate order. Further, the API will place a default change reason where one is omitted from the request, or take the one indicated in the request.

Data Added via the API has a Read-only Option

Release Date: February 10, 2023

When an Event Date or Item value is set via the API and marked as Externally Owned, EDC marks that Event Date or Item as read-only and prevents changes. Organizations can choose to move their active integrations forward to use this feature. Otherwise, they can stay on earlier API versions.

With the APIs listed below, users can set the externally_owned parameter to true (default when omitted) to indicate that the value should be treated as Externally Owned:

• Set Item Values
• Upsert Items
• Set Event Date
• Create Event Group (for unscheduled Event Groups only, where an Event Date is provided)
• Upsert Event Groups (for unscheduled Event Groups only, where an Event Date is provided)

With the property set, site users that attempt Reset Form cannot unset values. To unset the property through the API, pass false to the endpoint / location (Event Date or Items on a Form).

As part of this feature, we made the following changes to API responses:

• Retrieve Forms/Item Data returns the value for externally_owned on all Items.
• Retrieve Events/Forms returns the value for externally_owned_date on all Events.

Retrieve Coding Definitions Returns Dictionary Version

Release Date: February 10, 2023

Retrieve Coding Definitions now returns the Dictionary Version for each Form location that is configured for medical coding.

Start Study Data Extract Job Supports the Boolean Formatting Property

Release Date: February 10, 2023

This endpoint now supports the boolean_formatting parameter, which controls the SDE option used for formatting checkboxes and boolean field values. The default is y_n, which was the behavior prior to the v23.1 release.