Skip to main content

Reference Data Lookups

A single index of the lookup endpoints you'll use to find IDs and codes for other API requests.

💡 Cache reference data. Most of these lists rarely change. Load them once (or on a schedule) and reuse them, instead of looking them up on every request. Remember that IDs differ between sandbox and production.

Standard codes

These lists are the same for every NikoHealth customer.

Data

Endpoint

Filters

Example

HCPCS / CPT codes

GET /v1/hcpcs

code, name

{ "Code": "E0601", "Name": "Cont airway pressure device" }

Modifiers

GET /v1/modifiers

id, name

{ "Id": "RR", "Description": "Rental(dme)" }

Places of service

GET /v1/place-of-service

id, text

{ "Id": "12", "Name": "Home" }

Countries

GET /v1/countries

code, name

{ "Id": "US", "Name": "United States" }

Hospitals

GET /v1/hospitals

name

Name, address, and phone

Medications

GET /v1/medications

name, description

Name, ingredient, form, and dosage

Payer adjustment groups

GET /v1/payer-adjustments/groups

CO, PR, OA, PI

Payer adjustment reasons

GET /v1/payer-adjustments/reasons

id, name, description

{ "Id": "1", "Name": "Deductible Amount" }

Payer remark codes

GET /v1/payer-remark-codes

id, name, description

Provider-level adjustments

GET /v1/provider-level-adjustments

id, name, description

Payment methods

GET /v1/payment-methods

Check, Eft, CreditCard, Cash, Other

Payment levels

GET /v1/payment-levels

Primary, Secondary, Tertiary, Other

Eligibility service types

GET /v1/insurance/eligibility/service-types

name

{ "Id": "DurableMedicalEquipment", "Code": "DM" }

Most of these lists are large (for example, thousands of hospitals and over 100,000 medications). Always filter and page through them.


Your Organization's Setup

These records are specific to your environment.

Organization

Data

Endpoint

Key filters

Your organization

GET /v1/organization

Service locations

GET /v1/organization/locations

name, npi

Billing providers

GET /v1/billing-providers

name, npi, taxId

Rendering providers

GET /v1/rendering-providers

name, npi, type

Users

GET /v1/users

Teams

GET /v1/teams

Team members

GET /v1/team-members

Payers and Pricing

Data

Endpoint

Key filters

Payers

GET /v1/payers/dictionary

name, claimCode

Payer plans

GET /v1/payers/{payerId}/plans/dictionary

Price options

GET /v1/price-options

hcpcsCode, payerId, productId, type, serviceLocationId

Pricing groups

GET /v1/pricing-groups

name

Product tax codes

GET /v1/product-tax-codes

code, name

Clinical

Data

Endpoint

Key filters

Referring providers

GET /v1/referring-providers

npi, fullName

Inventory and Products

Data

Endpoint

Key filters

Products

GET /v1/products

Vendors

GET /v1/vendors

Inventory locations (warehouses)

GET /v1/inventory-locations

name, default

Units of measure

GET /v1/uoms, /v1/uoms/purchase, /v1/uoms/billing

Product categories / groups / manufacturers

GET /v2/inventory/categories, /v2/inventory/groups, /v2/inventory/manufacturers

Drop-ship accounts

GET /v1/orders/dropship/accounts

Tags, Types, and Categories

Data

Endpoint

Patient tags

GET /v1/patient-tags

Order tags

GET /v1/order-tags

Invoice tags

GET /v1/invoice-tags

Document tags

GET /v1/document-tags

Document types

GET /v1/document-types

Note subjects

GET /v1/note-subjects/dictionary

Task categories

GET /v1/tasks/categories

Purchase order statuses

GET /v1/purchase-orders/statuses

Custom fields

GET /v1/custom-fields

Webhook event types

GET /v1/webhook-event-types


ID Formats at a Glance

Knowing the format helps you spot when the wrong kind of ID is being sent.

Record

Format

Example

Patient

Numeric

10000105

Order

SO + 32 characters (sales); RO + 32 (resupply)

SO05adce00ef4b092b90f42f97b2ec3e36

Order item

UN + 32 characters

UN05adce00ef4b39680ac425a3882b0190

Patient insurance

PI + 32 characters

PIf5b1af006f4bdafa8b540aca26806e0d

Invoice

IN + 32 characters

IN9fa1d300ff4b39ab984449c5267b72f1

Invoice insurance

II + 32 characters

II46bd2b00c5eaaaebaf04f17dee14f7e5

Payment

PT + 32 characters

PTed2f0f00ef4b8ce90c1455b45d70b159

Prescription

PP + 32 characters

PP94adce00ef4bd958ee946025a6fe86a7

Referring provider

RP + 32 characters

RP01d8eb00863baa596d54c7ab32b5a2d8

Referring provider location

RL + 32 characters

RL01d8eb00863b3ff9aef47dd9f5309dfa

Service location

OL + 32 characters

OL3b309d00aceae09bd4544bef2658410e

Billing provider

BP + 32 characters

BP28538d00acea414bbc940e0fda497f92

Product

20 characters

A05MW34SX96ZF71QT28K

Payer / payer plan

40 characters

3c8e1f5a9b2d47e6a0c4f81b7d395e2a6f0b4c19

Patient document

Numeric

838

Document Management file

DM + 32 characters

DMb7b12c001f4b865938f425f778273ea8

Custom field

CF + 32 characters

CFcfa0fb00d62b7c28e564d4d963ca08ed

Task

TK + 32 characters

TKc5ec2c002dea588b9e841be48513a191

Vendor

VR + 32 characters

VR1b89c710acea37aa39249fcab4007a3f

Diagnosis

ICD-10 code with dot

G47.33

⚠️ Some prefixes are shared. Rental programs also start with RP (like referring providers), and inventory locations and DropDown list items both start with LI.

Always check which kind of record an ID belongs to.


Related articles

Did this answer your question?