{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/shepherd-vet/json-schema/shepherd-vet-open-api-appointment-controller-appointment-write-model-schema.json",
  "title": "OpenApiAppointmentController.AppointmentWriteModel",
  "description": "Appointment write REST model.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/shepherd-vet-appointment-api-openapi.yml#/components/schemas/OpenApiAppointmentController.AppointmentWriteModel",
  "required": [
    "endDate",
    "providerId",
    "startDate"
  ],
  "type": "object",
  "properties": {
    "appointmentStatusId": {
      "description": "The appointment status identifier. The default appointment status is upcoming.",
      "type": "string"
    },
    "appointmentTypeId": {
      "description": "The appointment type identifier. If left null it will block off time for provider. If\nBlockOff time for provider is to be created then PatientIds and ClientId should be null.",
      "type": "string"
    },
    "clientId": {
      "description": "The client identifier. It can be set only when AppointmentTypeId has value.",
      "type": "string"
    },
    "embed": {
      "description": "Comma-separated list of embedded properties to fetch. Nested fetches can be specified using dot notation (e.g., \"client.clientPhones\"). Defaults\nto null.",
      "type": "string"
    },
    "endDate": {
      "format": "date-time",
      "description": "The ISO string representing appointment end date. End date is in UTC time zone. Must be greater than\nStartDate and in increments of 5 minutes. Cannot be more than 24 hours after the StartDate.",
      "type": "string"
    },
    "patientIds": {
      "description": "The patient ids. Requires clientId. It can be set only when AppointmentTypeId has value.",
      "type": "array",
      "items": {
        "format": "uuid",
        "type": "string"
      }
    },
    "providerId": {
      "description": "The provider identifier.",
      "type": "string"
    },
    "scheduleTemplateAppointmentId": {
      "format": "uuid",
      "description": "Schedule template appointment identifier. Schedule templates appointments are used to reserve slots for certain appointment type.\nOnly appointments with such appointment type can be inserted into this slot.",
      "type": "string"
    },
    "sendEmailNotification": {
      "description": "A value indicating whether to send email notification. The default value is false.",
      "type": "boolean"
    },
    "sendFormEmailNotification": {
      "description": "A value indicating whether to send an email with link to forms. Forms must be linked to the appointment type.\nThe default value is false, meaning no email will be sent unless explicitly set to true.",
      "type": "boolean"
    },
    "sendSmsNotification": {
      "description": "A value indicating whether to send SMS notification. The default value is false.",
      "type": "boolean"
    },
    "startDate": {
      "format": "date-time",
      "description": "The ISO string representing appointment start date. Start date is in UTC time zone. Must be\nin increments of 5 minutes.",
      "type": "string"
    },
    "visitReason": {
      "description": "The visit reason. This will be the initial complaint in the SOAP.",
      "type": "string"
    }
  }
}