Search for a Referring Provider
GET /v1/referring-providers
Always search before creating, to avoid duplicates.
Filter | Notes |
| 10-digit NPI. The most reliable way to match. |
| Provider's name |
| Part of the address |
| Paging |
GET /v1/referring-providers?npi=1144338880
{
"Count": 1,
"Items": [
{
"Id": "RP01d8eb00863baa596d54c7ab32b5a2d8",
"General": {
"Npi": "1144338880",
"Name": { "FirstName": "Steve", "LastName": "Johnson" },
"Practice": "Example Family Physicians"
},
"PrimaryLocation": {
"Id": "RL01d8eb00863b3ff9aef47dd9f5309dfa",
"Address": { "AddressLine": "123 Main St", "City": "Birmingham", "State": "AL", "Zip": "35203" },
"Contacts": { "Phone": "2055551234", "Fax": "2055555678" }
}
}
]
}
ID | Format | Used as |
Provider |
|
|
|
|
|
Get One Provider
GET /v1/referring-providers/{id}
Also returns any additional Locations, Note, and PecosEnrollment (whether the provider is PECOS-enrolled).
Create a Referring Provider
POST /v1/referring-providers
Fields
Field | Required | Notes |
| ✅ | Exactly 10 digits |
| ✅ |
|
|
| e.g. |
|
| Practice name |
| ✅ | Requires |
| ✅ |
|
|
| Location name |
|
| Additional locations, same shape as |
|
| Payer-specific provider type (see below) |
|
| Free text |
SalesAgentId and ContactPerson at the top level are deprecated. Set SalesAgentId, ContactPerson, and SalesAgentNote on each location instead.
Payer Options
Use PayerOptions when a provider should be submitted as a different provider type for a specific payer or plan.
Field | Required | Notes |
| ✅ |
|
|
| From |
|
| From |
Example
POST /v1/referring-providers
{
"General": {
"Npi": "1144338880",
"Name": { "FirstName": "Steve", "LastName": "Johnson" },
"Title": "MD",
"Practice": "Example Family Physicians"
},
"PrimaryLocation": {
"Name": "Main Office",
"Address": {
"AddressLine": "123 Main St",
"City": "Birmingham",
"State": "AL",
"Zip": "35203"
},
"Contacts": {
"Phone": "2055551234",
"Fax": "2055555678"
}
}
}
Response: 201 Created
{ "Id": "RP01d8eb00863baa596d54c7ab32b5a2d8" }
💡 The response returns the provider's ID only. Call GET /v1/referring-providers/{id} to get the new PrimaryLocation.Id, which you'll need for orders and prescriptions.
Update a Referring Provider
PUT /v1/referring-providers/{id}
Send the full provider, using the same fields as creating one. To update an existing additional location, include its Id in Locations.
Response: 200 OK
Delete a Referring Provider
DELETE /v1/referring-providers/{id}
Response: 200 OK
Get Notified of Changes
Subscribe to referring-provider.created, referring-provider.updated, and referring-provider.deleted.
See Webhooks API.
Common Errors
Code | Meaning |
| Invalid request, e.g. an NPI that isn't 10 digits, or a missing address or contacts |
| Token missing, expired, or invalid |
| You don't have permission to access this resource |
| Provider not found |
| Too many requests |
