Appointment type feed

Definitions

AppointmentTypeFeed Definition

message AppointmentTypeFeed {
  repeated AppointmentType data = 1;
}

AppointmentType Definition

// Info about an appointment type which is supported on the partner's
// platform. E.g. "New patient", "Followup" An AppointmentTypeFeed should be a
// list of this message.
message AppointmentType {
  // An opaque string generated by the partner that identifies an appointment
  // type. Must be unique across all appointment types. Strongly recommended to
  // only include URL-safe characters. (required)
  string appointment_type_id = 1;

  // The name of the appointment type to be displayed. (required)
  Text name = 2;

  // ...
}

Text Definition

// A possibly-localized text payload. Some Text fields may contain marked-up
// content.
message Text {
  // Required. Text value in an unknown locale, which will be displayed if
  // `localized_value` for the user locale is empty or missing. The locale for
  // this value may depend on the partner or service provider, and it should not
  // be assumed to be any specific language.
  string value = 1;

  // Per-locale text values. Required.
  repeated LocalizedString localized_value = 2;
}

LocalizedString Definition

// Instance of a string in one locale.
message LocalizedString {
  // IETF BCP 47 language code, such as "en", "mas", "zh-Hant", "de-CH-1901".
  // See http://www.w3.org/International/articles/language-tags/.
  // Only "en-US" is currently supported. All other values will be ignored.
  string locale = 1;

  // Message in the locale above (UTF-8).
  string value = 2;
}

Appointment type feed samples

Appointment Type Feed

{
  "data": [
    {
      "appointment_type_id": "appointment_type_00001",
      "name": {
        "value": "New Patient",
        "localized_value": [
          {
            "locale": "en",
            "value": "New Patient"
          }
        ]
      }
    },
    {
      "appointment_type_id": "appointment_type_00002",
      "name": {
        "value": "Follow Up",
        "localized_value": [
          {
            "locale": "en",
            "value": "Follow Up"
          }
        ]
      }
    },
    {
      "appointment_type_id": "appointment_type_00003",
      "name": {
        "value": "Sick/Acute Problem - New Patient",
        "localized_value": [
          {
            "locale": "en",
            "value": "Sick/Acute Problem - New Patient"
          }
        ]
      }
    }
  ]
}

Descriptor File

{
  "generation_timestamp": 1615078234,
  "name": "healthappointments.appointment_type",
  "data_file": [
    "healthappointments.appointment_type-1615078234-00000-of-00001.json"
  ]
}