Merge pull request #180 from Display-Lab/message-template-consistency-patch

mackgalante · web-flow · commit 27459f7e603f · 2023-11-06T10:57:40.000-05:00
Commit changes from cedar
diff --git a/changelog.md b/changelog.md
@@ -1,5 +1,16 @@
 # Precision Feedback Knowledge Base (PFKB) - Changelog
 ## Version 0.1.1
+### Unreleased
+**Patch:** Message template changes
+- Fixed message text keys to have internally consistent programmatically acceptable keys for filling with information when createprecisionfeedback process is run
+    - Not updated for:
+        - congrats_improved_performance 
+        - consistently_high_performance
+        - remain_low_performance
+        - Potentially not moving forward with these templates, other cedar changes in the works but not in this patch
+- Separated parts of the message text into text message and additional message text
+    - Supporting this change with changes to pictoralist
+
 **Patch:** Update vignettes with standard template for all software pipeline sections
 - Updated introductory texts on all software pipeline sections for:
     - Goal Approach
diff --git a/message_templates/achieved_peer_average.json b/message_templates/achieved_peer_average.json
@@ -68,22 +68,25 @@
   },
   "Message text": [
     {
-      "@value": "Your performance is above the peer average this month for the measure [Measure name]."
+      "@value": "Your performance is now above the peer average this month for the measure [measure name]. Your performance was [recipient performance level]."
     }
   ],
   "schema:isBasedOn": "https://repo.metadatacenter.org/templates/707d3573-8ac9-4e2c-b53b-2026a795308c",
   "schema:name": "Achieved Peer Average",
   "schema:description": "specification for a possible precision feedback message",
   "pav:createdOn": "2023-04-26T14:40:04-07:00",
   "pav:createdBy": "https://metadatacenter.org/users/da882240-ad9e-42ea-a48b-215e54161ad3",
-  "pav:lastUpdatedOn": "2023-05-24T12:29:53-07:00",
-  "oslc:modifiedBy": "https://metadatacenter.org/users/b62c6dfa-e33c-40fa-aa02-021e4b9bb00b",
+  "pav:lastUpdatedOn": "2023-10-31T15:47:57-07:00",
+  "oslc:modifiedBy": "https://metadatacenter.org/users/da882240-ad9e-42ea-a48b-215e54161ad3",
   "@id": "https://repo.metadatacenter.org/template-instances/8927dac9-5088-4236-b91d-ff92756f6ac5",
   "Display compatibility": {
     "@value": "Text-only, bar chart, line chart"
   },
   "Short message ID": {
     "@value": "4",
     "@type": "xsd:decimal"
+  },
+  "Additional message text": {
+    "@value": null
   }
-}
+}
diff --git a/message_templates/achieved_top_10_peer_benchmark.json b/message_templates/achieved_top_10_peer_benchmark.json
@@ -68,22 +68,25 @@
   },
   "Message text": [
     {
-      "@value": "You reached the top 10% peer benchmark this month for the measure [Measure name]."
+      "@value": "You reached the top 10% peer benchmark this month for the measure [measure name]. Your performance was [recipient performance level]."
     }
   ],
   "schema:isBasedOn": "https://repo.metadatacenter.org/templates/707d3573-8ac9-4e2c-b53b-2026a795308c",
   "schema:name": "Achieved Top 10 Peer Benchmark",
   "schema:description": "specification for a possible precision feedback message",
   "pav:createdOn": "2023-04-26T14:29:04-07:00",
   "pav:createdBy": "https://metadatacenter.org/users/da882240-ad9e-42ea-a48b-215e54161ad3",
-  "pav:lastUpdatedOn": "2023-05-23T12:01:27-07:00",
-  "oslc:modifiedBy": "https://metadatacenter.org/users/626c7d49-cdfc-43d6-b254-36a7be904ea9",
+  "pav:lastUpdatedOn": "2023-10-31T15:47:10-07:00",
+  "oslc:modifiedBy": "https://metadatacenter.org/users/da882240-ad9e-42ea-a48b-215e54161ad3",
   "@id": "https://repo.metadatacenter.org/template-instances/5c49f6e6-b95f-4eb9-baa9-dac580e33e20",
   "Display compatibility": {
     "@value": "Text-only, bar chart, line chart"
   },
   "Short message ID": {
     "@value": "2",
     "@type": "xsd:decimal"
+  },
+  "Additional message text": {
+    "@value": null
   }
-}
+}
diff --git a/message_templates/achieved_top_25_peer_benchmark.json b/message_templates/achieved_top_25_peer_benchmark.json
@@ -68,16 +68,16 @@
   },
   "Message text": [
     {
-      "@value": "You reached the top 25% peer benchmark this month for the measure [Measure name]."
+      "@value": "You reached the top 25% peer benchmark this month for the measure [measure name]. Your performance was [recipient performance level]."
     }
   ],
   "schema:isBasedOn": "https://repo.metadatacenter.org/templates/707d3573-8ac9-4e2c-b53b-2026a795308c",
   "schema:name": "Achieved Top 25 Peer Benchmark",
   "schema:description": "specification for a possible precision feedback message",
   "pav:createdOn": "2023-04-26T14:32:04-07:00",
   "pav:createdBy": "https://metadatacenter.org/users/da882240-ad9e-42ea-a48b-215e54161ad3",
-  "pav:lastUpdatedOn": "2023-05-24T12:30:29-07:00",
-  "oslc:modifiedBy": "https://metadatacenter.org/users/b62c6dfa-e33c-40fa-aa02-021e4b9bb00b",
+  "pav:lastUpdatedOn": "2023-10-31T15:47:29-07:00",
+  "oslc:modifiedBy": "https://metadatacenter.org/users/da882240-ad9e-42ea-a48b-215e54161ad3",
   "pav:derivedFrom": "https://repo.metadatacenter.org/template-instances/5c49f6e6-b95f-4eb9-baa9-dac580e33e20",
   "@id": "https://repo.metadatacenter.org/template-instances/75bd50a3-c11b-4a61-96e6-eee1f34eff78",
   "Display compatibility": {
@@ -86,5 +86,8 @@
   "Short message ID": {
     "@value": "3",
     "@type": "xsd:decimal"
+  },
+  "Additional message text": {
+    "@value": null
   }
-}
+}
diff --git a/message_templates/approach_goal.json b/message_templates/approach_goal.json
@@ -60,22 +60,25 @@
   },
   "Message text": [
     {
-      "@value": "Your performance is approaching the goal this month for the measure [Measure name]."
+      "@value": "Your performance is approaching the goal this month for the measure [measure name]. Your performance was [recipient performance level]."
     }
   ],
   "schema:isBasedOn": "https://repo.metadatacenter.org/templates/707d3573-8ac9-4e2c-b53b-2026a795308c",
   "schema:name": "Approach Goal",
   "schema:description": "specification for a possible precision feedback message",
   "pav:createdOn": "2023-04-26T15:32:17-07:00",
   "pav:createdBy": "https://metadatacenter.org/users/da882240-ad9e-42ea-a48b-215e54161ad3",
-  "pav:lastUpdatedOn": "2023-05-24T12:31:22-07:00",
-  "oslc:modifiedBy": "https://metadatacenter.org/users/b62c6dfa-e33c-40fa-aa02-021e4b9bb00b",
+  "pav:lastUpdatedOn": "2023-10-31T15:57:29-07:00",
+  "oslc:modifiedBy": "https://metadatacenter.org/users/da882240-ad9e-42ea-a48b-215e54161ad3",
   "@id": "https://repo.metadatacenter.org/template-instances/70fbdb71-fd31-45b0-8432-2bfa1bff200d",
   "Display compatibility": {
     "@value": "Text-only, bar chart, line chart"
   },
   "Short message ID": {
     "@value": "17",
     "@type": "xsd:decimal"
+  },
+  "Additional message text": {
+    "@value": "A case-by-case breakdown of your results are available at your [clinical quality dashboard (link)]. More information about the rationale for the measure [measure name] and how it is calculated is available [here (link to measure spec)]."
   }
-}
+}
diff --git a/message_templates/approach_peer_average.json b/message_templates/approach_peer_average.json
@@ -64,22 +64,25 @@
   },
   "Message text": [
     {
-      "@value": "Your performance is approaching the peer average this month for the measure [Measure name]."
+      "@value": "Your performance is approaching the peer average this month for the measure [measure name]. Your performance was [recipient performance level]."
     }
   ],
   "schema:isBasedOn": "https://repo.metadatacenter.org/templates/707d3573-8ac9-4e2c-b53b-2026a795308c",
   "schema:name": "Approach Peer Average",
   "schema:description": "specification for a possible precision feedback message",
   "pav:createdOn": "2023-04-26T15:20:17-07:00",
   "pav:createdBy": "https://metadatacenter.org/users/da882240-ad9e-42ea-a48b-215e54161ad3",
-  "pav:lastUpdatedOn": "2023-05-24T12:31:54-07:00",
-  "oslc:modifiedBy": "https://metadatacenter.org/users/b62c6dfa-e33c-40fa-aa02-021e4b9bb00b",
+  "pav:lastUpdatedOn": "2023-10-31T15:55:36-07:00",
+  "oslc:modifiedBy": "https://metadatacenter.org/users/da882240-ad9e-42ea-a48b-215e54161ad3",
   "@id": "https://repo.metadatacenter.org/template-instances/004d3aeb-b90a-4e4d-8359-b190d1ab8532",
   "Display compatibility": {
     "@value": "Text-only, bar chart, line chart"
   },
   "Short message ID": {
     "@value": "10",
     "@type": "xsd:decimal"
+  },
+  "Additional message text": {
+    "@value": "A case-by-case breakdown of your results are available at your [clinical quality dashboard (link)]. More information about the rationale for the measure [measure name] and how it is calculated is available [here (link to measure spec)]."
   }
-}
+}
diff --git a/message_templates/approach_top_10_peer_benchmark.json b/message_templates/approach_top_10_peer_benchmark.json
@@ -64,22 +64,25 @@
   },
   "Message text": [
     {
-      "@value": "Your performance is approaching the top 10% peer benchmark this month for the measure [Measure name]."
+      "@value": "Your performance is approaching the top 10% peer benchmark this month for the measure [measure name]. Your performance was [recipient performance level]."
     }
   ],
   "schema:isBasedOn": "https://repo.metadatacenter.org/templates/707d3573-8ac9-4e2c-b53b-2026a795308c",
   "schema:name": "Approach Top 10 Peer Benchmark",
   "schema:description": "specification for a possible precision feedback message",
   "pav:createdOn": "2023-04-26T15:21:34-07:00",
   "pav:createdBy": "https://metadatacenter.org/users/da882240-ad9e-42ea-a48b-215e54161ad3",
-  "pav:lastUpdatedOn": "2023-05-24T12:32:15-07:00",
-  "oslc:modifiedBy": "https://metadatacenter.org/users/b62c6dfa-e33c-40fa-aa02-021e4b9bb00b",
+  "pav:lastUpdatedOn": "2023-10-31T15:56:00-07:00",
+  "oslc:modifiedBy": "https://metadatacenter.org/users/da882240-ad9e-42ea-a48b-215e54161ad3",
   "@id": "https://repo.metadatacenter.org/template-instances/17a4e0f8-5fc1-44bb-b243-8b4a33be1238",
   "Display compatibility": {
     "@value": "Text-only, bar chart, line chart"
   },
   "Short message ID": {
     "@value": "11",
     "@type": "xsd:decimal"
+  },
+  "Additional message text": {
+    "@value": "A case-by-case breakdown of your results are available at your [clinical quality dashboard (link)]. More information about the rationale for the measure [measure name] and how it is calculated is available [here (link to measure spec)]."
   }
-}
+}
diff --git a/message_templates/approach_top_25_peer_benchmark.json b/message_templates/approach_top_25_peer_benchmark.json
@@ -64,16 +64,16 @@
   },
   "Message text": [
     {
-      "@value": "Your performance is approaching the top 25% peer benchmark this month for the measure [Measure name]."
+      "@value": "Your performance is approaching the top 25% peer benchmark this month for the measure [measure name]. Your performance was [recipient performance level]."
     }
   ],
   "schema:isBasedOn": "https://repo.metadatacenter.org/templates/707d3573-8ac9-4e2c-b53b-2026a795308c",
   "schema:name": "Approach Top 25 Peer Benchmark",
   "schema:description": "specification for a possible precision feedback message",
   "pav:createdOn": "2023-04-26T15:22:35-07:00",
   "pav:createdBy": "https://metadatacenter.org/users/da882240-ad9e-42ea-a48b-215e54161ad3",
-  "pav:lastUpdatedOn": "2023-05-24T12:32:59-07:00",
-  "oslc:modifiedBy": "https://metadatacenter.org/users/b62c6dfa-e33c-40fa-aa02-021e4b9bb00b",
+  "pav:lastUpdatedOn": "2023-10-31T15:56:29-07:00",
+  "oslc:modifiedBy": "https://metadatacenter.org/users/da882240-ad9e-42ea-a48b-215e54161ad3",
   "pav:derivedFrom": "https://repo.metadatacenter.org/template-instances/17a4e0f8-5fc1-44bb-b243-8b4a33be1238",
   "@id": "https://repo.metadatacenter.org/template-instances/beb6ce2e-79a9-408f-aa66-b07bffed57e9",
   "Display compatibility": {
@@ -82,5 +82,8 @@
   "Short message ID": {
     "@value": "12",
     "@type": "xsd:decimal"
+  },
+  "Additional message text": {
+    "@value": "A case-by-case breakdown of your results are available at your [clinical quality dashboard (link)]. More information about the rationale for the measure [measure name] and how it is calculated is available [here (link to measure spec)]."
   }
-}
+}
diff --git a/message_templates/drop_below_goal.json b/message_templates/drop_below_goal.json
@@ -64,22 +64,25 @@
   },
   "Message text": [
     {
-      "@value": "Your performance dropped below the goal this month for the measure [Measure name]."
+      "@value": "Your performance dropped below the goal this month for the measure [measure name]. Your performance was [recipient performance level]."
     }
   ],
   "schema:isBasedOn": "https://repo.metadatacenter.org/templates/707d3573-8ac9-4e2c-b53b-2026a795308c",
   "schema:name": "Drop Below Goal",
   "schema:description": "specification for a possible precision feedback message",
   "pav:createdOn": "2023-04-26T15:26:28-07:00",
   "pav:createdBy": "https://metadatacenter.org/users/da882240-ad9e-42ea-a48b-215e54161ad3",
-  "pav:lastUpdatedOn": "2023-05-24T12:34:30-07:00",
-  "oslc:modifiedBy": "https://metadatacenter.org/users/b62c6dfa-e33c-40fa-aa02-021e4b9bb00b",
+  "pav:lastUpdatedOn": "2023-10-31T16:52:09-07:00",
+  "oslc:modifiedBy": "https://metadatacenter.org/users/da882240-ad9e-42ea-a48b-215e54161ad3",
   "@id": "https://repo.metadatacenter.org/template-instances/bbac24d6-c9e0-41f8-a5fd-3ea677402c06",
   "Display compatibility": {
     "@value": "Text-only, bar chart, line chart"
   },
   "Short message ID": {
     "@value": "15",
     "@type": "xsd:decimal"
+  },
+  "Additional message text": {
+    "@value": "A case-by-case breakdown of your results are available at your [clinical quality dashboard (link)]. More information about the rationale for the measure [measure name] and how it is calculated is available [here (link to measure spec)]."
   }
-}
+}
diff --git a/message_templates/drop_below_peer_average.json b/message_templates/drop_below_peer_average.json
@@ -68,15 +68,15 @@
   },
   "Message text": [
     {
-      "@value": "Your performance dropped below the peer average this month for the measure [Measure name]."
+      "@value": "Your performance dropped below the peer average this month for the measure [measure name]. Your performance was [recipient performance level]."
     }
   ],
   "schema:isBasedOn": "https://repo.metadatacenter.org/templates/707d3573-8ac9-4e2c-b53b-2026a795308c",
   "schema:name": "Drop Below Peer Average",
   "schema:description": "specification for a possible precision feedback message",
   "pav:createdOn": "2023-04-26T14:59:17-07:00",
   "pav:createdBy": "https://metadatacenter.org/users/da882240-ad9e-42ea-a48b-215e54161ad3",
-  "pav:lastUpdatedOn": "2023-04-26T14:59:45-07:00",
+  "pav:lastUpdatedOn": "2023-10-31T15:53:09-07:00",
   "oslc:modifiedBy": "https://metadatacenter.org/users/da882240-ad9e-42ea-a48b-215e54161ad3",
   "@id": "https://repo.metadatacenter.org/template-instances/35903316-d0cc-4a53-ba3f-a9d796e78985",
   "Display compatibility": {
@@ -85,5 +85,8 @@
   "Short message ID": {
     "@value": "8",
     "@type": "xsd:decimal"
+  },
+  "Additional message text": {
+    "@value": "A case-by-case breakdown of your results are available at your [clinical quality dashboard (link)]. More information about the rationale for the measure [measure name] and how it is calculated is available [here (link to measure spec)]."
   }
 }
diff --git a/message_templates/getting_worse.json b/message_templates/getting_worse.json
@@ -52,22 +52,25 @@
   },
   "Message text": [
     {
-      "@value": "Your performance is getting worse this month for the measure [Measure name]."
+      "@value": "Your performance is getting worse this month for the measure [measure name]. Your performance was [recipient performance level]."
     }
   ],
   "schema:isBasedOn": "https://repo.metadatacenter.org/templates/707d3573-8ac9-4e2c-b53b-2026a795308c",
   "schema:name": "Getting Worse",
   "schema:description": "specification for a possible precision feedback message",
   "pav:createdOn": "2023-04-26T15:35:30-07:00",
   "pav:createdBy": "https://metadatacenter.org/users/da882240-ad9e-42ea-a48b-215e54161ad3",
-  "pav:lastUpdatedOn": "2023-05-24T12:35:55-07:00",
-  "oslc:modifiedBy": "https://metadatacenter.org/users/b62c6dfa-e33c-40fa-aa02-021e4b9bb00b",
+  "pav:lastUpdatedOn": "2023-10-31T16:53:43-07:00",
+  "oslc:modifiedBy": "https://metadatacenter.org/users/da882240-ad9e-42ea-a48b-215e54161ad3",
   "@id": "https://repo.metadatacenter.org/template-instances/1f257d98-f6b0-44f6-92c8-1a194954f33f",
   "Display compatibility": {
     "@value": "Text-only, bar chart, line chart"
   },
   "Short message ID": {
     "@value": "20",
     "@type": "xsd:decimal"
+  },
+  "Additional message text": {
+    "@value": "A case-by-case breakdown of your results are available at your [clinical quality dashboard (link)]. More information about the rationale for the measure [measure name] and how it is calculated is available [here (link to measure spec)]."
   }
-}
+}
diff --git a/message_templates/no_longer_top_performer.json b/message_templates/no_longer_top_performer.json
@@ -68,15 +68,15 @@
   },
   "Message text": [
     {
-      "@value": "You are no longer a top performer this month for the measure [Measure name]. Your performance was [recipient performance level - percentage], below the [comparator name]."
+      "@value": "You are no longer a top performer for the measure [measure name]. Your performance was [recipient performance level], below the top 10% peer benchmark, which was [comparator performance level] this month."
     }
   ],
   "schema:isBasedOn": "https://repo.metadatacenter.org/templates/707d3573-8ac9-4e2c-b53b-2026a795308c",
   "schema:name": "No Longer Top Performer",
   "schema:description": "specification for a possible precision feedback message",
   "pav:createdOn": "2023-04-26T14:55:35-07:00",
   "pav:createdBy": "https://metadatacenter.org/users/da882240-ad9e-42ea-a48b-215e54161ad3",
-  "pav:lastUpdatedOn": "2023-05-01T07:28:52-07:00",
+  "pav:lastUpdatedOn": "2023-10-31T15:52:36-07:00",
   "oslc:modifiedBy": "https://metadatacenter.org/users/da882240-ad9e-42ea-a48b-215e54161ad3",
   "@id": "https://repo.metadatacenter.org/template-instances/e91fb18a-3a98-420e-a826-bfb1b6eafc58",
   "Display compatibility": {
@@ -85,5 +85,8 @@
   "Short message ID": {
     "@value": "7",
     "@type": "xsd:decimal"
+  },
+  "Additional message text": {
+    "@value": "A case-by-case breakdown of your results are available at your [clinical quality dashboard (link)]. More information about the rationale for the measure [measure name] and how it is calculated is available [here (link to measure spec)]."
   }
-}
+}
diff --git a/message_templates/not_top_performer.json b/message_templates/not_top_performer.json
@@ -81,4 +81,4 @@
   "Additional message text": {
     "@value": "A case-by-case breakdown of your results are available at your [clinical quality dashboard (link)]. More information about the rationale for the measure [measure name] and how it is calculated is available [here (link to measure spec)]."
   }
-}
+}
diff --git a/message_templates/opportunity_to_improve_goal.json b/message_templates/opportunity_to_improve_goal.json
@@ -56,16 +56,16 @@
   },
   "Message text": [
     {
-      "@value": "You may have an opportunity to improve for the measure [Measure name]. Your performance was [recipient performance level as percentage (with numerator and denominator)], below the goal."
+      "@value": "You may have an opportunity to improve for the measure [measure name]. Your performance was [recipient performance level], below the goal."
     }
   ],
   "schema:isBasedOn": "https://repo.metadatacenter.org/templates/707d3573-8ac9-4e2c-b53b-2026a795308c",
   "schema:name": "Opportunity to Improve Goal",
   "schema:description": "specification for a possible precision feedback message",
   "pav:createdOn": "2023-06-28T12:45:57-07:00",
   "pav:createdBy": "https://metadatacenter.org/users/da882240-ad9e-42ea-a48b-215e54161ad3",
-  "pav:lastUpdatedOn": "2023-09-13T12:00:06-07:00",
-  "oslc:modifiedBy": "https://metadatacenter.org/users/626c7d49-cdfc-43d6-b254-36a7be904ea9",
+  "pav:lastUpdatedOn": "2023-10-31T15:58:49-07:00",
+  "oslc:modifiedBy": "https://metadatacenter.org/users/da882240-ad9e-42ea-a48b-215e54161ad3",
   "Display compatibility": {
     "@value": "Text-only, bar chart, line chart"
   },
@@ -74,5 +74,8 @@
     "@type": "xsd:decimal"
   },
   "pav:derivedFrom": "https://repo.metadatacenter.org/template-instances/ffb029f4-104f-437d-9ea3-d85a46b4b87b",
-  "@id": "https://repo.metadatacenter.org/template-instances/0a7d1907-7884-4705-a503-df4a5687c493"
-}
+  "@id": "https://repo.metadatacenter.org/template-instances/0a7d1907-7884-4705-a503-df4a5687c493",
+  "Additional message text": {
+    "@value": "A case-by-case breakdown of your results are available at your [clinical quality dashboard (link)]. More information about the rationale for the measure [measure name] and how it is calculated is available [here (link to measure spec)]."
+  }
+}
diff --git a/message_templates/opportunity_to_improve_peer_average.json b/message_templates/opportunity_to_improve_peer_average.json
diff --git a/message_templates/performance_dropped.json b/message_templates/performance_dropped.json
diff --git a/message_templates/performance_improving.json b/message_templates/performance_improving.json
diff --git a/message_templates/reached_goal.json b/message_templates/reached_goal.json
diff --git a/message_templates/top_performer.json b/message_templates/top_performer.json
