Background

This API provides information about physical VA facilities. Information available includes geographic location, address, phone, hours of operation, and available services.

VA operates several different types of facilities, the types represented in this API include:

  • Health facilities
  • Benefits facilities
  • Cemeteries
  • Vet Centers

Authentication

All API requests require that you pass along a token you receive after signing up and being approved, including it as an HTTP header with name "apikey".

Response Formats

Clients may request several response formats by setting the `Accept` header.

  • application/json - The default JSON response format complies with JSON API.
  • application/geo+json - GeoJSON-compliant format, representing each facility as a Feature with a Point geometry.
  • text/csv - Available for the bulk download operation only.

Depending on the API request made, you can expect different results with your API response.

Response Elements

Some data elements within the response are only present for facilities of a given type.

  • The patient satisfaction scores contained in the `satisfaction` element are only applicable to VA health facilities.
  • The patient wait time values contained in the `wait_times` element are only applicable to VA health facilities.
  • The list of available services in the `services` element is only applicable to VA health and benefits facilities.

VA Facilities API Documentation

This is the interactive documentation for the VA Facilities API, providing a hands-on way to explore what is possible when makng requests to the API, and what to expect with responses. This documentation is driven by the OpenAPI specification, which provides a machine readable contract for the VA Facilities API.

Definitions

We provide machine readable definitions for our APIs, allowing you to import into the service or tooling of your choice.

OpenAPI

Postman

Feel free to submit a pull request for these API definitions using GitHub, or submit an issue when you see something incomplete.

Support

We provide three ways in which you can receive support for this API, and have your questions answered as you are working to integrate it into your web or mobile application.

GitHub Issue

Twitter

Email

If your question is of the private nature please email us, for all other inquires please submit as GitHub issue if possible, so that others can learn from your question to.

Road Map

This is where we provdie insight into what the future holds for this API, what current issues we are working on, and what has changed in the past work on this API.

Road Map:

  • Road Map Entry (2018/10/20) - These are the details for this road map entry, explaining what it is all about..
  • Road Map Entry (2018/10/20) - These are the details for this road map entry, explaining what it is all about..
  • Road Map Entry (2018/10/20) - These are the details for this road map entry, explaining what it is all about..

Issues:

  • Issue Entry (2018/09/10) - These are the details for this road map entry, explaining what it is all about..

Change Log:

  • Change Log Entry (2017/10/20) - These are the details for this road map entry, explaining what it is all about..
  • Change Log Entry (2017/10/20) - These are the details for this road map entry, explaining what it is all about..
  • Change Log Entry (2017/10/20) - These are the details for this road map entry, explaining what it is all about..

References

These are some relevant links regarding the use of this API, and the standards it supports.

  • GeoJSON Format - GeoJSON is a format for encoding a variety of geographic data structures.
  • JSON API Format - JSON API the specification we use for how a client should request that resources be fetched or modified, and how a server should respond to those requests.
  • OpenAPI - The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.
  • Postman Collections - Postman Collections are machine readable formats of saved API requests you can organize into folders, and use in the Postman client.