openapi: 3.0.0 info: title: Appealable Issues Higher-Level Reviews API version: v0 contact: name: developer.va.gov description: "The Appealable Issues API lets you retrieve a list of a claimant’s appealable issues and any chains of preceding issues. Appealable issues are issues from claims about which VA has made a decision that may be eligible for appeal. Not all appealable issues are guaranteed to be eligible for appeal; for example, claimants may have another appeal in progress for an issue.\n\nTo check the status of all decision reviews and appeals for a specified individual, use the [Appeals Status API](https://developer.va.gov/explore/api/appeals-status/docs).\n\nTo file an appeal or decision review, use one of these APIs: \n* [Higher-Level Reviews API](https://developer.va.gov/explore/api/higher-level-reviews/docs)\n* [Notice of Disagreements API](https://developer.va.gov/explore/api/notice-of-disagreements/docs)\n* [Supplemental Claims API](https://developer.va.gov/explore/api/supplemental-claims/docs)\n\n## Technical overview\nThe Appealable Issues API pulls data from Caseflow, a case management system. It provides decision review and appeal data that can be used for submitting a Higher Level Review, Notice of Disagreement, or Supplemental Claim.\n\n### Authorization and Access\nThe authentication model for the Appealable Issues API uses OAuth 2.0/OpenID Connect. The following authorization models are supported:\n* [Authorization code flow](https://developer.va.gov/explore/api/appealable-issues/authorization-code)\n* [Client Credentials Grant (CCG)](https://developer.va.gov/explore/api/appealable-issues/client-credentials)\n\n**Important:** To get production access using client credentials grant, 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\n\nOur sandbox environment is populated with [Veteran test data](https://github.com/department-of-veterans-affairs/vets-api-clients/blob/master/test_accounts/appealable_issues_test_accounts.md) that can be used to test various response scenarios. This sandbox data contains no PII or PHI, but mimics real Veteran account information.\n" servers: - url: https://sandbox-api.va.gov/services/appeals/appealable-issues/{version} description: VA.gov API sandbox environment variables: version: default: v0 - url: https://api.va.gov/services/appeals/appealable-issues/{version} description: VA.gov API production environment variables: version: default: v0 tags: - name: Higher-Level Reviews description: '' paths: /higher_level_reviews: post: summary: Creates a new Higher-Level Review description: Submits an appeal of type Higher Level Review. This endpoint is the same as submitting [VA Form 20-0996](https://www.va.gov/decision-reviews/higher-level-review/request-higher-level-review-form-20-0996) via mail or fax directly to the Board of Veterans’ Appeals. tags: - Higher-Level Reviews operationId: createHlr security: - apikey: [] parameters: - in: header name: X-VA-SSN required: true description: Veteran's SSN example: '706547821' schema: $ref: '#/components/schemas/X-VA-SSN' - in: header name: X-VA-ICN required: false description: Veteran's ICN example: 1013062086V794840 schema: $ref: '#/components/schemas/X-VA-ICN' - in: header name: X-VA-First-Name required: true description: Veteran's first name example: Cara schema: $ref: '#/components/schemas/X-VA-First-Name' - in: header name: X-VA-Middle-Initial required: false description: Veteran's middle initial schema: $ref: '#/components/schemas/X-VA-Middle-Initial' - in: header name: X-VA-Last-Name required: true description: Veteran's last name example: Bartlett schema: $ref: '#/components/schemas/X-VA-Last-Name' - in: header name: X-VA-Birth-Date required: true description: Veteran's birth date example: '1975-02-14' schema: $ref: '#/components/schemas/X-VA-Birth-Date' - in: header name: X-VA-File-Number required: false description: Veteran's file number schema: $ref: '#/components/schemas/X-VA-File-Number' - in: header name: X-VA-Insurance-Policy-Number required: false description: Veteran's insurance policy number schema: $ref: '#/components/schemas/X-VA-Insurance-Policy-Number' - in: header name: X-VA-NonVeteranClaimant-First-Name required: false description: Non-Veteran claimant's first name schema: $ref: '#/components/schemas/X-VA-NonVeteranClaimant-First-Name' - in: header name: X-VA-NonVeteranClaimant-Middle-Initial required: false description: Non-Veteran claimant's middle initial schema: $ref: '#/components/schemas/X-VA-NonVeteranClaimant-Middle-Initial' - in: header name: X-VA-NonVeteranClaimant-Last-Name required: false description: Non-Veteran claimant's last name schema: $ref: '#/components/schemas/X-VA-NonVeteranClaimant-Last-Name' - in: header name: X-VA-NonVeteranClaimant-SSN required: false description: Non-Veteran claimant's SSN schema: $ref: '#/components/schemas/X-VA-NonVeteranClaimant-SSN' - in: header name: X-VA-NonVeteranClaimant-Birth-Date required: false description: Non-Veteran claimant's Birth Date schema: $ref: '#/components/schemas/X-VA-NonVeteranClaimant-Birth-Date' - in: header name: X-Consumer-Username required: false description: Consumer User Name (passed from Kong) schema: type: string - in: header name: X-Consumer-ID required: false description: Consumer GUID schema: type: string responses: '200': description: Info about a single Higher-Level Review content: application/json: examples: minimum fields used: value: data: id: 00000000-1111-2222-3333-444444444444 type: higherLevelReview attributes: status: pending updatedAt: '2020-01-02T03:04:05.067Z' createdAt: '2020-01-02T03:04:05.067Z' formData: data: type: higherLevelReview attributes: informalConference: false benefitType: lifeInsurance veteran: homeless: false address: addressLine1: 123 Some St. city: Sometown countryCodeISO2: US zipCode5: '12345' socOptIn: true included: - type: contestableIssue attributes: issue: left shoulder decisionDate: '1920-12-01' all fields used: value: data: id: 00000000-1111-2222-3333-444444444444 type: higherLevelReview attributes: status: pending updatedAt: '2020-01-02T03:04:05.067Z' createdAt: '2020-01-02T03:04:05.067Z' formData: data: type: higherLevelReview attributes: benefitType: education veteran: homeless: true address: addressLine1: 123 Main St addressLine2: 'Suite #1200' addressLine3: Box 4 city: New York countryCodeISO2: US stateCode: NY zipCode5: '30012' phone: countryCode: '34' areaCode: '555' phoneNumber: '8001111' phoneNumberExt: '2' email: bob@bobbytablesemail.com timezone: America/Chicago claimant: address: addressLine1: 456 First St addressLine2: Apt 5 addressLine3: Box 1 city: Detroit countryCodeISO2: US stateCode: MI zipCode5: '48070' phone: countryCode: '1' areaCode: '555' phoneNumber: '8111100' phoneNumberExt: '4' email: claimant@email.com timezone: America/Detroit socOptIn: true informalConference: true informalConferenceContact: veteran informalConferenceTime: 800-1200 ET informalConferenceRep: firstName: Helen lastName: Holly email: holly@hellohellenholly.com phone: countryCode: '1' areaCode: '555' phoneNumber: '8001111' phoneNumberExt: '2' included: - type: contestableIssue attributes: issue: '123456789' decisionDate: '1900-01-01' decisionIssueId: 1 ratingIssueReferenceId: '2' ratingDecisionReferenceId: '3' socDate: '2020-04-30' disagreementArea: Rating - type: contestableIssue attributes: issue: left eyee decisionDate: '1900-01-02' disagreementArea: '123456789' - type: contestableIssue attributes: issue: right eye decisionDate: '1900-01-03' - type: contestableIssue attributes: issue: left ear decisionDate: '1900-01-04' socDate: '2019-05-15' disagreementArea: Rating - type: contestableIssue attributes: issue: right ear decisionDate: '1900-01-05' disagreementArea: Rating - type: contestableIssue attributes: issue: migraines decisionDate: '1900-01-06' disagreementArea: Rating - type: contestableIssue attributes: issue: left knee decisionDate: '1900-01-07' disagreementArea: Rating - type: contestableIssue attributes: issue: right knee decisionDate: '1900-01-08' disagreementArea: Rating - type: contestableIssue attributes: issue: left foot decisionDate: '1900-01-09' disagreementArea: Rating - type: contestableIssue attributes: issue: right foot decisionDate: '1900-01-10' socDate: '2021-01-08' disagreementArea: Rating - type: contestableIssue attributes: issue: left hand decisionDate: '1900-01-11' disagreementArea: Rating - type: contestableIssue attributes: issue: right hand decisionDate: '1900-01-12' disagreementArea: Rating - type: contestableIssue attributes: issue: fever decisionDate: '1900-01-13' disagreementArea: Service connection - type: contestableIssue attributes: issue: lupus decisionDate: '1900-01-14' socDate: '2020-09-23' - type: contestableIssue attributes: issue: cooties decisionDate: '1900-01-15' disagreementArea: Service connection schema: $ref: '#/components/schemas/hlrShow' '422': description: Violates JSON schema content: application/json: example: errors: - title: Missing required fields detail: One or more expected fields were not found code: '145' source: pointer: /data/attributes status: '422' meta: missing_fields: - informalConference schema: $ref: '#/components/schemas/errorModel' '500': description: Internal Server Error content: application/json: example: errors: - title: Internal server error detail: Internal server error code: '500' status: '500' schema: $ref: '#/components/schemas/errorModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/hlrCreate' examples: minimum fields used: value: data: type: higherLevelReview attributes: informalConference: false benefitType: lifeInsurance veteran: homeless: false address: addressLine1: 123 Some St. city: Sometown countryCodeISO2: US zipCode5: '12345' socOptIn: true included: - type: contestableIssue attributes: issue: left shoulder decisionDate: '1920-12-01' all fields used: value: data: type: higherLevelReview attributes: benefitType: education veteran: homeless: true address: addressLine1: 123 Main St addressLine2: 'Suite #1200' addressLine3: Box 4 city: New York countryCodeISO2: US stateCode: NY zipCode5: '30012' phone: countryCode: '34' areaCode: '555' phoneNumber: '8001111' phoneNumberExt: '2' email: bob@bobbytablesemail.com timezone: America/Chicago claimant: address: addressLine1: 456 First St addressLine2: Apt 5 addressLine3: Box 1 city: Detroit countryCodeISO2: US stateCode: MI zipCode5: '48070' phone: countryCode: '1' areaCode: '555' phoneNumber: '8111100' phoneNumberExt: '4' email: claimant@email.com timezone: America/Detroit socOptIn: true informalConference: true informalConferenceContact: veteran informalConferenceTime: 800-1200 ET informalConferenceRep: firstName: Helen lastName: Holly email: holly@hellohellenholly.com phone: countryCode: '1' areaCode: '555' phoneNumber: '8001111' phoneNumberExt: '2' included: - type: contestableIssue attributes: issue: '123456789' decisionDate: '1900-01-01' decisionIssueId: 1 ratingIssueReferenceId: '2' ratingDecisionReferenceId: '3' socDate: '2020-04-30' disagreementArea: Rating - type: contestableIssue attributes: issue: left eyee decisionDate: '1900-01-02' disagreementArea: '123456789' - type: contestableIssue attributes: issue: right eye decisionDate: '1900-01-03' - type: contestableIssue attributes: issue: left ear decisionDate: '1900-01-04' socDate: '2019-05-15' disagreementArea: Rating - type: contestableIssue attributes: issue: right ear decisionDate: '1900-01-05' disagreementArea: Rating - type: contestableIssue attributes: issue: migraines decisionDate: '1900-01-06' disagreementArea: Rating - type: contestableIssue attributes: issue: left knee decisionDate: '1900-01-07' disagreementArea: Rating - type: contestableIssue attributes: issue: right knee decisionDate: '1900-01-08' disagreementArea: Rating - type: contestableIssue attributes: issue: left foot decisionDate: '1900-01-09' disagreementArea: Rating - type: contestableIssue attributes: issue: right foot decisionDate: '1900-01-10' socDate: '2021-01-08' disagreementArea: Rating - type: contestableIssue attributes: issue: left hand decisionDate: '1900-01-11' disagreementArea: Rating - type: contestableIssue attributes: issue: right hand decisionDate: '1900-01-12' disagreementArea: Rating - type: contestableIssue attributes: issue: fever decisionDate: '1900-01-13' disagreementArea: Service connection - type: contestableIssue attributes: issue: lupus decisionDate: '1900-01-14' socDate: '2020-09-23' - type: contestableIssue attributes: issue: cooties decisionDate: '1900-01-15' disagreementArea: Service connection /higher_level_reviews/{uuid}: get: summary: Shows a specific Higher-Level Review. (a.k.a. the Show endpoint) description: Returns all of the data associated with a specific Higher-Level Review. tags: - Higher-Level Reviews operationId: showHlr security: - apikey: [] parameters: - name: uuid in: path description: Higher-Level Review UUID example: 44e08764-6008-46e8-a95e-eb21951a5b68 required: true schema: type: string responses: '200': description: Info about a single Higher-Level Review content: application/json: example: data: id: 00000000-1111-2222-3333-444444444444 type: higherLevelReview attributes: status: pending updatedAt: '2020-01-02T03:04:05.067Z' createdAt: '2020-01-02T03:04:05.067Z' schema: $ref: '#/components/schemas/hlrShow' '404': description: Higher-Level Review not found content: application/json: example: errors: - code: '404' detail: HigherLevelReview with uuid invalid not found status: '404' title: Record not found schema: $ref: '#/components/schemas/errorModel' '500': description: Internal Server Error content: application/json: example: errors: - title: Internal server error detail: Internal server error code: '500' status: '500' schema: $ref: '#/components/schemas/errorModel' /higher_level_reviews/contestable_issues/{benefit_type}: get: summary: Returns all contestable issues for a specific veteran. tags: - Higher-Level Reviews operationId: hlrContestableIssues description: Returns all issues associated with a Veteran that have been decided by a Higher-Level Review as of the receiptDate and bound by benefitType. Not all issues returned are guaranteed to be eligible for appeal. Associate these results when creating a new Higher-Level Review. security: - apikey: [] parameters: - name: benefit_type in: path description: 'benefit type - Available values: compensation' required: true schema: type: string - in: header name: X-VA-SSN required: false description: Either X-VA-SSN or X-VA-File-Number is required example: '706547821' schema: $ref: '#/components/schemas/X-VA-SSN' - in: header name: X-VA-File-Number required: false description: Either X-VA-SSN or X-VA-File-Number is required schema: $ref: '#/components/schemas/X-VA-File-Number' - in: header name: X-VA-Receipt-Date required: true description: (yyyy-mm-dd) In order to determine contestability of issues, the receipt date of a hypothetical Decision Review must be specified. This date must be after 2019-02-19, the Appeals Modernization Act (AMA) Activation Date. example: '2022-01-01' schema: $ref: '#/components/schemas/X-VA-Receipt-Date' - in: header name: X-VA-ICN required: false description: Veteran's ICN example: 1013062086V794840 schema: $ref: '#/components/schemas/X-VA-ICN' responses: '200': description: JSON:API response returning all contestable issues for a specific veteran. content: application/json: example: data: - type: contestableIssue attributes: ratingIssueSubjectText: Left knee ratingIssueReferenceId: '826209597423' ratingIssueProfileDate: '2019-02-22' ratingIssueDiagnosticCode: null description: Left knee isRating: true latestIssuesInChain: - id: null approxDecisionDate: '2019-02-26' decisionIssueId: null ratingDecisionReferenceId: null approxDecisionDate: '2019-02-26' rampClaimId: null titleOfActiveReview: null sourceReviewType: null timely: true activeReview: false - type: contestableIssue attributes: ratingIssueSubjectText: Right knee ratingIssueReferenceId: '826209920000' ratingIssueProfileDate: '2019-02-22' ratingIssueDiagnosticCode: null description: Right knee isRating: true latestIssuesInChain: - id: null approxDecisionDate: '2019-02-26' decisionIssueId: null ratingDecisionReferenceId: null approxDecisionDate: '2019-02-26' rampClaimId: null titleOfActiveReview: null sourceReviewType: null timely: true activeReview: false - type: contestableIssue attributes: ratingIssueReferenceId: '826209441170' ratingIssueProfileDate: '2019-02-22' ratingIssueDiagnosticCode: null description: PTSD isRating: true latestIssuesInChain: - id: null approxDecisionDate: '2019-02-26' decisionIssueId: null ratingDecisionReferenceId: null approxDecisionDate: '2019-02-26' rampClaimId: null titleOfActiveReview: null sourceReviewType: null timely: true activeReview: false - type: contestableIssue attributes: ratingIssueReferenceId: in-active-review-ref-id ratingIssueProfileDate: '2019-02-22' ratingIssueDiagnosticCode: null description: This rating is in active review isRating: true latestIssuesInChain: - id: null approxDecisionDate: '2019-02-26' decisionIssueId: null ratingDecisionReferenceId: null approxDecisionDate: '2019-02-26' rampClaimId: null titleOfActiveReview: null sourceReviewType: null timely: true activeReview: true - type: contestableIssue attributes: ratingIssueReferenceId: '826209942179' ratingIssueProfileDate: '2019-02-22' ratingIssueDiagnosticCode: null description: I am on a completed Higher Level Review isRating: true latestIssuesInChain: - id: null approxDecisionDate: '2019-02-26' decisionIssueId: null ratingDecisionReferenceId: null approxDecisionDate: '2019-02-26' rampClaimId: null titleOfActiveReview: null sourceReviewType: HigherLevelReview timely: true activeReview: false - type: contestableIssue attributes: ratingIssueReferenceId: before_ama_ref_id ratingIssueProfileDate: '2019-02-09' ratingIssueDiagnosticCode: null description: Issue before AMA not from a RAMP Review isRating: true latestIssuesInChain: - id: null approxDecisionDate: '2019-02-14' decisionIssueId: null ratingDecisionReferenceId: null approxDecisionDate: '2019-02-14' rampClaimId: null titleOfActiveReview: null sourceReviewType: null timely: true activeReview: false - type: contestableIssue attributes: ratingIssueReferenceId: ramp_reference_id ratingIssueProfileDate: '2019-02-09' ratingIssueDiagnosticCode: null description: Issue before AMA from a RAMP Review isRating: true latestIssuesInChain: - id: null approxDecisionDate: '2019-02-14' decisionIssueId: null ratingDecisionReferenceId: null approxDecisionDate: '2019-02-14' rampClaimId: null titleOfActiveReview: null sourceReviewType: null timely: true activeReview: false - type: contestableIssue attributes: ratingIssueReferenceId: '826209918301' ratingIssueProfileDate: '2018-12-12' ratingIssueDiagnosticCode: null description: Old injury isRating: true latestIssuesInChain: - id: null approxDecisionDate: '2018-12-17' decisionIssueId: null ratingDecisionReferenceId: null approxDecisionDate: '2018-12-17' rampClaimId: null titleOfActiveReview: null sourceReviewType: null timely: true activeReview: false - type: contestableIssue attributes: ratingIssueReferenceId: before_test_ama_ref_id ratingIssueProfileDate: '2017-10-12' ratingIssueDiagnosticCode: null description: Issue before test AMA not from a RAMP Review isRating: true latestIssuesInChain: - id: null approxDecisionDate: '2017-10-17' decisionIssueId: null ratingDecisionReferenceId: null approxDecisionDate: '2017-10-17' rampClaimId: null titleOfActiveReview: null sourceReviewType: null timely: false activeReview: false - type: contestableIssue attributes: ratingIssueReferenceId: ramp_reference_id ratingIssueProfileDate: '2017-10-12' ratingIssueDiagnosticCode: null description: Issue before test AMA from a RAMP Review isRating: true latestIssuesInChain: - id: null approxDecisionDate: '2017-10-17' decisionIssueId: null ratingDecisionReferenceId: null approxDecisionDate: '2017-10-17' rampClaimId: null titleOfActiveReview: null sourceReviewType: null timely: false activeReview: false schema: $ref: '#/components/schemas/contestableIssues' '404': description: Veteran not found content: application/json: example: errors: - title: Not found detail: Appeals data for a veteran with that SSN was not found code: CASEFLOWSTATUS404 status: '404' schema: $ref: '#/components/schemas/errorModel' '422': description: Invalid receipt date content: application/json: example: errors: - title: Validation error detail: Receipt date cannot be before 2019-02-20 source: header: X-VA-Receipt-Date status: '422' schema: $ref: '#/components/schemas/errorModel' '500': description: Internal Server Error content: application/json: example: errors: - title: Internal server error detail: Internal server error code: '500' status: '500' schema: $ref: '#/components/schemas/errorModel' '502': description: Unknown error content: application/json: example: errors: - title: Bad Gateway detail: Received a 500 response from the upstream server code: CASEFLOWSTATUS500 source: No method error status: '502' /higher_level_reviews/schema: get: summary: Gets the Higher-Level Review JSON Schema. tags: - Higher-Level Reviews operationId: hlrSchema description: Returns the [JSON Schema](https://json-schema.org/) for the `POST /higher_level_reviews` endpoint. security: - apikey: [] responses: '200': description: the JSON Schema for POST /higher_level_reviews content: application/json: example: '{"$schema":"http://json-schema.org/draft-07/schema#","description":"JSON Schema for VA Form 20-0996","$ref":"#/definitions/hlrCreate","definitions":{"nonBlankString":{"type":"string","pattern":"[^ \\f\\n\\r\\t\\v\\u00a0\\u1680\\u2000-\\u200a\\u2028\\u2029\\u202f\\u205f\\u3000\\ufeff]"},"hlrCreatePhone":{"type":"object","properties":{"countryCode":{"type":"string","pattern":"^[0-9]+$","minLength":1,"maxLength":3},"areaCode":{"type":"string","pattern":"^[0-9]{1,4}$","minLength":1,"maxLength":4},"phoneNumber":{"type":"string","pattern":"^[0-9]{1,14}$","minLength":1,"maxLength":14},"phoneNumberExt":{"type":"string","pattern":"^[a-zA-Z0-9]{1,10}$","minLength":1,"maxLength":10}},"required":["phoneNumber"]},"hlrCreate":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["higherLevelReview"]},"attributes":{"description":"If informal conference requested (`informalConference: true`), contact (`informalConferenceContact`) and time (`informalConferenceTime`) must be specified.","type":"object","additionalProperties":false,"properties":{"informalConference":{"type":"boolean"},"benefitType":{"type":"string","enum":["compensation","pensionSurvivorsBenefits","fiduciary","lifeInsurance","veteransHealthAdministration","veteranReadinessAndEmployment","loanGuaranty","education","nationalCemeteryAdministration"]},"veteran":{"type":"object","properties":{"homeless":{"type":"boolean"},"address":{"type":"object","properties":{"addressLine1":{"type":"string","maxLength":60},"addressLine2":{"type":"string","maxLength":30},"addressLine3":{"type":"string","maxLength":10},"city":{"type":"string","maxLength":60},"stateCode":{"type":"string","enum":["AL","AK","AS","AZ","AR","AA","AE","AP","CA","CO","CT","DE","DC","FM","FL","GA","GU","HI","ID","IL","IN","IA","KS","KY","LA","ME","MH","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","MP","OH","OK","OR","PW","PA","PR","RI","SC","SD","TN","TX","UT","VT","VI","VA","WA","WV","WI","WY"]},"countryCodeISO2":{"type":"string","pattern":"^[A-Z]{2}$","minLength":2,"maxLength":2},"zipCode5":{"type":"string","description":"5-digit zipcode. Use \"00000\" if Veteran is outside the United States","pattern":"^[0-9]{5}$"},"internationalPostalCode":{"type":"string","maxLength":16}},"additionalProperties":false,"required":["addressLine1","city","countryCodeISO2","zipCode5"]},"phone":{"$ref":"#/definitions/hlrCreatePhone"},"email":{"type":"string","format":"email","minLength":6,"maxLength":255},"timezone":{"type":"string","description":"Veteran''s timezone. Used for adding the current date to the signature according to the veteran''s local time. If not specified, the current UTC date will be used for the signature (which may be ahead or behind the local date).","enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Timbuktu","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/ComodRivadavia","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Atka","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Ensenada","America/Fort_Nelson","America/Fort_Wayne","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Knox_IN","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montreal","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Nuuk","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Acre","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Rosario","America/Santa_Isabel","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Shiprock","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Virgin","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/South_Pole","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Ashkhabad","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Choibalsan","Asia/Chongqing","Asia/Chungking","Asia/Colombo","Asia/Dacca","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Harbin","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Istanbul","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kashgar","Asia/Kathmandu","Asia/Katmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macao","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tel_Aviv","Asia/Thimbu","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ujung_Pandang","Asia/Ulaanbaatar","Asia/Ulan_Bator","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Faroe","Atlantic/Jan_Mayen","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/ACT","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Canberra","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/LHI","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/NSW","Australia/North","Australia/Perth","Australia/Queensland","Australia/South","Australia/Sydney","Australia/Tasmania","Australia/Victoria","Australia/West","Australia/Yancowinna","Brazil/Acre","Brazil/DeNoronha","Brazil/East","Brazil/West","CET","CST6CDT","Canada/Atlantic","Canada/Central","Canada/Eastern","Canada/Mountain","Canada/Newfoundland","Canada/Pacific","Canada/Saskatchewan","Canada/Yukon","Chile/Continental","Chile/EasterIsland","Cuba","EET","EST","EST5EDT","Egypt","Eire","Etc/GMT","Etc/GMT+0","Etc/GMT+1","Etc/GMT+10","Etc/GMT+11","Etc/GMT+12","Etc/GMT+2","Etc/GMT+3","Etc/GMT+4","Etc/GMT+5","Etc/GMT+6","Etc/GMT+7","Etc/GMT+8","Etc/GMT+9","Etc/GMT-0","Etc/GMT-1","Etc/GMT-10","Etc/GMT-11","Etc/GMT-12","Etc/GMT-13","Etc/GMT-14","Etc/GMT-2","Etc/GMT-3","Etc/GMT-4","Etc/GMT-5","Etc/GMT-6","Etc/GMT-7","Etc/GMT-8","Etc/GMT-9","Etc/GMT0","Etc/Greenwich","Etc/UCT","Etc/UTC","Etc/Universal","Etc/Zulu","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belfast","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Kyiv","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Nicosia","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Tiraspol","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","Factory","GB","GB-Eire","GMT","GMT+0","GMT-0","GMT0","Greenwich","HST","Hongkong","Iceland","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Iran","Israel","Jamaica","Japan","Kwajalein","Libya","MET","MST","MST7MDT","Mexico/BajaNorte","Mexico/BajaSur","Mexico/General","NZ","NZ-CHAT","Navajo","PRC","PST8PDT","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Johnston","Pacific/Kanton","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Samoa","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis","Pacific/Yap","Poland","Portugal","ROC","ROK","Singapore","Turkey","UCT","US/Alaska","US/Aleutian","US/Arizona","US/Central","US/East-Indiana","US/Eastern","US/Hawaii","US/Indiana-Starke","US/Michigan","US/Mountain","US/Pacific","US/Samoa","UTC","Universal","W-SU","WET","Zulu"]}},"additionalProperties":false,"required":["homeless"],"if":{"properties":{"homeless":{"const":false}}},"then":{"required":["address"]}},"claimant":{"type":"object","description":"If the claimant is a non-Veteran, claimant information is required. Without this information, we will be unable to identify the claimant. If you''re a healthcare provider or an employee of a healthcare provider requesting review of a VA payment decision, you must identify the healthcare provider as the claimant and complete all relevant information in the claimant object.","properties":{"address":{"type":"object","properties":{"addressLine1":{"type":"string","minLength":1,"maxLength":60},"addressLine2":{"type":"string","minLength":1,"maxLength":30},"addressLine3":{"type":"string","minLength":1,"maxLength":10},"city":{"type":"string","minLength":1,"maxLength":60},"stateCode":{"type":"string","enum":["AL","AK","AS","AZ","AR","AA","AE","AP","CA","CO","CT","DE","DC","FM","FL","GA","GU","HI","ID","IL","IN","IA","KS","KY","LA","ME","MH","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","MP","OH","OK","OR","PW","PA","PR","RI","SC","SD","TN","TX","UT","VT","VI","VA","WA","WV","WI","WY"]},"countryCodeISO2":{"type":"string","pattern":"^[A-Z]{2}$","minLength":2,"maxLength":2},"zipCode5":{"type":"string","description":"5-digit zipcode. Use \"00000\" if Veteran is outside the United States","pattern":"^[0-9]{5}$"},"internationalPostalCode":{"type":"string","maxLength":16}},"additionalProperties":false,"required":["addressLine1","city","countryCodeISO2","zipCode5"]},"phone":{"$ref":"#/definitions/hlrCreatePhone"},"email":{"type":"string","format":"email","minLength":6,"maxLength":255},"timezone":{"type":"string","description":"Claimant''s timezone. Used for adding the current date to the signature according to the claimant''s local time. If not specified, the current UTC date will be used for the signature (which may be ahead or behind the local date).","enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Timbuktu","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/ComodRivadavia","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Atka","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Ensenada","America/Fort_Nelson","America/Fort_Wayne","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Knox_IN","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montreal","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Nuuk","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Acre","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Rosario","America/Santa_Isabel","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Shiprock","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Virgin","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/South_Pole","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Ashkhabad","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Choibalsan","Asia/Chongqing","Asia/Chungking","Asia/Colombo","Asia/Dacca","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Harbin","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Istanbul","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kashgar","Asia/Kathmandu","Asia/Katmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macao","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tel_Aviv","Asia/Thimbu","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ujung_Pandang","Asia/Ulaanbaatar","Asia/Ulan_Bator","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Faroe","Atlantic/Jan_Mayen","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/ACT","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Canberra","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/LHI","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/NSW","Australia/North","Australia/Perth","Australia/Queensland","Australia/South","Australia/Sydney","Australia/Tasmania","Australia/Victoria","Australia/West","Australia/Yancowinna","Brazil/Acre","Brazil/DeNoronha","Brazil/East","Brazil/West","CET","CST6CDT","Canada/Atlantic","Canada/Central","Canada/Eastern","Canada/Mountain","Canada/Newfoundland","Canada/Pacific","Canada/Saskatchewan","Canada/Yukon","Chile/Continental","Chile/EasterIsland","Cuba","EET","EST","EST5EDT","Egypt","Eire","Etc/GMT","Etc/GMT+0","Etc/GMT+1","Etc/GMT+10","Etc/GMT+11","Etc/GMT+12","Etc/GMT+2","Etc/GMT+3","Etc/GMT+4","Etc/GMT+5","Etc/GMT+6","Etc/GMT+7","Etc/GMT+8","Etc/GMT+9","Etc/GMT-0","Etc/GMT-1","Etc/GMT-10","Etc/GMT-11","Etc/GMT-12","Etc/GMT-13","Etc/GMT-14","Etc/GMT-2","Etc/GMT-3","Etc/GMT-4","Etc/GMT-5","Etc/GMT-6","Etc/GMT-7","Etc/GMT-8","Etc/GMT-9","Etc/GMT0","Etc/Greenwich","Etc/UCT","Etc/UTC","Etc/Universal","Etc/Zulu","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belfast","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Kyiv","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Nicosia","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Tiraspol","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","Factory","GB","GB-Eire","GMT","GMT+0","GMT-0","GMT0","Greenwich","HST","Hongkong","Iceland","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Iran","Israel","Jamaica","Japan","Kwajalein","Libya","MET","MST","MST7MDT","Mexico/BajaNorte","Mexico/BajaSur","Mexico/General","NZ","NZ-CHAT","Navajo","PRC","PST8PDT","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Johnston","Pacific/Kanton","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Samoa","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis","Pacific/Yap","Poland","Portugal","ROC","ROK","Singapore","Turkey","UCT","US/Alaska","US/Aleutian","US/Arizona","US/Central","US/East-Indiana","US/Eastern","US/Hawaii","US/Indiana-Starke","US/Michigan","US/Mountain","US/Pacific","US/Samoa","UTC","Universal","W-SU","WET","Zulu"]}},"required":["address","phone"]},"informalConferenceContact":{"type":"string","enum":["veteran","representative"]},"informalConferenceTime":{"type":"string","enum":["800-1200 ET","1200-1630 ET"]},"informalConferenceRep":{"type":"object","description":"The Representative information listed MUST match the current Power of Attorney for the Veteran. Any changes to the Power of Attorney must be submitted via a VA 21-22 form separately.","properties":{"firstName":{"type":"string","maxLength":30},"lastName":{"type":"string","maxLength":40},"phone":{"$ref":"#/definitions/hlrCreatePhone"},"email":{"type":"string","format":"email","minLength":6,"maxLength":255}},"additionalProperties":false,"required":["firstName","lastName","phone"]},"socOptIn":{"type":"boolean"}},"required":["informalConference","benefitType","veteran","socOptIn"],"if":{"properties":{"informalConference":{"const":true}}},"then":{"required":["informalConferenceContact","informalConferenceTime"]}}},"additionalProperties":false,"required":["type","attributes"]},"included":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contestableIssue"]},"attributes":{"type":"object","properties":{"issue":{"allOf":[{"$ref":"#/definitions/nonBlankString"},{"maxLength":140}]},"decisionDate":{"type":"string","format":"date"},"decisionIssueId":{"type":"integer"},"ratingIssueReferenceId":{"type":"string"},"ratingDecisionReferenceId":{"type":"string"},"socDate":{"type":"string","format":"date"},"disagreementArea":{"type":"string","maxLength":90}},"additionalProperties":false,"required":["issue","decisionDate"]}},"additionalProperties":false,"required":["type","attributes"]},"minItems":1,"uniqueItems":true}},"additionalProperties":false,"required":["data","included"]}}}' '500': description: Internal Server Error content: application/json: example: errors: - title: Internal server error detail: Internal server error code: '500' status: '500' schema: $ref: '#/components/schemas/errorModel' /higher_level_reviews/validate: post: summary: Validates a POST request body against the JSON schema. tags: - Higher-Level Reviews operationId: hlrValidate description: Like the POST /higher_level_reviews, but only does the validations —does not submit anything. security: - apikey: [] parameters: - in: header name: X-VA-SSN required: true description: Veteran's SSN example: '706547821' schema: $ref: '#/components/schemas/X-VA-SSN' - in: header name: X-VA-ICN required: false description: Veteran's ICN example: 1013062086V794840 schema: $ref: '#/components/schemas/X-VA-ICN' - in: header name: X-VA-First-Name required: true description: Veteran's first name example: Cara schema: $ref: '#/components/schemas/X-VA-First-Name' - in: header name: X-VA-Middle-Initial required: false description: Veteran's middle initial schema: $ref: '#/components/schemas/X-VA-Middle-Initial' - in: header name: X-VA-Last-Name required: true description: Veteran's last name example: Bartlett schema: $ref: '#/components/schemas/X-VA-Last-Name' - in: header name: X-VA-Birth-Date required: true description: Veteran's birth date example: '1975-02-14' schema: $ref: '#/components/schemas/X-VA-Birth-Date' - in: header name: X-VA-File-Number required: false description: Veteran's file number schema: $ref: '#/components/schemas/X-VA-File-Number' - in: header name: X-VA-Insurance-Policy-Number required: false description: Veteran's insurance policy number schema: $ref: '#/components/schemas/X-VA-Insurance-Policy-Number' - in: header name: X-VA-NonVeteranClaimant-First-Name required: false description: Non-Veteran claimant's first name schema: $ref: '#/components/schemas/X-VA-NonVeteranClaimant-First-Name' - in: header name: X-VA-NonVeteranClaimant-Middle-Initial required: false description: Non-Veteran claimant's middle initial schema: $ref: '#/components/schemas/X-VA-NonVeteranClaimant-Middle-Initial' - in: header name: X-VA-NonVeteranClaimant-Last-Name required: false description: Non-Veteran claimant's last name schema: $ref: '#/components/schemas/X-VA-NonVeteranClaimant-Last-Name' - in: header name: X-VA-NonVeteranClaimant-SSN required: false description: Non-Veteran claimant's SSN schema: $ref: '#/components/schemas/X-VA-NonVeteranClaimant-SSN' - in: header name: X-VA-NonVeteranClaimant-Birth-Date required: false description: Non-Veteran claimant's Birth Date schema: $ref: '#/components/schemas/X-VA-NonVeteranClaimant-Birth-Date' - in: header name: X-Consumer-Username required: false description: Consumer User Name (passed from Kong) schema: type: string - in: header name: X-Consumer-ID required: false description: Consumer GUID schema: type: string responses: '200': description: Valid content: application/json: examples: minimum fields used: value: data: type: higherLevelReviewValidation attributes: status: valid all fields used: value: data: type: higherLevelReviewValidation attributes: status: valid schema: type: object properties: data: type: object properties: type: type: string enum: - higherLevelReviewValidation attributes: type: object properties: status: type: string enum: - valid '422': description: Error content: application/json: examples: Violates JSON schema: value: errors: - title: Missing required fields detail: One or more expected fields were not found code: '145' source: pointer: /data/attributes status: '422' meta: missing_fields: - informalConference Not JSON object: value: errors: - code: '109' detail: The request body isn't a JSON object status: '422' title: Validation error schema: $ref: '#/components/schemas/errorModel' '500': description: Internal Server Error content: application/json: example: errors: - title: Internal server error detail: Internal server error code: '500' status: '500' schema: $ref: '#/components/schemas/errorModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/hlrCreate' examples: minimum fields used: value: data: type: higherLevelReview attributes: informalConference: false benefitType: lifeInsurance veteran: homeless: false address: addressLine1: 123 Some St. city: Sometown countryCodeISO2: US zipCode5: '12345' socOptIn: true included: - type: contestableIssue attributes: issue: left shoulder decisionDate: '1920-12-01' all fields used: value: data: type: higherLevelReview attributes: benefitType: education veteran: homeless: true address: addressLine1: 123 Main St addressLine2: 'Suite #1200' addressLine3: Box 4 city: New York countryCodeISO2: US stateCode: NY zipCode5: '30012' phone: countryCode: '34' areaCode: '555' phoneNumber: '8001111' phoneNumberExt: '2' email: bob@bobbytablesemail.com timezone: America/Chicago claimant: address: addressLine1: 456 First St addressLine2: Apt 5 addressLine3: Box 1 city: Detroit countryCodeISO2: US stateCode: MI zipCode5: '48070' phone: countryCode: '1' areaCode: '555' phoneNumber: '8111100' phoneNumberExt: '4' email: claimant@email.com timezone: America/Detroit socOptIn: true informalConference: true informalConferenceContact: veteran informalConferenceTime: 800-1200 ET informalConferenceRep: firstName: Helen lastName: Holly email: holly@hellohellenholly.com phone: countryCode: '1' areaCode: '555' phoneNumber: '8001111' phoneNumberExt: '2' included: - type: contestableIssue attributes: issue: '123456789' decisionDate: '1900-01-01' decisionIssueId: 1 ratingIssueReferenceId: '2' ratingDecisionReferenceId: '3' socDate: '2020-04-30' disagreementArea: Rating - type: contestableIssue attributes: issue: left eyee decisionDate: '1900-01-02' disagreementArea: '123456789' - type: contestableIssue attributes: issue: right eye decisionDate: '1900-01-03' - type: contestableIssue attributes: issue: left ear decisionDate: '1900-01-04' socDate: '2019-05-15' disagreementArea: Rating - type: contestableIssue attributes: issue: right ear decisionDate: '1900-01-05' disagreementArea: Rating - type: contestableIssue attributes: issue: migraines decisionDate: '1900-01-06' disagreementArea: Rating - type: contestableIssue attributes: issue: left knee decisionDate: '1900-01-07' disagreementArea: Rating - type: contestableIssue attributes: issue: right knee decisionDate: '1900-01-08' disagreementArea: Rating - type: contestableIssue attributes: issue: left foot decisionDate: '1900-01-09' disagreementArea: Rating - type: contestableIssue attributes: issue: right foot decisionDate: '1900-01-10' socDate: '2021-01-08' disagreementArea: Rating - type: contestableIssue attributes: issue: left hand decisionDate: '1900-01-11' disagreementArea: Rating - type: contestableIssue attributes: issue: right hand decisionDate: '1900-01-12' disagreementArea: Rating - type: contestableIssue attributes: issue: fever decisionDate: '1900-01-13' disagreementArea: Service connection - type: contestableIssue attributes: issue: lupus decisionDate: '1900-01-14' socDate: '2020-09-23' - type: contestableIssue attributes: issue: cooties decisionDate: '1900-01-15' disagreementArea: Service connection /forms/200996: post: summary: Creates a new Higher-Level Review description: Submits an appeal of type Higher-Level Review. This endpoint is the same as submitting [VA Form 20-0996](https://www.va.gov/decision-reviews/higher-level-review/request-higher-level-review-form-20-0996) via mail or fax directly to the Board of Veterans’ Appeals. tags: - Higher-Level Reviews operationId: createHlr security: - productionOauth: - veteran/HigherLevelReviews.write - representative/HigherLevelReviews.write - system/HigherLevelReviews.write - sandboxOauth: - veteran/HigherLevelReviews.write - representative/HigherLevelReviews.write - system/HigherLevelReviews.write - bearer_token: [] parameters: [] responses: '201': description: Higher-Level Review created content: application/json: examples: minimum fields used: value: data: id: 00000000-1111-2222-3333-444444444444 type: higherLevelReview attributes: status: pending createDate: '2020-01-02T03:04:05.067Z' updateDate: '2020-01-02T03:04:05.067Z' formData: data: type: higherLevelReview attributes: informalConference: false benefitType: lifeInsurance veteran: icn: 1012667145V762142 ssn: '123456789' firstName: Jane lastName: Doe birthDate: '1969-12-31' homeless: false address: addressLine1: 123 Some St. city: Sometown countryCodeIso3: USA zipCode5: '12345' included: - type: appealableIssue attributes: issue: left shoulder decisionDate: '1920-12-01' all fields used: value: data: id: 00000000-1111-2222-3333-444444444444 type: higherLevelReview attributes: status: pending createDate: '2020-01-02T03:04:05.067Z' updateDate: '2020-01-02T03:04:05.067Z' formData: data: type: higherLevelReview attributes: benefitType: education veteran: icn: 1012667145V762142 ssn: '123456789' firstName: Jäñe middleInitial: ø lastName: Doé birthDate: '1969-12-31' fileNumber: '987654321' serviceNumber: '876543210' insurancePolicyNumber: '987654321123456789' homeless: true address: addressLine1: 123 Main St addressLine2: 'Suite #1200' addressLine3: Box 4 city: New York countryCodeIso3: USA stateCode: NY zipCode5: '30012' phone: countryCode: '34' areaCode: '555' phoneNumber: '8001111' phoneNumberExt: '2' email: bob@bobbytablesemail.com timezone: America/Chicago claimant: ssn: '829347561' birthDate: '1972-05-08' firstName: Betty middleInitial: D lastName: Boop address: addressLine1: 456 First St addressLine2: Apt 5 addressLine3: Box 1 city: Detroit countryCodeIso3: USA stateCode: MI zipCode5: '48070' phone: countryCode: '1' areaCode: '555' phoneNumber: '8111100' phoneNumberExt: '4' email: claimant@email.com timezone: America/Detroit informalConference: true informalConferenceContact: veteran informalConferenceTime: 800-1200 ET informalConferenceRep: firstName: Helen lastName: Holly email: holly@hellohellenholly.com phone: countryCode: '1' areaCode: '555' phoneNumber: '8001111' phoneNumberExt: '2' included: - type: appealableIssue attributes: issue: '123456789' decisionDate: '1900-01-01' decisionIssueId: 1 ratingIssueReferenceId: '2' ratingDecisionReferenceId: '3' socDate: '2020-04-30' disagreementArea: Rating - type: appealableIssue attributes: issue: left eyee decisionDate: '1900-01-02' disagreementArea: '123456789' - type: appealableIssue attributes: issue: right eye decisionDate: '1900-01-03' - type: appealableIssue attributes: issue: left ear decisionDate: '1900-01-04' socDate: '2019-05-15' disagreementArea: Rating - type: appealableIssue attributes: issue: right ear decisionDate: '1900-01-05' disagreementArea: Rating - type: appealableIssue attributes: issue: migraines decisionDate: '1900-01-06' disagreementArea: Rating - type: appealableIssue attributes: issue: left knee decisionDate: '1900-01-07' disagreementArea: Rating - type: appealableIssue attributes: issue: right knee decisionDate: '1900-01-08' disagreementArea: Rating - type: appealableIssue attributes: issue: left foot decisionDate: '1900-01-09' disagreementArea: Rating - type: appealableIssue attributes: issue: right foot decisionDate: '1900-01-10' socDate: '2021-01-08' disagreementArea: Rating - type: appealableIssue attributes: issue: left hand decisionDate: '1900-01-11' disagreementArea: Rating - type: appealableIssue attributes: issue: right hand decisionDate: '1900-01-12' disagreementArea: Rating - type: appealableIssue attributes: issue: fever decisionDate: '1900-01-13' disagreementArea: Service connection - type: appealableIssue attributes: issue: lupus decisionDate: '1900-01-14' socDate: '2020-09-23' - type: appealableIssue attributes: issue: cooties decisionDate: '1900-01-15' disagreementArea: Service connection schema: $ref: '#/components/schemas/hlrShow_2' '400': description: Bad request content: application/json: examples: Body is not a JSON object: value: errors: - code: '109' detail: The request body isn't a JSON object status: '400' title: Bad Request schema: $ref: '#/components/schemas/errorModel' '403': description: Forbidden attempt using a veteran-scoped OAuth token to create a Higher-Level Review for another veteran content: application/json: example: errors: - title: Forbidden detail: Veterans may access only their own records code: '403' status: '403' schema: $ref: '#/components/schemas/errorModel' '422': description: Violates JSON schema content: application/json: example: errors: - title: Missing required fields detail: One or more expected fields were not found code: '145' source: pointer: /data/attributes status: '422' meta: missing_fields: - informalConference schema: $ref: '#/components/schemas/errorModel' '500': description: Internal Server Error content: application/json: example: errors: - title: Internal server error detail: Internal server error code: '500' status: '500' schema: $ref: '#/components/schemas/errorModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/hlrCreate_2' examples: minimum fields used: value: data: type: higherLevelReview attributes: informalConference: false benefitType: lifeInsurance veteran: icn: 1012667145V762142 ssn: '123456789' firstName: Jane lastName: Doe birthDate: '1969-12-31' homeless: false address: addressLine1: 123 Some St. city: Sometown countryCodeIso3: USA zipCode5: '12345' included: - type: appealableIssue attributes: issue: left shoulder decisionDate: '1920-12-01' all fields used: value: data: type: higherLevelReview attributes: benefitType: education veteran: icn: 1012667145V762142 ssn: '123456789' firstName: Jäñe middleInitial: ø lastName: Doé birthDate: '1969-12-31' fileNumber: '987654321' serviceNumber: '876543210' insurancePolicyNumber: '987654321123456789' homeless: true address: addressLine1: 123 Main St addressLine2: 'Suite #1200' addressLine3: Box 4 city: New York countryCodeIso3: USA stateCode: NY zipCode5: '30012' phone: countryCode: '34' areaCode: '555' phoneNumber: '8001111' phoneNumberExt: '2' email: bob@bobbytablesemail.com timezone: America/Chicago claimant: ssn: '829347561' birthDate: '1972-05-08' firstName: Betty middleInitial: D lastName: Boop address: addressLine1: 456 First St addressLine2: Apt 5 addressLine3: Box 1 city: Detroit countryCodeIso3: USA stateCode: MI zipCode5: '48070' phone: countryCode: '1' areaCode: '555' phoneNumber: '8111100' phoneNumberExt: '4' email: claimant@email.com timezone: America/Detroit informalConference: true informalConferenceContact: veteran informalConferenceTime: 800-1200 ET informalConferenceRep: firstName: Helen lastName: Holly email: holly@hellohellenholly.com phone: countryCode: '1' areaCode: '555' phoneNumber: '8001111' phoneNumberExt: '2' included: - type: appealableIssue attributes: issue: '123456789' decisionDate: '1900-01-01' decisionIssueId: 1 ratingIssueReferenceId: '2' ratingDecisionReferenceId: '3' socDate: '2020-04-30' disagreementArea: Rating - type: appealableIssue attributes: issue: left eyee decisionDate: '1900-01-02' disagreementArea: '123456789' - type: appealableIssue attributes: issue: right eye decisionDate: '1900-01-03' - type: appealableIssue attributes: issue: left ear decisionDate: '1900-01-04' socDate: '2019-05-15' disagreementArea: Rating - type: appealableIssue attributes: issue: right ear decisionDate: '1900-01-05' disagreementArea: Rating - type: appealableIssue attributes: issue: migraines decisionDate: '1900-01-06' disagreementArea: Rating - type: appealableIssue attributes: issue: left knee decisionDate: '1900-01-07' disagreementArea: Rating - type: appealableIssue attributes: issue: right knee decisionDate: '1900-01-08' disagreementArea: Rating - type: appealableIssue attributes: issue: left foot decisionDate: '1900-01-09' disagreementArea: Rating - type: appealableIssue attributes: issue: right foot decisionDate: '1900-01-10' socDate: '2021-01-08' disagreementArea: Rating - type: appealableIssue attributes: issue: left hand decisionDate: '1900-01-11' disagreementArea: Rating - type: appealableIssue attributes: issue: right hand decisionDate: '1900-01-12' disagreementArea: Rating - type: appealableIssue attributes: issue: fever decisionDate: '1900-01-13' disagreementArea: Service connection - type: appealableIssue attributes: issue: lupus decisionDate: '1900-01-14' socDate: '2020-09-23' - type: appealableIssue attributes: issue: cooties decisionDate: '1900-01-15' disagreementArea: Service connection /forms/200996/{id}: get: summary: Show a specific Higher-Level Review description: Returns basic data associated with a specific Higher-Level Review. tags: - Higher-Level Reviews operationId: showHlr security: - productionOauth: - veteran/HigherLevelReviews.read - representative/HigherLevelReviews.read - system/HigherLevelReviews.read - sandboxOauth: - veteran/HigherLevelReviews.read - representative/HigherLevelReviews.read - system/HigherLevelReviews.read - bearer_token: [] parameters: - name: id in: path description: Higher-Level Review ID schema: type: string format: uuid example: 44e08764-6008-46e8-a95e-eb21951a5b68 required: true responses: '200': description: Success content: application/json: example: data: id: 00000000-1111-2222-3333-444444444444 type: higherLevelReview attributes: status: pending createDate: '2020-01-02T03:04:05.067Z' updateDate: '2020-01-02T03:04:05.067Z' schema: $ref: '#/components/schemas/hlrShow_2' '403': description: Forbidden access with a veteran-scoped OAuth token to an unowned Higher-Level Review content: application/json: example: errors: - title: Forbidden detail: Veterans may access only their own records code: '403' status: '403' schema: $ref: '#/components/schemas/errorModel' '404': description: Higher-Level Review not found content: application/json: example: errors: - title: Resource not found detail: Higher-Level Review with uuid 11111111-1111-1111-1111-111111111111 not found code: '404' status: '404' schema: $ref: '#/components/schemas/errorModel' '500': description: Internal Server Error content: application/json: example: errors: - title: Internal server error detail: Internal server error code: '500' status: '500' schema: $ref: '#/components/schemas/errorModel' /forms/200996/{id}/download: get: summary: Download a watermarked copy of a submitted Higher-Level Review tags: - Higher-Level Reviews operationId: downloadHlr security: - productionOauth: - veteran/HigherLevelReviews.read - representative/HigherLevelReviews.read - system/HigherLevelReviews.read - sandboxOauth: - veteran/HigherLevelReviews.read - representative/HigherLevelReviews.read - system/HigherLevelReviews.read - bearer_token: [] description: "Returns a watermarked copy of a Higher-Level Review PDF as submitted to the VA. PDFs are available\nwith the following caveats:\n\n1. The PDF download will become available only after after the Higher-Level Review has progressed to\n the 'submitted' state.\n2. The PDF will stop being available one week after the Higher-Level Review has progressed to the\n 'completed' state. This is when the Veteran's personally identifying information is purged from our servers.\n\nThe 'icn' parameter is required when accessing this endpoint using an OAuth token with the 'representative/HigherLevelReviews.read' or 'system/HigherLevelReviews.read' scopes.\nRequests made with the 'veteran/HigherLevelReviews.read' scope may omit the 'icn' parameter.\n" parameters: - name: icn description: ICN of the Veteran associated with the Higher-Level Review. Optional when using a veteran-scoped OAuth token. Required when using a representative- or system-scoped token. example: 1012832025V743496 schema: type: string pattern: ^[0-9]{10}V[0-9]{6}$ minLength: 17 maxLength: 17 in: query required: false - name: id in: path description: Higher-Level Review ID schema: type: string format: uuid example: 44444444-5555-6666-7777-888888888888 required: true responses: '200': description: Success content: application/pdf: schema: type: file '400': description: Missing 'icn' query parameter (with a system- or representative-scoped OAuth token) content: application/json: example: errors: - title: Missing parameter detail: The 'icn' parameter is required with this request code: '108' status: '400' schema: $ref: '#/components/schemas/errorModel' '403': description: Forbidden access (with a veteran-scoped OAuth token to an unowned Higher-Level Review) content: application/json: example: errors: - title: Forbidden detail: 'Invalid ''icn'' parameter: Veterans may access only their own records' code: '403' status: '403' schema: $ref: '#/components/schemas/errorModel' '404': description: Not Found content: application/json: examples: Higher-Level Review not found, or 'icn' parameter does not match the Higher-Level Review's saved data: value: errors: - title: Resource not found detail: Higher-Level Review with uuid 44444444-5555-6666-7777-888888888888 not found code: '404' status: '404' schema: $ref: '#/components/schemas/errorModel' '410': description: Personally identifying information gone content: application/json: example: errors: - code: '410' detail: PDF for HigherLevelReview with id 44444444-5555-6666-7777-888888888888 cannot be downloaded because the form data was deleted from the server after the PII retention period expired status: '410' title: PDF download expired schema: $ref: '#/components/schemas/errorModel' '422': description: PDF not ready content: application/json: example: errors: - code: '422' detail: PDF for HigherLevelReview with id 44444444-5555-6666-7777-888888888888 cannot be downloaded yet because the appeal is still being submitted status: '422' title: PDF download not ready schema: $ref: '#/components/schemas/errorModel' '500': description: Internal Server Error content: application/json: example: errors: - title: Internal server error detail: Internal server error code: '500' status: '500' schema: $ref: '#/components/schemas/errorModel' /schemas/{schema_type}: get: summary: Gets JSON schema related to Higher-Level Review. tags: - Higher-Level Reviews operationId: hlrSchema description: Returns the [JSON Schema](https://json-schema.org) related to the `POST /forms/200996` endpoint security: - productionOauth: - veteran/HigherLevelReviews.read - representative/HigherLevelReviews.read - system/HigherLevelReviews.read - sandboxOauth: - veteran/HigherLevelReviews.read - representative/HigherLevelReviews.read - system/HigherLevelReviews.read - bearer_token: [] parameters: - name: schema_type in: path description: 'Schema type. Can be: `200996`, `address`, `nonBlankString`, `phone`, `timezone`' required: true examples: '200996': value: '200996' address: value: address nonBlankString: value: nonBlankString phone: value: phone timezone: value: timezone schema: type: string responses: '200': description: The JSON schema for the given `schema_type` parameter content: application/json: examples: '200996': value: $schema: http://json-schema.org/draft-07/schema# description: JSON Schema for VA Form 20-0996 properties: data: type: object properties: type: type: string enum: - higherLevelReview attributes: description: 'If informal conference requested (`informalConference: true`), contact (`informalConferenceContact`) and time (`informalConferenceTime`) must be specified.' type: object properties: informalConference: type: boolean benefitType: type: string enum: - compensation - pensionSurvivorsBenefits - fiduciary - lifeInsurance - veteransHealthAdministration - veteranReadinessAndEmployment - loanGuaranty - education - nationalCemeteryAdministration veteran: type: object properties: ssn: allOf: - $ref: ssn.json - description: Veteran's SSN icn: $ref: icn.json firstName: allOf: - description: Veteran's first name minLength: 1 maxLength: 30 - {} - $ref: nonBlankString.json middleInitial: allOf: - description: Veteran's middle initial minLength: 1 maxLength: 1 - $ref: nonBlankString.json lastName: allOf: - description: Veteran's last name minLength: 1 maxLength: 40 - $ref: nonBlankString.json birthDate: description: Veteran's birth date type: string format: date fileNumber: $ref: fileNumber.json insurancePolicyNumber: allOf: - description: Veteran's insurance policy number maxLength: 18 - $ref: nonBlankString.json homeless: type: boolean address: $ref: address.json phone: $ref: phone.json email: type: string format: email minLength: 6 maxLength: 255 timezone: $ref: timezone.json required: - ssn - icn - firstName - lastName - birthDate - homeless if: properties: homeless: const: false then: required: - address claimant: type: object description: If the claimant is not a veteran, claimant information is required. Without this information, we will be unable to identify the claimant. If you're a healthcare provider or an employee of a healthcare provider requesting review of a VA payment decision, you must identify the healthcare provider as the claimant and complete all relevant information in the claimant object. properties: ssn: allOf: - $ref: ssn.json - description: Non-veteran claimant's SSN firstName: type: string description: Non-veteran claimant's first name maxLength: 30 middleInitial: allOf: - $ref: nonBlankString.json - description: Non-veteran claimant's middle initial maxLength: 1 lastName: allOf: - $ref: nonBlankString.json - description: Non-veteran claimant's last name maxLength: 40 birthDate: description: Non-veteran claimant's birth date type: string format: date address: $ref: address.json phone: $ref: phone.json email: type: string format: email minLength: 6 maxLength: 255 timezone: $ref: timezone.json required: - ssn - firstName - lastName - birthDate - address - phone informalConferenceContact: type: string enum: - veteran - representative informalConferenceTime: type: string enum: - 800-1200 ET - 1200-1630 ET informalConferenceRep: type: object description: The Representative information listed MUST match the current Power of Attorney for the Veteran. Any changes to the Power of Attorney must be submitted via a VA 21-22 form separately. properties: firstName: type: string maxLength: 30 lastName: type: string maxLength: 40 phone: $ref: phone.json email: type: string format: email minLength: 6 maxLength: 255 required: - firstName - lastName - phone required: - informalConference - benefitType - veteran if: properties: informalConference: const: true then: required: - informalConferenceContact - informalConferenceTime required: - type - attributes included: type: array items: type: object properties: type: type: string enum: - appealableIssue attributes: type: object properties: issue: allOf: - $ref: nonBlankString.json - minLength: 1 maxLength: 140 decisionDate: type: string format: date decisionIssueId: type: integer ratingIssueReferenceId: type: string ratingDecisionReferenceId: type: string socDate: type: string format: date disagreementArea: type: string maxLength: 90 required: - issue - decisionDate required: - type - attributes minItems: 1 uniqueItems: true required: - data - included address: value: $schema: http://json-schema.org/draft-2020-12/schema# description: 'JSON Schema for VA Decision Review Forms: ''address''' properties: address: type: object properties: addressLine1: type: string minLength: 1 maxLength: 60 addressLine2: type: string minLength: 1 maxLength: 30 addressLine3: type: string minLength: 1 maxLength: 10 city: type: string minLength: 1 maxLength: 60 stateCode: type: string enum: - AL - AK - AS - AZ - AR - AA - AE - AP - CA - CO - CT - DE - DC - FM - FL - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MH - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - MP - OH - OK - OR - PW - PA - PR - RI - SC - SD - TN - TX - UT - VT - VI - VA - WA - WV - WI - WY countryCodeIso3: description: Three letter ISO 3166-1 country code type: string pattern: ^[A-Z]{3}$ minLength: 3 maxLength: 3 example: USA zipCode5: type: string description: Five digit zipcode. Use "00000" if address is outside the United States pattern: ^[0-9]{5}$ minLength: 5 maxLength: 5 internationalPostalCode: type: string minLength: 1 maxLength: 16 required: - addressLine1 - city - countryCodeIso3 - zipCode5 nonBlankString: value: $schema: http://json-schema.org/draft-2020-12/schema# description: 'JSON Schema for VA Decision Review Forms: ''nonBlankString''' properties: nonBlankString: type: string pattern: '[^ \f\n\r\t\v\u00a0\u1680\u2000-\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]' phone: value: $schema: http://json-schema.org/draft-2020-12/schema# description: 'JSON Schema for VA Decision Review Forms: ''phone''' properties: phone: type: object properties: countryCode: type: string pattern: ^[0-9]+$ minLength: 1 maxLength: 3 areaCode: type: string pattern: ^[0-9]{1,4}$ minLength: 1 maxLength: 4 phoneNumber: type: string pattern: ^[0-9]{1,14}$ minLength: 1 maxLength: 14 phoneNumberExt: type: string pattern: ^[a-zA-Z0-9]{1,10}$ minLength: 1 maxLength: 10 required: - areaCode - phoneNumber timezone: value: $schema: http://json-schema.org/draft-2020-12/schema# description: 'JSON Schema for VA Decision Review Forms: ''timezone''' properties: timezone: type: string enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - Africa/Asmera - Africa/Bamako - Africa/Bangui - Africa/Banjul - Africa/Bissau - Africa/Blantyre - Africa/Brazzaville - Africa/Bujumbura - Africa/Cairo - Africa/Casablanca - Africa/Ceuta - Africa/Conakry - Africa/Dakar - Africa/Dar_es_Salaam - Africa/Djibouti - Africa/Douala - Africa/El_Aaiun - Africa/Freetown - Africa/Gaborone - Africa/Harare - Africa/Johannesburg - Africa/Juba - Africa/Kampala - Africa/Khartoum - Africa/Kigali - Africa/Kinshasa - Africa/Lagos - Africa/Libreville - Africa/Lome - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Africa/Malabo - Africa/Maputo - Africa/Maseru - Africa/Mbabane - Africa/Mogadishu - Africa/Monrovia - Africa/Nairobi - Africa/Ndjamena - Africa/Niamey - Africa/Nouakchott - Africa/Ouagadougou - Africa/Porto-Novo - Africa/Sao_Tome - Africa/Timbuktu - Africa/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - America/Argentina/ComodRivadavia - America/Argentina/Cordoba - America/Argentina/Jujuy - America/Argentina/La_Rioja - America/Argentina/Mendoza - America/Argentina/Rio_Gallegos - America/Argentina/Salta - America/Argentina/San_Juan - America/Argentina/San_Luis - America/Argentina/Tucuman - America/Argentina/Ushuaia - America/Aruba - America/Asuncion - America/Atikokan - America/Atka - America/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Buenos_Aires - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Catamarca - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Ciudad_Juarez - America/Coral_Harbour - America/Cordoba - America/Costa_Rica - America/Creston - America/Cuiaba - America/Curacao - America/Danmarkshavn - America/Dawson - America/Dawson_Creek - America/Denver - America/Detroit - America/Dominica - America/Edmonton - America/Eirunepe - America/El_Salvador - America/Ensenada - America/Fort_Nelson - America/Fort_Wayne - America/Fortaleza - America/Glace_Bay - America/Godthab - America/Goose_Bay - America/Grand_Turk - America/Grenada - America/Guadeloupe - America/Guatemala - America/Guayaquil - America/Guyana - America/Halifax - America/Havana - America/Hermosillo - America/Indiana/Indianapolis - America/Indiana/Knox - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Tell_City - America/Indiana/Vevay - America/Indiana/Vincennes - America/Indiana/Winamac - America/Indianapolis - America/Inuvik - America/Iqaluit - America/Jamaica - America/Jujuy - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Knox_IN - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Louisville - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Mendoza - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - America/Montreal - America/Montserrat - America/Nassau - America/New_York - America/Nipigon - America/Nome - America/Noronha - America/North_Dakota/Beulah - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/Nuuk - America/Ojinaga - America/Panama - America/Pangnirtung - America/Paramaribo - America/Phoenix - America/Port-au-Prince - America/Port_of_Spain - America/Porto_Acre - America/Porto_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rainy_River - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Rosario - America/Santa_Isabel - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - America/Shiprock - America/Sitka - America/St_Barthelemy - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - America/Swift_Current - America/Tegucigalpa - America/Thule - America/Thunder_Bay - America/Tijuana - America/Toronto - America/Tortola - America/Vancouver - America/Virgin - America/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/South_Pole - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Ashkhabad - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Calcutta - Asia/Chita - Asia/Choibalsan - Asia/Chongqing - Asia/Chungking - Asia/Colombo - Asia/Dacca - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Harbin - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Istanbul - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kashgar - Asia/Kathmandu - Asia/Katmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Asia/Macao - Asia/Macau - Asia/Magadan - Asia/Makassar - Asia/Manila - Asia/Muscat - Asia/Nicosia - Asia/Novokuznetsk - Asia/Novosibirsk - Asia/Omsk - Asia/Oral - Asia/Phnom_Penh - Asia/Pontianak - Asia/Pyongyang - Asia/Qatar - Asia/Qostanay - Asia/Qyzylorda - Asia/Rangoon - Asia/Riyadh - Asia/Saigon - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Tel_Aviv - Asia/Thimbu - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ujung_Pandang - Asia/Ulaanbaatar - Asia/Ulan_Bator - Asia/Urumqi - Asia/Ust-Nera - Asia/Vientiane - Asia/Vladivostok - Asia/Yakutsk - Asia/Yangon - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Bermuda - Atlantic/Canary - Atlantic/Cape_Verde - Atlantic/Faeroe - Atlantic/Faroe - Atlantic/Jan_Mayen - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/St_Helena - Atlantic/Stanley - Australia/ACT - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Canberra - Australia/Currie - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/LHI - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/NSW - Australia/North - Australia/Perth - Australia/Queensland - Australia/South - Australia/Sydney - Australia/Tasmania - Australia/Victoria - Australia/West - Australia/Yancowinna - Brazil/Acre - Brazil/DeNoronha - Brazil/East - Brazil/West - CET - CST6CDT - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Canada/Saskatchewan - Canada/Yukon - Chile/Continental - Chile/EasterIsland - Cuba - EET - EST - EST5EDT - Egypt - Eire - Etc/GMT - Etc/GMT+0 - Etc/GMT+1 - Etc/GMT+10 - Etc/GMT+11 - Etc/GMT+12 - Etc/GMT+2 - Etc/GMT+3 - Etc/GMT+4 - Etc/GMT+5 - Etc/GMT+6 - Etc/GMT+7 - Etc/GMT+8 - Etc/GMT+9 - Etc/GMT-0 - Etc/GMT-1 - Etc/GMT-10 - Etc/GMT-11 - Etc/GMT-12 - Etc/GMT-13 - Etc/GMT-14 - Etc/GMT-2 - Etc/GMT-3 - Etc/GMT-4 - Etc/GMT-5 - Etc/GMT-6 - Etc/GMT-7 - Etc/GMT-8 - Etc/GMT-9 - Etc/GMT0 - Etc/Greenwich - Etc/UCT - Etc/UTC - Etc/Universal - Etc/Zulu - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - Europe/Belfast - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Busingen - Europe/Chisinau - Europe/Copenhagen - Europe/Dublin - Europe/Gibraltar - Europe/Guernsey - Europe/Helsinki - Europe/Isle_of_Man - Europe/Istanbul - Europe/Jersey - Europe/Kaliningrad - Europe/Kiev - Europe/Kirov - Europe/Kyiv - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - Europe/Nicosia - Europe/Oslo - Europe/Paris - Europe/Podgorica - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/San_Marino - Europe/Sarajevo - Europe/Saratov - Europe/Simferopol - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Tirane - Europe/Tiraspol - Europe/Ulyanovsk - Europe/Uzhgorod - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zaporozhye - Europe/Zurich - Factory - GB - GB-Eire - GMT - GMT+0 - GMT-0 - GMT0 - Greenwich - HST - Hongkong - Iceland - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Iran - Israel - Jamaica - Japan - Kwajalein - Libya - MET - MST - MST7MDT - Mexico/BajaNorte - Mexico/BajaSur - Mexico/General - NZ - NZ-CHAT - Navajo - PRC - PST8PDT - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Enderbury - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Johnston - Pacific/Kanton - Pacific/Kiritimati - Pacific/Kosrae - Pacific/Kwajalein - Pacific/Majuro - Pacific/Marquesas - Pacific/Midway - Pacific/Nauru - Pacific/Niue - Pacific/Norfolk - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Palau - Pacific/Pitcairn - Pacific/Pohnpei - Pacific/Ponape - Pacific/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Samoa - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Truk - Pacific/Wake - Pacific/Wallis - Pacific/Yap - Poland - Portugal - ROC - ROK - Singapore - SystemV/AST4 - SystemV/AST4ADT - SystemV/CST6 - SystemV/CST6CDT - SystemV/EST5 - SystemV/EST5EDT - SystemV/HST10 - SystemV/MST7 - SystemV/MST7MDT - SystemV/PST8 - SystemV/PST8PDT - SystemV/YST9 - SystemV/YST9YDT - Turkey - UCT - US/Alaska - US/Aleutian - US/Arizona - US/Central - US/East-Indiana - US/Eastern - US/Hawaii - US/Indiana-Starke - US/Michigan - US/Mountain - US/Pacific - US/Samoa - UTC - Universal - W-SU - WET - Zulu '404': description: '`schema_type` not found' content: application/json: example: errors: - title: not_found detail: The 'invalid_schema_type' request parameter is invalid code: InvalidSchemaType status: '404' source: parameter: invalid_schema_type meta: available_options: - '200996' - address - fileNumber - icn - nonBlankString - phone - ssn - timezone schema: $ref: '#/components/schemas/errorModel' '500': description: Internal Server Error content: application/json: example: errors: - title: Internal server error detail: Internal server error code: '500' status: '500' schema: $ref: '#/components/schemas/errorModel' /forms/200996/validate: post: summary: Validates a POST request body against the JSON schema. tags: - Higher-Level Reviews operationId: hlrValidate description: Like the POST /higher_level_reviews, but only does the validations —does not submit anything. security: - productionOauth: - veteran/HigherLevelReviews.write - representative/HigherLevelReviews.write - system/HigherLevelReviews.write - sandboxOauth: - veteran/HigherLevelReviews.write - representative/HigherLevelReviews.write - system/HigherLevelReviews.write - bearer_token: [] parameters: [] responses: '200': description: Valid content: application/json: examples: minimum fields used: value: data: type: higherLevelReviewValidation attributes: status: valid all fields used: value: data: type: higherLevelReviewValidation attributes: status: valid schema: type: object properties: data: type: object properties: type: type: string enum: - higherLevelReviewValidation attributes: type: object properties: status: type: string enum: - valid '400': description: Bad request content: application/json: examples: Not JSON object: value: errors: - code: '109' detail: The request body isn't a JSON object status: '400' title: Bad Request schema: $ref: '#/components/schemas/errorModel' '422': description: Error content: application/json: examples: Violates JSON schema: value: errors: - title: Missing required fields detail: One or more expected fields were not found code: '145' source: pointer: /data/attributes status: '422' meta: missing_fields: - informalConference schema: $ref: '#/components/schemas/errorModel' '500': description: Internal Server Error content: application/json: example: errors: - title: Internal server error detail: Internal server error code: '500' status: '500' schema: $ref: '#/components/schemas/errorModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/hlrCreate_2' examples: minimum fields used: value: data: type: higherLevelReview attributes: informalConference: false benefitType: lifeInsurance veteran: icn: 1012667145V762142 ssn: '123456789' firstName: Jane lastName: Doe birthDate: '1969-12-31' homeless: false address: addressLine1: 123 Some St. city: Sometown countryCodeIso3: USA zipCode5: '12345' included: - type: appealableIssue attributes: issue: left shoulder decisionDate: '1920-12-01' all fields used: value: data: type: higherLevelReview attributes: benefitType: education veteran: icn: 1012667145V762142 ssn: '123456789' firstName: Jäñe middleInitial: ø lastName: Doé birthDate: '1969-12-31' fileNumber: '987654321' serviceNumber: '876543210' insurancePolicyNumber: '987654321123456789' homeless: true address: addressLine1: 123 Main St addressLine2: 'Suite #1200' addressLine3: Box 4 city: New York countryCodeIso3: USA stateCode: NY zipCode5: '30012' phone: countryCode: '34' areaCode: '555' phoneNumber: '8001111' phoneNumberExt: '2' email: bob@bobbytablesemail.com timezone: America/Chicago claimant: ssn: '829347561' birthDate: '1972-05-08' firstName: Betty middleInitial: D lastName: Boop address: addressLine1: 456 First St addressLine2: Apt 5 addressLine3: Box 1 city: Detroit countryCodeIso3: USA stateCode: MI zipCode5: '48070' phone: countryCode: '1' areaCode: '555' phoneNumber: '8111100' phoneNumberExt: '4' email: claimant@email.com timezone: America/Detroit informalConference: true informalConferenceContact: veteran informalConferenceTime: 800-1200 ET informalConferenceRep: firstName: Helen lastName: Holly email: holly@hellohellenholly.com phone: countryCode: '1' areaCode: '555' phoneNumber: '8001111' phoneNumberExt: '2' included: - type: appealableIssue attributes: issue: '123456789' decisionDate: '1900-01-01' decisionIssueId: 1 ratingIssueReferenceId: '2' ratingDecisionReferenceId: '3' socDate: '2020-04-30' disagreementArea: Rating - type: appealableIssue attributes: issue: left eyee decisionDate: '1900-01-02' disagreementArea: '123456789' - type: appealableIssue attributes: issue: right eye decisionDate: '1900-01-03' - type: appealableIssue attributes: issue: left ear decisionDate: '1900-01-04' socDate: '2019-05-15' disagreementArea: Rating - type: appealableIssue attributes: issue: right ear decisionDate: '1900-01-05' disagreementArea: Rating - type: appealableIssue attributes: issue: migraines decisionDate: '1900-01-06' disagreementArea: Rating - type: appealableIssue attributes: issue: left knee decisionDate: '1900-01-07' disagreementArea: Rating - type: appealableIssue attributes: issue: right knee decisionDate: '1900-01-08' disagreementArea: Rating - type: appealableIssue attributes: issue: left foot decisionDate: '1900-01-09' disagreementArea: Rating - type: appealableIssue attributes: issue: right foot decisionDate: '1900-01-10' socDate: '2021-01-08' disagreementArea: Rating - type: appealableIssue attributes: issue: left hand decisionDate: '1900-01-11' disagreementArea: Rating - type: appealableIssue attributes: issue: right hand decisionDate: '1900-01-12' disagreementArea: Rating - type: appealableIssue attributes: issue: fever decisionDate: '1900-01-13' disagreementArea: Service connection - type: appealableIssue attributes: issue: lupus decisionDate: '1900-01-14' socDate: '2020-09-23' - type: appealableIssue attributes: issue: cooties decisionDate: '1900-01-15' disagreementArea: Service connection components: schemas: hlrCreate: type: object properties: data: type: object properties: type: type: string enum: - higherLevelReview attributes: description: 'If informal conference requested (`informalConference: true`), contact (`informalConferenceContact`) and time (`informalConferenceTime`) must be specified.' type: object additionalProperties: false properties: informalConference: type: boolean benefitType: type: string enum: - compensation - pensionSurvivorsBenefits - fiduciary - lifeInsurance - veteransHealthAdministration - veteranReadinessAndEmployment - loanGuaranty - education - nationalCemeteryAdministration veteran: type: object properties: homeless: type: boolean address: type: object properties: addressLine1: type: string maxLength: 60 addressLine2: type: string maxLength: 30 addressLine3: type: string maxLength: 10 city: type: string maxLength: 60 stateCode: type: string enum: - AL - AK - AS - AZ - AR - AA - AE - AP - CA - CO - CT - DE - DC - FM - FL - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MH - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - MP - OH - OK - OR - PW - PA - PR - RI - SC - SD - TN - TX - UT - VT - VI - VA - WA - WV - WI - WY countryCodeISO2: type: string pattern: ^[A-Z]{2}$ minLength: 2 maxLength: 2 zipCode5: type: string description: 5-digit zipcode. Use "00000" if Veteran is outside the United States pattern: ^[0-9]{5}$ internationalPostalCode: type: string maxLength: 16 additionalProperties: false required: - addressLine1 - city - countryCodeISO2 - zipCode5 phone: $ref: '#/components/schemas/hlrCreatePhone' email: type: string format: email minLength: 6 maxLength: 255 timezone: type: string description: Veteran's timezone. Used for adding the current date to the signature according to the veteran's local time. If not specified, the current UTC date will be used for the signature (which may be ahead or behind the local date). enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - Africa/Asmera - Africa/Bamako - Africa/Bangui - Africa/Banjul - Africa/Bissau - Africa/Blantyre - Africa/Brazzaville - Africa/Bujumbura - Africa/Cairo - Africa/Casablanca - Africa/Ceuta - Africa/Conakry - Africa/Dakar - Africa/Dar_es_Salaam - Africa/Djibouti - Africa/Douala - Africa/El_Aaiun - Africa/Freetown - Africa/Gaborone - Africa/Harare - Africa/Johannesburg - Africa/Juba - Africa/Kampala - Africa/Khartoum - Africa/Kigali - Africa/Kinshasa - Africa/Lagos - Africa/Libreville - Africa/Lome - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Africa/Malabo - Africa/Maputo - Africa/Maseru - Africa/Mbabane - Africa/Mogadishu - Africa/Monrovia - Africa/Nairobi - Africa/Ndjamena - Africa/Niamey - Africa/Nouakchott - Africa/Ouagadougou - Africa/Porto-Novo - Africa/Sao_Tome - Africa/Timbuktu - Africa/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - America/Argentina/ComodRivadavia - America/Argentina/Cordoba - America/Argentina/Jujuy - America/Argentina/La_Rioja - America/Argentina/Mendoza - America/Argentina/Rio_Gallegos - America/Argentina/Salta - America/Argentina/San_Juan - America/Argentina/San_Luis - America/Argentina/Tucuman - America/Argentina/Ushuaia - America/Aruba - America/Asuncion - America/Atikokan - America/Atka - America/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Buenos_Aires - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Catamarca - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Ciudad_Juarez - America/Coral_Harbour - America/Cordoba - America/Costa_Rica - America/Creston - America/Cuiaba - America/Curacao - America/Danmarkshavn - America/Dawson - America/Dawson_Creek - America/Denver - America/Detroit - America/Dominica - America/Edmonton - America/Eirunepe - America/El_Salvador - America/Ensenada - America/Fort_Nelson - America/Fort_Wayne - America/Fortaleza - America/Glace_Bay - America/Godthab - America/Goose_Bay - America/Grand_Turk - America/Grenada - America/Guadeloupe - America/Guatemala - America/Guayaquil - America/Guyana - America/Halifax - America/Havana - America/Hermosillo - America/Indiana/Indianapolis - America/Indiana/Knox - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Tell_City - America/Indiana/Vevay - America/Indiana/Vincennes - America/Indiana/Winamac - America/Indianapolis - America/Inuvik - America/Iqaluit - America/Jamaica - America/Jujuy - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Knox_IN - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Louisville - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Mendoza - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - America/Montreal - America/Montserrat - America/Nassau - America/New_York - America/Nipigon - America/Nome - America/Noronha - America/North_Dakota/Beulah - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/Nuuk - America/Ojinaga - America/Panama - America/Pangnirtung - America/Paramaribo - America/Phoenix - America/Port-au-Prince - America/Port_of_Spain - America/Porto_Acre - America/Porto_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rainy_River - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Rosario - America/Santa_Isabel - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - America/Shiprock - America/Sitka - America/St_Barthelemy - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - America/Swift_Current - America/Tegucigalpa - America/Thule - America/Thunder_Bay - America/Tijuana - America/Toronto - America/Tortola - America/Vancouver - America/Virgin - America/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/South_Pole - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Ashkhabad - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Calcutta - Asia/Chita - Asia/Choibalsan - Asia/Chongqing - Asia/Chungking - Asia/Colombo - Asia/Dacca - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Harbin - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Istanbul - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kashgar - Asia/Kathmandu - Asia/Katmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Asia/Macao - Asia/Macau - Asia/Magadan - Asia/Makassar - Asia/Manila - Asia/Muscat - Asia/Nicosia - Asia/Novokuznetsk - Asia/Novosibirsk - Asia/Omsk - Asia/Oral - Asia/Phnom_Penh - Asia/Pontianak - Asia/Pyongyang - Asia/Qatar - Asia/Qostanay - Asia/Qyzylorda - Asia/Rangoon - Asia/Riyadh - Asia/Saigon - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Tel_Aviv - Asia/Thimbu - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ujung_Pandang - Asia/Ulaanbaatar - Asia/Ulan_Bator - Asia/Urumqi - Asia/Ust-Nera - Asia/Vientiane - Asia/Vladivostok - Asia/Yakutsk - Asia/Yangon - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Bermuda - Atlantic/Canary - Atlantic/Cape_Verde - Atlantic/Faeroe - Atlantic/Faroe - Atlantic/Jan_Mayen - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/St_Helena - Atlantic/Stanley - Australia/ACT - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Canberra - Australia/Currie - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/LHI - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/NSW - Australia/North - Australia/Perth - Australia/Queensland - Australia/South - Australia/Sydney - Australia/Tasmania - Australia/Victoria - Australia/West - Australia/Yancowinna - Brazil/Acre - Brazil/DeNoronha - Brazil/East - Brazil/West - CET - CST6CDT - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Canada/Saskatchewan - Canada/Yukon - Chile/Continental - Chile/EasterIsland - Cuba - EET - EST - EST5EDT - Egypt - Eire - Etc/GMT - Etc/GMT+0 - Etc/GMT+1 - Etc/GMT+10 - Etc/GMT+11 - Etc/GMT+12 - Etc/GMT+2 - Etc/GMT+3 - Etc/GMT+4 - Etc/GMT+5 - Etc/GMT+6 - Etc/GMT+7 - Etc/GMT+8 - Etc/GMT+9 - Etc/GMT-0 - Etc/GMT-1 - Etc/GMT-10 - Etc/GMT-11 - Etc/GMT-12 - Etc/GMT-13 - Etc/GMT-14 - Etc/GMT-2 - Etc/GMT-3 - Etc/GMT-4 - Etc/GMT-5 - Etc/GMT-6 - Etc/GMT-7 - Etc/GMT-8 - Etc/GMT-9 - Etc/GMT0 - Etc/Greenwich - Etc/UCT - Etc/UTC - Etc/Universal - Etc/Zulu - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - Europe/Belfast - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Busingen - Europe/Chisinau - Europe/Copenhagen - Europe/Dublin - Europe/Gibraltar - Europe/Guernsey - Europe/Helsinki - Europe/Isle_of_Man - Europe/Istanbul - Europe/Jersey - Europe/Kaliningrad - Europe/Kiev - Europe/Kirov - Europe/Kyiv - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - Europe/Nicosia - Europe/Oslo - Europe/Paris - Europe/Podgorica - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/San_Marino - Europe/Sarajevo - Europe/Saratov - Europe/Simferopol - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Tirane - Europe/Tiraspol - Europe/Ulyanovsk - Europe/Uzhgorod - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zaporozhye - Europe/Zurich - Factory - GB - GB-Eire - GMT - GMT+0 - GMT-0 - GMT0 - Greenwich - HST - Hongkong - Iceland - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Iran - Israel - Jamaica - Japan - Kwajalein - Libya - MET - MST - MST7MDT - Mexico/BajaNorte - Mexico/BajaSur - Mexico/General - NZ - NZ-CHAT - Navajo - PRC - PST8PDT - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Enderbury - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Johnston - Pacific/Kanton - Pacific/Kiritimati - Pacific/Kosrae - Pacific/Kwajalein - Pacific/Majuro - Pacific/Marquesas - Pacific/Midway - Pacific/Nauru - Pacific/Niue - Pacific/Norfolk - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Palau - Pacific/Pitcairn - Pacific/Pohnpei - Pacific/Ponape - Pacific/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Samoa - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Truk - Pacific/Wake - Pacific/Wallis - Pacific/Yap - Poland - Portugal - ROC - ROK - Singapore - Turkey - UCT - US/Alaska - US/Aleutian - US/Arizona - US/Central - US/East-Indiana - US/Eastern - US/Hawaii - US/Indiana-Starke - US/Michigan - US/Mountain - US/Pacific - US/Samoa - UTC - Universal - W-SU - WET - Zulu additionalProperties: false required: - homeless if: properties: homeless: const: false then: required: - address claimant: type: object description: If the claimant is a non-Veteran, claimant information is required. Without this information, we will be unable to identify the claimant. If you're a healthcare provider or an employee of a healthcare provider requesting review of a VA payment decision, you must identify the healthcare provider as the claimant and complete all relevant information in the claimant object. properties: address: type: object properties: addressLine1: type: string minLength: 1 maxLength: 60 addressLine2: type: string minLength: 1 maxLength: 30 addressLine3: type: string minLength: 1 maxLength: 10 city: type: string minLength: 1 maxLength: 60 stateCode: type: string enum: - AL - AK - AS - AZ - AR - AA - AE - AP - CA - CO - CT - DE - DC - FM - FL - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MH - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - MP - OH - OK - OR - PW - PA - PR - RI - SC - SD - TN - TX - UT - VT - VI - VA - WA - WV - WI - WY countryCodeISO2: type: string pattern: ^[A-Z]{2}$ minLength: 2 maxLength: 2 zipCode5: type: string description: 5-digit zipcode. Use "00000" if Veteran is outside the United States pattern: ^[0-9]{5}$ internationalPostalCode: type: string maxLength: 16 additionalProperties: false required: - addressLine1 - city - countryCodeISO2 - zipCode5 phone: $ref: '#/components/schemas/hlrCreatePhone' email: type: string format: email minLength: 6 maxLength: 255 timezone: type: string description: Claimant's timezone. Used for adding the current date to the signature according to the claimant's local time. If not specified, the current UTC date will be used for the signature (which may be ahead or behind the local date). enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - Africa/Asmera - Africa/Bamako - Africa/Bangui - Africa/Banjul - Africa/Bissau - Africa/Blantyre - Africa/Brazzaville - Africa/Bujumbura - Africa/Cairo - Africa/Casablanca - Africa/Ceuta - Africa/Conakry - Africa/Dakar - Africa/Dar_es_Salaam - Africa/Djibouti - Africa/Douala - Africa/El_Aaiun - Africa/Freetown - Africa/Gaborone - Africa/Harare - Africa/Johannesburg - Africa/Juba - Africa/Kampala - Africa/Khartoum - Africa/Kigali - Africa/Kinshasa - Africa/Lagos - Africa/Libreville - Africa/Lome - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Africa/Malabo - Africa/Maputo - Africa/Maseru - Africa/Mbabane - Africa/Mogadishu - Africa/Monrovia - Africa/Nairobi - Africa/Ndjamena - Africa/Niamey - Africa/Nouakchott - Africa/Ouagadougou - Africa/Porto-Novo - Africa/Sao_Tome - Africa/Timbuktu - Africa/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - America/Argentina/ComodRivadavia - America/Argentina/Cordoba - America/Argentina/Jujuy - America/Argentina/La_Rioja - America/Argentina/Mendoza - America/Argentina/Rio_Gallegos - America/Argentina/Salta - America/Argentina/San_Juan - America/Argentina/San_Luis - America/Argentina/Tucuman - America/Argentina/Ushuaia - America/Aruba - America/Asuncion - America/Atikokan - America/Atka - America/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Buenos_Aires - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Catamarca - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Ciudad_Juarez - America/Coral_Harbour - America/Cordoba - America/Costa_Rica - America/Creston - America/Cuiaba - America/Curacao - America/Danmarkshavn - America/Dawson - America/Dawson_Creek - America/Denver - America/Detroit - America/Dominica - America/Edmonton - America/Eirunepe - America/El_Salvador - America/Ensenada - America/Fort_Nelson - America/Fort_Wayne - America/Fortaleza - America/Glace_Bay - America/Godthab - America/Goose_Bay - America/Grand_Turk - America/Grenada - America/Guadeloupe - America/Guatemala - America/Guayaquil - America/Guyana - America/Halifax - America/Havana - America/Hermosillo - America/Indiana/Indianapolis - America/Indiana/Knox - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Tell_City - America/Indiana/Vevay - America/Indiana/Vincennes - America/Indiana/Winamac - America/Indianapolis - America/Inuvik - America/Iqaluit - America/Jamaica - America/Jujuy - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Knox_IN - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Louisville - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Mendoza - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - America/Montreal - America/Montserrat - America/Nassau - America/New_York - America/Nipigon - America/Nome - America/Noronha - America/North_Dakota/Beulah - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/Nuuk - America/Ojinaga - America/Panama - America/Pangnirtung - America/Paramaribo - America/Phoenix - America/Port-au-Prince - America/Port_of_Spain - America/Porto_Acre - America/Porto_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rainy_River - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Rosario - America/Santa_Isabel - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - America/Shiprock - America/Sitka - America/St_Barthelemy - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - America/Swift_Current - America/Tegucigalpa - America/Thule - America/Thunder_Bay - America/Tijuana - America/Toronto - America/Tortola - America/Vancouver - America/Virgin - America/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/South_Pole - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Ashkhabad - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Calcutta - Asia/Chita - Asia/Choibalsan - Asia/Chongqing - Asia/Chungking - Asia/Colombo - Asia/Dacca - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Harbin - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Istanbul - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kashgar - Asia/Kathmandu - Asia/Katmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Asia/Macao - Asia/Macau - Asia/Magadan - Asia/Makassar - Asia/Manila - Asia/Muscat - Asia/Nicosia - Asia/Novokuznetsk - Asia/Novosibirsk - Asia/Omsk - Asia/Oral - Asia/Phnom_Penh - Asia/Pontianak - Asia/Pyongyang - Asia/Qatar - Asia/Qostanay - Asia/Qyzylorda - Asia/Rangoon - Asia/Riyadh - Asia/Saigon - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Tel_Aviv - Asia/Thimbu - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ujung_Pandang - Asia/Ulaanbaatar - Asia/Ulan_Bator - Asia/Urumqi - Asia/Ust-Nera - Asia/Vientiane - Asia/Vladivostok - Asia/Yakutsk - Asia/Yangon - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Bermuda - Atlantic/Canary - Atlantic/Cape_Verde - Atlantic/Faeroe - Atlantic/Faroe - Atlantic/Jan_Mayen - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/St_Helena - Atlantic/Stanley - Australia/ACT - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Canberra - Australia/Currie - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/LHI - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/NSW - Australia/North - Australia/Perth - Australia/Queensland - Australia/South - Australia/Sydney - Australia/Tasmania - Australia/Victoria - Australia/West - Australia/Yancowinna - Brazil/Acre - Brazil/DeNoronha - Brazil/East - Brazil/West - CET - CST6CDT - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Canada/Saskatchewan - Canada/Yukon - Chile/Continental - Chile/EasterIsland - Cuba - EET - EST - EST5EDT - Egypt - Eire - Etc/GMT - Etc/GMT+0 - Etc/GMT+1 - Etc/GMT+10 - Etc/GMT+11 - Etc/GMT+12 - Etc/GMT+2 - Etc/GMT+3 - Etc/GMT+4 - Etc/GMT+5 - Etc/GMT+6 - Etc/GMT+7 - Etc/GMT+8 - Etc/GMT+9 - Etc/GMT-0 - Etc/GMT-1 - Etc/GMT-10 - Etc/GMT-11 - Etc/GMT-12 - Etc/GMT-13 - Etc/GMT-14 - Etc/GMT-2 - Etc/GMT-3 - Etc/GMT-4 - Etc/GMT-5 - Etc/GMT-6 - Etc/GMT-7 - Etc/GMT-8 - Etc/GMT-9 - Etc/GMT0 - Etc/Greenwich - Etc/UCT - Etc/UTC - Etc/Universal - Etc/Zulu - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - Europe/Belfast - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Busingen - Europe/Chisinau - Europe/Copenhagen - Europe/Dublin - Europe/Gibraltar - Europe/Guernsey - Europe/Helsinki - Europe/Isle_of_Man - Europe/Istanbul - Europe/Jersey - Europe/Kaliningrad - Europe/Kiev - Europe/Kirov - Europe/Kyiv - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - Europe/Nicosia - Europe/Oslo - Europe/Paris - Europe/Podgorica - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/San_Marino - Europe/Sarajevo - Europe/Saratov - Europe/Simferopol - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Tirane - Europe/Tiraspol - Europe/Ulyanovsk - Europe/Uzhgorod - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zaporozhye - Europe/Zurich - Factory - GB - GB-Eire - GMT - GMT+0 - GMT-0 - GMT0 - Greenwich - HST - Hongkong - Iceland - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Iran - Israel - Jamaica - Japan - Kwajalein - Libya - MET - MST - MST7MDT - Mexico/BajaNorte - Mexico/BajaSur - Mexico/General - NZ - NZ-CHAT - Navajo - PRC - PST8PDT - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Enderbury - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Johnston - Pacific/Kanton - Pacific/Kiritimati - Pacific/Kosrae - Pacific/Kwajalein - Pacific/Majuro - Pacific/Marquesas - Pacific/Midway - Pacific/Nauru - Pacific/Niue - Pacific/Norfolk - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Palau - Pacific/Pitcairn - Pacific/Pohnpei - Pacific/Ponape - Pacific/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Samoa - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Truk - Pacific/Wake - Pacific/Wallis - Pacific/Yap - Poland - Portugal - ROC - ROK - Singapore - Turkey - UCT - US/Alaska - US/Aleutian - US/Arizona - US/Central - US/East-Indiana - US/Eastern - US/Hawaii - US/Indiana-Starke - US/Michigan - US/Mountain - US/Pacific - US/Samoa - UTC - Universal - W-SU - WET - Zulu required: - address - phone informalConferenceContact: type: string enum: - veteran - representative informalConferenceTime: type: string enum: - 800-1200 ET - 1200-1630 ET informalConferenceRep: type: object description: The Representative information listed MUST match the current Power of Attorney for the Veteran. Any changes to the Power of Attorney must be submitted via a VA 21-22 form separately. properties: firstName: type: string maxLength: 30 lastName: type: string maxLength: 40 phone: $ref: '#/components/schemas/hlrCreatePhone' email: type: string format: email minLength: 6 maxLength: 255 additionalProperties: false required: - firstName - lastName - phone socOptIn: type: boolean required: - informalConference - benefitType - veteran - socOptIn if: properties: informalConference: const: true then: required: - informalConferenceContact - informalConferenceTime additionalProperties: false required: - type - attributes included: type: array items: type: object properties: type: type: string enum: - contestableIssue - appealableIssue attributes: type: object properties: issue: allOf: - $ref: '#/components/schemas/nonBlankString' - maxLength: 140 decisionDate: type: string format: date decisionIssueId: type: integer ratingIssueReferenceId: type: string ratingDecisionReferenceId: type: string socDate: type: string format: date disagreementArea: type: string maxLength: 90 additionalProperties: false required: - issue - decisionDate additionalProperties: false required: - type - attributes minItems: 1 uniqueItems: true additionalProperties: false required: - data - included X-VA-Last-Name: allOf: - description: last name - $ref: '#/components/schemas/nonBlankString' X-VA-NonVeteranClaimant-SSN: type: string description: Non-Veteran claimants's SSN pattern: ^[0-9]{9}$ icn: type: string description: Veteran's Master Person Index (MPI) Integration Control Number (ICN) pattern: ^[0-9]{10}V[0-9]{6}$ minLength: 17 maxLength: 17 example: 1012832025V743496 X-VA-NonVeteranClaimant-Middle-Initial: allOf: - description: middle initial - $ref: '#/components/schemas/nonBlankString' hlrCreatePhone: type: object properties: countryCode: type: string pattern: ^[0-9]+$ minLength: 1 maxLength: 3 areaCode: type: string pattern: ^[0-9]{1,4}$ minLength: 1 maxLength: 4 phoneNumber: type: string pattern: ^[0-9]{1,14}$ minLength: 1 maxLength: 14 phoneNumberExt: type: string pattern: ^[a-zA-Z0-9]{1,10}$ minLength: 1 maxLength: 10 required: - phoneNumber X-VA-NonVeteranClaimant-Birth-Date: description: Non-veteran claimant's birth date type: string format: date X-VA-Receipt-Date: description: (yyyy-mm-dd) Date to limit the contestable issues type: string format: date X-VA-ICN: description: Veteran's Integration Control Number, a unique identifier established via the Master Person Index (MPI) type: string minLength: 17 maxLength: 17 pattern: ^[0-9]{10}V[0-9]{6}$ hlrCreate_2: type: object description: JSON Schema for VA Form 20-0996 properties: data: type: object properties: type: type: string enum: - higherLevelReview attributes: description: 'If informal conference requested (`informalConference: true`), contact (`informalConferenceContact`) and time (`informalConferenceTime`) must be specified.' type: object properties: informalConference: type: boolean benefitType: type: string enum: - compensation - pensionSurvivorsBenefits - fiduciary - lifeInsurance - veteransHealthAdministration - veteranReadinessAndEmployment - loanGuaranty - education - nationalCemeteryAdministration veteran: type: object properties: ssn: allOf: - $ref: '#/components/schemas/ssn' - description: Veteran's SSN icn: $ref: '#/components/schemas/icn' firstName: allOf: - description: Veteran's first name minLength: 1 maxLength: 30 - $comment: can be whitespace, to accommodate those with 1 legal name - $ref: '#/components/schemas/nonBlankString' middleInitial: allOf: - description: Veteran's middle initial minLength: 1 maxLength: 1 - $ref: '#/components/schemas/nonBlankString' lastName: allOf: - description: Veteran's last name minLength: 1 maxLength: 40 - $ref: '#/components/schemas/nonBlankString' birthDate: description: Veteran's birth date type: string format: date fileNumber: $ref: '#/components/schemas/fileNumber' insurancePolicyNumber: allOf: - description: Veteran's insurance policy number maxLength: 18 - $ref: '#/components/schemas/nonBlankString' homeless: type: boolean address: $ref: '#/components/schemas/address' phone: $ref: '#/components/schemas/phone' email: type: string format: email minLength: 6 maxLength: 255 timezone: $ref: '#/components/schemas/timezone' required: - ssn - icn - firstName - lastName - birthDate - homeless if: properties: homeless: const: false then: required: - address claimant: type: object description: If the claimant is not a veteran, claimant information is required. Without this information, we will be unable to identify the claimant. If you're a healthcare provider or an employee of a healthcare provider requesting review of a VA payment decision, you must identify the healthcare provider as the claimant and complete all relevant information in the claimant object. properties: ssn: allOf: - $ref: '#/components/schemas/ssn' - description: Non-veteran claimant's SSN firstName: type: string description: Non-veteran claimant's first name maxLength: 30 $comment: can be whitespace, to accommodate those with 1 legal name middleInitial: allOf: - $ref: '#/components/schemas/nonBlankString' - description: Non-veteran claimant's middle initial maxLength: 1 lastName: allOf: - $ref: '#/components/schemas/nonBlankString' - description: Non-veteran claimant's last name maxLength: 40 birthDate: description: Non-veteran claimant's birth date type: string format: date address: $ref: '#/components/schemas/address' phone: $ref: '#/components/schemas/phone' email: type: string format: email minLength: 6 maxLength: 255 timezone: $ref: '#/components/schemas/timezone' required: - ssn - firstName - lastName - birthDate - address - phone informalConferenceContact: type: string enum: - veteran - representative informalConferenceTime: type: string enum: - 800-1200 ET - 1200-1630 ET informalConferenceRep: type: object description: The Representative information listed MUST match the current Power of Attorney for the Veteran. Any changes to the Power of Attorney must be submitted via a VA 21-22 form separately. properties: firstName: type: string maxLength: 30 lastName: type: string maxLength: 40 phone: $ref: '#/components/schemas/phone' email: type: string format: email minLength: 6 maxLength: 255 required: - firstName - lastName - phone required: - informalConference - benefitType - veteran if: properties: informalConference: const: true then: required: - informalConferenceContact - informalConferenceTime required: - type - attributes included: type: array items: type: object properties: type: type: string enum: - appealableIssue attributes: type: object properties: issue: allOf: - $ref: '#/components/schemas/nonBlankString' - minLength: 1 maxLength: 140 decisionDate: type: string format: date decisionIssueId: type: integer ratingIssueReferenceId: type: string ratingDecisionReferenceId: type: string socDate: type: string format: date disagreementArea: type: string maxLength: 90 required: - issue - decisionDate required: - type - attributes minItems: 1 uniqueItems: true required: - data - included errorModel: required: - errors properties: errors: type: array items: additionalProperties: false required: - title properties: title: type: string description: HTTP error title detail: type: string description: HTTP error detail code: type: string description: HTTP error code source: type: object additionalProperties: false description: Source of error properties: pointer: type: string description: Pointer to source of error parameter: type: string description: Invalid request parameter header: type: string description: Invalid header status: type: string description: HTTP error code meta: type: object description: Meta infomation properties: missing_fields: type: array items: type: string description: List of missing fields contestableIssue: type: object description: A contestable issue (to contest this, you include it as a RequestIssue when creating a HigherLevelReview, SupplementalClaim, or Appeal) properties: type: type: string enum: - contestableIssue id: type: string nullable: true attributes: type: object properties: ratingIssueReferenceId: type: string nullable: true description: RatingIssue ID example: '2385' ratingIssueProfileDate: type: string nullable: true format: date description: (yyyy-mm-dd) RatingIssue profile date example: '2006-05-31' ratingIssueDiagnosticCode: type: string nullable: true description: RatingIssue diagnostic code example: '5005' ratingDecisionReferenceId: type: string nullable: true description: The BGS ID for the contested rating decision. This may be populated while ratingIssueReferenceId is nil example: null decisionIssueId: type: integer nullable: true description: DecisionIssue ID example: null approxDecisionDate: type: string nullable: true format: date description: (yyyy-mm-dd) Approximate decision date example: '2006-11-27' description: type: string nullable: true description: Description example: Service connection for hypertension is granted with an evaluation of 10 percent effective July 24, 2005. rampClaimId: type: string nullable: true description: RampClaim ID example: null titleOfActiveReview: type: string nullable: true description: Title of DecisionReview that this issue is still active on example: null sourceReviewType: type: string nullable: true description: The type of DecisionReview (HigherLevelReview, SupplementalClaim, Appeal) the issue was last decided on (if any) example: null timely: type: boolean description: An issue is timely if the receipt date is within 372 dates of the decision date. example: false activeReview: type: boolean description: Indicates whether this issue is already part of an active Decision Review that is being processed by VA. Submitting a Decision Review that includes a listed issue with an activeReview of true may result in VA rejecting the submission. example: false latestIssuesInChain: type: array description: Shows the chain of decision and rating issues that preceded this issue. Only the most recent issue can be contested (the object itself that contains the latestIssuesInChain attribute). items: type: object properties: id: oneOf: - type: string nullable: true - type: integer example: null approxDecisionDate: type: string nullable: true format: date example: '2006-11-27' ratingIssueSubjectText: type: string nullable: true description: Short description of RatingIssue example: Hypertension ratingIssuePercentNumber: type: string nullable: true description: Numerical rating for RatingIssue example: '10' isRating: type: boolean description: Whether or not this is a RatingIssue example: true X-VA-NonVeteranClaimant-Last-Name: allOf: - description: last name - $ref: '#/components/schemas/nonBlankString' hlrShow: type: object properties: data: properties: id: $ref: '#/components/schemas/uuid' type: type: string enum: - higherLevelReview attributes: properties: status: type: string example: pending enum: - pending - submitting - submitted - processing - success - complete - error updatedAt: description: The last time the submission was updated type: string format: date-time example: '2018-07-30T17:31:15.958Z' createdAt: description: The time the submission was created type: string format: date-time example: '2018-07-30T17:31:15.958Z' required: - id - type - attributes required: - data X-VA-File-Number: allOf: - description: VA file number (c-file / css) - maxLength: 9 - $ref: '#/components/schemas/nonBlankString' uuid: type: string pattern: ^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$ hlrShow_2: type: object properties: data: properties: id: $ref: '#/components/schemas/uuid' type: type: string enum: - higherLevelReview attributes: properties: status: type: string example: pending enum: - pending - submitting - submitted - processing - success - complete - error updateDate: description: The last time the submission was updated type: string format: date-time example: '2018-07-30T17:31:15.958Z' createDate: description: The time the submission was created type: string format: date-time example: '2018-07-30T17:31:15.958Z' required: - id - type - attributes required: - data contestableIssues: type: object properties: data: type: array items: $ref: '#/components/schemas/contestableIssue' X-VA-SSN: description: social security number type: string minLength: 9 maxLength: 9 pattern: ^[0-9]{9}$ phone: type: object properties: countryCode: type: string pattern: ^[0-9]+$ minLength: 1 maxLength: 3 areaCode: type: string pattern: ^[0-9]{1,4}$ minLength: 1 maxLength: 4 phoneNumber: type: string pattern: ^[0-9]{1,14}$ minLength: 1 maxLength: 14 phoneNumberExt: type: string pattern: ^[a-zA-Z0-9]{1,10}$ minLength: 1 maxLength: 10 required: - areaCode - phoneNumber ssn: type: string description: Social Security Number pattern: ^[0-9]{9} minLength: 9 maxLength: 9 nonBlankString: type: string pattern: '[^ \f\n\r\t\v\u00a0\u1680\u2000-\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]' X-VA-Birth-Date: description: Veteran's birth date type: string format: date fileNumber: description: Veteran's VA file number (c-file / css) type: string minLength: 7 maxLength: 9 example: '987654321' X-VA-Middle-Initial: allOf: - description: middle initial - $ref: '#/components/schemas/nonBlankString' timezone: type: string enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - Africa/Asmera - Africa/Bamako - Africa/Bangui - Africa/Banjul - Africa/Bissau - Africa/Blantyre - Africa/Brazzaville - Africa/Bujumbura - Africa/Cairo - Africa/Casablanca - Africa/Ceuta - Africa/Conakry - Africa/Dakar - Africa/Dar_es_Salaam - Africa/Djibouti - Africa/Douala - Africa/El_Aaiun - Africa/Freetown - Africa/Gaborone - Africa/Harare - Africa/Johannesburg - Africa/Juba - Africa/Kampala - Africa/Khartoum - Africa/Kigali - Africa/Kinshasa - Africa/Lagos - Africa/Libreville - Africa/Lome - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Africa/Malabo - Africa/Maputo - Africa/Maseru - Africa/Mbabane - Africa/Mogadishu - Africa/Monrovia - Africa/Nairobi - Africa/Ndjamena - Africa/Niamey - Africa/Nouakchott - Africa/Ouagadougou - Africa/Porto-Novo - Africa/Sao_Tome - Africa/Timbuktu - Africa/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - America/Argentina/ComodRivadavia - America/Argentina/Cordoba - America/Argentina/Jujuy - America/Argentina/La_Rioja - America/Argentina/Mendoza - America/Argentina/Rio_Gallegos - America/Argentina/Salta - America/Argentina/San_Juan - America/Argentina/San_Luis - America/Argentina/Tucuman - America/Argentina/Ushuaia - America/Aruba - America/Asuncion - America/Atikokan - America/Atka - America/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Buenos_Aires - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Catamarca - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Ciudad_Juarez - America/Coral_Harbour - America/Cordoba - America/Costa_Rica - America/Creston - America/Cuiaba - America/Curacao - America/Danmarkshavn - America/Dawson - America/Dawson_Creek - America/Denver - America/Detroit - America/Dominica - America/Edmonton - America/Eirunepe - America/El_Salvador - America/Ensenada - America/Fort_Nelson - America/Fort_Wayne - America/Fortaleza - America/Glace_Bay - America/Godthab - America/Goose_Bay - America/Grand_Turk - America/Grenada - America/Guadeloupe - America/Guatemala - America/Guayaquil - America/Guyana - America/Halifax - America/Havana - America/Hermosillo - America/Indiana/Indianapolis - America/Indiana/Knox - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Tell_City - America/Indiana/Vevay - America/Indiana/Vincennes - America/Indiana/Winamac - America/Indianapolis - America/Inuvik - America/Iqaluit - America/Jamaica - America/Jujuy - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Knox_IN - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Louisville - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Mendoza - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - America/Montreal - America/Montserrat - America/Nassau - America/New_York - America/Nipigon - America/Nome - America/Noronha - America/North_Dakota/Beulah - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/Nuuk - America/Ojinaga - America/Panama - America/Pangnirtung - America/Paramaribo - America/Phoenix - America/Port-au-Prince - America/Port_of_Spain - America/Porto_Acre - America/Porto_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rainy_River - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Rosario - America/Santa_Isabel - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - America/Shiprock - America/Sitka - America/St_Barthelemy - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - America/Swift_Current - America/Tegucigalpa - America/Thule - America/Thunder_Bay - America/Tijuana - America/Toronto - America/Tortola - America/Vancouver - America/Virgin - America/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/South_Pole - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Ashkhabad - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Calcutta - Asia/Chita - Asia/Choibalsan - Asia/Chongqing - Asia/Chungking - Asia/Colombo - Asia/Dacca - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Harbin - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Istanbul - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kashgar - Asia/Kathmandu - Asia/Katmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Asia/Macao - Asia/Macau - Asia/Magadan - Asia/Makassar - Asia/Manila - Asia/Muscat - Asia/Nicosia - Asia/Novokuznetsk - Asia/Novosibirsk - Asia/Omsk - Asia/Oral - Asia/Phnom_Penh - Asia/Pontianak - Asia/Pyongyang - Asia/Qatar - Asia/Qostanay - Asia/Qyzylorda - Asia/Rangoon - Asia/Riyadh - Asia/Saigon - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Tel_Aviv - Asia/Thimbu - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ujung_Pandang - Asia/Ulaanbaatar - Asia/Ulan_Bator - Asia/Urumqi - Asia/Ust-Nera - Asia/Vientiane - Asia/Vladivostok - Asia/Yakutsk - Asia/Yangon - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Bermuda - Atlantic/Canary - Atlantic/Cape_Verde - Atlantic/Faeroe - Atlantic/Faroe - Atlantic/Jan_Mayen - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/St_Helena - Atlantic/Stanley - Australia/ACT - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Canberra - Australia/Currie - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/LHI - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/NSW - Australia/North - Australia/Perth - Australia/Queensland - Australia/South - Australia/Sydney - Australia/Tasmania - Australia/Victoria - Australia/West - Australia/Yancowinna - Brazil/Acre - Brazil/DeNoronha - Brazil/East - Brazil/West - CET - CST6CDT - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Canada/Saskatchewan - Canada/Yukon - Chile/Continental - Chile/EasterIsland - Cuba - EET - EST - EST5EDT - Egypt - Eire - Etc/GMT - Etc/GMT+0 - Etc/GMT+1 - Etc/GMT+10 - Etc/GMT+11 - Etc/GMT+12 - Etc/GMT+2 - Etc/GMT+3 - Etc/GMT+4 - Etc/GMT+5 - Etc/GMT+6 - Etc/GMT+7 - Etc/GMT+8 - Etc/GMT+9 - Etc/GMT-0 - Etc/GMT-1 - Etc/GMT-10 - Etc/GMT-11 - Etc/GMT-12 - Etc/GMT-13 - Etc/GMT-14 - Etc/GMT-2 - Etc/GMT-3 - Etc/GMT-4 - Etc/GMT-5 - Etc/GMT-6 - Etc/GMT-7 - Etc/GMT-8 - Etc/GMT-9 - Etc/GMT0 - Etc/Greenwich - Etc/UCT - Etc/UTC - Etc/Universal - Etc/Zulu - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - Europe/Belfast - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Busingen - Europe/Chisinau - Europe/Copenhagen - Europe/Dublin - Europe/Gibraltar - Europe/Guernsey - Europe/Helsinki - Europe/Isle_of_Man - Europe/Istanbul - Europe/Jersey - Europe/Kaliningrad - Europe/Kiev - Europe/Kirov - Europe/Kyiv - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - Europe/Nicosia - Europe/Oslo - Europe/Paris - Europe/Podgorica - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/San_Marino - Europe/Sarajevo - Europe/Saratov - Europe/Simferopol - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Tirane - Europe/Tiraspol - Europe/Ulyanovsk - Europe/Uzhgorod - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zaporozhye - Europe/Zurich - Factory - GB - GB-Eire - GMT - GMT+0 - GMT-0 - GMT0 - Greenwich - HST - Hongkong - Iceland - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Iran - Israel - Jamaica - Japan - Kwajalein - Libya - MET - MST - MST7MDT - Mexico/BajaNorte - Mexico/BajaSur - Mexico/General - NZ - NZ-CHAT - Navajo - PRC - PST8PDT - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Enderbury - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Johnston - Pacific/Kanton - Pacific/Kiritimati - Pacific/Kosrae - Pacific/Kwajalein - Pacific/Majuro - Pacific/Marquesas - Pacific/Midway - Pacific/Nauru - Pacific/Niue - Pacific/Norfolk - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Palau - Pacific/Pitcairn - Pacific/Pohnpei - Pacific/Ponape - Pacific/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Samoa - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Truk - Pacific/Wake - Pacific/Wallis - Pacific/Yap - Poland - Portugal - ROC - ROK - Singapore - SystemV/AST4 - SystemV/AST4ADT - SystemV/CST6 - SystemV/CST6CDT - SystemV/EST5 - SystemV/EST5EDT - SystemV/HST10 - SystemV/MST7 - SystemV/MST7MDT - SystemV/PST8 - SystemV/PST8PDT - SystemV/YST9 - SystemV/YST9YDT - Turkey - UCT - US/Alaska - US/Aleutian - US/Arizona - US/Central - US/East-Indiana - US/Eastern - US/Hawaii - US/Indiana-Starke - US/Michigan - US/Mountain - US/Pacific - US/Samoa - UTC - Universal - W-SU - WET - Zulu address: type: object properties: addressLine1: type: string minLength: 1 maxLength: 60 addressLine2: type: string minLength: 1 maxLength: 30 addressLine3: type: string minLength: 1 maxLength: 10 city: type: string minLength: 1 maxLength: 60 stateCode: type: string enum: - AL - AK - AS - AZ - AR - AA - AE - AP - CA - CO - CT - DE - DC - FM - FL - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MH - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - MP - OH - OK - OR - PW - PA - PR - RI - SC - SD - TN - TX - UT - VT - VI - VA - WA - WV - WI - WY countryCodeIso3: description: Three letter ISO 3166-1 country code type: string pattern: ^[A-Z]{3}$ minLength: 3 maxLength: 3 example: USA zipCode5: type: string description: Five digit zipcode. Use "00000" if address is outside the United States pattern: ^[0-9]{5}$ minLength: 5 maxLength: 5 internationalPostalCode: type: string minLength: 1 maxLength: 16 required: - addressLine1 - city - countryCodeIso3 - zipCode5 X-VA-NonVeteranClaimant-First-Name: allOf: - description: first name - $ref: '#/components/schemas/nonBlankString' X-VA-Insurance-Policy-Number: allOf: - description: Veteran's insurance policy number maxLength: 18 - $ref: '#/components/schemas/nonBlankString' X-VA-First-Name: allOf: - description: first name - type: string securitySchemes: bearer_token: type: http scheme: bearer bearerFormat: JWT productionOauth: type: oauth2 description: 'The authentication model for the Appealable Issues API uses OAuth 2.0/OpenID Connect. The following authorization models are supported: [Authorization code flow](https://developer.va.gov/explore/api/appealable-issues/authorization-code) and [Client Credentials Grant (CCG)](https://developer.va.gov/explore/api/appealable-issues/client-credentials).' flows: authorizationCode: authorizationUrl: https://api.va.gov/oauth2/appeals/v1/authorization tokenUrl: https://api.va.gov/oauth2/appeals/v1/token scopes: veteran/AppealableIssues.read: Appealable issues info veteran/appeals.read: Appeals info representative/AppealableIssues.read: Appealable issues info representative/appeals.read: Appeals info clientCredentials: tokenUrl: 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). scopes: system/AppealableIssues.read: Appealable issues info system/appeals.read: Appeals info sandboxOauth: type: oauth2 description: 'The authentication model for the Appealable Issues API uses OAuth 2.0/OpenID Connect. The following authorization models are supported: [Authorization code flow](https://developer.va.gov/explore/api/appealable-issues/authorization-code) and [Client Credentials Grant (CCG)](https://developer.va.gov/explore/api/appealable-issues/client-credentials).' flows: authorizationCode: authorizationUrl: https://sandbox-api.va.gov/oauth2/appeals/v1/authorization tokenUrl: https://sandbox-api.va.gov/oauth2/appeals/v1/token scopes: veteran/AppealableIssues.read: Appealable issues info veteran/appeals.read: Appeals info representative/AppealableIssues.read: Appealable issues info representative/appeals.read: Appeals info clientCredentials: tokenUrl: https://deptva-eval.okta.com/oauth2/auskff5o6xsoQVngk2p7/v1/token scopes: system/AppealableIssues.read: Appealable issues info system/appeals.read: Appeals info