docs: explain which resources are completion tracked (#332)

smart-on-fhir · Jan 6, 2025 · 8fae5f3 · 8fae5f3
1 parent 941efe3
commit 8fae5f3
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 3 deletions.
diff --git a/cumulus_library/__init__.py b/cumulus_library/__init__.py
@@ -6,4 +6,4 @@
 from cumulus_library.study_manifest import StudyManifest
 
 __all__ = ["BaseTableBuilder", "CountsBuilder", "StudyConfig", "StudyManifest"]
-__version__ = "4.1.3"
+__version__ = "4.2.0"
diff --git a/cumulus_library/studies/core/core_templates/completion_utils.jinja b/cumulus_library/studies/core/core_templates/completion_utils.jinja
@@ -39,6 +39,7 @@ in this table.
         SELECT
             ece.encounter_id,
             (
+                -- Every time you add a resource here, update core-study-details.md
                 BOOL_OR(ec.table_name = 'allergyintolerance')
                 AND BOOL_OR(ec.table_name = 'condition')
                 AND BOOL_OR(ec.table_name = 'diagnosticreport')

diff --git a/docs/core-study-details.md b/docs/core-study-details.md
@@ -56,8 +56,15 @@ that encounter is considered "incomplete" and may be left out of the core tables
 You can see which encounters were ignored as incomplete by examining the
 `core__incomplete_encounters` table which holds the ID of all incomplete encounters.
 
-Usually, you can resolve this by running the ETL process again for the encounters,
-making sure to include all associated resources.
+Usually, you can resolve this by making sure you've run the ETL process
+for each of the following encounter-linked resources:
+- AllergyIntolerance
+- Condition
+- DiagnosticReport
+- DocumentReference
+- MedicationRequest
+- Observation
+- Procedure
 
 ## Optional fields