2024.R2.SP1 API Release Notes - Pending Release. Will be available as part of the 2024 R3 Release


  1. Create patient Assessment V3 - Unassociated prescription number throws 500 internal server error. (HCSI-3242)
    a. Modified the error message returned to align with the standards of other errors that are being returned by an endpoint. The error in question was when the prescription and patient information passed to the endpoint are not related to each other.
  2. Search Patient API V3 - bug fix (HCSI-3240)
    a. Modified the error message returned to align with the standards of other errors that are being returned by an endpoint. The error in question was when the provide billing provider was not associated with the company id provided.
  3. Search Patient Providers throw error when search by PatientId (HCSI-3167)
    a. Modified the endpoint to require the input of either a Patient MRN or a Patient Id but not both.
  4. Create Patient API V3 - Invalid lookup throws error (HCSI-3239)
    a. When passing in values not defined in the list of valid values for the following fields Gender, Patient Status, License State, Service Site, Address State, Country, and County the endpoint was returning 500 internal server errors. This has been fixed so, now the endpoint now returns more user-friendly error messages.
  5. Create patient policy bugs (HCSI-3248)
    a. Fixed a few issues with how then endpoint was handling a few inputs, such as policy owner, patient relation to insured and next payer id.
  6. The password field from the patient notes response needs to be removed (HCSI-3145)
    a. The password field has been removed from the response of both the Get and Create Patient Note endpoints.
  7. Need a New Endpoint for Getting Purchase Orders (HCSI-3163)
    a. A new endpoint has been added to the library that will allow a user to get purchase or data from the system by either Purchase Order Number or Purchase Order ID.
  8. CareTend API - Need to Add the Due Date to the Create Document Endpoint (HCSI-3229)
    a. The create document endpoint has been modified to accept due date when creating a tracked document. This is not a required field when creating a tracked document and will issue an error when creating a document that is not tracked.
  9. CareTend API - Need to Create a New Endpoint for Searching Facilities (HCSI_3230)
    a. Added a new endpoint to the library for searching facilities. This new endpoint will accept as input Facility Name, Facility Type or both name and type.
  10. CareTend API - Create a Discontinue Prescription API (HCSI-2185)
    a. Added a new endpoint to the library for discontinuing a prescription. The endpoint currently does not allow you to discontinue prescriptions in the SPRx workflow. The following properties are required Prescription Id, Stop Date, Reason for Discontinue Name. Optionally you are allowed to pass in a Note via the endpoint.
  11. CareTend API - Need a New Endpoint for Updating IV Patient Orders (HCSI-3078)
    a. Added a new endpoint to the library for updating Patient IV Orders. The Order ID is the only required input of the endpoint.
  12. CareTend API - Need to Migrate the Get Patient User Defined Fields Endpoint to V3 Standards (HCSI-3021)
    a. Migrated the V2 endpoint for getting Patient User Defined Fields to the V3 library. The V2 version will still be there if you are already using it.
  13. CareTend API - Need to Add a New Endpoint for Searching Patient Notes (HCSI-3231)
    a. Added a new endpoint to the library for searching patient notes. Note Type is the only search criteria that has been set up as required, all others are optional.