On This Page
Overview
Veeva Compass National allows you to get quick insights and pull national and state level projected data for your market of interest. Using Compass National, you can get brand insights directly within the Portal, or build a query to extract data to your delivery location of choice.
Getting National & State Projected Data involves the following:
- Product View - Define your products of interest for your data deliverable and view treatment volume, patient volume, and change over time
- Market View - Understand key metrics, market share, and monthly trends for your products and time frame of interest
- Send Data - Pull national or state level projected data for your market of interest
- Geography Type - Select whether you would like data at the national or state level
- Time Interval - Select whether you would like weekly, monthly, quarterly, or yearly projected data
- Metrics - Select whether you would like to include product metrics broken out by disease area
- Delivery Schedule - Select how often you would like your data delivered
- Time Frame - Select the time range of data you would like for your data deliverable
- Delivery Options - Select the delivery format and location for your data deliverable
- Submit - Review the selected market, time frame, and delivery prior to submitting your query
Product View
Upon navigating to National & State Projected Data, you will be taken to the National landing page where you can view the latest volume and trends for products, as well as search on and add specific products of interest to get further market insights or to pull data. The products page displays all supported products at the brand-level, including product details and metrics for treatment and patient volume.
Product Details
Each product includes information about the company, whether it is branded or generic, the product compound, the disease area(s) it is being used to treat.
If a product has multiple companies or manufacturers, the Company column contains “Multiple” for their company name.
If a product has multiple FDA-approved conditions, the Disease Area column contains a comma separated list of applicable Disease Areas. Click the arrow to see the full disease area breakout.
Note that the Company, Branded/Generic, and Compound fields are included in the Portal only and are not part of the data extract.
Metrics
Each product contains volume and change for treatment and patient volume.
For volume and change for each product, the following metrics are shown:
- Tx - Total prescriptions and procedures.
- New Patients - New patients on the brand, across both prescriptions and procedures. A 395-day lookback period is used to identify new patients.
- Total Patients - Total patients on the brand, across both prescriptions and procedures.
The first column for each metric indicates the volume over a given time period. The second column for each metric indicates the % change (growth or decline) of that volume over a given time period.
In the below example, the first column (Tx, 1 week) indicates that there were 671 Total Prescriptions and Procedures for that product over the most recent week. The second column (Change, week over week) indicates that this is an 8% increase from the week prior. For New Patients, there was a 2% decrease, while for Total Patients there was a 13% increase.
For change, products that have no volume in the first time period will have a “-“ to indicate that there is no growth for that selected time period. In the below example, the New Patients volume for the product over the most recent week was 6. However, since there was no New Patients volume for that product in the prior week, the change is undefined.
Initially, metrics for each product are reported by “Disease Area Total”, which includes all volume for the product across all FDA-approved conditions. If a product has more than one available disease area, click on the arrow in this column to split out the volume into individual disease areas.
Time Frame
You can select the time period for product volume and change by using the time period buttons. When selecting a time period, this will update the volume and growth for the products to be calculated over the selected time period.
Available options are: 1 week, 1 month, 1 quarter, 1 year.
Note that the most recent data available based on your time frame selection will be listed in the upper right corner.
Product Search
You can search for products by entering in a search term into the search bar. Products can be searched for by Name, Company, Compound, and Disease Area. A list of all Disease Areas is available in our Data Dictionary.
To include multiple terms in your search, enter your first term and press “tab” or “enter” on your keyboard to encapsulate it. Then, repeat these steps for all desired terms. Alternatively, copy and paste a list of terms from a spreadsheet or text document. Terms on separate lines will automatically be encapsulated upon pasting.
When you are finished adding terms, click “Go” or hit Enter on your keyboard again to run a search.
To add a product to your market, click on the “+” button next to a product.
Once a product has been added, you can remove it by clicking on the “-“ button. You can also add all the products in the current view by clicking on “+ All”, or remove all products in the current view by clicking on “- All”.
The Added Products will indicate how many products you have added to your market. To filter down your view so that you are only your added products, click on the filter button.
You can remove the filter and view all products by clicking on the filter button again.
Templates
You can also add products to your market by using query templates. Templates can be created and managed in the Templates tab, or from a list of codes added to a query. See Query Templates for more information on creating and managing templates.
To add templates to your market, click on the “Templates” icon.
This will open a new window where you can select the template(s) you would like to add. To exit the window without applying any changes, click “Cancel”.
Use the search bar to search for a specific template. To preview the template, click on the template name. This will open a new window with the details of the codes in the template.
You can add a template to your market by clicking on the + button next to the template name. You may add more than one template at a time. To deselect a template, click the - button.
Note that templates are compatible across all Compass products (including Compass Patient and Pathway). Some products that are supported in Compass Patient and Pathway are not supported in Compass Prescriber and Compass National. When adding a template that contains products that are not supported, a warning message will appear that the selected template contains unprojected products. This means that only the products that are supported in Compass Prescriber and Compass National will be added to the query.
Once you have finished selecting your templates, click Apply. This will apply all the selected templates and add the corresponding products to your market. You may then refine your market as needed by adding or removing additional products.
Saving Templates
You can save a template from your added products by clicking the “Save as template” button.
Upon clicking “Save as template”, you will be prompted you to provide a name for your template.
After clicking “Save”, your template will now be saved for use in future queries and can be viewed in the Template Manager and Template modal.
Market View
You can view key metrics, market share, and time interval trends for your added products directly within the Portal. Once you have added at least one product, click on the graph button to view market information.
On this tab, you can view high-level information about your selected products, such as Tx volume, TRx/TMx split, market share, and volume trends. This enables you to get quick insights about your market without needing to pull data.
You can toggle between the Product View and Market View at any time by using the buttons on the top of the page. When you add new products in the Product View, the Market View will update dynamically based on your selections.
Summary Metrics
The information at the top of the page summarizes Tx volume and the TRx/TMX split across all the selected products. By default, monthly, quarterly, and yearly volume are based on the full time frame of National data (Jan 2021 - latest available month); while weekly volume is based on the most recent available 52 weeks.
Time Interval
The Time Interval dropdown allows you to select whether you would like to view data based on weekly, monthly, quarterly, or yearly projections.
Note that Compass National has data available starting from Jan 2021. For monthly projections, the prior month’s projections are published on the 28th of each month. For example, June 2025 projection data will be made available on July 28, 2025. Weekly projections are published each Thursday for three weeks prior. For example, weekly projection data up until August 8, 2025 will be made available on August 28, 2025.
Calendar Selector
The Calendar Selector allows you to choose a specific date range for your market. To add a starting date, open the calendar next to “From” and select a year/quarter/month/week. Then, open the calendar next to “To” and specify the ending date. Note that the “From” date must be before the “To” date.
Disease Area Filter
The Disease Area dropdown allows you to filter product volume by condition. Disease area names are sorted alphabetically and are followed by the number of added products that map to a given disease area. By default, all available disease areas for your selected products will be included.
To filter to a subset, click to open the dropdown and de-select any disease area names you do not want to include. Interacting with the “All” option will select/de-select all disease areas from the list. Note that you must have at least one disease area selected for visuals to load. If you de-select all options and close the filter, it will revert to your previous selection.
Currently, disease area is available for Tx, New Patients, and Total Patients metrics. When you apply this filter, TRx and TMx metrics will be hidden, while Payer Mix metrics will be reported by disease area total.
Key Metrics
The Key Metrics table provides Tx, TRx, TMx, Commercial Tx, Medicare Tx, Medicaid Tx, and New Patients for each product, across the selected time frame. The key metrics table also includes a color legend for distinguishing products in the Market Share and Monthly Trends graphs. You can hover over a product to highlight that product in the corresponding charts.
Market Share
The Market Share chart provides the market share for each product based on Tx (total prescriptions and procedures) and New Patients volume for the selected time frame. Note that if more than 20 products are added to your market, the Market Share chart will display only the top 20 products with the greatest market share.
Payer Mix
The Payer Mix chart shows the payer split (Commercial Tx, Medicare Tx, Medicaid Tx) aggregated for all products for the selected time frame.
Product Trends
The Product Trends graph shows volume trends for each product across the selected time frame. Use the buttons at the top of the graph to toggle between Tx, New Patients, and Total Patients metrics. You can also view the volume for a specific date and product by hovering over the point on the line. The bar at the bottom of the graph allows you to zoom in on a section of the graph to see it in greater detail.
Disease Area Share by Product
The Disease Area Share by Product chart displays the percent distribution of selected disease areas per product. Each product will have a bar totaling 100%, which displays the percent share of volume of a given disease area compared to all selected disease areas. The legend to the left of the chart displays the color for each disease area. Use the buttons at the top of the graph to toggle between Tx and New Patients metrics. If your market contains more products than fit on your screen, the scroll bar at the bottom of the chart can be used to see additional products.
Percentages over 5% will always be displayed in the chart. Hover over any smaller sections to see their exact percentage share.
Disease Area Market Trends
The Disease Area Market Trends chart displays total disease area volume trends across the selected products and time frame. Disease area sections are sized by volume and use the same color legend as the Disease Area Share by Product chart above. Use the buttons at the top of the graph to toggle between Tx, New Patients, and Total Patients metrics. The bar at the bottom of the graph allows you to zoom in on a section of the graph to see it in greater detail.
Hover over the graph to see the volume and percentage share for each disease area at a given point in time. When many disease areas are available, this list becomes scrollable. Note that percentage share is rounded to the nearest whole number, so occasionally these totals will not add to 100%.
Send Data
To get national or state level projected data for your selected products as a data file, click on the “Send Data” button. This will allow you to review your selected products, specify what type of data you would like, the delivery schedule, and the data file format and location.
Geography Type
The Geography Type pane allows you to specify whether you would like to receive projected data on a National or State level.
Selecting National will provide projected data for the selected products, aggregated across all US states. Selecting State will provide projected data for the selected products, broken out on a state level.
Time Interval
The Time Interval pane allows you to select whether you would like to receive weekly, monthly, quarterly, or yearly projections data.
Selecting Month will provide monthly projected data for the selected products and geography type. Selecting Week will provide weekly projected data for the selected products and geography type. Selecting Quarter will provide quarterly projected data for the selected products and geography type. Selecting Year will provide yearly projected data for the selected products and geography type.
Metrics
The Metrics pane allows you to select the level of detail you would like to include for metrics in your delivery. The options for Compass National are:
- Disease Area & Total Metrics - Includes metrics reported by a product’s individual disease areas and by a product’s total value.
- By default, all available disease areas for your selected products will be included. To filter to a subset of disease areas, click to open the dropdown and de-select any disease area names you do not want to include in your deliverable. Note that interacting with the “All” option will select/de-select all disease areas from the list.
- You must have at least one Disease Are selected. If you de-select all options and close the filter, it will revert to your previous selection.
- Total Metrics Only - Includes metrics reported by a product’s total value.
The Metrics section will be visible for Schema V3 deliveries with a Month, Quarter, or Year time interval. Schema V2 queries and queries with the Week time interval will automatically include Total Metrics Only.
Delivery Schedule
Delivery Schedule allows you to select how often you would like your data delivered. The delivery schedule options for National & State are:
- One Time - A one time pull provides a single delivery (either with weekly, monthly, quarterly, or yearly projections) with the selected products, filters, and time frame.
- Monthly - A monthly job allows you to receive the latest set of monthly, quarterly, or yearly projections on a recurring monthly basis. Monthly jobs are run on the 1st of each month and will include projections up until the end of the latest available month. For example, a monthly job run on April 1, 2025, will include projections up until the end of February 2025. The following monthly job, run on May 1, 2025, will include projections up until the end of March 2025. Monthly projections will report each month separately, while quarterly projections will aggregate three months together, and yearly projections will aggregate twelve months together. Quarters or years with partial data will be reported as quarter to date (QTD) or year to date (YTD).
- Weekly - A weekly job allows you to receive the latest set of weekly projections on a recurring weekly basis. Weekly jobs are run each Friday, and will include projections up until three weeks prior. For example, a weekly job run on Friday September 5, 2025 will include projections up until August 15, 2025. The following weekly job, run on Friday September 12, 2025 will include projections up until August 22, 2025.
Note that you will either see the weekly or monthly delivery schedule option based on the Time Interval selection.
Time Frame
The Time Frame pane can be used to select a time range for your data. To select a time frame, select a value from the drop down.
For the Week time interval, the options are: Last 13 weeks, Last 26 weeks, Last 52 weeks, Custom time frame, or Full Refresh.
For the Month time interval, the options are: Last 3 months, Last 6 months, Last 12 months, Last 24 months, Last 36 months, Custom time frame, or Full Refresh.
For the Quarterly time interval, the options are: Current quarter, Last 5 quarters.
For the Yearly time interval, the options are: Current year, Last 2 years, Last 3 years.
For one time jobs, you can opt to receive data from a rolling time frame or custom time frame. For a custom time frame, select the corresponding drop-down option, then use the month or week calendar selectors to pick your desired time frame.
Week Selection
For weekly jobs, you can select a range of weeks to include in your data pull. To add a starting week, click the “mm/dd/yyyy” or the calendar picker next to “From”.
Hover over the calendar to select the week you would like to start with. For Compass projections, weeks are defined as Saturday through Friday.
After selecting the starting week, specify the ending week. To add an ending week, type or click the “mm/dd/yyyy” or the calendar picker next to “To”. Note that the “From” date must be before the “To” date.
For weekly jobs, you can opt to receive a rolling time frame of data (e.g. each weekly job will provide data from the most recent 13, 26, or 52 weeks) or a full refresh. Full refresh means that each weekly job will provide data from December 26 2020 to the latest available week.
Compass National has weekly data available starting from Dec 26 2020, and projections are published each Thursday for three weeks prior. For example, weekly projection data up until August 8, 2025 will be made available on August 28, 2025.
Month Selection
For monthly jobs, you can select a range of months to include in your data pull. To add a starting month, type the three letter abbreviation for the month (e.g. Jan, Feb, Mar) or click the “mmm yyyy” or the calendar picker next to “From”.
After selecting the starting month, specify the ending month. To add an ending month, type or click the “mmm yyyy” or the calendar picker next to “To”. Note that the “From” date must be before the “To” date.
For monthly jobs, you can opt to receive a rolling time frame of data (e.g. each monthly job will provide data from the most recent 3, 6, 12, 24, or 36 months) or a full refresh. Full refresh means that each monthly job will provide data from January 2021 to the latest available month.
Compass National has monthly data available starting from Jan 2021, and the prior month’s projections are published on the 28th of each month. For example, April 2025 projection data will be made available on May 28, 2025.
Quarter Selection
For quarterly jobs, you can select a range of quarters to include in your data pull. To add a starting quarter, click the “qq yyyy” or the calendar picker next to “From”.
Hover over the calendar to select the quarter and year you would like to start with.
After selecting the starting quarter, specify the ending quarter. To add an ending quarter, click the “qq yyyy” or the calendar picker next to “To”. Note that the “From” date must be before the “To” date.
For quarterly jobs, you can opt to receive a rolling time frame of data (e.g. each job will provide data from the most recent 1 or 5 quarters) or a full refresh. Full refresh means that each quarterly job will provide data from January 2021 to the latest available quarter.
Year Selection
For yearly jobs, you can select a range of years to include in your data pull. To add a starting year, click the “yyyy” or the calendar picker next to “From”.
Hover over the calendar to select the year you would like to start with.
After selecting the starting year, specify the ending year. To add an ending year, click the “yyyy” or the calendar picker next to “To”. Note that the “From” date must be before the “To” date.
For yearly jobs, you can opt to receive a rolling time frame of data (e.g. each job will provide data from the most recent 1, 2, or 3 years) or a full refresh. Full refresh means that each yearly job will provide data from January 2021 to the latest available year.
Delivery Options
Delivery Options allows you to select your desired data delivery locations and file formats for your data. Select the delivery location(s) you would like your data to be delivered to via the checkboxes.If you have multiple configured delivery locations in Explorer, you may select more than one delivery location for your data. See Delivery Configuration for details on setting up new delivery locations.
The following delivery locations are currently available:
- SFTP is a Veeva-hosted secure file location which allows users to use an SFTP client (such as FileZilla or CyberDuck) to connect, navigate and download their data files. The SFTP option will be default selected for all queries.
- Amazon S3 allows you to deliver your data files to Amazon S3. If you have multiple Amazon S3 buckets configured for Compass delivery, you will need to select at least one bucket name from the dropdown list in addition to selecting the Amazon S3 checkbox to use this location. Users are able to select up to three Amazon S3 buckets for delivery in a single job.
- Microsoft Azure allows you to deliver your data files to Microsoft Azure. If you have multiple Azure containers configured for Compass delivery, you will need to select at least one container name from the dropdown list in addition to selecting the Microsoft Azure checkbox to use this location. Users are able to select up to three Azure containers for delivery in a single job.
- Veeva Nitro is a data science and analytics platform that seamlessly integrates with Veeva Compass. Nitro provides faster access to your data, so you have your data ready for querying, visualizing, and reporting. The Nitro option is available for users with an active Nitro subscription. Currently, the Nitro option is available for weekly and monthly data queries using Schema V2.
- Portal Download allows business users without access to an SFTP location to download their data directly from the Portal in an Excel format. Note that each tab within the Excel file will be truncated at 600K rows.
Once you have selected your delivery locations, you may be prompted to select a file format for your delivery. You can select one file format per location for your delivery. The available file formats for each location are managed by System Administrators via the Delivery Configuration page. Currently, Veeva Compass offers data in CSV and Parquet format. For more information on the data delivery files for Parquet and CSV, refer to Understanding the Files & Format.
Refer to the Accessing the Data section for instructions on how to access your data.
Schema Versions
Customers with multiple data delivery schemas available will see an additional selection option beneath the delivery location and file formats menu enabling them to choose the data schema version to be used for the job. When only one data schema version is available, this section will not be displayed.
Details about available data schema versions for each product and tips for transitioning to new schemas can be found under Data Schemas.
Submit
When you are ready to submit your query, click “Submit”, either from the top or bottom of the page.
Upon clicking “Submit”, a modal will appear for you to provide a name and select a license (if applicable) for your query, as well as manage sharing settings.
Note Query names can only consist of letters, numbers, underscores and spaces.
Sharing Settings
Sharing settings allow users to manage roles and access to jobs. These roles determine the user’s permissions (allowed actions) on the job. Roles can be assigned to individual users or groups. Users can also subscribe to job email notifications (e.g. job completion emails) via sharing settings.
By default, upon selecting a license, the user submitting the job is assigned as the Owner role, and any groups associated with the selected license are added to the Viewer role.
You can add additional users and groups to the sharing settings by searching in the “Share with users and groups” search bar, then clicking to select the user or group. The list of available users and groups will be filtered to those associated with the selected license.
By default, the newly added user/group will be assigned the Viewer role. To update the role for a user or group, click on the drop-down menu in the Role column. Note that to reassign another user as the Owner, you must submit the job first, then update the sharing settings in Job Manager.
The table below provides details of permissions that are available for each role.
Note Users with the Read-Only profile cannot be assigned as Owners of jobs, and are limited to Read-Only visibility even if they are made a Viewer or Editor of a job. Full descriptions of user profiles and permissions can be found in User and Group Management.
You can also subscribe users or groups to receive email notifications related to the job, such as when the job completes or is cancelled. To subscribe a user or group to email notifications, select the “Email notifications” checkbox.
Note that for one time jobs, email notification settings can only be updated when the job is submitted or during processing.
You may preview the list of users in a group by hovering over the group name. To remove a user or group from sharing settings, click on the “-” button.
Submit Job
Once you have made any desired updates to sharing settings for the job, click on “Submit”. You can check the status of your job in the Job Manager as well as manage the sharing settings. Confirmation of the Query ID, Query Name & Delivery location will pop up once the data pull is successfully submitted. You can check the status of your data pull in the Job Manager.