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:
- refi... |
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 prov... |
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
... |
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:
... |
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:
... |
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
... |
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:
ty... |
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
cl... |
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
exampl... |
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-... |
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:
... |
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
additionalPr... |
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 sh... |
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 whe... |
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": ./AppointmentK... |
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-80... |
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:
... |
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: "ab... |
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:
pagina... |
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:
... |
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
pr... |
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
... |
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 i... |
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 <... |
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-80... |
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
t... |
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
add... |
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 detai... |
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... |
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 o... |
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
- atta... |
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: "2... |
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
add... |
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
prope... |
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-2c963f6... |
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
additiona... |
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
- h... |
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
documentT... |
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:
... |
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: "... |
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... |
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
... |
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
additionalPrope... |
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,
"maxLen... |
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.... |
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
... |
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: strin... |
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
requ... |
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: "Gender... |
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 gen... |
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:
... |
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
ccRequestedCancellati... |
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: "./ClaimsAndAppealsO... |
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
... |
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... |
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
... |
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:
confidenceSc... |
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: "62... |
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:
... |
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: 'TC0000... |
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 th... |
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"
... |
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... |
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... |
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'
claimN... |
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... |
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: numbe... |
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:
... |
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... |
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-3JYDM... |
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
- dateFil... |
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... |
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": {
... |
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... |
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'
p... |
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
t... |
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_t... |
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
... |
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:... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.