Release Notes
Back to All

2024.R1.SP4 API Release Notes - Released with 2024 R2.

8 months ago by Jeff Albracht
  1. CareTend API V3: Need a New Endpoint for Removing a Patient Ancillary Provider (HCSI-2999)
    a. Added a new endpoint that allows for the removal of a patient ancillary provider.
  2. CareTend API V3 - Need to Migrate the Get Collection of Shipment Data Endpoint to V3 Standards (HCSI-3028)
    a. Migrated the existing V2 Get Collection of Shipment Data endpoint to V3. The two endpoints will return the same information. If you are currently using the V2 that is fine, but it is our recommendation that you move to using the V3 endpoint so that you can work out of a singular version of the library.
  3. CareTend API V3 - Need to Add Additional Parameters to the Create Patient Endpoint (HCSI-3069)
    a. Added into the V3 version of the endpoint details that were left off when the endpoint was converted into the V3 portion of the library. Details added back are Access Order, Activity Level, Start of Care Date(Admit Date), Culture Sensitivities, Diabetes Type, Diet Type, Exclude From Batch Patient Statements, Has No Known Drug Allergies, Lab Orders, Latest Height CM, Latest Weight KG, Medical History, Patient Credit Limit, Patient Statement Message, Release Medical Information.
  4. CareTend API V3 - Need to Modify the Search Prescriptions Endpoint to Return Additional Information (HCSI-3073)
    a. Added the Next Compounding Date to in the response of the endpoint.
  5. CareTend API V3 - Need a New Endpoint for Updating IV Patient Orders (HCSI-3078)
    a. Added an endpoint that allows for the updating of IV orders.
  6. CareTend API V3 - Need to create a new endpoint for getting the Location and Quantity data for an inventory item. (HCSI-3124)
    a. Added an endpoint that will retrieve location and quantity data for inventory items based on Item Id or NDC
  7. CareTend API – Backward Compatibility – Loop Component (HCSI-3153)
    Error Response model changes - new v3 error response models
    • For all v3 endpoints, the Errors[] array has been removed from the error response model (in non Status 200 responses) in order to give a consistent place to find the error message (the response’s Message property).
    • The api reference documentation has been updated to reflect the change in error response models.
    • Every v3 endpoint should now have api reference documentation for status 500 errors.
    • For non-production environments, the new error model also supports a StackTrace property to assist with troubleshooting. There is a web.config setting that must be updated for the property to be populated.
    Endpoint Modifications
    • Changed the verb on the DeletePatientAllergy V3 Command from PATCH to DELETE. Have also changed the Request body has changed to query string param.
    • Changed the response for the SearchPerson V3 Command from a list of objects to a paged response object that contains the items and the total count. In addition, we have removed City, Zip, NPI, MaxResultCount from request object.
    • Changed the response for the SearchPatients V3 Command from a list of objects to a paged response object that contains the items and the total count. We have also non-breaking change sto the request model of the endpoint adding inputs that include CarrierId, IncludeInactive, PhoneNumber, PolicyNumber, and SSN.
    • Removed the EmailAddresses property from any V3 endpoints with Insurance Company responses.
    Paged Response API documentation
    • API reference documentation for any endpoints that use a PagedResponse model now correctly returns the correct data model. Previously: {"data": [], "totalCount": 0} Corrected: {"result": { "data": [], "totalCount": 0}, "statusCode":200, "message:":""}