Practitioner feed

Definitions

PractitionerFeed Definition

message PractitionerFeed {
  repeated Practitioner data = 1;
}

Practitioner Definition

// Info about a healthcare practitioner who is bookable on the partner's
// platform. A PractitionerFeed should be a list of this message.
message Practitioner {
  // An opaque string generated by the partner that identifies a practitioner.
  // Must be unique across all practitioners.
  // Strongly recommended to only include URL-safe characters. (required)
  string practitioner_id = 1;
  // The name, telephone, url and geo are used to support matching partner
  // inventory with merchants already present on Google Maps. This information
  // will not be displayed.
  //
  // The name of the practitioner. (required)
  string name = 2;
  // The suffix of the practitioner. (optional)
  string suffix = 3;
  // The url of the practitioner's public website. Highly recommended.
  // (optional)
  string url = 4;
  // National Provider Identifier Standard (NPI) for identifying a specific
  // practitioner. (optional)
  string npi = 5;
  // 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
  // practitioner. (required)
  repeated ActionLink action_link = 6;

  // All IDs of health systems that the practitioner works for. At least one
  // health system ID should be provided. (required)
  repeated string health_system_id = 7;
}

// An action URL with associated language, list of countries restricted to, and
// optional platform that indicates which platform this action should be
// performed on.
message ActionLink {
  // The entry point URL for this action link. (required)
  string url = 1;

  // The BCP-47 language tag identifying the language in which the content
  // from this URI is available. (optional)
  string language = 2;

  // An unordered list of ISO 3166-1 alpha-2 country codes. Leave empty for
  // unrestricted visibility. (optional)
  repeated string restricted_country = 3;

  // ...
}

Practitioner feed samples

Practitioner Feed

{
  "data": [
    {
      "practitioner_id": "practitioner_00001",
      "name": "Jay Smith",
      "suffix": "MD",
      "url": "https://health.appointment/practitioner_00001",
      "npi": "1234567890",
      "action_link": [
        {
          "url": "https://health.appointment/practitioner_00001/booking",
          "language": "en-US",
          "restricted_country": ["US"]
        }
      ],
      "health_system_id": ["health_system_1", "health_system_2"]
    },
    {
      "practitioner_id": "practitioner_00002",
      "name": "Jenni Kim",
      "suffix": "MD",
      "url": "https://health.appointment/practitioner_00002",
      "npi": "3131567890",
      "action_link": [
        {
          "url": "https://health.appointment/practitioner_00002/booking",
          "language": "en-US",
          "restricted_country": ["US"]
        }
      ],
      "health_system_id": ["health_system_3"]
    }
  ]
}

Descriptor File

{
  "generation_timestamp": 1614997158,
  "name": "healthappointments.practitioner",
  "data_file": [
    "healthappointments.practitioner-1614907643-00000-of-00001.json"
  ]
}