Release Notes and Change Logs

athenaNet Release Schedule

athenaNet 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

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

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

Change Log 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.


  • 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.


  • 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 ( 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".


  • 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 “[].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.  


  • 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


    • 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.


    • 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".


      • 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.


        • 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.


        • 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.


        • 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”.


        • 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.


        • 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.


        • 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


        • 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


        • 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.


        • 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.



        • 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.


        • 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

        On this Page