API versions
The version is part of every endpoint path:
https://{yourDomain}.nikohealth.com/api/external/v1/patients
https://{yourDomain}.nikohealth.com/api/external/v2/payments
https://{yourDomain}.nikohealth.com/api/external/v3/orders/{id}/cost-sharing
Version | What's in it |
V1 | The core API: patients, insurances, orders, documents, notes, eligibility, invoices, inventory, tasks, webhooks, and reference data (165 endpoints) |
V2 | Newer versions of specific areas: payments and payment invoices, invoice search, patient rentals, order cost sharing, and inventory product categories, groups, and manufacturers |
V3 | Order cost sharing (get and save) |
Key points
Versions are not separate APIs. Use all three together with the same token. Most integrations use V1 for nearly everything, plus V2 or V3 for the specific areas above.
A newer version of an endpoint doesn't automatically remove the older one. When an older endpoint is being replaced, it's marked deprecated.
In Swagger, switch versions with the Select a definition dropdown at the top right (V1 Api, V2 Api, V3 Api).
What "Deprecated" Means
A deprecated endpoint or field still works today but will be removed in the future.
New integrations should not use deprecated endpoints or fields.
Existing integrations should plan to move to the replacement.
In Swagger, deprecated endpoints appear greyed out with a strikethrough, and deprecated fields are marked in the schema.
Deprecated Endpoints
Deprecated | Use instead |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| Send custom fields with |
| Send custom fields with |
| Send custom fields with |
| Send custom fields with |
| Send custom fields with |
|
|
|
|
|
|
|
|
|
|
|
|
| No direct replacement |
Deprecated Request Fields
These fields still appear in request models but should no longer be used.
Endpoint | Deprecated field | Use instead |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
⚠️ Two deprecated fields are still required.Description on patient notes and TypeId on document updates are marked deprecated but are still required by the request model. Until that changes, send them with the same value as their replacement (Text and DocumentTypeId).
Also Deprecated (see Swagger for current guidance)
Invoices:
PriorAuthNumberon invoice options and service lines;CreatedOn/ModifiedOnon the invoice list filter; drugCode/Ndcon service linesProducts:
BundleOptions,SerializedOptions,NonSerializedOptions,DropShipInfo,PreferedDeliveryMethod,PurchaseVendorIdReferring providers:
ContactPerson,SalesAgentIdVendors:
DropShipIntegrationType
Staying Current
Check Swagger before you build. If an endpoint or field is struck through, use its replacement.
Review your integration periodically. New deprecations are added as the API evolves.
Handle new response fields gracefully. We add fields to responses over time; your code shouldn't break when that happens.
Related articles
