Changelog

CareTend API Release Notes - 12/29/2025 to 1/09/2026

Related Issue NumberJira NumberRelease NoteCollectionAPI VersionStaging AvailabilityProduction Availability
N/AHCSI-4933Added a new POST v4/scheduletasks endpoint that lets AlayaCare create CareTend schedule tasks with subject, task type, start/end or duration, employee/department assignees, optional patient MRN, notes, and reminder minutes. Added validation and error handling for required fields (e.g., subject, task type, start date/time, department, entered by/on) and common edge cases, including support for clearing optional fields by sending null or no value. Added a structured response that returns the created task details (subject, type, start date/time, department, patient, duration, notes, assignees, reminder minutes) so calling systems can confirm the schedule entry that was created in CareTend.ScheduleTasksV41/14/20261/14/2026
N/AHCSI-5028Added a POST /v4/patients/search endpoint that removes use of database views in the underlying stored procedure so Integration V4 patient search works with the latest build pipeline. Added input validation to require well-formed patient search criteria and to reject invalid or incomplete request payloads before the query executes. Added an optimized query that returns patient search results directly from the underlying tables, with all previously ignored E2E and unit tests reinstated and functionality verified in QA (see attached Postman QA check)PatientsV41/14/20261/14/2026
N/AHCSI-5231Resolved an issue where the v4 PATCH /commands/v4/inventory endpoint returned a 500 error instead of a 400 when updating Drug or Supply inventory items with mismatched inventoryItemId and externalRefKey. Input validation has been enhanced so that mismatched identifiers or mismatched item types (for example, attempting to update a Drug inventory item as a Supply, or vice versa) now return a clear 400 error explaining that the values or types do not match the target inventory item. The endpoint continues to return standard success responses when the inventoryItemId, externalRefKey, and item type (Drug or Supply) are valid and consistent.InventoryV41/14/20261/14/2026
N/AHCSI-5232Added a POST v4/documents/newfax and v4/documents/newscan workflow integration so that newly created fax and scanned documents now appear correctly in the Document Manager and the Incoming Documents queue in the CareTend UI. Input validation ensures that only supported document types (New Fax, New Scanned) with valid workflow group settings create corresponding workflow instances required by the UI. The endpoint returns a standard 200 response with the created document, and now also creates the necessary workflow tracking records so these documents are immediately visible and editable in the UIDocumentsV41/14/20261/14/2026

CareTend 2026 R1 Release - 10/6/2025 to 12/26/2025

Related Issue NumberJira NumberRelease NoteCollectionAPI VersionStaging AvailabilityProduction Availability
N/AHCSI-3455Resolved an issue where the POST /v3/deliverytickets/shipmentupdates/search returned no results when shipment updates existed. The endpoint now requires a correctly structured JSON body (TeamIds, CompanyIds, ShipmentStatuses like ["shipped","return","transfer"]`, valid StartDate/EndDate, and paging: PageNumber, PageSize) and returns a paged list of matching shipment updates when validations and data conditions are met.DeliveryticketsV3Week of 1/5/2026Week of 1/19/2026
N/AHCSI-3859Added a POST /v3/patientorders/hme/recurringrental/item Recurring Rentals endpoint to create a recurring rental item and link it to an existing recurring rental, with automatic promotion to primary when it’s the only item and recalculation of billing options, authorizations, and taxes.PatientordersV3Week of 1/5/2026Week of 1/19/2026
N/AHCSI-3860Added a PATCH /v3/patientorders/hme/recurringrental/item endpoint that allows updating a recurring rental item and adding it to an existing recurring rental. Supports modifying details such as serial number, price, quantity, and tax status for equipment or non-inventory items, with billing and taxes recalculated as needed.PatientordersV3Week of 1/5/2026Week of 1/19/2026
N/AHCSI-3862Added a GET /v3/patientorders/hme/recurringrental/item endpoint to retrieve recurring rental items by Recurring Rental ID. Returns details such as serial number, billed and expected price, quantity, HCPC code, modifiers, billing narrative, taxable status, item description, and equipment asset information, and validates IDs for appropriate responses.PatientordersV3Week of 1/5/2026Week of 1/19/2026
WSI-65354HCSI-4933Updated Patient Orders CareTend API Endpoint where it will now automatically set the primary payer to “Patient” if none is provided.PatientordersV3Week of 1/5/2026Week of 1/19/2026
N/AHCSI-4136Updated the PUT IV patient drug order endpoint validation to prevent editing IV orders once a prescription is filled or labels have been printed.PatientordersV3Week of 1/5/2026Week of 1/19/2026
N/AHCSI-4945Updated Prescriptions CareTend API Endpoint where the Rx Description for Factor drug orders was not displaying in the UI response despite being passed via the Create or Update Prescription API, ensuring accurate rendering of prescription details for drugs like Eloctate Intravenous Solution Reconstituted 2000 UNIT.PrescriptionsV3Week of 1/5/2026Week of 1/19/2026
N/AHCSI-4947Updated Documents CareTend API Endpoint validation to clarify that the Received Date field cannot be set during creation of a "Patient Document" type, aligning with system constraints that restrict date fields to update operations only.DocumentsV3Week of 1/5/2026Week of 1/19/2026
N/AHCSI-4963Fixed an issue in the POST Documents CareTend API endpoint where updating the activeDate field caused the Date Active value to be removed in CareTend UI, ensuring the updated date displays correctly instead of reverting to “Select a date.”DocumentsV3Week of 1/5/2026Week of 1/19/2026
N/AHCSI-4977Fixed an issue with the POST Prescriptions API Endpoint where you received an error when trying to create a prescription for a Drug or HME order.PrescriptionsV3Week of 1/5/2026Week of 1/19/2026
N/AHCSI-4978Updated the POST Persons CareTend API endpoint by adding support for the ‘Associated Organization’ field group (Prescriber, Facility, Insurance Company, Supplier) in the Create Person endpoint, aligning API functionality with UI capabilities for contact management workflows.PersonsV3Week of 1/5/2026Week of 1/19/2026
WSI-66291HCSI-4979Updated the POST Delivery Ticket Items CareTend API endpoints to allow updates on non-working Delivery Tickets, resolving previous errors and enabling full support for programmatically created tickets in purchase order workflows.DeliveryticketsV3Week of 1/5/2026Week of 1/19/2026
N/AHCSI-5015Updated the POST Providers CareTend API endpoint to support creating provider contacts and user-defined fields, aligning API functionality with UI capabilities for comprehensive provider data management.ProvidersV3Week of 1/5/2026Week of 1/19/2026
N/AHCSI-5021Updated the POST Patients CareTend API endpoint to allow creating and updating patients without requiring a date of birth, aligning API behavior with UI functionality.PatientsV3Week of 1/5/2026Week of 1/19/2026
N/AHCSI-5023Updated the /v3/patients/contacts CareTend API endpoint to allow specifying an Active status when creating a patient contact, eliminating the need for a subsequent update call and aligning API behavior with UI functionality.PatientsV3Week of 1/5/2026Week of 1/19/2026
N/AHCSI-5024Updated the PATCH employees endpoint to allow clearing employee fields such as address, phone, DOB, and supervisor when information is incorrect and not yet available.EmployeesV3Week of 1/5/2026Week of 1/19/2026
N/AHCSI-5025Fixed an issue with the POST /v3/documents/serach endpoint to return the appropriate Workflow Id based on the specified workflowGroupName (e.g., HME, SPRx), ensuring accurate document retrieval.DocumentsV3Week of 1/5/2026Week of 1/19/2026
N/AHCSI-5049Updated POST /v3/deliverytickets/shippingresponses endpoint by fixing a bug for a missing mapping to ensure successful API calls now return accurate shipping data instead of empty responses.DeliveryticketsV3Week of 1/5/2026Week of 1/19/2026
WSI-69238HCSI-5065Fixed a bug where the POST /v3/patients/assessments/custom endpoint required a customAssessmentId without clear guidance. Validation now ensures a valid ID is provided or generated, and documentation clarifies requirements.PatientsV3Week of 1/5/2026Week of 1/19/2026
WSI-69445HCSI-5068Updated the POST /v3/patientorders/search endpoint to include Created Date and Modified Date in responses. Requires valid patient MRN or patientOrderId in request body.PatientordersV3Week of 1/5/2026Week of 1/19/2026
N/AHCSI-5081Updated the GET /v3/deliverytickets/shippingresponses to allow Delivery Ticket ID as a query parameter, require either Delivery Ticket Number or Delivery Ticket ID, and validate both when provided to ensure they reference the same ticket.DeliveryticketsV3Week of 1/5/2026Week of 1/19/2026
WSI-68347HCSI-5189Added a PUT /v3/prescriptions/sprx/discontinue endpoint to discontinue specialty pharmacy prescriptions, requiring prescription ID, stop date, and discontinuation reason. Supports reactivation and high-volume calls for bulk processing.PrescriptionsV3Week of 1/5/2026Week of 1/19/2026
WSI-662067HCSI-5192Resolved an issue where PUT /v3/entity/lastevent updated Last Event Name but did not refresh Last Event History and Workflow History details (LastEvent By, LastEvent Updated Date, Transition Date, Modified User, Modified Date). Validation ensures required entity and user context; updates now consistently use current UTC timestamp and calling user, and return accurate history.EntityV3Week of 1/5/2026Week of 1/19/2026
N/AHCSI-5196Resolved an issue where POST /v3/deliverytickets ignored fromDate and toDate per ticket item and overwrote with targetDeliveryDate. The endpoint now uses item-level dates when provided, falling back to targetDeliveryDate only if absent, ensuring correct service date ranges for billing and scheduling.DeliveryticketsV3Week of 1/5/2026Week of 1/19/2026

CareTend API Release Notes 12/12/2025 to 12/31/2025

Related Issue NumberJira NumberRelease NoteCollectionAPI VersionStaging AvailabilityProduction Availability
WSI-66291HCSI-4979Updated the POST /v4/deliverytickets/items endpoints to allow updates on non-working Delivery Tickets, resolving previous errors and enabling full support for programmatically created tickets in purchase order workflows.DeliveryticketsV412/31/202512/31/2025
N/AHCSI-5010Added a new PATCH /v4/inventory/items/prices/{inventoryItemPriceId} to update an existing inventory item price entry with validated inputs (price ID required, price, price type, effective start/end dates, modified by/date) and safeguards against overlapping effective date ranges. Supports partial updates and returns the updated price entry’s ID and effective dates.InventoryV412/31/202512/31/2025
N/AHCSI-5011Added a new GET /v4/inventory/items/price to retrieve an inventory item price entry. Requires priceType and accepts inventoryItemId, externalRefKey, or both (must reference the same item). Returns pricing details including IDs, price, price type, effective dates, created/modified by and dates, and record status fields.InventoryV412/31/202512/31/2025
N/AHCSI-5012Added a new GET /v4/inventory/prices/search to list price entries for an inventory item. Requires inventoryItemId, externalRefKey, or both (must reference the same item). Returns only non–end-dated prices (active, past, future) with item/price IDs, price, price type, effective dates, audit, and record status details.InventoryV412/31/202512/31/2025
N/AHCSI-5013Added a new DELETE /v4/inventory/items/prices/{inventoryItemPriceId} to remove an inventory item price entry. Validates the price ID and updates Rec Status, Rec Status Modified By, and Rec Status Date to mark deletion. Returns the updated price record to confirm status changes.InventoryV412/31/202512/31/2025
N/AHCSI-5014Added a new POST /v4/inventory/items/prices to create a new inventory item price entry. Requires price, price type, effective start/end dates, and accepts inventoryItemId, externalRefKey, or both (must reference the same item). Enforces non-overlapping date ranges for the same price type. Returns the newly created price record with IDs and audit fields.InventoryV412/31/202512/31/2025
WSI-69341HCSI-5054Resolved an issue where POST /v4/documents/newfax and related endpoints returned 200 but documents did not appear in CareTend Document Manager or SPRx Workflow – Incoming Documents. Endpoints now validate document type and filters to align with UI expectations, ensuring documents are correctly available in UI queues and views.DocumentsV412/31/202512/31/2025
WSI-69445HCSI-5068Updated the POST /v4/patients/search endpoint to include Created Date and Modified Date in responses. Requires valid patient MRN or patientOrderId in request body.PatientV412/31/202512/31/2025
WSI-69843HCSI-5082Resolved an issue where POST /v4/persons/search returned empty results for partyTypeDescription="Entity" and “invalid PartyTypeDescription” for "Billing Provider". Validation now maps supported descriptions to party types with at least one associated Person record; results correctly return for Entity, Billing Provider, and other supported types in Staging and Production.PersonV412/31/202512/31/2025
WSI-70162HCSI-5186Resolved an issue where POST /v4/inventory/items/quantity/add allowed costPerUnit=NULL, causing downstream POST /v3/inventory/locationsquantities/search to fail (“Nullable object must have a value”). The endpoint now defaults missing costPerUnit to 0, maintaining accurate quantities and preventing errors.InventoryV412/31/202512/31/2025

CareTend API Release Notes 12/01/2025 to 12/12/2025

Jira NumberRelease NoteAPI Version
HCSI-4959Updated the POST Create Patient endpoint to accept the AcuityOnAdmissionName property, validating against a lookup table and returning errors for invalid entries. Response includes patient’s acuity on admission when set.V4
HCSI-4964Fixed a bug where the PATCH Medication Profiles endpoint did not allow Start Date, Stop Date, and Discontinued Date fields to be cleared using DateTime.MinValue. Validation now accepts DateTime.MinValue to clear these fields, and response reflects blank dates.V4
HCSI-5042Fixed a bug where the PATCH Addresses endpoint failed when multiple AddressEntryIds referenced the same AddressId. Input validations now ensure address relationships are checked and soft-deleted before updates, preventing conflicts.V4
HCSI-5184Fixed a bug where the PUT Patients endpoint returned inconsistent Patient Status Id and Address Entry Id values compared to V3. Validation ensures valid MRN and consistent IDs across versions.V4

CareTend API Release Notes 11/17/2025 to 11/28/2025

Jira NumberRelease NoteAPI Version
HCSI-5072Updated the PATCH Billing Authorizations endpoint to allow clearing of Order Stop, Auth Start, Auth Stop, Qty. Limit, and Bill Price fields.V4
HCSI-5073Updated the PATCH Inventory endpoint to accept Inventory Item ID and ExternalRefKey as optional inputs, validate they reference the same item, require at least one identifier, and support updating ExternalRefKey for drug and supply items.V4
HCSI-5087Added a POST Assigns Inventory Location endpoint to allow assigning or unassigning inventory locations to an inventory item, supporting optional Inventory Item ID or ExternalRefKey (with validation if both provided) and requiring Inventory Location ID.V4
HCSI-5088Added a PATCH Activation Inventory endpoint to enable activating or inactivating an inventory item, supporting optional Inventory Item ID or ExternalRefKey (with validation if both provided), requiring one identifier, and ensuring zero inventory before inactivation.V4
HCSI-5089Updated the POST Inventory Search endpoint to include ExternalRefKey as an optional parameter and in the response, support filtering by Active items (default returns all), and include Active/Inactive indicator in the response.V4
HCSI-5090Updated the POST Inventory Items Search endpoint to include ExternalRefKey and Active/Inactive indicator in the response for improved item identification by location.V4

CareTend API Release Notes 11/03/2025 to 11/14/2025

Jira NumberRelease NoteAPI Version
HCSI-3861Added a DELETE endpoint to remove a recurring rental item from a recurring rental, including associated diagnoses and taxes, while ensuring primary items remain protected.V4
HCSI-5046Added a Delete Patient Assessment endpoint to delete a patient assessment, accepting precise identifiers to target a single assessment and marking it as deleted.V4
HCSI-5047Added a Unlock Patient Assessment endpoint to unlock a patient assessment using precise identifiers, enabling users to resume editing a single targeted assessment.V4
HCSI-5058Updated the PATCH employees endpoint to allow clearing an employee’s phone number when the information is incorrect and not yet available.V4
HCSI-5059Updated the PATCH employees endpoint to allow clearing an employee’s email address when the information is incorrect and not yet available.V4

CareTend API Release Notes 10/20/2025 to 10/31/2025

Jira NumberRelease NoteAPI Version
HCSI-3435Updated Delivery Tickets CareTend API Endpoint to allow clearing optional fields: promised date, driver, and footer statement when updating a delivery ticket.V4
HCSI-3629Updated Custom Assessments CareTend API Endpoint by adding ability to activate or inactivate assessment templates to prevent creation of outdated assessments.V4
HCSI-4946Updated Patient Demographics CareTend API Endpoint to support removal of selected checkbox options in the User Defined Activity/Caregiver field, resolving limitations in deselecting values programmatically.V4
HCSI-4975Updated Providers CareTend API Endpoint to include the Contact and User Defined tabs, aligning API capabilities with UI functionality across all provider sections.V4
HCSI-5018Updated Inventory CareTend API Endpoint to enable external inventory systems to pass item descriptions into CareTend, allowing inventory managers to identify and manage items consistently across platforms.V4
HCSI-5019Updated Inventory CareTend API Endpoint by adding: nullable, non-visible field to the inventory table for storing external Workday IDs, with support for passing this identifier through the create endpoint to improve cross-system item tracking.V4

CareTend API Release Notes 10/06/2025 to 10/17/2025

Jira NumberRelease NoteAPI Version
HCSI-4926Updated Persons CareTend API Endpoint to allow blank first name and last name values when updating a contact, ensuring consistency with UI behavior for company contacts instead of treating blanks as null.V4
HCSI-4962Fixed an issue in the Clinician Visit CareTend API Endpoint where Department, Employer, Employment Status, and Quantity fields did not update to blank when changed from valid values.V4
HCSI-4963Fixed an issue in the Update Documents CareTend API endpoint where updating the activeDate field caused the Date Active value to be removed in CareTend UI, ensuring the updated date displays correctly instead of reverting to “Select a date.”V3
HCSI-4976Added a new Suppliers CareTend API Endpoint to retrieve Supplier Account data, enabling accurate association of SupplierAccountId with SupplierId for purchase order creation.V4
HCSI-4977Fixed an issue with the Prescriptions API Endpoint where you received an error when trying to create a prescription for a Drug or HME order.V3
HCSI-4978Updated the Persons CareTend API endpoint by adding support for the ‘Associated Organization’ field group (Prescriber, Facility, Insurance Company, Supplier) in the Create Person endpoint, aligning API functionality with UI capabilities for contact management workflows.V3
HCSI-5005Added a new Inventory CareTend API endpoint to create Inventory Items, supporting fields such as Name, Inventory Number, Lot Tracking status, Price Code, Item Type, Therapy Type, Category, Manufacturer, Location, Quantity, Supplier, Purchasing Units, Dispensing Units, HCPC Code, Rev Code, Price, and NDC, enabling external systems to automate item creation without manual entry.V4
HCSI-5006Added a new Deducts Inventory Items CareTend API endpoint to reduce Inventory Item on-hand quantity by specifying InventoryItemId, InventoryLocationId, and new quantity, enabling external systems to maintain accurate stock levels for dispensing workflows.V4
HCSI-5015Updated the Providers CareTend API endpoint to support creating provider contacts and user-defined fields, aligning API functionality with UI capabilities for comprehensive provider data management.V3
HCSI-5021Updated the Patients CareTend API endpoint to allow creating and updating patients without requiring a date of birth, aligning API behavior with UI functionality.V3
HCSI-5023Updated the Patients Contacts CareTend API endpoint to allow specifying an Active status when creating a patient contact, eliminating the need for a subsequent update call and aligning API behavior with UI functionality.V3
HCSI-5025Fixed an issue with the Documents CareTend API endpoint to return the appropriate Workflow Id based on the specified workflowGroupName (e.g., HME, SPRx), ensuring accurate document retrieval.V3

CareTend 2025 R5 Release - 7/28/2025 to 10/03/2025

Jira NumberRelease NoteAPI Version
HCSI-4812Reviewed a potential internal API error in the Patient update endpoint caused by a missing discharge reason value due to a migration issue; endpoint is working as designed.V4
HCSI-4184Fixed a bug where the /persons/search endpoint was not returning data in Production.V3
HCSI-4634Fixed a bug where the POST /employeetask (Create a Task) was returning 502 (Bad Gateway).V3
HCSI-3419Fixed a bug where the Update Patient Catheter API failed to clear all catheter values except the clinician name, which was correctly updated to blank.V3