Release Notes and Change Logs

athenaOne Release Schedule

athenaOne releases bug fixes and minor enhancement requests on a bi-weekly cadence. Production releases take place on Fridays followed by Preview releases on Saturdays. If you have submitted a request, we will notify you so you can verify the changes in Preview before it becomes available in Production. All other generic API changes will be noted below and made available immediately or on an as-needed basis.

Important Upcoming Changes

12.2022

12.8 Bi-weekly Release: Updated Endpoint: Additional Data Sources added to FHIR R4 Observation Endpoint

  • Updated endpoint to add chart and encounter measurement data sources to the FHIR R4 Observation Endpoint

12.1 Bi-weekly Release: Updated Endpoint: Backend Updates to Prepare Screener

  • Updated endpoint to several questions in the PRAPARE questionnaire

12.1 Bi-weekly Release: Updated Endpoint: DocumentReferenceidentifier will be the same as the DocumentReferenceid

  • This has a breaking change
  • Updated endpoint to set the DocumentReference.identifier to be the same as the DocumentReference.id.

12.1 Bi-weekly Release: New Endpoint: GET and POST Action Notes on Letter

  • New endpoints to allow users to GET and POST action notes for a given letter document.

12.1 Bi-weekly Release: New Endpoint: GET and POST Action Notes on Surgery Documents

  • New endpoints enabling users to GET and POST action notes for a given surgery document.

12.1 Bi-weekly Release: Updated and New Endpoints: Get Attachments to a Patient Case

  • New and updated endpoints enabling users to access attachments to a patient case via API (when a patient case is generated, and documents are attached to it).

12.1 Bi-weekly Release: Updated Endpoints: Display if Summary of Care is Linked to Order or Surgery

  • Updated endpoints to populate attributes to inform if a Summary of Care document is linked to an order or surgery document.

12.1 Bi-weekly Release: Updated Endpoints: Display Schedule within Time Period for Consult Orders

  • Updated endpoint to populate the schedule within time period documented on consult orders.

12.1 Bi-Weekly Release: Updated Endpoint: Performance Improvements to GET insurancepackages API Endpoint

  • The GET insurancepackages API endpoint can now return more than 15 responses, and the stateofcoverage parameter should no longer be used.

    12.1 Bi-Weekly Release: Updated Endpoints: Populate the Observation.interpretation attribute

    • Updated endpoint to populate the Observation.interpretation attribute.

      12.1 Bi-weekly Release: Updated Endpoints: Populate the Surgery and/or Procedure the Document is Tied to

      • Updated endpoints enabling users to tie admin, patient cases, lab results and imaging result documents to procedures and surgeries.

       

       

        Change Log 2022

        11.2022

        22.11 Release: Updated Endpoints: Beta - Enable Read and Search Capabilities for the ServiceRequest FHIR Resource 

        • New endpoints to provide vendors with the option to use the standard FHIR based ServiceRequest rather than athenaOne APIs.

        22.11 Release: Enhanced Breaking Change Release Process for Public APIs

        • As athenahealth continues to evolve our ecosystem of available endpoints and functionalities, there will be unavoidable circumstances when breaking changes are introduced.
        • We have refined the process for introducing API-impacting features as well as the procedures for planning, testing, and remediating the effects of these breaking changes on your system.
        • This new process has been incorporated into the API Solutions Service Description.

        22.11.03 Bi-Weekly Release: Updated Endpoints: Populate Pre-scheduling Checklist on Surgery and Procedure Orders

        • Updated endpoint enabling users to get the Pre-scheduling checklist on surgery and procedure orders.

        22.11.03 Bi-Weekly Release: Updated Endpoints: Populate Alarm Days for Results, Orders and Surgeries

        • Updated endpoint enabling users to populate alarm days on imaging result documents, lab result documents, order documents, and surgery documents.

         

          10.2022

          October 2022 Release: Updated Endpoints: Automatic deletion of unused changed subscriptions

          • Unused subscriptions result in a significant number of unnecessary changed data messages that put pressure on our API infrastructure.

          22.10.24 Release: API Change: Update FHIR R4 Patient APIs to Return Record Restrictions and Blocked patients

          • Read and search FHIR R4 Patient endpoints have been updated to allow the return of record restrictions and blocked patients in the API response for 2-legged requests.
          • New security labels have been added to the metadata of the FHIR R4 Patient resource to indicate whether the record is restricted.

          22.10.20 - Return Social History Template Option Keys Appearing all Lower Case to Original Casing 

          • This has a breaking change
          • Updated endpoint to remove case-related discrepancy between the fields returned through the GET call and the fields expected for the PUT call for the keys linked to answer selections for the options field.

          22.10.07 Release: Updated Endpoints: POST/Add vitals to patient's chart MDP API Can Now Return VITALIDS

          • The POST/chart/{patientid}/vitals MDP API endpoint can now return the IDs of the newly added vitals.

          09.2022

          22.09.08 Bi-Weekly Release: Updated Endpoints: Backend Social History 

          • Updated endpoints to provides backend social history updates for Quality.

          08.2022

          22.08.25 Bi-Weekly Release: Updated Endpoint: Search Clinical Provider MDP API with Only Phone Number

          • Updated get/clinicalproviders/search endpoint enabling partners to search for clinical providers using only a phone number.

          22.08.11 Bi-Weekly Release: Updated endpoints: Enable attachments when retrieving a clinical letter document

          • Updated endpoint to allow vendors to retrieve attachments of letters.

          22.08.11 Bi-Weekly Release: Updated endpoints: Providing structured prior authorization details and Ask on Order Entry (AOE) questions with orders endpoints

          • Updated surgery and order endpoints to consistently populate Ask of Order Entry (AOE) questions and to populate structure prior auth details as entered on orders.

          07.2022

          07.27 Bi-Weekly: Updated Endpoint: GetLabResults API Retrieves Analyte Date and Time

          • Updated endpoint to retrieve the date and time when a patient's analyte levels are recorded, displaying the date and time with the result in the patient chart. 

          07.27 Bi-Weekly: Updated and New Endpoints: Populate Patient Education Content Via API

          • Updated endpoints to allow users to gather additional information on the patient education resources provided to patients via athenaClinicals.

          22.7 Added Standardized USC FHIR R4 Read and Search APIs in Support of 21st Century Cures

          • Starting Summer release, athenahealth will publish a set of read-only certified FHIR R4 APIs and our FHIR R4 server base URLs to empower third-party applications to easily integrate with our EHR and connect patients with their health information in accordance with 21st Century Cures Act. 

          22.7 Release: Added FHIR Bulk Data Access Capability in Support of 21st Century Cures

          • Added new capability that allows external systems to request large amounts of data in a FHIR format, using asynchronous API requests. 

          22.7 Release: Added Real-time Self-service Registration for 3-Legged OAuth Applications

          • Enhanced the app onboarding process making it more streamlined and self-service; therefore, increasing efficiency for API Developers who want to use our APIs to create an app

          22.7 Release: Added Admin Page to Monitor and Control PHR Application Access

          • Created practice admin page in athenaOne® enabling all Practice Managers and Communicator Admins to view a complete list of the PHR apps that can access your tablespace and control access if the app(s) meet a 21st Century Cures information blocking exception.

          22.7 Release: Update to Enable Patient Authentication Against Multiple athenaOne Practices Simultaneously Using Login with athenahealth

          • Eliminates the need for apps to specify both an athenahealth practice and Patient Portal brand for Login with athenahealth.

          05.2022

          22.5 Release: Modality Code Added to orders/signedoff Endpoint

          • Added modality code to orders/signedoff endpoint.

          22.5 Release: Updated to Add Insurance Package IDs to Response of Claim Endpoints 

          • Added primaryinsurancepackageid and secondaryinsurancepackageid to GET /claims/changed messages and GET /claims/{claimid} responses.

          03.2022

          22.3 Release: API Subscriptions - Department Filter Update

          • Updated department filtering on our API subscription. This update will run a batch update for all client and partner subscriptions (POST calls) to remove Department filters that were added by athena in the 22.1 release.

          22.3 Release: Enable Creation of OB Episodes for Transgender Patients

          • OB episodes are now enabled for transgender patients who may have a legal sex other than F.

          22.3 Release: Developer Portal – Usage Analytics and Error Dashboard for API Customers

          • The Console now provides a new analytics dashboard for preview or production apps enabling you to track your API call volume, errors, and rate limits.

          22.03.10 Bi-weekly Release: New Response Fields Added to the Apigee Token Response

          • The "scope" and "token_type" fields are now returned with all existing fields.

          02.2022

          22.2-22.3 Release: Updated Screening Questionnaire version numbers API Endpoint

          • We are making a change that will result in a new version number for many of our existing full screening questionnaires. This change does not affect any phrasing of the screener questions or of the question responses or other function of these tools. It is an administrative update on our end. We anticipate this to be a one-time project for this particular update.

          01.2022

          22.1 Release: Updated batch to API Subscriptions to Leverage Department Filtering

          • To cleanup subscriptions, athenahealth will be running a batch update for all client and partner subscriptions (POST calls) to add the appropriate Department filter to your subscriptions.
            • Department IDs to set in the Department Filter for each Changed Subscription have been determined by analyzing what messages have been retrieved (GET calls) by the client/partner in the prior 90 days (e.g., 1st Oct' 21 - 31st Dec '21).

          22.1 Release: Updated Analyte name available when retrieving lab result

          • API endpoints affected include these categories

            • Documents and Forms

          Change Log 2021

          11.2021

          21.11 Release: Expose Original Documents Via API

          • API endpoints affected include these categories
            • Documents and Forms

          21.11 Release: Add "createduser" Output For GET Documents Call

          • API endpoints affected include these categories
            • Documents and Forms

          21.11 Release: Add Output For Various Document Endpoints To Expose Original File Metadata Elements 

          • API endpoints affected include these categories
            • Documents and Forms

          21.11 Release:  Additional Supported Document Upload Types To Match The Athena UI For Document Endpoints

          • API endpoints affected include these categories
            • Documents and Forms

          21.11 Release: Enhanced Capability to Indicate Partially Administered Vaccines

          • API endpoints affected include these categories
            • Vaccines

          21.11 Release: Enhanced Reason Selection Options for Vaccines Not Given

          • API endpoints affected include these categories
            • Vaccines

          10.2021

          10.29 Bi-weekly Release: Revised Responses for Social History Smoking Status Question

          • API endpoints affected include these categories
            • Social History

          10.29 Bi-weekly Release: Portal User Will See Username of Provider Who Publishes Secure Message Instead of Provider Who Creates Secure Message 

          • API endpoints affected include these categories
            • Secure Messages

          09.2021

          09.03 Bi-weekly Release: Provider ID field returns Facility ID when running Lab/Imaging Result subscription API

          • This had a breaking change
          • API endpoints affected include these categories
            • Lab Results
            • Imaging Results

          08.2021

          08.06 Bi-weekly Release: Populate 'Priority' attribute on Order ID Endpoint

          • API endpoints affected include these categories
            • Orders

          07.2021

          21.7 Release: New Social History Experience 

          • This had a breaking change
          • API endpoints affected include these categories:
            • Social History questions and templates 
            • Patient selected templates 
            • Patient Social History 
            • Health History forms

          21.7 Release: Updated Ask at Order Entry Questions in Authorization and Insurance Referrals Section on Orders

          • This had a breaking change
          • New fields in the Authorization and Insurance Referrals section replace outdated AOEs on orders 
          • You must update Encounter Group and Auth Ops Group APIs with the new AOE questions

          21.7 Release: Updated Vaccine Information Statement (VIS) Documentation

          • This had a breaking change
          • Users will now be able to see which Vaccine Information Statements were provided to a patient

          21.7 Release: New athenaTelehealth Visit API

          • Access to the athenaTelehealth Visit API will benefit clients 
            • who utilize athenaTelehealth but do not utilize ReminderCall. It will allow them to deliver the visit link to patients via their chosen reminder method 
            • who utilize athenaTelehealth but do not use athenahealth's patient portal. It will allow them to take advantage of the Telehealth workflow in their portal of choice 
            • who want to surface the Telehealth workflow in custom applications 

          21.7 Release: Updated Subscribe Data Feed Types to Individual Departments

          • A new parameter is available for endpoint users to subscribe to specific departments within a practice. 
          • athenahealth will automatically update existing subscriptions for all users in a biweekly release after the Summer 2021 release. Expect further communications when your organization’s subscriptions will be updated. 
          • The list of department IDs for this functionality have been identified based on the unprocessed historical data for the past 3 months.

          06.2021

          • As of June 25, 2021, the rollout toggle associated with the “ircid” functionality for GET /appointments/booked (as noted in the June 11th update) is now GA.
          • As of June 16, 2021, we rolled back the changes for the input/output parameter patientrelationshiptoguarantor. The field now displays as the original parameter, guarantorrelationshiptopatient.
          • As of June 11, 2021, the input/output parameter guarantorrelationshiptopatient is now patientrelationshiptoguarantor. This field displays in GET /patients, PUT /patients/{patientid}, POST /patients, GET /patients/{patientid}, GET /patients/enhancedbestmatch, and GET /patients/customfield/{customfieldid}/{customfieldvalue}.
          • As of June 11, 2021, documentation has been updated to reflect that when GET /appointments/booked is used and the "showinsurance" flag is set to true, we now will also return an additional piece of information called “ircid”. This is the ID of the insurance’s reporting category; we already return the name as “ircname”. The rollout toggle associated with this functionality is set to go GA on June 25, 2021.

          05.2021

          • As of May 3, 2021, GET /appointments/{appointmentid}/nativeathenatelehealthroom was added to Sandbox. This endpoint retrieves details for a valid native athenaTelehealth appointment. Be aware that the invite link is to an unauthenticated web app. Clients should first check if their appointment is a native athenaTelehealth appointment by using our single appointment endpoint, GET /appointment/{appointmentid}. The patient url and join token are only valid on the day of the appointment. Please communicate the device check link (https://telehealth.px.athena.io/device-check) in your patient messaging.
          • As of May 3, 2021, GET /appointments/{appointmentid}/nativeathenatelehealthroom was removed from Sandbox. This API is still under development and may be added at a later date (to be determined).
          • As of May 3, 2021, GET /appointments/{appointmentid} had input parameter "showtelehealth" added and output parameter "nativeathenatelehealth" added. These parameters were added in preparation to the 21.7 Release and will not work until the release occurs.
          • As of May 14, 2021, output parameter "portalpublisheddatetime" was added to the following APIs: GET /patients/{patientid}/documents/labresult/{labresultid}, GET /patients/{patientid}/documents/imagingresult/{imagingresultid}, GET /patients/{patientid}/documents/labresult, and GET /patients/{patientid}/documents/imagingresult. This new output field indicates when a result has been marked as "send to portal".

          04.2021

          • A new field labeled EARLESTFILLDATE was added to the prescription order entry workflow. This is the field clinicians will use to specify the earliest date that the prescription can be filled by the pharmacy.

            The EARLESTFILLDATE field was added to the following APIs:
          1. GET /chart/{patientid}/medications*
          2. GET /chart/encounter/{encounterid}/orders
          3. GET /patients/{patientid}/documents/prescription/{prescriptionid}

            The FUTURESUBMITDATE will continue to be included in the above APIs. However, the FUTURESUBMITDATE (“Send” in the UI) is now hidden in the athenaNet user interface and therefore will always default to today’s date.

            *Special note regarding GET /v1/{practiceid}/chart/{patientid}/medications: This endpoint only emits the “futuresubmitdate” field for a medication if its order’s status is PEND. Since prescription orders will transmit immediately on approval and will no longer enter PEND status, users will no longer see the “futuresubmitdate” returned by this endpoint. The date of transmission remains visible in the “medication.events[].eventdate” field where the event’s “type” is “ORDER”.
          • As of April 14, 2021, GET /chart/configuration/questionnairescreeners will now return all available versions of a Screener available for a particular user/appointment/encounter and API users can choose what version of the screener to add to the encounter/appointment. To differentiate between versions the Screener “name” will carry the version information (Ex: Opioid Risk vs Opioid Risk v2). This will allow users to choose when to use the new version of a screener. *Please note that questionnaire screener names for versions that were rolled out in 20.11 will remain unchanged and will not have the appended version name.  

          02.2021

          • We are now surfacing the Observation Identifier for lab analytes. The output parameter observationidentifier is the analyte code which is created by the external lab. The affected endpoints are: GET /patients/{patientid}/documents/labresult/{labresultid}, GET /chart/{patientid}/analytes, and GET  /chart/{patientid}/labresults. This is being made since the Observation Identifier that the external lab service uses can add benefit to API users allowing users to know exactly what analyte the external lab is populating. 

          Change Log 2020

            12.2020

            • PUT /documents/imagingresult/{imagingresultid}/close was added to the Sandbox. This endpoint allows the user to advance an imaging result document to a closed status. 
            • PUT /documents/labresult/{labresultid}/close was added to the Sandbox. This endpoint allows the user to advance a lab result document to a closed status.

            11.2020

            • Removed all of the Patient Pay Vendor endpoints as these are still in development.
            • Removed the Fax System section from the Sandbox.
            • DELETE /chart/encounter/{encounterid}/encounterreasons was added to the Sandbox. This endpoint allows the user to delete an encounter reason from this encounter. The encounter reason to delete must be specified by its encounter reason id.
            • POST /chart/encounter/{encounterid}/encounterreasons was added to the Sandbox. This endpoint allows the user to add or update an encounter reason on this encounter. The encounter reason must be specified by ID. Use /configuration/encounterreaaons to get the full list of available encounter reasons.
            • POST /chart/encounter/{encounterid}/encounterreasonnote was added to the Sandbox. This endpoint allows the user to set or append text to the Encounter Reason Note. 
            • GET /configuration/encounterreasons was added to the Sandbox. This endpoint allows the user to retrieve the list of configured encounter reasons.
            • POST /encounter/{encounterid}/services has been updated to accept CPT codes (procedurecode) with the clinicalordertypegroup of "OTHER".

              10.2020

              • POST /patientpayvendors/{vendorcode}/changeageingownership was added to the Sandbox. This endpoint allows the user to update the Enrollment status of a Claim with a Patient Pay Vendor.
              • POST /patientpayvendors/{vendorcode}/payments was added to the Sandbox. This endpoint allows the user to record payments related to a patient.
              • POST /patientpayvendors/{vendorcode}/payments/{patientpaymentid}/refund was added to the Sandbox. This endpoint allows the user to record refunds related to a patient.
              • PUT /patients/{patientid}/documents/orders/referral/{referraldocumentid}/close was added to the Sandbox. This endpoint allows the user to close a referral order.
              • PUT /patients/{patientid}/documents/orders/referral/{referraldocumentid}/reopen was added to the Sandbox. This endpoint allows the user to reopen a referral order. When reopening a referral order, the status will be returned to SUBMIT.

                09.2020

                • GET /chart/{patientid}/allergies will now contain the key “categories” which will be an array of 0 to 3 categories, specifically “environment,” “food,” and “medication,” as applicable.
                • POST /patientpayvendors/{vendorcode}/statements was added to the Sandbox. This endpoint allows the user to update the age of claims for patients when statements are sent to them under the Patient Pay vendor.

                08.2020

                • POST /patientpayvendors/{vendorcode}/patientenrollment was added to the Sandbox. This endpoint allows the user to update the Enrollment status of a Patient with a Patient Pay Vendor.

                07.2020

                • GET /appointments/getappointmentidbyhash/{messagehash} was added to the Sandbox. This endpoint allows the user to get the appointment id from an appointment confirmation message hash.
                • When the “showallergentranslations” flag is set to TRUE for GET /chart/{patientid}/allergies, this endpoint will now include any available translations of the allergen code for each of the allergies on a patient’s chart, including “No Known Allergies”.

                06.2020

                • POST /appointments/expedited was added to the Sandbox. This call will create an appointment and complete the check-in process. In order to use this endpoint, the practice setting 'Expedited Encounters and Deferred Insurance' must be configured.
                • POST /vitals/observations was removed from the the Sandbox.

                05.2020

                • GET /personalpronouns was added to the Sandbox. This API is used to get the mapping of personal pronouns id to display name.
                • PUT /documents/labresult/{documentid}/dataentrycompleted was added to the the Sandbox. This endpoint is used to apply a document action on a specific lab result document.

                02.2020

                • POST /patients/{patientid}/patientsecuremessage/marklabresultread/{messagethreadid} was added to the Sandbox. This API updates the specified LabResult has been read by the patient or a family member on the Patient Portal.

                Change Log 2019

                06.2019

                • GET /patients/{patientid}/insurances will provide insurancepackageID information
                • Update appointment tickler ("appointment reminder") PUT & DELETE endpoints to allow modification by API for ticklers created by another user

                05.2019

                • BillingNDC parameter added to GET /v1/{practiceid}/patients/{patientid}/documents/prescription/{prescriptionid}
                • When the user runs the Request API - GET /v1/{practiceid}/chart/{patientid}/labresults, the output should expose additional parameters.
                  • "exactduplicatedocumentid" 
                  • "supersededdocumentid"
                • GET /chart/{patientid}/vaccines will surface "deletedate" when parameter "showdeleteted" = True.

                04.2019

                • GET /configuration/ordersets now returns the ICD10 codes, clinical provider name, and clinical provider id configured for each order set.
                • POST /providers allows for selecting supervising provider as 'SELF'.
                • GET /appointments/changed now surfaces appointment notes.
                • Output parameters of GET /encounter/{encounterid}/orders/{orderid} and GET /{patientid}/documents/order/{orderid} have been consolidated.
                • Fix messages returned for a deleted patient.
                  • When the Patient ID is soft-deleted within the context then display the message:“This patient id has been deleted from this context.”
                  • When the Patient ID is invalid (i.e.: no patient with that ID exists in the context, in any status) then display the message: “This patient does not exist in this context.

                 

                03.2019

                • GET /orders/changed can be filtered by order type, provider id, and clinical provider id/facility id.
                • GET /patients/changed will correctly return the patient's enterprise id instead of the athenaNet local id athenaNet localID when parameter 'returnglobalid' is set to TRUE.
                • The output of GET /orders/changed will now expose modality codes.

                02.2019

                • GET /patients/{patientid} will correctly return the insurance data associated with a patient's local id.
                • The following changed data subscriptions can now be filtered by department id and/or patient id (passed in as a JSON or comma-separated list):
                  • GET /ccmenrollmentstatus/changed
                  • GET /chart/healthhistory/medication/changed
                  • GET /claims/changed
                  • GET /appointments/changed
                  • GET /patients/changed
                • The POST /patients/{patientid}/documents/encounterdocument call will accept an enterprise id as the patient id and translate it to the appropriate local patient id.
                Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
                Submit

                On this Page