Add provider's phone number to VAOS EPS appointment response (#21311)

Author: carlosfelix2

modules/vaos/app/controllers/vaos/v2/eps_appointments_controller.rb

@@ -11,21 +11,51 @@ def show
 
         raise Common::Exceptions::RecordNotFound, message: 'Record not found' if appointment[:state] == 'draft'
 
-        response = OpenStruct.new({
-                                    id: appointment[:id],
-                                    appointment:,
-                                    provider: unless appointment[:provider_service_id].nil?
-                                                provider_service.get_provider_service(
-                                                  provider_id: appointment[:provider_service_id]
-                                                )
-                                              end
-                                  })
+        referral_detail = fetch_referral_detail(appointment)
+        provider = fetch_provider(appointment)
+        enriched_provider = Eps::EnrichedProvider.from_referral(provider, referral_detail)
+
+        response = OpenStruct.new(
+          id: appointment[:id],
+          appointment:,
+          provider: enriched_provider
+        )
 
         render json: Eps::EpsAppointmentSerializer.new(response)
       end
 
       private
 
+      ##
+      # Retrieves referral details from CCRA service for the given appointment if a referral number is present.
+      #
+      # @param appointment [Hash] The appointment data containing referral information
+      # @return [Ccra::ReferralDetail, nil] The referral details if found, nil otherwise
+      def fetch_referral_detail(appointment)
+        referral_number = appointment.dig(:referral, :referral_number)
+        return nil if referral_number.blank?
+
+        begin
+          # TODO: Need correct mode parameter, this one is hard-coded based on examples
+          ccra_referral_service.get_referral(referral_number, '2')
+        rescue => e
+          Rails.logger.error "Failed to retrieve referral details: #{e.message}"
+          nil
+        end
+      end
+
+      ##
+      # Fetches provider information for the given appointment.
+      #
+      # @param appointment [Hash] The appointment data containing provider service ID
+      # @return [Object, nil] Provider object or nil if no provider ID is found
+      def fetch_provider(appointment)
+        provider_id = appointment[:provider_service_id]
+        return nil if provider_id.nil?
+
+        provider_service.get_provider_service(provider_id:)
+      end
+
       def eps_appointment_id
         params.require(:id)
       end
@@ -42,6 +72,10 @@ def appointment_service
         @appointment_service ||= Eps::AppointmentService.new(current_user)
       end
 
+      def ccra_referral_service
+        @ccra_referral_service ||= Ccra::ReferralService.new(current_user)
+      end
+
       def provider
         provider_service.get_provider_service(provider_id: params[:provider_id])
       end

modules/vaos/app/models/ccra/referral_detail.rb

@@ -4,7 +4,7 @@ module Ccra
   # ReferralDetail represents the detailed information for a single referral from CCRA.
   class ReferralDetail
     attr_reader :expiration_date, :type_of_care, :provider_name, :location,
-                :referral_number
+                :referral_number, :phone_number
 
     ##
     # Initializes a new instance of ReferralDetail.
@@ -20,6 +20,7 @@ def initialize(attributes)
       @provider_name = referral['TreatingProvider']
       @location = referral['TreatingFacility']
       @referral_number = referral['ReferralNumber']
+      @phone_number = referral['ProviderPhone'] || referral['FacilityPhone']
     end
   end
 end

modules/vaos/app/models/eps/enriched_provider.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Eps
+  # Enriches provider data with additional information from referrals
+  class EnrichedProvider
+    # Creates a provider object enriched with referral information
+    #
+    # @param provider [Object] The base provider object to enrich
+    # @param referral_detail [Ccra::ReferralDetail, nil] Optional referral details to merge
+    # @return [OpenStruct] Enhanced provider with referral information
+    def self.from_referral(provider, referral_detail)
+      return provider if provider.nil? || referral_detail&.phone_number.blank?
+
+      enriched_data = provider.to_h
+      enriched_data[:phone_number] = referral_detail.phone_number
+      OpenStruct.new(enriched_data)
+    end
+  end
+end

modules/vaos/app/serializers/eps/eps_appointment_serializer.rb

@@ -25,8 +25,9 @@ class EpsAppointmentSerializer
         appointment_types: object.provider.appointment_types,
         specialties: object.provider.specialties,
         visit_mode: object.provider.visit_mode,
-        features: object.provider.features
-      }
+        features: object.provider.features,
+        phone_number: object.provider.phone_number
+      }.compact
     end
   end
 end

modules/vaos/spec/factories/ccra/referrals.rb

@@ -24,6 +24,7 @@
     location { 'VA Medical Center' }
     referral_number { 'VA0000005681' }
     expiration_date { '2024-05-27' }
+    phone_number { '555-123-4567' }
 
     initialize_with do
       attributes = {
@@ -32,7 +33,8 @@
           'TreatingProvider' => provider_name,
           'TreatingFacility' => location,
           'ReferralNumber' => referral_number,
-          'ReferralExpirationDate' => expiration_date
+          'ReferralExpirationDate' => expiration_date,
+          'ProviderPhone' => phone_number
         }
       }
       Ccra::ReferralDetail.new(attributes)

modules/vaos/spec/models/ccra/referral_detail_spec.rb

@@ -13,7 +13,8 @@
           'CategoryOfCare' => 'CARDIOLOGY',
           'TreatingProvider' => 'Dr. Smith',
           'TreatingFacility' => 'VA Medical Center',
-          'ReferralNumber' => 'VA0000005681'
+          'ReferralNumber' => 'VA0000005681',
+          'ProviderPhone' => '555-123-4567'
         }
       }
     end
@@ -24,6 +25,48 @@
       expect(subject.provider_name).to eq('Dr. Smith')
       expect(subject.location).to eq('VA Medical Center')
       expect(subject.referral_number).to eq('VA0000005681')
+      expect(subject.phone_number).to eq('555-123-4567')
+    end
+
+    context 'with facility phone instead of provider phone' do
+      let(:attributes_with_facility_phone) do
+        {
+          'Referral' => {
+            'ReferralExpirationDate' => '2024-05-27',
+            'CategoryOfCare' => 'CARDIOLOGY',
+            'TreatingProvider' => 'Dr. Smith',
+            'TreatingFacility' => 'VA Medical Center',
+            'ReferralNumber' => 'VA0000005681',
+            'FacilityPhone' => '555-987-6543'
+          }
+        }
+      end
+
+      it 'uses facility phone when provider phone is not available' do
+        detail = described_class.new(attributes_with_facility_phone)
+        expect(detail.phone_number).to eq('555-987-6543')
+      end
+    end
+
+    context 'with both provider and facility phone' do
+      let(:attributes_with_both_phones) do
+        {
+          'Referral' => {
+            'ReferralExpirationDate' => '2024-05-27',
+            'CategoryOfCare' => 'CARDIOLOGY',
+            'TreatingProvider' => 'Dr. Smith',
+            'TreatingFacility' => 'VA Medical Center',
+            'ReferralNumber' => 'VA0000005681',
+            'ProviderPhone' => '555-123-4567',
+            'FacilityPhone' => '555-987-6543'
+          }
+        }
+      end
+
+      it 'prefers provider phone over facility phone' do
+        detail = described_class.new(attributes_with_both_phones)
+        expect(detail.phone_number).to eq('555-123-4567')
+      end
     end
 
     context 'with missing Referral key' do
@@ -39,6 +82,7 @@
         expect(subject.provider_name).to be_nil
         expect(subject.location).to be_nil
         expect(subject.referral_number).to be_nil
+        expect(subject.phone_number).to be_nil
       end
     end
 
@@ -55,6 +99,7 @@
         expect(subject.provider_name).to be_nil
         expect(subject.location).to be_nil
         expect(subject.referral_number).to be_nil
+        expect(subject.phone_number).to be_nil
       end
     end
   end

modules/vaos/spec/models/eps/enriched_provider_spec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe Eps::EnrichedProvider do
+  describe '.from_referral' do
+    let(:provider) do
+      OpenStruct.new(
+        id: 'test-id',
+        name: 'Test Provider'
+      )
+    end
+
+    context 'when referral_detail has a phone number' do
+      let(:phone_number) { '555-123-4567' }
+      let(:referral_detail) { build(:ccra_referral_detail, phone_number:) }
+
+      it 'adds the phone number to the provider' do
+        result = described_class.from_referral(provider, referral_detail)
+        expect(result.id).to eq(provider.id)
+        expect(result.name).to eq(provider.name)
+        expect(result.phone_number).to eq(phone_number)
+      end
+    end
+
+    context 'when referral_detail has no phone number' do
+      let(:referral_detail) { build(:ccra_referral_detail, phone_number: nil) }
+
+      it 'returns the original provider' do
+        result = described_class.from_referral(provider, referral_detail)
+        expect(result).to be(provider)
+        expect(result.respond_to?(:phone_number)).to be false
+      end
+    end
+
+    context 'when referral_detail is nil' do
+      it 'returns the original provider' do
+        result = described_class.from_referral(provider, nil)
+        expect(result).to be(provider)
+        expect(result.respond_to?(:phone_number)).to be false
+      end
+    end
+
+    context 'when provider is nil' do
+      it 'returns nil' do
+        result = described_class.from_referral(nil, build(:ccra_referral_detail, phone_number: '555-555-5555'))
+        expect(result).to be_nil
+      end
+    end
+  end
+end