BB2-3865: Added v3 urls and waffle switch (#1333)

loganbertram · web-flow · commit 00f75655bbed · 2025-05-21T10:15:34.000-04:00
* Added v3 urls and waffle switch

* Add flag to test flags. Add v3 language in routing

* Split version logic

* v3 and v2 as v2 for now

* Expanded scope definitions for v3

* Refactor version checks

* Live waffle switch
diff --git a/apps/accounts/fixtures/scopes.json b/apps/accounts/fixtures/scopes.json
@@ -15,7 +15,7 @@
             "slug": "patient/Patient.read",
             "group": 5,
             "description": "Patient FHIR Resource",
-            "protected_resources": "[\n  [\n    \"GET\",\n   \"/v[12]/fhir/Patient[/]?$\"\n  ],\n [\n    \"GET\",\n   \"/v[12]/fhir/Patient[/?].*$\"\n  ]\n]",
+            "protected_resources": "[\n  [\n    \"GET\",\n   \"/v[123]/fhir/Patient[/]?$\"\n  ],\n [\n    \"GET\",\n   \"/v[123]/fhir/Patient[/?].*$\"\n  ]\n]",
             "default": "True"
         }
     },
@@ -27,7 +27,7 @@
             "slug": "profile",
             "group": 5,
             "description": "OIDC userinfo endpoint /connect/userinfo",
-            "protected_resources": "[\n  [\n    \"GET\",\n    \"/v[12]/connect/userinfo.*$\"\n  ]\n]",
+            "protected_resources": "[\n  [\n    \"GET\",\n    \"/v[123]/connect/userinfo.*$\"\n  ]\n]",
             "default": "True"
         }
     },
@@ -39,7 +39,7 @@
             "slug": "patient/ExplanationOfBenefit.read",
             "group": 5,
             "description": "ExplanationOfBenefit FHIR Resource",
-            "protected_resources": "[\n  [\n    \"GET\",\n   \"/v[12]/fhir/ExplanationOfBenefit[/]?$\"\n  ],\n  [\n    \"GET\",\n   \"/v[12]/fhir/ExplanationOfBenefit[/?].*$\"\n  ]\n]",
+            "protected_resources": "[\n  [\n    \"GET\",\n   \"/v[123]/fhir/ExplanationOfBenefit[/]?$\"\n  ],\n  [\n    \"GET\",\n   \"/v[123]/fhir/ExplanationOfBenefit[/?].*$\"\n  ]\n]",
             "default": "True"
         }
     },
@@ -51,7 +51,7 @@
             "slug": "patient/Coverage.read",
             "group": 5,
             "description": "Coverage FHIR Resource",
-            "protected_resources": "[\n  [\n    \"GET\",\n   \"/v[12]/fhir/Coverage[/]?$\"\n  ],\n  [\n    \"GET\",\n   \"/v[12]/fhir/Coverage[/?].*$\"\n  ]\n]",
+            "protected_resources": "[\n  [\n    \"GET\",\n   \"/v[123]/fhir/Coverage[/]?$\"\n  ],\n  [\n    \"GET\",\n   \"/v[123]/fhir/Coverage[/?].*$\"\n  ]\n]",
             "default": "True"
         }
     },
@@ -75,7 +75,7 @@
             "slug": "token_introspect",
             "group": 5,
             "description": "Allow an app to introspect a user's tokens.",
-            "protected_resources": "[[\"POST\", \"/v[12]/o/introspect\"]]",
+            "protected_resources": "[[\"POST\", \"/v[123]/o/introspect\"]]",
             "default": "False"
         }
     },
@@ -99,7 +99,7 @@
             "slug": "patient/Patient.r",
             "group": 5,
             "description": "Patient FHIR Resource",
-            "protected_resources": "[\n \n [\n    \"GET\",\n   \"/v[12]/fhir/Patient[/?].*$\"\n  ]\n]",
+            "protected_resources": "[\n \n [\n    \"GET\",\n   \"/v[123]/fhir/Patient[/?].*$\"\n  ]\n]",
             "default": "True"
         }
     },
@@ -111,7 +111,7 @@
             "slug": "patient/Patient.s",
             "group": 5,
             "description": "Patient FHIR Resource",
-            "protected_resources": "[\n  [\n    \"GET\",\n   \"/v[12]/fhir/Patient[/]?$\"\n  ]\n]",
+            "protected_resources": "[\n  [\n    \"GET\",\n   \"/v[123]/fhir/Patient[/]?$\"\n  ]\n]",
             "default": "True"
         }
     },
@@ -123,7 +123,7 @@
             "slug": "patient/Patient.rs",
             "group": 5,
             "description": "Patient FHIR Resource",
-            "protected_resources": "[\n  [\n    \"GET\",\n   \"/v[12]/fhir/Patient[/]?$\"\n  ],\n [\n    \"GET\",\n   \"/v[12]/fhir/Patient[/?].*$\"\n  ]\n]",
+            "protected_resources": "[\n  [\n    \"GET\",\n   \"/v[123]/fhir/Patient[/]?$\"\n  ],\n [\n    \"GET\",\n   \"/v[123]/fhir/Patient[/?].*$\"\n  ]\n]",
             "default": "True"
         }
     },
@@ -135,7 +135,7 @@
             "slug": "patient/ExplanationOfBenefit.r",
             "group": 5,
             "description": "ExplanationOfBenefit FHIR Resource",
-            "protected_resources": "[\n \n [\n    \"GET\",\n   \"/v[12]/fhir/ExplanationOfBenefit[/?].*$\"\n  ]\n]",
+            "protected_resources": "[\n \n [\n    \"GET\",\n   \"/v[123]/fhir/ExplanationOfBenefit[/?].*$\"\n  ]\n]",
             "default": "True"
         }
     },
@@ -147,7 +147,7 @@
             "slug": "patient/ExplanationOfBenefit.s",
             "group": 5,
             "description": "ExplanationOfBenefit FHIR Resource",
-            "protected_resources": "[\n  [\n    \"GET\",\n   \"/v[12]/fhir/ExplanationOfBenefit[/]?$\"\n  ]\n]",
+            "protected_resources": "[\n  [\n    \"GET\",\n   \"/v[123]/fhir/ExplanationOfBenefit[/]?$\"\n  ]\n]",
             "default": "True"
         }
     },
@@ -159,7 +159,7 @@
             "slug": "patient/ExplanationOfBenefit.rs",
             "group": 5,
             "description": "ExplanationOfBenefit FHIR Resource",
-            "protected_resources": "[\n  [\n    \"GET\",\n   \"/v[12]/fhir/ExplanationOfBenefit[/]?$\"\n  ],\n  [\n    \"GET\",\n   \"/v[12]/fhir/ExplanationOfBenefit[/?].*$\"\n  ]\n]",
+            "protected_resources": "[\n  [\n    \"GET\",\n   \"/v[123]/fhir/ExplanationOfBenefit[/]?$\"\n  ],\n  [\n    \"GET\",\n   \"/v[123]/fhir/ExplanationOfBenefit[/?].*$\"\n  ]\n]",
             "default": "True"
         }
     },
@@ -171,7 +171,7 @@
             "slug": "patient/Coverage.r",
             "group": 5,
             "description": "Coverage FHIR Resource",
-            "protected_resources": "[\n \n [\n    \"GET\",\n   \"/v[12]/fhir/Coverage[/?].*$\"\n  ]\n]",
+            "protected_resources": "[\n \n [\n    \"GET\",\n   \"/v[123]/fhir/Coverage[/?].*$\"\n  ]\n]",
             "default": "True"
         }
     },
@@ -183,7 +183,7 @@
             "slug": "patient/Coverage.s",
             "group": 5,
             "description": "Coverage FHIR Resource",
-            "protected_resources": "[\n  [\n    \"GET\",\n   \"/v[12]/fhir/Coverage[/]?$\"\n  ]\n]",
+            "protected_resources": "[\n  [\n    \"GET\",\n   \"/v[123]/fhir/Coverage[/]?$\"\n  ]\n]",
             "default": "True"
         }
     },
@@ -195,7 +195,7 @@
             "slug": "patient/Coverage.rs",
             "group": 5,
             "description": "Coverage FHIR Resource",
-            "protected_resources": "[\n  [\n    \"GET\",\n   \"/v[12]/fhir/Coverage[/]?$\"\n  ],\n  [\n    \"GET\",\n   \"/v[12]/fhir/Coverage[/?].*$\"\n  ]\n]",
+            "protected_resources": "[\n  [\n    \"GET\",\n   \"/v[123]/fhir/Coverage[/]?$\"\n  ],\n  [\n    \"GET\",\n   \"/v[123]/fhir/Coverage[/?].*$\"\n  ]\n]",
             "default": "True"
         }
     },
diff --git a/apps/capabilities/management/commands/create_blue_button_scopes.py b/apps/capabilities/management/commands/create_blue_button_scopes.py
@@ -11,7 +11,7 @@
 
 logger = logging.getLogger(bb2logging.HHS_SERVER_LOGNAME_FMT.format(__name__))
 
-fhir_prefix = "/v[12]/fhir/"
+fhir_prefix = "/v[123]/fhir/"
 
 
 def create_group(name="BlueButton"):
diff --git a/apps/core/management/commands/create_test_feature_switches.py b/apps/core/management/commands/create_test_feature_switches.py
@@ -16,6 +16,7 @@
     ("splunk_monitor", False, "This is used in other environments to ensure splunk forwarder is running."),
     ("testclient_v2", True, "This enables the v2 auth links in the test client"),
     ("wellknown_applications", True, "This enables the /.well-known/applications end-point. Active in prod, but not in sbx/test."),
+    ("v3_endpoints", True, "This enables v3 endpoints."),
     ("bfd_v3_connectathon", True, "This enables the bfd v3 features for connectathon demo"),
 )
 
diff --git a/apps/fhir/bluebutton/v3/urls.py b/apps/fhir/bluebutton/v3/urls.py
@@ -0,0 +1,55 @@
+from django.urls import re_path
+from django.contrib import admin
+from waffle.decorators import waffle_switch
+
+from apps.fhir.bluebutton.views.read import (
+    ReadViewCoverage,
+    ReadViewExplanationOfBenefit,
+    ReadViewPatient,
+)
+from apps.fhir.bluebutton.views.search import (
+    SearchViewCoverage,
+    SearchViewExplanationOfBenefit,
+    SearchViewPatient,
+)
+
+admin.autodiscover()
+
+urlpatterns = [
+    # Patient ReadView
+    re_path(
+        r"Patient/(?P<resource_id>[^/]+)",
+        waffle_switch("v3_endpoints")(ReadViewPatient.as_view(version=3)),
+        name="bb_oauth_fhir_patient_read_or_update_or_delete_v3",
+    ),
+    # Patient SearchView
+    re_path(
+        r"Patient[/]?",
+        waffle_switch("v3_endpoints")(SearchViewPatient.as_view(version=3)),
+        name="bb_oauth_fhir_patient_search_v3",
+    ),
+    # Coverage ReadView
+    re_path(
+        r"Coverage/(?P<resource_id>[^/]+)",
+        waffle_switch("v3_endpoints")(ReadViewCoverage.as_view(version=3)),
+        name="bb_oauth_fhir_coverage_read_or_update_or_delete_v3",
+    ),
+    # Coverage SearchView
+    re_path(
+        r"Coverage[/]?",
+        waffle_switch("v3_endpoints")(SearchViewCoverage.as_view(version=3)),
+        name="bb_oauth_fhir_coverage_search_v3",
+    ),
+    # EOB ReadView
+    re_path(
+        r"ExplanationOfBenefit/(?P<resource_id>[^/]+)",
+        waffle_switch("v3_endpoints")(ReadViewExplanationOfBenefit.as_view(version=3)),
+        name="bb_oauth_fhir_eob_read_or_update_or_delete_v3",
+    ),
+    # EOB SearchView
+    re_path(
+        r"ExplanationOfBenefit[/]?",
+        waffle_switch("v3_endpoints")(SearchViewExplanationOfBenefit.as_view(version=3)),
+        name="bb_oauth_fhir_eob_search_v3",
+    ),
+]
diff --git a/apps/fhir/bluebutton/views/generic.py b/apps/fhir/bluebutton/views/generic.py
@@ -151,16 +151,28 @@ def fetch_data(self, request, resource_type, *args, **kwargs):
                 req.headers["BlueButton-Application"] = quote(req.headers.get("BlueButton-Application"))
 
         prepped = s.prepare_request(req)
+
+        if self.version == 1:
+            api_ver_str = 'v1'
+        elif self.version == 2:
+            api_ver_str = 'v2'
+        # v3 uses v2 for now
+        elif self.version == 3:
+            api_ver_str = 'v2'
+        # defaults to v3
+        else:
+            logger.debug('Unexpected version number %d, defaulting to v2' % self.version)
+            api_ver_str = 'v2'
+
         # Send signal
-        pre_fetch.send_robust(FhirDataView, request=req, auth_request=request, api_ver='v2' if self.version == 2 else 'v1')
+        pre_fetch.send_robust(FhirDataView, request=req, auth_request=request, api_ver=api_ver_str)
         r = s.send(
             prepped,
             cert=backend_connection.certs(crosswalk=request.crosswalk),
             timeout=resource_router.wait_time,
             verify=FhirServerVerify(crosswalk=request.crosswalk))
         # Send signal
-        post_fetch.send_robust(FhirDataView, request=prepped, auth_request=request,
-                               response=r, api_ver='v2' if self.version == 2 else 'v1')
+        post_fetch.send_robust(FhirDataView, request=prepped, auth_request=request, response=r, api_ver=api_ver_str)
         response = build_fhir_response(request._request, target_url, request.crosswalk, r=r, e=None)
 
         # BB2-128
diff --git a/hhs_oauth_server/urls.py b/hhs_oauth_server/urls.py
@@ -4,6 +4,7 @@
 from rest_framework import status
 from django.urls import include, path, re_path
 from django.contrib import admin
+
 from apps.accounts.views.oauth2_profile import openidconnect_userinfo
 from apps.fhir.bluebutton.views.home import fhir_conformance, fhir_conformance_v2
 from apps.wellknown.views.openid import smart_configuration
@@ -37,6 +38,7 @@
     path("v2/fhir/.well-known/smart-configuration", smart_configuration, name="smart_configuration"),
     path("v2/fhir/metadata", fhir_conformance_v2, name="fhir_conformance_metadata_v2"),
     path("v2/fhir/", include("apps.fhir.bluebutton.v2.urls")),
+    path("v3/fhir/", include("apps.fhir.bluebutton.v3.urls")),
     path("v2/o/", include("apps.dot_ext.v2.urls")),
     path("v2/o/", include("apps.authorization.v2.urls")),
     path("docs/", include("apps.docs.urls")),
@@ -46,6 +48,7 @@
     path("akamai/testobject", testobject, name="akamai_testobject"),
 ]
 
+
 # If running in local development, add the media and static urls:
 if settings.IS_MEDIA_URL_LOCAL is True:
     urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@`
`16`	`16`	`("splunk_monitor", False, "This is used in other environments to ensure splunk forwarder is running."),`
`17`	`17`	`("testclient_v2", True, "This enables the v2 auth links in the test client"),`
`18`	`18`	`("wellknown_applications", True, "This enables the /.well-known/applications end-point. Active in prod, but not in sbx/test."),`
	`19`	`+ ("v3_endpoints", True, "This enables v3 endpoints."),`
`19`	`20`	`("bfd_v3_connectathon", True, "This enables the bfd v3 features for connectathon demo"),`
`20`	`21`	`)`
`21`	`22`