On This Page
Overview
On April 22, 2024 Compass announced the expansion of the data delivery schema to include the addition of new data attributes for Compass Patient and Compass Pathway.
If you became a Compass customer after April 22, 2024, you will automatically receive the new schema, and no further action is needed.
In order to support the transition of your data ingestion processes to utilize the new fields, Compass will maintain both the current retiring schema and the new expanding schema in parallel for up to 12 months (April 2025).
In the documentation and user interface, the retiring schema and new schema have the following names:
| Retiring Schema | New Schema |
|---|---|
| patient_schema_v1 | patient_schema_v2 |
| pathway_schema_v1 | pathway_schema_v2 |
While we have provided initial instructions below, if needed, your Product Expert team can support you in the editing or duplicating of any existing scheduled jobs.
Planning your Data Ingest Changes
The ingestion updates apply only to new additive fields. No existing fields are changing name or data type. However, the new fields are placed within their logical grouping of “like” elements throughout the file, and not appended at the end, in order to maintain schema readability.
The Data Dictionary provides the field names highlighted in yellow and their placement within the delivery schema, as well as the data types and any applicable character limits on the new fields. The Data Dictionary provided in your data delivery package will include a tab for both schemas during this transition period.
The Compass API page is also updated with the relevant schema version.
Your Product Expert can provide the resources or support in transitioning to the V2 schema, including the Data Dictionaries for your impacted products and sample data in csv and parquet formats, to test these changes before creating new queries.
Selecting the Schema Version
The data schema version can be selected as part of the Compass Patient Query Builder, located within the Review & Submit section, and as part of the Delivery Options.
This data schema version selection will be available when:
- Creating a new query within Query Builder
- Editing an existing scheduled query within the Job Manager, to change the job parameters to deliver in the V2 schema going forward
- Duplicating an existing scheduled query within Job Manager, to keep a version of the query delivering in the V1 schema and a new version of the query to deliver in the V2 schema in parallel
Once ingest changes to support the new schema have been made and all existing queries have been modified to deliver in the V2 schema, this schema selection will no longer be available.
New Attributes
Compass Patient & Compass Pathway
| Attribute Category | Field Names |
|---|---|
| Rx Payer Plan Data |
payer_name_vid_primary payer_name_vid_secondary payer_plan_name_primary payer_plan_name_secondary payer_plan_vid_primary payer_plan_vid_secondary |
| ICD Procedures | icd_procedure_code_1 icd_procedure_code_2 icd_procedure_code_3 icd_procedure_code_4 icd_procedure_code_5 icd_procedure_code_6 icd_procedure_code_1_desc icd_procedure_code_2_desc icd_procedure_code_3_desc icd_procedure_code_4_desc icd_procedure_code_5_desc icd_procedure_code_6_desc |
| Location Attributes |
place_of_service_category pharmacy_type_desc |
| Claim Attributes | claim_type prescription_write_date |
| Product Attributes | product_name_vid |
Compass Pathway
| Attribute Category | Field Names |
|---|---|
| Product Attributes |
original_product_id original_product_name |