Chart

The Patient Locations Reference allows the user to retrieve the configured patient locations in the department (e.g. exam room), etc. The Patient Statuses Reference allows the user to retrieved the patient statuses configured in the system. This feature will enable the admin staff, providers, etc. to know where the patient currently is during their visit.

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 patient locations

GET
/v1/{practiceid}/chart/configuration/patientlocations
Retrieve a list of patient locations for a specific department
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.

Output Parameters

Expand all
defaultoncheckin string Whether this is the default location once the appointment is checked in and the encounter is created
name string Name of this location
patientlocationid integer Athena patient location ID
Example Code

Get list of patient statuses

GET
/v1/{practiceid}/chart/configuration/patientstatuses
Retrieves a list of patient statuses during their visit 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
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
patientstatusid integer The patient status ID.
patientstatusname string The patient status name.
Example Code