PnC Published Report Style Guide

Style Guide/Naming Convention for Published Reports (Does not apply to reports in personal files)

Report Name
  • Should be unique and descriptive
    • Avoid using "copy of" or similar language
  • Capitalize:
    • The first word
    • All nouns
    • All verbs (including short ones such as "is"
    • All Adjectives
    • All proper nouns
Description
  • A textual description of record selection criteria
  • Intended use case or viewers
  • Known reasons the report would require edits
  • Report writer's first and last name
  • Published Date in MM/DD/YYYY format
Fields to Display
  • All display fields should have a custom name
    • Use names that are intuitive to users
      • ex: Messagedatetime should be renamed Message Sent Date Time
      • ex: CustomField4 in Disease Management should be renamed as the user sees it Enrolled Date
    • Use spaces between words
  • Use the same standard capitalization as listed under Report Name
Sort By
  • Choose a sort by order that suits the use case for the report in question
Parameters
  • Clear out date fields
    • Add/Edit Parameters > Set Defaults> Start date and End date “None” > OK > Done > Save
External System Integration
  • Data Team can deviate from fields to display standards where required for integration with external systems (SAS, python, Stata, etc.)
  • Reason for deviation should be clear from the description text

Example:

Name: COVID Testing Appts by Location and Provider

Description: Finds all checked in and future appointments for COVID-19 department summarized by location and provider. Use Appointment Date Counts with the Excel calculator to find percentage booked.Will require edits to include any COVID visit types built after the published date.  Ellie Kachel 8/21/2020 




Keywords:PnC, reports, reporting   Doc ID:117772
Owner:Bricen G.Group:UHS Informatics
Created:2022-04-05 12:45 CDTUpdated:2022-04-06 16:10 CDT
Sites:UHS Informatics
Feedback:  0   0