New Features - API Application Data

Today, I'm checking in with a neat new feature of our PokitDok Platform APIs. If you're not familiar with them, our APIs provide a clean, easy way to do eligibility checks, file claims with insurance companies, search for providers, and much more. Have a look at our platform site to learn more and sign up for free.

We recently had a customer ask if they could pass a bit of metadata along with their eligibility requests, and have it returned with the response. They could then pick this metadata off and use it to route the response to the correct place in their existing system. Well, we thought that was a great suggestion, so we have implemented this across our entire suite of API endpoints.

We've updated our developer documentation to demonstrate this functionality. Here's a quote from there:

API client applications may include custom application data in requests to help support scenarios where an application is unable to store the activity id and wishes to include application specific data in their API requests so that the information will be stored on the request's activity and returned to the application in asynchronous callbacks. This can be useful for scenarios where you want to directly associate a PokitDok Platform API request with some identifier(s) in your system so that you can do direct lookups to associate responses with the appropriate information. For example, suppose you wish to fire off a number of eligibility or claims requests and want to include some identifiers specific to your application. By including the identifier(s) you need in the request's application_data section, you can easily do direct lookups using those identifiers when you receive the API response.

Here's an example of how to craft a request payload containing application data:

The application_data block comes back to you, unchanged, in the data section of both synchronous and asynchronous responses, and it's also stored on the corresponding Activity for the transaction, viewable in the Platform Dashboard.

This has turned out to be a useful little feature for at least one of our clients. Hopefully it'll help you too. If you have questions concerning this, or anything to do with our health data APIs, feel free to contact our Platform team using our Contact Us page.

Leave a Reply

Your email address will not be published.