Swagger Updates for new fields on latest supp claims form (#20723)

* Swagger Updates

* Allow no treatment end date with unit tests.

Author: michelpmcdonald

modules/appeals_api/app/models/appeals_api/supplemental_claim.rb

@@ -174,6 +174,10 @@ def benefit_type
       data_attributes['benefitType']&.strip
     end
 
+    def mst_disclosure
+      data_attributes['mstUpcomingEventDisclosure']&.strip
+    end
+
     def claimant_type
       data_attributes['claimantType']&.strip
     end

modules/appeals_api/app/models/concerns/appeals_api/model_validations.rb

@@ -102,6 +102,10 @@ def validate_retrieve_from_date_range
             start_date_str = evidence_date['startDate']
             end_date_str = evidence_date['endDate']
 
+            # End date is no longer required on what we are calling the v4 version(Expiration Date: 05/31/2027)
+            # of the Supp claim form, so if it's not provided, don't validate the range
+            next if end_date_str.nil?
+
             start_date = Date.parse(start_date_str)
             end_date = Date.parse(end_date_str)
 

modules/appeals_api/app/services/appeals_api/pdf_construction/supplemental_claim/v4/form_data.rb

@@ -8,7 +8,6 @@ module SupplementalClaim
       module V4
         class FormData
           BENEFIT_TYPE_CODES = {
-
             'education' => 1,
             'veteranReadinessAndEmployment' => 2,
             'pensionSurvivorsBenefits' => 3,
@@ -47,6 +46,13 @@ class FormData
             'OTHER'
           ].freeze
 
+          MST_EVENT_DISCLOSURE = {
+            'I CONSENT' => 4,
+            'I DO NOT CONSENT' => 1,
+            'I REVOKE PRIOR CONSENT' => 3,
+            'NOT APPLICABLE AND/OR NOT ENROLLED IN VHA HEALTHCARE' => 2
+          }.freeze
+
           LONG_SIGNATURE_THRESHOLD = 70
           LONG_EMAIL_THRESHOLD = 120
           MAX_SIGNATURE_LENGTH = 180
@@ -76,6 +82,10 @@ def benefit_type_code
             BENEFIT_TYPE_CODES[supplemental_claim.benefit_type]
           end
 
+          def mst_disclosure_code
+            MST_EVENT_DISCLOSURE[supplemental_claim.mst_disclosure]
+          end
+
           def claimant_type_code
             CLAIMANT_TYPE_CODES[supplemental_claim.claimant_type]
           end

modules/appeals_api/app/services/appeals_api/pdf_construction/supplemental_claim/v4/form_fields.rb

@@ -43,6 +43,8 @@ class FormFields
             treatment_location_other: 'form1[0].#subform[5].Other_Specify[0]',
             treatment_location_other_details: 'form1[0].#subform[5].OTHER_Specify[2]',
 
+            mst_disclosure_code: 'form1[0].#subform[5].RadioButtonList[3]',
+
             evidence_submission_1_no_treatment_date: 'form1[0].#subform[5].Check_Box_Do_Not_Have_Date_s[0]',
             evidence_submission_2_no_treatment_date: 'form1[0].#subform[5].Check_Box_Do_Not_Have_Date_s[1]',
             evidence_submission_3_no_treatment_date: 'form1[0].#subform[5].Check_Box_Do_Not_Have_Date_s[2]',

modules/appeals_api/app/swagger/decision_reviews/v2/swagger.json

@@ -76,8 +76,12 @@
                     "nationalCemeteryAdministration"
                   ]
                 },
-                "homeless": { "type": "boolean" },
+                "homeless": { 
+                  "type": "boolean",
+                  "description": "Indicates if the claimant is currently homeless or at risk of becoming homeless." 
+                },
                 "homelessLivingSituation": {
+                  "description": "Claimant's current living situation; provide all that apply. For Other: 'A living situation not described by the previous options.'",
                   "type": "array", 
                   "items": {
                     "type": "string",
@@ -92,14 +96,33 @@
                     ]
                   }
                 },
-                "homelessLivingSituationOther": {"type":  "string", "maxLength": 100 },
-                "homelessPointOfContact": {"type":  "string", "maxLength": 150 },
+                "homelessLivingSituationOther": {
+                  "description": "Details for homeless living situation other",
+                  "type":  "string", 
+                  "maxLength": 100
+                },
+                "homelessPointOfContact": {
+                  "description": "The name of a contact that can be used by VA in order to get in touch with a homeless claimant.",
+                  "type":  "string", 
+                  "maxLength": 150 
+                },
                 "homelessPointOfContactPhone": {
+                  "description": "Phone number for the Claimant's point of contact in order to get in touch with a homeless claimant.",
                   "allOf": [
                     { "$ref": "#/definitions/phone" },
                     { "$comment": "the phone fields must not exceed 20 chars, when concatenated" }
                   ]
                 },
+                "mstUpcomingEventDisclosure": {
+                  "description": "Allows the Claimant to indicate their consent for VBA to communicate with VHA regarding upcoming events related to the appeals process.",
+                  "type": "string",
+                  "enum": [ 
+                    "I CONSENT",
+                    "I DO NOT CONSENT",
+                    "I REVOKE PRIOR CONSENT",
+                    "NOT APPLICABLE AND/OR NOT ENROLLED IN VHA HEALTHCARE"
+                  ]
+                },
                 "claimantType": {"type": "string", "enum": [ "veteran", "spouse_of_veteran", "child_of_veteran", "parent_of_veteran", "other"] },
                 "claimantTypeOtherValue": { "type":  "string", "minLength": 1, "maxLength": 25 },
                 "veteran": {
@@ -150,7 +173,7 @@
                   "properties": {
                     "treatmentLocations":{
                       "type": "array",
-                      "description": "Identify where you have received treatment",
+                      "description": "Claimant’s treatment locations; provide all that apply. For Other: 'A treatment location not described by the previous options.'",
                       "items": { 
                         "type": "string",
                         "enum": [
@@ -162,7 +185,10 @@
                           "OTHER"
                         ]
                       },
-                      "treatment_location_other": {"type":  "string", "maxLength": 115 }
+                      "treatmentLocationOther": {
+                        "description": "Details for treatment location other",
+                        "type":  "string", 
+                        "maxLength": 115 }
                     },
                     "evidenceType":{
                       "type": "array",
@@ -200,7 +226,6 @@
                                 "type": "boolean", 
                                 "description": "Don't have treatment date"
                               }
-                  
                             },
                             "required": [ "locationAndName" ]
                           }

modules/appeals_api/app/swagger/decision_reviews/v2/swagger_dev.json

@@ -26,7 +26,12 @@ def dates_month_format
       return [''] if evidence_dates.blank?
 
       evidence_dates.map do |hash|
-        "#{Date.parse(hash['startDate']).strftime('%m-%Y')} to #{Date.parse(hash['endDate']).strftime('%m-%Y')}"
+        # end date is not required for the month format
+        if hash['endDate'].nil?
+          Date.parse(hash['startDate']).strftime('%m-%Y')
+        else
+          "#{Date.parse(hash['startDate']).strftime('%m-%Y')} to #{Date.parse(hash['endDate']).strftime('%m-%Y')}"
+        end
       end
     end
 

modules/appeals_api/config/schemas/decision_reviews/v2/200995.json

@@ -35,6 +35,17 @@
     form_data { FixtureHelpers.fixture_as_json 'decision_reviews/v2/valid_200995_extra.json' }
   end
 
+  factory :no_treatment_end_dates_supplemental_claim, class: 'AppealsApi::SupplementalClaim' do
+    id { SecureRandom.uuid }
+    api_version { 'V2' }
+    evidence_submission_indicated { true }
+    auth_headers do
+      FixtureHelpers.fixture_as_json('decision_reviews/v2/valid_200995_headers_extra.json')
+                    .transform_values(&:strip)
+    end
+    form_data { FixtureHelpers.fixture_as_json 'decision_reviews/v2/valid_200995_no_treatment_end_date.json' }
+  end
+
   factory :minimal_supplemental_claim, class: 'AppealsApi::SupplementalClaim' do
     id { SecureRandom.uuid }
     api_version { 'V2' }