index
int64 0
0
| repo_id
stringclasses 829
values | file_path
stringlengths 34
254
| content
stringlengths 6
5.38M
|
|---|---|---|---|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/PrescriptionRecord.yml
|
type: object
additionalProperties: false
required:
- id
- type
- attributes
properties:
id:
type: string
example: "13650544"
description: Upstream identifier
type:
type: string
example: "Prescription"
attributes:
type: object
additionalProperties: false
required:
- refillStatus
- refillSubmitDate
- refillDate
- refillRemaining
- facilityName
- isRefillable
- isTrackable
- orderedDate
- quantity
- expirationDate
- prescriptionNumber
- prescriptionName
- instructions
- stationNumber
- facilityPhoneNumber
properties:
refillStatus:
type: string
nullable: true
example: "refillinprocess"
enum:
- active
- deleted
- discontinued
- discontinuedByProvider
- discontinuedEdit
- expired
- hold
- nonVerified
- providerHold
- refillinprocess
- submitted
- suspended
- unknown
- activeParked
- dateOfDeathEntered
- transferred
refillSubmitDate:
type: string
nullable: true
example: "2022-10-28T04:00:00.000Z"
refillDate:
type: string
nullable: true
example: "2022-10-28T04:00:00.000Z"
refillRemaining:
type: integer
nullable: true
example: 5
facilityName:
type: string
nullable: true
example: "DAYT29"
isRefillable:
type: bool
nullable: true
example: false
isTrackable:
type: bool
nullable: true
example: false
orderedDate:
type: string
nullable: true
example: "2022-10-28T04:00:00.000Z"
quantity:
type: string
nullable: true
example: "10"
expirationDate:
type: string
nullable: true
example: "2022-10-28T04:00:00.000Z"
prescriptionNumber:
type: string
nullable: true
example: "2719536"
prescriptionName:
type: string
nullable: true
example: "SOMATROPIN 5MG INJ (VI)"
instructions:
type: string
nullable: true
example: "INJECT 1MG INTO THE MUSCLE WEEKLY FOR 30 DAYS"
dispensedDate:
type: string
nullable: true
example: "2022-10-28T04:00:00.000Z"
stationNumber:
type: string
nullable: true
example: "989"
facilityPhoneNumber:
type: string
nullable: true
example: "(217) 636-6712"
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/Appeal.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: object
additionalProperties: false
required:
- type
- id
- attributes
properties:
type:
type: string
id:
type: string
description: Upstream identifier. Same as provided id.
attributes:
type: object
additionalProperties: false
required:
- appealIds
- active
- alerts
- aod
- aoj
- description
- docket
- events
- evidence
- incompleteHistory
- issues
- location
- programArea
- status
- type
- updated
properties:
appealIds:
type: array
items:
type: string
active:
type: boolean
alerts:
type: array
items:
$ref: "./AppealAlert.yml"
aod:
type: boolean
aoj:
type: string
enum:
- vba
- vha
- nca
- other
description:
type: string
docket:
type: object
nullable: true
events:
type: array
items:
$ref: "./AppealEvent.yml"
evidence:
type: array
items:
$ref: "./AppealEvidence.yml"
incompleteHistory:
type: boolean
issues:
type: array
items:
$ref: "./AppealIssue.yml"
location:
type: string
enum:
- aoj
- bva
programArea:
type: string
enum:
- compensation
- pension
- insurance
- loan_guaranty
- education
- vre
- medical
- burial
- bva
- fiduciary
- other
- multiple
- vha
- voc_rehub
- voc_rehab
status:
type: object
additionalProperties: false
properties:
details:
type: object
additionalProperties: false
properties:
lastSocDate:
type: string
certificationTimeliness:
items:
type: Integer
ssocTimeliness:
items:
type: Integer
decisionTimeliness:
items:
type: Integer
remandTimeliness:
items:
type: Integer
socTimeliness:
items:
type: Integer
remandSsocTimeliness:
items:
type: Integer
returnTimeliness:
items:
type: Integer
type:
type: string
enum:
- scheduled_hearing
- pending_hearing_scheduling
- on_docket
- pending_certification_ssoc
- pending_certification
- pending_form9
- pending_soc
- stayed
- at_vso
- bva_development
- decision_in_progress
- bva_decision
- field_grant
- withdrawn
- ftr
- ramp
- death
- reconsideration
- other_close
- remand_ssoc
- remand
- merged
- evidentiary_period
- ama_remand
- post_bva_dta_decision
- bva_decision_effectuation
- sc_received
- sc_decision
- sc_closed
- hlr_received
- hlr_dta_error
- hlr_decision
- hlr_closed
- statutory_opt_in
- motion
- pre_docketed
type:
type: string
enum:
- legacyAppeal
- appeal
- supplementalClaim
- higherLevelReview
updated:
type: string
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/CommunityCaresEligibility.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: object
additionalProperties: false
required:
- type
- id
- attributes
properties:
type:
type: string
example: "community_care_eligibility"
id:
type: string
example: "PrimaryCare"
description: Service Type
attributes:
type: object
additionalProperties: false
required:
- eligible
properties:
eligible:
type: bool
example: true
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/LighthouseErrors.yml
|
type: object
additionalProperties: false
required:
- errors
properties:
errors:
type: array
items:
type: object
additionalProperties: false
properties:
status:
type: string
code:
type: string
title:
type: string
detail:
type: string
error:
type: string
path:
type: string
timestamp:
type: string
message:
type: string
nullable: true
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/NewAppointment.yml
|
description: Information about a future or past meeting.
type: object
properties:
id:
description: A unique identifier for this appointment.
type: string
maxLength: 64
identifier:
type: array
items:
"$ref": ./AppointmentIdentifier.yml
kind:
"$ref": ./AppointmentKind.yml
status:
"$ref": ./AppointmentStatus.yml
serviceType:
description: the care type for the appointment
type: string
reasonCode:
"$ref": ./CodeableConcept.yml
priority:
minimum: 0
type: number
format: int32
patientIcn:
description: The patient ICN
type: string
nullable: false
locationId:
description: The sta6aid for the VAfacility where the appointment is registered.
type: string
clinic:
description: The clinic ID for the Appointment
type: string
clinicName:
description: The clinic name for the Appointment
type: string
practitioners:
description: The practitioners participating in this appointment.
type: array
items:
"$ref": ./Practitioner.yml
start:
description: The start time of the appointment.
type: string
format: date-time
end:
description: The end time of the appointment.
type: string
format: date-time
minutesDuration:
type: integer
description: The duration of the meeting, in minutes.
slot:
type: object
additionalProperties: false
properties:
id:
pattern: '[A-Za-z0-9\-\.]{1,64}'
type: string
description: The slot ID
start:
type: string
description: Date/Time that the slot is to begin.
format: date-time
end:
type: string
description: Date/Time that the slot is to end.
format: date-time
created:
type: string
description: The date this appointment was initially created.
format: date-time
preferredLocation:
"$ref": ./PreferredLocation.yml
requestedPeriods:
type: array
description: a list of requested periods for appointment
items:
"$ref": ./Period.yml
contact:
"$ref": ./PatientContact.yml
preferredTimesForPhoneCall:
type: array
description: a list of times the patient prefers to be contacted by phone
items:
type: string
enum:
- Morning
- Afternoon
- Evening
cancelationReason:
"$ref": ./CodeableConcept.yml
description:
description: Not used.
type: string
comment:
type: string
preferredLanguage:
type: string
cancellable:
type: boolean
description: If true then this logical appointment can be cancelled.
patientInstruction:
type: string
description: 'Detailed information and instructions for the patient. See: https://www.hl7.org/fhir/appointment-definitions.html#Appointment.patientInstruction'
telehealth:
"$ref": ./TelehealthInfo.yml
extension:
"$ref": ./AppointmentExtensions.yml
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/PrescriptionsRefill.yml
|
type: object
additionalProperties: false
required:
- id
- type
- attributes
properties:
id:
type: string
example: "6260ab13-177f-583d-b2dc-1b350404abb7"
description: user UUID
type:
type: string
example: "PrescriptionRefills"
attributes:
type: object
additionalProperties: false
required:
- failedStationList
- successfulStationList
- lastUpdatedTime
- prescriptionList
- failedPrescriptionIds
- errors
- infoMessages
properties:
failedStationList:
type: string
nullable: true
example: "DAYT29, DAYT29"
successfulStationList:
type: string
nullable: true
example: "SLC4, VAMCSLC-OUTPTRX"
lastUpdatedTime:
type: string
nullable: true
example: "Thu, 08 Dec 2022 12:11:33 EST"
prescriptionList:
type: string
nullable: true
example: null
failedPrescriptionIds:
type: array
example: ['8398465','8398466','8398467']
errors:
type: array
example: [{ "errorCode": 139,
"developerMessage": 'Prescription not refillable for id : 8398465',
"message": 'Prescription is not Refillable' }]
infoMessages:
type: array
example: []
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/IndividualDisabilityRatings.yml
|
type: object
additionalProperties: false
required:
- decision
- effectiveDate
- ratingPercentage
- diagnosticText
properties:
decision:
type: string
example: "Service Connected"
effectiveDate:
type: string
example: "2005-01-01T00:00:00.000+00:00"
nullable: true
ratingPercentage:
type: number
example: 10
nullable: true
diagnosticText:
type: string
example: "Hearing Loss"
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/ClaimsAndAppealsOverviewClaim.yml
|
data:
- type: claim
id: "600117255"
attributes:
subtype: Compensation
completed: false
dateFiled: "2020-01-01"
updatedAt: "2020-01-01"
displayTitle: Compensation
decisionLetterSent: false
phase: 1
documentsNeeded: true
developmentLetterSent: false
claimTypeCode: '020NEW'
meta:
errors: []
pagination:
currentPage: 1
perPage: 60
totalPages: 1
totalEntries: 11
activeClaimsCount: 7
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/PushRegistration.yml
|
type: object
additionalProperties: false
required:
- deviceToken
- osName
- appName
properties:
deviceToken:
type: string
example: "740f4707bebcf74f9b7c25d48e3358945f6aa01da5ddb387462c7eaf61bb78ad"
osName:
type: string
enum:
- ios
- android
deviceName:
type: string
example: "Galaxy 8"
appName:
type: string
example: "va_mobile_app"
debug:
type: boolean
description: Flag to switch between sandbox and non-sandbox app sid. *Lower envs only*
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/PractitionerIds.yml
|
description: Practitioner IDs from an external system.
type: object
properties:
identifier:
type: array
items:
required:
- system
- value
type: object
additionalProperties: false
properties:
system:
type: string
value:
type: string
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/Letters.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: object
additionalProperties: false
required:
- type
- id
- attributes
properties:
type:
type: string
example: "letters"
id:
type: string
example: "abe3f152-90b0-45cb-8776-4958bad0e0ef"
description: user UUID
attributes:
type: object
additionalProperties: false
required:
- letters
properties:
letters:
type: array
items:
type: object
additionalProperties: false
$ref: "./LettersInfo.yml"
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/PrescriptionTrackingRecord.yml
|
type: object
additionalProperties: false
required:
- id
- type
- attributes
properties:
id:
type: string
example: "657068347565"
description: Tracking number
type:
type: string
example: "PrescriptionTracking"
attributes:
type: object
additionalProperties: false
required:
- prescriptionName
- prescriptionNumber
- prescriptionId
- trackingNumber
- ndcNumber
- shippedDate
- deliveryService
- otherPrescriptions
properties:
prescriptionName:
type: string
nullable: true
example: "Ibuprofen 200mg"
prescriptionNumber:
type: string
nullable: true
example: "2719551"
prescriptionId:
type: integer
example: "13650541"
trackingNumber:
type: string
nullable: true
example: "657068347565"
ndcNumber:
type: string
nullable: true
example: "00781171601"
shippedDate:
type: string
nullable: true
example: "2022-10-28T04:00:00.000Z"
deliveryService:
type: string
nullable: true
example: 'USPS'
otherPrescriptions:
type: array
nullable: true
example: [{ prescriptionName: 'ETHAMBUTOL HCL 100MG TAB', prescriptionNumber: '2719553' }]
items:
type: object
additionalProperties: false
required:
- prescriptionName
- prescriptionNumber
properties:
prescriptionName:
type: string
example: 'ETHAMBUTOL HCL 100MG TAB'
prescriptionNumber:
type: '2719553'
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/AddressCreate.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: object
additionalProperties: false
required:
- addressLine1
- addressPou
- addressType
- city
- countryCodeIso3
properties:
addressMetaData:
type: object
additionalProperties: false
properties:
confidenceScore:
type: integer
example: 100
addressType:
type: string
example: "Domestic"
deliveryPointValidation:
type: string
example: "CONFIRMED"
residentialDeliveryIndicator:
type: string
example: "RESIDENTIAL"
addressLine1:
type: string
example: "1493 Martin Luther King Rd"
addressLine2:
type: string
nullable: true
addressLine3:
type: string
nullable: true
addressPou:
type: string
enum: [ "RESIDENCE/CHOICE", "CORRESPONDENCE" ]
example: "RESIDENCE/CHOICE"
addressType:
type: string
enum: [ "DOMESTIC", "INTERNATIONAL", "MILITARY" ]
example: "DOMESTIC"
city:
type: string
example: "Fulton"
countryCodeIso3:
type: string
example: "USA"
internationalPostalCode:
type: string
nullable: true
example: null
province:
type: string
nullable: true
example: null
stateCode:
type: string
nullable: true
example: "NY"
zipCode:
type: string
nullable: true
example: "97062"
zipCodeSuffix:
type: string
nullable: true
example: "1234"
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/claimEventTimeline.yml
|
type: object
properties:
type:
type: string
example: 'received_from_you_list'
tracked_item_id:
type: integer
example: 360_052
description:
type: string
example: 'The information provided concerning your prior marital history is inconsistent. In order to resolve these inconsistencies you should submit certified copies of the public record of the termination (death, divorce or annulment) for each of your prior marriages.'
nullable: true
display_name:
type: string
example: 'Claimant marital history inconsistent - need proof'
overdue:
type: boolean
example: true
nullable: true
status:
type: string
example: 'NEEDED'
nullable: true
uploaded:
type: boolean
example: true
nullable: true
uploads_allowed:
type: boolean
example: true
opened_date:
type: string
example: '2022-09-30'
requested_date:
type: string
example: '2022-09-30'
received_date:
type: string
example: '2023-10-30'
closed_date:
type: string
example: '2023-11-30'
suspense_date:
type: string
example: '2023-05-30'
documents:
type: array
items:
$ref: "./claimDocument.yml"
nullable: true
upload_date:
type: string
example: '2023-05-30'
date:
type: string
example: '2023-05-30'
nullable: true
file_type:
type: integer
example: 'Civilian Police Reports'
document_type:
type: null
example: null
filename:
type: string
example: '7B434B58-477C-4379-816F-05E6D3A10487.pdf'
nullable: true
document_id:
type: string
description: 'Only used for other_documents_list type event for untracked documents'
nullable: true
example: '{6A6DFA79-4EC9-4E58-9653-25BDCFB06A03}'
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/PushRegistrationResponse.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: object
additionalProperties: false
required:
- type
- id
- attributes
properties:
type:
type: string
example: "pushRegister"
id:
description: app name generated when registering an app with push vetext service
type: string
example: "va_mobile_app"
attributes:
type: object
additionalProperties: false
required:
- endpointSid
properties:
endpointSid:
type: string
example: "F1DC67487F5CE0227516037291336983"
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/CreateAppointmentCC.yml
|
description: A request to create a new appointment.
type: object
additionalProperties: false
required:
- kind
- status
- serviceType
- locationId
- requestedPeriods
- contact
- preferredTimesForPhoneCall
- comment
- preferredLocation
- preferredLanguage
properties:
kind:
"$ref": ./AppointmentKind.yml
example: 'clinic'
status:
type: string
description: Always 'proposed' for requests
enum:
- proposed
example: 'proposed'
serviceType:
type: string
description: The care type for the appointment
enum:
- amputation
- audiology-hearing aid support
- audiology-routine exam
- covid
- optometry
- outpatientMentalHealth
- moveProgram
- foodAndNutrition
- clinicalPharmacyPrimaryCare
- podiatry
- primaryCare
- homeSleepTesting
- socialWork
- cpap
- ophthalmology
example: 'optometry'
practitioners:
description: practitioners
type: array
items:
"$ref": ./Practitioner.yml
locationId:
description: The sta6aid for the VAfacility where the appointment is registered.
type: string
example: '983GC'
requestedPeriods:
type: array
description: A list of requested periods for appointment.
items:
"$ref": ./Period.yml
example: [
{
"start":"2022-03-17T00:00:00Z",
"end":"2022-03-17T11:59:00Z"
}
]
contact:
"$ref": ./PatientContact.yml
preferredTimesForPhoneCall:
type: array
description: A list of times the patient prefers to be contacted by phone.
items:
type: string
enum:
- Morning
- Afternoon
- Evening
example: [
"Morning"
]
preferredLocation:
description: A list of times the patient prefers to be contacted by phone.
$ref: ./PreferredLocation.yml
comment:
description: Free-form comment section to provide additional information about an appointment request.
type: string
example: 'free form comment here'
preferredLanguage:
description: Preferred Language
type: string
example: 'English'
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/Efolder.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: array
items:
type: object
additionalProperties: false
required:
- id
- type
- attributes
properties:
id:
type: string
example: "{23fe358d-6e82-4541-804c-ce7562ba28f4}"
description: document id
type:
type: string
example: efolder_document
attributes:
type: object
additionalProperties: false
required:
- docType
- typeDescription
- receivedAt
properties:
docType:
type: string
example: 1215
typeDescription:
type: string
example: DMC - Debt Increase Letter
receivedAt:
type: date
example: 2020-05-28
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/Appointments.yml
|
type: object
additionalProperties: false
required:
- data
- meta
properties:
data:
type: array
items:
$ref: "./Appointment.yml"
meta:
type: object
additionalProperties: false
required:
- upcomingAppointmentsCount
- upcomingDaysLimit
- pagination
properties:
errors:
type: [array, null]
upcomingAppointmentsCount:
type: number
description: The number of BOOKED, non-pending appointments in the next upcomingDaysLimit number of days.
upcomingDaysLimit:
type: number
description: The number of days into the future used for calculating upcomingAppointmentsCount. The current value is 30.
pagination:
type: object
additionalProperties: false
required:
- currentPage
- perPage
- totalPages
- totalEntries
properties:
currentPage:
type: number
example: 1
perPage:
type: number
example: 10
totalPages:
type: number
example: 2
totalEntries:
type: number
example: 15
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/PaymentHistory.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: array
items:
required:
- type
- id
- attributes
properties:
type:
type: string
example: "paymentHistory"
id:
type: string
example: "abe3f152-90b0-45cb-8776-4958bad0e0ef"
description: Upstream identifier
attributes:
type: object
additionalProperties: false
required:
- amount
- date
- paymentMethod
- paymentType
- bank
- account
properties:
amount:
type: string
example: "$350.00"
date:
type: string
example: "2022-01-15T00:00:00.000-06:00"
paymentMethod:
type: string
example: "Direct Deposit"
paymentType:
type: string
example: "Compensation & Pension - Recurring"
bank:
type: string
nullable: true
example: "PACIFIC PREMIER BANK"
account:
type: string
nullable: true
example: "************6464"
meta:
type: object
additionalProperties: false
required:
- errors
- pagination
- availableYears
- recurringPayment
properties:
errors:
type: [ array, null ]
pagination:
type: object
additionalProperties: false
required:
- currentPage
- perPage
- totalPages
- totalEntries
properties:
currentPage:
type: integer
example: 1
perPage:
type: integer
example: 10
totalPages:
type: integer
example: 1
totalEntries:
type: integer
example: 7
availableYears:
type: [ array, null ]
example: [2019, 2018, 2017, 2016, 2015]
recurringPayment:
type: object
additionalProperties: false
required:
- amount
- date
properties:
amount:
type: string
example: "$350.00"
date:
type: string
example: "2022-01-15T00:00:00.000-06:00"
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/CommunityCareProviders.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: array
items:
type: object
additionalProperties: false
$ref: "./CommunityCareProvider.yml"
meta:
type: object
additionalProperties: false
required:
- pagination
properties:
pagination:
type: object
additionalProperties: false
required:
- currentPage
- perPage
- totalPages
- totalEntries
properties:
currentPage:
type: integer
example: 1
perPage:
type: integer
example: 10
totalPages:
type: integer
example: 2
totalEntries:
type: integer
example: 15
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/MaintenanceWindows.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: array
items:
type: object
additionalProperties: false
properties:
id:
type: string
example: "23fe358d-6e82-4541-804c-ce7562ba28f4"
description: Database id
type:
type: string
example: "maintenance_window"
attributes:
type: object
additionalProperties: false
required:
- service
- start_time
- end_time
properties:
service:
type: string
enum:
- caseflow
- payment_history
- facility_locator
- appeals
- military_service_history
- claims
- direct_deposit_benefits
- disability_rating
- letters_and_documents
- secure_messaging
- appointments
- user_profile_update
- rx_refill
- efolder
- mhv_sm
- mhv_meds
- preneed_burial
- user_contact_update
- user_demographics
example: "claims"
start_time:
type: datetime
example: 2019-04-20T14:15:00.000-04:00
end_time:
type: datetime
example: 2019-04-20T18:15:00.000Z
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/PushSendRequestBody.yml
|
type: object
additionalProperties: false
required:
- appName
- templateId
- personalization
properties:
appName:
type: string
example: "va_mobile_app"
templateId:
type: string
example: "0EF7C8C9390847D7B3B521426EFF5814"
personalization:
type: object
additionalProperties: false
properties:
"%APPOINTMENT_DATE%":
type: string
example: "DEC 14"
"%APPOINTMENT_TIME%":
type: string
example: "10:00"
debug:
type: boolean
description: Flag to switch between sandbox and non-sandbox app sid. *Lower envs only*
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/Period.yml
|
type: object
additionalProperties: false
required:
- start
- end
properties:
start:
type: string
description: start time of period
format: date-time
end:
type: string
description: end time of period
format: date-time
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/CommunityCareLocation.yml
|
type: object
properties:
practiceName:
type: string
address:
$ref: ./AppointmentRequestAddress.yml
description: Information about the location of a community care appointment.
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/FacilityClinics.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: array
items:
type: object
additionalProperties: false
$ref: "./FacilityClinic.yml"
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/PhoneUpdate.yml
|
type: object
additionalProperties: false
required:
- id
- areaCode
- countryCode
- phoneNumber
- phoneType
- extension
properties:
id:
type: integer
example: 157032
areaCode:
type: string
example: "704"
countryCode:
type: string
example: "1"
phoneNumber:
type: string
example: "7749069"
phoneType:
type: string
enum: [ "HOME", "FAX", "MOBILE", "WORK" ]
example: "HOME"
extension:
type: string
example: "4567"
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/AddressTransaction.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: object
additionalProperties: false
required:
- id
- type
- attributes
properties:
id:
type: string
example: "3be0c7de-bfe1-4101-a326-5567bcd98b63"
description: Upstream identifier
type:
type: string
example: "async_transaction_vet360_address_transactions"
attributes:
type: object
additionalProperties: false
required:
- transactionId
- transactionStatus
- type
properties:
transactionId:
type: string
example: "3be0c7de-bfe1-4101-a326-5567bcd98b63"
transactionStatus:
type: string
enum:
- "REJECTED"
- "COMPLETED_SUCCESS"
- "COMPLETED_NO_CHANGES_DETECTED"
- "COMPLETED_FAILURE"
example: "COMPLETED_SUCCESS"
type:
type: string
example: "AsyncTransaction::VAProfile::AddressTransaction"
metadata:
type: array
example: []
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/SecureMessageNewMessageRequest.yml
|
type: object
additionalProperties: false
required:
- recipient_id
- category
- body
properties:
recipient_id:
type: integer
description: |
The message recipient. This must be a valid recipient id that is assigned to the user. The list of valid
recipients for a user can be obtained from the <pre>/v0/messaging/health/recipients</pre> endpoint.
example: 1763526
category:
type: string
description: |
Message category. This must be one of the values returned by the
<pre>/v0/messaging/health/messages/categories</pre> endpoint.
example: "OTHER"
body:
type: string
example: "What is the proper dosage and how long should I take this medication?"
subject:
type: string
example: "Question about my medication"
draft_id:
type: integer
description: |
Specifies draft message ID to send. Draft message is deleted once sent. Note that the recipient_id, category, body, and subject included with this post will overwrite any of original values of the draft.
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/PreferredLocation.yml
|
type: object
additionalProperties: false
required:
- city
- state
properties:
city:
maxLength: 64
type: string
example: 'Helena'
state:
maxLength: 32
type: string
example: 'MT'
description: The location that the veteran requested the appointment to be scheduled in.
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/ClaimLetterDocuments.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: array
items:
type: object
additionalProperties: false
required:
- id
- type
- attributes
properties:
id:
type: string
example: "{23fe358d-6e82-4541-804c-ce7562ba28f4}"
description: document id
type:
type: string
example: claim_letter_document
attributes:
type: object
additionalProperties: false
required:
- docType
- typeDescription
- receivedAt
properties:
docType:
type: string
example: 1215
typeDescription:
type: string
example: DMC - Debt Increase Letter
receivedAt:
type: datetime
example: 2024-09-13T178:32:24Z
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/ClaimDocUpload.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: object
additionalProperties: false
required:
- jobId
properties:
jobId:
type: string
enum:
- success
- failure
example: 'success'
description: job status
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/PhoneTransaction.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: object
additionalProperties: false
required:
- id
- string
properties:
id:
type: string
example: "3be0c7de-bfe1-4101-a326-5567bcd98b63"
description: Upstream identifier
type:
type: string
example: "asyncTransactionVet360PhoneTransactions"
attributes:
type: object
additionalProperties: false
required:
- transactionId
- transactionStatus
- type
properties:
transactionId:
type: string
example: "3be0c7de-bfe1-4101-a326-5567bcd98b63"
transactionStatus:
type: string
enum:
- "REJECTED"
- "COMPLETED_SUCCESS"
- "COMPLETED_NO_CHANGES_DETECTED"
- "COMPLETED_FAILURE"
example: "COMPLETED_SUCCESS"
type:
type: string
example: "AsyncTransaction::VAProfile::PhoneTransaction"
metadata:
type: array
example: [ ]
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/SecureMessageList.yml
|
type: object
additionalProperties: false
required:
- data
- meta
properties:
data:
type: array
items:
$ref: "./SecureMessageSummary.yml"
meta:
type: object
additionalProperties: false
required:
- sort
- pagination
properties:
sort:
type: object
additionalProperties: false
required: sentDate
properties:
sentDate:
type: string
enum: [ DESC, ASC ]
pagination:
type: object
additionalProperties: false
required:
- totalEntries
properties:
totalEntries:
type: integer
example: 15
messageCounts:
type: object
additionalProperties: false
description: |
Count of read and unread messages. `readReceipt` field containing "READ" count towards "read" count
while a null value will count towards "unread". If either read or unread is 0, the key will not be included.
properties:
read:
type: integer
example: 5
unread:
type: integer
example: 15
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/ClaimsAndAppealsOverviewErrors.yml
|
type: object
additionalProperties: false
required:
- service
- errorDetails
properties:
service:
type: string
enum:
- claims
- appeals
errorDetails:
type: string
description: List of errors encountered concatenated with semicolon delimiter.
example: Error 1 details; Error 2 details
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/FacilityEligibility.yml
|
type: object
additionalProperties: false
required:
- type
- id
- attributes
properties:
type:
type: string
example: facility_eligibility
id:
type: string
example: "100"
description: Facility Id
attributes:
type: object
additionalProperties: false
required:
- facility_id
- eligible
- reason
properties:
facilityId:
type: string
example: '100'
eligible:
type: boolean
example: false
reason:
type: string
example: "Non-primary facility with no visit within 12-24 months"
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/Coding.yml
|
properties:
system:
type: string
description: Identity of the terminology system
code:
type: string
description: Symbol in syntax defined by the system
display:
type: string
description: A human-readable representation defined by the system.
description: >-
A Coding is a representation of a defined concept using a symbol from a defined "code system".
FHIR reference: https://www.hl7.org/fhir/datatypes.html#Coding
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/SecureMessageAttachment.yml
|
type: object
additionalProperties: false
required:
- id
- type
- attributes
- links
properties:
id:
type: string
example: 7775443
type:
type: string
example: "attachments"
attributes:
type: object
additionalProperties: false
required:
- name
- messageId
- attachmentSize
properties:
name:
type: string
example: bb_report.pdf
messageId:
type: integer
example: 123789
attachmentSize:
type: integer
example: 225457
links:
type: object
additionalProperties: false
required:
- download
properties:
download:
type: string
format: url
example: https://api.va.gov/v0/messaging/health/messages/123789/attachments/7775443
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/EnrollmentStatus.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: object
additionalProperties: false
required:
- type
- id
- attributes
properties:
type:
type: string
example: enrollment_status
id:
type: string
example: "23fe358d-6e82-4541-804c-ce7562ba28f4"
description: user uuid
attributes:
type: object
additionalProperties: false
required:
- status
properties:
status:
type: string
example: enrolled
description: one of enrolled, pending, or other
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/ContactPoint.yml
|
type: object
additionalProperties: false
required:
- type
- value
properties:
type:
type: string
enum:
- email
- phone
nullable: false
example: 'phone'
value:
type: string
nullable: false
example: '7036753607'
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/CommunityCareProvider.yml
|
type: object
additionalProperties: false
required:
- type
- id
- attributes
properties:
type:
type: string
example: community_care_provider
id:
type: string
example: "23fe358d-6e82-4541-804c-ce7562ba28f4"
description: Upstream identifier. provider id.
attributes:
type: object
additionalProperties: false
required:
- name
- address
- distance
properties:
name:
type: string
example: "Dr. Smith"
address:
type: object
additionalProperties: false
$ref: "./FacilityAddress.yml"
distance:
type: float
example: 1.234
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/ReasonCode.yml
|
type: object
description: Reason for appointment. A reason will be selected, along with a required free form response. If no reason was provided ('My reason isn't listed' option) then no 'coding' field array will be provided and text field will be populated with the free form comment
required:
- coding
- text
properties:
coding:
type: array
items:
type: object
additionalProperties: false
properties:
code:
type: string
enum:
- 'Routine Follow-up'
- 'Medication Concern'
- 'New Problem'
example: 'Routine Follow-up'
text:
type: string
example: 'free form comment here'
maxLength: 100
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/MedicalCopays.yml
|
type: object
additionalProperties: false
required:
- data
- status
properties:
status:
type: integer
example: 200
data:
type: array
items:
type: object
additionalProperties: false
properties:
id:
type: string
example: '3fa85f64-5717-4562-b3fc-2c963f66afa6'
pSSeqNum:
type: integer
example: 0
pSTotSeqNum:
type: integer
example: 0
pSFacilityNum:
type: string
pSFacPhoneNum:
type: string
pSTotStatement:
type: integer
example: 0
pSStatementVal:
type: string
pSStatementDate:
type: string
pSStatementDateOutput:
type: string
pSProcessDate:
type: string
pSProcessDateOutput:
type: string
pHPatientLstNme:
type: string
pHPatientFstNme:
type: string
pHPatientMidNme:
type: string
pHAddress1:
type: string
pHAddress2:
type: string
pHAddress3:
type: string
pHCity:
type: string
pHState:
type: string
pHZipCde:
type: string
pHZipCdeOutput:
type: string
pHCtryNme:
type: string
pHAmtDue:
type: integer
example: 0
pHAmtDueOutput:
type: string
pHPrevBal:
type: integer
example: 0
pHPrevBalOutput:
type: string
pHTotCharges:
type: integer
example: 0
pHTotChargesOutput:
type: string
pHTotCredits:
type: integer
example: 0
pHTotCreditsOutput:
type: string
pHNewBalance:
type: integer
example: 0
pHNewBalanceOutput:
type: string
pHSpecialNotes:
type: string
pHROParaCdes:
type: string
pHNumOfLines:
type: integer
example: 0
pHDfnNumber:
type: integer
example: 0
pHCernerStatementNumber:
type: integer
example: 0
pHCernerPatientId:
type: string
pHCernerAccountNumber:
type: string
pHIcnNumber:
type: string
pHAccountNumber:
type: integer
example: 0
pHLargeFontIndcator:
type: integer
example: 0
station:
type: object
description: Facility information
properties:
facilitYNum:
type: string
visNNum:
type: string
facilitYDesc:
type: string
cyclENum:
type: string
remiTToFlag:
type: string
maiLInsertFlag:
type: string
staTAddress1:
type: string
staTAddress2:
type: string
staTAddress3:
type: string
city:
type: string
state:
type: string
ziPCde:
type: string
ziPCdeOutput:
type: string
baRCde:
type: string
teLNumFlag:
type: string
teLNum:
type: string
teLNum2:
type: string
contacTInfo:
type: string
dM2TelNum:
type: string
contacTInfo2:
type: string
toPTelNum:
type: string
lbXFedexAddress1:
type: string
lbXFedexAddress2:
type: string
lbXFedexAddress3:
type: string
lbXFedexCity:
type: string
lbXFedexState:
type: string
lbXFedexZipCde:
type: string
lbXFedexBarCde:
type: string
lbXFedexContact:
type: string
lbXFedexContactTelNum:
type: string
details:
type: array
description: A collection of transactions for a specific medical copay balance
items:
type: object
additionalProperties: false
properties:
pDDatePosted:
type: string
pDDatePostedOutput:
type: string
pDTransDesc:
type: string
pDTransDescOutput:
type: string
pDTransAmt:
type: integer
example: 0
pDTransAmtOutput:
type: string
pDRefNo:
type: string
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/SecureMessagingFolders.yml
|
type: object
additionalProperties: false
required:
- data
- meta
properties:
data:
type: array
items:
$ref: "./SecureMessagingFolder.yml"
meta:
type: object
additionalProperties: false
required:
- pagination
properties:
pagination:
type: object
additionalProperties: false
required:
- currentPage
- perPage
- totalPages
- totalEntries
properties:
currentPage:
type: integer
example: 1
perPage:
type: integer
example: 10
totalPages:
type: integer
example: 2
totalEntries:
type: integer
example: 15
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/Prescriptions.yml
|
type: object
additionalProperties: false
required:
- data
- meta
properties:
data:
type: array
items:
type: object
additionalProperties: false
$ref: "./PrescriptionRecord.yml"
meta:
type: object
additionalProperties: false
required:
- prescriptionStatusCount
- hasNonVaMeds
properties:
prescriptionStatusCount:
type: object
additionalProperties: false
description: |
Count of different types of prescriptions. "active" contains prescriptions that have a `refillStatus` of active,
submitted, providerHold, activeParked, refillinprocess, and/or prescriptions that have a tracking number
associated with them. If a prescriptions does not meet the criteria for "active", it appends it's `refillStatus` to the list.
If a refillStatus is not present in any prescription, it will not be included in this list.
See `refillStatus` enum for all possible values. "isRefillable" is a separate count of prescriptions with `isRefillable` set to true.
A prescription can be counted in both `isRefillable` and any other status count.
example:
active: 1
isRefillable: 1
discontinued: 1
expired: 2
historical: 3
pending: 1
transferred: 2
submitted: 1
hold: 1
unknown: 2
total: 14
hasNonVaMeds:
type: boolean
description: |
Notifies if user has any prescriptions that are Non-VA (NV). This boolean will be set regardless of
the set of data returned in the "data" section of the response (ie. this will still be set to "true"
if the user has Non-VA meds but the current page of the response does not show any).
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/ClaimUploadRequestBody.yml
|
type: object
additionalProperties: false
required:
- files
- trackedItemId
- documentType
properties:
files:
type: array
description: base64 strings of images to upload together
items:
type: string
trackedItemId:
type: string
description: item id from claim eventsTimeline
documentType:
type: string
example: L827
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/SecureMessageCategories.yml
|
properties:
data:
type: object
additionalProperties: false
required:
- id
- type
- attributes
properties:
id:
type: string
example: "0"
description: Upstream identifier
type:
type: string
example: "categories"
attributes:
type: object
additionalProperties: false
required:
- messageCategoryType
properties:
messageCategoryType:
type: array
items:
type: string
example:
- OTHER
- COVID
- APPOINTMENTS
- MEDICATIONS
- TEST_RESULTS
- EDUCATION
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/SecureMessageSignature.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: object
additionalProperties: false
required:
- type
- id
- attributes
properties:
type:
type: string
example: "messageSignature"
id:
type: string
example: "abe3f152-90b0-45cb-8776-4958bad0e0ef"
description: user UUID
attributes:
type: object
additionalProperties: false
required:
- signatureName
- includeSignature
- signatureTitle
properties:
signatureName:
type: string
example: "My Signature Name"
includeSignature:
type: boolean
signatureTitle:
type: string
example: "My Signature Title"
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/AppointmentCheckinDemographics.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: object
additionalProperties: false
required:
- type
- id
- attributes
properties:
type:
type: string
example: "checkInDemographics"
id:
type: string
example: "75db6a5c-84ae-4ca4-bba2-ef4c41d563ab"
description: user uuid
attributes:
type: object
additionalProperties: false
required:
- insuranceVerificationNeeded
- needsConfirmation
- mailingAddress
- residentialAddress
- homePhone
- officePhone
- cellPhone
- email
- emergencyContact
- nextOfKin
properties:
insuranceVerificationNeeded:
type: boolean
example: true
needsConfirmation:
type: boolean
example: true
mailingAddress:
type: object
additionalProperties: false
required:
- street1
- street2
- street3
- city
- county
- state
- zip
- zip4
- country
properties:
street1:
type: string
street2:
type: string
street3:
type: string
city:
type: string
county:
type: string
state:
type: string
zip:
type: string
zip4:
type: string
nullable: true
country:
type: string
residentialAddress:
type: object
additionalProperties: false
required:
- street1
- street2
- street3
- city
- county
- state
- zip
- zip4
- country
properties:
street1:
type: string
street2:
type: string
street3:
type: string
city:
type: string
county:
type: string
state:
type: string
zip:
type: string
zip4:
type: string
nullable: true
country:
type: string
homePhone:
type: string
officePhone:
type: string
cellPhone:
type: string
email:
type: string
emergencyContact:
type: object
additionalProperties: false
required:
- needsConfirmation
- name
- relationship
- phone
- workPhone
- address
properties:
needsConfirmation:
type: boolean
name:
type: string
relationship:
type: string
phone:
type: string
workPhone:
type: string
address:
type: object
additionalProperties: false
required:
- street1
- street2
- street3
- city
- county
- state
- zip
- zip4
- country
properties:
street1:
type: string
street2:
type: string
street3:
type: string
city:
type: string
county:
type: string
state:
type: string
zip:
type: string
zip4:
type: string
nullable: true
country:
type: string
nextOfKin:
type: object
additionalProperties: false
required:
- needsConfirmation
- name
- relationship
- phone
- workPhone
- address
properties:
needsConfirmation:
type: boolean
name:
type: string
nullable: true
relationship:
type: string
nullable: true
phone:
type: string
nullable: true
workPhone:
type: string
nullable: true
address:
type: object
additionalProperties: false
required:
- street1
- street2
- street3
- city
- county
- state
- zip
- zip4
- country
properties:
street1:
type: string
nullable: true
street2:
type: string
nullable: true
street3:
type: string
nullable: true
city:
type: string
nullable: true
county:
type: string
nullable: true
state:
type: string
nullable: true
zip:
type: string
nullable: true
zip4:
type: string
nullable: true
country:
type: string
nullable: true
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/EVSSAuthError.yml
|
type: object
additionalProperties: false
required:
- errors
properties:
errors:
type: array
items:
required:
- title
- detail
- code
- status
properties:
title:
type: string
example: Not Found
detail:
type: string
example: "The requested resource could not be found but may be available again in the future."
code:
type: string
example: '404'
status:
type: string
example: '404'
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/Error.yml
|
type: object
additionalProperties: false
required:
- title
- detail
- code
- status
properties:
title:
type: string
detail:
type: string
code:
type: string
status:
type: string
source:
type:
anyOf:
- string
- object
meta:
type: object
additionalProperties: false
required:
- messages
properties:
messages:
type: array
items:
type: object
additionalProperties: false
required:
- key
- severity
- text
properties:
key:
type: string
severity:
type: string
text:
type: string
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/PreferredNameUpdate.yml
|
type: object
additionalProperties: false
required:
- text
properties:
text:
type: string
example: "New Preferred Name"
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/CreateDependents.yml
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "SUPPLEMENTAL CLAIM FOR COMPENSATION (21-686C & 21-674)",
"type": "object",
"definitions": {
"fullName": {
"type": "object",
"properties": {
"first": {
"type": "string",
"minLength": 1,
"maxLength": 30,
"pattern": "^[A-Za-zÀ-ÖØ-öø-ÿ-]+(?:s[A-Za-zÀ-ÖØ-öø-ÿ-][?]+)*$"
},
"middle": {
"type": "string",
"pattern": "^[A-Za-zÀ-ÖØ-öø-ÿ-]+(?:s[A-Za-zÀ-ÖØ-öø-ÿ-][?]+)*$",
"maxLength": 20
},
"last": {
"type": "string",
"minLength": 1,
"maxLength": 30,
"pattern": "^[A-Za-zÀ-ÖØ-öø-ÿ-]+(?:s[A-Za-zÀ-ÖØ-öø-ÿ-][?]+)*$"
}
},
"required": [
"first",
"last"
]
},
"phone": {
"type": "string",
"minLength": 10
},
"date": {
"pattern": "^(\\d{4}|XXXX)-(0[1-9]|1[0-2]|XX)-(0[1-9]|[1-2][0-9]|3[0-1]|XX)$",
"type": "string"
},
"email": {
"type": "string",
"maxLength": 256,
"format": "email"
},
"files": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"size": {
"type": "integer"
},
"confirmationCode": {
"type": "string"
}
}
}
},
"privacyAgreementAccepted": {
"type": "boolean",
"enum": [
true
]
},
"ssn": {
"type": "string",
"pattern": "^[0-9]{9}$"
},
"genericLocation": {
"type": "object",
"properties": {
"isOutsideUs": {
"type": "boolean",
"default": false
},
"country": {
"type": "string",
"enum": [
"AFG",
"ALB",
"DZA",
"AND",
"AGO",
"AIA",
"ATA",
"ATG",
"ARG",
"ARM",
"ABW",
"AUS",
"AUT",
"AZE",
"BHS",
"BHR",
"BGD",
"BRB",
"BLR",
"BEL",
"BLZ",
"BEN",
"BMU",
"BTN",
"BOL",
"BIH",
"BWA",
"BVT",
"BRA",
"IOT",
"BRN",
"BGR",
"BFA",
"BDI",
"KHM",
"CMR",
"CAN",
"CPV",
"CYM",
"CAF",
"TCD",
"CHL",
"CHN",
"CXR",
"CCK",
"COL",
"COM",
"COG",
"COD",
"COK",
"CRI",
"CIV",
"HRV",
"CUB",
"CYP",
"CZE",
"DNK",
"DJI",
"DMA",
"DOM",
"ECU",
"EGY",
"SLV",
"GNQ",
"ERI",
"EST",
"ETH",
"FLK",
"FRO",
"FJI",
"FIN",
"FRA",
"GUF",
"PYF",
"ATF",
"GAB",
"GMB",
"GEO",
"DEU",
"GHA",
"GIB",
"GRC",
"GRL",
"GRD",
"GLP",
"GTM",
"GIN",
"GNB",
"GUY",
"HTI",
"HMD",
"HND",
"HKG",
"HUN",
"ISL",
"IND",
"IDN",
"IRN",
"IRQ",
"IRL",
"ISR",
"ITA",
"JAM",
"JPN",
"JOR",
"KAZ",
"KEN",
"KIR",
"PRK",
"KOR",
"KWT",
"KGZ",
"LAO",
"LVA",
"LBN",
"LSO",
"LBR",
"LBY",
"LIE",
"LTU",
"LUX",
"MAC",
"MKD",
"MDG",
"MWI",
"MYS",
"MDV",
"MLI",
"MLT",
"MTQ",
"MRT",
"MUS",
"MYT",
"MEX",
"FSM",
"MDA",
"MCO",
"MNG",
"MSR",
"MAR",
"MOZ",
"MMR",
"NAM",
"NRU",
"NPL",
"ANT",
"NLD",
"NCL",
"NZL",
"NIC",
"NER",
"NGA",
"NIU",
"NFK",
"NOR",
"OMN",
"PAK",
"PAN",
"PNG",
"PRY",
"PER",
"PHL",
"PCN",
"POL",
"PRT",
"QAT",
"REU",
"ROU",
"RUS",
"RWA",
"SHN",
"KNA",
"LCA",
"SPM",
"VCT",
"SMR",
"STP",
"SAU",
"SEN",
"SCG",
"SYC",
"SLE",
"SGP",
"SVK",
"SVN",
"SLB",
"SOM",
"ZAF",
"SGS",
"ESP",
"LKA",
"SDN",
"SUR",
"SWZ",
"SWE",
"CHE",
"SYR",
"TWN",
"TJK",
"TZA",
"THA",
"TLS",
"TGO",
"TKL",
"TON",
"TTO",
"TUN",
"TUR",
"TKM",
"TCA",
"TUV",
"UGA",
"UKR",
"ARE",
"GBR",
"URY",
"UZB",
"VUT",
"VAT",
"VEN",
"VNM",
"VGB",
"WLF",
"ESH",
"YEM",
"ZMB",
"ZWE"
],
"enumNames": [
"Afghanistan",
"Albania",
"Algeria",
"Andorra",
"Angola",
"Anguilla",
"Antarctica",
"Antigua",
"Argentina",
"Armenia",
"Aruba",
"Australia",
"Austria",
"Azerbaijan",
"Bahamas",
"Bahrain",
"Bangladesh",
"Barbados",
"Belarus",
"Belgium",
"Belize",
"Benin",
"Bermuda",
"Bhutan",
"Bolivia",
"Bosnia",
"Botswana",
"Bouvet Island",
"Brazil",
"British Indian Ocean Territories",
"Brunei Darussalam",
"Bulgaria",
"Burkina Faso",
"Burundi",
"Cambodia",
"Cameroon",
"Canada",
"Cape Verde",
"Cayman",
"Central African Republic",
"Chad",
"Chile",
"China",
"Christmas Island",
"Cocos Islands",
"Colombia",
"Comoros",
"Congo",
"Democratic Republic of the Congo",
"Cook Islands",
"Costa Rica",
"Ivory Coast",
"Croatia",
"Cuba",
"Cyprus",
"Czech Republic",
"Denmark",
"Djibouti",
"Dominica",
"Dominican Republic",
"Ecuador",
"Egypt",
"El Salvador",
"Equatorial Guinea",
"Eritrea",
"Estonia",
"Ethiopia",
"Falkland Islands",
"Faroe Islands",
"Fiji",
"Finland",
"France",
"French Guiana",
"French Polynesia",
"French Southern Territories",
"Gabon",
"Gambia",
"Georgia",
"Germany",
"Ghana",
"Gibraltar",
"Greece",
"Greenland",
"Grenada",
"Guadeloupe",
"Guatemala",
"Guinea",
"Guinea-Bissau",
"Guyana",
"Haiti",
"Heard Island",
"Honduras",
"Hong Kong",
"Hungary",
"Iceland",
"India",
"Indonesia",
"Iran",
"Iraq",
"Ireland",
"Israel",
"Italy",
"Jamaica",
"Japan",
"Jordan",
"Kazakhstan",
"Kenya",
"Kiribati",
"North Korea",
"South Korea",
"Kuwait",
"Kyrgyzstan",
"Laos",
"Latvia",
"Lebanon",
"Lesotho",
"Liberia",
"Libya",
"Liechtenstein",
"Lithuania",
"Luxembourg",
"Macao",
"Macedonia",
"Madagascar",
"Malawi",
"Malaysia",
"Maldives",
"Mali",
"Malta",
"Martinique",
"Mauritania",
"Mauritius",
"Mayotte",
"Mexico",
"Micronesia",
"Moldova",
"Monaco",
"Mongolia",
"Montserrat",
"Morocco",
"Mozambique",
"Myanmar",
"Namibia",
"Nauru",
"Nepal",
"Netherlands Antilles",
"Netherlands",
"New Caledonia",
"New Zealand",
"Nicaragua",
"Niger",
"Nigeria",
"Niue",
"Norfolk",
"Norway",
"Oman",
"Pakistan",
"Panama",
"Papua New Guinea",
"Paraguay",
"Peru",
"Philippines",
"Pitcairn",
"Poland",
"Portugal",
"Qatar",
"Reunion",
"Romania",
"Russia",
"Rwanda",
"Saint Helena",
"Saint Kitts and Nevis",
"Saint Lucia",
"Saint Pierre and Miquelon",
"Saint Vincent and the Grenadines",
"San Marino",
"Sao Tome and Principe",
"Saudi Arabia",
"Senegal",
"Serbia",
"Seychelles",
"Sierra Leone",
"Singapore",
"Slovakia",
"Slovenia",
"Solomon Islands",
"Somalia",
"South Africa",
"South Georgia and the South Sandwich Islands",
"Spain",
"Sri Lanka",
"Sudan",
"Suriname",
"Swaziland",
"Sweden",
"Switzerland",
"Syrian Arab Republic",
"Taiwan",
"Tajikistan",
"Tanzania",
"Thailand",
"Timor-Leste",
"Togo",
"Tokelau",
"Tonga",
"Trinidad and Tobago",
"Tunisia",
"Turkey",
"Turkmenistan",
"Turks and Caicos Islands",
"Tuvalu",
"Uganda",
"Ukraine",
"United Arab Emirates",
"United Kingdom",
"Uruguay",
"Uzbekistan",
"Vanuatu",
"Vatican",
"Venezuela",
"Vietnam",
"British Virgin Islands",
"Wallis and Futuna",
"Western Sahara",
"Yemen",
"Zambia",
"Zimbabwe"
]
},
"state": {
"type": "string",
"enum": [
"AL",
"AK",
"AS",
"AZ",
"AR",
"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"
],
"enumNames": [
"Alabama",
"Alaska",
"American Samoa",
"Arizona",
"Arkansas",
"California",
"Colorado",
"Connecticut",
"Delaware",
"District Of Columbia",
"Federated States Of Micronesia",
"Florida",
"Georgia",
"Guam",
"Hawaii",
"Idaho",
"Illinois",
"Indiana",
"Iowa",
"Kansas",
"Kentucky",
"Louisiana",
"Maine",
"Marshall Islands",
"Maryland",
"Massachusetts",
"Michigan",
"Minnesota",
"Mississippi",
"Missouri",
"Montana",
"Nebraska",
"Nevada",
"New Hampshire",
"New Jersey",
"New Mexico",
"New York",
"North Carolina",
"North Dakota",
"Northern Mariana Islands",
"Ohio",
"Oklahoma",
"Oregon",
"Palau",
"Pennsylvania",
"Puerto Rico",
"Rhode Island",
"South Carolina",
"South Dakota",
"Tennessee",
"Texas",
"Utah",
"Vermont",
"Virgin Islands",
"Virginia",
"Washington",
"West Virginia",
"Wisconsin",
"Wyoming"
]
},
"city": {
"type": "string",
"maxLength": 30,
"pattern": "^(?!\\s)(?!.*?\\s{2,})[^<>%$#@!^&*0-9]+$"
}
}
},
"genericTextInput": {
"type": "string",
"maxLength": 50
},
"genericTrueFalse": {
"type": "boolean"
},
"genericNumberAndDashInput": {
"type": "string",
"maxLength": 50,
"minLength": 4,
"pattern": "^[0-9]*[-]*[0-9]*[-]*[0-9]*$"
},
"currencyInput": {
"type": "string",
"pattern": "^\\d+(\\.\\d{1,2})?$"
},
"addressSchema": {
"type": "object",
"properties": {
"view:editMailingAddressSubheader": {
"type": "object",
"properties": {}
},
"view:livesOnMilitaryBase": {
"$ref": "#/definitions/genericTrueFalse"
},
"view:livesOnMilitaryBaseInfo": {
"type": "object",
"properties": {}
},
"countryName": {
"type": "string",
"enum": [
"USA",
"AFG",
"ALB",
"DZA",
"AND",
"AGO",
"AIA",
"ATA",
"ATG",
"ARG",
"ARM",
"ABW",
"AUS",
"AUT",
"AZE",
"BHS",
"BHR",
"BGD",
"BRB",
"BLR",
"BEL",
"BLZ",
"BEN",
"BMU",
"BTN",
"BOL",
"BIH",
"BWA",
"BVT",
"BRA",
"IOT",
"BRN",
"BGR",
"BFA",
"BDI",
"KHM",
"CMR",
"CAN",
"CPV",
"CYM",
"CAF",
"TCD",
"CHL",
"CHN",
"CXR",
"CCK",
"COL",
"COM",
"COG",
"COD",
"COK",
"CRI",
"CIV",
"HRV",
"CUB",
"CYP",
"CZE",
"DNK",
"DJI",
"DMA",
"DOM",
"ECU",
"EGY",
"SLV",
"GNQ",
"ERI",
"EST",
"ETH",
"FLK",
"FRO",
"FJI",
"FIN",
"FRA",
"GUF",
"PYF",
"ATF",
"GAB",
"GMB",
"GEO",
"DEU",
"GHA",
"GIB",
"GRC",
"GRL",
"GRD",
"GLP",
"GTM",
"GIN",
"GNB",
"GUY",
"HTI",
"HMD",
"HND",
"HKG",
"HUN",
"ISL",
"IND",
"IDN",
"IRN",
"IRQ",
"IRL",
"ISR",
"ITA",
"JAM",
"JPN",
"JOR",
"KAZ",
"KEN",
"KIR",
"PRK",
"KOR",
"KWT",
"KGZ",
"LAO",
"LVA",
"LBN",
"LSO",
"LBR",
"LBY",
"LIE",
"LTU",
"LUX",
"MAC",
"MKD",
"MDG",
"MWI",
"MYS",
"MDV",
"MLI",
"MLT",
"MTQ",
"MRT",
"MUS",
"MYT",
"MEX",
"FSM",
"MDA",
"MCO",
"MNG",
"MSR",
"MAR",
"MOZ",
"MMR",
"NAM",
"NRU",
"NPL",
"ANT",
"NLD",
"NCL",
"NZL",
"NIC",
"NER",
"NGA",
"NIU",
"NFK",
"NOR",
"OMN",
"PAK",
"PAN",
"PNG",
"PRY",
"PER",
"PHL",
"PCN",
"POL",
"PRT",
"QAT",
"REU",
"ROU",
"RUS",
"RWA",
"SHN",
"KNA",
"LCA",
"SPM",
"VCT",
"SMR",
"STP",
"SAU",
"SEN",
"SCG",
"SYC",
"SLE",
"SGP",
"SVK",
"SVN",
"SLB",
"SOM",
"ZAF",
"SGS",
"ESP",
"LKA",
"SDN",
"SUR",
"SWZ",
"SWE",
"CHE",
"SYR",
"TWN",
"TJK",
"TZA",
"THA",
"TLS",
"TGO",
"TKL",
"TON",
"TTO",
"TUN",
"TUR",
"TKM",
"TCA",
"TUV",
"UGA",
"UKR",
"ARE",
"GBR",
"URY",
"UZB",
"VUT",
"VAT",
"VEN",
"VNM",
"VGB",
"WLF",
"ESH",
"YEM",
"ZMB",
"ZWE"
],
"enumNames": [
"United States",
"Afghanistan",
"Albania",
"Algeria",
"Andorra",
"Angola",
"Anguilla",
"Antarctica",
"Antigua",
"Argentina",
"Armenia",
"Aruba",
"Australia",
"Austria",
"Azerbaijan",
"Bahamas",
"Bahrain",
"Bangladesh",
"Barbados",
"Belarus",
"Belgium",
"Belize",
"Benin",
"Bermuda",
"Bhutan",
"Bolivia",
"Bosnia",
"Botswana",
"Bouvet Island",
"Brazil",
"British Indian Ocean Territories",
"Brunei Darussalam",
"Bulgaria",
"Burkina Faso",
"Burundi",
"Cambodia",
"Cameroon",
"Canada",
"Cape Verde",
"Cayman",
"Central African Republic",
"Chad",
"Chile",
"China",
"Christmas Island",
"Cocos Islands",
"Colombia",
"Comoros",
"Congo",
"Democratic Republic of the Congo",
"Cook Islands",
"Costa Rica",
"Ivory Coast",
"Croatia",
"Cuba",
"Cyprus",
"Czech Republic",
"Denmark",
"Djibouti",
"Dominica",
"Dominican Republic",
"Ecuador",
"Egypt",
"El Salvador",
"Equatorial Guinea",
"Eritrea",
"Estonia",
"Ethiopia",
"Falkland Islands",
"Faroe Islands",
"Fiji",
"Finland",
"France",
"French Guiana",
"French Polynesia",
"French Southern Territories",
"Gabon",
"Gambia",
"Georgia",
"Germany",
"Ghana",
"Gibraltar",
"Greece",
"Greenland",
"Grenada",
"Guadeloupe",
"Guatemala",
"Guinea",
"Guinea-Bissau",
"Guyana",
"Haiti",
"Heard Island",
"Honduras",
"Hong Kong",
"Hungary",
"Iceland",
"India",
"Indonesia",
"Iran",
"Iraq",
"Ireland",
"Israel",
"Italy",
"Jamaica",
"Japan",
"Jordan",
"Kazakhstan",
"Kenya",
"Kiribati",
"North Korea",
"South Korea",
"Kuwait",
"Kyrgyzstan",
"Laos",
"Latvia",
"Lebanon",
"Lesotho",
"Liberia",
"Libya",
"Liechtenstein",
"Lithuania",
"Luxembourg",
"Macao",
"Macedonia",
"Madagascar",
"Malawi",
"Malaysia",
"Maldives",
"Mali",
"Malta",
"Martinique",
"Mauritania",
"Mauritius",
"Mayotte",
"Mexico",
"Micronesia",
"Moldova",
"Monaco",
"Mongolia",
"Montserrat",
"Morocco",
"Mozambique",
"Myanmar",
"Namibia",
"Nauru",
"Nepal",
"Netherlands Antilles",
"Netherlands",
"New Caledonia",
"New Zealand",
"Nicaragua",
"Niger",
"Nigeria",
"Niue",
"Norfolk",
"Norway",
"Oman",
"Pakistan",
"Panama",
"Papua New Guinea",
"Paraguay",
"Peru",
"Philippines",
"Pitcairn",
"Poland",
"Portugal",
"Qatar",
"Reunion",
"Romania",
"Russia",
"Rwanda",
"Saint Helena",
"Saint Kitts and Nevis",
"Saint Lucia",
"Saint Pierre and Miquelon",
"Saint Vincent and the Grenadines",
"San Marino",
"Sao Tome and Principe",
"Saudi Arabia",
"Senegal",
"Serbia",
"Seychelles",
"Sierra Leone",
"Singapore",
"Slovakia",
"Slovenia",
"Solomon Islands",
"Somalia",
"South Africa",
"South Georgia and the South Sandwich Islands",
"Spain",
"Sri Lanka",
"Sudan",
"Suriname",
"Swaziland",
"Sweden",
"Switzerland",
"Syrian Arab Republic",
"Taiwan",
"Tajikistan",
"Tanzania",
"Thailand",
"Timor-Leste",
"Togo",
"Tokelau",
"Tonga",
"Trinidad and Tobago",
"Tunisia",
"Turkey",
"Turkmenistan",
"Turks and Caicos Islands",
"Tuvalu",
"Uganda",
"Ukraine",
"United Arab Emirates",
"United Kingdom",
"Uruguay",
"Uzbekistan",
"Vanuatu",
"Vatican",
"Venezuela",
"Vietnam",
"British Virgin Islands",
"Wallis and Futuna",
"Western Sahara",
"Yemen",
"Zambia",
"Zimbabwe"
]
},
"addressLine1": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^.*\\S.*"
},
"addressLine2": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^.*\\S.*"
},
"addressLine3": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^.*\\S.*"
},
"city": {
"type": "string"
},
"stateCode": {
"type": "string",
"enum": [
"AL",
"AK",
"AS",
"AZ",
"AR",
"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"
],
"enumNames": [
"Alabama",
"Alaska",
"American Samoa",
"Arizona",
"Arkansas",
"California",
"Colorado",
"Connecticut",
"Delaware",
"District Of Columbia",
"Federated States Of Micronesia",
"Florida",
"Georgia",
"Guam",
"Hawaii",
"Idaho",
"Illinois",
"Indiana",
"Iowa",
"Kansas",
"Kentucky",
"Louisiana",
"Maine",
"Marshall Islands",
"Maryland",
"Massachusetts",
"Michigan",
"Minnesota",
"Mississippi",
"Missouri",
"Montana",
"Nebraska",
"Nevada",
"New Hampshire",
"New Jersey",
"New Mexico",
"New York",
"North Carolina",
"North Dakota",
"Northern Mariana Islands",
"Ohio",
"Oklahoma",
"Oregon",
"Palau",
"Pennsylvania",
"Puerto Rico",
"Rhode Island",
"South Carolina",
"South Dakota",
"Tennessee",
"Texas",
"Utah",
"Vermont",
"Virgin Islands",
"Virginia",
"Washington",
"West Virginia",
"Wisconsin",
"Wyoming"
]
},
"province": {
"type": "string"
},
"zipCode": {
"type": "string",
"pattern": "^\\d{5}$"
},
"internationalPostalCode": {
"type": "string"
}
}
}
},
"properties": {
"optionSelection": {
"type": "object",
"view:selectable686Options": {
"type": "object",
"properties": {
"addSpouse": {
"$ref": "#/definitions/genericTrueFalse",
"default": false
},
"addChild": {
"$ref": "#/definitions/genericTrueFalse",
"default": false
},
"report674": {
"$ref": "#/definitions/genericTrueFalse",
"default": false
},
"reportDivorce": {
"$ref": "#/definitions/genericTrueFalse",
"default": false
},
"reportStepchildNotInHousehold": {
"$ref": "#/definitions/genericTrueFalse",
"default": false
},
"reportDeath": {
"$ref": "#/definitions/genericTrueFalse",
"default": false
},
"reportMarriageOfChildUnder18": {
"$ref": "#/definitions/genericTrueFalse",
"default": false
},
"reportChild18OrOlderIsNotAttendingSchool": {
"$ref": "#/definitions/genericTrueFalse",
"default": false
}
}
}
},
"veteranInformation": {
"type": "object",
"properties": {
"veteranInformation": {
"type": "object",
"properties": {}
},
"veteranAddress": {
"type": "object",
"properties": {
"veteranAddress": {
"$ref": "#/definitions/addressSchema"
},
"phoneNumber": {
"$ref": "#/definitions/phone"
},
"emailAddress": {
"$ref": "#/definitions/email"
}
}
}
}
},
"addChild": {
"type": "object",
"properties": {
"addChildInformation": {
"type": "object",
"properties": {
"childrenToAdd": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"properties": {
"fullName": {
"$ref": "#/definitions/fullName"
},
"ssn": {
"$ref": "#/definitions/ssn"
},
"birthDate": {
"$ref": "#/definitions/date"
}
}
}
}
}
},
"addChildPlaceOfBirth": {
"type": "object",
"properties": {
"childrenToAdd": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"properties": {
"placeOfBirth": {
"$ref": "#/definitions/genericLocation"
},
"childStatus": {
"type": "object",
"properties": {
"biological": {
"$ref": "#/definitions/genericTrueFalse"
},
"adopted": {
"$ref": "#/definitions/genericTrueFalse"
},
"stepchild": {
"$ref": "#/definitions/genericTrueFalse"
},
"biologicalStepchild": {
"$ref": "#/definitions/genericTrueFalse"
},
"dateBecameDependent": {
"$ref": "#/definitions/date"
},
"stepchildParent": {
"$ref": "#/definitions/fullName"
},
"ssn": {
"$ref": "#/definitions/ssn"
},
"birthDate": {
"$ref": "#/definitions/date"
}
}
},
"view:childStatusInformation": {
"type": "object",
"properties": {}
},
"notSelfSufficient": {
"$ref": "#/definitions/genericTrueFalse"
},
"view:notSelfSufficientDescription": {
"type": "object",
"properties": {}
},
"previouslyMarried": {
"type": "string",
"enum": [
"Yes",
"No"
]
},
"previousMarriageDetails": {
"type": "object",
"properties": {
"dateMarriageEnded": {
"$ref": "#/definitions/date"
},
"reasonMarriageEnded": {
"type": "string",
"enum": [
"Divorce",
"Death",
"Annulment",
"Other"
]
},
"otherReasonMarriageEnded": {
"$ref": "#/definitions/genericTextInput"
}
}
},
"childIncome": {
"$ref": "#/definitions/genericTrueFalse"
}
}
}
}
}
},
"addChildAdditionalInformation": {
"type": "object",
"properties": {
"childrenToAdd": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"properties": {
"doesChildLiveWithYou": {
"$ref": "#/definitions/genericTrueFalse"
},
"childAddressInfo": {
"type": "object",
"properties": {
"personChildLivesWith": {
"$ref": "#/definitions/fullName"
},
"address": {
"$ref": "#/definitions/addressSchema"
}
}
}
}
}
}
}
},
"childAdditionalEvidence": {
"type": "object",
"properties": {
"view:additionalEvidenceDescription": {
"type": "object",
"properties": {}
},
"childEvidenceDocumentType": {
"type": "string",
"enum": [
"13",
"25",
"58",
"59",
"663",
"10"
],
"enumNames": [
"Adoption Decree",
"Birth Certificate",
"Medical Treatment Record - Government Facility",
"Medical Treatment Record - Non-Government Facility",
"Medical Opinion",
"Unknown"
]
},
"childSupportingDocuments": {
"$ref": "#/definitions/files"
}
}
}
}
},
"addSpouse": {
"type": "object",
"properties": {
"spouseNameInformation": {
"type": "object",
"properties": {
"fullName": {
"$ref": "#/definitions/fullName"
},
"ssn": {
"$ref": "#/definitions/ssn"
},
"birthDate": {
"$ref": "#/definitions/date"
},
"isVeteran": {
"$ref": "#/definitions/genericTrueFalse"
},
"vaFileNumber": {
"$ref": "#/definitions/genericNumberAndDashInput"
},
"serviceNumber": {
"$ref": "#/definitions/genericNumberAndDashInput"
}
}
},
"currentMarriageInformation": {
"type": "object",
"properties": {
"date": {
"$ref": "#/definitions/date"
},
"location": {
"$ref": "#/definitions/genericLocation"
},
"type": {
"type": "string",
"enum": [
"CEREMONIAL",
"COMMON-LAW",
"TRIBAL",
"PROXY",
"OTHER"
],
"enumNames": [
"Religious or civil ceremony (minister, justice of the peace, etc.)",
"Common-law",
"Tribal",
"Proxy",
"Other"
]
},
"typeOther": {
"$ref": "#/definitions/genericTextInput"
},
"view:marriageTypeInformation": {
"type": "object",
"properties": {}
}
}
},
"doesLiveWithSpouse": {
"type": "object",
"properties": {
"spouseDoesLiveWithVeteran": {
"$ref": "#/definitions/genericTrueFalse"
},
"currentSpouseReasonForSeparation": {
"type": "string",
"enum": [
"Death",
"Divorce",
"Other"
]
},
"address": {
"$ref": "#/definitions/addressSchema"
},
"spouseIncome": {
"$ref": "#/definitions/genericTrueFalse"
}
}
},
"spouseMarriageHistory": {
"type": "object",
"properties": {
"spouseWasMarriedBefore": {
"$ref": "#/definitions/genericTrueFalse"
},
"spouseMarriageHistory": {
"type": "array",
"items": {
"type": "object",
"properties": {
"fullName": {
"$ref": "#/definitions/fullName"
}
}
}
}
}
},
"spouseMarriageHistoryDetails": {
"type": "object",
"properties": {
"spouseMarriageHistory": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startDate": {
"$ref": "#/definitions/date"
},
"startLocation": {
"$ref": "#/definitions/genericLocation"
},
"reasonMarriageEnded": {
"type": "string",
"enum": [
"Divorce",
"Death",
"Other"
],
"enumNames": [
"Divorce",
"Death",
"Annulment/Other"
]
},
"reasonMarriageEndedOther": {
"$ref": "#/definitions/genericTextInput"
},
"endDate": {
"$ref": "#/definitions/date"
},
"endLocation": {
"$ref": "#/definitions/genericLocation"
}
}
}
}
}
},
"veteranMarriageHistory": {
"type": "object",
"properties": {
"veteranWasMarriedBefore": {
"$ref": "#/definitions/genericTrueFalse"
},
"veteranMarriageHistory": {
"type": "array",
"items": {
"type": "object",
"properties": {
"fullName": {
"$ref": "#/definitions/fullName"
}
}
}
}
}
},
"veteranMarriageHistoryDetails": {
"type": "object",
"properties": {
"veteranMarriageHistory": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startDate": {
"$ref": "#/definitions/date"
},
"startLocation": {
"$ref": "#/definitions/genericLocation"
},
"reasonMarriageEnded": {
"type": "string",
"enum": [
"Divorce",
"Death",
"Other"
],
"enumNames": [
"Divorce",
"Death",
"Annulment/Other"
]
},
"reasonMarriageEndedOther": {
"$ref": "#/definitions/genericTextInput"
},
"endDate": {
"$ref": "#/definitions/date"
},
"endLocation": {
"$ref": "#/definitions/genericLocation"
}
}
}
}
}
},
"marriageAdditionalEvidence": {
"type": "object",
"properties": {
"view:additionalEvidenceDescription": {
"type": "object",
"properties": {}
},
"spouseEvidenceDocumentType": {
"type": "string",
"enum": [
"14",
"61",
"119",
"10"
],
"enumNames": [
"Affidavit",
"Marriage Certificate / License",
"VA 21-4171 Supporting Statement Regarding Marriage",
"Unknown"
]
},
"spouseSupportingDocuments": {
"$ref": "#/definitions/files"
}
}
}
}
},
"reportDivorce": {
"type": "object",
"properties": {
"fullName": {
"$ref": "#/definitions/fullName"
},
"ssn": {
"$ref": "#/definitions/ssn"
},
"birthDate": {
"$ref": "#/definitions/date"
},
"date": {
"$ref": "#/definitions/date"
},
"location": {
"$ref": "#/definitions/genericLocation"
},
"reasonMarriageEnded": {
"type": "string",
"enum": [
"Divorce",
"Other"
],
"enumNames": [
"Divorce",
"Annulment/Other"
]
},
"explanationOfOther": {
"$ref": "#/definitions/genericTextInput"
},
"spouseIncome": {
"$ref": "#/definitions/genericTrueFalse"
}
}
},
"deceasedDependents": {
"type": "object",
"properties": {
"dependentInformation": {
"type": "object",
"properties": {
"deaths": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"properties": {
"fullName": {
"$ref": "#/definitions/fullName"
},
"ssn": {
"$ref": "#/definitions/ssn"
},
"birthDate": {
"$ref": "#/definitions/date"
},
"dependentType": {
"type": "string",
"enum": [
"SPOUSE",
"DEPENDENT_PARENT",
"CHILD"
],
"enumNames": [
"Spouse",
"Dependent Parent",
"Child"
]
},
"childStatus": {
"type": "object",
"properties": {
"childUnder18": {
"$ref": "#/definitions/genericTrueFalse"
},
"stepChild": {
"$ref": "#/definitions/genericTrueFalse"
},
"adopted": {
"$ref": "#/definitions/genericTrueFalse"
},
"disabled": {
"$ref": "#/definitions/genericTrueFalse"
},
"childOver18InSchool": {
"$ref": "#/definitions/genericTrueFalse"
}
}
}
}
}
}
}
},
"dependentAdditionalInformation": {
"type": "object",
"properties": {
"deaths": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"properties": {
"date": {
"$ref": "#/definitions/date"
},
"location": {
"$ref": "#/definitions/genericLocation"
},
"dependentIncome": {
"$ref": "#/definitions/genericTrueFalse"
}
}
}
}
}
}
}
},
"reportChildMarriage": {
"type": "object",
"properties": {
"fullName": {
"$ref": "#/definitions/fullName"
},
"ssn": {
"$ref": "#/definitions/ssn"
},
"birthDate": {
"$ref": "#/definitions/date"
},
"dateMarried": {
"$ref": "#/definitions/date"
},
"dependentIncome": {
"$ref": "#/definitions/genericTrueFalse"
}
}
},
"reportChildStoppedAttendingSchool": {
"type": "object",
"properties": {
"fullName": {
"$ref": "#/definitions/fullName"
},
"ssn": {
"$ref": "#/definitions/ssn"
},
"birthDate": {
"$ref": "#/definitions/date"
},
"dateChildLeftSchool": {
"$ref": "#/definitions/date"
},
"dependentIncome": {
"$ref": "#/definitions/genericTrueFalse"
}
}
},
"reportStepchildNotInHousehold": {
"type": "object",
"properties": {
"stepchildren": {
"type": "object",
"properties": {
"stepChildren": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"properties": {
"fullName": {
"$ref": "#/definitions/fullName"
},
"ssn": {
"$ref": "#/definitions/ssn"
},
"birthDate": {
"$ref": "#/definitions/date"
}
}
}
}
}
},
"stepchildInformation": {
"type": "object",
"properties": {
"stepChildren": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"properties": {
"supportingStepchild": {
"$ref": "#/definitions/genericTrueFalse",
"default": false
},
"livingExpensesPaid": {
"type": "string",
"enum": [
"More than half",
"Half",
"Less than half"
]
},
"whoDoesTheStepchildLiveWith": {
"$ref": "#/definitions/fullName"
},
"address": {
"$ref": "#/definitions/addressSchema"
}
}
}
}
}
}
}
},
"report674": {
"type": "object",
"properties": {
"studentNameAndSsn": {
"type": "object",
"properties": {
"view:674Information": {
"type": "object",
"properties": {}
},
"fullName": {
"$ref": "#/definitions/fullName"
},
"ssn": {
"$ref": "#/definitions/ssn"
},
"birthDate": {
"$ref": "#/definitions/date"
},
"isParent": {
"$ref": "#/definitions/genericTrueFalse"
},
"dependentIncome": {
"$ref": "#/definitions/genericTrueFalse"
}
}
},
"studentAddressMarriageTuition": {
"type": "object",
"properties": {
"address": {
"$ref": "#/definitions/addressSchema"
},
"wasMarried": {
"$ref": "#/definitions/genericTrueFalse"
},
"marriageDate": {
"$ref": "#/definitions/date"
},
"tuitionIsPaidByGovAgency": {
"$ref": "#/definitions/genericTrueFalse"
},
"agencyName": {
"$ref": "#/definitions/genericTextInput"
},
"datePaymentsBegan": {
"$ref": "#/definitions/date"
}
}
},
"studentSchoolAddress": {
"type": "object",
"properties": {
"schoolInformation": {
"type": "object",
"properties": {
"name": {
"$ref": "#/definitions/genericTextInput"
},
"schoolType": {
"type": "string",
"enum": [
"HighSch",
"College",
"HomeSch"
],
"enumNames": [
"High School",
"Postsecondary",
"Home School"
]
},
"trainingProgram": {
"$ref": "#/definitions/genericTextInput"
},
"address": {
"$ref": "#/definitions/addressSchema"
}
}
}
}
},
"studentTermDates": {
"type": "object",
"properties": {
"currentTermDates": {
"type": "object",
"properties": {
"officialSchoolStartDate": {
"$ref": "#/definitions/date"
},
"expectedStudentStartDate": {
"$ref": "#/definitions/date"
},
"expectedGraduationDate": {
"$ref": "#/definitions/date"
}
}
},
"programInformation": {
"type": "object",
"properties": {
"studentIsEnrolledFullTime": {
"$ref": "#/definitions/genericTrueFalse"
},
"courseOfStudy": {
"$ref": "#/definitions/genericTextInput"
},
"classesPerWeek": {
"type": "number"
},
"hoursPerWeek": {
"type": "number"
}
}
}
}
},
"studentLastTerm": {
"type": "object",
"properties": {
"studentDidAttendSchoolLastTerm": {
"$ref": "#/definitions/genericTrueFalse"
},
"lastTermSchoolInformation": {
"type": "object",
"properties": {
"name": {
"$ref": "#/definitions/genericTextInput"
},
"address": {
"$ref": "#/definitions/addressSchema"
},
"termBegin": {
"$ref": "#/definitions/date"
},
"dateTermEnded": {
"$ref": "#/definitions/date"
},
"classesPerWeek": {
"type": "number"
},
"hoursPerWeek": {
"type": "number"
}
}
}
}
},
"studentIncomeInformation": {
"type": "object",
"properties": {
"studentDoesEarnIncome": {
"$ref": "#/definitions/genericTrueFalse"
},
"studentEarningsFromSchoolYear": {
"type": "object",
"properties": {
"earningsFromAllEmployment": {
"$ref": "#/definitions/currencyInput"
},
"annualSocialSecurityPayments": {
"$ref": "#/definitions/currencyInput"
},
"otherAnnuitiesIncome": {
"$ref": "#/definitions/currencyInput"
},
"allOtherIncome": {
"$ref": "#/definitions/currencyInput"
}
}
},
"studentWillEarnIncomeNextYear": {
"$ref": "#/definitions/genericTrueFalse"
},
"studentExpectedEarningsNextYear": {
"type": "object",
"properties": {
"earningsFromAllEmployment": {
"$ref": "#/definitions/currencyInput"
},
"annualSocialSecurityPayments": {
"$ref": "#/definitions/currencyInput"
},
"otherAnnuitiesIncome": {
"$ref": "#/definitions/currencyInput"
},
"allOtherIncome": {
"$ref": "#/definitions/currencyInput"
}
}
}
}
},
"studentNetworthInformation": {
"type": "object",
"properties": {
"studentDoesHaveNetworth": {
"$ref": "#/definitions/genericTrueFalse"
},
"studentNetworthInformation": {
"type": "object",
"properties": {
"savings": {
"$ref": "#/definitions/currencyInput"
},
"securities": {
"$ref": "#/definitions/currencyInput"
},
"realEstate": {
"$ref": "#/definitions/currencyInput"
},
"otherAssets": {
"$ref": "#/definitions/currencyInput"
},
"remarks": {
"type": "string",
"maxLength": 500,
"pattern": "^(?!\\s)(?!.*?\\s{2,})[^<>%$#@!^&*]+$"
}
}
}
}
}
}
},
"householdIncome": {
"type": "object",
"properties": {
"householdIncome": {
"$ref": "#/definitions/genericTrueFalse"
}
}
}
}
}
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/Practitioner.yml
|
type: object
additionalProperties: false
required:
- identifier
- address
properties:
identifier:
type: array
items:
type: object
additionalProperties: false
required:
- system
- value
properties:
system:
type: string
example: http://hl7.org/fhir/sid/us-npi
value:
type: string
example: 1407938061
address:
type: object
additionalProperties: false
required:
- line
- city
- state
- postal_code
properties:
type:
type: string
example: postal
line:
type: array
items:
type: string
example: 38143 Martha Ave
city:
type: string
example: Fremont
state:
type: string
example: CA
postal_code:
type: string
example: 94536
country:
type: string
example: USA
text:
type: string
example: test
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/DependentsRequestDecisions.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: object
additionalProperties: false
required:
- id
- type
- attributes
properties:
id:
type: string
example: "abe3f152-90b0-45cb-8776-4958bad0e0ef"
description: user UUID
type:
type: string
example: "dependency_request_decisions"
attributes:
type: object
additionalProperties: false
required:
- dependencyVerifications
- diaries
- promptRenewal
properties:
dependencyVerifications:
type: array
items:
type: object
additionalProperties: false
required:
- awardEffectiveDate
- awardEventId
- awardType
- beginAwardEventId
- beneficiaryId
- birthdayDate
- decisionDate
- decisionId
- dependencyDecisionId
- dependencyDecisionType
- dependencyDecisionTypeDescription
- dependencyStatusType
- dependencyStatusTypeDescription
- eventDate
- firstName
- fullName
- lastName
- modifiedAction
- modifiedBy
- modifiedDate
- modifiedLocation
- modifiedProcess
- personId
- relationshipTypeDescription
- sortDate
- sortOrderNumber
- veteranId
properties:
awardEffectiveDate:
type: string
nullable: true
example: "2000-06-01T00:00:00.000-05:00"
awardEventId:
type: string
nullable: true
example: "60300"
awardType:
type: string
example: "CPL"
beginAwardEventId:
type: string
nullable: true
example: "25326"
beneficiaryId:
type: string
example: "13014883"
birthdayDate:
type: string
nullable: true
example: "2000-05-05T00:00:00.000-05:00"
decisionDate:
type: string
nullable: true
example: "2006-05-02T09:46:06.000-05:00"
decisionId:
type: string
nullable: true
example: "24678"
dependencyDecisionId:
type: string
nullable: true
example: "14599"
dependencyDecisionType:
type: string
nullable: true
example: "DEPEST"
dependencyDecisionTypeDescription:
type: string
nullable: true
example: "Dependency Established"
dependencyStatusType:
type: string
nullable: true
example: "SP"
dependencyStatusTypeDescription:
type: string
nullable: true
example: "Spouse"
eventDate:
type: string
nullable: true
example: "2000-05-05T00:00:00.000-05:00"
firstName:
type: string
example: "lauren"
fullName:
type: string
nullable: true
example: "lauren jakes"
lastName:
type: string
example: "jakes"
modifiedAction:
type: string
example: "U"
modifiedBy:
type: string
example: "IA"
modifiedDate:
type: string
nullable: true
example: "2008-04-21T14:14:20.000-05:00"
modifiedLocation:
type: string
example: "101"
modifiedProcess:
type: string
example: "106072 Backfill"
personId:
type: string
example: "13018361"
relationshipTypeDescription:
type: string
nullable: true
example: "Spouse"
sortDate:
type: string
nullable: true
example: "2006-05-02T09:46:06.000-05:00"
sortOrderNumber:
type: string
example: "0"
nullable: true
veteranId:
type: string
nullable: true
example: "13014883"
diaries:
type: array
items:
type: object
additionalProperties: false
required:
- awardDiaryId
- awardType
- beneficaryId
- diaryDueDate
- diaryLcStatusType
- diaryLcStatusTypeDescription
- diaryReasonType
- diaryReasonTypeDescription
- fileNumber
- firstNm
- lastName
- modifiedAction
- modifiedBy
- modifiedDate
- modifiedLocation
- modifiedProcess
- ptcpntDiaryId
- statusDate
- veteranId
- payeeType
properties:
awardDiaryId:
type: string
example: "3322"
awardType:
type: string
example: "CPL"
beneficaryId:
type: string
example: "13014883"
diaryDueDate:
type: string
example: "2014-05-01T00:00:00.000-05:00"
diaryLcStatusType:
type: string
example: "PEND"
diaryLcStatusTypeDescription:
type: string
example: "Pending"
diaryReasonType:
type: string
example: "24"
diaryReasonTypeDescription:
type: string
example: "Issue Dependency Verification Form"
fileNumber:
type: string
example: "546212222"
firstNm:
type: string
example: "Ray"
lastName:
type: string
example: "Jakes"
modifiedAction:
type: string
example: "I"
modifiedBy:
type: string
example: "CAPSBRAN"
modifiedDate:
type: string
example: "2006-05-02T07:52:11.000-05:00"
modifiedLocation:
type: string
example: "317"
modifiedProcess:
type: string
example: "cp_diary_pkg.do_create"
ptcpntDiaryId:
type: string
example: "13018359"
statusDate:
type: string
example: "2006-05-02T07:52:11.000-05:00"
veteranId:
type: string
example: "13014883"
payeeType:
type: string
example: "11"
nullable: true
promptRenewal:
type: boolean
example: false
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/ClaimsAndAppealsOverviewAppealsError.yml
|
type: object
additionalProperties: false
required:
- data
- meta
properties:
data:
type: array
items:
type: object
additionalProperties: false
properties:
id:
type: string
example: "600117255"
description: Claim Id
type:
type: string
example: "claim"
enum:
- claim
attributes:
type: object
additionalProperties: false
required:
- subtype
- completed
- dateFiled
- updatedAt
- displayTitle
- decisionLetterSent
- phase
- documentsNeeded
- developmentLetterSent
- claimTypeCode
properties:
subtype:
type: string
example: "Compensation"
description: Human readable string for claim or appeal subtype
completed:
type: boolean
dateFiled:
type: string
format: date
nullable: true
example: "2020-01-01"
updatedAt:
type: string
format: date
nullable: true
example: "2020-01-01"
displayTitle:
type: string
description: Formatted title for display in mobile overview list
example: "disability compensation appeal"
decisionLetterSent:
type: boolean
description: decision letter will be available from endpoint /v0/claims/decision-letters if true
example: "true"
phase:
type: integer
nullable: true
description: The phase of processing the claim is in. This does not apply to appeals. The integers used map to the phases as `1 => CLAIM_RECEIVED, 2 => UNDER_REVIEW, 3 => GATHERING_OF_EVIDENCE, 4 => REVIEW_OF_EVIDENCE, 5 => PREPARATION_FOR_DECISION, 6 => PENDING_DECISION_APPROVAL, 7 => PREPARATION_FOR_NOTIFICATION, 8 => COMPLETE`
example: 1
documentsNeeded:
type: boolean
nullable: true
description: Documents are still needed.
example: "true"
developmentLetterSent:
type: boolean
nullable: true
description: Development letter has been sent.
example: "true"
claimTypeCode:
type: string
description: Type of claim
nullable: true
example: "020NEW"
claimTypeBase:
type: string
description: Base type of claim
nullable: true
meta:
type: object
additionalProperties: false
properties:
errors:
type: array
description: Array of objects of failing upstream services. Used for debugging only.
items:
type: object
additionalProperties: false
required:
- service
- errorDetails
properties:
service:
type: string
example: "appeals"
enum:
- appeals
errorDetails:
type: string
description: List of errors encountered concatenated with semicolon delimiter.
example: "Received a 500 response from the upstream server"
pagination:
type: object
additionalProperties: false
required:
- currentPage
- perPage
- totalPages
- totalEntries
properties:
currentPage:
type: number
example: 1
perPage:
type: number
example: 10
totalPages:
type: number
example: 2
totalEntries:
type: number
example: 15
activeClaimsCount:
type: number
example: 3
description: Count of claims with `completed` set to false
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/UserDemographics.yml
|
type: object
additionalProperties: false
required:
- id
- type
- attributes
properties:
id:
type: string
example: "3be0c7de-bfe1-4101-a326-5567bcd98b63"
description: user UUID
type:
type: string
example: "demographics"
attributes:
type: object
additionalProperties: false
required:
- genderIdentity
- preferredName
properties:
genderIdentity:
type: string
example: "F"
preferredName:
type: string
example: "SAM"
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/GenderIdentityEdit.yml
|
type: object
additionalProperties: false
required:
- code
properties:
data:
type: object
additionalProperties: false
properties:
id:
type: string
example: "23fe358d-6e82-4541-804c-ce7562ba28f4"
description: user UUID
type:
type: string
example: "GenderIdentityOptions"
attributes:
type: object
additionalProperties: false
required:
- options
properties:
options:
type: object
additionalProperties: false
example:
M: "Man"
B: "Non-binary"
TM: "Transgender man"
TF: "Transgender woman"
F: "Woman"
N: "Prefer not to answer"
O: "A gender not listed here"
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/CreateDependentsResponse.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: object
additionalProperties: false
required:
- id
- type
- attributes
properties:
id:
type: string
example: bf01349c-585d-480f-8afc-7a2f88697a1a
description: Randomly generated UUID
type:
type: string
example: dependents
attributes:
type: object
additionalProperties: false
required:
- submitFormJobId
properties:
submitFormJobId:
type: string
example: "908550d787e8dbfb0bf3df85"
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/LabsAndTests.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: array
items:
type: object
additionalProperties: false
required:
- type
- id
- attributes
properties:
type:
type: string
example: letter
id:
type: string
example: abe3f152-90b0-45cb-8776-4958bad0e0ef
description: Upstream identifier
attributes:
type: object
additionalProperties: false
required:
- category
- subject
- effectiveDateTime
- issued
- result
properties:
category:
type: string
example: 'Laboratory'
subject:
type: object
additionalProperties: false
required:
- reference
- display
properties:
reference:
type: string
example: 'https://sandbox-api.va.gov/services/fhir/v0/r4/Patient/1000005'
display:
type: string
example: 'Mr. Shane235 Bartell116'
effectiveDateTime:
type: datetime
example: 2019-04-20T14:15:00.000-04:00
issued:
type: datetime
example: 2019-04-20T14:15:00.000-04:00
results:
type: array
items:
type: object
additionalProperties: false
required:
- reference
- display
properties:
reference:
type: string
example: 'https://sandbox-api.va.gov/services/fhir/v0/r4/Observation/I2-ILWORI4YUOUAR5H2GCH6ATEFRM000000'
display:
type: string
example: 'Glucose'
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/AppointmentExtensions.yml
|
type: object
properties:
desiredDate:
type: string
description: Optional field indicating the date and time that the patient originally desired to have the appointment. Used for reporting with VistA appointments.
format: date-time
ccLocation:
$ref: ./CommunityCareLocation.yml
ccRequestedCancellation:
type: boolean
description: Indicates if a cancellation request has been submitted for an appointment request.
description: Non-standard FHIR Appointment attributes.
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/ClaimsAndAppealsOverview502.yml
|
type: object
additionalProperties: false
required:
- data
- meta
properties:
data:
type: array
meta:
properties:
errors:
type: array
items:
type: array
items:
type: object
additionalProperties: false
$ref: "./ClaimsAndAppealsOverviewErrors.yml"
description: Array info about failing upstream services
pagination:
type: object
additionalProperties: false
required:
- currentPage
- perPage
- totalPages
- totalEntries
properties:
currentPage:
type: number
example: 1
perPage:
type: number
example: 10
totalPages:
type: number
example: 2
totalEntries:
type: number
example: 15
activeClaimsCount:
type: number
example: 3
description: Count of claims with `completed` set to false
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/FacilitiesInfoRequestBody.yml
|
type: object
properties:
lat:
type: number
example: 34.5968
description: lat for user's current location
long:
type: number
example: 10.5796
description: long for user's current location
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/FacilityClinic.yml
|
type: object
additionalProperties: false
required:
- type
- id
- attributes
properties:
type:
type: string
example: facility_clinic
id:
type: string
example: "12345"
description: Upstream identifier
attributes:
type: object
additionalProperties: false
required:
- name
properties:
name:
type: string
example: 'C&P Optometry'
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/AppointmentCheckin.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: object
additionalProperties: false
required:
- type
- id
- attributes
properties:
type:
type: string
example: "check_in"
id:
type: string
example: "75db6a5c-84ae-4ca4-bba2-ef4c41d563ab"
description: user uuid
attributes:
type: object
additionalProperties: false
required:
- id
- code
- message
properties:
id:
type: string
example: "75db6a5c-84ae-4ca4-bba2-ef4c41d563ab"
description: user uuid
code:
type: string
example: 'check-in-success'
message:
type: string
example: 'Check-In successful'
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/claimDocument.yml
|
type: object
properties:
tracked_item_id:
type: integer
example: 360_052
file_type:
type: integer
example: 'Civilian Police Reports'
document_type:
type: null
example: null
filename:
type: string
example: '7B434B58-477C-4379-816F-05E6D3A10487.pdf'
upload_date:
type: string
example: '2023-03-01'
document_id:
type: string
example: '{6A6DFA79-4EC9-4E58-9653-25BDCFB06A03}'
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/AddressUpdate.yml
|
type: object
additionalProperties: false
required:
- id
- addressLine1
- addressPou
- addressType
- city
- countryCode
properties:
id:
type: string
example: "23fe358d-6e82-4541-804c-ce7562ba28f4"
addressMetaData:
type: object
additionalProperties: false
properties:
confidenceScore:
type: integer
example: 100
addressType:
type: string
example: "Domestic"
deliveryPointValidation:
type: string
example: "CONFIRMED"
residentialDeliveryIndicator:
type: string
example: "RESIDENTIAL"
validationKey:
type: integer
example: 0
addressLine1:
type: string
example: "1493 Martin Luther King Rd"
addressLine2:
type: string
nullable: true
addressLine3:
type: string
nullable: true
addressPou:
type: string
enum: [ "RESIDENCE/CHOICE", "CORRESPONDENCE" ]
example: "RESIDENCE/CHOICE"
addressType:
type: string
enum: [ "DOMESTIC", "INTERNATIONAL", "MILITARY" ]
example: "DOMESTIC"
city:
type: string
example: "Fulton"
countryCode:
type: string
example: "US"
internationalPostalCode:
type: string
nullable: true
example: null
province:
type: string
nullable: true
example: null
stateCode:
type: string
example: "NY"
zipCode:
type: string
example: "97062"
zipCodeSuffix:
type: string
nullable: true
example: "1234"
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/ServiceEligibilities.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: object
additionalProperties: false
required:
- type
- id
- attributes
properties:
type:
type: string
example: "va_eligibility"
id:
type: string
example: "6260ab13-177f-583d-b2dc-1b350404abb7"
description: user UUID
attributes:
type: object
additionalProperties: false
required:
- ccSupported
- services
properties:
ccSupported:
type: array
items:
type: string
example: ["942"]
services:
type: array
items:
type: object
additionalProperties: false
example: [{name: 'amputation',requestEligibleFacilities: ['942','123'], directEligibleFacilities: ['945','342']},
{name: 'audiology',requestEligibleFacilities: ['942','123'], directEligibleFacilities: ['945','342']},
{name: 'covid',requestEligibleFacilities: ['942','123'], directEligibleFacilities: ['945','342']},
{name: 'optometry',requestEligibleFacilities: ['942','123'], directEligibleFacilities: ['945','342']},
{name: 'outpatientMentalHealth',requestEligibleFacilities: ['942','123'], directEligibleFacilities: ['945','342']},
{name: 'moveProgram',requestEligibleFacilities: ['942','123'], directEligibleFacilities: ['945','342']},
{name: 'foodAndNutrition',requestEligibleFacilities: ['942','123'], directEligibleFacilities: ['945','342']},
{name: 'clinicalPharmacyPrimaryCare',requestEligibleFacilities: ['942','123'], directEligibleFacilities: ['945','342']},
{name: 'podiatry',requestEligibleFacilities: ['942','123'], directEligibleFacilities: ['945','342']},
{name: 'primaryCare',requestEligibleFacilities: ['942','123'], directEligibleFacilities: ['945','342']},
{name: 'homeSleepTesting',requestEligibleFacilities: ['942','123'], directEligibleFacilities: ['945','342']},
{name: 'socialWork',requestEligibleFacilities: ['942','123'], directEligibleFacilities: ['945','342']},
{name: 'cpap',requestEligibleFacilities: ['942','123'], directEligibleFacilities: ['945','342']},
{name: 'ophthalmology',requestEligibleFacilities: ['942','123'], directEligibleFacilities: ['945','342']}]
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/ClinicSlots.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: array
items:
type: object
additionalProperties: false
$ref: "./Slot.yml"
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/CreateAppointmentRequest.yml
|
description: A request to create a new appointment.
type: object
additionalProperties: false
required:
- kind
- status
- serviceType
- reasonCode
- locationId
- requestedPeriods
- contact
- preferredTimesForPhoneCall
properties:
kind:
"$ref": ./AppointmentKind.yml
example: 'clinic'
status:
type: string
description: Always 'proposed' for requests
enum:
- proposed
example: 'proposed'
preferredTimesForPhoneCall:
type: array
description: A list of times the patient prefers to be contacted by phone.
items:
type: string
enum:
- Morning
- Afternoon
- Evening
example: [
"Morning"
]
serviceType:
type: string
description: the care type for the appointment
enum:
- amputation
- audiology-hearing aid support
- audiology-routine exam
- covid
- optometry
- outpatientMentalHealth
- moveProgram
- foodAndNutrition
- clinicalPharmacyPrimaryCare
- podiatry
- primaryCare
- homeSleepTesting
- socialWork
- cpap
- ophthalmology
example: 'optometry'
reasonCode:
type: object
additionalProperties: false
"$ref": ./ReasonCode.yml
locationId:
description: The sta6aid for the VAfacility where the appointment is registered.
type: string
example: '983GC'
requestedPeriods:
type: array
description: A list of requested periods for appointment.
items:
"$ref": ./Period.yml
example: [
{
"start":"2022-03-17T00:00:00Z",
"end":"2022-03-17T11:59:00Z"
}
]
contact:
"$ref": ./PatientContact.yml
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/TravelPayClaimSummary.yml
|
type: object
additionalProperties: false
required:
- id
- claimStatus
- appointmentDateTime
- facilityId
- createdOn
- modifiedOn
properties:
id:
type: string
nullable: false
example: "16cbc3d0-56de-4d86-abf3-ed0f6908ee53"
claimNumber:
type: string
nullable: true
example: 'TC00000000001'
claimStatus:
type: string
nullable: false
example: 'In process'
appointmentDateTime:
type: string
nullable: false
example: '2023-02-23T22:22:52.549Z'
facilityId:
type: string
nullable: true
example: '3fa85f64-5717-4562-b3fc-2c963f66afa6'
facilityName:
type: string
nullable: true
example: 'Tomah VA Medical Center'
totalCostRequested:
type: float
nullable: true
example: 4.52
reimbursementAmount:
type: float
nullable: true
example: 0
createdOn:
type: string
nullable: false
example: '2023-02-24T22:22:52.549Z'
modifiedOn:
type: string
nullable: false
example: '2023-02-26T22:22:52.549Z'
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/TravelPayClaims.yml
|
type: object
additionalProperties: false
required:
- meta
- data
properties:
meta:
type: object
required:
- totalRecordCount
- pageNumber
- status
properties:
totalRecordCount:
type: integer
description: Total number of claims found. Will be 0 if no claims exist within the specified date range.
minimum: 0
example: 25
pageNumber:
type: integer
example: 1
status:
type: integer
enum:
- 200
- 206
example: 200
data:
type: array
description: Array of travel pay claims. Will be empty if no claims are found within the specified date range.
minItems: 0
items:
$ref: './TravelPayClaimSummary.yml'
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/DecisionLetters.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: array
items:
type: object
additionalProperties: false
$ref: "./DecisionLetterRecord.yml"
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/EndpointDiscovery.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: object
additionalProperties: false
required:
- id
- type
- attributes
properties:
id:
type: string
example: "welcome"
type:
type: string
example: "welcome"
attributes:
type: object
additionalProperties: false
required:
- message
- endpoints
properties:
message:
type: string
example: "Welcome to the mobile API"
endpoints:
type: array
items:
type: string
example: "mobile/v0/appointments"
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/Phone.yml
|
type: object
additionalProperties: false
required:
- areaCode
- countryCode
- phoneNumber
- phoneType
- extension
properties:
id:
type: integer
example: 157032
areaCode:
type: string
example: "704"
countryCode:
type: string
example: "1"
phoneNumber:
type: string
example: "7749069"
phoneType:
type: string
enum: [ "HOME", "FAX", "MOBILE", "WORK" ]
example: "HOME"
extension:
type: string
example: "4567"
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/DiscoveryResponse.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: object
additionalProperties: false
required:
- id
- type
- attributes
properties:
id:
type: string
example: "1.0"
description: API Version number
type:
type: string
example: "discovery"
attributes:
type: object
additionalProperties: false
required:
- endpoints
- authBaseUrl
- apiRootUrl
- webviews
- appAccess
- displayMessage
properties:
endpoints:
type: object
additionalProperties: false
example:
appointments: {
url: "/v0/appointments",
method: "GET"
}
uploadClaimDocuments: {
url: "/claim/:id/documents",
method: "POST"
}
createUserPhone: {
url: '/user/phones',
method: 'POST'
}
updateUserPhone: {
url: '/user/phones',
method: 'PUT'
}
authBaseUrl:
type: string
example: "https://sqa.fed.eauth.va.gov/oauthe/sps/oauth/oauth20/"
apiRootUrl:
type: string
example: "https://staging-api.va.gov/mobile"
webviews:
type: object
additionalProperties:
type: string
example:
coronaFAQ: https://www.va.gov/coronavirus-veteran-frequently-asked-questions
facilityLocator: https://www.va.gov/find-locations/
appAccess:
type: boolean
displayMessage:
type: string
example: "Please update the app to continue"
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/PatientContact.yml
|
description: Patient contact information
type: object
additionalProperties: false
required:
- telecom
properties:
telecom:
type: array
items:
"$ref": ./ContactPoint.yml
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/PrescriptionTracking.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: array
items:
type: object
additionalProperties: false
$ref: "./PrescriptionTrackingRecord.yml"
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/TravelPayClaimDetails.yml
|
type: object
additionalProperties: false
required:
- id
- claimStatus
- appointmentDate
- createdOn
- modifiedOn
properties:
id:
type: string
nullable: false
example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
claimNumber:
type: string
nullable: true
example: 'TC0000000000001'
claimName:
type: string
nullable: true
example: 'Claim created for NOLLE BARAKAT'
claimantFirstName:
type: string
nullable: true
example: 'Nolle'
claimantMiddleName:
type: string
nullable: true
example: 'Polite'
claimantLastName:
type: string
nullable: true
example: 'Barakat'
claimStatus:
type: string
nullable: false
example: 'Pre approved for payment'
appointmentDate:
type: string
nullable: false
example: '2024-01-01T16:45:34.465Z'
facilityName:
type: string
nullable: true
example: 'Cheyenne VA Medical Center'
totalCostRequested:
type: number
nullable: true
example: 20.00
reimbursementAmount:
type: number
nullable: true
example: 14.52
rejectionReason:
type: object
nullable: true
description: 'Rejection reason description'
additionalProperties: false
properties:
rejectionReasonId:
type: string
example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
rejectionReasonName:
type: string
example: "INCOMPLETE_DOCUMENTATION"
rejectionReasonTitle:
type: string
example: "Incomplete Documentation"
rejectionReasonDescription:
type: string
example: "The claim was rejected due to missing required documentation"
decisionLetterReason:
type: string
nullable: true
description: 'Decision letter reason extracted from decision letter document for denied or partial payment claims'
example: "Mileage approved but parking not eligible per policy. Only travel expenses over 30 miles are reimbursable."
appointment:
type: object
nullable: false
description: 'Appointment details associated with the claim'
additionalProperties: false
properties:
id:
type: string
example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
appointmentSource:
type: string
example: "API"
appointmentDateTime:
type: string
example: "2024-01-01T16:45:34.465Z"
appointmentType:
type: string
example: "EnvironmentalHealth"
facilityId:
type: string
example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
facilityName:
type: string
example: "Cheyenne VA Medical Center"
serviceConnectedDisability:
type: integer
example: 30
appointmentStatus:
type: string
example: "Complete"
externalAppointmentId:
type: string
example: "12345"
associatedClaimId:
type: string
example: "uuid1"
associatedClaimNumber:
type: string
example: "TC0000000000001"
isCompleted:
type: boolean
example: true
expenses:
type: array
nullable: true
description: 'List of expenses associated with the claim'
items:
type: object
additionalProperties: false
properties:
id:
type: string
example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
expenseType:
type: string
example: "Mileage"
name:
type: string
example: ""
dateIncurred:
type: string
example: "2024-01-01T16:45:34.465Z"
description:
type: string
example: "mileage-expense"
costRequested:
type: number
example: 20.00
costSubmitted:
type: number
example: 20.00
documents:
type: array
nullable: true
description: 'List of documents associated with the claim'
items:
type: object
additionalProperties: false
properties:
documentId:
type: string
example: "uuid1"
filename:
type: string
example: "DecisionLetter.pdf"
mimetype:
type: string
example: "application/pdf"
createdon:
type: string
example: "2025-03-24T14:00:52.893Z"
createdOn:
type: string
nullable: false
example: '2025-03-12T20:27:14.088Z'
modifiedOn:
type: string
nullable: false
example: '2025-03-12T20:27:14.088Z'
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/PushPreferences.yml
|
type: object
additionalProperties: false
required:
- preference
- enabled
properties:
preference:
type: string
enum: [ "appointment_reminders", "secure_message_alerts" ]
example: "appointment_reminders"
enabled:
type: boolean
example: true
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/AppealEvidence.yml
|
type: object
properties:
description:
type: string
data:
type: string
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/Address.yml
|
type: object
additionalProperties: false
required:
- id
- addressLine1
- addressLine2
- addressLine3
- addressPou
- addressType
- city
- countryCode
- internationalPostalCode
- province
- stateCode
- zipCode
- zipCodeSuffix
properties:
id:
type: integer
example: 157032
addressLine1:
type: string
example: "1493 Martin Luther King Rd"
addressLine2:
type: string
nullable: true
addressLine3:
type: string
nullable: true
addressPou:
type: string
enum: [ "RESIDENCE/CHOICE", "CORRESPONDENCE" ]
example: "RESIDENCE/CHOICE"
addressType:
type: string
enum: [ "DOMESTIC", "INTERNATIONAL", "MILITARY" ]
example: "DOMESTIC"
city:
type: string
example: "Fulton"
countryCode:
type: string
example: "US"
internationalPostalCode:
type: string
nullable: true
example: null
province:
type: string
nullable: true
example: null
stateCode:
type: string
example: "NY"
zipCode:
type: string
example: "97062"
zipCodeSuffix:
type: string
nullable: true
example: "1234"
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/TasAddress.yml
|
type: object
properties:
streetAddress:
type: string
city:
type: string
state:
type: string
zipCode:
type: string
country:
type: string
latitutde:
description: Latitude of the site
type: number
format: double
longitude:
description: Longitude of the site
type: number
format: double
additionalDetails:
description: AdditionalDetails of the site
type: string
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/SecureMessageReplyRequest.yml
|
type: object
additionalProperties: false
required:
- recipient_id
- category
- subject
- body
properties:
recipient_id:
type: integer
description:
example: 1112233
category:
type: string
example: TEST
subject:
type: string
example: My Test Results
maxLength: 50
body:
type: string
example: Dear provider, please clarify my test results. Thank you.
draft_id:
type: integer
description: |
Specifies draft message ID to send. Draft message is deleted once sent. Note that body included with this post will overwrite any of original values of the draft.
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/TelehealthInfo.yml
|
description: Details about a telehealth (virtual) meeting.
type: object
properties:
url:
description: The meeting URL.
type: string
atlas:
"$ref": ./TasInfo.yml
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/AppointmentIdentifier.yml
|
required:
- system
- value
type: object
properties:
system:
type: string
value:
type: string
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/AvsPdf.yml
|
type: object
properties:
appt_id:
type: string
example: '12345'
nullable: true
id:
type: string
example: '15249638961'
nullable: true
name:
type: string
example: 'Ambulatory Visit Summary'
nullable: true
loinc_codes:
type: array
items:
type: string
example: '4189669'
nullable: true
note_type:
type: string
example: 'ambulatory_patient_summary'
nullable: true
content_type:
type: string
example: 'application/pdf'
nullable: true
binary:
type: string
example: 'JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC9TdWJ0e'
nullable: true
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/AppointmentStatus.yml
|
type: string
description: Required for VA and CC Requests. Documentation at https://hl7.org/fhir/R4/valueset-appointmentstatus.html
enum:
- proposed
- cancelled
- pending
- booked
- arrived
- noshow
- fulfilled
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/Locations.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: object
additionalProperties: false
required:
- type
- id
- attributes
properties:
type:
type: string
example: "location"
id:
type: string
example: "I2-3JYDMXC6RXTU4H25KRVXATSEJQ000000"
description: Upstream identifier. Same as id provided.
attributes:
type: object
additionalProperties: false
required:
- name
- address
properties:
name:
type: string
example: "COLUMBUS VAMC"
address:
type: object
additionalProperties: false
$ref: "./FacilityAddress.yml"
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/ClaimsAndAppeals.yml
|
type: object
properties:
id:
type: string
example: "600117255"
description: Claim or Appeal Id
type:
type: string
example: "claim"
enum:
- claim
- appeal
attributes:
type: object
additionalProperties: false
required:
- subtype
- completed
- dateFiled
- updatedAt
- displayTitle
- decisionLetterSent
- phase
- documentsNeeded
- developmentLetterSent
- claimTypeCode
properties:
subtype:
type: string
example: "Compensation"
description: Human readable string for claim or appeal subtype
completed:
type: boolean
dateFiled:
type: string
format: date
nullable: true
example: "2020-01-01"
updatedAt:
type: string
format: date
nullable: true
example: "2020-01-01"
displayTitle:
type: string
description: Formatted title for display in mobile overview list
example: "disability compensation appeal"
nullable: true
decisionLetterSent:
type: boolean
description: decision letter will be available from endpoint /v0/claims/decision-letters if true
example: "true"
phase:
type: integer
nullable: true
description: The phase of processing the claim is in. This does not apply to appeals. The integers used map to the phases as `1 => CLAIM_RECEIVED, 2 => UNDER_REVIEW, 3 => GATHERING_OF_EVIDENCE, 4 => REVIEW_OF_EVIDENCE, 5 => PREPARATION_FOR_DECISION, 6 => PENDING_DECISION_APPROVAL, 7 => PREPARATION_FOR_NOTIFICATION, 8 => COMPLETE`
example: 1
documentsNeeded:
type: boolean
nullable: true
description: Documents are still needed.
example: "true"
developmentLetterSent:
type: boolean
nullable: true
description: Development letter has been sent.
example: "true"
claimTypeCode:
type: string
description: Type of claim
nullable: true
example: "020NEW"
claimTypeBase:
type: string
description: Base type of claim
example: 'compensation claim'
nullable: true
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/Pensions.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: object
additionalProperties: false
required:
- type
- id
- attributes
properties:
type:
type: string
example: "pensions"
id:
type: string
example: "f26bc1f0-c389-4f3c-86e0-7712fb08fbe6"
description: Upstream veteran id field
attributes:
type: object
additionalProperties: false
required:
- isEligibleForPension
- isInReceiptOfPension
- netWorthLimit
properties:
isEligibleForPension:
type: boolean
example: true
isInReceiptOfPension:
type: boolean
example: true
netWorthLimit:
type: decimal
example: 129094
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/CreatePreneedBurial.yml
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "APPLICATION FOR PRE-NEED DETERMINATION OF ELIGIBILITY IN A VA NATIONAL CEMETERY",
"type": "object",
"additionalProperties": false,
"definitions": {
"address": {
"type": "object",
"oneOf": [
{
"properties": {
"country": {
"type": "string",
"enum": [
"CAN"
]
},
"state": {
"type": "string",
"enum": [
"AB",
"BC",
"MB",
"NB",
"NF",
"NT",
"NV",
"NU",
"ON",
"PE",
"QC",
"SK",
"YT"
],
"maxLength": 3
},
"postalCode": {
"type": "string",
"maxLength": 10
}
}
},
{
"properties": {
"country": {
"type": "string",
"enum": [
"MEX"
]
},
"state": {
"type": "string",
"enum": [
"aguascalientes",
"baja-california-norte",
"baja-california-sur",
"campeche",
"chiapas",
"chihuahua",
"coahuila",
"colima",
"distrito-federal",
"durango",
"guanajuato",
"guerrero",
"hidalgo",
"jalisco",
"mexico",
"michoacan",
"morelos",
"nayarit",
"nuevo-leon",
"oaxaca",
"puebla",
"queretaro",
"quintana-roo",
"san-luis-potosi",
"sinaloa",
"sonora",
"tabasco",
"tamaulipas",
"tlaxcala",
"veracruz",
"yucatan",
"zacatecas"
],
"maxLength": 3
},
"postalCode": {
"type": "string",
"maxLength": 10
}
}
},
{
"properties": {
"country": {
"type": "string",
"enum": [
"USA"
]
},
"state": {
"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"
],
"maxLength": 3
},
"postalCode": {
"type": "string",
"maxLength": 10
}
}
},
{
"properties": {
"country": {
"not": {
"type": "string",
"enum": [
"CAN",
"MEX",
"USA"
]
}
},
"state": {
"type": "string",
"maxLength": 3
},
"postalCode": {
"type": "string",
"maxLength": 10
}
}
}
],
"properties": {
"street": {
"type": "string",
"minLength": 1,
"maxLength": 20
},
"street2": {
"type": "string",
"minLength": 1,
"maxLength": 20
},
"city": {
"type": "string",
"minLength": 1,
"maxLength": 20
}
},
"required": [
"street",
"city",
"state",
"postalCode"
]
},
"dateRange": {
"type": "object",
"properties": {
"from": {
"$ref": "#/definitions/date"
},
"to": {
"$ref": "#/definitions/date"
}
}
},
"files": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"size": {
"type": "integer"
},
"confirmationCode": {
"type": "string"
}
}
}
},
"fullName": {
"type": "object",
"properties": {
"first": {
"type": "string",
"minLength": 1,
"maxLength": 15
},
"middle": {
"type": "string",
"maxLength": 15
},
"last": {
"type": "string",
"minLength": 1,
"maxLength": 25
},
"suffix": {
"type": "string",
"enum": [
"Jr.",
"Sr.",
"II",
"III",
"IV"
],
"maxLength": 3
}
},
"required": [
"first",
"last"
]
},
"phone": {
"type": "string",
"minLength": 10,
"maxLength": 20,
"pattern": "^(?:\\D*\\d){10,15}\\D*$"
},
"ssn": {
"type": "string",
"pattern": "^\\d{3}-\\d{2}-\\d{4}$"
},
"centralMailVaFile": {
"type": "string",
"pattern": "^\\d{8,9}$"
},
"date": {
"type": "string",
"format": "date"
},
"race": {
"type": "object",
"properties": {
"isAmericanIndianOrAlaskanNative": {
"type": "boolean"
},
"isAsian": {
"type": "boolean"
},
"isBlackOrAfricanAmerican": {
"type": "boolean"
},
"isSpanishHispanicLatino": {
"type": "boolean"
},
"notSpanishHispanicLatino": {
"type": "boolean"
},
"isNativeHawaiianOrOtherPacificIslander": {
"type": "boolean"
},
"isWhite": {
"type": "boolean"
}
}
}
},
"properties": {
"application": {
"type": "object",
"required": [
"applicant",
"claimant",
"hasCurrentlyBuried",
"veteran"
],
"properties": {
"applicant": {
"type": "object",
"required": [
"applicantRelationshipToClaimant",
"applicantEmail",
"applicantPhoneNumber",
"mailingAddress",
"name"
],
"properties": {
"applicantEmail": {
"type": "string",
"maxLength": 50,
"format": "email"
},
"applicantPhoneNumber": {
"$ref": "#/definitions/phone"
},
"applicantRelationshipToClaimant": {
"type": "string",
"enum": [
"Self",
"Authorized Agent/Rep"
]
},
"completingReason": {
"type": "string",
"maxLength": 256
},
"mailingAddress": {
"$ref": "#/definitions/address"
},
"name": {
"$ref": "#/definitions/fullName"
}
}
},
"claimant": {
"type": "object",
"required": [
"address",
"dateOfBirth",
"name",
"relationshipToVet",
"ssn"
],
"properties": {
"address": {
"$ref": "#/definitions/address"
},
"dateOfBirth": {
"$ref": "#/definitions/date"
},
"desiredCemetery": {
"type": "string",
"pattern": "^\\d{3}$"
},
"email": {
"type": "string",
"maxLength": 50,
"format": "email"
},
"name": {
"type": "object",
"properties": {
"first": {
"type": "string",
"minLength": 1,
"maxLength": 15
},
"middle": {
"type": "string",
"maxLength": 15
},
"last": {
"type": "string",
"minLength": 1,
"maxLength": 25
},
"suffix": {
"type": "string",
"enum": [
"Jr.",
"Sr.",
"II",
"III",
"IV"
],
"maxLength": 3
},
"maiden": {
"type": "string",
"maxLength": 15
}
},
"required": [
"first",
"last"
]
},
"phoneNumber": {
"$ref": "#/definitions/phone"
},
"relationshipToVet": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4"
]
},
"ssn": {
"$ref": "#/definitions/ssn"
}
}
},
"veteran": {
"type": "object",
"required": [
"currentName",
"gender",
"isDeceased",
"maritalStatus",
"serviceName",
"serviceRecords",
"ssn",
"militaryStatus"
],
"properties": {
"address": {
"$ref": "#/definitions/address"
},
"currentName": {
"type": "object",
"properties": {
"first": {
"type": "string",
"minLength": 1,
"maxLength": 15
},
"middle": {
"type": "string",
"maxLength": 15
},
"last": {
"type": "string",
"minLength": 1,
"maxLength": 25
},
"suffix": {
"type": "string",
"enum": [
"Jr.",
"Sr.",
"II",
"III",
"IV"
],
"maxLength": 3
},
"maiden": {
"type": "string",
"maxLength": 15
}
},
"required": [
"first",
"last"
]
},
"dateOfBirth": {
"$ref": "#/definitions/date"
},
"dateOfDeath": {
"$ref": "#/definitions/date"
},
"gender": {
"type": "string",
"enum": [
"Female",
"Male"
]
},
"race": {
"$ref": "#/definitions/race"
},
"isDeceased": {
"type": "string",
"enum": [
"yes",
"no",
"unsure"
]
},
"maritalStatus": {
"type": "string",
"enum": [
"Single",
"Separated",
"Married",
"Divorced",
"Widowed"
]
},
"militaryServiceNumber": {
"type": "string",
"maxLength": 9,
"pattern": "^[A-Za-z0-9]{4,9}$"
},
"militaryStatus": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"enum": [
"A",
"I",
"D",
"S",
"R",
"E",
"O",
"V",
"X"
]
},
"placeOfBirth": {
"type": "string",
"maxLength": 100
},
"serviceName": {
"$ref": "#/definitions/fullName"
},
"serviceRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"dateRange": {
"$ref": "#/definitions/dateRange"
},
"serviceBranch": {
"type": "string",
"enum": [
"AL",
"FS",
"FT",
"ES",
"CM",
"C3",
"C2",
"C4",
"C7",
"C5",
"GS",
"CI",
"FP",
"CS",
"CV",
"XG",
"CB",
"FF",
"GP",
"MO",
"NO",
"NN",
"NM",
"PA",
"PG",
"KC",
"PS",
"RO",
"CF",
"CE",
"AF",
"XF",
"AG",
"AR",
"AC",
"AA",
"AT",
"NG",
"XR",
"CO",
"CA",
"CC",
"GC",
"CG",
"XC",
"MC",
"MM",
"NA",
"XA",
"CD",
"PH",
"GU",
"WP",
"WA",
"WS",
"WR"
]
},
"dischargeType": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7"
]
},
"highestRank": {
"type": "string",
"maxLength": 20
},
"nationalGuardState": {
"type": "string",
"maxLength": 3,
"enum": [
"AL",
"AK",
"AZ",
"AR",
"CA",
"CO",
"CT",
"DE",
"DC",
"FL",
"GA",
"GU",
"HI",
"ID",
"IL",
"IN",
"IA",
"KS",
"KY",
"LA",
"ME",
"MD",
"MA",
"MI",
"MN",
"MS",
"MO",
"MT",
"NE",
"NV",
"NH",
"NJ",
"NM",
"NY",
"NC",
"ND",
"OH",
"OK",
"OR",
"PA",
"PR",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VT",
"VI",
"VA",
"WA",
"WV",
"WI",
"WY"
],
"enumNames": [
"Alabama",
"Alaska",
"Arizona",
"Arkansas",
"California",
"Colorado",
"Connecticut",
"Delaware",
"District Of Columbia",
"Florida",
"Georgia",
"Guam",
"Hawaii",
"Idaho",
"Illinois",
"Indiana",
"Iowa",
"Kansas",
"Kentucky",
"Louisiana",
"Maine",
"Maryland",
"Massachusetts",
"Michigan",
"Minnesota",
"Mississippi",
"Missouri",
"Montana",
"Nebraska",
"Nevada",
"New Hampshire",
"New Jersey",
"New Mexico",
"New York",
"North Carolina",
"North Dakota",
"Ohio",
"Oklahoma",
"Oregon",
"Pennsylvania",
"Puerto Rico",
"Rhode Island",
"South Carolina",
"South Dakota",
"Tennessee",
"Texas",
"Utah",
"Vermont",
"Virgin Islands",
"Virginia",
"Washington",
"West Virginia",
"Wisconsin",
"Wyoming"
]
}
},
"required": [
"serviceBranch"
]
},
"minItems": 1
},
"ssn": {
"$ref": "#/definitions/ssn"
},
"vaClaimNumber": {
"$ref": "#/definitions/centralMailVaFile"
}
}
},
"hasCurrentlyBuried": {
"type": "string",
"enum": [
"1",
"2",
"3"
]
},
"currentlyBuriedPersons": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"$ref": "#/definitions/fullName"
},
"cemeteryNumber": {
"type": "string",
"pattern": "^\\d{3}$"
}
}
}
},
"preneedAttachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 50
},
"size": {
"type": "integer"
},
"confirmationCode": {
"type": "string"
},
"attachmentId": {
"type": "string",
"enum": [
"1",
"2",
"3",
"5",
"6"
],
"enumNames": [
"Discharge",
"Marriage related",
"Dependent related",
"Letter",
"Other"
]
}
},
"required": [
"attachmentId",
"confirmationCode",
"name"
]
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/Letter.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: object
additionalProperties: false
required:
- type
- id
- attributes
properties:
type:
type: string
example: letter
id:
type: string
example: abe3f152-90b0-45cb-8776-4958bad0e0ef
attributes:
type: object
additionalProperties: false
required:
- letter
properties:
letter:
type: object
additionalProperties: false
required:
- letterDescription
- letterContent
properties:
letterDescription:
type: string
example: This card verifies that you served honorably in the Armed Forces.
letterContent:
type: array
items:
type: object
additionalProperties: false
required:
- contentKey
- contentTitle
- content
properties:
contentKey:
type: string
example: front-of-card
contentTitle:
type: string
example: <front of card>
content:
type: string
example: This card is to serve as proof the individual listed below served honorably in the Uniformed Services of the United States.
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/AppointmentKind.yml
|
type: string
enum:
- clinic
- cc
- telehealth
- phone
description: |
The kind of appointment:
* clinic - A clinic (in-person) appointment
* cc - A community-care appointment
* telehealth - A virtual appointment
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/SecureMessageThreadList.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: array
items:
$ref: './SecureMessageThread.yml'
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/DiscoveryRequest.yml
|
type: object
additionalProperties: false
required:
- environment
- buildNumber
- os
properties:
environment:
type: string
enum:
- dev
- staging
- prod
buildNumber:
type: string
example: "10"
os:
type: string
enum:
- android
- ios
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/MedicalCopay.yml
|
type: object
additionalProperties: false
required:
- data
- status
properties:
status:
type: integer
example: 200
data:
type: object
required:
- id
- station
- details
properties:
id:
type: string
example: '3fa85f64-5717-4562-b3fc-2c963f66afa6'
pSSeqNum:
type: integer
example: 0
pSTotSeqNum:
type: integer
example: 0
pSFacilityNum:
type: string
pSFacPhoneNum:
type: string
pSTotStatement:
type: integer
example: 0
pSStatementVal:
type: string
pSStatementDate:
type: string
pSStatementDateOutput:
type: string
pSProcessDate:
type: string
pSProcessDateOutput:
type: string
pHPatientLstNme:
type: string
pHPatientFstNme:
type: string
pHPatientMidNme:
type: string
pHAddress1:
type: string
pHAddress2:
type: string
pHAddress3:
type: string
pHCity:
type: string
pHState:
type: string
pHZipCde:
type: string
pHZipCdeOutput:
type: string
pHCtryNme:
type: string
pHAmtDue:
type: integer
example: 0
pHAmtDueOutput:
type: string
pHPrevBal:
type: integer
example: 0
pHPrevBalOutput:
type: string
pHTotCharges:
type: integer
example: 0
pHTotChargesOutput:
type: string
pHTotCredits:
type: integer
example: 0
pHTotCreditsOutput:
type: string
pHNewBalance:
type: integer
example: 0
pHNewBalanceOutput:
type: string
pHSpecialNotes:
type: string
pHROParaCdes:
type: string
pHNumOfLines:
type: integer
example: 0
pHDfnNumber:
type: integer
example: 0
pHCernerStatementNumber:
type: integer
example: 0
pHCernerPatientId:
type: string
pHCernerAccountNumber:
type: string
pHIcnNumber:
type: string
pHAccountNumber:
type: integer
example: 0
pHLargeFontIndcator:
type: integer
example: 0
station:
type: object
description: Facility information
properties:
facilitYNum:
type: string
visNNum:
type: string
facilitYDesc:
type: string
cyclENum:
type: string
remiTToFlag:
type: string
maiLInsertFlag:
type: string
staTAddress1:
type: string
staTAddress2:
type: string
staTAddress3:
type: string
city:
type: string
state:
type: string
ziPCde:
type: string
ziPCdeOutput:
type: string
baRCde:
type: string
teLNumFlag:
type: string
teLNum:
type: string
teLNum2:
type: string
contacTInfo:
type: string
dM2TelNum:
type: string
contacTInfo2:
type: string
toPTelNum:
type: string
lbXFedexAddress1:
type: string
lbXFedexAddress2:
type: string
lbXFedexAddress3:
type: string
lbXFedexCity:
type: string
lbXFedexState:
type: string
lbXFedexZipCde:
type: string
lbXFedexBarCde:
type: string
lbXFedexContact:
type: string
lbXFedexContactTelNum:
type: string
details:
type: array
description: A collection of transactions for a specific medical copay balance
items:
type: object
additionalProperties: false
properties:
pDDatePosted:
type: string
pDDatePostedOutput:
type: string
pDTransDesc:
type: string
pDTransDescOutput:
type: string
pDTransAmt:
type: integer
example: 0
pDTransAmtOutput:
type: string
pDRefNo:
type: string
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/EmailTransaction.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: object
additionalProperties: false
required:
- id
- string
properties:
id:
type: string
example: "3be0c7de-bfe1-4101-a326-5567bcd98b63"
description: Upstream identifier
type:
type: string
example: "asyncTransactionVet360EmailTransactions"
attributes:
type: object
additionalProperties: false
required:
- transactionId
- transactionStatus
- type
properties:
transactionId:
type: string
example: "3be0c7de-bfe1-4101-a326-5567bcd98b63"
transactionStatus:
type: string
enum:
- "REJECTED"
- "COMPLETED_SUCCESS"
- "COMPLETED_NO_CHANGES_DETECTED"
- "COMPLETED_FAILURE"
example: "COMPLETED_SUCCESS"
type:
type: string
example: "AsyncTransaction::VAProfile::EmailTransaction"
metadata:
type: array
example: [ ]
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/SecureMessagingAllRecipients.yml
|
type: object
required:
- data
- meta
properties:
data:
type: array
items:
type: object
required:
- id
- type
- attributes
properties:
id:
type: string
example: 855912
type:
type: string
example: "all_triage_teams"
attributes:
type: object
required:
- triageTeamId
- name
- stationNumber
- preferredTeam
- relationType
- locationName
- suggestedNameDisplay
- healthCareSystemName
- ohTriageGroup
properties:
triageTeamId:
type: integer
example: 855912
name:
type: string
example: RADIOLOGY_TRIAGE_GROUP_1
stationNumber:
type: string
example: 989
relationType:
type: string
enum: [PATIENT]
example: PATIENT
locationName:
type: string
example: "Main Hospital"
suggestedNameDisplay:
type: string
example: "Radiology Triage Group 1"
healthCareSystemName:
type: string
example: "VA Health Care System"
ohTriageGroup:
type: boolean
example: true
meta:
type: object
required:
- sort
- careSystems
properties:
sort:
type: object
required:
- name
properties:
name:
type: string
enum: [ASC, DESC]
example: ASC
associatedTriageGroups:
type: integer
example: 38
associatedBlockedTriageGroups:
type: integer
example: 1
friendlyTriageTeamPilotFacilities:
type: string
example: "979,989"
careSystems:
type: array
items:
type: object
required:
- stationNumber
- healthCareSystemName
properties:
stationNumber:
type: string
example: "979"
healthCareSystemName:
type: string
example: "VAMC Columbus"
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/Debts.yml
|
type: object
additionalProperties: false
required:
- data
- meta
properties:
data:
type: array
items:
required:
- type
- id
- attributes
properties:
id:
type: string
example: 'fe1776a8-3908-4efe-8e20-8dd31440ccb9'
description: User UUID
type:
type: string
example: 'debts'
attributes:
type: object
additionalProperties: false
required:
- fileNumber
- payeeNumber
- personEntitled
- deductionCode
- benefitType
- diaryCode
- diaryCodeDescription
- amountOverpaid
- amountWithheld
- originalAr
- currentAr
- debtHistory
- fiscalTransactionData
properties:
fileNumber:
type: string
example: '796043735'
payeeNumber:
type: string
example: '00'
personEntitled:
type: string
example: null
deductionCode:
type: string
example: '30'
benefitType:
type: string
example: 'Comp & Pen'
diaryCode:
type: string
example: '914'
diaryCodeDescription:
type: string
example: 'Paid In Full'
amountOverpaid:
type: float
example: 123.34
amountWithheld:
type: float
example: 50.0
originalAr:
type: float
example: 1177.0
currentAr:
type: float
example: 123.34
debtHistory:
type: array
items:
type: object
additionalProperties: false
properties:
date:
type: string
example: '09/12/1998'
letterCode:
type: string
example: '123'
description:
type: string
example: 'Third Demand Letter - Potential Treasury Referral'
fiscalTransactionData:
type: array
items:
type: object
additionalProperties: false
properties:
debtId:
type: integer
debtIncreaseAmount:
type: float
hinesCode:
type: string
offsetAmount:
type: float
offsetType:
type: string
paymentType:
type: string
transactionAdminAmount:
type: float
transactionCourtAmount:
type: float
transactionDate:
type: string
transactionDescription:
type: string
transactionExplanation:
type: string
transactionFiscalCode:
type: string
transactionFiscalSource:
type: string
transactionFiscalYear:
type: string
transactionInterestAmount:
type: float
transactionMarshallAmount:
type: float
transactionPrincipalAmount:
type: float
transactionTotalAmount:
type: float
meta:
type: object
additionalProperties: false
required:
- hasDependentDebts
properties:
hasDependentDebts:
type: boolean
example: false
|
0
|
code_files/vets-api-private/modules/mobile/docs
|
code_files/vets-api-private/modules/mobile/docs/schemas/Dependents.yml
|
type: object
additionalProperties: false
required:
- data
properties:
data:
type: array
items:
type: object
additionalProperties: false
required:
- type
- id
- attributes
properties:
type:
type: string
example: dependent
id:
type: string
example: "23fe358d-6e82-4541-804c-ce7562ba28f4"
description: Randomly generated UUID
attributes:
type: object
additionalProperties: false
required:
- awardIndicator
- dateOfBirth
- emailAddress
- firstName
- lastName
- middleName
- proofOfDependency
- ptcpntId
- relatedToVet
- relationship
- veteranIndicator
properties:
awardIndicator:
type: string
example: 'N'
nullable: true
dateOfBirth:
type: string
example: '01/02/1960'
nullable: true
emailAddress:
type: string
example: 'emailAddress'
nullable: true
firstName:
type: string
example: 'JANE'
nullable: true
lastName:
type: string
example: 'WEBB'
nullable: true
middleName:
type: string
example: 'M'
nullable: true
proofOfDependency:
type: string
example: 'N'
nullable: true
ptcpntId:
type: string
example: '600280661'
nullable: true
relatedToVet:
type: string
example: 'Y'
nullable: true
relationship:
type: string
example: 'Spouse'
nullable: true
veteranIndicator:
type: string
example: 'N'
nullable: true
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.