Validate Solution

Before bringing your integration live with clients, athena will work with you to confirm that your integration functions as scoped and will work with you to finalize any remaining details. 

  1. Purpose

    Following a self-service build model, it is the customer's (or vendor's) responsibility to build and test their API integration in their Preview environment prior to submitting a request for Solution Validation. At this point the integration must be fully built and tested in the Preview environment, and both business and technical stakeholders should be aligned on the solution being ready for production.

    Once you submit your request for Solution Validation, athenahealth will coordinate a 30-minute Solution Validation call, where technical stakeholders are required and business stakeholders are strongly encouraged to attend. During the call, client (or vendor) will need to walk us through a live end-to-end demo of the app and integrated workflows, and be prepared to answer any questions we have concerning the integration. 

    This Solution Validation call is typically the last checkpoint necessary for athenahealth to ensure that the API solution is properly configured, functions as intended, and does not pose risk to our systems or the workflows of athenaNet users. To help ensure an efficient and successful Solution Validation, we recommend doing a dry run of the demo on your own prior to the live call with athenahealth.

  2. Pre-requisites for validation

    Before requesting solution validation, you must complete all the following: 

    • Design your application to be efficient in the API calls it makes 
    • Design your application with security in mind, including these best practices 
    • Complete development of the release candidate of your application 
    • Complete full, end-to-end testing of your application in your Preview environment 
    • Be prepared to provide a live demonstration of your application using your Preview environment
    • Complete a Technical Specification (the template can be found at documenting the solution that is going into production and is therefore in scope for the Solution Validation
  3. What’s the process / how does it work?

    • Once you have completed all the pre-requisites, you submit a request for Solution Validation 
    • An athenahealth integration specialist will reach out to you to schedule a 30-minute Solution Validation call 
    • On the call, you will provide a live end-to-end demonstration of the application and integrated workflows in the applicable athenaNet Preview (test) environment
    • The integration specialist will evaluate your integration and determine if it is production-ready 
    • If your application passes Solution Validation, you will be provided with a Go-Live Authorization document for signature, and the integration specialist will coordinate next steps with you 
  4. Evaluation Criteria

    While there are numerous aspects to the evaluation, some of which depend on your application’s use case(s), the following are some of the things your application will be evaluated on: 

    • Excessive, Bulk, Redundant, or Unnecessary API calls 
      • Certain administrative data (e.g., Providers, Departments, Appointments) don’t change frequently, so repeat calls to these endpoints are usually unnecessary 
      • Leverage caching and subscription endpoints where available 
      • Ensure that your application stays within the Queries per Second (QPS) and Queries per Day (QPD) limits 
    • Integrity of Chart Data 
      • Patients should never make direct updates to their chart; all chart updates must be reviewed and approved by clinical staff 
    • Security 
      • Use an application-specific or “service account” API key (“client id”); do not use an individual developer’s key 
      • Maintain your API credentials in a centralized secure system, such as a HIPAA-compliant key server and API caller 
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others

On this Page