Kipu API FAQ

Frequently asked questions about Kipu's API connections and related documentation.

What is the Kipu API?

The Kipu API acts as a bridge, allowing the Kipu EMR to communicate with other software systems. It enables data retrieval (GET) and modification (POST, PATCH), particularly for patient information.

Every day, nearly one million messages are exchanged between Kipu and other systems using Kipu APIs. These application programming interfaces (APIs) allow third-party developers to access Kipu data.

Kipu offers a comprehensive range of APIs, with 41 currently available and more being added regularly. These integration options enhance the platform's capabilities to meet diverse business needs.

What can we do with the API?

The API supports three types of interactions: GET, POST, and PATCH. Available data points include UR, Insurance, Settings, Users, Appointments, Consents, Patients, Census, and Occupancy. Currently, only the Patient data can be modified using POST and PATCH. Please refer to the API Documentation for a complete list of endpoints and data models.

What is the difference between API & integrations?

The Kipu API can be used to build integrations with third-party applications. A native integration, offered through the Kipu Marketplace, typically requires no user coding and includes access to Kipu's support.

For API-based integrations, a developer is needed to code and build the integration. Kipu supports only the API itself; the user’s developer must maintain and support the integration and the other software involved.

Will Kipu set up the API for me?

No, Kipu does not offer professional API implementation services.

Can anyone set up an API?

Setting up an API requires specialized knowledge, usually handled by a web developer. We recommend working with someone experienced in API connections to ensure proper setup.

Where can I see the API documentation?

You can review our API documentation here.

How do we get API Keys?

To use the API, users need API Keys. Request API Keys by filling out the request form. If a third-party developer is involved, an API agreement may be required and is typically sent for signatures within 3–5 business days.

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

Yes, but you will need a developer to build the integration. Kipu supports only the API itself; the developer is responsible for the integration and its ongoing maintenance. The feasibility depends on the other software, which your developer can assess.

Is there a Development Sandbox?

There is no public sandbox. Customers can request a personalized sandbox through Client Support.

Do we need a Developer to use the API?

Yes, a developer is needed to code, build, and support the integration.

How can we get API Support?

Client Support is available for assistance at [e-mail]. Reviewing the documentation and troubleshooting guide is recommended for the quickest resolution.