Payroll

For Healthcare Analytics

The Payroll entity provides employee hours and amounts based on the payroll import, and paycode and paid job details for each employee and pay period.

Caution: The Healthcare Analytics entities and columns are available only from the API and cannot be used in Dataviews or to create reports at this time. To get the Healthcare Analytics data, use the Retrieve Data (POST /v1/commons/data/multi_read) API operation. Retrieve only the WORKUNIT and WORKUNIT_TIMESERIES data and ignore the Employee and Location data.

Supported Dataview types

Standard Dataview

Timeseries Dataview

Employee Dataview

Business Structure Dataview

Yes

  • Only the Pay_Period symbolic time period (STP) is supported so that you can retrieve this data for a single pay period.

No

Data granularity

  • Work unit
  • Day
  • ORGJOB
  • EMP

Columns

Label

Description

Key

Raw Payroll Employment Status

Payroll Employment Status

HCA_METRIC_RAW_PAYROLL_EMPLOYMENT_STATUS

Raw Payroll Amount

Payroll Amount

HCA_METRIC_RAW_PAYROLL_PAID_AMOUNT

Raw Payroll Hours

Payroll Hours

HCA_METRIC_RAW_PAYROLL_PAID_HOURS

Raw Payroll Paid Job

Payroll Paid Job

HCA_METRIC_RAW_PAYROLL_PAID_JOB

Raw Payroll Paycode Name

Payroll Paycode Name

HCA_METRIC_RAW_PAYROLL_PAYCODE_NAME

Related entities

None

Additional information

For symbolic periods that are not based on pay periods, no data is returned.

Supported views:

  • Work unit

Roll-ups:

  • No roll-ups are supported, data is exported at the lowest grain.
  • Raw payroll data is rolled up by payroll paycode, payroll employee status, employee, and payroll paid job.

Core entity

Employee

Organization

Day

Organizational Job

Paycode

Labor Category

Activity

Work Unit

Work Group

X

X

X