{ "opencollection": "1.0.0", "info": { "name": "Address Validation 5103 Waiver facilities API", "version": "3" }, "request": { "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "header" } }, "items": [ { "info": { "name": "facilities", "type": "folder" }, "items": [ { "info": { "name": "Bulk download information for all facilities", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox-api.va.gov/services/address-validation/{version}/facilities/all", "headers": [ { "name": "Accept", "value": "application/geo+json" } ] }, "docs": "Retrieve all available facilities in a single operation, formatted as either a GeoJSON FeatureCollection or as a CSV. Due to the complexity of the facility resource type, the CSV response contains a subset of available facility data - specifically it omits the available services, patient satisfaction, and patient wait time data." }, { "info": { "name": "Query facilities by location or IDs, with optional filters", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox-api.va.gov/services/address-validation/{version}/facilities", "params": [ { "name": "ids", "value": "", "type": "query", "description": "List of comma-separated facility IDs to retrieve in a single request. Can be combined with lat and long parameters to retrieve facilities sorted by distance from a location." }, { "name": "zip", "value": "", "type": "query", "description": "Zip code to search for facilities. More detailed zip codes can be passed in, but only the first five digits are used to determine facilities to return." }, { "name": "state", "value": "", "type": "query", "description": "State in which to search for facilities. Except in rare cases, this is two characters." }, { "name": "lat", "value": "", "type": "query", "description": "Latitude of point to search for facilities, in WGS84 coordinate reference system." }, { "name": "long", "value": "", "type": "query", "description": "Longitude of point to search for facilities, in WGS84 coordinate reference system." }, { "name": "radius", "value": "", "type": "query", "description": "Optional radial distance from specified latitude and longitude to filter facilities search in WGS84 coordinate reference system." }, { "name": "bbox[]", "value": "", "type": "query", "description": "Bounding box (longitude, latitude, longitude, latitude) within which facilities will be returned. (WGS84 coordinate reference system)" }, { "name": "visn", "value": "", "type": "query", "description": "VISN search of matching facilities." }, { "name": "type", "value": "", "type": "query", "description": "Optional facility type search filter" }, { "name": "services[]", "value": "", "type": "query", "description": "Optional facility service search filter" }, { "name": "mobile", "value": "", "type": "query", "description": "Optional facility mobile search filter" }, { "name": "page", "value": "", "type": "query", "description": "Page of results to return per paginated response." }, { "name": "per_page", "value": "", "type": "query", "description": "Number of results to return per paginated response." } ] }, "docs": "Query facilities by bounding box, latitude and longitude, state, visn, or zip code. Bounding box is specified as four `bbox[]` parameters, long1, lat1, long2, lat2. (Relative order is unimportant.)\n\nA query by latitude and longitude returns all facilities in the system, sorted by distance from that location. Providing an optional radius in miles to this query will narrow the scope of the returned facilities to those falling within the specified radius from that location.\n\nAll location queries su" }, { "info": { "name": "Retrieve a specific facility by ID", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox-api.va.gov/services/address-validation/{version}/facilities/:id", "params": [ { "name": "id", "value": "vha_688", "type": "path", "description": "Facility ID, in the form `_`, where prefix is one of \"vha\", \"vba\", \"nca\", or \"vc\", for health facility, benefits, cemetery, or vet center, respectively." } ] }, "docs": "Retrieve a specific facility by ID" }, { "info": { "name": "Bulk download of all facility IDs", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox-api.va.gov/services/address-validation/{version}/ids", "params": [ { "name": "type", "value": "", "type": "query", "description": "Optional facility type search filter" } ] }, "docs": "Retrieves all available facility IDs only" }, { "info": { "name": "Retrieve all VA health facilities reachable by driving within the specified time period", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox-api.va.gov/services/address-validation/{version}/nearby", "params": [ { "name": "lat", "value": "", "type": "query", "description": "Latitude of the location from which drive time will be calculated." }, { "name": "lng", "value": "", "type": "query", "description": "Longitude of the location from which drive time will be calculated." }, { "name": "street_address", "value": "", "type": "query", "description": "Street address of the location from which drive time will be calculated." }, { "name": "city", "value": "", "type": "query", "description": "City of the location from which drive time will be calculated." }, { "name": "state", "value": "", "type": "query", "description": "Two character state code of the location from which drive time will be calculated." }, { "name": "zip", "value": "", "type": "query", "description": "Zip code of the location from which drive time will be calculated." }, { "name": "drive_time", "value": "", "type": "query", "description": "Filter to only include facilities that are within the specified number of drive time minutes from the requested location." }, { "name": "services[]", "value": "", "type": "query", "description": "Optional facility service search filter" } ] }, "docs": "Retrieve all VA health facilities that are located within a specified drive time from a specified location based on coordinates (lat and lng). Optional filter parameters include drive_time and services[]. Address (street_address, city, state, and zip) no longer returns results.\n\nThe \"attributes\" element has information about the drive-time band that contains the requested location for each facility in the response. The values of `min_time` and `max_time` are in minutes. For example, a facility r" }, { "info": { "name": "Retrieve a specific facility by ID", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox-api.va.gov/services/address-validation/{version}/facilities/:facilityId", "params": [ { "name": "facilityId", "value": "vha_688", "type": "path", "description": "Facility ID, in the form `_`, where prefix is one of \"vha\", \"vba\", \"nca\", or \"vc\", for health facility, benefits, cemetery, or vet center, respectively." } ] }, "docs": "Retrieve a specific facility by ID" }, { "info": { "name": "Query a specific facility service using a service ID and a facility ID.", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox-api.va.gov/services/address-validation/{version}/facilities/:facilityId/services/:serviceId", "params": [ { "name": "facilityId", "value": "vha_688", "type": "path", "description": "Facility ID, in the form `_`, where prefix is one of \"vha\", \"vba\", \"nca\", or \"vc\", for health facility, benefits, cemetery, or vet center, respectively." }, { "name": "serviceId", "value": "covid19Vaccine", "type": "path", "description": "Service ID, unique identifier for service" } ] }, "docs": "Query facility services using service parameter. Simply provide the service like `services/cardiology`. \n\nResults are paginated. JSON responses include pagination information in the standard JSON API \"links\" and \"meta\" elements. \n\nYou may optionally specify `page` and `per_page` with any query. " }, { "info": { "name": "Retrieve all services for a given facility", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox-api.va.gov/services/address-validation/{version}/facilities/:facilityId/services", "params": [ { "name": "facilityId", "value": "vha_688", "type": "path", "description": "Facility ID, in the form `_`, where prefix is one of \"vha\", \"vba\", \"nca\", or \"vc\", for health facility, benefits, cemetery, or vet center, respectively." }, { "name": "serviceIds", "value": "covid19Vaccine", "type": "query", "description": "Comma separated list of `serviceIds` can be used alongside or independently of `serviceType`" }, { "name": "serviceType", "value": "health", "type": "query", "description": "Type of service can be used alongside or independently of `serviceIds`" } ] }, "docs": "Queries for services associated with a facility. Supports optional search parameters to narrow the results. By default, all services for the given facility will be returned. A search may specify a comma separated list of service ids to include by using the `serviceIds` parameter. The type of services (e.g. \"health\", \"benefits\", etc) may be specified in the `type` parameter.\n\n\nResults are paginated. JSON responses include pagination information in the standard JSON API \"links\" and \"meta\" elements" } ] } ], "bundled": true }