Kipu Marketplace  API Documents   HL7 Specs   Integrations   Certified Partners

Every day, nearly one million messages are sent between Kipu and non-Kipu systems using Kipu APIs. Application programming interfaces (APIs) allows third-party developers to work with Kipu to access data.

Kipu's Instances have an extensive list of APIs, with 41 APIs currently available—and more being added regularly. There are a number of integration options that can help extend the platform's capabilities to meet a wide range of business needs.

If you are a Kipu Client or a developer working with a Kipu Client you will need a set of keys to access the API. Please complete this form with all the information and an API Access Agreement will be sent via email. Once both parties have signed the agreement, the keys will be delivered to the developer. Please allow up to two business days for the agreement.  

Please keep in mind, if you are a developer and not currently working with a Kipu client, you'll need to submit a partner request instead.

What can we do with API?

The API allows for three type of interactions: GET, POST, and PATCH. There are a number of data points available in the API including, but not limited to UR, Insurance, Settings, Users, Appointments, Consents, Patients, Census and Occupancy. Currently, the only POST & PATCH available are Patients. For a complete list of Endpoints and data models please reference the API Documentation. 

What is the difference between API & integrations?

The Kipu API can be used to build an integration with third-party applications. The difference between the API and a native integration is who builds and supports the integrations. If it is a native integration offered through the Kipu Marketplace, typically no coding is required on the part of the user. Also, users have access to Kipu's first-class support with a native integration.

In order to use the API the user will need a developer to code/build the integration. Also with an API integration, Kipu can only support the actual API. As for the software you are integrating with or communication between the system the users developer would be responsible to maintain and support. 

Can we request an API enhancement?

Yes, simply review the Integrations Portal and select Submit an Idea. Once you've submitted the idea, you can return to the portal to see if your enhancement is under consideration, or it's progress if it is added to our roadmap. 

How do we get API Keys?

User will need API Keys to utilize the API. To request API Keys simply fill out the request form. If a third party developer will be using the API, an API agreement may be necessary and is typically sent out for signatures within 3-5 business days. 

We want to connect to another software, can we use the API to connect the systems?

In order to use the API the user will need a developer to code/build the integration. Kipu can only support the actual API. As for the software you are integrating with or communication between the system the users developer would be responsible to maintain and support. It will also depend on the software you are trying to connect to, but your developer can answer those questions. 

Is there a Development Sandbox?

There is no Public Sandbox. If a customer would like a personalized sandbox they can request it through Client Support. 

Do we need a Developer to use the API?

In order to use the API the user will need a developer to code/build the integration. Your developer will also be responsible for supporting whatever API Integration they build. 

How can we get API Support?

Client Support is available for assistance, but would recommend reviewing the documentation and troubleshooting guide for fastest resolutions. 

New Error Handling Responses:

Added new error message to help developers identify issues they run into. 

Added new GET endpoints:

Patient Allergies, Patient Diets, Allergies, Diets

Added the following parameters to the Patient POST:

patient_diets_attributes, allergies_attributes, food_restrictions

Added the patient_tags attribute to the GET endpoints:
Latest Updated Patients, Patient Admissions, Patient Census, and Patient Find

Added the patient_tag_ids parameter to endpoints:
Patient POST and Patient Patch.

Added new GET endpoints:

Patient Tags, Insurances Latest, Utilization Reviews Latest

Added attributes to the Patient Occupancy endpoint:

bed_id, building_id, room_id

Added new attributes to the following GET Endpoints:

 Latest Updated Patients, Patient Admissions, Patient Census, and Patient endpoints

Added parameters to the Patient POST & PATCH:

pronouns, preferred_language, alternate_addresses_attributes

Added parameters to Patients Care Teams endpoint:

page (specify page number of current result list)

per (number of results to return per page)

Copyright © 2022. All rights reserved.