# Scheduling AvailableSlots

This data model communicates information about a patient’s office or other outpatient appointment. EHR systems can send `Scheduling` messages to update your system with the appointment status, date/time, scheduled providers, and scheduled resources.

Every appointment gets assigned a visit number and patient ID. Any changes to the appointment are made with the relevant visit number. If the appointment is canceled and later rescheduled, however, a new visit number is created. Also keep in mind that scheduling holds and blocks don’t have an associated patient ID.

This data model has event types that allow you to:

- receive a notification about appointment updates; 
- push or receive a list of available appointment slots; 
- query for and receive open appointment times; or
- query for and receive booked appointment times. 

> **EHR support for Scheduling**
>
> EHR systems typically make scheduling information available through either a standard SIU HL7v2 feed or a proprietary API. SIU messages follow a push notification model while a proprietary API and web service rely on queries. 
>
> You also have the option to use data on demand if you prefer to query, but your connection only supports push notifications for scheduling data. For example, if you primarily want information about a booked appointment, you can use the `Booked` event type to get the information you need with data on demand. [Learn more about data on demand](https://docs.redoxengine.com/permalink/4TD76U5kQESdKsZvzDHfx5).

> **Scheduling vs. SurgicalScheduling vs. PatientAdmin data models**
>
> There’s some overlap among these data models, but here’s what to expect for each: 
>
> - The `Scheduling` data model contains information about outpatient appointments. This may include pre- and post-op office appointments.
> - The `SurgicalScheduling` data model contains information about surgical appointments. This contains information besides appointment details, like questionnaire answers from the patient, equipment requirements for the procedure, or in-progress notes about the surgery.
> - The `PatientAdmin` data model contains insurance information for appointments or surgical procedures.

Query for open times for booking an appointment within a given time range. Results are returned in `Scheduling.AvailableSlotsResponse`.

> **Required query parameters and populated response**
>
> The required elements and populated response vary depending on the EHR system you're integrating with. Work with your connection to understand which query parameters they require and what to expect in the response during implementation testing.

Status: Beta

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `Meta` | object | Yes |  |
| `Meta.DataModel` | string | Yes | Scheduling |
| `Meta.EventType` | string | Yes | AvailableSlots |
| `Meta.EventDateTime` | string or null | No | Displays the UTC date and time that an outgoing request is delivered or an incoming request is received. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Meta.Test` | boolean or null | No | Indicates whether the request is a test or not. |
| `Meta.Source` | object | No | Contains the information for the system initiating the message, including the source ID and name. *Included in messages from Redox* |
| `Meta.Source.ID` | string or null | No | Identifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional. *UUID* |
| `Meta.Source.Name` | string or null | No | Displays the name of the system initiating the message. |
| `Meta.Destinations` | Array of object | No | Contains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination. *Required when sending data to Redox.* |
| `Meta.Destinations[].ID` | string or null | No | Identifies the endpoint that the request is directed to. *UUID* |
| `Meta.Destinations[].Name` | string or null | No | Displays the name of the endpoint that the request is directed to. |
| `Meta.Logs` | Array of object | No | Contains the log identifier(s) for the request. |
| `Meta.Logs[].ID` | string or null | No | Identifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference. *UUID* |
| `Meta.Logs[].AttemptID` | string or null | No | Identifies the request log attempt value, which is useful when retries are possible. *UUID* |
| `Meta.FacilityCode` | string or null | No | Code for the facility related to the message. *Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.* |
| `StartDateTime` | string | Yes | Defines the start of the time range to search for appointments. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Patient` | object | No |  |
| `Patient.Identifiers` | Array of object | No | Contains a list of identifiers and identifier types that correlate to the patient. |
| `Patient.Identifiers[].ID` | string or null | No | Contains an identifier for the patient. |
| `Patient.Identifiers[].IDType` | string or null | No | Defines the type of identifier used to identify the patient (e.g., MRN, EPI). |
| `Patient.Demographics` | object | No |  |
| `Patient.Demographics.FirstName` | string or null | No | Displays the patient's first name. |
| `Patient.Demographics.MiddleName` | string or null | No | Displays the patient's middle name or initial. For patients with multiple middle names, all their middle names are included in this field. |
| `Patient.Demographics.LastName` | string or null | No | Displays the patient's last name. |
| `Patient.Demographics.DOB` | string or null | No | Specifies the patient's date of birth. *In [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Patient.Demographics.SSN` | string or null | No | Contains the patient's social security number. |
| `Patient.Demographics.Sex` | string or null | No | Specifies the patient's sex. Value set ca03256a-4fd3-4b3d-8e37-912cd22b5cda: Female, Male, Unknown, Other, Nonbinary, Prefer not to answer |
| `Patient.Demographics.Race` | string or null | No | Specifies the patient's race. Value set 2d9b5abe-e939-4c55-b8e5-a2816ecb08eb: American Indian or Alaska Native, Asian, Black or African American, Native Hawaiian or Other Pacific Islander, Other Race, White, Unknown, Prefer not to answer |
| `Patient.Demographics.IsHispanic` | boolean or null | No | Indicates whether the patient is of hispanic origin. Value set 731a7062-165a-434c-bef7-b02b824dfc7b: true, false, null |
| `Patient.Demographics.Religion` | string or null | No | Indicates the patient's religious affiliation. Value set 11a5dd99-3549-484c-ba0a-1b22723e9a45: Latter Day Saints, Lutheran, Mahayana, Meditation, Messianic Judaism, Mitraism, New Age, non-Roman Catholic, Occult, Adventist, African Religions, Afro-Caribbean Religions, Agnosticism, Anglican, Animism, Atheism, Babi & Baha'I faiths, Baptist, Bon, Cao Dai, Celticism, Christian, Confucianism, Cyberculture Religions, Divination, Fourth Way, Free Daism, Gnosis, Hinduism, Humanism, Independent, Islam, Jainism, Jehovah's Witnesses, Judaism, Orthodox, Paganism, Pentecostal, Reformed/Presbyterian, Roman Catholic Church, Satanism, Scientology, Shamanism, Shiite (Islam), Shinto, Sikism, Spiritualism, Sunni (Islam), Taoism, Theravada, Unitarian-Universalism, Universal Life Church, Vajrayana (Tibetan), Veda, Voodoo, Wicca, Yaohushua, Zen Buddhism, Zoroastrianism, Assembly of God, Brethren, Christian Scientist, Church of Christ, Church of God, Congregational, Disciples of Christ, Eastern Orthodox, Episcopalian, Evangelical Covenant, Friends, Full Gospel, Methodist, Native American, Nazarene, Presbyterian, Protestant, Reformed, Salvation Army, Unitarian Universalist, United Church of Christ, Protestant - No Denomination, The Process, None, Other, Unknown |
| `Patient.Demographics.MaritalStatus` | string or null | No | Specifies the patient's marital status. Value set f3f48779-ee0c-4477-b458-d8cba9303039: Separated, Unmarried, Common law, Divorced, Legally Separated, Living together, Interlocutory, Married, Annulled, Other, Domestic partner, Registered domestic partner, Single, Unreported, Unknown, Widowed, Polygamous, Never Married |
| `Patient.Demographics.IsDeceased` | boolean or null | No | Indicates if the patient is deceased. |
| `Patient.Demographics.DeathDateTime` | string or null | No | Specifies the date and time that the patient was proclaimed deceased. *[ISO 8601 Format](https://en.wikipedia.org/wiki/ISO_8601)* |
| `Patient.Demographics.PhoneNumber` | object | No |  |
| `Patient.Demographics.PhoneNumber.Home` | string or null | No | Displays the patient's home phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Patient.Demographics.PhoneNumber.Office` | string or null | No | Displays the patient's office phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Patient.Demographics.PhoneNumber.Mobile` | string or null | No | Displays the patient's mobile phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Patient.Demographics.EmailAddresses` | Array of string | No | Displays the patient's email address(es). |
| `Patient.Demographics.Language` | string or null | No | Indicates the patient's primary spoken language. *In ISO 639-1 alpha values (e.g. 'en'). [Supported Values](http://www.loc.gov/standards/iso639-2/php/code_list.php)* Value set 7eeaad13-6761-41f0-ab43-5be92809afc2: af, ae, ak, bg, bh, ca, ce, ch, co, cr, cs, cu, cv, da, dz, ee, en, eo, et, eu, ff, gl, ha, hr, ii, is, lu, kk, kn, ku, kv, kw, mk, ms, nb, nd, pi, sk, om, qu, sn, sq, su, ta, ti, tk, uk, wo, yo, id, ig, jv, kj, km, ln, lo, mr, mt, na, ng, no, oj, pt, rm, rw, sg, st, sw, th, tr, tt, ur, vo, zh, aa, de, fi, ht, hy, ie, ik, ki, kl, ko, kr, ks, ky, lv, mg, mi, ml, my, ne, nl, ny, oc, os, pa, pl, ps, rn, sc, sd, si, sl, so, sr, sv, tg, tl, tn, to, tw, ty, ug, ve, vi, wa, za, es, fa, gn, hu, hz, ia, la, lt, mh, mn, nn, nr, nv, or, ro, sa, se, ss, te, ts, uz, xh, yi, zu, Other, Unknown, ab, av, ba, sgn, am, an, ay, ar, as, az, be, bi, bm, bn, bo, br, bs, cy, dv, el, fj, fo, fr, fy, ga, gd, gu, gv, he, hi, ho, io, it, iu, ja, ka, kg, lb, lg, li, ru, sm |
| `Patient.Demographics.Citizenship` | Array of string | No | Specifies the patient's nation(s) of citizenship. *In ISO 3166 alpha 2 format (e.g. 'US').* Value set 232b1e77-fd16-4f4c-838f-0d288c119806: American Samoa, Anguilla, Austria, Bahamas, Barbados, Bhutan, Bosnia and Herzegovina, Afghanistan, Åland Islands, Albania, Angola, Andorra, Argentina, Armenia, Bangladesh, Belgium, Benin, Bonaire Sint Eustatius and Saba, Botswana, Bouvet Island, British Indian Ocean Territory, Brunei Darussalam, Burkina Faso, Bulgaria, Algeria, Antarctica, Antigua and Barbuda, Aruba, Australia, Azerbaijan, Bahrain, Belarus, Belize, Bermuda, Bolivia (Plurinational State of), Brazil, Burundi, Cayman Islands, China, Colombia, Cook Islands, Curaçao, El Salvador, Cambodia, Christmas Island, Congo (the Democratic Republic of the), Croatia, Czechia, Dominica, Cabo Verde, Chad, Cocos (Keeling) Islands, Costa Rica, Denmark, Dominican Republic, Cameroon, Chile, Congo, Cyprus, Ecuador, Canada, Central African Republic, Comoros, Cuba, Djibouti, Egypt, Equatorial Guinea, Eritrea, Estonia, Ethiopia, Falkland Islands[Malvinas], Faroe Islands, Fiji, Finland, France, French Guiana, French Polynesia, French Southern Territories, Gabon, Gambia, Georgia, Germany, Ghana, Gibraltar, Greece, Greenland, Grenada, Guadeloupe, Guam, Guatemala, Guernsey, Guinea, Guinea-Bissau, Guyana, Haiti, Heard Island and McDonald Islands, Holy See, Honduras, Hong Kong, Hungary, Iceland, India, Indonesia, Iran (Islamic Republic of), Iraq, Ireland, Isle of Man, Israel, Italy, Jamaica, Japan, Jersey, Jordan, Kazakhstan, Kenya, Kiribati, Korea (the Republic of), Kuwait, Kyrgyzstan, Liechtenstein, Madagascar, Mali, Mauritius, Monaco, Mozambique, Netherlands, Niger, Lao Peoples Democratic Republic, Latvia, Lesotho, Macao, Malta, Mayotte, Moldova (the Republic of), Myanmar, Nigeria, Oman, Lebanon, Lithuania, Malawi, Maldives, Mauritania, Mongolia, Morocco, Nepal, Nicaragua, Northern Mariana Islands, Liberia, Luxembourg, Malaysia, Martinique, Micronesia (Federated States of), Montserrat, Nauru, New Zealand, Norfolk Island, Libya, Macedonia (the former Yugoslav Republic of), Marshall Islands, Mexico, Montenegro, Namibia, New Caledonia, Niue, Norway, Pakistan, Palau, Palestine State of, Panama, Papua New Guinea, Paraguay, Peru, Philippines, Pitcairn, Poland, Portugal, Qatar, Puerto Rico, Réunion, Romania, Russian Federation, Rwanda, Saint Barthélemy, Saint Helena Ascension and Tristan da Cunha, Saint Kitts and Nevis, Saint Lucia, Saint Martin (French part), Saint Pierre and Miquelon, Saint Vincent and the Grenadines, Samoa, San Marino, Sao Tome and Principe, Saudi Arabia, Senegal, Serbia, Seychelles, Sierra Leone, Singapore, Sint Maarten (Dutch part), Slovakia, Slovenia, Solomon Islands, Somalia, South Africa, South Georgia and the South Sandwich Islands, South Sudan, Spain, Sri Lanka, Sudan, Suriname, Svalbard and Jan Mayen, Swaziland, Sweden, Switzerland, Syrian Arab Republic, Tajikistan, Taiwan (Province of China), Timor-Leste, Trinidad and Tobago, Tuvalu, Uruguay, Virgin Islands (U.S.), Yemen, Tanzania United Republic of, Turkey, Ukraine, United States of America, Viet Nam, Western Sahara*, Thailand, Tonga, Turks and Caicos Islands, United States Minor Outlying Islands, Venezuela (Bolivarian Republic of), Zimbabwe, Togo, Tunisia, Uganda, United Arab Emirates, Uzbekistan, Virgin Islands (British), Zambia, Tokelau, Turkmenistan, United Kingdom of Great Britain and Northern Ireland, Vanuatu, Wallis and Futuna, Côte dIvoire, Korea (the Democratic Peoples Republic of), Unknown |
| `Patient.Demographics.Address` | object | No | Patient's home address |
| `Patient.Demographics.Address.StreetAddress` | string or null | No | Street address |
| `Patient.Demographics.Address.City` | string or null | No | City |
| `Patient.Demographics.Address.State` | string or null | No | State |
| `Patient.Demographics.Address.ZIP` | string or null | No | ZIP |
| `Patient.Demographics.Address.County` | string or null | No | County |
| `Patient.Demographics.Address.Country` | string or null | No | Country. Value set 39791e31-0cee-4c58-a6c1-3d9e2c71d13b: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, IO, CM, CL, CO, CI, DK, EC, ER, FK, TF, GM, GI, GW, VA, IS, IM, JP, KI, LS, LT, MK, MV, MX, MS, NA, NC, MP, PK, PG, PL, RU, PM, SA, SG, SB, SS, SE, TZ, TO, TV, US, VN, EH, ZW, BQ, BR, BF, CA, TD, KM, CK, CU, DO, EE, FI, GE, GL, GN, GY, IN, IE, JE, KW, LB, LY, MO, ML, MR, MN, MM, NZ, NU, OM, PY, PT, RO, KN, SN, RS, ZA, LK, SJ, SY, TK, TM, UG, UM, UZ, WF, BA, BG, CV, CX, CD, CW, DJ, GQ, FO, PF, DE, GD, GG, HT, HK, IR, IL, KE, KG, LU, MY, MT, MU, ME, MZ, NP, NF, PW, PH, QA, BL, MF, ST, SX, SI, GS, SR, TJ, TG, TN, UA, VU, VG, BW, BN, KH, KY, CC, CR, CY, EG, FJ, FR, GH, GP, GU, HN, IQ, JM, KZ, KP, LA, LR, MW, MH, YT, MD, MA, NI, NG, NO, PA, PN, RE, RW, LC, SM, SC, SK, ES, CH, TH, TT, TR, GB, VE, VI, ZM, BV, BI, CF, CN, CG, HR, CZ, DM, SV, ET, GF, GA, GR, GT, HM, HU, ID, IT, JO, KR, LV, LI, MG, MQ, FM, MC, NR, NL, NE, PS, PE, PR, SH, VC, WS, SL, SO, SD, SZ, TW, TL, TC, AE, UY, YE, DR |
| `Patient.Notes` | Array of string | No | Contains any patient-level notes. *Not supported with data on demand.* |
| `Patient.Diagnoses` | Array of object | No | Contains a list of diagnoses associated with the visit. |
| `Patient.Diagnoses[].Code` | string or null | No | Code for the diagnosis |
| `Patient.Diagnoses[].Codeset` | string or null | No | Code set used to identify the diagnosis. *One of the following: ICD-9, ICD-10, HCPCS, CPT* Value set 5730b002-4623-48de-8336-a38e57989cf5: ICD-10, ICD-9, HCPCS, CPT, Unknown, SNOMED CT |
| `Patient.Diagnoses[].Name` | string or null | No | Name of the diagnosis |
| `Patient.Diagnoses[].Type` | string or null | No | Type of the diagnosis. Value set 355dbdb5-f708-4f35-8fb2-85ba4bbe67b7: Unknown, Admitting, Final, Self, Working, Principal |
| `Patient.Diagnoses[].DocumentedDateTime` | string or null | No | DateTime the diagnosis was documented. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `EndDateTime` | string or null | No | Defines the end of the time range to search for appointments. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Visit` | object | No |  |
| `Visit.Reasons` | Array of string | No | Contains is a patient-friendly value that provides context for the purpose of the appointment (e.g., knee pain). This differs from the Visit Type since it can include a clinical component. |
| `Visit.AttendingProviders` | Array of object | No |  |
| `Visit.AttendingProviders[].ID` | string or null | No | ID of the provider. *This ID is often required for Inpatient Visits.* |
| `Visit.AttendingProviders[].IDType` | string or null | No | ID type of the ID for the provider |
| `Visit.AttendingProviders[].FirstName` | string or null | No | First name of the provider |
| `Visit.AttendingProviders[].LastName` | string or null | No | Last name of the provider |
| `Visit.AttendingProviders[].Credentials` | Array of string | No | List of credentials for the provider. *e.g. MD, PhD* |
| `Visit.AttendingProviders[].Address` | object | No | Provider's address |
| `Visit.AttendingProviders[].Address.StreetAddress` | string or null | No | Street address |
| `Visit.AttendingProviders[].Address.City` | string or null | No | City |
| `Visit.AttendingProviders[].Address.State` | string or null | No | State |
| `Visit.AttendingProviders[].Address.ZIP` | string or null | No | ZIP |
| `Visit.AttendingProviders[].Address.County` | string or null | No | County |
| `Visit.AttendingProviders[].Address.Country` | string or null | No | Country. Value set 39791e31-0cee-4c58-a6c1-3d9e2c71d13b: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, IO, CM, CL, CO, CI, DK, EC, ER, FK, TF, GM, GI, GW, VA, IS, IM, JP, KI, LS, LT, MK, MV, MX, MS, NA, NC, MP, PK, PG, PL, RU, PM, SA, SG, SB, SS, SE, TZ, TO, TV, US, VN, EH, ZW, BQ, BR, BF, CA, TD, KM, CK, CU, DO, EE, FI, GE, GL, GN, GY, IN, IE, JE, KW, LB, LY, MO, ML, MR, MN, MM, NZ, NU, OM, PY, PT, RO, KN, SN, RS, ZA, LK, SJ, SY, TK, TM, UG, UM, UZ, WF, BA, BG, CV, CX, CD, CW, DJ, GQ, FO, PF, DE, GD, GG, HT, HK, IR, IL, KE, KG, LU, MY, MT, MU, ME, MZ, NP, NF, PW, PH, QA, BL, MF, ST, SX, SI, GS, SR, TJ, TG, TN, UA, VU, VG, BW, BN, KH, KY, CC, CR, CY, EG, FJ, FR, GH, GP, GU, HN, IQ, JM, KZ, KP, LA, LR, MW, MH, YT, MD, MA, NI, NG, NO, PA, PN, RE, RW, LC, SM, SC, SK, ES, CH, TH, TT, TR, GB, VE, VI, ZM, BV, BI, CF, CN, CG, HR, CZ, DM, SV, ET, GF, GA, GR, GT, HM, HU, ID, IT, JO, KR, LV, LI, MG, MQ, FM, MC, NR, NL, NE, PS, PE, PR, SH, VC, WS, SL, SO, SD, SZ, TW, TL, TC, AE, UY, YE, DR |
| `Visit.AttendingProviders[].EmailAddresses` | Array of string | No | Provider's email address(es) |
| `Visit.AttendingProviders[].PhoneNumber` | object | No |  |
| `Visit.AttendingProviders[].PhoneNumber.Office` | string or null | No | Provider's office phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Visit.AttendingProviders[].Location` | object | No | Provider's location |
| `Visit.AttendingProviders[].Location.Type` | string or null | No | Type of location. *Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone* |
| `Visit.AttendingProviders[].Location.Facility` | string or null | No | Facility. *Example: Community Hospital* |
| `Visit.AttendingProviders[].Location.FacilityIdentifiers` | Array of object | No | List of IDs specific to this facility |
| `Visit.AttendingProviders[].Location.FacilityIdentifiers[].ID` | string or null | No | An ID specific to this facility |
| `Visit.AttendingProviders[].Location.FacilityIdentifiers[].IDType` | string or null | No | The source or system to which this ID pertains. *Could be an OID or a human-readable name* |
| `Visit.AttendingProviders[].Location.Department` | string or null | No | Department |
| `Visit.AttendingProviders[].Location.DepartmentIdentifiers` | Array of object | No | List of IDs specific to this department |
| `Visit.AttendingProviders[].Location.DepartmentIdentifiers[].ID` | string or null | No | An ID specific to this department |
| `Visit.AttendingProviders[].Location.DepartmentIdentifiers[].IDType` | string or null | No | The source or system to which this ID pertains. *Could be an OID or a human-readable name* |
| `Visit.AttendingProviders[].Location.Room` | string or null | No | Room. *Example: 136* |
| `Visit.Locations` | Array of object | No | Specifies the location of the appointment. |
| `Visit.Locations[].Type` | string or null | No | Specifies the type of location (e.g., clinic, department, home, nursing unit, provider office, phone). *Not supported with data on demand.* |
| `Visit.Locations[].Facility` | string or null | No | Specifies the kind of facility (e.g., community hospital). *Not supported with data on demand.* |
| `Visit.Locations[].Department` | string or null | No | Specifies the department where the patient appointment takes place. |
| `Visit.Locations[].SpecialtyDepartment` | object | No | Indicates the departments specialty. |
| `Visit.Locations[].SpecialtyDepartment.Code` | string or null | No | Code for the specialty of the department |
| `Visit.Locations[].SpecialtyDepartment.Codeset` | string or null | No | Code set used to identify the specialty of the department |
| `Visit.Locations[].SpecialtyDepartment.Description` | string or null | No | Description of the specialty of the department |
| `Visit.Locations[].Room` | string or null | No | Displays the room number for the visit (e.g., 136). *Not supported with data on demand.* |
| `Visit.Locations[].ID` | string or null | No | Contains the unique identifier of the visit location. |
| `Visit.VisitType` | Array of object | No | Defines the type of patient visit. |
| `Visit.VisitType[].Code` | string or null | No | Code for the visit type |
| `Visit.VisitType[].Codeset` | string or null | No | Code set used to identify the visit type |
| `Visit.VisitType[].Description` | string or null | No | Description of the visit type |
| `Visit.VisitPreference` | Array of object | No | Contains the details for the appointment scheduling preferences. |
| `Visit.VisitPreference[].Duration` | string or null | No | Defines the preferred length of time for the patient visit. |
| `Visit.VisitPreference[].DurationUnit` | string or null | No | Specifies the unit of measurement for the duration field. |
| `Visit.VisitPreference[].Day` | Array of string | No | Specifies the preferred day of week for scheduling the appointment. |
| `Visit.VisitPreference[].Time` | Array of string | No | Specifies the preferred time of day for the appointment. |

## Example

```json
{
  "Meta": {
    "DataModel": "Scheduling",
    "EventType": "AvailableSlots",
    "EventDateTime": "2026-11-16T23:16:06.930Z",
    "Test": true,
    "Source": {
      "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
      "Name": "Redox Dev Tools"
    },
    "Destinations": [
      {
        "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
        "Name": "Redox EMR"
      }
    ],
    "Logs": [
      {
        "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
        "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
      }
    ],
    "FacilityCode": null
  },
  "Patient": {
    "Identifiers": [
      {
        "ID": "0000000001",
        "IDType": "MR"
      },
      {
        "ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
        "IDType": "EHRID"
      },
      {
        "ID": "a1d4ee8aba494ca",
        "IDType": "NIST"
      }
    ],
    "Demographics": {
      "FirstName": "Timothy",
      "MiddleName": "Paul",
      "LastName": "Bixby",
      "DOB": "2008-01-06",
      "SSN": "101-01-0001",
      "Sex": "Male",
      "Race": "White",
      "IsHispanic": null,
      "Religion": null,
      "MaritalStatus": "Single",
      "IsDeceased": null,
      "DeathDateTime": null,
      "PhoneNumber": {
        "Home": "+18088675301",
        "Office": null,
        "Mobile": null
      },
      "EmailAddresses": [],
      "Language": "en",
      "Citizenship": [],
      "Address": {
        "StreetAddress": "4762 Hickory Street",
        "City": "Monroe",
        "State": "WI",
        "ZIP": "53566",
        "County": "Green",
        "Country": "US"
      }
    },
    "Notes": [],
    "Diagnoses": [
      {
        "Code": "R07.0",
        "Codeset": "ICD-10",
        "Name": "Pain in throat",
        "Type": null,
        "DocumentedDateTime": null
      }
    ]
  },
  "StartDateTime": "2026-11-16T23:16:07.227Z",
  "EndDateTime": null,
  "Visit": {
    "Reasons": [
      "Check up"
    ],
    "AttendingProviders": [],
    "Locations": [
      {
        "Type": "Inpatient",
        "Facility": "RES General Hospital",
        "Department": "3N",
        "SpecialtyDepartment": {
          "Code": null,
          "Codeset": null,
          "Description": null
        },
        "Room": "136",
        "ID": null
      }
    ],
    "VisitType": [
      {
        "Code": "210",
        "Codeset": "DNER15",
        "Description": "Office Visit"
      }
    ],
    "VisitPreference": [
      {
        "Duration": "30",
        "DurationUnit": "minutes",
        "Day": [
          "Tues",
          "Fri"
        ],
        "Time": [
          "1000"
        ]
      }
    ]
  }
}
```
