Inbox Tasks

The Inbox tasks feature allows physicians, administrative staff members, or athenahealth staff to action on and complete the tasks in their inbox. Inbox Task Staff Reference allows the user to view the configured list of staff members in a department who would be working on the Inbox tasks.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Get list of tasks assigned to given provider
GET
/v1/{practiceid}/providers/{providerid}/inbox

Retrieves a list of tasks assigned to a given 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
providerid integer providerid
priority string Priority to filter, all others will be excluded
subtype string The document class to filter, all others will be excluded
inboxcategory string The inbox category/bucket to filter, all others will be excluded.
status string Status to filter, all others will be excluded
departmentid integer The athenaNet department ID for the patient associated tasks. If department ID is passed in then patient ID is also required.
patientid integer An athenaNet patient ID. If specified will only retrieve tasks associated with this patient ID. If patient ID is passed in then department ID is also required.
sortorder string Order in which the result will be sorted according to created date
limit integer Number of entries to return (default 1000, max 10000)Please note that this endpoint has a different default and max than normal.
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
createddate string Date when this task was created
departmentid integer The department ID associated with this task, typically just the department from the encounter or department.
description string Task description
documentclass string Document class, for further classification within the given inbox category bucket
documentsubclass string Document subclass, for further classification within the document class.
inboxcategory string Category for this task
patientid integer The ID of the patient that this task is for. Please note that not all tasks will have associated patients.
priority string Task priority
resultcategory string The uppercase result category (e.g. "NORMAL", "ABNORMAL" , "UNKNOWN", etc.)
status string Status that the task is currently in
subtype string Subtype of this Task
subtypeid string AthenaNet ID of the Subtype - i.e. if this is an encounter, then encounter ID
taskid integer AthenaNet ID for the given task
Example Code
Get count of tasks assigned to given provider
GET
/v1/{practiceid}/providers/{providerid}/inbox/counts

Retrieves the count of tasks along with the inbox categories assigned to the 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
providerid integer providerid
departmentid integer The athenaNet department ID for the patient associated tasks. If department ID is passed in then patient ID is also required.
patientid integer An athenaNet patient ID. If specified will only retrieve tasks associated with this patient ID. If patient ID is passed in then department ID is also required.

Output Parameters

Expand all
abnormalcount string The number of abnormal tasks (generally results).
count string The total number of tasks
criticalcount string The number of tasks that are critical.
inboxcategory string The category of tasks for this entry.
patientid string The patient ID this document is tied to.
Example Code
Get list of tasks assigned to given staff
GET
/v1/{practiceid}/staff/{staffusername}/inbox

Retrieves a list of tasks assigned to a specific staff

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
staffusername string staffusername
priority string Priority to filter, all others will be excluded
subtype string The document class to filter, all others will be excluded
inboxcategory string The inbox category/bucket to filter, all others will be excluded.
status string Status to filter, all others will be excluded
departmentid integer The athenaNet department ID for the patient associated tasks. If department ID is passed in then patient ID is also required.
patientid integer An athenaNet patient ID. If specified will only retrieve tasks associated with this patient ID. If patient ID is passed in then department ID is also required.
sortorder string Order in which the result will be sorted according to created date
limit integer Number of entries to return (default 1000, max 10000)Please note that this endpoint has a different default and max than normal.
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
createddate string Date when this task was created
departmentid integer The department ID associated with this task, typically just the department from the encounter or department.
description string Task description
documentclass string Document class, for further classification within the given inbox category bucket
documentsubclass string Document subclass, for further classification within the document class.
inboxcategory string Category for this task
patientid integer The ID of the patient that this task is for. Please note that not all tasks will have associated patients.
priority string Task priority
resultcategory string The uppercase result category (e.g. "NORMAL", "ABNORMAL" , "UNKNOWN", etc.)
status string Status that the task is currently in
subtype string Subtype of this Task
subtypeid string AthenaNet ID of the Subtype - i.e. if this is an encounter, then encounter ID
taskid integer AthenaNet ID for the given task
Example Code
Get list of users whom tasks can be assigned for given department
GET
/v1/{practiceid}/configuration/inbox/staff

Retrieves a list of users in a department who can be assigned the inbox tasks

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
departmentid integer The athenaNet department id.
limit integer Number of entries to return (default 1000, max 10000)Please note that this endpoint has a different default and max than normal.
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
staffname string Name of the user/bucket
Example Code