Skip to content

Commit

Permalink
Add service description for /veterans/{veteranId}/526 (#12971)
Browse files Browse the repository at this point in the history
* Updates swagger docs for dev v2
Changes to be committed:
	modified:   modules/claims_api/app/swagger/claims_api/v2/dev/swagger.json
	modified:   modules/claims_api/spec/requests/v2/veterans/rswag_disability_compensation_request_spec.rb
  • Loading branch information
rockwellwindsor-va authored Jun 13, 2023
1 parent 75e9736 commit 1fef9b7
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 4 deletions.
6 changes: 3 additions & 3 deletions modules/claims_api/app/swagger/claims_api/v2/dev/swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -1418,7 +1418,7 @@
]
}
],
"description": "The below 526 schema is in a draft state representing the attributes we are currently planning to support. Changes are expected as we continue development. \n",
"description": "Automatically establishes a disability compensation claim (21-526EZ) in Veterans Benefits Management System (VBMS). \nThis endpoint generates a filled and electronically signed 526EZ form, establishes the disability claim in VBMS, and \nsubmits the form to the Veteran's eFolder.\n\nA 200 response indicates the API submission was successful. The claim has not reached VBMS until it has a CLAIM_RECEIVED status. \nCheck claim status using the GET veterans/{veteranId}/claims/{id} endpoint.\n\n**A substantially complete 526EZ claim must include:**\n* Veteran's name\n* Sufficient service information for VA to verify the claimed service, if applicable\n* At least one claimed disability or medical condition and how it relates to service\n* Veteran and/or Representative signature\n\n**Standard and fully developed claims (FDCs)**\n\n[Fully developed claims (FDCs)](https://www.va.gov/disability/how-to-file-claim/evidence-needed/fully-developed-claims/)\nare claims certified by the submitter to include all information needed for processing. These claims process faster \nthan claims submitted through the standard claim process. If a claim is certified for the FDC, but is missing needed information, \nit will be processed as a standard claim.\n\nTo certify a claim for the FDC process, set the claimProcessType to FDC_PROGRAM.\n",
"parameters": [
{
"name": "veteranId",
Expand Down Expand Up @@ -4635,8 +4635,8 @@
"id": "1",
"type": "intent_to_file",
"attributes": {
"creationDate": "2023-06-05",
"expirationDate": "2024-06-05",
"creationDate": "2023-06-12",
"expirationDate": "2024-06-12",
"type": "compensation",
"status": "active"
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,27 @@
produces 'application/json'

get_schema_description = <<~VERBIAGE
The below 526 schema is in a draft state representing the attributes we are currently planning to support. Changes are expected as we continue development.#{' '}
Automatically establishes a disability compensation claim (21-526EZ) in Veterans Benefits Management System (VBMS).#{' '}
This endpoint generates a filled and electronically signed 526EZ form, establishes the disability claim in VBMS, and#{' '}
submits the form to the Veteran's eFolder.
A 200 response indicates the API submission was successful. The claim has not reached VBMS until it has a CLAIM_RECEIVED status.#{' '}
Check claim status using the GET veterans/{veteranId}/claims/{id} endpoint.
**A substantially complete 526EZ claim must include:**
* Veteran's name
* Sufficient service information for VA to verify the claimed service, if applicable
* At least one claimed disability or medical condition and how it relates to service
* Veteran and/or Representative signature
**Standard and fully developed claims (FDCs)**
[Fully developed claims (FDCs)](https://www.va.gov/disability/how-to-file-claim/evidence-needed/fully-developed-claims/)
are claims certified by the submitter to include all information needed for processing. These claims process faster#{' '}
than claims submitted through the standard claim process. If a claim is certified for the FDC, but is missing needed information,#{' '}
it will be processed as a standard claim.
To certify a claim for the FDC process, set the claimProcessType to FDC_PROGRAM.
VERBIAGE
description get_schema_description
parameter name: 'veteranId',
Expand Down

0 comments on commit 1fef9b7

Please sign in to comment.