message FacilityFeed {
repeated Facility data = 1;
}
Facility Definition
// Info about a healthcare facility on the partner's platform. It could be a// location/clinic that one or multiple practitioners work at. It could also be// a bookable facility, like a test center.// A FacilityFeed should be a list of this message.messageFacility{// An opaque string generated by the partner that identifies a facility.// Must be unique across all facilities.// Strongly recommended to only include URL-safe characters. (required)stringfacility_id=1;// The name, telephone, url and geo are used to support matching partner// inventory with merchants/locations already present on Google Maps. This// information will not be displayed.//// The name of the facility. (required)stringname=2;// The contact telephone number of the facility including its country and area// codes, e.g. +14567891234. Highly recommended. (optional)stringtelephone=3;// The url of the facility's public website. Highly recommended. (optional)stringurl=4;// The Geo info of the facility, including latitude, longitude, and address.// (required)GeoCoordinatesgeo=6;// An action URL with associated language, list of countries restricted to,// type, and optional platform that indicates which platform this action// should be performed on. This action link is specifically for the merchant,// please use the ActionLink in the appointment type feed to link to a// specific appointment type. (required if the booking link needs to be shown// in facility's profile in Google Search)repeatedActionLinkaction_link=10;// The ID of the health system that the facility belongs to. (required)stringhealth_system_id=11;// ...}
GeoCoordinates Definition
// The Geo data of a location, including latitude, longitude, and address.messageGeoCoordinates{// Optional.google.type.LatLnglat_lng=1;// Address for a location, could either be structured or unstructured.// (required)oneofaddress{// Postal address of the location, preferred.PostalAddresspostal_address=2;// An unstructured address could also be provided as a fallback.// E.g. "1600 amphitheatre parkway mountain view, ca 94043"stringunstructured_address=3;}}
PostalAddress Definition
// The postal address for a merchant.messagePostalAddress{// The country, e.g. "US". (required)stringcountry=1;// The locality/city, e.g. "Mountain View". (required)stringlocality=2;// The region/state/province, e.g. "CA". This field is only required in// countries where region is commonly a part of the address. (optional)stringregion=3;// The postal code, e.g. "94043". (required)stringpostal_code=4;// The street address, e.g. "1600 Amphitheatre Pkwy". (required)stringstreet_address=5;}
ActionLink Definition
// An action URL with associated language, list of countries restricted to, and// optional platform that indicates which platform this action should be// performed on.messageActionLink{// The entry point URL for this action link. (required)stringurl=1;// The BCP-47 language tag identifying the language in which the content// from this URI is available. (optional)stringlanguage=2;// An unordered list of ISO 3166-1 alpha-2 country codes. Leave empty for// unrestricted visibility. (optional)repeatedstringrestricted_country=3;// ...}
Facility feed samples
Facility Feed
{"data":[{"facility_id":"facility_00111","name":"AMG St Main","telephone":"+14567891234","url":"https://health.appointment/facility_00111","npi":"3216549870","geo":{"lat_lng":{"latitude":37.422113,"longitude":-122.084041},"postal_address":{"country":"US","locality":"Mountain View","region":"CA","postal_code":"94043","street_address":"1600 Amphitheatre Pkwy"}},"action_link":[{"url":"https://health.appointment/facility_00111/booking","language":"en-US","restricted_country":["US"]}],"health_system_id":"health_system_4"},{"facility_id":"facility_00231","name":"AMG St California","telephone":"+13892891236","url":"https://health.appointment/facility_00231","geo":{"lat_lng":{"latitude":28.322124,"longitude":-123.125673},"postal_address":{"country":"US","locality":"Mountain View","region":"CA","postal_code":"94045","street_address":"200 Amphitheatre Pkwy"}},"action_link":[{"url":"https://health.appointment/facility_00231","language":"en-US","restricted_country":["US"]}],"health_system_id":"health_system_5"}]}
[null,null,["Last updated 2024-10-31 UTC."],[[["The Facility Feed provides information about healthcare facilities, including their location, contact details, and a booking link."],["Each facility is identified by a unique `facility_id` and associated with a `health_system_id`."],["Feeds should be uploaded in JSON format, although the specification is defined using protocol buffers."],["Geographic data is provided using latitude/longitude and a postal address, supporting Google Maps integration."],["An `action_link` can be included to direct users to a booking page or other relevant resource for the facility."]]],[]]