2024.SP2.GA API Release Notes - Released with 2024 R2.

  1. V3 Get Patient Diagnosis does not return its results in Sequence order. (HCSI-3148)
    a. After the initial development of the Get Patient Diagnosis V3 endpoint it was noted that the diagnoses were not being returned in sequence order. All diagnoses were being returned along with their corresponding data including sequence, they just weren’t sorted. The change here has fixed that, and the diagnoses are now being returned in sequence order.
  2. CareTend API V3 - Need to Add Additional Parameters to the Create Patient Endpoint (HCSI-3069)
    a. To increase the parody with the V2 version of this endpoint we have added data points back into the response of the V3 version of the endpoint. Those data points 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 and Release Medical Information.
    b. In addition to the additional data points, we have created a few new endpoints to handle working with patient statistics. We have added endpoints for creating, updating, and removing patient statistics. The remove is a soft delete.
    c. In addition to the additional data points, we have created a few new endpoints to handle working with patient licenses. We have added endpoints for creating, updating, and removing patient licenses. The remove is a soft delete.
  3. CareTend API V3: Need a New Endpoint for Removing a Patient Ancillary Provider - (HCSI-2999)
    a. Added a new endpoint that allows the user to remove an Ancillary provider from a patient. The endpoint accepts the patient medical record number and the ancillary provider id and inputs.
  4. CareTend API V3 - Need a New Endpoint for Getting Prescription Fills (HCSI-3077)
    a. Added a new endpoint that allows the user to get prescription fill(s) from CareTend. The endpoint will accept as input either a patient medical record number or a prescription number. It will not accept both with in the same call.
  5. CareTend API - Need a New Endpoint for Updating Items on an IV Order
    a. Added a new endpoint that will all the user to update the items that are part of an IV order in CareTend. This endpoint will the user to either edit the existing item on the order or they can add either a new drug item or a new non-inventory billable item to the order, but not supplies or equipment.

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

  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:":""}

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

  1. CareTend API V3 - Need to Migrate the Get Company by Id Endpoint to V3 Standards (HCSI-3034)
    a. Migrated the existing V2 Get Company by Id 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.
  2. Update patient V3 : bugs (HCSI-3059)
    a. Modified the API to issue an understandable error when passing in an SSN that is longer than 9 digits. Also made changes to disallow multiple primary phone numbers and email addresses to be passed in via the API.
    b. Also made some changes to the Create Patient Diagnosis endpoint so that it issues proper and understandable error messages around missing ICD9 and ICD10 codes. IsAllowed has been removed from the response of the endpoint as it is always TRUE and there is no way to modify it.
  3. CareTend API V3: Need a New Endpoint for Updating Patient Diagnosis (HCSI-2707)
    a. Added an endpoint that allows for the updating of a patient diagnosis.
  4. CareTend API V3: Add Update Person V3 Command (HCSI-2994)
    a. Migrated the existing V2 Update Person 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.
  5. CareTend API V3: Need a New Endpoint for Removing Patient Diagnosis (HCSI-2996)
    a. Added an endpoint that allows for the removing of a patient diagnosis.
  6. CareTend API V3: Need a New Endpoint for Removing the Relationship Between a Patient and Provider (HCSI-2997)
    a. Added an endpoint that allows for the removal of a provider from a patient. This will not remove the provider from the system but instead removes the relationship between a patient and provider.
  7. CareTend API V3: Need a New Endpoint for Creating a Patient Ancillary Provider (HCSI-2998)
    a. Added a new endpoint that allows for the creation of a patient ancillary provider.
  8. 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.
  9. CareTend API V3 - Need to Migrate the Update the Given Delivery Ticket Endpoint to V3 Standards (HCSI-3029)
    a. Migrated the existing V2 Update the Given Delivery Ticket 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.
  10. CareTend API V3 - Need to Migrate the Get Inventory Item by Id Endpoint to V3 Standards (HCSI-3031)
    a. Migrated the existing V2 Get Inventory by Id 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.
  11. CareTend API V3 - Need to Migrate the Get Patient Note by Id Endpoint to V3 Standards- Validate response. (HCSI-3032)
    a. Migrated the existing V2 Get Patient Note by Id 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.
  12. CareTend API V3 - Need to Migrate the Get Patient Note Template by Id Endpoint to V3 Standards (HCSI-3033)
    a. Migrated the existing V2 Get Patient Note Template by Id 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.
  13. CareTend API V3 - Need to Add Additional Parameters to the Create Patient Endpoint (HCSI-3069)
    a. Modified the existing V3 Create Patient Endpoint by adding back into the response some data elements that were not carried forward from the V2 endpoint.
  14. CareTend API V3 - Need to Add Additional Parameters to the Search Patients Endpoint (HCSI-3070)
    a. Modified the existing V3 Search Patient Endpoint by adding back into the search parameters and the response various data elements that were not carried forward from the V2 endpoint.

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

  1. CareTend API V3: Need a New Endpoint for Getting Claim Items (HCSI-2730)
    a. Created a new V3 endpoint that will allow the user to get Claim Item information. This new endpoint requires the user to provide a Claim Number and will return the set of items associated to the supplied Claim Number.
  2. CareTend API V3: Need a New Endpoint for Getting NCPDP Data (HCSI-2736)
    a. Created a new V3 endpoint that will allow the user to get NCPDP claim related information. This new endpoint requires the user to provide a Claim Number and will return various NCPDP related fields for the supplied Claim Number.
  3. V3 API Persons Search /person/search: Searching by partyTypeDescription is not behaving as expected. (HCSI-2819)
    a. The person search endpoint was not functioning as expected when searching by Party Type Description. This has been fixed and the correct result sets are being returned when doing a person searching by Party Type Description.
  4. CareTend API V3: Need a New Endpoint for Getting Deleted Invoice Fields (HCSI-2984)
    a. Instead of creating a new endpoint to return some additional invoice data we have modified the get invoice data endpoint with an additional input parameter allowing the user to include delete invoices. We have also added three new fields to the response for the deleted reason, deleted by and deleted date.
  5. CareTend API V3: Add Get Person by Id V3 Command (HCSI-2992)
    a. Migrated the existing V2 Get Person 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.
  6. CareTend API V3: Add Create Person V3 Command (HCSI-2993)
    a. Migrated the existing V2 Create Person 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.
  7. CareTend API V3: Add Delete Person by Id V3 Command (HCSI-2995)
    a. Migrated the existing V2 Delete Person 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.
  8. CareTend API V3 - Need to Migrate Create Patient Diagnosis for MRN endpoint to V3 Standards (HCSI-3002)
    a. Migrated the existing V2 Create Patient Diagnosis 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.
  9. CareTend API V3 - Need to Migrate Discontinue Order by ID Endpoint to V3 Standards ( HCSI-3003)
    a. Migrated the existing V2 Discontinue Order 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.
  10. CareTend API V3 - Need to Migrate Create Patient Note for MRN Endpoint to V3 Standards (HCSI-3005)
    a. Migrated the existing V2 Create Patient Note 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.
  11. CareTend API V3: Get Patient Catheters by MRN V3 Command (HCSI-3006)
    a. Migrated the existing V2 Get Patient Catheters 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.
  12. CareTend API V3: Get Patient Assessment V3 Command (HCSI-3009)
    a. Migrated the existing V2 Get Patient Assessments 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.
  13. CareTend API V3: Create Patient Assessment V3 Command (HCSI-3010)
    a. Migrated the existing V2 Create Patient Assessment 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.
  14. Factor Order V3: On passing referralSourceId as 0, it errors out. (HCSI-3011)
    a. Cleaned up the error that is retuned, when passing an invalid referral source into the API so that it is understood why the API failed.
  15. Create patient V3 : bugs (HCSI-3013)
    a. Modified the API to issue an understandable error when passing in an SSN that is longer than 9 digits. Also made changes to disallow multiple primary phone numbers and email addresses to be passed in via the API.
  16. CareTend API V3 - Need to Migrate the Get Facilities Endpoint to V3 Standards (HCSI-3019)
    a. Migrated the existing V2 Get Facilities 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.
  17. CareTend API V3 - Need to Migrate the Search the Diagnosis Code Ids for Given Diagnosis Codes Endpoint to V3 Standards (HCSI-3023)
    a. Migrated the existing V2 Search Diagnosis Code Ids for Given Diagnosis Codes 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.
  18. CareTend API V3 - Need to Migrate the Search the Procedure Code Ids for Given Procedure Codes Endpoint to V3 Standards (HCSI-3024)
    a. Migrated the existing V2 Search Procedure Code Ids for Given Procedure Codes 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.
  19. CareTend API V3 - Need to Migrate the Get Employee by Username Endpoint to V3 Standards (HCSI-3026)
    a. Migrated the existing V2 Get Employee by Username 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.
  20. CareTend API V3 - Need to Migrate the Get Carrier by Given Id Endpoint to V3 Standards (HCSI-3027)
    a. Migrated the existing V2 Get Carrier by Given Id 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.
  21. CareTend API V3 - Need to Migrate the Get Employee by Id Endpoint to V3 Standards (HCSI-3038)
    a. Migrated the existing V2 Get Employee by Id 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.

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

  1. CareTend API V3- Create/update clinician visit is not creating LinkedScheduled task entry (HCSI-2968)
    a. After initial development of the create clinician visit endpoint it was noticed the corresponding linked task was not being created. We have modified the API so that is now creates the linked task.
  2. Consistent Error Response for V3 (HCSI-2907)
    a. Created a common/consistent error response format so that any error returned by an API will look and feel consistent. This consistent formatting will appear within the V3 APIs. This also removes the Errors as it was a duplicate of Message.
improved

CareTend API 2024 R1 Release

We have improved the CareTend API documentation and have modified our API paths to follow industry standards and to improve readability. These changes will impact existing integrations that have used the APIs listed in the table. Click the page heading to see the table.