Changes in the Feasibility API

Oct 13, 2025 by pynkocean.com 89 views

=====================================================

Introduction

The feasibility API is undergoing significant changes in the next version, which will impact the existing feasibility service. This article will guide you through the modifications required to adapt to the new feasibility API. We will explore the changes in the API, the impact on the feasibility service, and provide a step-by-step guide on how to update the service to the new API.

Changes in the Feasibility API

The feasibility API will change as described in the swagger.yaml file. The main change is that users will now save a data query instead of a feasibility query. This shift is driven by the introduction of the Clinical Resource Transfer Definition Language (CRTDL), which is composed of two parts: cohortDefinition and dataExtraction.

CRTDL: A New Language for Data Queries

CRTDL is a language used to define data queries. It is composed of two main parts:

CohortDefinition: This part is equivalent to the previous feasibility query. It defines the criteria for selecting a cohort of patients.
DataExtraction: This part defines the data to be extracted from the selected cohort.

The use of CRTDL allows for more flexibility and precision in defining data queries, making it an essential component of the new feasibility API.

Changes in the Feasibility Service

The feasibility service will need to be updated to accommodate the changes in the feasibility API. The base path of the service will change to api/v5/query/data, and individual calls will be modified as follows:

Modified Calls

getQueriesByUser: This call will remain the same: ${this.basePath}/by-user/${userId}
getQueryById: This call will also remain the same: ${this.basePath}/${queryId}
getQueryContentById: This call will change to: ${this.basePath}/${queryId}/crtdl
getQueryResultById: This call will be removed, as it is no longer needed. The result is now part of the return of getQueryById. Note that site-specific results can no longer be queried separately.

Updating the Feasibility Service

To update the feasibility service, follow these steps:

Step 1: Update the Base Path

Update the base path of the service to api/v5/query/data.

Step 2: Modify Individual Calls

Update the individual calls as described in the previous section:

Update getQueriesByUser to use the new base path.
Update getQueryById to use the new base path.
Update getQueryContentById to use the new base path and include the CRTDL part.
Remove getQueryResultById, as it is no longer needed.

Step 3: Test the Updated Service

Test the updated service to ensure that it is working correctly with the new feasibility API.

Conclusion

The feasibility API is undergoing significant changes, which will impact the existing feasibility service. By understanding the changes in the API and following the steps outlined in this article, you can update your feasibility service to accommodate the new API. Remember to test the updated service thoroughly to ensure that it is working correctly.

Additional Resources

For more information on the feasibility API and CRTDL, refer to the following resources:

====================================================================

Q: What is the main change in the feasibility API?

A: The main change in the feasibility API is that users will now save a data query instead of a feasibility query. This shift is driven by the introduction of the Clinical Resource Transfer Definition Language (CRTDL), which is composed of two parts: cohortDefinition and dataExtraction.

Q: What is CRTDL?

A: CRTDL is a language used to define data queries. It is composed of two main parts:

CohortDefinition: This part is equivalent to the previous feasibility query. It defines the criteria for selecting a cohort of patients.
DataExtraction: This part defines the data to be extracted from the selected cohort.

Q: How will the base path of the service change?

A: The base path of the service will change to api/v5/query/data.

Q: Which individual calls will be modified?

A: The following individual calls will be modified:

getQueriesByUser: This call will remain the same: ${this.basePath}/by-user/${userId}
getQueryById: This call will also remain the same: ${this.basePath}/${queryId}
getQueryContentById: This call will change to: ${this.basePath}/${queryId}/crtdl
getQueryResultById: This call will be removed, as it is no longer needed. The result is now part of the return of getQueryById.

Q: What should I do with the removed `getQueryResultById` call?

A: You should remove the getQueryResultById call, as it is no longer needed. The result is now part of the return of getQueryById.

Q: How can I update my feasibility service to accommodate the new API?

A: To update your feasibility service, follow these steps:

Update the base path of the service to api/v5/query/data.
Modify the individual calls as described above.
Test the updated service to ensure that it is working correctly with the new feasibility API.

Q: Where can I find more information on the feasibility API and CRTDL?

A: You can find more information on the feasibility API and CRTDL in the following resources:

Q: What if I have further questions or concerns about the update?

A: If you have further questions or concerns about the update, please don't hesitate to reach out to the development team or the relevant support channels. We are here to help you with any questions or issues you may have.