Departments Reference

The Departments reference allows the user to view the list of detailed information of departments associated with the practice.

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 all departments
GET
/v1/{practiceid}/departments

Retrieves detailed information of the departments associated to a practice

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
showalldepartments boolean By default, departments hidden in the portal do not appear. When this is set to true, that restriction is not applied. Default is false.
providerlist boolean If set to true, list providers who see patients in this department. Note that only providers that have booked appointments in the department will be listed. Default is false.
hospitalonly boolean If set to true, return hospital only departments.
fullproviderlist boolean If set to true, list providers who are configured to be able to see patients in this department. This list is most accurate when the department-providers configuration is actively maintained. This list is dependent on valid configuration. Warning: the configured list may be very large. Default is false.
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 for this department.
address2 string The address (line 2) for this department.
chartsharinggroupid string The chart sharing group ID puts departments (that are enabled for Clinicals) into groups with regards to clinical information. Any chart related GET calls with department IDs that are in the same chart sharing group generally return the same set of information. For example, if department IDs 1 and 2 are in chart sharing group 1000 and department IDs 20 and 21 are in chart sharing group 2000, the allergies endpoint for department ID 1 or 2 will return the same set of data, and using department IDs 20 and 21 may return a different set of allergies. Most commonly, this is used to ensure mental health and other sensitive charts remain separate from other data.
city string The city for this department.
clinicalproviderfax string This is the department's fax number for receiving orders.
clinicals string Is Clinicals turned on for this department. Possible values are "ON", "OFF", "DOCUMENTSONLY" (which means that they accept documents, but generally not doing encounters in Clinicals) or "ADMINONLY" which for most purposes is the same as "OFF", though means that it is in the middle of implementation.
communicatorbrandid string The ID of the patient-facing brand this department belongs to.
creditcardtypes string An array of credit card types accepted in this department (for retail transactions). If not present, credit cards can not be processed for this department for retail transactions.
departmentid string The department ID. This ID is local to each practice.
doesnotobservedst string Set to true if this practice does not observe daylight savings time.
ecommercecreditcardtypes string An array of credit card types accepted in this department (for ecommerce transactions). If not present, credit cards can not be processed for this department for ecommerce transactions.
fax string This is the department's fax number. Sometimes this is not configured even though the department can receive faxes. This happens when the main clinical provider has their fax number set up but the department does not. You should check both this field and the "clinicalproviderfax" field when determining if faxes are possible.
ishospitaldepartment string Flag denoting if this department is a hospital department.
latitude string The latitude may be set by the practice to correct any bad public mapping data. In degrees, with a decimal component.
longitude string The longitude may be set by the practice to correct any bad public mapping data. In degrees, with a decimal component.
medicationhistoryconsent string Should medication history consent be asked in this practice. This is a practice-wide setting at the end of the day; if it is on for one Clinicals department (of status "ON"), it will be on for all Clinicals departments.
name string The department's name.
oneyearcontractmax string For a year long payment contract, the practice's suggested maximum amount for this department.
patientdepartmentname string The patient-friendly name for this department, if set by the practice.
phone string This number is not always patient-facing; it may be a "back line".
placeofservicefacility string Is this department a "facility" or not
placeofservicetypeid string An athena-internal ID for the type of service location (e.g. office vs. hospital)
placeofservicetypename string The name describing the type of service location (e.g. office vs. hospital)
portalurl string The URL for the practice or the portal, if available, for this department. This may be the practice's website where they have a link to the portal.
providergroupid string The ID of the financial group this department belongs to. Not all practices have distinct financial groups.
providergroupname string The name of the financial group this department belongs to. Not all practices have distinct financial groups.
providerlist string If providerlist is passed in (set to true), a list of provider IDs
servicedepartment string Indicates if this is a department where billable services are performed (i.e. a department where you can create claims).
singleappointmentcontractmax string For a single appointment payment contract, the practice's suggested maximum amount for this department.
state string The state for this department.
timezone string The timezone for this department, offset from UTC/GMT.
timezonename string Timezone name of the department.
timezoneoffset string The "normal" timezone offset from UTC/GMT. The "timezone" combines this and "doesnotobservedst". During daylight savings, this is 1 less than "timezone".
zip string The zip code for this department.
Example Code