openapi-directory/api/va.gov/facilities.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.1","info":{"contact":{"name":"developer.va.gov"},"description":"## Background\n\nThe VA Facilities API version 0 (v0) provides information about VA facilities, including locations, addresses, phone numbers, hours of operation, and available services.\n\nThis API gives information about several types of VA facilities:\n- Health facilities (vha)\n- Benefits facilities (vba)\n- Cemeteries (nca)\n- Vet Centers (vc)\n\n## Technical overview\n\nFor in-depth details on data sources for the Facilities API, [read our Facilities GitHub documentation](https://github.com/department-of-veterans-affairs/lighthouse-facilities#readme).\n\nHealth service and service availability data for v0 of this API are based on historical data.\n\n- Historical data is returned for the previous 30 days.\n- Data is based on both pending and completed appointments for a service at a given facility.\n\n\n### Authentication and Authorization\n\nVA Facilities is an open data API. Open data API requests are authorized through a symmetric API token that's provided in an HTTP header with the name '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### 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.","title":"VA Facilities","version":"0.0.1","x-apisguru-categories":["location"],"x-logo":{"url":"https://prod-va-gov-assets.s3-us-gov-west-1.amazonaws.com/img/design/icons/apple-touch-icon.png"},"x-origin":[{"format":"openapi","url":"https://api.va.gov/services/va_facilities/docs/v0/api","version":"3.0"}],"x-providerName":"va.gov","x-serviceName":"facilities"},"tags":[{"description":"VA Facilities API","name":"facilities"}],"paths":{"/facilities":{"get":{"description":"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 support filtering by facility type, available services, and mobile status.\n\nOne can also retrieve facilities by ID using a comma-separated list like `?ids=id1,id2`. When requesting multiple facilities by ID, the API will return as many results as it can find matches for, omitting IDs where there is no match. It will not return an HTTP error code if it is unable to match a requested ID. Clients may supply IDs up to the limit their HTTP client enforces for URI path lengths. (Usually 2048 characters.)\n\nResults are paginated. JSON responses include pagination information in the standard JSON API \"links\" and \"meta\" elements. \n\n### Parameter combinations\nYou may optionally specify `page` and `per_page` with any query. You must specify one of the following parameter combinations: \n\n- `bbox[]`, with the option of any combination of `type`, `services[]`, or `mobile`\n\n- `ids`\n\n- `lat` and `long`, with the option of any combination of `radius`, `ids`, `type`, `services[]`, or `mobile`\n\n- `state`, with the option of any combination of `type`, `services[]`, or `mobile`\n\n- `visn`\n\n- `zip`, with the option of any combination of `type`, `services[]`, or `mobile`\n\n Invalid combinations will return `400 Bad Request`. ","operationId":"getFacilitiesByLocation","parameters":[{"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.","examples":{"ids":{"description":"ids","value":["vha_688","vha_644"]}},"in":"query","name":"ids","schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"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.","examples":{"zip":{"description":"zip","value":"80301-1000"}},"in":"query","name":"zip","schema":{"format":"##### or #####-####","type":"string"}},{"description":"State in which to search for facilities. Except in rare cases, this is two characters.","examples":{"state":{"description":"state","value":"CO"}},"in":"query","name":"state","schema":{"format":"XX","type":"string"}},{"description":"Latitude of point to search for facilities, in WGS84 coordinate reference system.","examples":{"coordinates":{"description":"coordinates","value":56.7}},"in":"query","name":"lat","schema":{"format":"float","type":"number"}},{"description":"Longitude of point to search for facilities, in WGS84 coordinate reference system.","examples":{"coordinates":{"description":"coordinates","value":-123.4}},"in":"query","name":"long","schema":{"format":"float","type":"number"},"style":"form"},{"description":"Optional radial distance from specified latitude and longitude to filter facilities search in WGS84 coordinate reference system.","examples":{"distance":{"description":"distance","value":75}},"in":"query","name":"radius","schema":{"format":"float","type":"number"},"style":"form"},{"description":"Bounding box (longitude, latitude, longitude, latitude) within which facilities will be returned. (WGS84 coordinate reference system)","examples":{"bbox":{"description":"bbox","value":[-105.4,39.4,-104.5,40.1]}},"in":"query","name":"bbox[]","schema":{"items":{"format":"float","type":"number"},"maxItems":4,"minItems":4,"type":"array"},"style":"form"},{"description":"VISN search of matching facilities.","in":"query","name":"visn","schema":{"type":"number"}},{"description":"Optional facility type search filter","in":"query","name":"type","schema":{"enum":["health","cemetery","benefits","vet_center"],"type":"string"}},{"description":"Optional facility service search filter","in":"query","name":"services[]","schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Optional facility mobile search filter","in":"query","name":"mobile","schema":{"type":"boolean"}},{"description":"Page of results to return per paginated response.","in":"query","name":"page","schema":{"default":1,"format":"int64","type":"integer"}},{"description":"Number of results to return per paginated response.","in":"query","name":"per_page","schema":{"default":10,"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/geo+json":{"schema":{"$ref":"#/components/schemas/GeoFacilitiesResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/FacilitiesResponse"}},"application/vnd.geo+json":{"schema":{"$ref":"#/components/schemas/GeoFacilitiesResponse"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"}}},"description":"Missing API token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"}}},"description":"Invalid API token"},"406":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Requested format unacceptable"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"API rate limit exceeded"}},"summary":"Query facilities by location or IDs, with optional filters","tags":["facilities"]}},"/facilities/all":{"get":{"description":"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.","operationId":"getAllFacilities","parameters":[{"example":"application/geo+json","in":"header","name":"Accept","required":true,"schema":{"enum":["application/geo+json","application/vnd.geo+json","text/csv"],"type":"string"}}],"responses":{"200":{"content":{"application/geo+json":{"schema":{"$ref":"#/components/schemas/GeoFacilitiesResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/GeoFacilitiesResponse"}},"application/vnd.geo+json":{"schema":{"$ref":"#/components/schemas/GeoFacilitiesResponse"}},"text/csv":{"schema":{"example":"id,name,station_id,latitude,longitude,facility_type,classification,website,physical_address_1,physical_address_2,physical_address_3,physical_city,physical_state,physical_zip,mailing_address_1,mailing_address_2,mailing_address_3,mailing_city,mailing_state,mailing_zip,phone_main,phone_fax,phone_mental_health_clinic,phone_pharmacy,phone_after_hours,phone_patient_advocate,phone_enrollment_coordinator,hours_monday,hours_tuesay,hours_wednesday,hours_thursday,hours_friday,hours_saturday,hours_sunday,mobile,active_status,visn\nvc_0101V,Boston Vet Center,0101V,42.3445959000001,-71.0361051099999,vet_center,,,7 Drydock Avenue,Suite 2070,,Boston,MA,2210,,,,,,,857-203-6461 x,,,,,,,800AM-700PM,800AM-800PM,800AM-700PM,800AM-800PM,800AM-600PM,-,-,,,\nvba_362b,Houston Regional Benefit Office at Frank Tejeda Outpatient Clinic,362b,29.51690196,-98.59601936,va_benefits_facility,Outbased,NULL,5788 Eckhert Road,,,San Antonio,TX,78240,,,,,,,210-699-5040,210-699-5079,,,,,,,,,,,,,,,\nvha_459GH,Saipan VA Clinic,459GH,15.216794,145.729385,va_health_facility,Other Outpatient Services (OOS),,Marina Heights Business Park - Garapan,Medical Associates of the Pacific,MH-II Building Suite 100 and 206,Saipan,MP,96950-9998,,,,,,,670-322-0035 x,670-322-0038 x,\"\",800-465-8387 x,800-214-1306 x,670-322-0035 x,808-433-7600 x,,,,,,,,false,A,21\n","type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"}}},"description":"Missing API token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"}}},"description":"Invalid API token"},"406":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Requested format unacceptable"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"API rate limit exceeded"}},"summary":"Bulk download information for all facilities","tags":["facilities"]}},"/facilities/{id}":{"get":{"operationId":"getFacilityById","parameters":[{"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.","example":"vha_688","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/geo+json":{"schema":{"$ref":"#/components/schemas/GeoFacilityReadResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/FacilityReadResponse"}},"application/vnd.geo+json":{"schema":{"$ref":"#/components/schemas/GeoFacilityReadResponse"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Bad request - invalid or missing query parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"}}},"description":"Missing API token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"}}},"description":"Invalid API token"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Facility not found"},"406":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Requested format unacceptable"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"API rate limit exceeded"}},"summary":"Retrieve a specific facility by ID","tags":["facilities"]}},"/ids":{"get":{"description":"Retrieves all available facility IDs only","operationId":"getFacilityIds","parameters":[{"description":"Optional facility type search filter","in":"query","name":"type","schema":{"enum":["health","cemetery","benefits","vet_center"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacilitiesIdsResponse"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"}}},"description":"Missing API token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"}}},"description":"Invalid API token"},"406":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Requested format unacceptable"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"API rate limit exceeded"}},"summary":"Bulk download of all facility IDs","tags":["facilities"]}},"/nearby":{"get":{"description":"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 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":"getNearbyFacilities","parameters":[{"description":"Latitude of the location from which drive time will be calculated.","examples":{"coordinates":{"description":"coordinates","value":56.7}},"in":"query","name":"lat","schema":{"format":"float","type":"number"}},{"description":"Longitude of the location from which drive time will be calculated.","examples":{"coordinates":{"description":"coordinates","value":-123.4}},"in":"query","name":"lng","schema":{"format":"float","type":"number"},"style":"form"},{"description":"Street address of the location from which drive time will be calculated.","examples":{"address":{"description":"address","value":"1350 I St. NW"}},"in":"query","name":"street_address","schema":{"type":"string"}},{"description":"City of the location from which drive time will be calculated.","examples":{"address":{"description":"address","value":"Washington"}},"in":"query","name":"city","schema":{"type":"string"}},{"description":"Two character state code of the location from which drive time will be calculated.","examples":{"address":{"description":"address","value":"DC"}},"in":"query","name":"state","schema":{"type":"string"}},{"description":"Zip code of the location from which drive time will be calculated.","examples":{"address":{"description":"address","value":"20005-3305"}},"in":"query","name":"zip","schema":{"description":"##### or #####-####","type":"string"}},{"description":"Filter to only include facilities that are within the specified number of drive time minutes from the requested location.","in":"query","name":"drive_time","schema":{"default":90,"enum":[10,20,30,40,50,60,70,80,90],"format":"int32","type":"integer"}},{"description":"Optional facility service search filter","in":"query","name":"services[]","schema":{"items":{"type":"string"},"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NearbyResponse"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"}}},"description":"Missing Required Or Ambiguous Parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"}}},"description":"Missing API token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"}}},"description":"Invalid API token"},"406":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Requested format unacceptable"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"API rate limit exceeded"}},"summary":"Retrieve all VA health facilities reachable by driving within the specified time period","tags":["facilities"]}}},"components":{"schemas":{"Address":{"description":"Description of an address.","nullable":true,"properties":{"address_1":{"description":"Street name and number.","example":"50 Irving Street, Northwest","nullable":true,"type":"string"},"address_2":{"description":"Second line of address if applicable (such as a building number).","example":"Bldg 2","nullable":true,"type":"string"},"address_3":{"description":"Third line of address if applicable (such as a unit or suite number).","example":"Suite 7","nullable":true,"type":"string"},"city":{"description":"City name.","example":"Washington","nullable":true,"type":"string"},"state":{"description":"State code.","example":"DC","nullable":true,"type":"string"},"zip":{"description":"Postal (ZIP) code.","example":"20422-0001","nullable":true,"type":"string"}},"type":"object"},"Addresses":{"description":"Collection of addresses associated with a facility.","nullable":true,"properties":{"mailing":{"$ref":"#/components/schemas/Address"},"physical":{"$ref":"#/components/schemas/Address"}},"type":"object"},"ApiError":{"description":"API invocation or processing error","properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorMessage"},"type":"array"}},"required":["errors"],"type":"object"},"AppointmentPhoneNumber":{"description":"Phone number information for scheduling an appointment.","nullable":true,"properties":{"extension":{"description":"Appointment phone number extension.","example":"71234","nullable":true,"type":"string"},"label":{"description":"Appointment phone number label (e.g. 'Main phone', 'Appointment phone', etc).","example":"Main phone","nullable":true,"type":"string"},"number":{"description":"Appointment phone number.","example":"937-268-6511","nullable":true,"type":"string"},"type":{"description":"Appointment contact number type (e.g. 'tel', 'fax', etc)","example":"tel","nullable":true,"type":"string"}},"type":"object"},"DetailedService":{"description":"Detailed information of a facility service.","nullable":true,"properties":{"appointment_leadin":{"description":"Additional appointment information. May contain html / string formatting characters.","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.","nullable":true,"type":"string"},"appointment_phones":{"description":"List of phone numbers related to scheduling appointments for this service.","items":{"$ref":"#/components/schemas/AppointmentPhoneNumber"},"nullable":true,"type":"array"},"description_facility":{"description":"Deprecated until further notice.","example":"null","nullable":true,"type":"string"},"name":{"description":"Service name.","example":"COVID-19 vaccines","nullable":true,"type":"string"},"online_scheduling_available":{"description":"String detailing online scheduling availability.","example":"True","nullable":true,"type":"string"},"path":{"description":"URL to a page with additional details for this service within the associated facility's health care system.","example":"https://www.boston.va.gov/services/covid-19-vaccines.asp","nullable":true,"type":"string"},"referral_required":{"description":"String detailing if referrals are required for the service.","example":"False","nullable":true,"type":"string"},"service_id":{"description":"Service id.","example":"covid19Vaccine","type":"string"},"service_locations":{"description":"List of service locations.","items":{"$ref":"#/components/schemas/DetailedServiceLocation"},"nullable":true,"type":"array"},"walk_ins_accepted":{"description":"String detailing if walk-ins are accepted for the service.","example":"True","nullable":true,"type":"string"}},"type":"object"},"DetailedServiceAddress":{"description":"Service location address.","nullable":true,"properties":{"address_line1":{"description":"Street name and number.","example":"50 Irving Street, Northwest","nullable":true,"type":"string"},"address_line2":{"description":"Building number.","example":"Bldg 2","nullable":true,"type":"string"},"building_name_number":{"description":"Building name and/or number of service.","example":"Baxter Building","nullable":true,"type":"string"},"city":{"description":"City name.","example":"Washington","nullable":true,"type":"string"},"clinic_name":{"description":"Clinic name for service.","example":"Baxter Clinic","nullable":true,"type":"string"},"country_code":{"description":"Country code.","example":"US","nullable":true,"type":"string"},"state":{"description":"State code.","example":"DC","nullable":true,"type":"string"},"wing_floor_or_room_number":{"description":"Wing, floor, or room number of service.","example":"Wing East","nullable":true,"type":"string"},"zip_code":{"description":"Postal (ZIP) code.","example":"20422-0001","nullable":true,"type":"string"}},"type":"object"},"DetailedServiceEmailContact":{"description":"Email contact information for facility service.","nullable":true,"properties":{"email_address":{"description":"Email address for facility service contact.","example":"georgea@va.gov","nullable":true,"type":"string"},"email_label":{"description":"Email address label.","example":"George Anderson","nullable":true,"type":"string"}},"type":"object"},"DetailedServiceHours":{"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,"properties":{"Friday":{"description":"Service availability on Fridays.","example":"9AM-5PM","nullable":true,"type":"string"},"Monday":{"description":"Service availability on Mondays.","example":"9AM-5PM","nullable":true,"type":"string"},"Saturday":{"description":"Service availability on Saturdays.","example":"Closed","nullable":true,"type":"string"},"Sunday":{"description":"Service availability on Sundays.","example":"Closed","nullable":true,"type":"string"},"Thursday":{"description":"Service availability on Thursdays.","example":"9AM-5PM","nullable":true,"type":"string"},"Tuesday":{"description":"Service availability on Tuesdays.","example":"9AM-5PM","nullable":true,"type":"string"},"Wednesday":{"description":"Service availability on Wednesdays.","example":"9AM-5PM","nullable":true,"type":"string"}},"type":"object"},"DetailedServiceLocation":{"description":"Details for a location offering a service.","nullable":true,"properties":{"additional_hours_info":{"description":"Additional information related to service location hours.","example":"Location hours times may vary depending on staff availability","nullable":true,"type":"string"},"appointment_phones":{"description":"List of appointment phone information.","items":{"$ref":"#/components/schemas/AppointmentPhoneNumber"},"nullable":true,"type":"array"},"email_contacts":{"description":"List of email contact information regarding facility services.","items":{"$ref":"#/components/schemas/DetailedServiceEmailContact"},"nullable":true,"type":"array"},"facility_service_hours":{"$ref":"#/components/schemas/DetailedServiceHours"},"service_location_address":{"$ref":"#/components/schemas/DetailedServiceAddress"}},"type":"object"},"Distance":{"description":"Distance to facility in miles using decimal format. Used when querying for facilities proximal to a location. ","example":54.13,"properties":{"distance":{"description":"Distance to facility in decimal format.","example":54.13,"type":"number"},"id":{"description":"Identifier of facility.","example":"vc_0101V","type":"string"}},"required":["distance","id"],"type":"object"},"ErrorMessage":{"properties":{"code":{"example":"103","type":"string"},"detail":{"example":"Detailed error message","type":"string"},"status":{"example":"400","type":"string"},"title":{"example":"Error title","type":"string"}},"type":"object"},"FacilitiesIdsResponse":{"description":"JSON API response for a query for facility ids.","properties":{"data":{"description":"List of VA facility ids.","items":{"type":"string"},"type":"array"}},"type":"object"},"FacilitiesMetadata":{"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.","properties":{"distances":{"items":{"$ref":"#/components/schemas/Distance"},"type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["pagination"],"type":"object"},"FacilitiesResponse":{"description":"JSON API-compliant response object describing one or more VA facilities","properties":{"data":{"items":{"$ref":"#/components/schemas/Facility"},"type":"array"},"links":{"$ref":"#/components/schemas/PageLinks"},"meta":{"$ref":"#/components/schemas/FacilitiesMetadata"}},"required":["links","meta"],"type":"object"},"Facility":{"description":"JSON API representation of a Facility.","properties":{"attributes":{"$ref":"#/components/schemas/FacilityAttributes"},"id":{"description":"Identifier representing facility.","example":"vha_688","type":"string"},"type":{"description":"One of 4 facility top-level type categories (e.g. health, benefits, cemetery and vet center).","enum":["va_facilities"],"example":"va_facilities","type":"string"}},"required":["attributes","id","type"],"type":"object"},"FacilityAttributes":{"description":"Details describing a facility.","nullable":true,"properties":{"active_status":{"description":"This field is deprecated and replaced with \"operating_status\".","enum":["A","T"],"nullable":true,"type":"string"},"address":{"$ref":"#/components/schemas/Addresses"},"classification":{"description":"Subtype of facility which can further be used to describe facility.","example":"VA Medical Center (VAMC)","nullable":true,"type":"string"},"detailed_services":{"items":{"$ref":"#/components/schemas/DetailedService"},"nullable":true,"type":"array"},"facility_type":{"description":"One of facility top-level type categories (e.g.) health, benefits, cemetery and vet center.","enum":["va_benefits_facility","va_cemetery","va_health_facility","vet_center"],"example":"va_health_facility","type":"string"},"hours":{"$ref":"#/components/schemas/Hours"},"lat":{"description":"Facility latitude.","example":38.9311137,"format":"float","type":"number"},"long":{"description":"Facility longitude.","example":-77.0109110499999,"format":"float","type":"number"},"mobile":{"example":false,"nullable":true,"type":"boolean"},"name":{"description":"Name associated with given facility.","example":"Washington VA Medical Center","type":"string"},"operating_status":{"$ref":"#/components/schemas/OperatingStatus"},"operational_hours_special_instructions":{"description":"Additional information about a VA health or Vet Center facility's operating hours.","example":"Normal business hours are Monday through Friday, 8:00 a.m. to 4:30 p.m.","nullable":true,"type":"string"},"phone":{"$ref":"#/components/schemas/Phone"},"satisfaction":{"$ref":"#/components/schemas/Satisfaction"},"services":{"$ref":"#/components/schemas/Services"},"time_zone":{"description":"Facility time zone.","example":"America/New_York","format":"String","type":"string"},"visn":{"example":"20","nullable":true,"type":"string"},"wait_times":{"$ref":"#/components/schemas/WaitTimes"},"website":{"description":"Web address of facility.","example":"http://www.washingtondc.va.gov","nullable":true,"type":"string"}},"required":["facility_type","lat","long","name","operating_status"],"type":"object"},"FacilityReadResponse":{"description":"Response that contains facility data.","properties":{"data":{"$ref":"#/components/schemas/Facility"}},"required":["data"],"type":"object"},"GenericError":{"description":"A general error json response for things like Authorization Errors or Bad Requests (ex. invalid parameter values).","properties":{"message":{"example":"Detailed Error Message","type":"string"}},"required":["message"],"type":"object"},"GeoFacilitiesResponse":{"description":"GeoJSON API-compliant response object describing one or more VA facilities.","properties":{"features":{"items":{"$ref":"#/components/schemas/GeoFacility"},"type":"array"},"type":{"enum":["FeatureCollection"],"type":"string"}},"required":["type"],"type":"object"},"GeoFacility":{"description":"GeoJSON-complaint Feature object describing a VA Facility","properties":{"geometry":{"$ref":"#/components/schemas/Geometry"},"properties":{"$ref":"#/components/schemas/Properties"},"type":{"description":"Top level category describing the type of facility.","enum":["Feature"],"example":"Feature","type":"string"}},"required":["geometry","properties","type"],"type":"object"},"GeoFacilityReadResponse":{"description":"Response that contains GeoFacility data.","properties":{"geometry":{"$ref":"#/components/schemas/Geometry"},"properties":{"$ref":"#/components/schemas/Properties"},"type":{"enum":["Feature"],"type":"string"}},"required":["geometry","properties","type"],"type":"object"},"Geometry":{"description":"Geometric data giving the physical location of a VA Facility.","nullable":true,"properties":{"coordinates":{"description":"The latitude and longitude of the Facility's physical location.","example":[-77.0367761,38.9004181],"items":{"description":"The latitude and longitude of the Facility's physical location.","nullable":true,"type":"number"},"maxItems":2,"minItems":2,"nullable":true,"type":"array"},"type":{"description":"Describes the type of geometric data provided.","enum":["Point"],"example":"Point","type":"string"}},"required":["type"],"type":"object"},"Hours":{"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.","example":"\"monday\": \"9:30AM-4:00PM\",","nullable":true,"properties":{"friday":{"description":"Hours of operation for Friday.","example":"9AM-5PM","nullable":true,"type":"string"},"monday":{"description":"Hours of operation for Monday.","example":"9AM-5PM","nullable":true,"type":"string"},"saturday":{"description":"Hours of operation for Saturday.","example":"Closed","nullable":true,"type":"string"},"sunday":{"description":"Hours of operation for Sunday.","example":"Closed","nullable":true,"type":"string"},"thursday":{"description":"Hours of operation for Thursday.","example":"9AM-5PM","nullable":true,"type":"string"},"tuesday":{"description":"Hours of operation for Tuesday.","example":"9AM-5PM","nullable":true,"type":"string"},"wednesday":{"description":"Hours of operation for Wednesday.","example":"9AM-5PM","nullable":true,"type":"string"}},"type":"object"},"Meta":{"description":"JSON API-compliant object containing metadata about this response.","nullable":true,"properties":{"band_version":{"description":"Version of the drive time band data set used to generate this response.","example":"APR2021","nullable":true,"type":"string"}},"type":"object"},"Nearby":{"description":"JSON API-compliant object describing a nearby VA facility.","nullable":true,"properties":{"attributes":{"$ref":"#/components/schemas/NearbyAttributes"},"id":{"description":"Identifier for facility.","example":"vha_688","type":"string"},"type":{"description":"Type of facility.","enum":["nearby_facility"],"example":"va_health_facility","type":"string"}},"required":["attributes","id","type"],"type":"object"},"NearbyAttributes":{"nullable":true,"properties":{"max_time":{"description":"Maximum time to reach facility.","example":20,"format":"int32","type":"integer"},"min_time":{"description":"Minimum time to reach facility.","example":10,"format":"int32","type":"integer"}},"required":["max_time","min_time"],"type":"object"},"NearbyResponse":{"description":"Response which contains minimum and maximum time it takes to reach facility.","nullable":true,"properties":{"data":{"items":{"$ref":"#/components/schemas/Nearby"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"type":"object"},"OperatingStatus":{"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.","example":"NORMAL","nullable":true,"properties":{"additional_info":{"description":"Details of facility notices for visitors, such as messages about parking lot closures or floor visitation information.","maxLength":300,"minLength":0,"nullable":true,"type":"string"},"code":{"description":"Status codes indicate normal hours/services, limited hours/services, closed operations, or published facility notices for visitors.","enum":["NORMAL","NOTICE","LIMITED","CLOSED"],"example":"NORMAL","nullable":true,"type":"string"},"supplemental_status":{"description":"List of supplemental statuses for VA facility.","items":{"$ref":"#/components/schemas/SupplementalStatus"},"nullable":true,"type":"array"}},"required":["code"],"type":"object"},"PageLinks":{"description":"Links for first page, next page, previous and last page of response.","properties":{"first":{"description":"Link to first page of response.","example":"https://api.va.gov/services/va_facilities/v0/facilities?type=health&page=1&per_page=1000","nullable":true,"type":"string"},"last":{"description":"Link to last page of response.","example":"https://api.va.gov/services/va_facilities/v0/facilities?type=health&page=4&per_page=1000","nullable":true,"type":"string"},"next":{"description":"Link to next page of response.","example":"https://api.va.gov/services/va_facilities/v0/facilities?type=health&page=2&per_page=1000","nullable":true,"type":"string"},"prev":{"description":"Link to previous page of response.","example":"https://api.va.gov/services/va_facilities/v0/facilities?type=health&page=1&per_page=1000","nullable":true,"type":"string"},"related":{"description":"Link to related pages of response.","example":"https://api.va.gov/services/va_facilities/v0/facilities?id=vha_688","nullable":true,"type":"string"},"self":{"description":"Link to current page of response.","example":"https://api.va.gov/services/va_facilities/v0/facilities?type=health&page=1&per_page=1000","nullable":true,"type":"string"}},"required":["self"],"type":"object"},"Pagination":{"description":"Pagination data reflecting response that has been seperated into discrete pages.","properties":{"current_page":{"description":"Current page of response.","example":1,"format":"int32","type":"integer"},"per_page":{"description":"Number of results per page.","example":20,"format":"int32","type":"integer"},"total_entries":{"description":"Total number of entries matching this query.","example":2162,"format":"int32","type":"integer"},"total_pages":{"description":"Total number of pages matching this query.","example":250,"format":"int32","type":"integer"}},"required":["current_page","per_page","total_entries","total_pages"],"type":"object"},"PatientSatisfaction":{"description":"Veteran-reported satisfaction score for health care services at VA health facilities.","nullable":true,"properties":{"primary_care_routine":{"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.","example":0.85,"format":"float","nullable":true,"type":"number"},"primary_care_urgent":{"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.","example":0.85,"format":"float","nullable":true,"type":"number"},"specialty_care_routine":{"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.","example":0.85,"format":"float","nullable":true,"type":"number"},"specialty_care_urgent":{"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.","example":0.85,"format":"float","nullable":true,"type":"number"}},"type":"object"},"PatientWaitTime":{"description":"Expected wait times for new and established patients for a given health care service at VA health facilities.","nullable":true,"properties":{"established":{"description":"Average number of days a patient who has already been to this location has to wait for a non-urgent appointment.","example":5,"nullable":true,"type":"number"},"new":{"description":"Average number of days a Veteran who hasn't been to this location has to wait for a non-urgent appointment.","example":10,"nullable":true,"type":"number"},"service":{"description":"Service being offered by facility.","enum":["Audiology","Cardiology","CaregiverSupport","Covid19Vaccine","DentalServices","Dermatology","EmergencyCare","Gastroenterology","Gynecology","MentalHealthCare","Ophthalmology","Optometry","Orthopedics","Nutrition","Podiatry","PrimaryCare","SpecialtyCare","UrgentCare","Urology","WomensHealth"],"type":"string"}},"required":["service"],"type":"object"},"Phone":{"description":"Collection of all telephone contact numbers for given facility. ","example":"1-800-827-1000","nullable":true,"properties":{"after_hours":{"description":"Phone number that may be reached outside of operating hours for given facility.","example":"202-555-1212","nullable":true,"type":"string"},"enrollment_coordinator":{"description":"Phone number for enrollment coordinator for given facility.","example":"202-555-1212","nullable":true,"type":"string"},"fax":{"description":"Phone number used for faxing to given facility.","example":"202-555-1212","nullable":true,"type":"string"},"health_connect":{"description":"Phone number for VA Health Connect.","example":"312-122-4516","nullable":true,"type":"string"},"main":{"description":"Phone number for given facility.","example":"202-555-1212","nullable":true,"type":"string"},"mental_health_clinic":{"description":"Phone number for mental health clinic for given facility.","example":"202-555-1212","nullable":true,"type":"string"},"patient_advocate":{"description":"Phone number for patient advocate for given facility.","example":"202-555-1212","nullable":true,"type":"string"},"pharmacy":{"description":"Phone number for pharmacy for given facility.","example":"202-555-1212","nullable":true,"type":"string"}},"type":"object"},"Properties":{"description":"Details describing a facility.","nullable":true,"properties":{"active_status":{"description":"This field is deprecated and replaced with \"operating_status\".","enum":["A","T"],"nullable":true,"type":"string"},"address":{"$ref":"#/components/schemas/Addresses"},"classification":{"description":"Subtype of facility which can further be used to describe facility.","example":"VA Medical Center (VAMC)","nullable":true,"type":"string"},"detailed_services":{"items":{"$ref":"#/components/schemas/DetailedService"},"nullable":true,"type":"array"},"facility_type":{"description":"One of facility top-level type categories (e.g.) health, benefits, cemetery and vet center.","enum":["va_benefits_facility","va_cemetery","va_health_facility","vet_center"],"example":"va_health_facility","type":"string"},"hours":{"$ref":"#/components/schemas/Hours"},"id":{"description":"Identifier representing the Facility.","example":"vha_688","type":"string"},"mobile":{"example":false,"nullable":true,"type":"boolean"},"name":{"description":"Name associated with given facility.","example":"Washington VA Medical Center","type":"string"},"operating_status":{"$ref":"#/components/schemas/OperatingStatus"},"operational_hours_special_instructions":{"description":"Additional information about facility operating hours.","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.\"]","nullable":true,"type":"string"},"phone":{"$ref":"#/components/schemas/Phone"},"satisfaction":{"$ref":"#/components/schemas/Satisfaction"},"services":{"$ref":"#/components/schemas/Services"},"time_zone":{"description":"Facility time zone","example":"America/New_York","format":"String","type":"string"},"visn":{"example":"20","nullable":true,"type":"string"},"wait_times":{"$ref":"#/components/schemas/WaitTimes"},"website":{"description":"Web address of facility.","example":"http://www.washingtondc.va.gov","nullable":true,"type":"string"}},"required":["facility_type","id","operating_status"],"type":"object"},"Satisfaction":{"description":"Scores that indicate patient satisfaction at given facility per service.","nullable":true,"properties":{"effective_date":{"example":"2025-06-15T13:48:48.115Z","format":"date","nullable":true,"type":"string"},"health":{"$ref":"#/components/schemas/PatientSatisfaction"}},"type":"object"},"Services":{"description":"All services offered by a VA health or benefits facility grouped by service type.","nullable":true,"properties":{"benefits":{"description":"List of benefits services for given facility.","items":{"enum":["ApplyingForBenefits","BurialClaimAssistance","DisabilityClaimAssistance","eBenefitsRegistrationAssistance","EducationAndCareerCounseling","EducationClaimAssistance","FamilyMemberClaimAssistance","HomelessAssistance","InsuranceClaimAssistanceAndFinancialCounseling","IntegratedDisabilityEvaluationSystemAssistance","Pensions","PreDischargeClaimAssistance","TransitionAssistance","UpdatingDirectDepositInformation","VAHomeLoanAssistance","VocationalRehabilitationAndEmploymentAssistance"],"type":"string"},"nullable":true,"type":"array"},"health":{"description":"List of health services for given facility.","items":{"enum":["Audiology","Cardiology","CaregiverSupport","Covid19Vaccine","DentalServices","Dermatology","EmergencyCare","Gastroenterology","Gynecology","MentalHealthCare","Ophthalmology","Optometry","Orthopedics","Nutrition","Podiatry","PrimaryCare","SpecialtyCare","UrgentCare","Urology","WomensHealth"],"type":"string"},"nullable":true,"type":"array"},"last_updated":{"description":"Date of the most recent change in offered services.","example":"2025-06-15T13:48:48.115Z","format":"date","nullable":true,"type":"string"},"other":{"description":"List of other services not included in one of the other service categories.","items":{"enum":["OnlineScheduling"],"type":"string"},"nullable":true,"type":"array"}},"type":"object"},"SupplementalStatus":{"description":"Supplemental status for VA facility.","nullable":true,"properties":{"id":{"description":"Unique id for supplemental status.","example":"COVID_LOW","type":"string"},"label":{"description":"Descriptive label for supplemental status.","example":"COVID-19 health protection guidelines: Levels low","type":"string"}},"required":["id","label"],"type":"object"},"WaitTimes":{"description":"Collection of wait times reported for various services based on access to care survey.","example":10,"nullable":true,"properties":{"effective_date":{"description":"The effective date of when the access to care survey was carried out.","example":"2025-06-15T13:48:48.115Z","format":"date","nullable":true,"type":"string"},"health":{"description":"List of expected patient wait times for given health service.","items":{"$ref":"#/components/schemas/PatientWaitTime"},"nullable":true,"type":"array"}},"type":"object"}}}}