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/spec/support/schemas/my_health/messaging
|
code_files/vets-api-private/spec/support/schemas/my_health/messaging/v1/message_with_attachment.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data", "included"],
"properties": {
"data": {
"type": "object",
"required": ["id", "type", "attributes", "relationships", "links"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["messages", "message_drafts"] },
"attributes": {
"type": "object",
"required": [
"message_id",
"category",
"subject",
"body",
"attachment",
"sent_date",
"sender_id",
"sender_name",
"recipient_id",
"recipient_name",
"read_receipt",
"suggested_name_display",
"is_oh_message"
],
"properties": {
"message_id": { "type": "integer" },
"category": { "type": "string" },
"subject": { "type": "string" },
"body": { "type": ["null", "string"] },
"attachment": { "type": "boolean" },
"sent_date": { "type": "date-time" },
"sender_id": { "type": "integer" },
"sender_name": { "type": "string" },
"recipient_id": { "type": "integer" },
"recipient_name": { "type": "string" },
"read_receipt": { "type": ["null", "string"] },
"triage_group_name": { "type": ["null", "string"] },
"proxy_sender_name": { "type": ["null", "string"] },
"suggested_name_display": { "type": ["null", "string"]},
"is_oh_message": { "type": "boolean" }
}
},
"relationships": {
"type": "object",
"required": ["attachments"],
"properties": {
"attachments": {
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"required": ["id", "type"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["attachments"] }
}
}
}
}
}
}
},
"links": {
"type": "object",
"required": ["self"],
"properties": {
"self": { "type": "string" }
}
}
}
},
"included": {
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"required": ["id", "type", "attributes", "links"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["attachments"] },
"attributes": {
"type": "object",
"required": ["message_id", "name", "attachment_size"],
"properties": {
"message_id": { "type": "integer" },
"name": { "type": "string" },
"attachment_size": { "type": "integer" }
}
},
"links": {
"type": "object",
"required": ["download"],
"properties": {
"download": { "type": "string" }
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/my_health/messaging
|
code_files/vets-api-private/spec/support/schemas/my_health/messaging/v1/all_triage_teams.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data", "meta"],
"properties": {
"data": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "object",
"required": ["id", "type", "attributes"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["all_triage_teams"] },
"attributes": {
"type": "object",
"$ref": "all_triage_team.json"
}
}
}
},
"meta": {
"type": "object",
"required": ["sort"],
"properties": {
"associated_triage_groups": {
"type": "integer"
},
"friendly_triage_team_pilot_facilities": {
"type": "string"
},
"associated_blocked_triage_groups": {
"type": "integer"
},
"sort": {
"type": "object"
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/my_health/messaging
|
code_files/vets-api-private/spec/support/schemas/my_health/messaging/v1/triage_team.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"triage_team_id",
"name",
"relation_type",
"preferred_team"
],
"properties": {
"triage_team_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"relation_type": {
"type": "string"
},
"preferred_team": {
"type": "boolean"
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/my_health/messaging
|
code_files/vets-api-private/spec/support/schemas/my_health/messaging/v1/folder_search.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"required": ["id", "type", "attributes", "links"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["messages"] },
"attributes": {
"type": "object",
"required": [
"message_id",
"category",
"subject",
"body",
"attachment",
"sent_date",
"sender_id",
"sender_name",
"recipient_id",
"recipient_name",
"read_receipt",
"suggested_name_display",
"is_oh_message"
],
"properties": {
"message_id": { "type": "integer" },
"category": { "type": "string" },
"subject": { "type": "string" },
"body": { "type": ["null", "string"] },
"attachment": { "type": "boolean" },
"sent_date": { "type": "date-time" },
"sender_id": { "type": "integer" },
"sender_name": { "type": "string" },
"recipient_id": { "type": "integer" },
"recipient_name": { "type": "string" },
"read_receipt": { "type": ["null", "string"] },
"triage_group_name": { "type": ["null", "string"] },
"proxy_sender_name": { "type": ["null", "string"] },
"suggested_name_display": { "type": ["null", "string"] },
"is_oh_message": { "type": "boolean" }
}
},
"links": {
"type": "object",
"required": ["self"],
"properties": {
"self": { "type": "string" }
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/my_health/messaging
|
code_files/vets-api-private/spec/support/schemas/my_health/messaging/v1/message.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"required": ["id", "type", "attributes", "relationships", "links"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["messages", "message_drafts"] },
"attributes": {
"type": "object",
"required": [
"message_id",
"category",
"subject",
"body",
"attachment",
"sent_date",
"sender_id",
"sender_name",
"recipient_id",
"recipient_name",
"read_receipt",
"suggested_name_display",
"is_oh_message"
],
"properties": {
"message_id": { "type": "integer" },
"category": { "type": "string" },
"subject": { "type": "string" },
"body": { "type": ["null", "string"] },
"attachment": { "type": "boolean" },
"sent_date": { "type": "date-time" },
"sender_id": { "type": "integer" },
"sender_name": { "type": "string" },
"recipient_id": { "type": "integer" },
"recipient_name": { "type": "string" },
"read_receipt": { "type": ["null", "string"] },
"triage_group_name": { "type": ["null", "string"] },
"proxy_sender_name": { "type": ["null", "string"] },
"suggested_name_display": { "type": ["null", "string"] },
"is_oh_message": { "type": "boolean" }
}
},
"relationships": {
"type": "object",
"required": ["attachments"],
"properties": {
"attachments": {
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"required": ["id", "type"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["attachments"] }
}
}
}
}
}
}
},
"links": {
"type": "object",
"required": ["self"],
"properties": {
"self": { "type": "string" }
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/my_health/prescriptions
|
code_files/vets-api-private/spec/support/schemas/my_health/prescriptions/v1/prescription_list_filtered_with_pagination.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data", "meta"],
"properties": {
"data": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "prescription_details.json"
}
},
"meta": {
"type": "object",
"required": ["updated_at", "failed_station_list", "sort", "recently_requested"],
"properties": {
"updated_at": { "type": "string" },
"failed_station_list": { "type": "string" },
"filter": {
"type": "object"
},
"sort": {
"type": "object"
},
"pagination": {
"type": "object",
"required": ["current_page", "per_page", "total_pages", "total_entries"],
"properties": {
"current_page": { "type": "integer" },
"per_page": { "type": "integer" },
"total_pages": { "type": "integer" },
"total_entries": { "type": "integer" }
}
},
"filter_count": {
"type": "object",
"properties": {
"active": { "type":"integer"},
"all_medications": { "type":"integer"},
"recently_requested": { "type":"integer"},
"non_active": { "type":"integer"},
"renewal": { "type":"integer"}
}
},
"recently_requested": {
"type": "array",
"items": { "type": "object" }
}
}
},
"links": {
"type": "object",
"required": ["self", "first", "prev", "next", "last"],
"properties": {
"self": { "type": "string" },
"first": { "type": "string" },
"prev": { "type": ["string", "null"] },
"next": { "type": ["string", "null"] },
"last": { "type": "string" }
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/my_health/prescriptions
|
code_files/vets-api-private/spec/support/schemas/my_health/prescriptions/v1/prescription_details.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["id", "type", "attributes", "links"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["prescription_details"] },
"attributes": {
"type": "object",
"required": [
"prescription_id",
"prescription_number",
"prescription_name",
"refill_status",
"refill_submit_date",
"refill_date",
"refill_remaining",
"facility_name",
"ordered_date",
"quantity",
"expiration_date",
"dispensed_date",
"station_number",
"is_refillable",
"is_trackable",
"sig",
"cmop_division_phone",
"in_cerner_transition",
"not_refillable_display_message",
"cmop_ndc_number",
"user_id",
"provider_first_name",
"provider_last_name",
"remarks",
"division_name",
"modified_date",
"institution_id",
"dial_cmop_division_phone",
"pharmacy_phone_number",
"disp_status",
"ndc",
"reason",
"prescription_number_index",
"prescription_source",
"disclaimer",
"indication_for_use",
"indication_for_use_flag",
"category",
"tracking_list",
"rx_rf_records",
"tracking",
"orderable_item",
"sorted_dispensed_date",
"prescription_image",
"color",
"shape",
"back_imprint",
"front_imprint"
],
"properties": {
"prescription_id": { "type": ["integer", "null"] },
"prescription_number": { "type": ["string", "null"] },
"prescription_name": { "type": ["string", "null"] },
"refill_status": { "type": ["string", "null"]},
"refill_submit_date": { "type": ["string", "null"], "format": "date" },
"refill_date": { "type": ["string", "null"], "format": "date" },
"refill_remaining": { "type": ["integer", "null"] },
"facility_name": { "type": ["string", "null"] },
"ordered_date": { "type": "string", "format": "date" },
"quantity": { "type": ["string", "null"] },
"expiration_date": { "type": ["string", "null"], "format": "date" },
"dispensed_date": { "type": ["string", "null"], "format": "date" },
"station_number": { "type": ["string", "null"] },
"is_refillable": { "type": ["boolean", "null"] },
"is_trackable": { "type": ["boolean", "null"] },
"sig": { "type": ["string", "null"] },
"cmop_division_phone": { "type": ["string", "null"] },
"in_cerner_transition": { "type": ["boolean", "null"] },
"not_refillable_display_message": { "type": ["string", "null"] },
"cmop_ndc_number": { "type": ["string", "null"] },
"user_id": { "type": ["integer", "null"] },
"provider_first_name": { "type": ["string", "null"] },
"provider_last_name": { "type": ["string", "null"]},
"remarks": { "type": ["string", "null"] },
"division_name": { "type": ["string", "null"] },
"modified_date": { "type": ["string", "null"], "format": "date" },
"institution_id": { "type": ["string", "null"] },
"dial_cmop_division_phone": { "type": ["string", "null"] },
"pharmacy_phone_number": { "type": ["string", "null"] },
"disp_status": { "type": ["string", "null"] },
"ndc": { "type": ["string", "null"] },
"reason": { "type": ["string", "null"] },
"prescription_number_index": { "type": ["string", "null"] },
"prescription_source": { "type": ["string", "null"] },
"disclaimer": { "type": ["string", "null"] },
"indication_for_use": { "type": ["string", "null"] },
"indication_for_use_flag": { "type": ["string", "null"] },
"category": { "type": ["string", "null"] },
"color": { "type": ["string", "null"] },
"shape": { "type": ["string", "null"] },
"back_imprint": { "type": ["string", "null"] },
"front_imprint": { "type": ["string", "null"] },
"tracking_list": {
"type": "array",
"items": {
"tracking": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "integer" },
"station_number": { "type": "string" },
"rx_number": { "type": "string" },
"carrier": { "type": "string" },
"tracking_number": { "type": "string" },
"complete_date_time": { "type": "string", "format": "date" },
"division_phone": { "type": "string" },
"ndc": { "type": "string" },
"date_loaded": { "type": "string", "format": "date" },
"is_local_tracking": { "type": "boolean" },
"others_in_same_package": { "type": "boolean" },
"view_image_displayed": { "type": "boolean" }
}
}
}
}
},
"rx_rf_records": {
"type": "array",
"items": {
"rf_record": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prescription_id": { "type": "integer" },
"prescription_number": { "type": "string" },
"prescription_name": { "type": "string" },
"refill_status": { "type": "string" },
"refill_submit_date": { "type": ["string", "null"], "format": "date" },
"refill_date": { "type": "string", "format": "date" },
"refill_remaining": { "type": "integer" },
"facility_name": { "type": "string" },
"ordered_date": { "type": "string", "format": "date" },
"quantity": { "type": "string" },
"expiration_date": { "type": "string", "format": "date" },
"dispensed_date": { "type": ["string", "null"], "format": "date" },
"station_number": { "type": "string" },
"is_refillable": { "type": "boolean" },
"is_trackable": { "type": "boolean" },
"in_cerner_transition": { "type": "boolean" },
"not_refillable_display_message": { "type": "string" },
"cmop_ndc_number": { "type": ["string", "null"] },
"user_id": { "type": "integer" },
"provider_first_name": { "type": "string" },
"provider_last_name": { "type": "string" },
"remarks": { "type": "string" },
"division_name": { "type": "string" },
"modified_date": { "type": ["string", "null"], "format": "date" },
"institution_id": { "type": ["string", "null"] },
"dial_cmop_division_phone": { "type": "string" },
"disp_status": { "type": "string" },
"ndc": { "type": "string" },
"reason": { "type": "string" },
"prescription_number_index": { "type": "string" },
"prescription_source": { "type": "string" },
"disclaimer": { "type": "string" },
"indication_for_use": { "type": "string" },
"indication_for_use_flag": { "type": "string" },
"category": { "type": "string" },
"tracking": { "type": "boolean" }
}
}
}
}
},
"tracking": { "type": ["boolean", "null"] },
"orderable_item": { "type": ["string", "null"] },
"sorted_dispensed_date": { "type": ["string", "null"], "format": "date" },
"prescription_image": { "type": ["string", "null"] },
"grouped_medications": {
"type": ["array", "null"],
"properties": {
"properties": {
"prescription_id": { "type": ["integer", "null"] },
"prescription_number": { "type": ["string", "null"] },
"prescription_name": { "type": ["string", "null"] },
"refill_status": { "type": ["string", "null"]},
"refill_submit_date": { "type": ["string", "null"], "format": "date" },
"refill_date": { "type": ["string", "null"], "format": "date" },
"refill_remaining": { "type": ["integer", "null"] },
"facility_name": { "type": ["string", "null"] },
"ordered_date": { "type": "string", "format": "date" },
"quantity": { "type": ["string", "null"] },
"expiration_date": { "type": ["string", "null"], "format": "date" },
"dispensed_date": { "type": ["string", "null"], "format": "date" },
"station_number": { "type": ["string", "null"] },
"is_refillable": { "type": ["boolean", "null"] },
"is_trackable": { "type": ["boolean", "null"] },
"sig": { "type": ["string", "null"] },
"cmop_division_phone": { "type": ["string", "null"] },
"in_cerner_transition": { "type": ["boolean", "null"] },
"not_refillable_display_message": { "type": ["string", "null"] },
"cmop_ndc_number": { "type": ["string", "null"] },
"user_id": { "type": ["integer", "null"] },
"provider_first_name": { "type": ["string", "null"] },
"provider_last_name": { "type": ["string", "null"]},
"remarks": { "type": ["string", "null"] },
"division_name": { "type": ["string", "null"] },
"modified_date": { "type": ["string", "null"], "format": "date" },
"institution_id": { "type": ["string", "null"] },
"dial_cmop_division_phone": { "type": ["string", "null"] },
"pharmacy_phone_number": { "type": ["string", "null"] },
"disp_status": { "type": ["string", "null"] },
"ndc": { "type": ["string", "null"] },
"reason": { "type": ["string", "null"] },
"prescription_number_index": { "type": ["string", "null"] },
"prescription_source": { "type": ["string", "null"] },
"disclaimer": { "type": ["string", "null"] },
"indication_for_use": { "type": ["string", "null"] },
"indication_for_use_flag": { "type": ["string", "null"] },
"category": { "type": ["string", "null"] },
"color": { "type": ["string", "null"] },
"shape": { "type": ["string", "null"] },
"back_imprint": { "type": ["string", "null"] },
"front_imprint": { "type": ["string", "null"] },
"tracking_list": {
"type": "array",
"items": {
"tracking": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "integer" },
"station_number": { "type": "string" },
"rx_number": { "type": "string" },
"carrier": { "type": "string" },
"tracking_number": { "type": "string" },
"complete_date_time": { "type": "string", "format": "date" },
"division_phone": { "type": "string" },
"ndc": { "type": "string" },
"date_loaded": { "type": "string", "format": "date" },
"is_local_tracking": { "type": "boolean" },
"others_in_same_package": { "type": "boolean" },
"view_image_displayed": { "type": "boolean" }
}
}
}
}
},
"rx_rf_records": {
"type": "array",
"items": {
"rf_record": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prescription_id": { "type": "integer" },
"prescription_number": { "type": "string" },
"prescription_name": { "type": "string" },
"refill_status": { "type": "string" },
"refill_submit_date": { "type": ["string", "null"], "format": "date" },
"refill_date": { "type": "string", "format": "date" },
"refill_remaining": { "type": "integer" },
"facility_name": { "type": "string" },
"ordered_date": { "type": "string", "format": "date" },
"quantity": { "type": "string" },
"expiration_date": { "type": "string", "format": "date" },
"dispensed_date": { "type": ["string", "null"], "format": "date" },
"station_number": { "type": "string" },
"is_refillable": { "type": "boolean" },
"is_trackable": { "type": "boolean" },
"in_cerner_transition": { "type": "boolean" },
"not_refillable_display_message": { "type": "string" },
"cmop_ndc_number": { "type": ["string", "null"] },
"user_id": { "type": "integer" },
"provider_first_name": { "type": "string" },
"provider_last_name": { "type": "string" },
"remarks": { "type": "string" },
"division_name": { "type": "string" },
"modified_date": { "type": ["string", "null"], "format": "date" },
"institution_id": { "type": ["string", "null"] },
"dial_cmop_division_phone": { "type": "string" },
"disp_status": { "type": "string" },
"ndc": { "type": "string" },
"reason": { "type": "string" },
"prescription_number_index": { "type": "string" },
"prescription_source": { "type": "string" },
"disclaimer": { "type": "string" },
"indication_for_use": { "type": "string" },
"indication_for_use_flag": { "type": "string" },
"category": { "type": "string" },
"tracking": { "type": "boolean" }
}
}
}
}
},
"tracking": { "type": ["boolean", "null"] },
"orderable_item": { "type": ["string", "null"] },
"sorted_dispensed_date": { "type": ["string", "null"], "format": "date" },
"prescription_image": { "type": ["string", "null"] },
"grouped_medications": {
"type": "array",
"properties": {
"prescription_id": { "type": ["integer", "null"] },
"prescription_number": { "type": ["string", "null"] },
"prescription_name": { "type": ["string", "null"] },
"refill_status": { "type": ["string", "null"]},
"refill_submit_date": { "type": ["string", "null"], "format": "date" },
"refill_date": { "type": ["string", "null"], "format": "date" },
"refill_remaining": { "type": ["integer", "null"] },
"facility_name": { "type": ["string", "null"] },
"ordered_date": { "type": "string", "format": "date" },
"quantity": { "type": ["string", "null"] },
"expiration_date": { "type": ["string", "null"], "format": "date" },
"dispensed_date": { "type": ["string", "null"], "format": "date" },
"station_number": { "type": ["string", "null"] },
"is_refillable": { "type": ["boolean", "null"] },
"is_trackable": { "type": ["boolean", "null"] },
"sig": { "type": ["string", "null"] },
"cmop_division_phone": { "type": ["string", "null"] },
"in_cerner_transition": { "type": ["boolean", "null"] },
"not_refillable_display_message": { "type": ["string", "null"] },
"cmop_ndc_number": { "type": ["string", "null"] },
"user_id": { "type": ["integer", "null"] },
"provider_first_name": { "type": ["string", "null"] },
"provider_last_name": { "type": ["string", "null"]},
"remarks": { "type": ["string", "null"] },
"division_name": { "type": ["string", "null"] },
"modified_date": { "type": ["string", "null"], "format": "date" },
"institution_id": { "type": ["string", "null"] },
"dial_cmop_division_phone": { "type": ["string", "null"] },
"disp_status": { "type": ["string", "null"] },
"ndc": { "type": ["string", "null"] },
"reason": { "type": ["string", "null"] },
"prescription_number_index": { "type": ["string", "null"] },
"prescription_source": { "type": ["string", "null"] },
"disclaimer": { "type": ["string", "null"] },
"indication_for_use": { "type": ["string", "null"] },
"indication_for_use_flag": { "type": ["string", "null"] },
"category": { "type": ["string", "null"] },
"color": { "type": ["string", "null"] },
"shape": { "type": ["string", "null"] },
"back_imprint": { "type": ["string", "null"] },
"front_imprint": { "type": ["string", "null"] },
"tracking_list": {
"type": "array",
"items": {
"tracking": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "integer" },
"station_number": { "type": "string" },
"rx_number": { "type": "string" },
"carrier": { "type": "string" },
"tracking_number": { "type": "string" },
"complete_date_time": { "type": "string", "format": "date" },
"division_phone": { "type": "string" },
"ndc": { "type": "string" },
"date_loaded": { "type": "string", "format": "date" },
"is_local_tracking": { "type": "boolean" },
"others_in_same_package": { "type": "boolean" },
"view_image_displayed": { "type": "boolean" }
}
}
}
}
},
"rx_rf_records": {
"type": "array",
"items": {
"rf_record": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prescription_id": { "type": "integer" },
"prescription_number": { "type": "string" },
"prescription_name": { "type": "string" },
"refill_status": { "type": "string" },
"refill_submit_date": { "type": ["string", "null"], "format": "date" },
"refill_date": { "type": "string", "format": "date" },
"refill_remaining": { "type": "integer" },
"facility_name": { "type": "string" },
"ordered_date": { "type": "string", "format": "date" },
"quantity": { "type": "string" },
"expiration_date": { "type": "string", "format": "date" },
"dispensed_date": { "type": ["string", "null"], "format": "date" },
"station_number": { "type": "string" },
"is_refillable": { "type": "boolean" },
"is_trackable": { "type": "boolean" },
"in_cerner_transition": { "type": "boolean" },
"not_refillable_display_message": { "type": "string" },
"cmop_ndc_number": { "type": ["string", "null"] },
"user_id": { "type": "integer" },
"provider_first_name": { "type": "string" },
"provider_last_name": { "type": "string" },
"remarks": { "type": "string" },
"division_name": { "type": "string" },
"modified_date": { "type": ["string", "null"], "format": "date" },
"institution_id": { "type": ["string", "null"] },
"dial_cmop_division_phone": { "type": "string" },
"disp_status": { "type": "string" },
"ndc": { "type": "string" },
"reason": { "type": "string" },
"prescription_number_index": { "type": "string" },
"prescription_source": { "type": "string" },
"disclaimer": { "type": "string" },
"indication_for_use": { "type": "string" },
"indication_for_use_flag": { "type": "string" },
"category": { "type": "string" },
"tracking": { "type": "boolean" }
}
}
}
}
},
"tracking": { "type": ["boolean", "null"] },
"orderable_item": { "type": ["string", "null"] },
"sorted_dispensed_date": { "type": ["string", "null"], "format": "date" },
"prescription_image": { "type": ["string", "null"] },
"grouped_medications": {
"type": ["array", "null"],
"properties": {}
}
}
}
}
}
}
}
},
"links": {
"oneOf": [
{
"type": "object",
"required": ["self", "tracking"],
"properties": {
"self": { "type": "string" },
"tracking": { "type": "string" }
}
},
{
"type": "object",
"required": ["self"],
"properties": {
"self": { "type": "string" }
}
}
]
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/my_health/prescriptions
|
code_files/vets-api-private/spec/support/schemas/my_health/prescriptions/v1/prescriptions_list_paginated.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data", "meta"],
"properties": {
"data": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "prescription_details.json"
}
},
"links": {
"type": "object",
"required": ["self", "first", "prev", "next", "last"],
"properties": {
"self": { "type": "string" },
"first": { "type": "string" },
"prev": { "type": ["string", "null"] },
"next": { "type": ["string", "null"] },
"last": { "type": "string" }
}
},
"meta": {
"type": "object",
"required": ["updated_at", "failed_station_list", "sort", "pagination", "recently_requested"],
"properties": {
"updated_at": { "type": "string" },
"failed_station_list": { "type": "string" },
"sort": {
"type": "object"
},
"pagination": {
"type": "object",
"required": ["current_page", "per_page", "total_pages", "total_entries"],
"properties": {
"current_page": { "type": "integer" },
"per_page": { "type": "integer" },
"total_pages": { "type": "integer" },
"total_entries": { "type": "integer" }
}
},
"filter_count": {
"type": "object",
"properties": {
"active": { "type":"integer"},
"all_medications": { "type":"integer"},
"recently_requested": { "type":"integer"},
"non_active": { "type":"integer"},
"renewal": { "type":"integer"}
}
},
"recently_requested": {
"type": "array",
"items": { "type": "object" }
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/my_health/prescriptions
|
code_files/vets-api-private/spec/support/schemas/my_health/prescriptions/v1/prescription_list_filtered.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data", "meta"],
"properties": {
"data": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "prescription_details.json"
}
},
"meta": {
"type": "object",
"required": ["updated_at", "failed_station_list", "sort", "recently_requested"],
"properties": {
"updated_at": { "type": "string" },
"failed_station_list": { "type": "string" },
"sort": {
"type": "object"
},
"filter": {
"type": "object"
},
"filter_count": {
"type": "object",
"properties": {
"active": { "type":"integer"},
"all_medications": { "type":"integer"},
"recently_requested": { "type":"integer"},
"non_active": { "type":"integer"},
"renewal": { "type":"integer"}
}
},
"recently_requested": {
"type": "array",
"items": { "type": "object" }
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/my_health/prescriptions
|
code_files/vets-api-private/spec/support/schemas/my_health/prescriptions/v1/prescriptions_list.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data", "meta"],
"properties": {
"data": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "prescription_details.json"
}
},
"meta": {
"type": "object",
"required": ["updated_at", "failed_station_list", "sort", "recently_requested"],
"properties": {
"updated_at": { "type": "string" },
"failed_station_list": { "type": "string" },
"sort": {
"type": "object"
},
"filter_count": {
"type": "object",
"properties": {
"active": { "type":"integer"},
"all_medications": { "type":"integer"},
"recently_requested": { "type":"integer"},
"non_active": { "type":"integer"},
"renewal": { "type":"integer"}
}
},
"recently_requested": {
"type": "array",
"items": { "type": "object" }
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/my_health/prescriptions
|
code_files/vets-api-private/spec/support/schemas/my_health/prescriptions/v1/prescription_single.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data", "meta"],
"properties": {
"data": {
"$ref": "prescription_details.json"
},
"meta": {
"type": "object",
"required": ["updated_at", "failed_station_list"],
"properties": {
"updated_at": { },
"failed_station_list": { }
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/sob/entitlement.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["months", "days"],
"additionalProperties": false,
"properties": {
"months": { "type": "integer" },
"days": { "type": "integer" }
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/sob/ch33_status.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": [
"object",
"null"
],
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"first_name",
"last_name"
],
"properties": {
"first_name": {
"type": [
"string",
"null"
]
},
"last_name": {
"type": [
"string",
"null"
]
},
"date_of_birth": {
"type": [
"string",
"null"
]
},
"va_file_number": {
"type": [
"string",
"null"
]
},
"regional_processing_office": {
"type": [
"string",
"null"
]
},
"eligibility_date": {
"type": [
"string",
"null"
]
},
"delimiting_date": {
"type": [
"string",
"null"
]
},
"percentage_benefit": {
"type": [
"integer",
"null"
]
},
"original_entitlement": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "entitlement.json"
}
]
},
"used_entitlement": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "entitlement.json"
}
]
},
"remaining_entitlement": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "entitlement.json"
}
]
},
"entitlement_transferred_out": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "entitlement.json"
}
]
},
"veteran_is_eligible": {
"type": [
"boolean",
"null"
]
},
"active_duty": {
"type": [
"boolean",
"null"
]
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/preneeds/receive_applications.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"required": ["id", "type", "attributes"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["preneeds_receive_applications"] },
"attributes": {
"type": "object",
"required": [
"receive_application_id", "tracking_number", "return_code", "application_uuid", "return_description", "submitted_at"
],
"properties": {
"submitted_at": { "type": "string" },
"receive_application_id": { "type": "string" },
"tracking_number": { "type": "string" },
"return_code": { "type": "integer" },
"application_uuid": { "type": "string" },
"return_description": { "type": "return_description" }
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/preneeds/attachment_types.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type" : "object",
"required": ["data"],
"properties": {
"data" : {
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"required": ["id", "type", "attributes"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["preneeds_attachment_types"] },
"attributes": {
"type": "object",
"required": [
"attachment_type_id",
"description"
],
"properties": {
"attachment_type_id": { "type": "integer" },
"description": { "type": "string" }
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/preneeds/cemeteries.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type" : "object",
"required": ["data"],
"properties": {
"data" : {
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"required": ["id", "type", "attributes"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["preneeds_cemeteries"] },
"attributes": {
"type": "object",
"required": [
"cemetery_id",
"name",
"cemetery_type",
"num"
],
"properties": {
"cemetery_id": { "type": "string" },
"name": { "type": "string" },
"cemetery_type": { "type": "string" },
"num": { "type": "string" }
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/claims_api/claim.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string",
"description": "Claim ID from EVSS"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": false,
"required": [
"date_filed",
"max_est_date",
"open",
"waiver_submitted",
"documents_needed",
"development_letter_sent",
"status",
"requested_decision",
"claim_type",
"contention_list",
"va_representative",
"events_timeline",
"supporting_documents"
],
"properties": {
"evss_id": {
"type": "integer",
"nullable": true,
"description": "Upstream service identifier"
},
"date_filed": {
"type": "string",
"format": "date",
"description": "Date in YYYY-MM-DD the claim was first filed",
"example": "2018-06-04"
},
"min_est_date": {
"type": [
"string",
"null"
],
"format": "date",
"description": "Minimum Estimated Claim Completion Date",
"example": "2019-06-04"
},
"max_est_date": {
"type": [
"string",
"null"
],
"format": "date",
"description": "Maximum Estimated Claim Completion Date",
"example": "2019-09-04"
},
"open": {
"type": "boolean",
"description": "Has the claim been resolved"
},
"waiver_submitted": {
"type": "boolean",
"description": "Requested Decision or Waiver 5103 Submitted"
},
"documents_needed": {
"type": "boolean",
"description": "Does the claim require additional documents to be submitted"
},
"development_letter_sent": {
"type": "boolean",
"description": "Indicates if a Development Letter has been sent to the Claimant regarding a benefit claim"
},
"decision_letter_sent": {
"type": "boolean",
"description": "Indicates if a Decision Letter has been sent to the Claimant regarding a benefit claim"
},
"status": {
"type": "string",
"description": "Current status of the claim",
"enum": [
"pending",
"Claim received",
"Initial review",
"Evidence gathering, review, and decision",
"Preparation for notification",
"Complete"
]
},
"requested_decision": {
"type": "boolean",
"description": "The claim filer has requested a claim decision be made"
},
"claim_type": {
"type": "string",
"description": "The type of claim originally submitted"
},
"contention_list": {
"type": "array",
"items": {
"type": "string"
}
},
"va_representative": {
"type": "string",
"description": "Current VA Representative Organization"
},
"events_timeline": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"date"
],
"properties": {
"type": {
"type": "string",
"description": "Different types of event statuses"
},
"date": {
"type": "string",
"format": "date",
"description": "Date of Event"
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"tracked_item_id",
"file_type",
"document_type",
"filename",
"upload_date",
"type",
"date"
],
"properties": {
"tracked_item_id": {
"type": [
"string",
"null"
],
"description": "Tracked Item ID given by VBMS"
},
"file_type": {
"type": "string",
"description": "Type of File being submitted/requested"
},
"document_type": {
"type": "string",
"description": "Type of document submitted"
},
"filename": {
"type": "string",
"description": "Name of file submitted"
},
"upload_date": {
"type": "string",
"format": "date",
"description": "Date original upload of file occured"
},
"type": {
"type": "string",
"description": "Type of Tracked Item submitted"
},
"date": {
"type": "string",
"format": "date",
"description": "Date of Event"
}
}
}
]
}
},
"supporting_documents": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of document"
},
"type": {
"type": "string"
},
"md5": {
"type": "string",
"description": "Hashed representation of document"
},
"filename": {
"type": "string",
"description": "Name of document"
},
"uploaded_at": {
"type": "string",
"format": "date",
"description": "Date and time document was uploaded"
}
}
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/claims_api/claims.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"required": [
"id",
"type",
"attributes"
],
"additionalProperties": false,
"description": "Claim with some details for the given Veteran info",
"properties": {
"id": {
"type": "string",
"description": "Claim ID from EVSS",
"example": "8347210"
},
"type": {
"type": "string",
"example": "evss_claims"
},
"attributes": {
"type": "object",
"additionalProperties": false,
"required": [
"evss_id",
"date_filed",
"max_est_date",
"open",
"waiver_submitted",
"documents_needed",
"development_letter_sent",
"status",
"requested_decision",
"claim_type"
],
"properties": {
"evss_id": {
"type": "integer",
"description": "Upstream service identifier"
},
"date_filed": {
"type": "string",
"format": "date",
"description": "Date in YYYY-MM-DD the claim was first filed",
"example": "2018-06-04"
},
"min_est_date": {
"type": [
"string",
"null"
],
"format": "date",
"description": "Minimum Estimated Claim Completion Date",
"example": "2019-06-04"
},
"max_est_date": {
"type": [
"string",
"null"
],
"format": "date",
"description": "Maximum Estimated Claim Completion Date",
"example": "2019-09-04"
},
"open": {
"type": "boolean",
"description": "Has the claim been resolved",
"example": "true"
},
"waiver_submitted": {
"type": "boolean",
"description": "Requested Decision or Waiver 5103 Submitted",
"example": "false"
},
"documents_needed": {
"type": "boolean",
"description": "Does the claim require additional documents to be submitted",
"example": "false"
},
"development_letter_sent": {
"type": "boolean",
"description": "Indicates if a Development Letter has been sent to the Claimant regarding a benefit claim",
"example": "false"
},
"decision_letter_sent": {
"type": "boolean",
"description": "Indicates if a Decision Letter has been sent to the Claimant regarding a benefit claim",
"example": "false"
},
"status": {
"type": "string",
"description": "Current status of the claim",
"enum": [
"Claim received",
"Initial review",
"Evidence gathering, review, and decision",
"Preparation for notification",
"Complete"
],
"example": "Claim received"
},
"requested_decision": {
"type": "boolean",
"description": "The claim filer has requested a claim decision be made",
"example": "false"
},
"claim_type": {
"type": "string",
"description": "The type of claim originally submitted",
"example": "Compensation"
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/forms
|
code_files/vets-api-private/spec/support/schemas/claims_api/forms/intent_to_file/active.json
|
{
"required": ["data"],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": ["id", "type", "attributes"],
"properties": {
"id": {
"type": "string",
"description": "Intent to File ID from EVSS"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": false,
"required": ["expiration_date", "type", "status"],
"properties": {
"creation_date": {
"type": "string",
"nullable": true,
"format": "date",
"description": "Date the Intent to File was received at the VA"
},
"expiration_date": {
"type": "string",
"format": "date",
"description": "Date the ITF expires, this is 1 year from the created_date"
},
"type": {
"type": "string",
"description": "The type of ITF filed. Compensation, Pension, or Burial",
"enum": [
"compensation",
"burial",
"pension"
]
},
"status": {
"type": "string",
"description": "The status of the Intent to File",
"enum": [
"active",
"inactive"
]
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/forms
|
code_files/vets-api-private/spec/support/schemas/claims_api/forms/intent_to_file/validate.json
|
{
"required": ["data"],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": ["type", "attributes"],
"properties": {
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": false,
"required": ["status"],
"properties": {
"status": {
"type": "string",
"description": "The status of the Intent to File",
"enum": [
"valid"
]
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/forms
|
code_files/vets-api-private/spec/support/schemas/claims_api/forms/intent_to_file/submission.json
|
{
"required": ["data"],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": ["id", "type", "attributes"],
"properties": {
"id": {
"type": "string",
"description": "Intent to File ID from EVSS"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": false,
"required": ["creation_date", "expiration_date", "type", "status"],
"properties": {
"creation_date": {
"type": "string",
"format": "date",
"description": "Date the Intent to File was received at the VA"
},
"expiration_date": {
"type": "string",
"format": "date",
"description": "Date the ITF expires, this is 1 year from the created_date"
},
"type": {
"type": "string",
"description": "The type of ITF filed. Compensation, Pension, or Burial",
"enum": [
"compensation",
"burial",
"pension"
]
},
"status": {
"type": "string",
"description": "The status of the Intent to File",
"enum": [
"active",
"duplicate"
]
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/forms
|
code_files/vets-api-private/spec/support/schemas/claims_api/forms/power_of_attorney/get.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": ["id", "type", "attributes"],
"properties": {
"id": {
"type": "string",
"description": "Power of Attorney Submission UUID"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": false,
"required": ["status", "date_request_accepted", "representative"],
"properties": {
"status": {
"type": "string",
"description": "Says if the power of attorney is pending, submitted, updated or errored",
"enum": [
"pending",
"submitted",
"updated",
"errored"
]
},
"date_request_accepted": {
"type": "string",
"description": "Date request was first accepted",
"format": "date"
},
"representative": {
"type": "object",
"additionalProperties": false,
"required": ["service_organization"],
"properties": {
"service_organization": {
"type": "object",
"additionalProperties": true,
"required": ["poa_code"],
"properties": {
"poa_code": {
"type": "string",
"description": "Power of Attorney Code submitted for Veteran"
}
}
}
}
},
"previous_poa": {
"type": "string",
"nullable": true,
"description": "Current or Previous Power of Attorney Code submitted for Veteran"
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/forms
|
code_files/vets-api-private/spec/support/schemas/claims_api/forms/power_of_attorney/upload.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": ["id", "type", "attributes"],
"properties": {
"id": {
"type": "string",
"description": "Power of Attorney Submission UUID"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": false,
"required": ["status", "date_request_accepted", "representative"],
"properties": {
"status": {
"type": "string",
"description": "Says if the power of attorney is pending, submitted, updated or errored",
"enum": [
"pending",
"submitted",
"updated",
"errored"
]
},
"date_request_accepted": {
"type": "string",
"description": "Date request was first accepted",
"format": "date"
},
"representative": {
"type": "object",
"additionalProperties": false,
"required": ["service_organization"],
"properties": {
"service_organization": {
"type": "object",
"additionalProperties": true,
"required": ["poa_code"],
"properties": {
"poa_code": {
"type": "string",
"description": "Power of Attorney Code submitted for Veteran"
}
}
}
}
},
"previous_poa": {
"type": "string",
"nullable": true,
"description": "Current or Previous Power of Attorney Code submitted for Veteran"
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/forms
|
code_files/vets-api-private/spec/support/schemas/claims_api/forms/power_of_attorney/active.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": ["id", "type", "attributes"],
"properties": {
"id": {
"type": "null"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": false,
"required": ["status", "date_request_accepted", "representative"],
"properties": {
"status": {
"type": "string",
"description": "Status of Power of Attorney establishment",
"enum": [
"pending",
"submitted",
"updated",
"errored"
]
},
"date_request_accepted": {
"type": "string",
"nullable": true,
"description": "Date request was first accepted",
"format": "date"
},
"representative": {
"type": "object",
"additionalProperties": false,
"required": ["service_organization"],
"properties": {
"service_organization": {
"type": "object",
"additionalProperties": false,
"required": ["poa_code"],
"properties": {
"poa_code": {
"type": "string",
"description": "Power of Attorney Code submitted for Veteran"
},
"first_name": {
"description": "First name of representative, null if representative is an organization",
"type": "string",
"nullable": true,
"example": "Jane"
},
"last_name": {
"description": "Last name of representative, null if representative is an organization",
"type": "string",
"nullable": true,
"example": "Doe"
},
"organization_name": {
"description": "Name of representing organization, null if representative is an individual",
"type": "string",
"nullable": true,
"example": "Some Great Organization"
},
"phone_number": {
"description": "Phone number of representative. Can be organization or individual phone number.",
"type": "string",
"example": "555-555-5555"
}
}
}
}
},
"previous_poa": {
"type": "string",
"nullable": true,
"description": "Current or Previous Power of Attorney Code submitted for Veteran"
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/forms
|
code_files/vets-api-private/spec/support/schemas/claims_api/forms/power_of_attorney/validate.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": ["type", "attributes"],
"properties": {
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": false,
"required": ["status"],
"properties": {
"status": {
"type": "string",
"description": "Says if the power of attorney is pending, submitted, updated or errored",
"enum": [
"valid"
]
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/forms
|
code_files/vets-api-private/spec/support/schemas/claims_api/forms/power_of_attorney/submission.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": ["id", "type", "attributes"],
"properties": {
"id": {
"type": "string",
"description": "Power of Attorney Submission UUID"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": false,
"required": ["status", "date_request_accepted", "representative"],
"properties": {
"status": {
"type": "string",
"description": "Says if the power of attorney is pending, submitted, updated or errored",
"enum": [
"pending",
"submitted",
"updated",
"errored"
]
},
"date_request_accepted": {
"type": "string",
"description": "Date request was first accepted",
"format": "date"
},
"representative": {
"type": "object",
"additionalProperties": false,
"required": ["service_organization"],
"properties": {
"service_organization": {
"type": "object",
"additionalProperties": true,
"required": ["poa_code"],
"properties": {
"poa_code": {
"type": "string",
"description": "Power of Attorney Code submitted for Veteran"
}
}
}
}
},
"previous_poa": {
"type": "string",
"nullable": true,
"description": "Current or Previous Power of Attorney Code submitted for Veteran"
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/forms
|
code_files/vets-api-private/spec/support/schemas/claims_api/forms/disability/upload.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": ["id", "type", "attributes"],
"properties": {
"id": {
"type": "string",
"description": "Internal vets-api Claim ID"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": false,
"required": ["open", "updated_at", "events_timeline", "token", "status", "flashes"],
"properties": {
"evss_id": {
"type": "integer",
"nullable": true,
"description": "EVSS Claim ID"
},
"date_filed": {
"type": "string",
"nullable": true,
"format": "date",
"description": "Date in YYYY-MM-DD the claim was first filed"
},
"min_est_date": {
"type": "string",
"nullable": true,
"format": "date",
"description": "Minimum Estimated Claim Completion Date"
},
"max_est_date": {
"type": "string",
"nullable": true,
"format": "date",
"description": "Maximum Estimated Claim Completion Date"
},
"phase_change_date": {
"type": "string",
"nullable": true,
"format": "date",
"description": "Date of last phase change"
},
"open": {
"type": "boolean",
"description": "Has the claim been resolved"
},
"waiver_submitted": {
"type": "boolean",
"nullable": true,
"description": "Requested Decision or Waiver 5103 Submitted"
},
"documents_needed": {
"type": "boolean",
"nullable": true,
"description": "Does the claim require additional documents to be submitted"
},
"development_letter_sent": {
"type": "boolean",
"nullable": true,
"description": "Indicates if a Development Letter has been sent to the Claimant regarding a benefit claim"
},
"decision_letter_sent": {
"type": "boolean",
"nullable": true,
"description": "Indicates if a Decision Letter has been sent to the Claimant regarding a benefit claim"
},
"phase": {
"type": "string",
"nullable": true
},
"ever_phase_back": {
"type": "string",
"nullable": true
},
"current_phase_back": {
"type": "string",
"nullable": true
},
"requested_decision": {
"type": "string",
"nullable": true,
"description": "The claim filer has requested a claim decision be made"
},
"claim_type": {
"type": "string",
"nullable": true,
"description": "The type of claim originally submitted"
},
"updated_at": {
"type": "string",
"format": "date",
"description": "Time stamp of last change to the claim"
},
"contention_list": {
"type": "array",
"nullable": true
},
"va_representative": {
"type": "string",
"nullable": true
},
"events_timeline": {
"type": "array"
},
"token": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"pending"
],
"description": "Current status of the claim"
},
"flashes": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/forms
|
code_files/vets-api-private/spec/support/schemas/claims_api/forms/disability/attachments.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": ["id", "type", "attributes"],
"properties": {
"id": {
"type": "string",
"description": "Internal vets-api Claim ID"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": false,
"required": ["open", "updated_at", "events_timeline", "status", "supporting_documents"],
"properties": {
"evss_id": {
"type": "integer",
"nullable": true,
"description": "EVSS Claim ID"
},
"date_filed": {
"type": "string",
"nullable": true,
"format": "date",
"description": "Date in YYYY-MM-DD the claim was first filed"
},
"min_est_date": {
"type": "string",
"nullable": true,
"format": "date",
"description": "Minimum Estimated Claim Completion Date"
},
"max_est_date": {
"type": "string",
"nullable": true,
"format": "date",
"description": "Maximum Estimated Claim Completion Date"
},
"phase_change_date": {
"type": "string",
"nullable": true,
"format": "date",
"description": "Date of last phase change"
},
"open": {
"type": "boolean",
"description": "Has the claim been resolved"
},
"waiver_submitted": {
"type": "boolean",
"nullable": true,
"description": "Requested Decision or Waiver 5103 Submitted"
},
"documents_needed": {
"type": "boolean",
"nullable": true,
"description": "Does the claim require additional documents to be submitted"
},
"development_letter_sent": {
"type": "boolean",
"nullable": true,
"description": "Indicates if a Development Letter has been sent to the Claimant regarding a benefit claim"
},
"decision_letter_sent": {
"type": "boolean",
"nullable": true,
"description": "Indicates if a Decision Letter has been sent to the Claimant regarding a benefit claim"
},
"phase": {
"type": "string",
"nullable": true
},
"ever_phase_back": {
"type": "string",
"nullable": true
},
"current_phase_back": {
"type": "string",
"nullable": true
},
"requested_decision": {
"type": "string",
"nullable": true,
"description": "The claim filer has requested a claim decision be made"
},
"claim_type": {
"type": "string",
"nullable": true,
"description": "The type of claim originally submitted"
},
"updated_at": {
"type": "string",
"format": "date",
"description": "Time stamp of last change to the claim"
},
"contention_list": {
"type": "array",
"nullable": true
},
"va_representative": {
"type": "string",
"nullable": true
},
"events_timeline": {
"type": "array"
},
"status": {
"type": "string",
"enum": [
"pending",
"established"
],
"description": "Current status of the claim"
},
"supporting_documents": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of document"
},
"type": {
"type": "string"
},
"md5": {
"type": "string",
"nullable": true,
"description": "Hashed representation of document"
},
"filename": {
"type": "string",
"nullable": true,
"description": "Name of document"
},
"uploaded_at": {
"type": "string",
"nullable": true,
"format": "date",
"description": "Date and time document was uploaded"
}
}
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/forms
|
code_files/vets-api-private/spec/support/schemas/claims_api/forms/disability/validate.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": ["type", "attributes"],
"properties": {
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": false,
"required": ["status"],
"properties": {
"status": {
"type": "string",
"enum": [
"valid"
],
"description": "Return whether or not whether or not the payload is valid"
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/forms
|
code_files/vets-api-private/spec/support/schemas/claims_api/forms/disability/submission.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": ["id", "type", "attributes"],
"properties": {
"id": {
"type": "string",
"description": "Internal vets-api Claim ID"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": false,
"required": ["open", "updated_at", "events_timeline", "token", "status", "flashes"],
"properties": {
"evss_id": {
"type": "null",
"description": "EVSS Claim ID"
},
"date_filed": {
"type": "null",
"description": "Date in YYYY-MM-DD the claim was first filed"
},
"min_est_date": {
"type": "null",
"description": "Minimum Estimated Claim Completion Date"
},
"max_est_date": {
"type": "null",
"description": "Maximum Estimated Claim Completion Date"
},
"phase_change_date": {
"type": "null",
"description": "Date of last phase change"
},
"open": {
"type": "boolean",
"description": "Has the claim been resolved"
},
"waiver_submitted": {
"type": "null",
"description": "Requested Decision or Waiver 5103 Submitted"
},
"documents_needed": {
"type": "null",
"description": "Does the claim require additional documents to be submitted"
},
"development_letter_sent": {
"type": "null",
"description": "Indicates if a Development Letter has been sent to the Claimant regarding a benefit claim"
},
"decision_letter_sent": {
"type": "null",
"description": "Indicates if a Decision Letter has been sent to the Claimant regarding a benefit claim"
},
"phase": {
"type": "null"
},
"ever_phase_back": {
"type": "null"
},
"current_phase_back": {
"type": "null"
},
"requested_decision": {
"type": "null",
"description": "The claim filer has requested a claim decision be made"
},
"claim_type": {
"type": "null",
"description": "The type of claim originally submitted"
},
"updated_at": {
"type": "string",
"format": "date",
"description": "Time stamp of last change to the claim"
},
"contention_list": {
"type": "null"
},
"va_representative": {
"type": "null"
},
"events_timeline": {
"type": "array"
},
"token": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"pending"
],
"description": "Current status of the claim"
},
"flashes": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api
|
code_files/vets-api-private/spec/support/schemas/claims_api/veteran_identifier/submission.json
|
{
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"example": "1012667145V762142"
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/errors/default.json
|
{
"required": ["errors"],
"properties": {
"errors": {
"type": "array",
"items": {
"additionalProperties": false,
"required": ["title", "detail"],
"properties": {
"title": {
"type": "string",
"description": "HTTP error title"
},
"detail": {
"type": "string",
"description": "HTTP error detail"
},
"status": {
"type": "string",
"description": "HTTP error status code"
},
"code": {
"type": "string",
"description": "HTTP error status code"
},
"source": {
"type": "object",
"additionalProperties": false,
"description": "Source of error",
"properties": {
"pointer": {
"type": "string",
"description": "Pointer to source of error"
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/errors
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/errors/disability_compensation/default_without_source.json
|
{
"required": ["errors"],
"properties": {
"errors": {
"type": "array",
"items": {
"additionalProperties": false,
"required": ["title", "detail"],
"properties": {
"title": {
"type": "string",
"description": "HTTP error title"
},
"detail": {
"type": "string",
"description": "HTTP error detail"
},
"status": {
"type": "string",
"description": "HTTP error status code"
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/errors
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/errors/disability_compensation/default.json
|
{
"required": ["errors"],
"properties": {
"errors": {
"type": "array",
"items": {
"additionalProperties": false,
"required": ["title", "detail"],
"properties": {
"title": {
"type": "string",
"description": "HTTP error title"
},
"detail": {
"type": "string",
"description": "HTTP error detail"
},
"status": {
"type": "string",
"description": "HTTP error status code"
},
"source": {
"type": "object",
"additionalProperties": false,
"description": "Source of error",
"properties": {
"pointer": {
"type": "string",
"description": "Pointer to source of error"
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/errors
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/errors/disability_compensation/default_with_source.json
|
{
"required": ["errors"],
"properties": {
"errors": {
"type": "array",
"items": {
"additionalProperties": false,
"required": ["title", "status", "detail"],
"properties": {
"status": {
"type": "string",
"description": "HTTP error code"
},
"detail": {
"type": "string",
"description": "HTTP error detail"
},
"source": {
"type": "object",
"pointer": {
"type": "string"
}
},
"title": {
"type": "string"
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/errors
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/errors/power_of_attorney/default.json
|
{
"required": ["errors"],
"properties": {
"errors": {
"type": "array",
"items": {
"additionalProperties": false,
"required": ["title", "detail"],
"properties": {
"title": {
"type": "string",
"description": "HTTP error title"
},
"detail": {
"type": "string",
"description": "HTTP error detail"
},
"status": {
"type": "string",
"description": "HTTP error status code"
},
"source": {
"type": "object",
"additionalProperties": false,
"description": "Source of error",
"properties": {
"pointer": {
"type": "string",
"description": "Pointer to source of error"
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/veterans/submit_waiver_5103.json
|
{
"type": "object",
"additionalProperties": true,
"properties": {
"success": {
"type": "boolean",
"example": "true"
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/veterans
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/veterans/disability_compensation/attachments.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": ["id", "type", "attributes"],
"properties": {
"id": {
"type": "string",
"description": "Internal vets-api Claim ID"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": false,
"required": ["claimProcessType", "veteranIdentification", "disabilities", "serviceInformation", "claimantCertification"],
"properties": {
"claimProcessType": {
"type": "string"
},
"veteranIdentification": {
"type": "object",
"properties": {
"serviceNumber": {
"type": "string"
},
"veteranNumber": {
"type": "object",
"properties": {
"telephone": {
"type": "string"
},
"internationalTelephone": {
"type": "string"
}
}
},
"currentVaEmployee": {
"type": "boolean"
},
"mailingAddress": {
"type": "object",
"properties": {
"addressLine1": {
"type": "string"
},
"addressLine2": {
"type": "string"
},
"addressLine3": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"country": {
"type": "string"
},
"zipFirstFive": {
"type": "string"
},
"zipLastFour": {
"type": "string"
}
}
},
"emailAddress": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"agreeToEmailRelatedToClaim": {
"type": "boolean"
}
}
}
}
},
"changeOfAddress": {
"type": "object",
"properties": {
"typeOfAddressChange": {
"type": "string"
},
"addressLine1": {
"type": "string"
},
"addressLine2": {
"type": "string"
},
"addressLine3": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"country": {
"type": "string"
},
"zipFirstFive": {
"type": "string"
},
"zipLastFour": {
"type": "string"
},
"dates": {
"type": "object",
"properties": {
"beginDate": {
"type": "string"
},
"endDate": {
"type": "string"
}
}
}
}
},
"homeless": {
"type": "object",
"properties": {
"currentlyHomeless": {
"type": "object",
"properties": {
"currentlyHomeless": {
"type": "object",
"properties": {
"homelessSituationOptions": {
"type": "string"
},
"otherDescription": {
"type": "string"
}
}
}
}
},
"pointOfContact": {
"type": "string"
},
"pointOfContactNumber": {
"type": "object",
"properties": {
"telephone": {
"type": "string"
},
"internationalTelephone": {
"type": "string"
}
}
}
}
},
"toxicExposure": {
"type": "object",
"properties": {
"gulfWarHazardService": {
"type": "object",
"properties": {
"servedInGulfWarHazardLocations":{
"type": "string"
},
"serviceDates": {
"type": "object",
"properties": {
"beginDate": {
"type": "string"
},
"endDate": {
"type": "string"
}
}
}
}
},
"herbicideHazardService": {
"type": "object",
"properties": {
"servedInHerbicideHazardLocations": {
"type": "string"
},
"otherLocationsServed": {
"type": "string"
},
"serviceDates": {
"type": "object",
"properties": {
"beginDate": {
"type": "string"
},
"endDate": {
"type": "string"
}
}
}
}
},
"additionalHazardExposures": {
"type": "object",
"properties": {
"additionalExposures": {
"type": "array",
"items": {
"type": "string"
}
},
"specifyOtherExposures": {
"type": "string"
},
"exposureDates": {
"type": "object",
"properties": {
"beginDate": {
"type": "string"
},
"endDate": {
"type": "string"
}
}
}
}
},
"multipleExposures": {
"type": "array",
"items": {
"type": "object",
"properties": {
"hazardExposedTo": {
"type": "string"
},
"exposureLocation": {
"type": "string"
},
"exposureDates": {
"type": "object",
"properties": {
"beginDate": {
"type": "string"
},
"endDate": {
"type": "string"
}
}
}
}
}
}
}
},
"disabilities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"exposureOrEventOrInjury": {
"type": "string"
},
"serviceRelevance": {
"type": "string"
},
"approximateDate": {
"type": "string"
},
"disabilityActionType": {
"type": "string"
},
"classificationCode": {
"type": "string"
},
"ratedDisabilityId": {
"type": "string"
},
"diagnosticCode": {
"type": "integer"
},
"isRelatedToToxicExposure": {
"type": "boolean"
},
"secondaryDisabilities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"exposureOrEventOrInjury": {
"type": "string"
},
"serviceRelevance": {
"type": "string"
},
"disabilityActionType": {
"type": "string"
},
"approximateDate": {
"type": "string"
},
"classificationCode": {
"type": "string"
}
}
}
}
}
}
},
"treatments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"beginDate": {
"type": "string"
},
"treatedDisabilityNames": {
"type": "array",
"items": {
"type": "string"
}
},
"center": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
}
}
}
}
}
},
"serviceInformation": {
"type": "object",
"properties": {
"alternateNames": {
"type": "array",
"items": {
"type": "string"
}
},
"servicePeriods": {
"type": "array",
"items": {
"type": "object",
"properties": {
"serviceBranch": {
"type": "string"
},
"serviceComponent": {
"type": "string"
},
"activeDutyBeginDate": {
"type": "string"
},
"activeDutyEndDate": {
"type": "string"
},
"separationLocationCode": {
"type": "string"
}
}
}
},
"servedInActiveCombatSince911": {
"type": "string"
},
"reservesNationalGuardService": {
"type": "object",
"properties": {
"component": {
"type": "string"
},
"obligationTermsOfService": {
"type": "object",
"properties": {
"beginDate": {
"type": "string"
},
"endDate": {
"type": "string"
}
}
},
"unitName": {
"type": "string"
},
"unitAddress": {
"type": "string"
},
"unitPhone": {
"type": "object",
"properties": {
"areaCode": {
"type": "string"
},
"phoneNumber": {
"type": "string"
}
}
},
"receivingInactiveDutyTrainingPay": {
"type": "string"
}
}
},
"federalActivation": {
"type": "object",
"properties": {
"activationDate": {
"type": "string"
},
"anticipatedSeparationDate": {
"type": "string"
}
}
}
},
"confinements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"approximateBeginDate": {
"type": "string"
},
"approximateEndDate": {
"type": "string"
}
}
}
}
},
"servicePay": {
"type": "object",
"properties": {
"receivingMilitaryRetiredPay": {
"type": "string"
},
"futureMilitaryRetiredPay": {
"type": "string"
},
"futureMilitaryRetiredPayExplanation": {
"type": "string"
},
"militaryRetiredPay": {
"type": "object",
"properties": {
"branchOfService": {
"type": "string"
},
"monthlyAmount": {
"type": "integer"
}
}
},
"retiredStatus": {
"type": "string"
},
"favorMilitaryRetiredPay": {
"type": "boolean"
},
"receivedSeparationOrSeverancePay": {
"type": "string"
},
"separationSeverancePay": {
"type": "object",
"properties": {
"datePaymentReceived": {
"type": "string"
},
"branchOfService": {
"type": "string"
},
"preTaxAmountReceived": {
"type": "integer"
}
}
},
"favorTrainingPay": {
"type": "boolean"
}
}
},
"directDeposit": {
"type": "object",
"properties": {
"noAccount": {
"type": "boolean"
},
"accountNumber": {
"type": "string"
},
"accountType": {
"type": "string"
},
"financialInstitutionName":{
"type": "string"
},
"routingNumber": {
"type": "string"
}
}
},
"claimantCertification": {
"type": "boolean"
},
"claimNotes": {
"type": ["string", "null"],
"description": "An optional notes section.",
"maxLength": 4000
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/veterans
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/veterans/intent_to_file/intent_to_file.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": ["id", "type", "attributes"],
"properties": {
"id": {
"type": "string",
"description": "Intent To File ID",
"example": "600131328"
},
"type": {
"type": "string",
"example": "intent_to_file"
},
"attributes": {
"required": ["creationDate", "expirationDate", "status", "type"],
"properties": {
"creationDate": {
"type": "string",
"format": "date",
"description": "Date the Intent to File was received at VA"
},
"expirationDate": {
"type": "string",
"format": "date",
"description": "Date the Intent to File expires, this is 1 year from the createdDate"
},
"status": {
"type": "string",
"description": "The status of the Intent to File",
"example": "active"
},
"type": {
"type": "string",
"description": "The type of Intent to File filed",
"example": "compensation"
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/veterans
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/veterans/power_of_attorney/status.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": ["id", "type", "attributes"],
"properties": {
"id": {
"type": "string",
"description": "Power of Attorney Submission UUID"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": false,
"required": ["status", "createdAt", "representative"],
"properties": {
"status": {
"type": "string",
"description": "Says if the power of attorney is pending, submitted, updated or errored",
"enum": [
"pending",
"submitted",
"updated",
"errored"
]
},
"createdAt": {
"type": "string",
"description": "Date request was first accepted",
"format": "date"
},
"errors": {
"type": "array",
"description": "Error details if applicable",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"code": {
"type": "string",
"enum": [
"PDF_SUBMISSION",
"POA_UPDATE",
"POA_ACCESS_UPDATE",
"CLAIMANT_NOTIFICATION"
]
}
}
}
},
"steps": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": [
"PDF_SUBMISSION",
"POA_UPDATE",
"POA_ACCESS_UPDATE",
"CLAIMANT_NOTIFICATION"
]
},
"status": {
"type": "string",
"enum": [
"NOT_STARTED",
"IN_PROGRESS",
"SUCCESS",
"FAILED"
]
},
"completedAt": {
"type": ["string", "null"],
"format": "date"
},
"nextStep": {
"type": ["string", "null"],
"enum": [
"POA_UPDATE",
"POA_ACCESS_UPDATE",
"CLAIMANT_NOTIFICATION",
null
]
}
}
}
},
"representative": {
"type": "object",
"additionalProperties": false,
"required": ["poaCode"],
"properties": {
"poaCode": {
"type": "string",
"description": "Power of Attorney Code submitted for Veteran"
}
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/veterans/power_of_attorney
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/veterans/power_of_attorney/request_representative/submit.json
|
{
"$schema" : "http://json-schema.org/draft-07/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": ["id", "type", "attributes"],
"properties": {
"id": {
"type": ["string"],
"description": "The unique identifier for the power of attorney request"
},
"type": {
"type": "string",
"enum": ["power-of-attorney-request"],
"description": "The type of the resource"
},
"attributes": {
"type": "object",
"additionalProperties": false,
"required": [
"veteran",
"representative",
"recordConsent",
"consentAddressChange"
],
"properties": {
"veteran": {
"type": "object",
"additionalProperties": false,
"required": [
"address"
],
"properties": {
"serviceNumber": {
"description": "The Veteran's Service Number",
"type": "string",
"maxLength": 9
},
"serviceBranch": {
"description": "Service Branch for the veteran.",
"type": "string",
"enum": [
"AIR_FORCE",
"ARMY",
"COAST_GUARD",
"MARINE_CORPS",
"NAVY",
"SPACE_FORCE",
"OTHER"
],
"example": "ARMY"
},
"address": {
"type": "object",
"additionalProperties": false,
"required": [
"addressLine1",
"city",
"stateCode",
"countryCode",
"zipCode"
],
"properties" : {
"addressLine1": {
"description": "Street address with number and name.",
"type": "string",
"pattern": "^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$",
"maxLength": 30
},
"addressLine2": {
"type": "string",
"maxLength": 5
},
"city": {
"description": "City for the address.",
"type": "string",
"example": "Portland",
"maxLength": 18
},
"stateCode": {
"description": "State for the address.",
"type": "string",
"pattern": "^[a-z,A-Z]{2}$",
"example": "OR"
},
"countryCode": {
"description": "Country code of the address.",
"type": "string",
"example": "US",
"pattern": "^[A-Za-z0-9-]{2,6}$"
},
"zipCode": {
"description": "Zipcode (First 5 digits) of the address.",
"type": "string",
"pattern": "^\\d{5}?$",
"example": "12345"
},
"zipCodeSuffix": {
"description": "Zipcode (Last 4 digits) of the address.",
"type": "string",
"pattern": "^\\d{4}?$",
"example": "6789"
}
}
},
"phone": {
"$comment": "the phone fields must not exceed 20 chars, when concatenated",
"type": "object",
"additionalProperties": false,
"required": [
"areaCode",
"phoneNumber"
],
"properties": {
"areaCode": {
"description": "Area code of the phone number.",
"type": "string", "pattern": "^[2-9][0-9]{2}$",
"example": "555"
},
"phoneNumber": {
"description": "Phone number.",
"type": "string", "pattern": "^[0-9]{1,14}$",
"example": "555-5555"
}
}
},
"email": {
"description": "Email address of the veteran.",
"type": "string",
"pattern": ".@.",
"maxLength": 61,
"example": "veteran@example.com"
},
"insuranceNumber": {
"type": "string",
"maxLength": 10,
"description": "Veteran's insurance number, if applicable. Include letter prefix."
}
}
},
"claimant": {
"type": "object",
"additionalProperties": false,
"properties": {
"claimantId": {
"type": ["string", "null"],
"example": "123456789",
"description": "Id of the claimant."
},
"address": {
"type": "object",
"additionalProperties": false,
"properties" : {
"addressLine1": {
"description": "Street address with number and name. Required if claimant information provided.",
"type": ["string", "null"],
"pattern": "^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$",
"maxLength": 30
},
"addressLine2": {
"type": ["string", "null"],
"maxLength": 5
},
"city": {
"description": "City for the address. Required if claimant information provided.",
"type": ["string", "null"],
"example": "Portland",
"maxLength": 18
},
"stateCode": {
"description": "State for the address. Required if claimant information provided.",
"type": ["string", "null"],
"pattern": "^[a-z,A-Z]{2}$",
"example": "OR"
},
"countryCode": {
"description": "Country code of the address. Required if claimant information provided.",
"type": ["string", "null"],
"example": "US",
"pattern": "^[A-Za-z0-9-]{2,6}$"
},
"zipCode": {
"description": "Zipcode (First 5 digits) of the address. Required if claimant information provided.",
"type": ["string", "null"],
"pattern": "^\\d{5}?$",
"example": "12345"
},
"zipCodeSuffix": {
"description": "Zipcode (Last 4 digits) of the address.",
"type": ["string", "null"],
"pattern": "^\\d{4}?$",
"example": "6789"
}
}
},
"phone": {
"$comment": "the phone fields must not exceed 20 chars, when concatenated",
"type": "object",
"additionalProperties": false,
"required": [
"areaCode",
"phoneNumber"
],
"properties": {
"areaCode": {
"description": "Area code of the phone number.",
"type": ["string", "null"],
"pattern": "^[2-9][0-9]{2}$",
"example": "555"
},
"phoneNumber": {
"description": "Phone number.",
"type": ["string", "null"],
"pattern": "^[0-9]{1,14}$",
"example": "555-5555"
}
}
},
"email": {
"description": "Email address of the claimant.",
"type": ["string", "null"],
"pattern": ".@.",
"maxLength": 61,
"example": "claimant@example.com"
},
"relationship": {
"description": "Relationship of claimant to the veteran. Required if claimant information provided.",
"type": ["string", "null"],
"example": "Spouse"
}
}
},
"representative": {
"description": "Details of the requested Power of Attorney representing the veteran.",
"type": "object",
"additionalProperties": false,
"required": [
"poaCode"
],
"properties": {
"poaCode": {
"description": "The POA code of the accredited representative or organization.",
"type": "string",
"example": "A1Q"
}
}
},
"recordConsent": {
"description": "AUTHORIZATION FOR REPRESENTATIVE'S ACCESS TO RECORDS PROTECTED BY SECTION 7332, TITLE 38, U.S.C.",
"type": "boolean"
},
"consentLimits": {
"description": "Consent in Item 19 for the disclosure of records relating to treatment for drug abuse, alcoholism or alcohol abuse, infection with the human immunodeficiency virus (HIV), or sickle cell anemia is limited as follows. Will default to false if not specified.",
"type": "array",
"items": {
"type": "string",
"enum": [
"DRUG_ABUSE",
"ALCOHOLISM",
"HIV",
"SICKLE_CELL"
]
},
"example": "DRUG ABUSE"
},
"consentAddressChange": {
"description": "AUTHORIZATION FOR REPRESENTATIVE TO ACT ON CLAIMANT'S BEHALF TO CHANGE CLAIMANT'S ADDRESS.",
"type": "boolean"
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/veterans/power_of_attorney
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/veterans/power_of_attorney/2122a/submit.json
|
{
"$schema" : "http://json-schema.org/draft-07/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": ["type", "attributes"],
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": false,
"required": ["code"],
"properties": {
"code": {
"type": "string",
"description": "code for Power of attorney"
},
"phoneNumber": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/veterans/power_of_attorney
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/veterans/power_of_attorney/2122a/validate.json
|
{
"$schema" : "http://json-schema.org/draft-07/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": ["type", "attributes"],
"properties": {
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": false,
"required": ["status"],
"properties": {
"status": {
"type": "string",
"description": "Says if submission of 21-22a would work with the given parameters",
"enum": [
"valid"
]
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/veterans/power_of_attorney
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/veterans/power_of_attorney/2122/submit.json
|
{
"$schema" : "http://json-schema.org/draft-07/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": ["type", "attributes"],
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": false,
"required": ["code"],
"properties": {
"code": {
"type": "string",
"description": "code for Power of attorney"
},
"phoneNumber": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/veterans/power_of_attorney
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/veterans/power_of_attorney/2122/validate.json
|
{
"$schema" : "http://json-schema.org/draft-07/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": ["type", "attributes"],
"properties": {
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": false,
"required": ["status"],
"properties": {
"status": {
"type": "string",
"description": "Says if submission of 21-22 would work with the given parameters",
"enum": [
"valid"
]
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/veterans
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/veterans/claims/claim.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type" : "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"required": ["id", "type", "attributes"],
"additionalProperties": false,
"description": "Claim details",
"properties": {
"id": {
"type": "string",
"nullable": true,
"description": "Claim ID in VBMS. If a claim was submitted with Lighthouse and not successfully established upstream, it could have a null claimId.",
"example": "600131328"
},
"type": {
"type": "string",
"example": "evss_claims"
},
"attributes": {
"type": "object",
"additionalProperties": false,
"required": ["claimTypeCode", "claimDate", "claimPhaseDates", "claimType", "closeDate", "contentions", "decisionLetterSent", "developmentLetterSent", "documentsNeeded", "endProductCode", "evidenceWaiverSubmitted5103", "errors", "jurisdiction", "lighthouseId", "maxEstClaimDate", "minEstClaimDate", "status", "submitterApplicationCode", "submitterRoleCode", "supportingDocuments", "tempJurisdiction", "trackedItems"],
"properties": {
"claimTypeCode": {
"type": "string",
"description": "Type code of benefit claim",
"example": "400PREDSCHRG"
},
"claimType": {
"type": "string",
"description": "Name of claim type",
"example": "Compensation"
},
"contentions": {
"type": "array",
"description": "The contentions being submitted with a claim",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "abscess kidney (New)"
}
}
}
},
"claimDate": {
"format": "date",
"type": "string",
"nullable": true,
"description": "The date a claim was filed",
"example": "2017-10-18"
},
"claimPhaseDates": {
"type":"object",
"properties": {
"currentPhaseBack": {
"type": "boolean",
"description": "Indicates whether the current phase is moving backward."
},
"latestPhaseType": {
"type": "string",
"enum": [
"CLAIM_RECEIVED",
"UNDER_REVIEW",
"GATHERING_OF_EVIDENCE",
"REVIEW_OF_EVIDENCE",
"PREPARATION_FOR_DECISION",
"PENDING_DECISION_APPROVAL",
"PREPARATION_FOR_NOTIFICATION",
"COMPLETE"
],
"nullable": true,
"description": "The most current phase for the claim"
},
"phaseChangeDate": {
"format": "date",
"type": "string",
"nullable": true,
"description": "The date that the claim changed to its current phase",
"example": "2017-10-18"
},
"previousPhases": {
"type": "object",
"properties": {
"phase1CompleteDate": {
"format": "date",
"type": "string",
"description": "Completed date of the claim received phase.",
"example": "2017-10-18"
},
"phase2CompleteDate": {
"format": "date",
"type": "string",
"description": "Completed date of the initial review phase.",
"example": "2017-10-18"
},
"phase3CompleteDate": {
"format": "date",
"type": "string",
"description": "Completed date of the gathering of evidence phase.",
"example": "2017-10-18"
},
"phase4CompleteDate": {
"format": "date",
"type": "string",
"description": "Completed date of the reviewing of evidence phase.",
"example": "2017-10-18"
},
"phase5CompleteDate": {
"format": "date",
"type": "string",
"description": "Completed date of the preparation for decision phase.",
"example": "2017-10-18"
},
"phase6CompleteDate": {
"format": "date",
"type": "string",
"description": "Completed date of the pending decision approval phase.",
"example": "2017-10-18"
},
"phase7CompleteDate": {
"format": "date",
"type": "string",
"description": "Completed date of the preparation for notification phase.",
"example": "2017-10-18"
},
"phase8CompleteDate": {
"format": "date",
"type": "string",
"description": "Completed date of the completed phase.",
"example": "2017-10-18"
}
}
}
}
},
"closeDate": {
"format": "date",
"type": "string",
"nullable": true,
"description": "Date claim was closed",
"example": "2019-09-04"
},
"decisionLetterSent": {
"type": "boolean",
"description": "If true, a decision letter has been sent to the claimant regarding a benefit claim"
},
"developmentLetterSent": {
"type": "boolean",
"description": "If true, a development letter has been sent to the claimant regarding a benefit claim"
},
"documentsNeeded": {
"type": "boolean",
"description": "If true, the claim requires additional documents to be submitted"
},
"endProductCode": {
"type": "string",
"description": "End product code of claim",
"example": "930"
},
"evidenceWaiverSubmitted5103": {
"type": "boolean",
"nullable": true,
"description": "If true, indicates a decision has been requested and/or a Waiver 5103 has been submitted",
"example": "false"
},
"errors": {
"type": "array",
"description": "Error details if claim is in an errored state.",
"items": {
"properties": {
"detail": {
"type": "string",
"example": "Something happened"
},
"source": {
"type": "string",
"example": "some/error/path"
}
}
}
},
"jurisdiction": {
"type": "string",
"description": "Regional office to which the claim is currently assigned."
},
"lighthouseId": {
"type": "string",
"nullable": true,
"description": "Claim ID in Lighthouse",
"example": "0BAEFC26-1CE4-4046-9B3C-3071055603DB"
},
"minEstClaimDate": {
"format": "date",
"type": "string",
"nullable": true,
"description": "Minimum estimated claim completion date",
"example": "2019-06-04"
},
"maxEstClaimDate": {
"format": "date",
"type": "string",
"nullable": true,
"description": "Maximum estimated claim completion date",
"example": "2019-09-04"
},
"status": {
"type": "string",
"description": "Status of claim",
"enum": [
"PENDING",
"CLAIM_RECEIVED",
"INITIAL_REVIEW",
"EVIDENCE_GATHERING_REVIEW_DECISION",
"PREPARATION_FOR_NOTIFICATION",
"COMPLETE",
"ERRORED",
"CANCELED"
]
},
"submitterApplicationCode": {
"type": "string",
"description": "Application code of benefit claim submitter",
"example": "EBN"
},
"submitterRoleCode": {
"type": "string",
"description": "Role code of benefit claim submitter",
"example": "VET"
},
"supportingDocuments": {
"type": "array",
"description": "Information regarding any supported documents attached to a claim",
"items": {
"properties": {
"documentId": {
"type": "string",
"description": "Unique identifier of document"
},
"documentTypeLabel": {
"type": "string",
"nullable": true
},
"originalFileName": {
"type": "string",
"description": "Name of document",
"nullable": true
},
"trackedItemId": {
"type": "string",
"nullable": true
},
"uploadDate": {
"format": "date",
"type": "string",
"description": "Date and time document was uploaded",
"nullable": true
}
}
}
},
"tempJurisdiction": {
"type": ["string", "null"],
"description": "Temporary jurisdiction of claim"
},
"trackedItems": {
"type": "array",
"description": "",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"closedDate": {
"format": "date",
"type": "string",
"nullable": true,
"description": "Date the tracked item was closed",
"example": "2017-10-18"
},
"description": {
"type": "string",
"nullable": true,
"description": "Description of the tracked item",
"example": "You may also submit statements from individuals having knowledge of your claimed condition."
},
"requestedDate": {
"format": "date",
"type": "string",
"nullable": true,
"description": "Date the tracked item was requested",
"example": "2017-10-18"
},
"id": {
"type": "integer",
"description": "ID of the tracked item",
"example": 293454
},
"displayName": {
"type": "string",
"nullable": true,
"description": "Description of the tracked item",
"example": "Submit buddy statement(s)"
},
"receivedDate": {
"format": "date",
"type": "string",
"nullable": true,
"description": "Date the tracked item was received",
"example": "2017-10-18"
},
"overdue": {
"type": "boolean",
"nullable": true,
"description": "True if the item is overdue",
"example": true
},
"status": {
"type": "string",
"nullable": true,
"description": "Enum with the status of the tracked item",
"example": "NO_LONGER_REQUIRED",
"enum": [
"ACCEPTED",
"INITIAL_REVIEW_COMPLETE",
"NEEDED_FROM_YOU",
"NEEDED_FROM_OTHERS",
"NO_LONGER_REQUIRED",
"SUBMITTED_AWAITING_REVIEW"
]
},
"suspenseDate": {
"format": "date",
"type": "string",
"nullable": true,
"example": "2017-10-18"
},
"uploadsAllowed": {
"type": "boolean",
"example": true
}
}
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/veterans
|
code_files/vets-api-private/spec/support/schemas/claims_api/v2/veterans/claims/claims.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "array",
"items": {
"required": ["id", "type", "attributes"],
"additionalProperties": false,
"description": "Claim details",
"properties": {
"id": {
"type": "string",
"nullable": true,
"description": "Claim ID in VBMS. If a claim was submitted with Lighthouse and not successfully established upstream, it could have a null claimId.",
"example": "600131328"
},
"type": {
"type": "string",
"example": "claim"
},
"attributes": {
"type": "object",
"required": ["baseEndProductCode", "claimType", "claimDate", "claimPhaseDates", "closeDate", "developmentLetterSent", "decisionLetterSent", "documentsNeeded", "endProductCode", "evidenceWaiverSubmitted5103", "lighthouseId", "status"],
"properties": {
"baseEndProductCode": {
"type": "string",
"description": "Base end product code for claim",
"example": "400"
},
"claimType": {
"type": "string",
"description": "Name of claim type",
"example": "Compensation"
},
"claimDate": {
"format": "date",
"type": "string",
"description": "Date the claim was first filed. In YYYY-MM-DD format.",
"example": "2018-06-04"
},
"claimPhaseDates": {
"type":"object",
"properties": {
"phaseChangeDate": {
"format": "date",
"type": "string",
"description": "The date that the claim changed to its current phase",
"example": "2017-10-18"
},
"phaseType": {
"type": "string",
"enum": [
"CLAIM_RECEIVED",
"UNDER_REVIEW",
"GATHERING_OF_EVIDENCE",
"REVIEW_OF_EVIDENCE",
"PREPARATION_FOR_DECISION",
"PENDING_DECISION_APPROVAL",
"PREPARATION_FOR_NOTIFICATION",
"COMPLETE"
],
"description": "The most current phase for the claim",
"example": "UNDER_REVIEW"
}
}
},
"closeDate": {
"format": "date",
"type": "string",
"description": "Date claim was closed",
"example": "2019-09-04"
},
"developmentLetterSent": {
"type": "boolean",
"description": "If true, a development letter has been sent to the claimant regarding a benefit claim",
"example": "false"
},
"decisionLetterSent": {
"type": "boolean",
"description": "If true, a decision letter has been sent to the claimant regarding a benefit claim",
"example": "false"
},
"documentsNeeded": {
"type": "boolean",
"description": "If true, the claim requires additional documents to be submitted",
"example": "false"
},
"endProductCode": {
"type": "string",
"description": "End product code of claim"
},
"evidenceWaiverSubmitted5103": {
"type": "boolean",
"nullable": true,
"description": "If true, indicates a decision has been requested and/or a Waiver 5103 has been submitted",
"example": "false"
},
"lighthouseId": {
"type": "string",
"nullable": true,
"description": "Claim ID in Lighthouse",
"example": "0BAEFC26-1CE4-4046-9B3C-3071055603DB"
},
"status": {
"type": "string",
"description": "Status of claim",
"enum": [
"PENDING",
"CLAIM_RECEIVED",
"INITIAL_REVIEW",
"EVIDENCE_GATHERING_REVIEW_DECISION",
"PREPARATION_FOR_NOTIFICATION",
"COMPLETE",
"ERRORED",
"CANCELED"
]
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api
|
code_files/vets-api-private/spec/support/schemas/claims_api/errors/default.json
|
{
"required": ["errors"],
"properties": {
"errors": {
"type": "array",
"items": {
"additionalProperties": false,
"required": ["title", "detail", "code", "status"],
"properties": {
"title": {
"type": "string",
"description": "HTTP error title"
},
"detail": {
"type": "string",
"description": "HTTP error detail"
},
"code": {
"type": "string",
"description": "HTTP error code"
},
"status": {
"type": "string",
"description": "HTTP error code"
},
"source": {
"type": "object",
"additionalProperties": false,
"description": "Source of error",
"properties": {
"pointer": {
"type": "string",
"description": "Pointer to source of error"
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api
|
code_files/vets-api-private/spec/support/schemas/claims_api/errors/default_with_source.json
|
{
"required": ["errors"],
"properties": {
"errors": {
"type": "array",
"items": {
"additionalProperties": false,
"required": ["status", "detail", "source"],
"properties": {
"status": {
"type": "integer",
"description": "HTTP error code"
},
"detail": {
"type": "string",
"description": "HTTP error detail"
},
"source": {
"type": "string"
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/veterans
|
code_files/vets-api-private/spec/support/schemas/claims_api/veterans/power-of-attorney/get.json
|
{
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": ["type", "attributes"],
"properties": {
"type": {
"type": "string",
"nullable": true,
"description": "Type of representative, organization or individual",
"example": "individual"
},
"attributes": {
"type": "object",
"additionalProperties": false,
"required": ["code", "name", "phoneNumber"],
"properties": {
"code": {
"type": "string",
"nullable": true,
"description": "Power of Attorney Code currently assigned to Veteran"
},
"name": {
"description": "Name of individual representative or organization",
"type": "string",
"nullable": true,
"example": "Jane Smith"
},
"phoneNumber": {
"description": "Phone number of representative. Can be organization or individual phone number.",
"type": "string",
"nullable": true,
"example": "555-555-5555"
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/claims_api/veterans
|
code_files/vets-api-private/spec/support/schemas/claims_api/veterans/power-of-attorney/post.json
|
{
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": ["id", "type", "attributes"],
"properties": {
"id": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true,
"description": "Type of representative, organization or individual",
"example": "individual"
},
"attributes": {
"type": "object",
"additionalProperties": false,
"required": ["code", "name", "phoneNumber"],
"properties": {
"code": {
"type": "string",
"nullable": true,
"description": "Power of Attorney Code currently assigned to Veteran"
},
"name": {
"description": "Name of individual representative or organization",
"type": "string",
"nullable": true,
"example": "Jane Smith"
},
"phoneNumber": {
"description": "Phone number of representative. Can be organization or individual phone number.",
"type": "string",
"nullable": true,
"example": "555-555-5555"
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/va_profile/transaction_response.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"transaction_status": {
"type": "string"
},
"transaction_id": {
"type": "string"
},
"type": {
"type": "string"
},
"metadata": {
"type": "array"
}
},
"type": "object"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/va_profile/preferred_name_response.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"preferred_name": {
"type": "object",
"description": "Preferred Name",
"properties": {
"text": {
"type": "string",
"description": "Preferred Name Text"
},
"source_system_user": {
"type": "string",
"description": "Source System User"
},
"source_date": {
"type": "string",
"description": "Source Date"
}
}
}
},
"type": "object"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/va_profile/zipcodes.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"zipcodes": {
"description": "Array of zipcodes",
"items": {
"type": "object",
"properties": {
"zip_code": { "type": "string" }
}
},
"type": "array"
}
},
"type": "object"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/va_profile/states.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"states": {
"description": "Array of states",
"items": {
"type": "object",
"properties": {
"state_name": { "type": "string" },
"state_code": { "type": "string" }
}
},
"type": "array"
}
},
"type": "object"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/va_profile/countries.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"countries": {
"description": "Array of countries",
"items": {
"type": "object",
"properties": {
"country_name": { "type": "string" },
"country_code_iso3": { "type": "string" }
}
},
"type": "array"
}
},
"type": "object"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/va_profile/gender_identity_response.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"gender_identity": {
"type": "object",
"description": "Gender Identity",
"properties": {
"code": {
"type": "string",
"description": "Gender Identity Code"
},
"name": {
"type": "string",
"description": "Gender Identity Name"
},
"source_system_user": {
"type": "string",
"description": "Source System User"
},
"source_date": {
"type": "string",
"description": "Source Date"
}
}
}
},
"type": "object"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support/schemas/va_profile/profile
|
code_files/vets-api-private/spec/support/schemas/va_profile/profile/v3/military_info_response.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"messages": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"code": {
"type": "string"
},
"key": {
"type": "string"
},
"text": {
"type": "string"
},
"severity": {
"type": "string"
}
},
"required": [
"code",
"key",
"text",
"severity"
]
},
{
"type": "object",
"properties": {
"code": {
"type": "string"
},
"key": {
"type": "string"
},
"text": {
"type": "string"
},
"severity": {
"type": "string"
}
},
"required": [
"code",
"key",
"text",
"severity"
]
},
{
"type": "object",
"properties": {
"code": {
"type": "string"
},
"key": {
"type": "string"
},
"text": {
"type": "string"
},
"severity": {
"type": "string"
}
},
"required": [
"code",
"key",
"text",
"severity"
]
}
]
},
"profile": {
"type": "object",
"properties": {
"militaryPerson": {
"type": "object",
"properties": {
"militarySummary": {
"type": "object",
"properties": {
"activeDutyStatus": {
"type": "string"
},
"combatServiceIndicator": {
"type": "boolean"
},
"post911DeploymentIndicator": {
"type": "boolean"
},
"pre911DeploymentIndicator": {
"type": "boolean"
},
"title38StatusText": {
"type": "string"
},
"title38StatusCode": {
"type": "string"
},
"dutyStatusText": {
"type": "string"
},
"dutyStatusCode": {
"type": "string"
},
"totalNumberOfRegularActiveDutyDays": {
"type": "integer"
},
"totalNumberOfReserveActiveDutyDays": {
"type": "integer"
},
"totalNumberOfGuardActiveDutyDays": {
"type": "integer"
},
"totalNumberOfTrainingDays": {
"type": "integer"
},
"customerType": {
"type": "object",
"properties": {
"dodServiceSummary": {
"type": "object",
"properties": {
"dodServiceSummaryCode": {
"type": "string"
},
"calculationModelVersion": {
"type": "string"
},
"effectiveStartDate": {
"type": "string"
}
},
"required": [
"dodServiceSummaryCode",
"calculationModelVersion",
"effectiveStartDate"
]
}
},
"required": [
"dodServiceSummary"
]
}
},
"required": [
"activeDutyStatus",
"combatServiceIndicator",
"post911DeploymentIndicator",
"pre911DeploymentIndicator",
"title38StatusText",
"title38StatusCode",
"dutyStatusText",
"dutyStatusCode",
"totalNumberOfRegularActiveDutyDays",
"totalNumberOfReserveActiveDutyDays",
"totalNumberOfGuardActiveDutyDays",
"totalNumberOfTrainingDays",
"customerType"
]
},
"militaryOccupations": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"serviceSegmentSequence": {
"type": "integer"
},
"occupationSegmentSequence": {
"type": "integer"
},
"occupationTypeCode": {
"type": "string"
},
"occupationTypeText": {
"type": "string"
},
"dodProvidedCode": {
"type": "string"
},
"dodOccupationCode": {
"type": "string"
},
"dodOccupationText": {
"type": "string"
},
"serviceProvidedCode": {
"type": "string"
},
"serviceSpecificOccupationCode": {
"type": "string"
},
"serviceSpecificOccupationText": {
"type": "string"
},
"effectiveDate": {
"type": "string"
}
},
"required": [
"serviceSegmentSequence",
"occupationSegmentSequence",
"occupationTypeCode",
"occupationTypeText",
"dodProvidedCode",
"dodOccupationCode",
"dodOccupationText",
"serviceProvidedCode",
"serviceSpecificOccupationCode",
"serviceSpecificOccupationText",
"effectiveDate"
]
},
{
"type": "object",
"properties": {
"serviceSegmentSequence": {
"type": "integer"
},
"occupationSegmentSequence": {
"type": "integer"
},
"occupationTypeCode": {
"type": "string"
},
"occupationTypeText": {
"type": "string"
},
"dodProvidedCode": {
"type": "string"
},
"dodOccupationCode": {
"type": "string"
},
"dodOccupationText": {
"type": "string"
},
"serviceProvidedCode": {
"type": "string"
},
"serviceSpecificOccupationCode": {
"type": "string"
},
"serviceSpecificOccupationText": {
"type": "string"
},
"effectiveDate": {
"type": "string"
}
},
"required": [
"serviceSegmentSequence",
"occupationSegmentSequence",
"occupationTypeCode",
"occupationTypeText",
"dodProvidedCode",
"dodOccupationCode",
"dodOccupationText",
"serviceProvidedCode",
"serviceSpecificOccupationCode",
"serviceSpecificOccupationText",
"effectiveDate"
]
},
{
"type": "object",
"properties": {
"serviceSegmentSequence": {
"type": "integer"
},
"occupationSegmentSequence": {
"type": "integer"
},
"occupationTypeCode": {
"type": "string"
},
"occupationTypeText": {
"type": "string"
},
"dodProvidedCode": {
"type": "string"
},
"dodOccupationCode": {
"type": "string"
},
"dodOccupationText": {
"type": "string"
},
"serviceProvidedCode": {
"type": "string"
},
"serviceSpecificOccupationCode": {
"type": "string"
},
"serviceSpecificOccupationText": {
"type": "string"
},
"effectiveDate": {
"type": "string"
}
},
"required": [
"serviceSegmentSequence",
"occupationSegmentSequence",
"occupationTypeCode",
"occupationTypeText",
"dodProvidedCode",
"dodOccupationCode",
"dodOccupationText",
"serviceProvidedCode",
"serviceSpecificOccupationCode",
"serviceSpecificOccupationText",
"effectiveDate"
]
}
]
},
"payGradeRanks": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"serviceRankText": {
"type": "string"
},
"serviceRankCode": {
"type": "string"
},
"payPlanText": {
"type": "string"
},
"payPlanCode": {
"type": "string"
},
"payGradeText": {
"type": "string"
},
"payGradeCode": {
"type": "string"
},
"payGradeDate": {
"type": "string"
},
"personnelCategoryCode": {
"type": "string"
},
"episodeIdentifier": {
"type": "string"
}
},
"required": [
"serviceRankText",
"serviceRankCode",
"payPlanText",
"payPlanCode",
"payGradeText",
"payGradeCode",
"payGradeDate",
"personnelCategoryCode",
"episodeIdentifier"
]
}
]
},
"militaryServiceHistory": {
"type": "object",
"properties": {
"releaseFromActiveDutyDate": {
"type": "string"
},
"militaryServiceEpisodes": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"serviceEpisodeIdentifier": {
"type": "integer"
},
"branchOfServiceText": {
"type": "string"
},
"branchOfServiceCode": {
"type": "string"
},
"organizationText": {
"type": "string"
},
"organizationCode": {
"type": "string"
},
"episodeSequenceNumber": {
"type": "integer"
},
"periodOfServiceTypeText": {
"type": "string"
},
"periodOfServiceTypeCode": {
"type": "string"
},
"periodOfServiceBeginDate": {
"type": "string"
},
"periodOfServiceEndDate": {
"type": "string"
},
"characterOfDischargeText": {
"type": "string"
},
"characterOfDischargeCode": {
"type": "string"
},
"narrativeReasonForSeparationText": {
"type": "string"
},
"narrativeReasonForSeparationCode": {
"type": "string"
},
"narrativeReasonForSeparationFamilyText": {
"type": "string"
},
"narrativeReasonForSeparationFamilyCode": {
"type": "string"
},
"projectedDateOfSeparationCertaintyText": {
"type": "string"
},
"projectedDateOfSeparationCertaintyCode": {
"type": "string"
},
"terminationReasonText": {
"type": "string"
},
"terminationReasonCode": {
"type": "string"
},
"enlistedServiceYears": {
"type": "integer"
},
"deployments": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"deploymentSequenceNumber": {
"type": "integer"
},
"deploymentBeginDate": {
"type": "string"
},
"deploymentEndDate": {
"type": "string"
},
"deploymentProjectText": {
"type": "string"
},
"deploymentProjectCode": {
"type": "string"
},
"deploymentTerminationReasonText": {
"type": "string"
},
"deploymentTerminationReasonCode": {
"type": "string"
},
"deploymentLocations": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"deploymentLocationSequenceNumber": {
"type": "integer"
},
"deploymentCountryText": {
"type": "string"
},
"deploymentCountryCode": {
"type": "string"
},
"deploymentLocationBodyOfWaterText": {
"type": "string"
},
"deploymentLocationBodyOfWaterCode": {
"type": "string"
},
"deploymentLocationBeginDate": {
"type": "string"
},
"deploymentLocationEndDate": {
"type": "string"
},
"deploymentLocationTerminationReasonText": {
"type": "string"
},
"deploymentLocationTerminationReasonCode": {
"type": "string"
}
},
"required": [
"deploymentLocationSequenceNumber",
"deploymentCountryText",
"deploymentCountryCode",
"deploymentLocationBodyOfWaterText",
"deploymentLocationBodyOfWaterCode",
"deploymentLocationBeginDate",
"deploymentLocationEndDate",
"deploymentLocationTerminationReasonText",
"deploymentLocationTerminationReasonCode"
]
}
]
}
},
"required": [
"deploymentSequenceNumber",
"deploymentBeginDate",
"deploymentEndDate",
"deploymentProjectText",
"deploymentProjectCode",
"deploymentTerminationReasonText",
"deploymentTerminationReasonCode",
"deploymentLocations"
]
},
{
"type": "object",
"properties": {
"deploymentSequenceNumber": {
"type": "integer"
},
"deploymentBeginDate": {
"type": "string"
},
"deploymentEndDate": {
"type": "string"
},
"deploymentProjectText": {
"type": "string"
},
"deploymentProjectCode": {
"type": "string"
},
"deploymentTerminationReasonText": {
"type": "string"
},
"deploymentTerminationReasonCode": {
"type": "string"
},
"deploymentLocations": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"deploymentLocationSequenceNumber": {
"type": "integer"
},
"deploymentCountryText": {
"type": "string"
},
"deploymentCountryCode": {
"type": "string"
},
"deploymentLocationBodyOfWaterText": {
"type": "string"
},
"deploymentLocationBodyOfWaterCode": {
"type": "string"
},
"deploymentLocationBeginDate": {
"type": "string"
},
"deploymentLocationEndDate": {
"type": "string"
},
"deploymentLocationTerminationReasonText": {
"type": "string"
},
"deploymentLocationTerminationReasonCode": {
"type": "string"
}
},
"required": [
"deploymentLocationSequenceNumber",
"deploymentCountryText",
"deploymentCountryCode",
"deploymentLocationBodyOfWaterText",
"deploymentLocationBodyOfWaterCode",
"deploymentLocationBeginDate",
"deploymentLocationEndDate",
"deploymentLocationTerminationReasonText",
"deploymentLocationTerminationReasonCode"
]
},
{
"type": "object",
"properties": {
"deploymentLocationSequenceNumber": {
"type": "integer"
},
"deploymentCountryText": {
"type": "string"
},
"deploymentCountryCode": {
"type": "string"
},
"deploymentLocationBodyOfWaterText": {
"type": "string"
},
"deploymentLocationBodyOfWaterCode": {
"type": "string"
},
"deploymentLocationBeginDate": {
"type": "string"
},
"deploymentLocationEndDate": {
"type": "string"
},
"deploymentLocationTerminationReasonText": {
"type": "string"
},
"deploymentLocationTerminationReasonCode": {
"type": "string"
}
},
"required": [
"deploymentLocationSequenceNumber",
"deploymentCountryText",
"deploymentCountryCode",
"deploymentLocationBodyOfWaterText",
"deploymentLocationBodyOfWaterCode",
"deploymentLocationBeginDate",
"deploymentLocationEndDate",
"deploymentLocationTerminationReasonText",
"deploymentLocationTerminationReasonCode"
]
}
]
}
},
"required": [
"deploymentSequenceNumber",
"deploymentBeginDate",
"deploymentEndDate",
"deploymentProjectText",
"deploymentProjectCode",
"deploymentTerminationReasonText",
"deploymentTerminationReasonCode",
"deploymentLocations"
]
}
]
},
"serviceComponentCode": {
"type": "string"
},
"serviceComponentText": {
"type": "string"
}
},
"required": [
"serviceEpisodeIdentifier",
"branchOfServiceText",
"branchOfServiceCode",
"organizationText",
"organizationCode",
"episodeSequenceNumber",
"periodOfServiceTypeText",
"periodOfServiceTypeCode",
"periodOfServiceBeginDate",
"periodOfServiceEndDate",
"characterOfDischargeText",
"characterOfDischargeCode",
"narrativeReasonForSeparationText",
"narrativeReasonForSeparationCode",
"narrativeReasonForSeparationFamilyText",
"narrativeReasonForSeparationFamilyCode",
"projectedDateOfSeparationCertaintyText",
"projectedDateOfSeparationCertaintyCode",
"terminationReasonText",
"terminationReasonCode",
"enlistedServiceYears",
"deployments",
"serviceComponentCode",
"serviceComponentText"
]
},
{
"type": "object",
"properties": {
"serviceEpisodeIdentifier": {
"type": "integer"
},
"branchOfServiceText": {
"type": "string"
},
"branchOfServiceCode": {
"type": "string"
},
"organizationText": {
"type": "string"
},
"organizationCode": {
"type": "string"
},
"episodeSequenceNumber": {
"type": "integer"
},
"periodOfServiceTypeText": {
"type": "string"
},
"periodOfServiceTypeCode": {
"type": "string"
},
"periodOfServiceBeginDate": {
"type": "string"
},
"periodOfServiceEndDate": {
"type": "string"
},
"characterOfDischargeText": {
"type": "string"
},
"characterOfDischargeCode": {
"type": "string"
},
"narrativeReasonForSeparationText": {
"type": "string"
},
"narrativeReasonForSeparationCode": {
"type": "string"
},
"narrativeReasonForSeparationFamilyText": {
"type": "string"
},
"narrativeReasonForSeparationFamilyCode": {
"type": "string"
},
"projectedDateOfSeparationCertaintyText": {
"type": "string"
},
"projectedDateOfSeparationCertaintyCode": {
"type": "string"
},
"terminationReasonText": {
"type": "string"
},
"terminationReasonCode": {
"type": "string"
},
"enlistedServiceYears": {
"type": "integer"
},
"deployments": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"deploymentSequenceNumber": {
"type": "integer"
},
"deploymentBeginDate": {
"type": "string"
},
"deploymentEndDate": {
"type": "string"
},
"deploymentProjectText": {
"type": "string"
},
"deploymentProjectCode": {
"type": "string"
},
"deploymentTerminationReasonText": {
"type": "string"
},
"deploymentTerminationReasonCode": {
"type": "string"
},
"deploymentLocations": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"deploymentLocationSequenceNumber": {
"type": "integer"
},
"deploymentCountryText": {
"type": "string"
},
"deploymentCountryCode": {
"type": "string"
},
"deploymentLocationBodyOfWaterText": {
"type": "string"
},
"deploymentLocationBodyOfWaterCode": {
"type": "string"
},
"deploymentLocationBeginDate": {
"type": "string"
},
"deploymentLocationEndDate": {
"type": "string"
},
"deploymentLocationTerminationReasonText": {
"type": "string"
},
"deploymentLocationTerminationReasonCode": {
"type": "string"
}
},
"required": [
"deploymentLocationSequenceNumber",
"deploymentCountryText",
"deploymentCountryCode",
"deploymentLocationBodyOfWaterText",
"deploymentLocationBodyOfWaterCode",
"deploymentLocationBeginDate",
"deploymentLocationEndDate",
"deploymentLocationTerminationReasonText",
"deploymentLocationTerminationReasonCode"
]
}
]
}
},
"required": [
"deploymentSequenceNumber",
"deploymentBeginDate",
"deploymentEndDate",
"deploymentProjectText",
"deploymentProjectCode",
"deploymentTerminationReasonText",
"deploymentTerminationReasonCode",
"deploymentLocations"
]
}
]
},
"serviceComponentCode": {
"type": "string"
},
"serviceComponentText": {
"type": "string"
}
},
"required": [
"serviceEpisodeIdentifier",
"branchOfServiceText",
"branchOfServiceCode",
"organizationText",
"organizationCode",
"episodeSequenceNumber",
"periodOfServiceTypeText",
"periodOfServiceTypeCode",
"periodOfServiceBeginDate",
"periodOfServiceEndDate",
"characterOfDischargeText",
"characterOfDischargeCode",
"narrativeReasonForSeparationText",
"narrativeReasonForSeparationCode",
"narrativeReasonForSeparationFamilyText",
"narrativeReasonForSeparationFamilyCode",
"projectedDateOfSeparationCertaintyText",
"projectedDateOfSeparationCertaintyCode",
"terminationReasonText",
"terminationReasonCode",
"enlistedServiceYears",
"deployments",
"serviceComponentCode",
"serviceComponentText"
]
}
]
}
},
"required": [
"releaseFromActiveDutyDate",
"militaryServiceEpisodes"
]
},
"unitAssignments": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"episodeId": {
"type": "integer"
},
"personnelCategoryCode": {
"type": "string"
},
"assignmentSequence": {
"type": "integer"
},
"militaryUnitTypeCode": {
"type": "string"
},
"militaryUnitTypeText": {
"type": "string"
},
"militaryUnitCode": {
"type": "string"
},
"militaryUnitText": {
"type": "string"
},
"dodProvidedUnitCode": {
"type": "string"
},
"effectiveDate": {
"type": "string"
},
"lastUpdate": {
"type": "string"
}
},
"required": [
"episodeId",
"personnelCategoryCode",
"assignmentSequence",
"militaryUnitTypeCode",
"militaryUnitTypeText",
"militaryUnitCode",
"militaryUnitText",
"dodProvidedUnitCode",
"effectiveDate",
"lastUpdate"
]
},
{
"type": "object",
"properties": {
"episodeId": {
"type": "integer"
},
"personnelCategoryCode": {
"type": "string"
},
"assignmentSequence": {
"type": "integer"
},
"militaryUnitTypeCode": {
"type": "string"
},
"militaryUnitTypeText": {
"type": "string"
},
"militaryUnitCode": {
"type": "string"
},
"militaryUnitText": {
"type": "string"
},
"dodProvidedUnitCode": {
"type": "string"
},
"effectiveDate": {
"type": "string"
},
"lastUpdate": {
"type": "string"
}
},
"required": [
"episodeId",
"personnelCategoryCode",
"assignmentSequence",
"militaryUnitTypeCode",
"militaryUnitTypeText",
"militaryUnitCode",
"militaryUnitText",
"dodProvidedUnitCode",
"effectiveDate",
"lastUpdate"
]
},
{
"type": "object",
"properties": {
"episodeId": {
"type": "integer"
},
"personnelCategoryCode": {
"type": "string"
},
"assignmentSequence": {
"type": "integer"
},
"militaryUnitTypeCode": {
"type": "string"
},
"militaryUnitTypeText": {
"type": "string"
},
"militaryUnitCode": {
"type": "string"
},
"militaryUnitText": {
"type": "string"
},
"dodProvidedUnitCode": {
"type": "string"
},
"effectiveDate": {
"type": "string"
},
"lastUpdate": {
"type": "string"
}
},
"required": [
"episodeId",
"personnelCategoryCode",
"assignmentSequence",
"militaryUnitTypeCode",
"militaryUnitTypeText",
"militaryUnitCode",
"militaryUnitText",
"dodProvidedUnitCode",
"effectiveDate",
"lastUpdate"
]
},
{
"type": "object",
"properties": {
"episodeId": {
"type": "integer"
},
"personnelCategoryCode": {
"type": "string"
},
"assignmentSequence": {
"type": "integer"
},
"militaryUnitTypeCode": {
"type": "string"
},
"militaryUnitTypeText": {
"type": "string"
},
"militaryUnitCode": {
"type": "string"
},
"militaryUnitText": {
"type": "string"
},
"dodProvidedUnitCode": {
"type": "string"
},
"effectiveDate": {
"type": "string"
},
"lastUpdate": {
"type": "string"
}
},
"required": [
"episodeId",
"personnelCategoryCode",
"assignmentSequence",
"militaryUnitTypeCode",
"militaryUnitTypeText",
"militaryUnitCode",
"militaryUnitText",
"dodProvidedUnitCode",
"effectiveDate",
"lastUpdate"
]
},
{
"type": "object",
"properties": {
"episodeId": {
"type": "integer"
},
"personnelCategoryCode": {
"type": "string"
},
"assignmentSequence": {
"type": "integer"
},
"militaryUnitTypeCode": {
"type": "string"
},
"militaryUnitTypeText": {
"type": "string"
},
"militaryUnitCode": {
"type": "string"
},
"militaryUnitText": {
"type": "string"
},
"dodProvidedUnitCode": {
"type": "string"
},
"effectiveDate": {
"type": "string"
},
"lastUpdate": {
"type": "string"
}
},
"required": [
"episodeId",
"personnelCategoryCode",
"assignmentSequence",
"militaryUnitTypeCode",
"militaryUnitTypeText",
"militaryUnitCode",
"militaryUnitText",
"dodProvidedUnitCode",
"effectiveDate",
"lastUpdate"
]
},
{
"type": "object",
"properties": {
"episodeId": {
"type": "integer"
},
"personnelCategoryCode": {
"type": "string"
},
"assignmentSequence": {
"type": "integer"
},
"militaryUnitTypeCode": {
"type": "string"
},
"militaryUnitTypeText": {
"type": "string"
},
"militaryUnitCode": {
"type": "string"
},
"militaryUnitText": {
"type": "string"
},
"dodProvidedUnitCode": {
"type": "string"
},
"effectiveDate": {
"type": "string"
},
"lastUpdate": {
"type": "string"
}
},
"required": [
"episodeId",
"personnelCategoryCode",
"assignmentSequence",
"militaryUnitTypeCode",
"militaryUnitTypeText",
"militaryUnitCode",
"militaryUnitText",
"dodProvidedUnitCode",
"effectiveDate",
"lastUpdate"
]
},
{
"type": "object",
"properties": {
"episodeId": {
"type": "integer"
},
"personnelCategoryCode": {
"type": "string"
},
"assignmentSequence": {
"type": "integer"
},
"militaryUnitTypeCode": {
"type": "string"
},
"militaryUnitTypeText": {
"type": "string"
},
"militaryUnitCode": {
"type": "string"
},
"militaryUnitText": {
"type": "string"
},
"dodProvidedUnitCode": {
"type": "string"
},
"effectiveDate": {
"type": "string"
},
"lastUpdate": {
"type": "string"
}
},
"required": [
"episodeId",
"personnelCategoryCode",
"assignmentSequence",
"militaryUnitTypeCode",
"militaryUnitTypeText",
"militaryUnitCode",
"militaryUnitText",
"dodProvidedUnitCode",
"effectiveDate",
"lastUpdate"
]
}
]
}
},
"required": [
"militarySummary",
"militaryOccupations",
"payGradeRanks",
"militaryServiceHistory",
"unitAssignments"
]
}
},
"required": [
"militaryPerson"
]
}
},
"required": [
"messages",
"profile"
]
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/veteran_verification/keys.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
},
"properties": {
"keys": {
"type": "array",
"items": {
"properties": {
"kty": {
"type": "string"
},
"alg": {
"type": "string"
},
"kid": {
"type": "string"
},
"pem": {
"type": "string"
},
"e": {
"type": "string"
},
"n": {
"type": "string"
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/health_quest/patient.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"first_name": { "type": "string" },
"middle_initial": { "type": "string" },
"last_name": { "type": "string" }
}
},
"contact_information": {
"type": "object",
"properties": {
"mobile": { "type": "string" },
"preferred_email": { "type": "string" },
"time_zone": { "type": "string" }
}
},
"location": {
"type": "object",
"properties": {
"type": { "type": "string" },
"facility": {
"type": "object",
"properties": {
"name": { "type": "string" },
"site_code": { "type": "string" },
"time_zone": { "type": "string" }
}
}
}
},
"patient_appointment": { "type": "boolean" },
"virtual_meeting_room": {
"type": "object",
"properties": {
"conference": { "type": "string" },
"pin": { "type": "string" },
"url": { "type": "string" }
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/health_quest/cc_appointments.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data", "meta"],
"properties": {
"data": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "cc_appointment.json"
}
},
"meta": {
"type": "object",
"required": ["pagination"],
"properties": {
"pagination": {
"type": "object",
"required": ["current_page", "per_page", "total_pages", "total_entries"],
"properties": {
"current_page": { "type": "integer" },
"per_page": { "type": "integer" },
"total_pages": { "type": "integer" },
"total_entries": { "type": "integer" }
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/health_quest/cc_appointment.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["id", "type", "attributes"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["cc_appointments"] },
"attributes": {
"type": "object",
"required": [
"appointment_request_id",
"distance_eligible_confirmed",
"name",
"provider_practice",
"provider_phone",
"address",
"instructions_to_veteran",
"appointment_time",
"time_zone"
],
"properties": {
"appointment_request_id": { "type": "string" },
"distance_eligible_confirmed": { "type": "boolean" },
"name": {
"type": "object",
"required": ["first_name", "last_name"],
"properties": {
"first_name": { "type": "string" },
"last_name": { "type": "string" }
}
},
"provider_practice": { "type": "string" },
"provider_phone": { "type": "string" },
"address": {
"type": "object",
"required": ["street", "city", "state", "zip_code"],
"properties": {
"street": {"type": "string" },
"city": {"type": "string" },
"state": {"type": "string" },
"zip_code": {"type": "string" }
}
},
"instructions_to_veteran": { "type": "string" },
"appointment_time": { "type": "string" },
"time_zone": { "type": "string" }
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/health_quest/va_appointment.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["id", "type", "attributes"],
"properties": {
"id": { "type": "string" },
"type": { "type": "string", "enum": ["va_appointments"] },
"attributes": {
"type": "object",
"properties": {
"start_date": { "type": "string", "format": "date-time" },
"sta6aid": { "type": ["string", null] },
"clinic_id": { "type": ["string", null] },
"clinic_friendly_name": { "type": ["string", null] },
"facility_id": { "type": ["string", null] },
"community_care": { "type": ["boolean", null] },
"vds_appointments": {
"type": "array",
"optional": true,
"uniqueItems": true,
"items": {
"type": "object",
"properties": {
"appointment_length": { "type": ["string", null] },
"appointment_time": { "type": "string", "format": "date-time" },
"clinic": {
"type": "object",
"required": ["name", "ask_for_check_in", "facility_code"],
"properties": {
"name": { "type": "string" },
"ask_for_check_in": { "type": "boolean" },
"facility_code": { "type": "string" }
}
},
"type": { "type": "string" },
"current_status": { "type": "string" },
"booking_note": { "type": ["string", null] }
}
}
},
"vvs_appointments": {
"type": "array",
"optional": true,
"uniqueItems": true,
"items": {
"type": "object",
"properties": {
"id": { "type": "string" },
"appointment_kind": { "type": "string" },
"scheduling_request_type": { "type": "string" },
"instruction": { "type": "string" },
"invities": { "type": "array" },
"source_system": { "type": "string" },
"date_time": { "type": "string", "format": "date-time" },
"desired_date": { "type": "string", "format": "date-time" },
"duration": { "type": "integer" },
"status": {
"type": "object",
"required": ["description", "code"],
"properties": {
"description": { "type": "string" },
"code": { "type": "string" }
}
},
"type": { "type": "string" },
"booking_notes": { "type": "string" },
"instructions_other": { "type": "boolean" },
"patients": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "patient.json"
}
},
"providers": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "provider.json"
}
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/health_quest/provider.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"first_name": { "type": "string" },
"middle_initial": { "type": "string" },
"last_name": { "type": "string" }
}
},
"contact_information": {
"type": "object",
"properties": {
"mobile": { "type": "string" },
"preferred_email": { "type": "string" },
"time_zone": { "type": "string" }
}
},
"location": {
"type": "object",
"properties": {
"type": { "type": "string" },
"facility": {
"type": "object",
"properties": {
"name": { "type": "string" },
"site_code": { "type": "string" },
"time_zone": { "type": "string" }
}
},
"clinic": {
"type": "object",
"properties": {
"ien": { "type": "string" },
"name": { "type": "string" }
}
}
}
},
"virtual_meeting_room": {
"type": "object",
"properties": {
"conference": { "type": "string" },
"pin": { "type": "string" },
"url": { "type": "string" }
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/health_quest/va_appointments.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data", "meta"],
"properties": {
"data": {
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "va_appointment.json"
}
},
"meta": {
"type": "object",
"required": ["pagination"],
"properties": {
"pagination": {
"type": "object",
"required": ["current_page", "per_page", "total_pages", "total_entries"],
"properties": {
"current_page": { "type": "integer" },
"per_page": { "type": "integer" },
"total_pages": { "type": "integer" },
"total_entries": { "type": "integer" }
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vaos/facilities.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"institution_code",
"city",
"state_abbrev",
"authoritative_name",
"root_station_code",
"admin_parent",
"parent_station_code"
],
"properties": {
"institution_code": {
"type": "string"
},
"city": {
"type": "string"
},
"state_abbrev": {
"type": "string"
},
"authoritative_name": {
"type": "string"
},
"root_station_code": {
"type": "string"
},
"admin_parent": {
"type": "boolean"
},
"parent_station_code": {
"type": "string"
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vaos/cc_supported_sites.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "string" },
"type": { "type": "string" },
"attributes": {
"type": "object",
"properties": {
"name": { "type": "string" },
"timezone": { "type": "string" }
},
"required": [
"name",
"timezone"
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
}
},
"required": [
"data"
]
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vaos/patient.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"first_name": { "type": "string" },
"middle_initial": { "type": "string" },
"last_name": { "type": "string" }
}
},
"contact_information": {
"type": "object",
"properties": {
"mobile": { "type": "string" },
"preferred_email": { "type": "string" },
"time_zone": { "type": "string" }
}
},
"location": {
"type": "object",
"properties": {
"type": { "type": "string" },
"facility": {
"type": "object",
"properties": {
"name": { "type": "string" },
"site_code": { "type": "string" },
"time_zone": { "type": "string" }
}
}
}
},
"patient_appointment": { "type": "boolean" },
"virtual_meeting_room": {
"type": "object",
"properties": {
"conference": { "type": "string" },
"pin": { "type": "string" },
"url": { "type": "string" }
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vaos/cc_appointment_request.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"data_identifier",
"has_veteran_new_message",
"preferred_state",
"preferred_city",
"preferred_language",
"preferred_zip_code",
"distance_willing_to_travel",
"distance_eligible",
"office_hours",
"preferred_providers"
],
"properties": {
"data_identifier": {
"type": "object"
},
"has_veteran_new_message": {
"type": "boolean"
},
"preferred_state": {
"type": "string"
},
"preferred_city": {
"type": "string"
},
"preferred_zip_code": {
"type": "string"
},
"preferred_language": {
"type": "string"
},
"distance_willing_to_travel": {
"type": "integer"
},
"distance_eligible": {
"type": "boolean"
},
"office_hours": {
"type": "array",
"items": {
"type": "string"
}
},
"preferred_providers": {
"type": "array",
"items": {
"type": "object",
"required": [
"first_name",
"last_name",
"practice_name",
"address",
"preferred_order",
"object_type",
"link"
],
"properties": {
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"practice_name": {
"type": "string"
},
"address": {
"type": "object"
},
"preferred_order": {
"type": "integer"
},
"object_type": {
"type": "string"
},
"link": {
"type": "array"
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vaos/facilities_limits.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"number_of_requests",
"request_limit"
],
"properties": {
"number_of_requests": {
"type": "integer"
},
"request_limit": {
"type": "integer"
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vaos/system_institutions.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"location_ien",
"institution_sid",
"institution_ien",
"institution_name",
"institution_code"
],
"properties": {
"location_ien": {
"type": "string"
},
"institution_sid": {
"type": "integer"
},
"institution_ien": {
"type": "string"
},
"institution_name": {
"type": "string"
},
"institution_code": {
"type": "string"
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vaos/cc_appointments.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data", "meta"],
"properties": {
"data": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "cc_appointment.json"
}
},
"meta": {
"type": "object",
"required": ["pagination", "errors"],
"properties": {
"pagination": {
"type": "object",
"required": ["current_page", "per_page", "total_pages", "total_entries"],
"properties": {
"current_page": { "type": "integer" },
"per_page": { "type": "integer" },
"total_pages": { "type": "integer" },
"total_entries": { "type": "integer" }
}
},
"errors": {
"type": "array",
"minItems": 0,
"uniqueItems": false,
"items": {
"type": "object",
"required": ["code", "source", "summary"],
"properties": {
"code": { "type": "integer" },
"source": { "type": "string" },
"summary": { "type": "string" }
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vaos/request_eligibility_criteria.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"request_settings",
"custom_request_settings"
],
"properties": {
"request_settings": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"type_of_care",
"stop_codes",
"submitted_request_limit",
"enterprise_submitted_request_limit"
],
"properties": {
"id": {
"type": "string"
},
"type_of_care": {
"type": "string"
},
"patient_history_required": {
"type": "string"
},
"patient_history_duration": {
"type": "integer"
},
"stop_codes": {
"type": "array",
"items": {
"type": "object",
"required": [
"primary"
],
"properties": {
"primary": {
"type": "string"
}
}
}
},
"submitted_request_limit": {
"type": "integer"
},
"enterprise_submitted_request_limit": {
"type": "integer"
}
}
}
},
"custom_request_settings": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"type_of_care",
"submitted_request_limit",
"enterprise_submitted_request_limit",
"supported",
"scheduling_days"
],
"properties": {
"id": {
"type": "string"
},
"type_of_care": {
"type": "string"
},
"submitted_request_limit": {
"type": "integer"
},
"enterprise_submitted_request_limit": {
"type": "integer"
},
"supported": {
"type": "boolean"
},
"scheduling_days": {
"type": "array",
"items": {
"type": "object",
"required": [
"day",
"can_schedule"
],
"properties": {
"day": {
"type": "string"
},
"can_schedule": {
"type": "boolean"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vaos/messages.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "message.json"
}
}
},
"required": [
"data"
]
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vaos/facility_visits.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"has_visited_in_past_months",
"duration_in_months"
],
"properties": {
"has_visited_in_past_months": {
"type": "boolean"
},
"duration_in_months": {
"type": "integer"
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vaos/direct_booking_eligibility_criteria.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"core_settings"
],
"properties": {
"core_settings": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"type_of_care",
"stop_codes",
"submitted_request_limit",
"enterprise_submitted_request_limit"
],
"properties": {
"id": {
"type": "string"
},
"type_of_care": {
"type": "string"
},
"patient_history_required": {
"type": "string"
},
"patient_history_duration": {
"type": "integer"
},
"stop_codes": {
"type": "array",
"items": {
"type": "object",
"required": [
"primary"
],
"properties": {
"primary": {
"type": "string"
},
"secondary": {
"type": "string"
}
}
}
},
"can_cancel": {
"type": "boolean"
},
"submitted_request_limit": {
"type": "integer"
},
"enterprise_submitted_request_limit": {
"type": "integer"
}
}
}
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vaos/va_appointment_raw.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["id", "type", "attributes"],
"properties": {
"id": { "type": "string" },
"type": { "type": "string", "enum": ["va_appointments"] },
"attributes": {
"type": "object",
"properties": {
"start_date": { "type": "string", "format": "date-time" },
"sta6aid": { "type": ["string", null] },
"clinic_id": { "type": ["string", null] },
"clinic_friendly_name": { "type": ["string", null] },
"facility_id": { "type": ["string", null] },
"char4": { "type": ["string", null] },
"phone_only": { "type": ["boolean", null] },
"community_care": { "type": ["boolean", null] },
"vds_appointments": {
"type": "array",
"optional": true,
"uniqueItems": true,
"items": {
"type": "object",
"properties": {
"id": { "type": "string" },
"appointment_length": { "type": ["string", null] },
"appointment_time": { "type": "string", "format": "date-time" },
"clinic": {
"type": "object",
"required": ["name", "ask_for_check_in", "facility_code"],
"properties": {
"name": { "type": "string" },
"ask_for_check_in": { "type": "boolean" },
"facility_code": { "type": "string" }
}
},
"type": { "type": "string" },
"current_status": { "type": "string" },
"booking_note": { "type": ["string", null] }
}
}
},
"vvs_appointments": {
"type": "array",
"optional": true,
"uniqueItems": true,
"items": {
"type": "object",
"properties": {
"id": { "type": "string" },
"appointment_kind": { "type": "string" },
"scheduling_request_type": { "type": "string" },
"instruction": { "type": "string" },
"invities": { "type": "array" },
"source_system": { "type": "string" },
"date_time": { "type": "string", "format": "date-time" },
"desired_date": { "type": "string", "format": "date-time" },
"duration": { "type": "integer" },
"status": {
"type": "object",
"required": ["description", "code"],
"properties": {
"description": { "type": "string" },
"code": { "type": "string" }
}
},
"type": { "type": "string" },
"booking_notes": { "type": "string" },
"instructions_other": { "type": "boolean" },
"patients": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "patient.json"
}
},
"providers": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "provider.json"
}
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vaos/facility_limits.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"number_of_requests",
"request_limit"
],
"properties": {
"number_of_requests": {
"type": "integer"
},
"request_limit": {
"type": "integer"
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vaos/facility_cancel_reasons.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"number",
"text",
"type",
"inactive"
],
"properties": {
"number": {
"type": "string"
},
"text": {
"type": "string"
},
"type": {
"type": "string"
},
"inactive": {
"type": "boolean"
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vaos/cc_appointment.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["id", "type", "attributes"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["cc_appointments"] },
"attributes": {
"type": "object",
"required": [
"appointment_request_id",
"distance_eligible_confirmed",
"name",
"provider_practice",
"provider_phone",
"address",
"instructions_to_veteran",
"appointment_time",
"time_zone"
],
"properties": {
"appointment_request_id": { "type": "string" },
"distance_eligible_confirmed": { "type": "boolean" },
"name": {
"type": "object",
"required": ["first_name", "last_name"],
"properties": {
"first_name": { "type": "string" },
"last_name": { "type": "string" }
}
},
"provider_practice": { "type": "string" },
"provider_phone": { "type": "string" },
"address": {
"type": "object",
"required": ["street", "city", "state", "zip_code"],
"properties": {
"street": {"type": "string" },
"city": {"type": "string" },
"state": {"type": "string" },
"zip_code": {"type": "string" }
}
},
"instructions_to_veteran": { "type": "string" },
"appointment_time": { "type": "string" },
"time_zone": { "type": "string" }
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vaos/systems.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"unique_id",
"assigning_authority",
"assigning_code",
"id_status"
],
"properties": {
"unique_id": {
"type": "string"
},
"assigning_authority": {
"type": {
"enum": [
"ICN",
"EDIPI",
"UNKNOWN"
]
}
},
"assigning_code": {
"type": "string"
},
"id_status": {
"type": {
"enum": [
"ACTIVE",
"PERMANENT"
]
}
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vaos/cc_eligibility.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["id", "type", "attributes"],
"properties": {
"id": { "type": "string" },
"type": { "type": "string", "enum": ["cc_eligibility"] },
"attributes": {
"type": "object",
"properties": {
"eligible": { "type": "boolean" }
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vaos/appointment_requests.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"data",
"meta"
],
"properties": {
"data": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "appointment_request.json"
}
},
"meta": {
"type": "object",
"required": [
"pagination"
],
"properties": {
"pagination": {
"type": "object",
"required": [
"current_page",
"per_page",
"total_pages",
"total_entries"
],
"properties": {
"current_page": {
"type": "integer"
},
"per_page": {
"type": "integer"
},
"total_pages": {
"type": "integer"
},
"total_entries": {
"type": "integer"
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vaos/appointment_time_slot.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"required": [
"start_date_time",
"end_date_time",
"booking_status",
"remaining_allowed_over_bookings",
"availability"
],
"properties": {
"start_date_time": {
"type": "string",
"format": "date"
},
"end_date_time": {
"type": "string",
"format": "date"
},
"booking_status": {
"type": "string"
},
"remaining_allowed_over_bookings": {
"type": "string"
},
"availability": {
"type": "boolean"
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vaos/system_facilities.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"institution_code",
"city",
"state_abbrev",
"authoritative_name",
"root_station_code",
"admin_parent",
"parent_station_code",
"request_supported",
"direct_scheduling_supported",
"express_times",
"institution_timezone"
],
"properties": {
"institution_code": {
"type": "string"
},
"city": {
"type": "string"
},
"state_abbrev": {
"type": "string"
},
"authoritative_name": {
"type": "string"
},
"root_station_code": {
"type": "string"
},
"admin_parent": {
"type": "boolean"
},
"parent_station_code": {
"type": "string"
},
"request_supported": {
"type": "boolean"
},
"direct_scheduling_supported": {
"type": "boolean"
},
"express_times": {
"oneOf": [
{
"type": "null"
},
{
"type": "object",
"required": [
"start",
"end",
"timezone",
"offset_utc"
],
"properties": {
"start": {
"type": "string"
},
"end": {
"type": "string"
},
"timezone": {
"type": "string"
},
"offset_utc": {
"type": "string"
}
}
}
]
},
"institution_timezone": {
"type": ["string", "null"]
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vaos/va_appointment.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"$ref": "va_appointment_raw.json"
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vaos/appointment_request.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"last_updated_at": {
"type": "null"
},
"appointment_date": {
"type": [
"string",
null
]
},
"appointment_time": {
"type": [
"string",
null
]
},
"option_date1": {
"type": "string"
},
"option_time1": {
"type": "string"
},
"option_date2": {
"type": "string"
},
"option_time2": {
"type": "string"
},
"option_date3": {
"type": "string"
},
"option_time3": {
"type": "string"
},
"status": {
"type": "string"
},
"appointment_type": {
"type": "string"
},
"visit_type": {
"type": "string"
},
"reason_for_visit": {
"type": [
"string",
null
]
},
"additional_information": {
"type": [
"string",
null
]
},
"facility": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"facility_code": {
"type": "string"
},
"type": {
"type": [
"string",
null
]
},
"address": {
"type": [
"string",
null
]
},
"state": {
"type": [
"string",
null
]
},
"city": {
"type": [
"string",
null
]
},
"parent_site_code": {
"type": "string"
}
},
"required": [
"name",
"facility_code",
"state",
"city",
"parent_site_code"
]
},
"email": {
"type": [
"string",
null
]
},
"text_messaging_allowed": {
"type": "boolean"
},
"phone_number": {
"type": "string"
},
"purpose_of_visit": {
"type": "string"
},
"provider_id": {
"type": "string"
},
"second_request": {
"type": "boolean"
},
"second_request_submitted": {
"type": "boolean"
},
"patient": {
"type": "object",
"properties": {
"inpatient": {
"type": "boolean"
},
"text_messaging_allowed": {
"type": "boolean",
"required": false
}
},
"required": [
"inpatient",
"text_messaging_allowed"
]
},
"best_timeto_call": {
"type": "array",
"items": [
{
"type": "string"
}
]
},
"appointment_request_detail_code": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"appointment_request_detail_code_id": {
"type": "string"
},
"created_date": {
"type": "string"
},
"detail_code": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"provider_message": {
"type": "string"
},
"veteran_message": {
"type": "string"
}
},
"required": [
"code",
"provider_message",
"veteran_message"
]
}
},
"required": [
"appointment_request_detail_code_id",
"created_date",
"detail_code"
]
}
]
},
"has_veteran_new_message": {
"type": "boolean"
},
"has_provider_new_message": {
"type": "boolean"
},
"provider_seen_appointment_request": {
"type": "boolean"
},
"requested_phone_call": {
"type": "boolean"
},
"booked_appt_date_time": {
"type": [
"string",
null
]
},
"type_of_care_id": {
"type": "string"
},
"friendly_location_name": {
"type": [
"string",
null
]
},
"cc_appointment_request": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "cc_appointment_request.json"
}
]
},
"date": {
"type": "string"
},
"assigning_authority": {
"type": "string"
},
"created_date": {
"type": "string"
}
},
"required": [
"last_updated_at",
"appointment_date",
"appointment_time",
"option_date1",
"option_time1",
"option_date2",
"option_time2",
"option_date3",
"option_time3",
"status",
"appointment_type",
"visit_type",
"facility",
"email",
"text_messaging_allowed",
"phone_number",
"purpose_of_visit",
"provider_id",
"second_request",
"second_request_submitted",
"patient",
"best_timeto_call",
"appointment_request_detail_code",
"has_veteran_new_message",
"has_provider_new_message",
"provider_seen_appointment_request",
"requested_phone_call",
"booked_appt_date_time",
"type_of_care_id",
"friendly_location_name",
"date",
"assigning_authority",
"created_date"
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vaos/provider.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"first_name": { "type": "string" },
"middle_initial": { "type": "string" },
"last_name": { "type": "string" }
}
},
"contact_information": {
"type": "object",
"properties": {
"mobile": { "type": "string" },
"preferred_email": { "type": "string" },
"time_zone": { "type": "string" }
}
},
"location": {
"type": "object",
"properties": {
"type": { "type": "string" },
"facility": {
"type": "object",
"properties": {
"name": { "type": "string" },
"site_code": { "type": "string" },
"time_zone": { "type": "string" }
}
},
"clinic": {
"type": "object",
"properties": {
"ien": { "type": "string" },
"name": { "type": "string" }
}
}
}
},
"virtual_meeting_room": {
"type": "object",
"properties": {
"conference": { "type": "string" },
"pin": { "type": "string" },
"url": { "type": "string" }
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vaos/facility_clinics.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"site_code",
"clinic_id",
"clinic_name",
"clinic_friendly_location_name",
"primary_stop_code",
"secondary_stop_code",
"direct_scheduling_flag",
"display_to_patient_flag",
"institution_name",
"institution_code",
"object_type"
],
"properties": {
"site_code": {
"type": "string"
},
"clinic_id": {
"type": "string"
},
"clinic_name": {
"type": "string"
},
"clinic_friendly_location_name": {
"type": "string"
},
"primary_stop_code": {
"type": "string"
},
"secondary_stop_code": {
"type": "string"
},
"direct_scheduling_flag": {
"type": "string"
},
"display_to_patient_flag": {
"type": "string"
},
"institution_name": {
"type": "string"
},
"institution_code": {
"type": "string"
},
"object_type": {
"type": "string"
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vaos/va_appointments.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data", "meta"],
"properties": {
"data": {
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "va_appointment_raw.json"
}
},
"meta": {
"type": "object",
"required": ["pagination", "errors"],
"properties": {
"pagination": {
"type": "object",
"required": ["current_page", "per_page", "total_pages", "total_entries"],
"properties": {
"current_page": { "type": "integer" },
"per_page": { "type": "integer" },
"total_pages": { "type": "integer" },
"total_entries": { "type": "integer" }
}
},
"errors": {
"type": "array",
"minItems": 0,
"uniqueItems": false,
"items": {
"type": "object",
"required": ["code", "source", "summary"],
"properties": {
"code": { "type": "integer" },
"source": { "type": "string" },
"summary": { "type": "string" }
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vaos/system_pact.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"facility_id",
"possible_primary",
"provider_position",
"provider_sid",
"staff_name",
"team_name",
"team_purpose",
"team_sid",
"title"
],
"properties": {
"facility_id": {
"type": "string"
},
"possible_primary": {
"type": "string"
},
"provider_position": {
"type": "string"
},
"provider_sid": {
"type": "string"
},
"staff_name": {
"type": "string"
},
"team_name": {
"type": "string"
},
"team_purpose": {
"type": "string"
},
"team_sid": {
"type": "string"
},
"title": {
"type": "string"
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vaos/preferences.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"notification_frequency",
"email_allowed",
"email_address",
"text_msg_allowed"
],
"properties": {
"notification_frequency": {
"type": "string"
},
"email_allowed": {
"type": "boolean"
},
"email_address": {
"type": "string"
},
"text_msg_allowed": {
"type": "boolean"
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vaos/message.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": { "type": "string" },
"type": { "type": "string" },
"attributes": {
"type": "object",
"properties": {
"message_text": { "type": "string" },
"message_date_time": { "type": "string" },
"appointment_request_id": { "type": "string" },
"date": { "type": "string" }
},
"required": [
"message_text",
"message_date_time",
"appointment_request_id",
"date"
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vaos/facility_available_appointments.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"clinic_id",
"clinic_name",
"appointment_length",
"clinic_display_start_time",
"display_increments",
"stop_code",
"ask_for_check_in",
"max_overbooks_per_day",
"has_user_access_to_clinic",
"primary_stop_code",
"secondary_stop_code",
"list_size",
"empty",
"appointment_time_slot"
],
"properties": {
"clinic_id": {
"type": "string"
},
"clinic_name": {
"type": "string"
},
"appointment_length": {
"type": "integer"
},
"clinic_display_start_time": {
"type": "string"
},
"display_increments": {
"type": "string"
},
"stop_code": {
"type": "string"
},
"ask_for_check_in": {
"type": "boolean"
},
"max_overbooks_per_day": {
"type": "integer"
},
"has_user_access_to_clinic": {
"type": "boolean"
},
"primary_stop_code": {
"type": "string"
},
"secondary_stop_code": {
"type": "string"
},
"list_size": {
"type": "integer"
},
"empty": {
"type": "boolean"
},
"appointment_time_slot": {
"type": "array",
"items": {
"$ref": "appointment_time_slot.json"
}
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/dgi/toe_claimant_info_response.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"claimant": {
"type": "object",
"required": [],
"properties": {
"claimantId": {
"type": "number"
},
"suffix": {
"type": ["string", "null"]
},
"dateOfBirth": {
"type": ["string", "null"]
},
"firstName": {
"type": ["string", "null"]
},
"lastName": {
"type": ["string", "null"]
},
"middleName": {
"type": ["string", "null"]
},
"notificationMethod": {
"type": ["string", "null"]
},
"contactInfo": {
"type": "object",
"required": [],
"properties": {
"addressLine1": {
"type": ["string", "null"]
},
"addressLine2": {
"type": ["string", "null"]
},
"city": {
"type": ["string", "null"]
},
"zipcode": {
"type": ["string", "null"]
},
"emailAddress": {
"type": ["string", "null"]
},
"addressType": {
"type": ["string", "null"]
},
"mobilePhoneNumber": {
"type": ["string", "null"]
},
"homePhoneNumber": {
"type": ["string", "null"]
},
"countryCode": {
"type": ["string", "null"]
},
"stateCode": {
"type": ["string", "null"]
}
}
},
"preferredContact": {
"type": ["string", "null"]
}
}
},
"serviceData": {
"type": "array",
"items": {
"type": "object",
"required": [],
"properties": {
"branchOfService": {
"type": "string"
},
"beginDate": {
"type": "string"
},
"endDate": {
"type": "string"
},
"characterOfService": {
"type": "string"
},
"reasonForSeparation": {
"type": "string"
},
"exclusionPeriods": {
"type": "array",
"items": {
"type": "string"
}
},
"trainingPeriods": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"type": "object"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/dgi/eligibility_response.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"eligibility": {
"type": "array",
"items": {
"type": "object",
"required": [],
"properties": {
"veteran_is_eligible": {
"type": "boolean"
},
"chapter": {
"type": "string"
}
}
}
}
},
"type": "object"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/dgi/claimant_info_response.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"claimant": {
"type": "object",
"required": [],
"properties": {
"claimantId": {
"type": "number"
},
"suffix": {
"type": ["string", "null"]
},
"dateOfBirth": {
"type": ["string", "null"]
},
"firstName": {
"type": ["string", "null"]
},
"lastName": {
"type": ["string", "null"]
},
"middleName": {
"type": ["string", "null"]
},
"notificationMethod": {
"type": ["string", "null"]
},
"contactInfo": {
"type": "object",
"required": [],
"properties": {
"addressLine1": {
"type": ["string", "null"]
},
"addressLine2": {
"type": ["string", "null"]
},
"city": {
"type": ["string", "null"]
},
"zipcode": {
"type": ["string", "null"]
},
"emailAddress": {
"type": ["string", "null"]
},
"addressType": {
"type": ["string", "null"]
},
"mobilePhoneNumber": {
"type": ["string", "null"]
},
"homePhoneNumber": {
"type": ["string", "null"]
},
"countryCode": {
"type": ["string", "null"]
},
"stateCode": {
"type": ["string", "null"]
}
}
},
"preferredContact": {
"type": ["string", "null"]
}
}
},
"serviceData": {
"type": "array",
"items": {
"type": "object",
"required": [],
"properties": {
"branchOfService": {
"type": "string"
},
"beginDate": {
"type": "string"
},
"endDate": {
"type": "string"
},
"characterOfService": {
"type": "string"
},
"reasonForSeparation": {
"type": "string"
},
"exclusionPeriods": {
"type": "array",
"items": {
"type": "string"
}
},
"trainingPeriods": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"type": "object"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/dgi/claim_status_response.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"claimantId": {
"type": "number"
},
"claimServiceId": {
"type": "number"
},
"claimStatus": {
"type": "string"
},
"confirmationNumber": {
"type": "string"
},
"receivedDate": {
"type": "string"
}
},
"type": "object"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support/1010_forms
|
code_files/vets-api-private/spec/support/1010_forms/shared_examples/form_attachment.rb
|
# frozen_string_literal: true
require 'rails_helper'
shared_examples 'inherits the FormAttachment model' do
it 'is a FormAttachment model' do
expect(described_class::FORM_ATTACHMENT_MODEL.ancestors).to include(FormAttachment)
end
end
shared_examples 'create 1010 form attachment' do
let(:form_attachment_guid) { SecureRandom.uuid }
let(:pdf_file) do
fixture_file_upload('doctors-note.pdf', 'application/pdf')
end
let(:form_attachment_model) { described_class::FORM_ATTACHMENT_MODEL }
let(:param_namespace) { form_attachment_model.to_s.underscore.split('/').last }
let(:resource_name) { form_attachment_model.name.remove('::').snakecase }
let(:json_api_type) { resource_name.pluralize }
let(:attachment_factory_id) { resource_name.to_sym }
it 'requires params.`param_namespace`' do
empty_req_params = [nil, {}]
empty_req_params << { param_namespace => {} }
empty_req_params.each do |params|
post(:create, params:)
expect(response).to have_http_status(:bad_request)
response_body = JSON.parse(response.body)
expect(response_body['errors'].size).to eq(1)
expect(response_body['errors'][0]).to eq(
'title' => 'Missing parameter',
'detail' => "The required parameter \"#{param_namespace}\", is missing",
'code' => '108',
'status' => '400'
)
end
end
it 'requires file_data to be a file' do
params = { param_namespace => { file_data: 'not_a_file_just_a_string' } }
post(:create, params:)
expect(response).to have_http_status(:bad_request)
response_body_errors = JSON.parse(response.body)['errors']
expect(response_body_errors.size).to eq(1)
expect(response_body_errors[0]).to eq(
'title' => 'Invalid field value',
'detail' => '"String" is not a valid value for "file_data"',
'code' => '103',
'status' => '400'
)
end
def expect_form_attachment_creation
form_attachment = build(attachment_factory_id, guid: form_attachment_guid)
expect(form_attachment_model).to receive(:new) do
expect(form_attachment).to receive(:set_file_data!)
expect(form_attachment).to receive(:save!) do
form_attachment.id = 99
form_attachment
end
form_attachment
end
form_attachment
end
it 'creates a FormAttachment' do
params = { param_namespace => { file_data: pdf_file } }
expect_form_attachment_creation
post(:create, params:)
expect(response).to have_http_status(:ok)
expect(
JSON.parse(response.body)
).to eq(
{
'data' => {
'id' => '99',
'type' => json_api_type,
'attributes' => {
'guid' => form_attachment_guid
}
}
}
)
end
end
|
0
|
code_files/vets-api-private/spec/support/1010_forms
|
code_files/vets-api-private/spec/support/1010_forms/shared_examples/attachment_serializer.rb
|
# frozen_string_literal: true
require 'rails_helper'
shared_examples '1010 forms attachment serializer' do
subject { serialize(attachment, serializer_class: described_class) }
let(:expected) do
{
id: '99',
guid: '75163ba4-01a2-46f1-bdb7-4b1f307f66e4',
type: resource_name.pluralize
}
end
let(:attachment) do
build(resource_name.to_sym, id: expected[:id].to_i, guid: expected[:guid])
end
let(:data) { JSON.parse(subject)['data'] }
it 'includes the :id, :type, and :guid in the serialized attachment' do
expect(data['id']).to eq(expected[:id])
expect(data['type']).to eq(expected[:type])
expect(data['attributes']['guid']).to eq(expected[:guid])
end
end
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.