{"openapi":"3.0.1","info":{"title":"VA Facilities","description":"## Background\n\nThe VA Facilities API version 1 (v1) provides information about VA facilities, including locations, addresses, phone numbers, hours of operation, and available services.\n\nVA operates several different types of facilities. This API gives information about:\n- Health facilities (vha)\n- Benefits facilities (vba)\n- Cemeteries (nca)\n- Vet Centers (vc)\n\n## Technical Overview\n\nHealth service data for v1 of this API is based on both real-time and historical data.\n\n- Historical data is returned for the previous 30 days. Data is based on both pending and completed appointments for a given facility.\n- Service-related data may be added, removed, or modified by an authorized individual at the data facility. These data changes are available to v1 of this API in real time.\n\n\n### Authentication and authorization\n\nAPI requests are authorized with an API key provided in an HTTP header named apikey.\n\n### Test data\n\nTest data for the sandbox environment is only for testing the API and is not guaranteed to be up-to-date. After testing this API in sandbox, you can start the process of moving to production.\n\n### Facility ID formats\n\nA facility ID has the format prefix_stationNumber. The prefix is nca, vc, vba, or vha. Cemeteries may be VA national cemeteries or non-national; non-national cemeteries have the station number prefixed with an s. There are no other constraints on the format. Some facility ID examples are:\n- Health: `vha_402GA`\n- Benefits: `vba_539GB`\n- National cemetery: `nca_063`\n- Non-national cemetery: `nca_s1082`\n- Vet Center: `vc_0872MVC`\n\n\n### Service Ids\n\nServices within the API are identified with a unique `serviceId` which are used by some endpoints. These identifiers will never change. To see all service ids currently active, use the `/facilities` endpoint to return a listing of all facilities in the API. The service ids can be found in the `services` section of the results\n\n\n### Mobile Facilities\n\nThe mobile health facilities move regularly within a region. If a facility comes back from this API with \"mobile\": \"true\", the latitude/longitude and address could be inaccurate. To get the exact current location, please call the mobile facility number listed.","contact":{"name":"developer.va.gov"},"version":"1.0.0"},"tags":[{"name":"facilities","description":"VA Facilities API"}],"paths":{"/facilities":{"get":{"tags":["facilities"],"summary":"Query facilities based on optional parameters such as location or ID.","description":"Query facilities with a combination of optional search parameters.\n\n- A query with no search parameters will return all facilities in the response. \n\n- A query by bounding box returns all facilities within a geographic area bounded by the given positions. The ordering of the coordinate pairs may be in any order. \n\n- A query by latitude and longitude returns all facilities matching other given parameters, sorted by distance from that location. If either `lat` or `long` are supplied, both must be given. 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. Radius may only be supplied if both lat and long are present.\n\n- If one wishes to only get facilities with specific ids, simply include a comma separated list like `?facilityIds=id1,id2`. When requesting multiple facilities by ID, the API will return as many results as it can find matches for given other included parameters, omitting ids where there is no match. As per the JSON API specification, unrecognized IDs will not result in a returned error but rather simply not return a result for that ID. Clients may supply IDs up to the limit their HTTP client enforces for URI path lengths. (Usually 2048 characters.)\n\n- Results are paginated. The default page size is 10. Pagination can be modified by specifying `page` and/or `per_page` parameters up to a maximum page size of 1000. JSON responses include pagination information in the standard JSON API  \"links\" and \"meta\" elements. \n\n","operationId":"GET:/facilities","parameters":[{"name":"facilityIds","in":"query","description":"List of comma separated ids. When searching by multiple IDs, the API will return as many matches as it can find given any other parameters. If there isn't a match, the API will omit the ID. As per the JSON:API specification, unrecognized IDs will not result in a returned error but rather simply not return a result for that ID. Clients may supply IDs up to the limit their HTTP client enforces for URI path lengths. (Usually 2048 characters.)","style":"form","schema":{"type":"array","items":{"type":"string"}},"examples":{"facilityIds":{"description":"facilityIds","value":["vha_688","vha_644"]}}},{"name":"zip","in":"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.","schema":{"type":"string","format":"##### or #####-####"},"examples":{"zip":{"description":"zip","value":"80301-1000"}}},{"name":"state","in":"query","description":"State in which to search for facilities. Except in rare cases, this is two characters.","schema":{"type":"string","format":"XX"},"examples":{"state":{"description":"state","value":"CO"}}},{"name":"lat","in":"query","description":"Latitude of point to search for facilities, in WGS84 coordinate reference system. Lat + long returns all facilities matching other given parameters, sorted by distance from that location. Must be accompanied by a valid longitude.","schema":{"type":"number","format":"float"},"examples":{"coordinates":{"description":"coordinates","value":56.7}}},{"name":"long","in":"query","description":"Longitude of point to search for facilities, in WGS84 coordinate reference system. Lat + long returns all facilities matching other given parameters, sorted by distance from that location. Must be accompanied by a valid latitude.","style":"form","schema":{"type":"number","format":"float"},"examples":{"coordinates":{"description":"coordinates","value":-123.4}}},{"name":"radius","in":"query","description":"Optional radial distance from specified latitude and longitude to filter facilities search in WGS84 coordinate reference system. Must be accompanied by a valid latitude and longitude.","style":"form","schema":{"type":"number","format":"float"},"examples":{"distance":{"description":"distance","value":75}}},{"name":"bbox[]","in":"query","description":"Four `bbox[]` parameters, long1, lat1, long2, lat2. (WGS84 coordinate reference system)  A query by bounding box returns all facilities within a geographic area bounded by the given positions. The ordering of the coordinate pairs may be in any order. ","style":"form","schema":{"maxItems":4,"minItems":4,"type":"array","items":{"type":"number","format":"float"}},"examples":{"bbox":{"description":"bbox","value":[-105.4,39.4,-104.5,40.1]}}},{"name":"visn","in":"query","description":"VISN search of matching facilities.","schema":{"type":"number"}},{"name":"type","in":"query","description":"Type of facility location","schema":{"type":"string","enum":["health","cemetery","benefits","vet_center"]}},{"name":"services[]","in":"query","description":"List of services a facility offers","style":"form","schema":{"type":"array","items":{"type":"string"}}},{"name":"mobile","in":"query","description":"Boolean flag to include or exclude mobile facilities","schema":{"type":"boolean"},"examples":{"mobile":{"description":"mobile","value":"True"}}},{"name":"page","in":"query","description":"Page of results to return per paginated response.","schema":{"type":"integer","format":"int64","default":1}},{"name":"per_page","in":"query","description":"Number of results to return per paginated response. ","schema":{"type":"integer","format":"int64","default":10}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacilitiesResponse"}}}},"401":{"description":"Authorization information not provided","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"No API key found in request"}}}}},"403":{"description":"Invalid authorization","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"You cannot consume this service"}}}}},"406":{"description":"Requested format unacceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Payload too large","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Request size limit exceeded"}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"API rate limit exceeded"}}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"The server took too long to respond"}}}}}}}},"/facilities/{facilityId}":{"get":{"tags":["facilities"],"summary":"Retrieve a specific facility by ID","operationId":"GET:/facilities/{facilityId}","parameters":[{"name":"facilityId","in":"path","description":"Facility ID, in the form `<prefix>_<station>`, where prefix is one of \"vha\", \"vba\", \"nca\", or \"vc\", for health facility, benefits, cemetery, or vet center, respectively.","required":true,"schema":{"type":"string"},"example":"vha_688"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacilityReadResponse"}}}},"400":{"description":"Bad request - invalid or missing query parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Authorization information not provided","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"No API key found in request"}}}}},"403":{"description":"Invalid authorization","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"You cannot consume this service"}}}}},"404":{"description":"Facility not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"Requested format unacceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Payload too large","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Request size limit exceeded"}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"API rate limit exceeded"}}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"The server took too long to respond"}}}}}}}},"/ids":{"get":{"tags":["facilities"],"summary":"Bulk download of all facility IDs","description":"Retrieves all available facility IDs only","operationId":"GET:/ids","parameters":[{"name":"type","in":"query","description":"Optional facility type search filter","schema":{"type":"string","enum":["health","cemetery","benefits","vet_center"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacilitiesIdsResponse"}}}},"401":{"description":"Authorization information not provided","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"No API key found in request"}}}}},"403":{"description":"Invalid authorization","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"You cannot consume this service"}}}}},"406":{"description":"Requested format unacceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Payload too large","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Request size limit exceeded"}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"API rate limit exceeded"}}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"The server took too long to respond"}}}}}}}},"/nearby":{"get":{"tags":["facilities"],"summary":"Retrieve all VA health facilities reachable by driving within the specified time period","description":"Retrieve all VA health facilities that are located within a specified drive time from a specified location based on coordinates (`lat` and `long`). Optional filter parameters include `drive_time` and `services[]`. \n\nResults of this operation are paginated. Pagination can be modified by specifying `page` and/or `per_page` parameters. Responses include pagination information in the standard JSON API \"links\" and \"meta\" elements. \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 returned with a matched `min_time` of 10 and `max_time` of 20 is a 10 to 20 minute drive from the requested location.\n\nTo retrieve full details for nearby facilities, see the documentation for `/facilities?ids`.","operationId":"GET:/nearby","parameters":[{"name":"lat","in":"query","description":"Latitude of the location from which drive time will be calculated.","schema":{"type":"number","format":"float"},"examples":{"coordinates":{"description":"coordinates","value":56.7}}},{"name":"long","in":"query","description":"Longitude of the location from which drive time will be calculated.","style":"form","schema":{"type":"number","format":"float"},"examples":{"coordinates":{"description":"coordinates","value":-123.4}}},{"name":"drive_time","in":"query","description":"Filter to only include facilities that are within the specified number of drive time minutes from the requested location.","schema":{"type":"integer","format":"int32","default":90,"enum":[10,20,30,40,50,60,70,80,90]}},{"name":"services[]","in":"query","description":"Optional facility service search filter","style":"form","schema":{"type":"array","items":{"type":"string"}}},{"name":"page","in":"query","description":"Page of results to return per paginated response.","schema":{"type":"integer","format":"int32","default":1}},{"name":"per_page","in":"query","description":"Number of results to return per paginated response.","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NearbyResponse"}}}},"400":{"description":"Missing Required Or Ambiguous Parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"}}}},"401":{"description":"Authorization information not provided","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"No API key found in request"}}}}},"403":{"description":"Invalid authorization","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"You cannot consume this service"}}}}},"406":{"description":"Requested format unacceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Payload too large","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Request size limit exceeded"}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"API rate limit exceeded"}}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"The server took too long to respond"}}}}}}}},"/facilities/{facilityId}/services/{serviceId}":{"get":{"tags":["facilities"],"summary":"Query a specific facility service using a service ID and a facility ID.","description":"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. ","operationId":"GET:/facilities/{facilityId}/services/{serviceId}","parameters":[{"name":"facilityId","in":"path","description":"Facility ID, in the form `<prefix>_<station>`, where prefix is one of \"vha\", \"vba\", \"nca\", or \"vc\", for health facility, benefits, cemetery, or vet center, respectively.","required":true,"schema":{"type":"string"},"example":"vha_688"},{"name":"serviceId","in":"path","description":"Service ID, unique identifier for service","required":true,"schema":{"type":"string"},"example":"covid19Vaccine"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetailedServiceResponse"}}}},"400":{"description":"Bad request - invalid or missing query parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Authorization information not provided","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"No API key found in request"}}}}},"403":{"description":"Invalid authorization","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"You cannot consume this service"}}}}},"404":{"description":"Facility not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"Requested format unacceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Payload too large","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Request size limit exceeded"}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"API rate limit exceeded"}}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"The server took too long to respond"}}}}}}}},"/facilities/{facilityId}/services":{"get":{"tags":["facilities"],"summary":"Retrieve all services for a given facility","description":"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. \n\n\n\n### Parameter combinations\nYou may optionally specify `page` and `per_page` with any query. You can query with any combination of the following: \n\n- `serviceIds`\n\n- `serviceType`\n\nBoth parameters are optional, and both may be used independently of each other or not at all.","operationId":"GET:/facilities/{facilityId}/services","parameters":[{"name":"facilityId","in":"path","description":"Facility ID, in the form `<prefix>_<station>`, where prefix is one of \"vha\", \"vba\", \"nca\", or \"vc\", for health facility, benefits, cemetery, or vet center, respectively.","required":true,"schema":{"type":"string"},"example":"vha_688"},{"name":"serviceIds","in":"query","description":"Comma separated list of `serviceIds` can be used alongside or independently of `serviceType`","schema":{"type":"array","items":{"type":"string"}},"example":"covid19Vaccine"},{"name":"serviceType","in":"query","description":"Type of service can be used alongside or independently of `serviceIds`","schema":{"type":"string"},"example":"health"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetailedServicesResponse"}}}},"400":{"description":"Bad request - invalid or missing query parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Authorization information not provided","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"No API key found in request"}}}}},"403":{"description":"Invalid authorization","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"You cannot consume this service"}}}}},"404":{"description":"Facility not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"Requested format unacceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Payload too large","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Request size limit exceeded"}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"API rate limit exceeded"}}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"The server took too long to respond"}}}}}}}}},"components":{"schemas":{"Address":{"type":"object","properties":{"address1":{"type":"string","description":"Street name and number.","nullable":true,"example":"50 Irving Street, Northwest"},"address2":{"type":"string","description":"Second line of address if applicable (such as a building number).","nullable":true,"example":"Bldg 2"},"address3":{"type":"string","description":"Third line of address if applicable (such as a unit or suite number).","nullable":true,"example":"Suite 7"},"zip":{"type":"string","description":"Postal (ZIP) code.","nullable":true,"example":"20422-0001"},"city":{"type":"string","description":"City name.","nullable":true,"example":"Washington"},"state":{"type":"string","description":"State code.","nullable":true,"example":"DC"}},"description":"Description of an address.","nullable":true},"Addresses":{"type":"object","properties":{"mailing":{"$ref":"#/components/schemas/Address"},"physical":{"$ref":"#/components/schemas/Address"}},"description":"Collection of addresses associated with a facility.","nullable":true},"Distance":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of facility.","example":"vc_0101V"},"distance":{"type":"number","description":"Distance to facility in decimal format.","example":54.13}},"description":"Distance to facility in miles using decimal format. Used when querying for facilities proximal to a location. ","example":54.13},"FacilitiesMetadata":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/Pagination"},"distances":{"type":"array","items":{"$ref":"#/components/schemas/Distance"}}},"description":"Metadata representation for data in response. This metadata includes paginated items that allow user to see the current page, objects perPage, total pages and total entries."},"FacilitiesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Facility"}},"links":{"$ref":"#/components/schemas/PageLinks"},"meta":{"$ref":"#/components/schemas/FacilitiesMetadata"}},"description":"An object describing one or more VA facilities"},"Facility":{"type":"object","properties":{"id":{"type":"string","description":"Identifier representing facility.","example":"vha_688"},"type":{"type":"string","description":"Top level facility type.","example":"va_facilities","enum":["va_facilities"]},"attributes":{"$ref":"#/components/schemas/FacilityAttributes"}},"description":"Representation of a Facility."},"FacilityAttributes":{"required":["operatingStatus"],"type":"object","properties":{"name":{"type":"string","description":"Name associated with given facility.","example":"Washington VA Medical Center"},"facilityType":{"type":"string","description":"One of facility top-level type categories (e.g.) health, benefits, cemetery and vet center.","example":"va_health_facility","enum":["va_benefits_facility","va_cemetery","va_health_facility","vet_center"]},"classification":{"type":"string","description":"Subtype of facility which can further be used to describe facility.","nullable":true,"example":"VA Medical Center (VAMC)"},"parent":{"$ref":"#/components/schemas/Parent"},"website":{"type":"string","description":"Web address of facility","nullable":true,"example":"http://www.washingtondc.va.gov"},"lat":{"type":"number","description":"Facility latitude.","format":"float","example":38.9311137},"long":{"type":"number","description":"Facility longitude.","format":"float","example":-77.0109110499999},"timeZone":{"type":"string","description":"Facility time zone.","format":"String","example":"America/New_York"},"address":{"$ref":"#/components/schemas/Addresses"},"phone":{"$ref":"#/components/schemas/Phone"},"hours":{"$ref":"#/components/schemas/Hours"},"operationalHoursSpecialInstructions":{"type":"array","description":"Additional information about a VA health or Vet Center facility's operating hours.","nullable":true,"example":["More hours are available for some services.","If you need to talk to someone, call the Vet Center at 1-877-927-8387.","Vet Center hours are dependent upon outreach assignments."],"items":{"type":"string","description":"Additional information about a VA health or Vet Center facility's operating hours.","nullable":true,"example":"[\"More hours are available for some services.\",\"If you need to talk to someone, call the Vet Center at 1-877-927-8387.\",\"Vet Center hours are dependent upon outreach assignments.\"]"}},"services":{"$ref":"#/components/schemas/Services"},"satisfaction":{"$ref":"#/components/schemas/Satisfaction"},"mobile":{"type":"boolean","nullable":true,"example":false},"operatingStatus":{"$ref":"#/components/schemas/OperatingStatus"},"visn":{"type":"string","nullable":true,"example":"20"},"healthCareSystem":{"$ref":"#/components/schemas/HealthCareSystem"}},"description":"Details describing a facility.","nullable":true},"HealthCareSystem":{"type":"object","properties":{"name":{"type":"string","description":"Name of the health care system.","nullable":true}},"description":"Health Care System of the facility","nullable":true},"Hours":{"type":"object","properties":{"monday":{"type":"string","description":"Hours of operation for Monday.","nullable":true,"example":"9AM-5PM"},"tuesday":{"type":"string","description":"Hours of operation for Tuesday.","nullable":true,"example":"9AM-5PM"},"wednesday":{"type":"string","description":"Hours of operation for Wednesday.","nullable":true,"example":"9AM-5PM"},"thursday":{"type":"string","description":"Hours of operation for Thursday.","nullable":true,"example":"9AM-5PM"},"friday":{"type":"string","description":"Hours of operation for Friday.","nullable":true,"example":"9AM-5PM"},"saturday":{"type":"string","description":"Hours of operation for Saturday.","nullable":true,"example":"Closed"},"sunday":{"type":"string","description":"Hours of operation for Sunday.","nullable":true,"example":"Closed"}},"description":"Standard hours of operation. Currently formatted as descriptive text suitable for display, with no guarantee of a standard parseable format. Hours of operation may vary due to holidays or other events.","nullable":true,"example":"\"monday\": \"9:30AM-4:00PM\","},"OperatingStatus":{"required":["code"],"type":"object","properties":{"code":{"type":"string","description":"Status codes indicate normal hours/services, limited hours/services, closed operations, or published facility notices for visitors.","nullable":true,"example":"NORMAL","enum":["NORMAL","NOTICE","LIMITED","CLOSED","TEMPORARY_CLOSURE","TEMPORARY_LOCATION","VIRTUAL_CARE","COMING_SOON"]},"additionalInfo":{"type":"string","description":"Details of facility notices for visitors, such as messages about parking lot closures or floor visitation information.","nullable":true},"supplementalStatus":{"type":"array","description":"List of supplemental statuses for VA facility.","nullable":true,"items":{"$ref":"#/components/schemas/SupplementalStatus"}}},"description":"Current status of facility operations. The overall status of the facility, which can be: Normal Hours and Services, Facility Notice, Limited Hours and/or Services, or Closed. This field replaces active_status.","nullable":true,"example":"NORMAL"},"PageLinks":{"type":"object","properties":{"related":{"type":"string","description":"Link to related pages of response.","nullable":true,"example":"https://api.va.gov/services/va_facilities/v1/facilities?id=vha_688"},"self":{"type":"string","description":"Link to current page of response.","nullable":true,"example":"https://api.va.gov/services/va_facilities/v1/facilities?type=health&page=1&per_page=1000"},"first":{"type":"string","description":"Link to first page of response.","nullable":true,"example":"https://api.va.gov/services/va_facilities/v1/facilities?type=health&page=1&per_page=1000"},"prev":{"type":"string","description":"Link to previous page of response.","nullable":true,"example":"https://api.va.gov/services/va_facilities/v1/facilities?type=health&page=1&per_page=1000"},"next":{"type":"string","description":"Link to next page of response.","nullable":true,"example":"https://api.va.gov/services/va_facilities/v1/facilities?type=health&page=2&per_page=1000"},"last":{"type":"string","description":"Link to last page of response.","nullable":true,"example":"https://api.va.gov/services/va_facilities/v1/facilities?type=health&page=4&per_page=1000"}},"description":"Links for first page, next page, previous and last page of response."},"Pagination":{"type":"object","properties":{"currentPage":{"type":"integer","description":"Current page of response.","format":"int32","example":1},"perPage":{"type":"integer","description":"Number of results per page.","format":"int32","example":20},"totalPages":{"type":"integer","description":"Total number of pages matching this query.","format":"int32","example":250},"totalEntries":{"type":"integer","description":"Total number of entries matching this query.","format":"int32","example":2162}},"description":"Pagination data reflecting response that has been seperated into discrete pages."},"Parent":{"type":"object","properties":{"id":{"type":"string","description":"Parent facility id","nullable":true,"example":"vha_402"},"link":{"type":"string","description":"URL for an API request for parent facility","nullable":true,"example":"https://api.va.gov/services/va_facilities/v0/facilities/vha_402"}},"description":"Reference to facility's parent","nullable":true},"PatientSatisfaction":{"type":"object","properties":{"primaryCareUrgent":{"type":"number","description":"Percentage of Veterans who say they usually or always get an appointment when they need urgent attention at a primary care location. NOTE: Veterans are rating their satisfaction of getting an appointment for an urgent primary care visit, NOT an urgent care visit.","format":"float","nullable":true,"example":0.85},"primaryCareRoutine":{"type":"number","description":"Percentage of Veterans who say they usually or always get an appointment when they need routine attention at a primary care location. NOTE: Veterans are rating their satisfaction of getting an appointment for a routine primary care visit.","format":"float","nullable":true,"example":0.85},"specialtyCareUrgent":{"type":"number","description":"Percentage of Veterans who say they usually or always get an appointment when they need urgent attention at a specialty care location. NOTE: Veterans are rating their satisfaction of getting an appointment for an urgent specialty care visit, NOT an urgent care visit.","format":"float","nullable":true,"example":0.85},"specialtyCareRoutine":{"type":"number","description":"Percentage of Veterans who say they usually or always get an appointment when they need routine attention at a specialty care location. NOTE: Veterans are rating their satisfaction of getting an appointment for a routine specialty care visit.","format":"float","nullable":true,"example":0.85}},"description":"Veteran-reported satisfaction score for health care services at VA health facilities.","nullable":true},"Phone":{"type":"object","properties":{"fax":{"type":"string","description":"Phone number used for faxing to given facility.","nullable":true,"example":"202-555-1212"},"main":{"type":"string","description":"Phone number for given facility.","nullable":true,"example":"512-325-1255"},"healthConnect":{"type":"string","description":"Phone number for VA Health Connect.","nullable":true,"example":"312-122-4516"},"pharmacy":{"type":"string","description":"Phone number for pharmacy for given facility.","nullable":true,"example":"202-555-1212"},"afterHours":{"type":"string","description":"Phone number that may be reached outside of operating hours for given facility.","nullable":true,"example":"202-555-1212"},"patientAdvocate":{"type":"string","description":"Phone number for patient advocate for given facility.","nullable":true,"example":"202-555-1212"},"mentalHealthClinic":{"type":"string","description":"Phone number for mental health clinic for given facility.","nullable":true,"example":"202-555-1212"},"enrollmentCoordinator":{"type":"string","description":"Phone number for enrollment coordinator for given facility.","nullable":true,"example":"202-555-1212"}},"description":"Collection of all telephone contact numbers for given facility. ","nullable":true,"example":"1-800-827-1000"},"Satisfaction":{"type":"object","properties":{"health":{"$ref":"#/components/schemas/PatientSatisfaction"},"effectiveDate":{"type":"string","format":"date","nullable":true,"example":"2018-01-01"}},"description":"Scores that indicate patient satisfaction at given facility per service.","nullable":true},"ServiceBenefitsService":{"type":"object","properties":{"name":{"type":"string","description":"Name of facility service.","nullable":true,"example":"Example Service Name"},"serviceId":{"type":"string","description":"Unique identifier for facility service.","nullable":true,"example":"exampleServiceId"},"link":{"type":"string","description":"Fully qualified link for facility service.","nullable":true,"example":"http://api.va.gov/services/va_facilities/v1/facilities/vha_558GA/services/covid19Vaccine"}},"description":"Service info block."},"ServiceHealthService":{"type":"object","properties":{"name":{"type":"string","description":"Name of facility service.","nullable":true,"example":"Example Service Name"},"serviceId":{"type":"string","description":"Unique identifier for facility service.","nullable":true,"example":"exampleServiceId"},"link":{"type":"string","description":"Fully qualified link for facility service.","nullable":true,"example":"http://api.va.gov/services/va_facilities/v1/facilities/vha_558GA/services/covid19Vaccine"}},"description":"Service info block."},"ServiceOtherService":{"type":"object","properties":{"name":{"type":"string","description":"Name of facility service.","nullable":true,"example":"Example Service Name"},"serviceId":{"type":"string","description":"Unique identifier for facility service.","nullable":true,"example":"exampleServiceId"},"link":{"type":"string","description":"Fully qualified link for facility service.","nullable":true,"example":"http://api.va.gov/services/va_facilities/v1/facilities/vha_558GA/services/covid19Vaccine"}},"description":"Service info block."},"Services":{"type":"object","properties":{"health":{"type":"array","description":"List of health service objects for given facility.","nullable":true,"items":{"$ref":"#/components/schemas/ServiceHealthService"}},"benefits":{"type":"array","description":"List of benefits service objects for given facility.","nullable":true,"items":{"$ref":"#/components/schemas/ServiceBenefitsService"}},"other":{"type":"array","description":"List of benefits service objects for given facility.","nullable":true,"items":{"$ref":"#/components/schemas/ServiceOtherService"}},"link":{"type":"string","description":"Base services link for services at facility.","nullable":true,"example":"http://api.va.gov/services/va_facilities/v1/facilities/vha_558GA/services/"},"lastUpdated":{"type":"string","description":"Date of the most recent change in offered services.","format":"date","nullable":true,"example":"2018-01-01"}},"description":"All services offered by a VA facility grouped by service type.","nullable":true},"SupplementalStatus":{"required":["id","label"],"type":"object","properties":{"id":{"type":"string","description":"Unique id for supplemental status.","example":"COVID_LOW"},"label":{"type":"string","description":"Descriptive label for supplemental status.","example":"COVID-19 health protection guidelines: Levels low"}},"description":"Supplemental status for VA facility.","nullable":true},"GenericError":{"type":"object","properties":{"message":{"type":"string","example":"Detailed Error Message"}},"description":"A general error json response for things like Authorization Errors or Bad Requests (ex. invalid parameter values)."},"ApiError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"}}},"description":"API invocation or processing error"},"ErrorMessage":{"type":"object","properties":{"title":{"type":"string","example":"Error title"},"detail":{"type":"string","example":"Detailed error message"},"code":{"type":"string","example":"103"},"status":{"type":"string","example":"400"}}},"FacilityReadResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Facility"}},"description":"An object containing facility data."},"FacilitiesIdsResponse":{"type":"object","properties":{"data":{"type":"array","description":"List of VA facility ids.","items":{"type":"string"}}},"description":"A list of facility ids."},"Meta":{"type":"object","properties":{"bandVersion":{"type":"string","description":"Version of the drive time band data set used to generate this response.","nullable":true,"example":"APR2021"}},"description":"Object containing metadata about this response.","nullable":true},"Nearby":{"type":"object","properties":{"id":{"type":"string","description":"Identifier for facility.","example":"vha_688"},"type":{"type":"string","description":"Type of facility.","example":"va_health_facility","enum":["nearby_facility"]},"attributes":{"$ref":"#/components/schemas/NearbyAttributes"}},"description":"Object describing a nearby VA facility.","nullable":true},"NearbyAttributes":{"type":"object","properties":{"minTime":{"type":"integer","description":"Minimum time to reach facility.","format":"int32","example":10},"maxTime":{"type":"integer","description":"Maximum time to reach facility.","format":"int32","example":20}},"nullable":true},"NearbyResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Nearby"}},"meta":{"$ref":"#/components/schemas/Meta"}},"description":"Object containing minimum and maximum time it takes to reach a facility.","nullable":true},"AppointmentPhoneNumber":{"type":"object","properties":{"extension":{"type":"string","description":"Appointment phone number extension.","nullable":true,"example":"71234"},"label":{"type":"string","description":"Appointment phone number label (e.g. 'Main phone', 'Appointment phone', etc).","nullable":true,"example":"Main phone"},"number":{"type":"string","description":"Appointment phone number.","nullable":true,"example":"937-268-6511"},"type":{"type":"string","description":"Appointment contact number type (e.g. 'tel', 'fax', etc)","nullable":true,"example":"tel"}},"description":"Phone number information for scheduling an appointment.","nullable":true},"DetailedService":{"type":"object","properties":{"serviceInfo":{"$ref":"#/components/schemas/ServiceInfo"},"appointmentLeadIn":{"type":"string","description":"Additional appointment information. May contain html / string formatting characters.","nullable":true,"example":"Your VA health care team will contact you if you're eligible to get a vaccine during this time. As the supply of vaccine increases, we'll work with our care teams to let Veterans know their options."},"appointmentPhones":{"type":"array","description":"List of phone numbers related to scheduling appointments for this service.","nullable":true,"items":{"$ref":"#/components/schemas/AppointmentPhoneNumber"}},"serviceLocations":{"type":"array","description":"List of service locations.","nullable":true,"items":{"$ref":"#/components/schemas/DetailedServiceLocation"}},"waitTime":{"$ref":"#/components/schemas/PatientWaitTime"},"lastUpdated":{"type":"string","description":"Date and time of most recent upload of detailed service from CMS.","format":"date-time","nullable":true},"path":{"type":"string","description":"URL to a page with additional details for this service within the associated facility's health care system.","nullable":true,"example":"https://www.boston.va.gov/services/covid-19-vaccines.asp"},"serviceId":{"$ref":"#/components/schemas/DetailedService"},"name":{"$ref":"#/components/schemas/DetailedService"}},"description":"Detailed information of a facility service.","nullable":true},"DetailedServiceAddress":{"type":"object","properties":{"buildingNameNumber":{"type":"string","description":"Building name and/or number of service.","nullable":true,"example":"Baxter Building"},"wingFloorOrRoomNumber":{"type":"string","description":"Wing, floor, or room number of service.","nullable":true,"example":"Wing East"},"addressLine1":{"type":"string","description":"Street name and number.","nullable":true,"example":"50 Irving Street, Northwest"},"addressLine2":{"type":"string","description":"Building number.","nullable":true,"example":"Bldg 2"},"city":{"type":"string","description":"City name.","nullable":true,"example":"Washington"},"state":{"type":"string","description":"State code.","nullable":true,"example":"DC"},"zipCode":{"type":"string","description":"Postal (ZIP) code.","nullable":true,"example":"20422-0001"},"countryCode":{"type":"string","description":"Country code.","nullable":true,"example":"US"}},"description":"Service location address.","nullable":true},"DetailedServiceEmailContact":{"type":"object","properties":{"emailAddress":{"type":"string","description":"Email address for facility service contact.","nullable":true,"example":"georgea@va.gov"},"emailLabel":{"type":"string","description":"Email address label.","nullable":true,"example":"George Anderson"}},"description":"Email contact information for facility service.","nullable":true},"DetailedServiceHours":{"type":"object","properties":{"monday":{"type":"string","description":"Service availability on Mondays.","nullable":true,"example":"9AM-5PM"},"tuesday":{"type":"string","description":"Service availability on Tuesdays.","nullable":true,"example":"9AM-5PM"},"wednesday":{"type":"string","description":"Service availability on Wednesdays.","nullable":true,"example":"9AM-5PM"},"thursday":{"type":"string","description":"Service availability on Thursdays.","nullable":true,"example":"9AM-5PM"},"friday":{"type":"string","description":"Service availability on Fridays.","nullable":true,"example":"9AM-5PM"},"saturday":{"type":"string","description":"Service availability on Saturdays.","nullable":true,"example":"Closed"},"sunday":{"type":"string","description":"Service availability on Sundays.","nullable":true,"example":"Closed"}},"description":"Standard hours of operation. Currently formatted as descriptive text suitable for display, with no guarantee of a standard parseable format. Hours of operation may vary due to holidays or other events.","nullable":true},"DetailedServiceLocation":{"type":"object","properties":{"officeName":{"type":"string","description":"Name of given office location.","nullable":true,"example":"ENT Clinic"},"serviceAddress":{"$ref":"#/components/schemas/DetailedServiceAddress"},"phones":{"type":"array","description":"List of appointment phone information.","nullable":true,"items":{"$ref":"#/components/schemas/AppointmentPhoneNumber"}},"emailContacts":{"type":"array","description":"List of email contact information regarding facility services.","nullable":true,"items":{"$ref":"#/components/schemas/DetailedServiceEmailContact"}},"serviceHours":{"$ref":"#/components/schemas/DetailedServiceHours"},"additionalHoursInfo":{"type":"string","description":"Additional information related to service location hours.","nullable":true,"example":"Location hours times may vary depending on staff availability"},"onlineSchedulingAvailable":{"type":"string","description":"String detailing online scheduling availability.","nullable":true,"example":"True"},"referralRequired":{"type":"string","description":"String detailing if referrals are required for the service.","nullable":true,"example":"False"},"walkInsAccepted":{"type":"string","description":"String detailing if walk-ins are accepted for the service.","nullable":true,"example":"True"}},"description":"Details for a location offering a service.","nullable":true},"DetailedServiceResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DetailedService"}},"description":"Expanded details for a service."},"PatientWaitTime":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","nullable":true,"example":"2018-01-01"},"new":{"type":"number","description":"Average number of days a Veteran who hasn't been to this location has to wait for a non-urgent appointment.","nullable":true,"example":28.175438},"established":{"type":"number","description":"Average number of days a patient who has already been to this location has to wait for a non-urgent appointment.","nullable":true,"example":4.359409}},"description":"Expected wait times for new and established patients for a given health care service at VA health facilities.","nullable":true,"example":10},"ServiceInfo":{"type":"object","properties":{"name":{"type":"string","description":"Service name.","nullable":true,"example":"COVID-19 vaccines"},"serviceId":{"type":"string","description":"Service identifier.","example":"covid19Vaccine"},"serviceType":{"type":"string","description":"Service type.","nullable":true,"example":"Health","enum":["benefits","health","other"]}},"description":"Service information."},"DetailedServicesMetadata":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/Pagination"}},"description":"\t\nObject containing metadata about detailed service response"},"DetailedServicesResponse":{"type":"object","properties":{"data":{"type":"array","description":"List of objects containing service details.","items":{"$ref":"#/components/schemas/DetailedService"}},"links":{"$ref":"#/components/schemas/PageLinks"},"meta":{"$ref":"#/components/schemas/DetailedServicesMetadata"}},"description":"An object containing a list of services."}},"securitySchemes":{"apikey":{"in":"header","name":"apikey","type":"apiKey"}}},"servers":[{"url":"https://sandbox-api.va.gov/services/va_facilities/{version}","description":"Sandbox","variables":{"version":{"default":"v1"}}},{"url":"https://api.va.gov/services/va_facilities/{version}","description":"Production","variables":{"version":{"default":"v1"}}}],"security":[{"apikey":[]}]}