On This Page
Overview
Veeva Compass provides a versioned data delivery schema for each product which allows customers to plan for a predictable data ingest.
Periodic updates to the delivery schemas allow for new enhancements such as field additions and retirements, as well as naming and data type updates, occurring at most once per year. Each schema version has its own Delivery Package complete with version-specific Data Dictionaries and a version-specific API parameter. Whenever a new schema version is released, Compass will maintain both the current retiring schema and the new enhanced schema in parallel for up to 12 months, providing customers time to migrate and test their ingestion workflows on the new schema without job interruption.
New Compass customers will always be defaulted to delivery on the newest available schema version, even if an older version of the schema is still available.
Current Delivery Schemas
Current, recently announced, and recently retired data schemas for each product are listed below, and referred to as such throughout the documentation and user interface, the retiring schema and new schema have the following names:
| Subproduct | Schema | Launch Date | Retirement Date |
|---|---|---|---|
| Patient | patient_schema_v3 | April 21, 2025 | - |
| Patient | patient_schema_v2 | April 22, 2024 | April 20, 2026 |
| Pathway | pathway_schema_v3 | April 21, 2025 | - |
| Pathway | pathway_schema_v2 | April 22, 2024 | April 20, 2026 |
| Prescriber | prescriber_schema_v2 | April 21, 2025 | - |
| Prescriber | prescriber_schema_v1 | January 15, 2024 | April 20, 2026 |
| Zip | zip_schema_v2 | April 21, 2025 | - |
| Zip | zip_schema_v1 | January 15, 2024 | April 20, 2026 |
| National | national_schema_v2 | April 21, 2025 | - |
| National | national_schema_v1 | January 15, 2024 | April 20, 2026 |
| State | state_schema_v2 | April 21, 2025 | - |
| State | state_schema_v1 | January 15, 2024 | April 20, 2026 |
| Genomics | genomics_schema_v3 | August 26, 2025 | - |
| Lab Results | lab_results_schema_v3 | April 21, 2025 | - |
| Specialty Pharmacy | specialty_pharmacy_schema_v3 | April 21, 2025 | - |
Selecting the Schema Version
When setting up jobs for Compass Patient, Compass Prescriber, or Compass National, customers with multiple data delivery schemas available will see an additional selection option within the delivery location and file formats menu enabling them to select the data schema version to be used for the job. When only one data schema version is available, this section will not be displayed.
This data schema version selection will be available when:
- Creating a new query
- Editing an existing scheduled query within the Job Manager
- Duplicating an existing scheduled query within Job Manager
Planning Data Ingest Changes
Compass provides several resources during schema version changes to help you test and migrate to the latest data.
- Release notes will announce schema launch and retirement dates prior to the change, including a summary of impacted fields.
- The Data Dictionary provided in your data delivery package will include a tab for both schemas during the transition period. The Compass API page is also updated with the relevant schema version.
- A Data Governance document will be available to list new, retiring, and changed attributes as well as a description of each change.
- Your Product Expert is also available to provide resources and support, including the Data Dictionaries and Data Governance documents for your impacted products and additional sample data in csv and parquet formats, as well as help duplicating your jobs to use the new schema for testing purposes.