Referring Provider

The Referring Provider feature allows the user to view the referring providers information (demographic and contact information). The Referring Provider Changed Subscription feature will allow the user to retrieve any changes made to the referring providers detail since the last time this request we run. The user will need to initiate subscription. For more information about subscriptions, please refer Changed Data Subscriptions

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

Endpoints

Get list of referring providers
GET
/v1/{practiceid}/referringproviders

Retrieves a list of referring providers

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
limit integer Number of entries to return (default 1500, max 5000)
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
address string The address (1st line) of the referring provider.
address2 string The address (2nd line) of the referring provider.
ansinamecode string This is the ANSI name and code for this referring provider's specialty.
ansispecialtycode string The ANSI speciality code for this referring provider.
city string The city of the referring provider.
email string The email of the referring provider.
entitytype string Either "Person" or "Non-Person" (e.g. X-Ray machines)
fax string The fax of the referring provider.
firstname string The first name of the referring provider.
lastname string The last name of the referring provider.
middleinitial string The middle initial of the referring provider.
name string The full name of the referring provider.
namesuffix string The name suffix of the referring provider.
note string The note associated with the referring provider.
npinumber integer The NPI number associated with the referring provider.
phone string The phone of the referring provider.
providertype string The provider type of the referring provider.
referringproviderid string The ID of the referring provider. Note: this is unrelated to /providers.
specialty string A friendly name for this provider's specialty.
state string The state of the referring provider.
zip string The zip of the referring provider.
Example Code
Add new referring provider
POST
/v1/{practiceid}/referringproviders

Creates a new referring provider record

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
Content-Type string Content type of the payload

❙ Request Body

Expand all
address string The address of the referring provider.
address2 string The address (line 2) of the referring provider.
city string The city of the referring provider.
email string The email of the referring provider.
entitytype string The entity type of the referring provider: PERSON or NONPERSON
fax string The fax of the referring provider.
firstname string The first name of the referring provider.
lastname string The last name/organization name of the referring provider.
middleinitial string The middle initial of the referring provider.
namesuffix string The name suffix of the referring provider.
note string The notes associated with the referring provider.
npinumber integer The NPI number associated with the referring provider. If this parameter exists in the body without a value, it will null out this field.
phone string The phone of the referring provider.
state string The state of the referring provider.
zip string The zip of the referring provider.

Output Parameters

Expand all
errormessage string Error message, if applicable.
referringproviderid integer The referring provider ID. This is not the same ID from the /providers API
success string Whether the operation was successful.
Example Code
Get information of given referring provider
GET
/v1/{practiceid}/referringproviders/{referringproviderid}

Retrieves information for a specific referring provider

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
referringproviderid integer referringproviderid

Output Parameters

Expand all
address string The address (1st line) of the referring provider.
address2 string The address (2nd line) of the referring provider.
ansinamecode string This is the ANSI name and code for this referring provider's specialty.
ansispecialtycode string The ANSI speciality code for this referring provider.
city string The city of the referring provider.
email string The email of the referring provider.
entitytype string Either "Person" or "Non-Person" (e.g. X-Ray machines)
fax string The fax of the referring provider.
firstname string The first name of the referring provider.
lastname string The last name of the referring provider.
middleinitial string The middle initial of the referring provider.
name string The full name of the referring provider.
namesuffix string The name suffix of the referring provider.
note string The note associated with the referring provider.
npinumber integer The NPI number associated with the referring provider.
phone string The phone of the referring provider.
providertype string The provider type of the referring provider.
referringproviderid string The ID of the referring provider. Note: this is unrelated to /providers.
specialty string A friendly name for this provider's specialty.
state string The state of the referring provider.
zip string The zip of the referring provider.
Example Code
Update information of given referring provider
PUT
/v1/{practiceid}/referringproviders/{referringproviderid}

Modifies the information for a specific referring provider

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
referringproviderid integer referringproviderid
Content-Type string Content type of the payload

❙ Request Body

Expand all
address string The address of the referring provider.
address2 string The address (line 2) of the referring provider.
city string The city of the referring provider.
email string The email of the referring provider.
fax string The fax of the referring provider.
firstname string The first name of the referring provider.
lastname string The last name of the referring provider.
middleinitial string The middle initial of the referring provider.
namesuffix string The name suffix of the referring provider.
note string The notes associated with the referring provider.
npinumber integer The NPI number associated with the referring provider. If this parameter exists in the body without a value, it will null out this field.
phone string The phone of the referring provider.
state string The state of the referring provider.
zip string The zip of the referring provider.

Output Parameters

Expand all
success string Whether the operation was successful.
Example Code
Get list of change events for referring-providers
GET
/v1/{practiceid}/referringproviders/changed/subscription/events

Retrieves a list of all events that can be input for this subscription

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid

Output Parameters

Expand all
status string Will return one of following statuses: ACTIVE, INACTIVE, or PARTIAL. The PARTIAL status means that not all events are subscribed to. In the event of a problem, UNKNOWN may be returned.
subscriptions array List of events you are subscribed to.
Example Code
Subscribe to all/specific change events for referring-providers
POST
/v1/{practiceid}/referringproviders/changed/subscription

Subscribes for changed referring providers results events

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
Content-Type string Content type of the payload

❙ Request Body

Expand all
departmentids array For every New/Update Subscriptions complete list of departmentids should be passed. NOTE: Without DepartmentIDs entire Context/Practice will be subscribed.
eventname string By default, you are subscribed to all possible events. If you only wish to subscribe to an individual event, pass the event name with this argument.

Output Parameters

Expand all
success string Returns if the call to manipulate subscriptions for referringprovider was successful.
Example Code
Get list of subscribed events for changes in referring-providers
GET
/v1/{practiceid}/referringproviders/changed/subscription

Retrieves list of events applicable for the changed referring providers

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid

Output Parameters

Expand all
status string Will return one of following statuses: ACTIVE, INACTIVE, or PARTIAL. The PARTIAL status means that not all events are subscribed to. In the event of a problem, UNKNOWN may be returned.
subscriptions array List of events you are subscribed to.
Example Code
Get list of changes in referring-providers
GET
/v1/{practiceid}/referringproviders/changed

Retrieves a list of referring providers whose details has been modified

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
leaveunprocessed string For testing purposes, do not mark records as processed
showprocessedenddatetime string See showprocessedstartdatetime
showprocessedstartdatetime string Show already processed changes. This will show changes that you previously retrieved at some point after this datetime mm/dd/yyyy hh24:mi:ss (Eastern). Can be used to refetch data if there was an error, such as a timeout, and records are marked as already retrieved. This is intended to be used with showprocessedenddatetime and for a short period of time only. Also note that all messages will eventually be deleted.
limit integer Number of entries to return (default 1500, max 10000)Please note that this endpoint has a different max than normal.
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
address string The address (1st line) of the referring provider.
address2 string The address (2nd line) of the referring provider.
ansinamecode string This is the ANSI name and code for this referring provider's specialty.
ansispecialtycode string The ANSI speciality code for this referring provider.
city string The city of the referring provider.
email string The email of the referring provider.
entitytype string Either "Person" or "Non-Person" (e.g. X-Ray machines)
fax string The fax of the referring provider.
firstname string The first name of the referring provider.
lastname string The last name of the referring provider.
middleinitial string The middle initial of the referring provider.
name string The full name of the referring provider.
namesuffix string The name suffix of the referring provider.
note string The note associated with the referring provider.
npinumber integer The NPI number associated with the referring provider.
phone string The phone of the referring provider.
providertype string The provider type of the referring provider.
referringproviderid string The ID of the referring provider. Note: this is unrelated to /providers.
specialty string A friendly name for this provider's specialty.
state string The state of the referring provider.
zip string The zip of the referring provider.
Example Code
Unsubscribe to all/specific events for changes in referring-providers
DELETE
/v1/{practiceid}/referringproviders/changed/subscription

Deletes a specific event which is no longer required

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
eventname string By default, you are unsubscribed from all possible events. If you only wish to unsubscribe from an individual event, pass the event name with this argument.

Output Parameters

Expand all
success string Returns if the call to manipulate subscriptions for referringprovider was successful.
Example Code