{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/shepherd-vet/json-schema/shepherd-vet-open-api-appointment-patient-controller-appointment-patient-filter-model-schema.json",
  "title": "OpenApiAppointmentPatientController.AppointmentPatientFilterModel",
  "description": "Appointment Patient Filter model.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/shepherd-vet-appointmentpatient-api-openapi.yml#/components/schemas/OpenApiAppointmentPatientController.AppointmentPatientFilterModel",
  "type": "object",
  "properties": {
    "appointmentIds": {
      "description": "Filters by Comma-separated list of unique appointment identifiers.",
      "type": "string"
    },
    "clinicIds": {
      "description": "Comma-separated list of Clinic identifiers. Defaults to null. The filter is applicable only if the group to which the clinic belongs shares clients and patients.",
      "type": "string"
    },
    "ignorePatient": {
      "description": "Filters by Ignore patient status. Defaults to null (fetches all entities no matter IgnorePatient status).",
      "type": "boolean"
    },
    "includePatientHomeClinic": {
      "description": "Used to support multi-site practices that share patients and clients.\nDetermines whether to include Appointment patients from a patient's home clinic\nwhen filtering by clinic.\n            \nBehavior:\n- If true:\n  - Includes Appointment patients from the specified clinic (default)\n  - Also includes appointment patients from other clinics where the patient's home clinic\n    matches the specified clinic\n- If false (default):\n  - Only includes Appointment patients directly from the specified clinic\n            \nNote: The patient's home clinic is only considered if ClinicIds are provided\nin the filter; otherwise, all data from the group is returned.",
      "type": "boolean"
    },
    "patientIds": {
      "description": "Filters by Comma-separated list of unique patient identifiers.",
      "type": "string"
    },
    "soapIds": {
      "description": "Filters SOAP entries by their unique identifiers. Results are only returned for SOAPs created on the\nappointment page; those created on the SOAP page return null.",
      "type": "string"
    },
    "dateCreatedFrom": {
      "format": "date-time",
      "description": "Sets the start of the date range filter on the entity creation date. Must not be later than DateCreatedTo, or\nthe request returns 400. Defaults to null.",
      "type": "string"
    },
    "dateCreatedTo": {
      "format": "date-time",
      "description": "The end of the date range filter on the entity creation date. Defaults to null.",
      "type": "string"
    },
    "dateUpdatedFrom": {
      "format": "date-time",
      "description": "The start of the date range filter on the entity last update date. Must not be later than DateUpdatedTo, or the\nrequest returns 400. Defaults to null.",
      "type": "string"
    },
    "dateUpdatedTo": {
      "format": "date-time",
      "description": "The end of the date range filter on the entity last update date. Defaults to null.",
      "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 to null.",
      "type": "string"
    },
    "excludeIds": {
      "description": "Comma-separated list of IDs representing entities that you wish to exclude from your search. Defaults to null.",
      "type": "string"
    },
    "ids": {
      "description": "Comma-separated list of IDs representing entities that you wish to include in your search. Defaults to null.",
      "type": "string"
    },
    "page": {
      "format": "int32",
      "description": "The page number. Defaults to 1.",
      "type": "integer"
    },
    "rpp": {
      "format": "int32",
      "description": "The number of items to return per page. The max is 1000. Defaults to 10.",
      "type": "integer"
    },
    "sort": {
      "description": "Which field to sort by. Needs to be in \"field|order\" format, where order is either \"asc\" or \"desc\". The default sort field depends on the endpoint, typically \"id|asc\"",
      "type": "string"
    }
  }
}