Skip to content

Commit

Permalink
Merge branch 'API-41210_find_report_icn_to_caseflow' of https://githu…
Browse files Browse the repository at this point in the history 
…b.com/department-of-veterans-affairs/vets-api into API-41210_find_report_icn_to_caseflow
  • Loading branch information
@michelpmcdonald
michelpmcdonald committed Dec 17, 2024
2 parents a1155d1 + 4508bd2 commit 1648251
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 30 deletions.
2 changes: 1 addition & 1 deletion modules/claims_api/app/swagger/claims_api/description/v2.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ End-to-end claims tracking provides the status of claims as they move through th

### Claim statuses

After you submit a disability compensation claim with the `POST /veterans/{veteranId}/526` synchronous endpoint, it is then established in Veterans Benefits Management System (VBMS). A `202` response means that the claim was successfully submitted by the API. However, it does not mean VA has received the required 526EZ PDF.
After you submit a disability compensation claim with the `POST /veterans/{veteranId}/526/synchronous` endpoint, it is then established in Veterans Benefits Management System (VBMS). A `202` response means that the claim was successfully submitted by the API. However, it does not mean VA has received the required 526EZ PDF.

To confirm the status of your submission, use the `GET /veterans/{veteranId}/claims/{id}` endpoint and the ID returned with your submission response. Statuses are:

Expand Down
30 changes: 15 additions & 15 deletions modules/claims_api/app/swagger/claims_api/v2/dev/swagger.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"info": {
"title": "Benefits Claims",
"version": "v2",
"description": "## Background\n\nThe Benefits Claims API Version 2 lets internal consumers: \n\n- Retrieve existing claim information, including status, by claim ID.\n- Automatically establish an Intent To File (21-0966) in VBMS.\n- Automatically establish a disability compensation claim (21-526EZ) in VBMS.\n- Digitally submit supporting documentation for disability compensation claims.\n- Retrieve the active Power of Attorney organization of individual with power of attorney for a claimant.\n- Automatically establish a power of attorney appointment in VBMS for an accredited organization (VA Form 21-22).\n- Automatically establish a power of attorney appointment in VBMS for an accredited individual (VA Form 21-22a).\n\nYou should use the [Benefits Claims API Version 1](https://developer.va.gov/explore/benefits/docs/claims?version=current) if you are a consumer outside of VA and do not have the necessary VA agreements to use this API.\n \n## Appointing an accredited representative for dependents\n\nDependents of Veterans, such as spouses, children (biological and step), and parents (biological and foster) may be eligible for VA benefits and can request representation by an accredited representative.\n\nTo file claims through an accredited representative, dependents must appoint their own. Once appointed, the representative will have power of attorney (POA) to assist with the dependentʼs VA claims.\n\nBefore appointing a representative, the dependentʼs relationship to the Veteran must be established. If a new representative is being appointed, the dependentʼs relationship to the Veteran will be validated first. The representative will be appointed to the dependent, not the Veteran.\n\n## Technical Overview\n\nThis API accepts a payload of requests and responses with the payload identifying the claim and Veteran. Responses provide the submission’s processing status. Responses also provide a unique ID which can be used with the appropriate GET endpoint to return detailed, end-to-end claims status tracking. \n\nEnd-to-end claims tracking provides the status of claims as they move through the submission process, but does not return whether the claim was approved or denied. \n\n### Claim statuses\n\nAfter you submit a disability compensation claim with the `POST /veterans/{veteranId}/526` synchronous endpoint, it is then established in Veterans Benefits Management System (VBMS). A `202` response means that the claim was successfully submitted by the API. However, it does not mean VA has received the required 526EZ PDF. \n\nTo confirm the status of your submission, use the `GET /veterans/{veteranId}/claims/{id}` endpoint and the ID returned with your submission response. Statuses are: \n\n* **Pending**: The claim is successfully submitted for processing\n* **Errored**: The submission encountered upstream errors\n* **Canceled**: The claim was identified as a duplicate, or another issue caused the claim to be canceled. \n * For duplicate claims, the claim's progress is tracked under a different Claim ID than the one returned in your submission response. \n* **Claim received**: The claim was received, but hasn't been assigned to a reviewer yet.\n* **Initial review**: The claim has been assigned to a reviewer, who will determine if more information is needed.\n* **Evidence gathering, review, and decision**: VA is gathering evidence to make a decision from health care providers, government agencies, and other sources.\n* **Preparation for notification**: VA has made a decision on the claim, and is getting a decision letter ready to mail.\n* **Complete**: VA has sent a decision letter by U.S. mail.\n\n### Finding a Veteran's unique VA ID\n\nThis API uses Inegration Control Number (ICN) as a unique Veteran identifier to identify the subject of each API request. This identifier should be used as the `{veteranId}` parameter in request URLs.\n\n**Note**: though ICNs are typically static, they may change over time. If a specific ICN suddenly responds with a `404 not found` error, it may have changed. It’s a good idea to periodically check the ICN for each Veteran.\n\n### Authentication and authorization\n\nThe authentication model for the Benefits Claims Version 2 is based on OAuth 2.0 / OpenID Connect and supports the [client credentials grant](https://developer.va.gov/explore/authorization/docs/client-credentials?api=claims).\n\n**Important**: To get production access, you must either work for VA or have specific VA agreements in place. If you have questions, [contact us](https://developer.va.gov/support/contact-us).\n\n### Test data for sandbox environment use\n\nWe use mock [test data in the sandbox environment](https://github.com/department-of-veterans-affairs/vets-api-clients/blob/master/test_accounts.md). Sandbox test data and test users for the Benefits Claims API are valid for all versions of the API.\n"
"description": "## Background\n\nThe Benefits Claims API Version 2 lets internal consumers: \n\n- Retrieve existing claim information, including status, by claim ID.\n- Automatically establish an Intent To File (21-0966) in VBMS.\n- Automatically establish a disability compensation claim (21-526EZ) in VBMS.\n- Digitally submit supporting documentation for disability compensation claims.\n- Retrieve the active Power of Attorney organization of individual with power of attorney for a claimant.\n- Automatically establish a power of attorney appointment in VBMS for an accredited organization (VA Form 21-22).\n- Automatically establish a power of attorney appointment in VBMS for an accredited individual (VA Form 21-22a).\n\nYou should use the [Benefits Claims API Version 1](https://developer.va.gov/explore/benefits/docs/claims?version=current) if you are a consumer outside of VA and do not have the necessary VA agreements to use this API.\n \n## Appointing an accredited representative for dependents\n\nDependents of Veterans, such as spouses, children (biological and step), and parents (biological and foster) may be eligible for VA benefits and can request representation by an accredited representative.\n\nTo file claims through an accredited representative, dependents must appoint their own. Once appointed, the representative will have power of attorney (POA) to assist with the dependentʼs VA claims.\n\nBefore appointing a representative, the dependentʼs relationship to the Veteran must be established. If a new representative is being appointed, the dependentʼs relationship to the Veteran will be validated first. The representative will be appointed to the dependent, not the Veteran.\n\n## Technical Overview\n\nThis API accepts a payload of requests and responses with the payload identifying the claim and Veteran. Responses provide the submission’s processing status. Responses also provide a unique ID which can be used with the appropriate GET endpoint to return detailed, end-to-end claims status tracking. \n\nEnd-to-end claims tracking provides the status of claims as they move through the submission process, but does not return whether the claim was approved or denied. \n\n### Claim statuses\n\nAfter you submit a disability compensation claim with the `POST /veterans/{veteranId}/526/synchronous` endpoint, it is then established in Veterans Benefits Management System (VBMS). A `202` response means that the claim was successfully submitted by the API. However, it does not mean VA has received the required 526EZ PDF. \n\nTo confirm the status of your submission, use the `GET /veterans/{veteranId}/claims/{id}` endpoint and the ID returned with your submission response. Statuses are: \n\n* **Pending**: The claim is successfully submitted for processing\n* **Errored**: The submission encountered upstream errors\n* **Canceled**: The claim was identified as a duplicate, or another issue caused the claim to be canceled. \n * For duplicate claims, the claim's progress is tracked under a different Claim ID than the one returned in your submission response. \n* **Claim received**: The claim was received, but hasn't been assigned to a reviewer yet.\n* **Initial review**: The claim has been assigned to a reviewer, who will determine if more information is needed.\n* **Evidence gathering, review, and decision**: VA is gathering evidence to make a decision from health care providers, government agencies, and other sources.\n* **Preparation for notification**: VA has made a decision on the claim, and is getting a decision letter ready to mail.\n* **Complete**: VA has sent a decision letter by U.S. mail.\n\n### Finding a Veteran's unique VA ID\n\nThis API uses Inegration Control Number (ICN) as a unique Veteran identifier to identify the subject of each API request. This identifier should be used as the `{veteranId}` parameter in request URLs.\n\n**Note**: though ICNs are typically static, they may change over time. If a specific ICN suddenly responds with a `404 not found` error, it may have changed. It’s a good idea to periodically check the ICN for each Veteran.\n\n### Authentication and authorization\n\nThe authentication model for the Benefits Claims Version 2 is based on OAuth 2.0 / OpenID Connect and supports the [client credentials grant](https://developer.va.gov/explore/authorization/docs/client-credentials?api=claims).\n\n**Important**: To get production access, you must either work for VA or have specific VA agreements in place. If you have questions, [contact us](https://developer.va.gov/support/contact-us).\n\n### Test data for sandbox environment use\n\nWe use mock [test data in the sandbox environment](https://github.com/department-of-veterans-affairs/vets-api-clients/blob/master/test_accounts.md). Sandbox test data and test users for the Benefits Claims API are valid for all versions of the API.\n"
},
"tags": [
{
Expand Down Expand Up @@ -1036,7 +1036,7 @@
"202 without a transactionId": {
"value": {
"data": {
"id": "10dbad27-ce32-408e-885c-ec2abb34847e",
"id": "c04ea779-1c6a-4fd1-a3ba-f6953bc839cc",
"type": "forms/526",
"attributes": {
"claimId": "600442191",
Expand Down Expand Up @@ -1221,7 +1221,7 @@
},
"federalActivation": {
"activationDate": "2023-10-01",
"anticipatedSeparationDate": "2024-12-15"
"anticipatedSeparationDate": "2024-12-18"
},
"confinements": [
{
Expand Down Expand Up @@ -1267,7 +1267,7 @@
"202 with a transactionId": {
"value": {
"data": {
"id": "11f513a7-ac0c-4ea9-b8ae-2600a34729cc",
"id": "739cbe6b-be83-4277-a3c6-8eced1eeb527",
"type": "forms/526",
"attributes": {
"claimId": "600442191",
Expand Down Expand Up @@ -1431,7 +1431,7 @@
"serviceBranch": "Public Health Service",
"serviceComponent": "Active",
"activeDutyBeginDate": "2008-11-14",
"activeDutyEndDate": "2024-12-15",
"activeDutyEndDate": "2024-12-18",
"separationLocationCode": "98282"
}
],
Expand All @@ -1452,7 +1452,7 @@
},
"federalActivation": {
"activationDate": "2023-10-01",
"anticipatedSeparationDate": "2024-12-15"
"anticipatedSeparationDate": "2024-12-18"
},
"confinements": [
{
Expand Down Expand Up @@ -4695,7 +4695,7 @@
"serviceBranch": "Public Health Service",
"serviceComponent": "Active",
"activeDutyBeginDate": "2008-11-14",
"activeDutyEndDate": "2024-12-15",
"activeDutyEndDate": "2024-12-18",
"separationLocationCode": "98282"
}
],
Expand All @@ -4716,7 +4716,7 @@
},
"federalActivation": {
"activationDate": "2023-10-01",
"anticipatedSeparationDate": "2024-12-15"
"anticipatedSeparationDate": "2024-12-18"
},
"confinements": [
{
Expand Down Expand Up @@ -9238,8 +9238,8 @@
"id": "1",
"type": "intent_to_file",
"attributes": {
"creationDate": "2024-12-13",
"expirationDate": "2025-12-13",
"creationDate": "2024-12-16",
"expirationDate": "2025-12-16",
"type": "compensation",
"status": "active"
}
Expand Down Expand Up @@ -10129,7 +10129,7 @@
"application/json": {
"example": {
"data": {
"id": "3f404e82-ed36-459c-9e43-a5a826655989",
"id": "8ecf04c6-588d-4d57-bd41-4ae0c54c7576",
"type": "individual",
"attributes": {
"code": "067",
Expand Down Expand Up @@ -10901,7 +10901,7 @@
"application/json": {
"example": {
"data": {
"id": "97cbb22e-90c9-4bce-a571-bbc54ff98e15",
"id": "c0ca13ea-5360-4b41-a8af-8f89a181c023",
"type": "organization",
"attributes": {
"code": "083",
Expand Down Expand Up @@ -12895,10 +12895,10 @@
"application/json": {
"example": {
"data": {
"id": "47bc11a3-a2c2-4d8a-8e46-253263642d6d",
"id": "18158bc1-2245-4262-a9a9-d955b93b40ea",
"type": "claimsApiPowerOfAttorneys",
"attributes": {
"dateRequestAccepted": "2024-12-13",
"dateRequestAccepted": "2024-12-16",
"previousPoa": null,
"representative": {
"serviceOrganization": {
Expand Down Expand Up @@ -13188,7 +13188,7 @@
"HIV",
"ALCOHOLISM"
],
"id": "84da172b-2359-4198-9abf-44afbc7bdfde",
"id": "96fc2003-9ded-4a64-a7f2-798f3d018746",
"type": "power-of-attorney-request"
}
}
Expand Down
Loading

0 comments on commit 1648251

Please sign in to comment.