In Instinct EMR, the Partner API lets other software securely read from and write to your practice's data without anyone signing in and clicking around. Technology partners and Instinct EMR customers use it to connect tools such as lab systems, online booking, payments, and reporting dashboards.
How the Partner API works
The Partner API is an agreed way for two programs to talk, like a waiter between a diner and a kitchen. The other software (the diner) sends a request, the Partner API checks that the request is allowed, and Instinct EMR (the kitchen) returns exactly what was asked for.
Request: a question such as "list today's appointments."
Response: the answer, returned as plain text in a format called JSON.
Credentials: issued by Instinct, these decide which practice's data the software can reach. Each set of credentials covers one Instinct EMR database only. A database can hold one practice or several locations.
Token: a temporary pass the software receives in exchange for credentials. Tokens expire, and the software simply requests a new one.
Who uses the Partner API?
Technology partners: companies building a connection to Instinct EMR, such as a lab company, an online booking platform, or a payments provider.
Instinct EMR customers: practices taking their own data out, such as sending visits and invoices to a business intelligence tool, syncing patients to another system, or building an internal workflow.
Someone must build or set up the software that makes the requests, so a developer is typically needed. A practice without technical help is usually better served by a partner product that already uses the Partner API.
What the Partner API can access
The Partner API covers 12 areas of Instinct EMR. What other software can do depends on the area.
Look at, add, and change: patients and accounts, appointments and scheduling, visits, radiology, and chart documents (created from templates).
Look at and add: lab orders and results (including uploading PDF results and managing test codes) and invoices and payments (adding line items and reading payments).
Look at only: orders and treatments, prescriptions, alerts and reminders, and reference data such as species, breeds, services, and locations.
Add only: PDF generation. The software requests a PDF, then collects it when ready.
Note: Lab and radiology access is narrower than other areas. Each integration only sees its own orders and test codes. |
How software gets data and updates
Software gets data from Instinct EMR in two ways.
Requests: the software asks whenever it needs something, such as "anything new since yesterday?" This covers every area above. For all areas except lab and radiology order events, software checks for records created or updated since its last request.
Webhooks: the software gives Instinct EMR a web address, and Instinct EMR automatically sends a message when a lab order is submitted, or a radiology order is created, updated, or canceled.
Long lists arrive in pages. The Partner API sends up to 100 records at a time, along with a bookmark to the next batch. A practice with 750 records needs 8 requests to retrieve them all.
Frequently asked questions
Can the Partner API see other practices' data?
No. Credentials are tied to one Instinct EMR database. Separate databases need separate credentials.
Which web address does the software use?
The address depends on the AWS region where your practice's Instinct EMR is hosted. Separate addresses exist for US East, EU West, AP East, and AP Southeast. The Partner API documentation lists them, and Support can confirm the right one.
Is the Partner API secure?
Yes. Every request needs a valid token, tokens expire, and credentials are limited to specific locations.
Is the integration finished once access is granted?
No. The Partner API is the foundation. A developer still needs to build the booking tool, lab connection, or dashboard on top of it.
Request Partner API access
Partner API access is not a setting a practice can switch on. Instinct issues the credentials and delivers them via a secure third-party platform. To request access, see Request Partner API Access.
After the credentials arrive, the developer follows the full Partner API documentation, starting with the Authentication Guide.
Still need help?
Contact support via live chat or email [email protected].