[NDH-692] Updating provider pk (#308)

* Updating provider pk

* cleaning up models.py

* one more cleanup

* update retrieve param naming for clarity

Author: spopelka-dsac

backend/app/tests/test_routing.py

@@ -77,5 +77,5 @@ def test_fhir_rest_routes_reverse_without_slash(self):
         endpoint_list_path = reverse("fhir-endpoint-list")
         self.assertEqual(endpoint_list_path, "/fhir/Endpoint")
 
-        endpoint_detail_path = reverse("fhir-endpoint-detail", kwargs={"pk": 12345})
+        endpoint_detail_path = reverse("fhir-endpoint-detail", kwargs={"id": 12345})
         self.assertEqual(endpoint_detail_path, "/fhir/Endpoint/12345")

backend/npdfhir/models.py

@@ -645,8 +645,8 @@ class Meta:
 
 
 class Provider(models.Model):
-    npi = models.OneToOneField(Npi, models.DO_NOTHING, db_column="npi", primary_key=True)
-    individual = models.OneToOneField(Individual, models.DO_NOTHING, blank=True, null=True)
+    npi = models.OneToOneField(Npi, models.DO_NOTHING, db_column="npi")
+    individual = models.OneToOneField(Individual, models.DO_NOTHING, primary_key=True)
 
     class Meta:
         managed = False
@@ -655,7 +655,7 @@ class Meta:
 
 class ProviderEducation(models.Model):
     pk = models.CompositePrimaryKey("npi", "school_id")
-    npi = models.ForeignKey(Provider, models.DO_NOTHING, db_column="npi")
+    npi = models.ForeignKey(Provider, models.DO_NOTHING, db_column="npi", to_field="npi")
     school_id = models.IntegerField()
     degree_type = models.ForeignKey(DegreeType, models.DO_NOTHING)
     start_date = models.DateField(blank=True, null=True)
@@ -711,7 +711,7 @@ class Meta:
 
 
 class ProviderToOrganization(models.Model):
-    individual = models.ForeignKey(Provider, models.DO_NOTHING, to_field="individual_id")
+    individual = models.ForeignKey(Provider, models.DO_NOTHING)
     organization = models.ForeignKey(Organization, models.DO_NOTHING)
     relationship_type = models.ForeignKey("RelationshipType", models.DO_NOTHING)
     id = models.UUIDField(primary_key=True)
@@ -725,7 +725,7 @@ class Meta:
 
 class ProviderToOtherId(models.Model):
     pk = models.CompositePrimaryKey("npi", "other_id", "other_id_type_id", "issuer", "state_code")
-    npi = models.ForeignKey(Provider, models.DO_NOTHING, db_column="npi")
+    npi = models.ForeignKey(Provider, models.DO_NOTHING, db_column="npi", to_field="npi")
     other_id = models.CharField(max_length=100)
     other_id_type = models.ForeignKey(OtherIdType, models.DO_NOTHING)
     state_code = models.ForeignKey(FipsState, models.DO_NOTHING, db_column="state_code")
@@ -737,7 +737,7 @@ class Meta:
 
 
 class ProviderToTaxonomy(models.Model):
-    npi = models.ForeignKey(Provider, models.DO_NOTHING, db_column="npi")
+    npi = models.ForeignKey(Provider, models.DO_NOTHING, db_column="npi", to_field="npi")
     nucc_code = models.ForeignKey(Nucc, models.DO_NOTHING, db_column="nucc_code")
     is_primary = models.BooleanField(blank=True, null=True)
     id = models.UUIDField(primary_key=True)

backend/npdfhir/serializers.py

@@ -707,7 +707,7 @@ def to_representation(self, instance):
             resource_type = resource["resourceType"]
             id = resource["id"]
             url_name = f"fhir-{resource_type.lower()}-detail"
-            full_url = request.build_absolute_uri(reverse(url_name, kwargs={"pk": id}))
+            full_url = request.build_absolute_uri(reverse(url_name, kwargs={"id": id}))
             # Create an entry for this resource
             entry = {
                 "fullUrl": full_url,

backend/npdfhir/tests/fixtures.py

@@ -75,8 +75,10 @@ def create_practitioner(
             individual=individual, address=location.address, address_use=use
         )
 
+    npi_value = npi_value or random.randint(1000000000, 9999999999)
+
     npi = Npi.objects.create(
-        npi=npi_value or int(str(uuid.uuid4().int)[:10]),
+        npi=npi_value,
         entity_type_code=1,
         enumeration_date=datetime.date(2000, 1, 1),
         last_update_date=datetime.date(2020, 1, 1),

backend/npdfhir/utils.py

@@ -27,7 +27,7 @@ def get_schema_data(request):
 
 
 def genReference(url_name, identifier, request):
-    reference = request.build_absolute_uri(reverse(url_name, kwargs={"pk": identifier}))
+    reference = request.build_absolute_uri(reverse(url_name, kwargs={"id": identifier}))
     reference = Reference(reference=reference)
     return reference
 

backend/npdfhir/views.py

@@ -72,6 +72,7 @@ class FHIREndpointViewSet(viewsets.GenericViewSet):
     ordering_fields = ["name", "address", "ehr_vendor_name"]
     pagination_class = CustomPaginator
     pagination_class = CustomPaginator
+    lookup_url_kwarg = "id"
 
     @extend_schema(
         responses={
@@ -117,15 +118,15 @@ def list(self, request):
             200: OpenApiResponse(description="Successfully retrieved FHIR Endpoint resource")
         }
     )
-    def retrieve(self, request, pk=None):
+    def retrieve(self, request, id=None):
         """
         Query a specific endpoint as a FHIR Endpoint resource
         """
 
         try:
-            UUID(pk)
+            UUID(id)
         except (ValueError, TypeError):
-            return HttpResponse(f"Endpoint {escape(pk)} not found", status=404)
+            return HttpResponse(f"Endpoint {escape(id)} not found", status=404)
 
         endpoint = get_object_or_404(
             EndpointInstance.objects.prefetch_related(
@@ -136,7 +137,7 @@ def retrieve(self, request, pk=None):
                 "endpointinstancetopayload_set__mime_type",
                 "endpointinstancetootherid_set",
             ),
-            pk=pk,
+            id=id,
         )
 
         serialized_endpoint = EndpointSerializer(endpoint, context={"request": request})
@@ -160,6 +161,7 @@ class FHIRPractitionerViewSet(viewsets.GenericViewSet):
     filter_backends = [DjangoFilterBackend, SearchFilter, ParamOrderingFilter]
     filterset_class = PractitionerFilterSet
     pagination_class = CustomPaginator
+    lookup_url_kwarg = "id"
 
     ordering_fields = [
         "individual__individualtoname__last_name",
@@ -217,14 +219,14 @@ def list(self, request):
             200: OpenApiResponse(description="Successfully retrieved FHIR Practitioner resource")
         }
     )
-    def retrieve(self, request, pk=None):
+    def retrieve(self, request, id=None):
         """
         Query a specific provider as a FHIR Practitioner resource
         """
         try:
-            UUID(pk)
+            UUID(id)
         except (ValueError, TypeError):
-            return HttpResponse(f"Practitioner {escape(pk)} not found", status=404)
+            return HttpResponse(f"Practitioner {escape(id)} not found", status=404)
 
         provider = get_object_or_404(
             Provider.objects.prefetch_related(
@@ -240,7 +242,7 @@ def retrieve(self, request, pk=None):
                 "providertootherid_set",
                 "providertotaxonomy_set",
             ),
-            individual_id=pk,
+            individual_id=id,
         )
 
         serialized_practitioner = PractitionerSerializer(provider)
@@ -264,6 +266,7 @@ class FHIRPractitionerRoleViewSet(viewsets.GenericViewSet):
     filter_backends = [DjangoFilterBackend, SearchFilter, ParamOrderingFilter]
     filterset_class = PractitionerRoleFilterSet
     pagination_class = CustomPaginator
+    lookup_url_kwarg = "id"
 
     ordering_fields = ["location__name", "practitioner_first_name", "practitioner_last_name"]
 
@@ -308,16 +311,16 @@ def list(self, request):
             )
         }
     )
-    def retrieve(self, request, pk=None):
+    def retrieve(self, request, id=None):
         """
         Query a specific relationship between providers, healthcare organizations, and practice locations, represented as a FHIR PractitionerRole resource
         """
         try:
-            UUID(pk)
+            UUID(id)
         except (ValueError, TypeError):
-            return HttpResponse(f"PractitionerRole {escape(pk)} not found", status=404)
+            return HttpResponse(f"PractitionerRole {escape(id)} not found", status=404)
 
-        practitionerrole = get_object_or_404(ProviderToLocation, pk=pk)
+        practitionerrole = get_object_or_404(ProviderToLocation, id=id)
 
         serialized_practitionerrole = PractitionerRoleSerializer(
             practitionerrole, context={"request": request}
@@ -342,6 +345,7 @@ class FHIROrganizationViewSet(viewsets.GenericViewSet):
     filter_backends = [DjangoFilterBackend, SearchFilter, ParamOrderingFilter]
     filterset_class = OrganizationFilterSet
     pagination_class = CustomPaginator
+    lookup_url_kwarg = "id"
 
     ordering_fields = ["organizationtoname__name"]
 
@@ -403,14 +407,14 @@ def list(self, request):
             200: OpenApiResponse(description="Successfully retrieved FHIR Organization resource")
         }
     )
-    def retrieve(self, request, pk=None):
+    def retrieve(self, request, id=None):
         """
         Query a specific organization, represented as a FHIR Organization resource
         """
         try:
-            UUID(pk)
+            UUID(id)
         except (ValueError, TypeError):
-            return HttpResponse(f"Organization {escape(pk)} not found", status=404)
+            return HttpResponse(f"Organization {escape(id)} not found", status=404)
 
         organization = get_object_or_404(
             Organization.objects.prefetch_related(
@@ -435,7 +439,7 @@ def retrieve(self, request, pk=None):
                 "clinicalorganization__organizationtotaxonomy_set",
                 "clinicalorganization__organizationtotaxonomy_set__nucc_code",
             ),
-            pk=pk,
+            id=id,
         )
 
         serialized_organization = OrganizationSerializer(organization, context={"request": request})
@@ -459,6 +463,7 @@ class FHIRLocationViewSet(viewsets.GenericViewSet):
     filter_backends = [DjangoFilterBackend, SearchFilter, ParamOrderingFilter]
     filterset_class = LocationFilterSet
     pagination_class = CustomPaginator
+    lookup_url_kwarg = "id"
 
     ordering_fields = ["organization_name", "address_full", "name"]
 
@@ -516,16 +521,16 @@ def list(self, request):
             200: OpenApiResponse(description="Successfully retrieved FHIR Location resource")
         }
     )
-    def retrieve(self, request, pk=None):
+    def retrieve(self, request, id=None):
         """
         Query a specific healthcare practice location as a FHIR Location resource
         """
         try:
-            UUID(pk)
+            UUID(id)
         except (ValueError, TypeError):
-            return HttpResponse(f"Location {escape(pk)} not found", status=404)
+            return HttpResponse(f"Location {escape(id)} not found", status=404)
 
-        location = get_object_or_404(Location, pk=pk)
+        location = get_object_or_404(Location, id=id)
 
         serialized_location = LocationSerializer(location, context={"request": request})
 

flyway/sql/migrations/V15__provider_pk_change.sql

@@ -0,0 +1,11 @@
+-- DRF Spectacular documentation was reading from the model definition and not the API construction (indicating that Practitioners could be retrieved by NPI), so these migrations update the database to reflect the querying pattern in the API (Practitioners retrieved by individual_id)
+alter table npd.provider_education drop constraint fk_provider_education_npi;
+alter table npd.provider_to_other_id drop constraint fk_provider_to_other_id_npi;
+alter table npd.provider_to_taxonomy drop constraint fk_provider_to_taxonomy_npi;
+alter table npd.provider drop constraint pk_provider;
+alter table npd.provider alter column individual_id set not null;
+alter table npd.provider add constraint pk_provider primary key (individual_id);
+alter table npd.provider add constraint uc_provider_npi UNIQUE (npi);
+alter table npd.provider_education add constraint fk_provider_education_npi foreign key (npi) references npd.provider(npi);
+alter table npd.provider_to_other_id add constraint fk_provider_to_other_id_npi foreign key (npi) references npd.provider(npi);
+alter table npd.provider_to_taxonomy add constraint fk_provider_to_taxonomy_npi foreign key (npi) references npd.provider(npi);