Provider
The Provider feature allows the user to view, modify or delete provider details in a specific practice. The Provider Changed Subscription feature will allow the user to retrieve providers that have recently been changed, updated or deleted. The user will need to initiate subscriptions. 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
- Primary
- Subscription
Update information of given provider
PUT
/v1/{practiceid}/providers/{providerid}
BETA: Modifies information of the specific provider
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
providerid
integer
providerid
Content-Type
string
Content type of the payload
❙ Request Body
Expand allOutput Parameters
Expand all
alertmessage
string
Alert message if the operation did not work.
errorreason
string
Error message if the operation did not work.
providerid
integer
The ID to be used for this provider. Note that in athenaNet, an individual provider (as defined by a unique NPI) may have multiple provider IDs. For the API, we have collapsed these to a single canonical ID. For updates and deletes, this will be either 1 or -1 depending on success or failure.
Example Code
Get information of given provider
GET
/v1/{practiceid}/providers/{providerid}
Retrieves information of the specific provider
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
providerid
integer
providerid
showusualdepartmentguessthreshold
number
There are situations where determining where a provider "normally" practices is desired. Unfortuantely, there is no such concept in athenaNet since providers often practice in multiple locations. However, we can use some intelligence to determine this by looking back over the previous few months (90 days) to see actual practice. To enable this, set this value between 0 and 1; it is highly recommended to be at least .5. This is the ratio of appointments in a given department to the total number of appointments for that provider. A value of .5 means "the provider's appointments are 50% in the department guessed." Setting this to 1 would only return a department if ALL of the provider's appointments were in one department.
showallproviderids
boolean
In athenaNet's internal data structures, a single provider can be represented by multiple IDs. These IDs are used in certain external messages (e.g. HL7) and thus these IDs may need to be known by the API user as well. When set to true, a list of all of these ancillary IDs will be provided.
showfederalidnumber
number
Include the provider's federal ID number in results.
Output Parameters
Expand all
acceptingnewpatientsyn
string
Indicates whether the provider is accepting new patients. This field is currently only for informational purposes, and does not drive any athenaNet functionality.
ansinamecode
string
This is the ANSI name with ANSI code for this provider's specialty.
ansispecialtycode
string
This is the ANSI code for this provider's specialty.
billable
string
Indicates if this is a billable provider.
createencounteroncheckinyn
string
If true, appointments scheduled with this provider will create an encounter when the appointment is checked in for encounter supported appointment types. Only applies to the primary providerid. If the provider has other IDs with the same API, please use 'showallproviderids' to see which IDs create encounters.
createencounterprovideridlist
string
A list of provider IDs for this provider NPI that will create an encounter when the appointment is checked in for encounter supported appointment types. Only populated if 'showallproviderids' is set.
displayname
string
The preferred name to use when displaying this provider.
entitytype
string
Either "Person" or "Non-Person" (e.g. X-Ray machines)
federalidnumber
string
The federal ID number for provider, if SHOWFEDERALIDNUMBER is set.
firstname
string
The provider's first name.
hideinportalyn
string
If set, this provider does not appear in athenaCommunicator's web portal.
homedepartment
string
For certain purposes, this can be considered to be the "home" or default department for a provider.
lastname
string
The provider's last name.
npi
integer
The NPI for this provider, if available.
otherprovideridlist
string
When showallproviderids is set to true, a list of all other athenaNet providers IDs that may refer to this same provider. If not present with showallproviderids, there are no other IDs other than the primary ID.
personalpronouns
string
The preferred personal pronouns of this provider.
providergrouplist
string
When showallproviderids is set to true, a list of all provider groups that this provider is registered in. Data is only relevant if a practice is using Provider-Group-Based Data Permissions in their practice.
providerid
integer
The ID to be used for this provider. Note that in athenaNet, an individual provider (as defined by a unique NPI) may have multiple provider IDs. For the API, we have collapsed these to a single canonical ID.
providertype
string
There is a long potential list of provider type in the form "full name (id)", but "MD", "NP" or "NP S" (Nurse Practitioner (Supervising)), "RES" (resident), "EQUIP", "DO", "PA" or "PASUP" (Physician's Assistant (Supervising)), "TECH", "RN", LPT", "CRNA" or "CRNASUP" (Certified Registered Nurse Anesthesiologist (Supervising)), and MA (Medical Assistant) are among the most common.
providertypeid
string
This is just the ID (a text string) such as "NP" or "NP S" for the provider type.
providerusername
string
The username of the provider.
scheduleresourcetype
string
Name of the scheduling resource type tied to the provider.
schedulingname
string
The scheduling name for this provider (as used in athenaNet).
sex
string
The sex of this provider.
specialty
string
A friendly name for this provider's specialty.
specialtyid
integer
The ID of the provider's specialty.
supervisingproviderid
integer
The ID of the supervising provider.
supervisingproviderusername
string
The username of the supervising provider.
usualdepartmentid
integer
The "usual" department for this provider, if SHOWUSUALDEPARTMENTGUESSTHRESHOLD is set.
Example Code
Delete information of given provider
DELETE
/v1/{practiceid}/providers/{providerid}
BETA: Deletes the record of the specified provider
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
providerid
integer
providerid
Output Parameters
Expand all
alertmessage
string
Alert message if the operation did not work.
errorreason
string
Error message if the operation did not work.
providerid
integer
The ID to be used for this provider. Note that in athenaNet, an individual provider (as defined by a unique NPI) may have multiple provider IDs. For the API, we have collapsed these to a single canonical ID. For updates and deletes, this will be either 1 or -1 depending on success or failure.
Example Code
Get list of change events for providers
GET
/v1/{practiceid}/providers/changed/subscription/events
Retrieve list of events for changed providers
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
Output Parameters
Expand all
departmentids
array
List of Departmentids subscribed
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 providers
POST
/v1/{practiceid}/providers/changed/subscription
Subscribes for changed provider events
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
Content-Type
string
Content type of the payload
Output Parameters
Expand all
success
string
Returns if the call to manipulate subscriptions for providers was successful.
Example Code
Get list of subscribed events for changes in providers
GET
/v1/{practiceid}/providers/changed/subscription
Retrieves list of events applicable for providers changed
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
Output Parameters
Expand all
departmentids
array
List of Departmentids subscribed
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 providers
GET
/v1/{practiceid}/providers/changed
Retrieve list of providers which are updated, deleted or added
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
leaveunprocessed
boolean
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 5000)
offset
integer
Starting point of entries; 0-indexed
Output Parameters
Expand all
acceptingnewpatientsyn
string
Indicates whether the provider is accepting new patients. This field is currently only for informational purposes, and does not drive any athenaNet functionality.
ansinamecode
string
This is the ANSI name with ANSI code for this provider's specialty.
ansispecialtycode
string
This is the ANSI code for this provider's specialty.
billable
string
Indicates if this is a billable provider.
displayname
string
The preferred name to use when displaying this provider.
entitytype
string
Either "Person" or "Non-Person" (e.g. X-Ray machines)
firstname
string
The provider's first name.
hideinportalyn
string
If set, this provider does not appear in athenaCommunicator's web portal.
homedepartment
string
For certain purposes, this can be considered to be the "home" or default department for a provider.
lastname
string
The provider's last name.
personalpronouns
string
The preferred personal pronouns of this provider.
providerid
integer
The ID to be used for this provider. Note that in athenaNet, an individual provider (as defined by a unique NPI) may have multiple provider IDs. For the API, we have collapsed these to a single canonical ID.
providertype
string
There is a long potential list of provider type in the form "full name (id)", but "MD", "NP" or "NP S" (Nurse Practitioner (Supervising)), "RES" (resident), "EQUIP", "DO", "PA" or "PASUP" (Physician's Assistant (Supervising)), "TECH", "RN", LPT", "CRNA" or "CRNASUP" (Certified Registered Nurse Anesthesiologist (Supervising)), and MA (Medical Assistant) are among the most common.
providertypeid
string
This is just the ID (a text string) such as "NP" or "NP S" for the provider type.
providerusername
string
The username of the provider.
scheduleresourcetype
string
Name of the scheduling resource type tied to the provider.
schedulingname
string
The scheduling name for this provider (as used in athenaNet).
sex
string
The sex of this provider.
specialty
string
A friendly name for this provider's specialty.
Example Code
Unsubscribe to all/specific events for changes in providers
DELETE
/v1/{practiceid}/providers/changed/subscription
Delete an 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
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 providers was successful.
Example Code