Press Ganey NDNQI Report

Press Ganey National Database of Nursing Quality Indicators (NDNQI) is a country-wide database in the United States with which participating hospitals share data related to direct nursing care hours. This extension extracts direct nursing care data from UKG Pro Workforce Management (UKG Pro WFM) into a specific format that complies with Press Ganey NDNQI requirements.

Note: This integration is an extension that is developed outside the normal release schedule to meet specific customer needs; it must be installed by an Integration Consultant. To request one of these extensions, you must submit a request by way of the Gateway Request Portal for BITS, accompanied by a change order.

Press Ganey NDNQI analyzes the data it receives from participating hospitals, gaining insight into nursing care quality improvements. It then shares the findings with hospitals, allowing each facility to assess the quality of nursing care provided across internal departments. Facilities can also take advantage of the results through comparative analysis of performance against other hospitals.

This extension generates a comma-separated (.CSV) file which contains unit-level actual hours worked by employees and contract workers in direct nursing roles, such as:

  • Registered Nurse (RN)

  • Licensed Practical Nurse (LPN)

  • Unlicensed Assistive Personnel (UAP)

  • Mental Health Technician (MHT)

  • Paramedic

  • Emergency Medical Technician (EMT)

Certification and pay rule assignments are referenced by the process to distinguish between employees and contract workers. This essential distinction helps categorize the actual hours worked by employees and contract workers in specific nursing roles before exporting to the file. For example, the actual hours worked by registered nurses (RN) will appear in the file under the RNHospEmplHours and RNContractEmplHours columns.

Press Ganey NDNQI Report concept

Reporting is performed at the hospital unit level where the unit is typically defined as a department, but can be a combination of departments or other business structure nodes. As a rule, output file creation is performed for the entire facility on a quarterly basis before submission to Press Ganey NDNQI.

The administrator configures the integration by identifying criteria to retrieve the actual worked hours, including:

  • Minimum hours threshold

  • (Optional) Grace restriction and decimal rounding values

  • Inclusion of inactive and terminated employees

At the integration's runtime, the user selects a location query, and then selects either start and end dates, or a symbolic time period, such as Last Quarter or Last Month. The process gathers data that meets the criteria, applies the grace restriction, and then rounds the total hours up or down in each category. Worked hours related to partial transfers within a shift and multiple shifts in a day roll-up to the appropriate category.

Rolled-up category data, associated with the selections, is sent to the output file. Only data for an entire month is included; partial month data is excluded.

Considerations and limitations

The integration must be run by a named user. Do not run the integration with a system account.

Before you start

Before you configure this integration, you must do the following:

  1. Configure Access to Integrations.
  2. Configure the following:

    • Combined paycode: Configure, or confirm the existence of a combined paycode which contains all actual worked hours paycodes. See the Combined Paycodes topic.

    • Certifications: Confirm the certifications assignments for any employee who is considered a contract worker in UKG Pro WFM. See the Skills and certifications topic.

    • Pay rules: Confirm the pay rule assignment for any employee who is considered a contract worker in UKG Pro WFM. See the Pay Rules and Employment Terms topics.

      Note: The process relies on certifications or pay rules to distinguish regular employees from contract workers. Use distinct values in order that actual worked hours are rolled-up into the appropriate categories.

  3. Get the URL, User, and Password for the APIGatewayServer.

Configure the Press Ganey NDNQI Report integration

  1. Deploy the Press Ganey NDNQI Report integration
    Note: For more information, see the Deploy Integration Packs to your Atom topic.

    1. Open the Integration Template Designer: Select Main Menu Administration > Application Setup > Integrations Setup > Design Integration Templates.

      Note: If prompted, enter your Username and Password. Click Tap Log in.

    2. Make sure that the Account is correct. If not, select the right account.

    3. Select the Deploy tab > Integration Packs.
    4. From the list in the left column, search for and select the Pro WFM Press Ganey NDNQI Report Extension integration.
      Note: If the integration does not display, select Browse Integration Packs to search for and select the iPack.

    5. Click Tap Install.

    6. From Unattached Environments, select the environment in which to deploy the integration process for the selected integration. Click Tap the double-left arrows button
      Select items
      .
  2. Configure the Press Ganey NDNQI Report integration settings
    1. Select the environment
      1. Select the Manage tab > Atom Management.
      2. Select your environment.
    2. Select environment extensions
      1. In Administration, click tap Environment Extensions.
      2. In Process Filter, click tap the magnifying glass
        Search button
        . It can take several seconds before the button becomes active.
      3. Scroll to and select the integration pack: Press Ganey NDNQI Report > PressGaneyNDNQIReport_iPack_v2.
  3. Configure connection settings
    Caution: If you select Use Default for the connection settings and process properties, ensure that Value is blank. If Value is not blank, that value overrides the default value whether or not Use Default is selected or cleared. Example: If the default value is abc, but Value shows xyz, the integration uses xyz regardless of the setting of Use Default.
    1. Select Connection Settings.

    2. From the Connection list, select and configure the following:

      Connection Settings

      Connection Settings

      Setting

      Required

      Actions

      PressGaneyNDNQIReport_iPack_v2_APIGatewayServer

      Required

      To change the default API gateway server:

      1. Clear Use Default.
      2. Enter the URL to the server.

        Example: <tenantURL>/api

      PressGaneyNDNQIReport_iPack_v2_SFTPServer

      Required

      The SFTP server setting defines the connection to the file that contains the records. Integrations access only the internal SFTP account.

      To change the default SFTP server parameters:

      1. For each field, clear Use Default.
      2. Enter the following values:

        • Enter the name of the internal Host.

        • Enter the number of the Port for the internal SFTP account.

        • In User, enter the username for the internal SFTP account.

        • In Password, select <Encrypted>. Enter the new password for the internal SFTP account.

        • Click Tap Apply.

      PressGaneyNDNQIReport_iPack_v2_UnitID_CRT

      Required

      Enable Override.

      PressGaneyNDNQIReport_iPack_v2_RolledUpCategory_CRT

      Required

      Enable Override.

      PressGaneyNDNQIReport_iPack_v2_Locale_CRT

      Required

      Enable Override.

  4. Configure process properties
    1. Select Process Properties.
      Caution: Do not edit the default values of the AuthenticationProperties. By default, cookies are enabled and set the values for authentication properties.

    2. Select PressGaneyNDNQIReport_iPack_v2 to set process properties that must be configured before the integration can run. This main process starts the integration process and handles errors.

    Process properties

    Process properties

    Process property name

    Column header value

    PressGaneyNDNQIReport_iPack_v2_CRTConfigProperties

    For PressGaneyNDNQIReport_iPack_v2_UnitID_CRT:

    1. Clear Use Default.
    2. Enter Dimension Business Structure Node, Unit Id, Track MHT(Y/N), Track Contract MHT (Y/N), Track Paramedics (Y/N), Track EMT (Y/N).

    For PressGaneyNDNQIReport_iPack_v2_RolledUpCategory_CRT:

    1. Clear Use Default.
    2. Enter Dimension Job, Payrule, Skill & Cert, Press Ganey NDNQI Rolled Up Category.

    For PressGaneyNDNQIReport_iPack_v2_Locale_CRT:

    1. Clear Use Default.
    2. Enter Parameter Name, Locale Policy, Value, Description.
  5. Configure cross-reference tables

    Cross-reference tables (CRT) are the look-up tables that the integrations use to translate parameter values. One or more data values from the source system can be used to assign one or more parameters in the destination system.

    • If more than one row matches a reference value, the first match is the output value.
    • If no match is found, the output value can be null, or the integration can produce errors.
    1. Select Cross Reference.
    2. From the Cross Reference list, select a PressGaneyNDNQIReport table.

    3. Select Override to:

      • Download the tables when you run the integration
      • Edit the table cells in Extensions
    4. When you finish, click tap OK.
    5. Repeat the steps for each of the PressGaneyNDNQIReport tables.
      • PressGaneyNDNQIReport_iPack_v2_UnitID_CRT: Maps a specific business structure node with a unit ID. Only departments listed in this CRT are included in the report.

        Press Ganey NDNQI Report — Unit ID CRT table structure

        Press Ganey NDNQI Report — Unit ID CRT table structure

        Column header

        Definition

        Dimension Business Structure Node

        The business structure for which hours are tracked. Wildcards are not supported.

        Unit Id

        The NDNQI identification number that corresponds to the unit.

        Track MHT(Y/N)

        Determines whether hours worked by MHT employees are tracked for the unit.

        Track Contract MHT(Y/N)

        Determines whether hours worked by MHT contract workers are tracked for the unit.

        Track Paramedics(Y/N)

        Determines whether hours worked by paramedic employees are tracked for the unit.

        Track EMT(Y/N)

        Determines whether hours worked by EMT employees are tracked for the unit.

      • PressGaneyNDNQIReport_iPack_v2_RolledUpCategory_CRT: Maps jobs with contributing hours to a rolled-up category (metric).

        Press Ganey NDNQI Report — Rolled-up Category CRT table structure

        Press Ganey NDNQI Report — Rolled-up Category CRT table structure

        Column header

        Definition

        DimensionJob

        The job in which the employee works.

        Wildcards are supported.

        PayRule

        The pay rule assignment used to identify contract workers.

        Skill & Cert

        The certification assignments used to identify contract workers.

        Press Ganey NDNQI Rolled Up Category

        The category or metric name that is mapped to the job. Corresponds with the column header in the output file. Suggested values include:

        RNHospEmplHours RNContractEmplHours LPNHospEmplHours LPNContractEmplHours UAPHospEmplHours UAPContractEmplHours MHTHospEmplHours MHTContractEmplHours ParamedicEmplHours EMTEmplHours

      • PressGaneyNDNQIReport_iPack_v2_Locale_CRT: Allows translation of messages and labels into different languages. Locale support is provided for column headers.

        Press Ganey NDNQI Report — Locale CRT table structure

        Press Ganey NDNQI Report — Localization CRT table structure

        Column header

        Description

        Parameter Name

        Parameters defined in PressGaneyNDNQIReport_iPack_v2_Locale_CRT process property.

        Locale Policy

        Locale Policy.

        Value

        Message shown in Additional Details, value of the label defined in the Run Summary section, or output file column headers.

        Description

        Parameter description displayed in Additional Details.

        Note:

        • Localization of integration extensions remains optional, but is supported.

        • The cross-reference table (CRT) holds all messages represented with standard English labels; these apply to all locales when the Locale is set to a wildcard (*).

        • Some or all messages can be translated by adding lines to the table in their preferred translation for specific locales. Messages for the most commonly used Locale Policy should be defined at the top of the CRT.

        • Names of the parameters in the CRT column "Parameter Name" must be used as is. If any parameter value needs to be localized for a different Locale Policy, copy the "Parameter Name" with the * Locale Policy, add a new row to the CRT with the appropriate Locale Policy, and then add the localized values in the Message (or Value) and Description CRT columns.

        • Do not enter values in the CRT column "Description" if it is blank.

        • Do not modify placeholders (<>) or the configurable values that are included in the CRT column "Message" (or "Value").

        Sample Locale CRT

        Sample Localization CRT

        Parameter Name

        Locale Policy

        Value

        Description

        Message_NoUnitID

        *

        Unit ID is not configured.

        Unit ID is not configured in the CRT.

        Message_NoStructureNode

        *

        Structure Node not configured.

        Structure Node not configured in the CRT.

        Message_InvalidEndDate

        *

        The End Date must match the last date of a previous month.

        User-supplied End Date does not meet validation criteria.

        Message_InvalidStartDate

        *

        The Start Date must match the first date of a previous month.

        User-supplied Start Date does not meet validation criteria.

        Message_NoCombinedPayCode

        *

        Combined Pay Code is not configured.

        Combined Pay Code is not configured.

        Message_NoLocationType

        *

        Location is not configured.

        Location is not configured.

        Message_NoLocation

        *

        Location must be selected.

        The user did not select a Location.

        Message_NoEndDate

        *

        End Date must be selected.

        The user did not select an End Date.

        Message_InvalidTimestamp

        *

        Timestamp configuration is invalid.

        AppendDateTimeStamp is not configured correctly.

        Message_NoStartDate

        *

        Start Date must be selected.

        The user did not select a Start Date.

        Label_WithoutErrors

        *

        Integration completed without errors.

        Message details when Integration completed without errors.

        Label_WithoutTransactionErrors

        *

        Integration has completed without transaction errors. Additional details, such as disqualifications, may be accessible using the button below.

        Message details when Integration completed without transaction errors. Additional details, such as disqualifications, may be accessible using the button below.

        Label_TransactionEnabled

        *

        Process completed with transaction errors. If Transaction Assistant is enabled, failed records can be re-submitted through Transaction Assistant.

        Message details when Process completed with transaction errors. If Transaction Assistant is enabled, failed records can be re-submitted through Transaction Assistant.

        Label_AdditionalDetails

        *

        Process completed with transaction errors. Additional details, such as disqualifications, may be accessible using the button below.

        Message details when Process completed with transaction errors. Additional details, such as disqualifications, may be accessible using the button below.

        Label_LocationCount

        *

        Location Count

        Run Summary Location Count.

        Label_UnitIdCount

        *

        Unit Id Count

        Run Summary Unit Id Count.

        Label_ExportedSuccessful

        *

        Exported

        Run Summary Exported.

        Label_ProcessedEmployeeCount

        *

        Processed Employee Count

        Run Summary Processed Employee Count.

        Label_DisqualifiedEmployeeCount

        *

        Disqualified Employee Count

        Run Summary Disqualified Employee Count.

        Label_DisqualifiedLocation

        *

        Count of Location not Found

        Run Summary Count of Location not Found.

        Label_IntegrationExecutionId

        *

        ExecutionId

        Run Summary ExecutionId.

        Label_IntegrationType

        *

        Integration Type

        Integration Type.

        Message_IntegrationType

        *

        Import

        Value of Integration Type.

        Label_Year

        *

        Year

        Output file column header.

        Label_Quarter

        *

        Quarter

        Output file column header.

        Label_Month

        *

        Month

        Output file column header.

        Label_UnitID

        *

        UnitID

        Output file column header.

        RNHospEmplHours

        *

        RNHospEmplHours

        Output file column header.

        RNContractEmplHours

        *

        RNContractEmplHours

        Output file column header

        LPNHospEmplHours

        *

        LPNHospEmplHours

        Output file column header.

        LPNContractEmplHours

        *

        LPNContractEmplHours

        Output file column header.

        UAPHospEmplHours

        *

        UAPHospEmplHours

        Output file column header.

        UAPContractEmplHours

        *

        UAPContractEmplHours

        Output file column header.

        MHTHospEmplHours

        *

        MHTHospEmplHours

        Output file column header.

        MHTContractEmplHours

        *

        MHTContractEmplHours

        Output file column header.

        ParamedicEmplHours

        *

        ParamedicEmplHours

        Output file column header.

        EMTEmplHours

        *

        EMTEmplHours

        Output file column header.

        AdditionalDetail_NoUnitIdKey

        *

        UnitId

        Additional details section for UnitId.

        AdditionalDetail_NoStructureNode

        *

        StructureNode

        Additional details section for NoStructureNode.

        AdditionalDetail_NoEmployeeHoursKey

        *

        No hours found

        Additional details section for NoEmployeeHoursKey.

        Message_NoEmployeeHours

        *

        Employee does not have worked hours.

        Additional details section for NoEmployeeHours.

        Message_IncorrectSFTPAction

        *

        An invalid SFTP action has been specified. Refer to process reporting for more details.

        Invalid SFTP action error message.

        Message_InvalidOption

        *

        Integration cannot be run for future dates.

        Invalid date for integration run.

        Message_NoFileGenerated

        *

        No unit ids are mapped at this location.

        No Unit ID found in Unit CRT for selected location.

        Message_ManagerNoAccess

        *

        Manager <PersonNumber> does not have location access during <StartDate> to <EndDate>.

        Error_LocationJob

        *

        Incorrect location selected.

        Error_User

        *

        Unauthorized access: The system account you are using does not have the required privileges to run this integration. Please disable the system account option from the install integrations page and log in with a named user.

        Message_NoEmployeeAccess

        *

        Access rights violation. The user does not have access to employee <Employee>.

Install the Press Ganey NDNQI Report integration

After the integrations are deployed and the connection settings and process properties are configured, install the integrations to make them available for running or scheduling.

Note:

  • An integration template is the configured integration that you deploy to an Atom and then install to make available for running or scheduling.

  • An installed integration is a single instance of an integration that is based on an integration template. When you install an integration, you can define parameters or set parameters to be defined when the integration is run.
  1. Select Main Menu Administration > Application Setup > Integrations Setup > Install Integrations.
  2. Click Tap Create .
  3. In Integration Name, enter a unique name, such as PressGaneyNDNQIReport_iPack_v2.
  4. (Optional) Enter a Description.
    Note: Do not select API Integration.
  5. In File Access, select None to not select a connection.
    Note: Do not select Execute Integration with System Account.

  6. (Optional) Select Re-Run to allow repeated runs of the integration with the same parameter values as the previous run.

  7. Email Notifications

    (Optional)

    1. Select Yes to send email and control center notifications for integration runs.
    2. Enter the email addresses of the recipients for the following types of run status. For multiple recipients, separate the addresses by a comma, but no spaces:

      In Progress — The integration run started and has not finished.

      Completed — The integration ran successfully without errors.

      Failed — The integration ran successfully, but one or more records have errors. The integration run is treated as failed. If Abort on Failure is configured in an integration set, the integration set stops.

      Completed with Errors — The integration run has errors or could not run.

  8. In Skip Configuration, select None(default) to allow multiple integrations to run at the same time or with the same data without restrictions.
    Note: Do not select Allow Minute Interval.

  9. Integration template and parameters

    1. In Integration Template, select PressGaneyNDNQIReport_iPack_v2.

    2. Click Tap Assign .

    3. In Integration Parameters, you can override default settings. Click Tap Create.

    4. Complete the configuration for each parameter value.

    5. Click Save.

Repeat this step for each integration parameter that supports the Press Ganey NDNQI Report process.

Press Ganey NDNQI Report — Integration Parameters

PressGaneyNDNQIReport — Integration Parameters

Parameter name / Template parameter

Description / User prompt

Template parameter

Parameter type

AppendDateTimestamp

(Optional)

Format of timestamp appended to the generated file name.

Supported values include: dd-MM-yyyy'T'hhmmSSS(default) MM-dd-yyyy'T'hhmmSSS

User prompt = No

AppendDateTimestamp

Text

CombinedPayCode

The combined paycode that captures total worked productive hours associated with direct patient care.

Default = Press Ganey Combined Pay Code

User prompt = No

CombinedPayCode

Text

CountHoursThreshold

Contains the minimum threshold that hours must meet or exceed to be included in the metric report.

Default = 50

User prompt = No

CountHoursThreshold

Number

End Date

End date of the report export period. Must be used with the StartDate.

User prompt = Yes

EndDate

Date

File Name

Name of the output file.

Default = Press Ganey NDNQI Report

User prompt = No

FileName

Text

Grace

(Optional) The restriction value that is applied to the hours before rounding is processed. When configured, the Round parameter must also be configured.

Default = 0.5

User prompt = No

Grace

Text

IncludeInactive

(Optional)

Determines whether inactive employees are included in the output file.

Default = false

User prompt = No

IncludeInactive

Boolean

IncludeTerminated

(Optional)

Determines whether terminated employees are included in the output file.

Default = false

User prompt = No

IncludeTerminated

Boolean

Location

Location query for which the integration will run. When a facility is selected, all unit IDs within the facility are included in the report. Hyperfind queries are not supported.

Default = All Home Locations

User prompt = Yes

Location

Hyperfind

OutputDirectory

SFTP directory path to which the metric data file is exported.

Default = /Outbound

User prompt = No

OutputDirectory

Text

Reporting Period

A symbolic time period for which the report is generated. At integration runtime, StartDate and EndDate values are given priority over Reporting Period. All supported values are based on a calendar year and include: Last Month Last Quarter(default) Q1(January—March) Q2(April—June) Q3(July—September) Q4(October—December)

User prompt = Yes

ReportingPeriod

Dropdown

Round

(Optional) The rounding value that is applied to the hours after the grace restriction. When configured, the Grace parameter must also be configured.

Default = 1

User prompt = No

Round

Text

SFTP Action

SFTP Action to perform when files with the same name exist in the remote directory.

Supported case-sensitive values include: Create New Name(default) Append Overwrite Error

User prompt = No

SFTPAction

Text

Start Date

(Optional) Start date of the report export period. Must be used with the EndDate.

User prompt = Yes

StartDate

Date

Make sure that the generic data access profiles (GDAP) allow access by the people who need to run the installed integrations. See Configure Access to Integrations .

Run and test the Press Ganey NDNQ1 Report integration

Run integrations to test that the configuration is set up correctly.

  1. Run the integration
    1. Select the integration:
      1. Select Main Menu Maintenance > Integrations.
      2. Click Tap Run an Integration .
      3. Select the PressGaneyNDNQIReport_iPack_v2 integration from the list. Click Tap Select.
      4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the system assigns a default name, which ends with a date and time stamp.
    2. Set parameters as follows:
      • Start Date: Enter the start date. The End Date must also be provided.
      • End Date: Enter the end date. The Start Date must also be provided.
      • Location: Select the location.
      • Reporting Period: Select a symbolic time period instead of Start and End Dates.
    3. Select the following:
      • Run Integration: If this is the first time this integration is being run.
      • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter values again. Click Tap Yes to continue, or No to not run the integration and to return to the parameter settings.
    4. Wait for the confirmation that the integration completed or failed. Close the panel.
    5. Click Tap Refresh .
    6. To see details, select the integration run. Select Run Summary.
  2. Check the results

    Status indicators

    • In-Progress: The run of this integration has not yet completed.
    • Completed: The integration ran successfully without errors.
    • Scheduled: This integration is scheduled to run later or repeatedly.
    • (Grayed out) Scheduled but Deleted: This integration is scheduled to run, but the integration template has been deleted. When it runs, it will generate an error. To prevent this error, delete the scheduled integration run.
    • Completed with Errors: The integration ran successfully, but one or more records have errors. The integration run is treated as failed. If Abort on Failure is configured in an integration set, the integration set stops.
    • Failed: The integration run has errors or could not run.
    • To troubleshoot and resolve errors, do the following:

      Check the Run Summary for details.

      • To troubleshoot all types of errors, or if the Run Summary shows a large number of errors, click tap Go to Additional Details (if available), or click tap the Source File to open and examine the input source file.
      • (Only for import integrations) To troubleshoot and resubmit integrations that have transactional or data errors, click tap Go to Transaction Assistant.

    To check the results in more detail:

    1. Click Tap the tile for the integration run.
    2. Click Tap Run Summary to see the results of the integration run.

      Example Run Summary details

      Note: The available details vary by integration and configuration.
      • Integration Run Name: Name of this run of the integration.
      • Process Name: Name of any integration set that includes this integration.
      • Integration Name: Name of the installed integration.
      • Integration Reference ID: Unique identifier for this integration run (to help in troubleshooting errors).
      • User: The person or user account that ran the integration.
      • Integration Type: Import, Export, or None
      • Start Date: Date and time when the integration run started.
      • End Date: Date and time when the integration run finished.
      • Status: In-Progress, Completed, Completed with Errors, or Failed.
      • Records Processed: Number of records that were processed.
      • Records Created: Number of records that were created.
      • Errors: Number of records that failed.
      • Source Files, Output File, and Error Files: For file-based import integrations, use Manage SFTP to access the source and output files on the inbound (source) and outbound (destination) SFTP folders. See the Manage SFTP topic.
    3. Log in to the destination system and ensure that the data has been correctly updated.
    Note: You can schedule integrations and integration sets to run once later or at a recurring frequency. See the Schedule Integrations topic.

APIs

API details

APIs for the Press Ganey NDNQI Report integration

API name

Type

Resource path

Description

Execute Hyperfind Query

POST

v1/commons/hyperfind/execute

Retrieve employees based on location. Use to retrieve Location ID and Employee count and qualifier.

Retrieve Timecard Data for Multiple Employees

POST

v1/timekeeping/timecard_metrics/multi_read

Retrieve actual hours worked by the employee.

Retrieve Location by ID

GET

/v1/commons/locations/{id}

Retrieve substructure of location.

Retrieve Data

POST

v1/commons/data/multi_read

Retrieve employee certificate using Retrieve Data.

Retrieve Persons

POST

v1/commons/persons/extensions/multi_read

Retrieve person information.

Retrieve Certification Assignments by ID

GET

v1/commons/persons/certifications/{personId}

Retrieve certificate for terminated employee.

Retrieve Manager Role Assignments

POST

/v1/commons/persons/manager_role_assignments/multi_read

Retrieve manager role assignment.

Retrieve Employee Group by ID

GET

/v1/commons/employee_groups/{id}

Retrieve employee group.

Retrieve Location Set by Name

GET

/v1/commons/location_sets

Retrieve location set.

Retrieve Location by Path

GET

/v1/commons/locations

Retrieve location path.

Retrieve Current User

GET

/v1/commons/persons/current_user_info

Retrieve person number.

Target file properties

  • File name: Press Ganey NDNQI Report
  • File extension: .csv
  • Format: Comma delimited
  • Frequency: On-demand or scheduled
  • Header row: No
  • Footer row: No
  • Output folder: /Outbound

Target file layout

Output file layout for the Press Ganey NDNQI Report

Field

Description

Year

The year in which the actual hours were worked. Data is limited to a single year.

Quarter

The quarter in which the actual hours were worked. Values include: 1—4

Month

The month in which the actual hours were worked. Values include: 1—12

UnitID

Unit identification number.

RN Hosp Empl Hours

Hours worked by Registered Nurses.

RN Contract Empl Hours

Hours worked by Registered Nurses contracted by the facility.

LPN Hosp Empl Hours

Hours worked by Licensed Practical Nurses.

LPN Contract Empl Hours

Hours worked by Licensed Practical Nurses contracted by the facility.

UAP Hosp Empl Hours

Hours worked by Unlicensed Assistive Personnel.

UAP Contract Empl Hours

Hours worked by Unlicensed Assistive Personnel contracted by the facility.

MHTHospEmplHours

Hours worked by Mental Health Technicians.

MHT Contract EmplHours

Hours worked by Mental Health Technicians contracted by the facility.

Paramedic Empl Hours

Hours worked by Paramedics.

EMT Empl Hours

Hours worked by Emergency Medical Technicians.

Version history

Version history

Version

Description

1

Initial release.

1.1

The Press Ganey NDNQI Report totals did not break out by year and quarter when the report was run for a date range or symbolic period that spanned multiple months.

1.2

The Press Ganey NDNQI Report now includes worked hours associated with the job for:

  • multiple transfers within the same shift.

  • multiple shifts with multiple transfers within the same day, up to a maximum of 3 shifts in the same day.

iPack_v2

The integration delivery is now by way of an iPack.

iPack_v2 (enhancements)

The Press Ganey NDNQI Report was enhanced to capture transferred-in hours at all levels of the business structure. The report now includes hours worked by employees who:

  • transfer in from an external unit.

  • transfer to a job that differs from their primary job.

Items that were addressed include:

  • Selecting All Home Locations returned an error when running the report.

  • The AppendTimestamp integration parameter default value of dd-MM-yyyy'T'hhmmSSS was inconsistent with the validation format.

  • The report omitted employees when their future employment status differed from the current status. For example, an active employee as of today, but terminated in the future; or an inactive employee as of today, but rehired in the future.

Addressed a profile mismatch issue.

The Press Ganey NDNQI Report now:

  • handles multiple active certificates that are assigned to an employee.

  • appropriately adds actual worked hours to an employee's assigned certificate when that certificate expires during the reporting period.

  • generates a validation message when an incorrect location is selected.

The Press Ganey NDNQI Report now displays an appropriate message when a system account runs the integration for All Home Locations.

The Press Ganey NDNQI Report addresses an API issue that returns an unexpected date format for consecutive dates.

The Press Ganey NDNQI Report integration:

  • failed when it was executed by a user who did not have access to the selected location or job. The integration now displays an appropriate error message and then skips the record to continue processing.

  • did not include all of the departments that were selected at runtime in the output file.