# Scheduling Cancel

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.

Receive a notification when an appointment has been canceled. 

The `Visit.VisitNumber` identifies the appointment to cancel in your system.

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `Meta` | object | Yes |  |
| `Meta.DataModel` | string | Yes | Scheduling |
| `Meta.EventType` | string | Yes | Cancel |
| `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.* |
| `Visit` | object | Yes |  |
| `Visit.VisitNumber` | string | Yes | Displays the unique identifier for the related patient visit. |
| `Visit.VisitDateTime` | string | Yes | Contains the scheduled date and time of the appointment. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Visit.Location` | object | Yes | Displays the location of the patient appointment. |
| `Visit.Location.Department` | string | Yes | Department |
| `Visit.Location.Type` | string or null | No | Type of location. *Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone* |
| `Visit.Location.Facility` | string or null | No | Facility. *Example: Community Hospital* |
| `Visit.Location.FacilityIdentifiers` | Array of object | No | List of IDs specific to this facility |
| `Visit.Location.FacilityIdentifiers[].ID` | string or null | No | An ID specific to this facility |
| `Visit.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.Location.DepartmentIdentifiers` | Array of object | No | List of IDs specific to this department |
| `Visit.Location.DepartmentIdentifiers[].ID` | string or null | No | An ID specific to this department |
| `Visit.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.Location.Room` | string or null | No | Room. *Example: 136* |
| `Visit.AccountNumber` | string or null | No | Contains an identifier that can span several visits often related to the same patient condition (e.g., surgeries, research study, pregnancy). In other words, the account number can be used to link related visits. *Not supported with data on demand.* |
| `Visit.PatientClass` | string or null | No | Classifies the department or type of patient care. Patient class is used in many EHR systems to determine where to put the patient (e.g., inpatient, outpatient, emergency). |
| `Visit.Status` | string or null | No | Indicates the status of the visit. Value set 79eaa211-877a-41af-99c3-de76fbd102b9: Pending, Other, Scheduled, Arrived, Completed, No Show, Canceled, Left Without Being Seen, Rescheduled, Confirmed, Checked In, In Room, Not Seen, Cancelled, Billed, Cancel, Checked Out |
| `Visit.Duration` | number or null | No | Defines the length of the appointment in minutes. |
| `Visit.Reason` | string or null | 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.CancelReason` | string or null | No | Reason the visit was canceled |
| `Visit.Type` | string or null | No | Displays an administrative value used primarily for bidirectional exchange to update EHR system schedules. *Not supported with data on demand.* |
| `Visit.Instructions` | Array of string | No | Contains any relevant instructions for the patient visit. *Not supported with data on demand.* |
| `Visit.AttendingProvider` | object | No |  |
| `Visit.AttendingProvider.ID` | string or null | No | ID of the attending provider. *This ID is often required for Inpatient Visits.* |
| `Visit.AttendingProvider.IDType` | string or null | No | ID type of the ID for the attending provider |
| `Visit.AttendingProvider.FirstName` | string or null | No | First name of the attending provider |
| `Visit.AttendingProvider.LastName` | string or null | No | Last name of the attending provider |
| `Visit.AttendingProvider.Credentials` | Array of string | No | List of credentials for the attending provider. *e.g. MD, PhD* |
| `Visit.AttendingProvider.Address` | object | No | Provider's address |
| `Visit.AttendingProvider.Address.StreetAddress` | string or null | No | Street address |
| `Visit.AttendingProvider.Address.City` | string or null | No | City |
| `Visit.AttendingProvider.Address.State` | string or null | No | State |
| `Visit.AttendingProvider.Address.ZIP` | string or null | No | ZIP |
| `Visit.AttendingProvider.Address.County` | string or null | No | County |
| `Visit.AttendingProvider.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.AttendingProvider.EmailAddresses` | Array of string | No | Provider's email address(es) |
| `Visit.AttendingProvider.PhoneNumber` | object | No |  |
| `Visit.AttendingProvider.PhoneNumber.Office` | string or null | No | Provider's office phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Visit.AttendingProvider.Location` | object | No | Provider's location |
| `Visit.AttendingProvider.Location.Type` | string or null | No | Type of location. *Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone* |
| `Visit.AttendingProvider.Location.Facility` | string or null | No | Facility. *Example: Community Hospital* |
| `Visit.AttendingProvider.Location.FacilityIdentifiers` | Array of object | No | List of IDs specific to this facility |
| `Visit.AttendingProvider.Location.FacilityIdentifiers[].ID` | string or null | No | An ID specific to this facility |
| `Visit.AttendingProvider.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.AttendingProvider.Location.Department` | string or null | No | Department |
| `Visit.AttendingProvider.Location.DepartmentIdentifiers` | Array of object | No | List of IDs specific to this department |
| `Visit.AttendingProvider.Location.DepartmentIdentifiers[].ID` | string or null | No | An ID specific to this department |
| `Visit.AttendingProvider.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.AttendingProvider.Location.Room` | string or null | No | Room. *Example: 136* |
| `Visit.ConsultingProvider` | object | No |  |
| `Visit.ConsultingProvider.ID` | string or null | No | ID of the consulting provider. *This ID is often required for Inpatient Visits.* |
| `Visit.ConsultingProvider.IDType` | string or null | No | ID type of the ID for the consulting provider |
| `Visit.ConsultingProvider.FirstName` | string or null | No | First name of the consulting provider |
| `Visit.ConsultingProvider.LastName` | string or null | No | Last name of the consulting provider |
| `Visit.ConsultingProvider.Credentials` | Array of string | No | List of credentials for the consulting provider. *e.g. MD, PhD* |
| `Visit.ConsultingProvider.Address` | object | No | Provider's address |
| `Visit.ConsultingProvider.Address.StreetAddress` | string or null | No | Street address |
| `Visit.ConsultingProvider.Address.City` | string or null | No | City |
| `Visit.ConsultingProvider.Address.State` | string or null | No | State |
| `Visit.ConsultingProvider.Address.ZIP` | string or null | No | ZIP |
| `Visit.ConsultingProvider.Address.County` | string or null | No | County |
| `Visit.ConsultingProvider.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.ConsultingProvider.EmailAddresses` | Array of string | No | Provider's email address(es) |
| `Visit.ConsultingProvider.PhoneNumber` | object | No |  |
| `Visit.ConsultingProvider.PhoneNumber.Office` | string or null | No | Provider's office phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Visit.ConsultingProvider.Location` | object | No | Provider's location |
| `Visit.ConsultingProvider.Location.Type` | string or null | No | Type of location. *Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone* |
| `Visit.ConsultingProvider.Location.Facility` | string or null | No | Facility. *Example: Community Hospital* |
| `Visit.ConsultingProvider.Location.FacilityIdentifiers` | Array of object | No | List of IDs specific to this facility |
| `Visit.ConsultingProvider.Location.FacilityIdentifiers[].ID` | string or null | No | An ID specific to this facility |
| `Visit.ConsultingProvider.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.ConsultingProvider.Location.Department` | string or null | No | Department |
| `Visit.ConsultingProvider.Location.DepartmentIdentifiers` | Array of object | No | List of IDs specific to this department |
| `Visit.ConsultingProvider.Location.DepartmentIdentifiers[].ID` | string or null | No | An ID specific to this department |
| `Visit.ConsultingProvider.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.ConsultingProvider.Location.Room` | string or null | No | Room. *Example: 136* |
| `Visit.ReferringProvider` | object | No |  |
| `Visit.ReferringProvider.ID` | string or null | No | ID of the referring provider. *This ID is often required for Inpatient Visits.* |
| `Visit.ReferringProvider.IDType` | string or null | No | ID type of the ID for the referring provider |
| `Visit.ReferringProvider.FirstName` | string or null | No | First name of the referring provider |
| `Visit.ReferringProvider.LastName` | string or null | No | Last name of the referring provider |
| `Visit.ReferringProvider.Credentials` | Array of string | No | List of credentials for the referring provider. *e.g. MD, PhD* |
| `Visit.ReferringProvider.Address` | object | No | Provider's address |
| `Visit.ReferringProvider.Address.StreetAddress` | string or null | No | Street address |
| `Visit.ReferringProvider.Address.City` | string or null | No | City |
| `Visit.ReferringProvider.Address.State` | string or null | No | State |
| `Visit.ReferringProvider.Address.ZIP` | string or null | No | ZIP |
| `Visit.ReferringProvider.Address.County` | string or null | No | County |
| `Visit.ReferringProvider.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.ReferringProvider.EmailAddresses` | Array of string | No | Provider's email address(es) |
| `Visit.ReferringProvider.PhoneNumber` | object | No |  |
| `Visit.ReferringProvider.PhoneNumber.Office` | string or null | No | Provider's office phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Visit.ReferringProvider.Location` | object | No | Provider's location |
| `Visit.ReferringProvider.Location.Type` | string or null | No | Type of location. *Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone* |
| `Visit.ReferringProvider.Location.Facility` | string or null | No | Facility. *Example: Community Hospital* |
| `Visit.ReferringProvider.Location.FacilityIdentifiers` | Array of object | No | List of IDs specific to this facility |
| `Visit.ReferringProvider.Location.FacilityIdentifiers[].ID` | string or null | No | An ID specific to this facility |
| `Visit.ReferringProvider.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.ReferringProvider.Location.Department` | string or null | No | Department |
| `Visit.ReferringProvider.Location.DepartmentIdentifiers` | Array of object | No | List of IDs specific to this department |
| `Visit.ReferringProvider.Location.DepartmentIdentifiers[].ID` | string or null | No | An ID specific to this department |
| `Visit.ReferringProvider.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.ReferringProvider.Location.Room` | string or null | No | Room. *Example: 136* |
| `Visit.VisitProvider` | object | No |  |
| `Visit.VisitProvider.ID` | string or null | No | ID of the visit provider. *This ID is often required for Inpatient Visits.* |
| `Visit.VisitProvider.IDType` | string or null | No | ID type of the ID for the visit provider |
| `Visit.VisitProvider.FirstName` | string or null | No | First name of the visit provider |
| `Visit.VisitProvider.LastName` | string or null | No | Last name of the visit provider |
| `Visit.VisitProvider.Credentials` | Array of string | No | List of credentials for the visit provider. *e.g. MD, PhD* |
| `Visit.VisitProvider.Address` | object | No | Provider's address |
| `Visit.VisitProvider.Address.StreetAddress` | string or null | No | Street address |
| `Visit.VisitProvider.Address.City` | string or null | No | City |
| `Visit.VisitProvider.Address.State` | string or null | No | State |
| `Visit.VisitProvider.Address.ZIP` | string or null | No | ZIP |
| `Visit.VisitProvider.Address.County` | string or null | No | County |
| `Visit.VisitProvider.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.VisitProvider.EmailAddresses` | Array of string | No | Provider's email address(es) |
| `Visit.VisitProvider.PhoneNumber` | object | No |  |
| `Visit.VisitProvider.PhoneNumber.Office` | string or null | No | Provider's office phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Visit.VisitProvider.Location` | object | No | Provider's location |
| `Visit.VisitProvider.Location.Type` | string or null | No | Type of location. *Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone* |
| `Visit.VisitProvider.Location.Facility` | string or null | No | Facility. *Example: Community Hospital* |
| `Visit.VisitProvider.Location.FacilityIdentifiers` | Array of object | No | List of IDs specific to this facility |
| `Visit.VisitProvider.Location.FacilityIdentifiers[].ID` | string or null | No | An ID specific to this facility |
| `Visit.VisitProvider.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.VisitProvider.Location.Department` | string or null | No | Department |
| `Visit.VisitProvider.Location.DepartmentIdentifiers` | Array of object | No | List of IDs specific to this department |
| `Visit.VisitProvider.Location.DepartmentIdentifiers[].ID` | string or null | No | An ID specific to this department |
| `Visit.VisitProvider.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.VisitProvider.Location.Room` | string or null | No | Room. *Example: 136* |
| `Visit.AdditionalStaff` | Array of object | No | Contains information about any other staff assigned to the assist with the patient visit. Each may be scheduled individually. |
| `Visit.AdditionalStaff[].ID` | string or null | No | ID of the Additional staff member. *This ID is often required for Inpatient Visits.* |
| `Visit.AdditionalStaff[].IDType` | string or null | No | ID type of the ID for the Additional staff member |
| `Visit.AdditionalStaff[].FirstName` | string or null | No | First name of the Additional staff member |
| `Visit.AdditionalStaff[].LastName` | string or null | No | Last name of the Additional staff member |
| `Visit.AdditionalStaff[].Credentials` | Array of string | No | List of credentials for the Additional staff member. *e.g. MD, PhD* |
| `Visit.AdditionalStaff[].Address` | object | No | Provider's address |
| `Visit.AdditionalStaff[].Address.StreetAddress` | string or null | No | Street address |
| `Visit.AdditionalStaff[].Address.City` | string or null | No | City |
| `Visit.AdditionalStaff[].Address.State` | string or null | No | State |
| `Visit.AdditionalStaff[].Address.ZIP` | string or null | No | ZIP |
| `Visit.AdditionalStaff[].Address.County` | string or null | No | County |
| `Visit.AdditionalStaff[].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.AdditionalStaff[].EmailAddresses` | Array of string | No | Provider's email address(es) |
| `Visit.AdditionalStaff[].PhoneNumber` | object | No |  |
| `Visit.AdditionalStaff[].PhoneNumber.Office` | string or null | No | Provider's office phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Visit.AdditionalStaff[].Location` | object | No | Provider's location |
| `Visit.AdditionalStaff[].Location.Type` | string or null | No | Type of location. *Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone* |
| `Visit.AdditionalStaff[].Location.Facility` | string or null | No | Facility. *Example: Community Hospital* |
| `Visit.AdditionalStaff[].Location.FacilityIdentifiers` | Array of object | No | List of IDs specific to this facility |
| `Visit.AdditionalStaff[].Location.FacilityIdentifiers[].ID` | string or null | No | An ID specific to this facility |
| `Visit.AdditionalStaff[].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.AdditionalStaff[].Location.Department` | string or null | No | Department |
| `Visit.AdditionalStaff[].Location.DepartmentIdentifiers` | Array of object | No | List of IDs specific to this department |
| `Visit.AdditionalStaff[].Location.DepartmentIdentifiers[].ID` | string or null | No | An ID specific to this department |
| `Visit.AdditionalStaff[].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.AdditionalStaff[].Location.Room` | string or null | No | Room. *Example: 136* |
| `Visit.AdditionalStaff[].Role` | object | No | Defines the role of this person in the patient visit. |
| `Visit.AdditionalStaff[].Role.Code` | string or null | No | Code for the service |
| `Visit.AdditionalStaff[].Role.Codeset` | string or null | No | Code set used to identify the service. *Codeset will be blank for system-defined codes.* |
| `Visit.AdditionalStaff[].Role.Description` | string or null | No | Description of the service. *Example: Primary Physician, Technologist, etc.* |
| `Visit.AdditionalStaff[].StartDateTime` | string or null | No | If this staff member's schedule is different from the appointment schedule, this is the time that this staff member is scheduled to start work. |
| `Visit.AdditionalStaff[].Duration` | number or null | No | Specifies the length of time that the staff member is scheduled for. *In minutes* |
| `Visit.Diagnoses` | Array of object | No | Contains a list of diagnoses associated with the patient visit. |
| `Visit.Diagnoses[].Code` | string or null | No | Code for the diagnosis |
| `Visit.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 |
| `Visit.Diagnoses[].Name` | string or null | No | Name of the diagnosis |
| `Visit.Diagnoses[].Type` | string or null | No | Type of the diagnosis. Value set 355dbdb5-f708-4f35-8fb2-85ba4bbe67b7: Unknown, Admitting, Final, Self, Working, Principal |
| `Visit.Diagnoses[].DocumentedDateTime` | string or null | No | DateTime the diagnosis was documented. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Visit.Equipment` | Array of object | No | Specifies the equipment or resources assigned to this appointment. Each may be scheduled individually. |
| `Visit.Equipment[].Code` | string or null | No | Code for the equipment |
| `Visit.Equipment[].Codeset` | string or null | No | Code set used to identify the equipment. *Codeset will be blank for system-defined codes.* |
| `Visit.Equipment[].Description` | string or null | No | Description of the equipment. *Example: X-Ray, Therapy Ball, etc.* |
| `Visit.Equipment[].StartDateTime` | string or null | No | If the equipment's schedule is different from the appointment schedule, this is the time that this staff member is scheduled to start work. *Not supported with data on demand.* |
| `Visit.Equipment[].Duration` | number or null | No | Defines the length of time (in minutes) that the equipment is scheduled for. *Not supported with data on demand.* |
| `Patient` | object | No |  |
| `Patient.Identifiers` | Array of object | No | List of IDs and ID types that identify the patient |
| `Patient.Identifiers[].ID` | string or null | No | ID for the patient |
| `Patient.Identifiers[].IDType` | string or null | No | Type of ID. *E.g. MRN, EPI* |
| `Patient.Demographics` | object | No |  |
| `Patient.Demographics.FirstName` | string or null | No | Patient's first name |
| `Patient.Demographics.MiddleName` | string or null | No | Patient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field. |
| `Patient.Demographics.LastName` | string or null | No | Patient's last name |
| `Patient.Demographics.DOB` | string or null | No | Patient's date of birth. *In [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Patient.Demographics.SSN` | string or null | No | Patient's social security number |
| `Patient.Demographics.Sex` | string or null | No | 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 | Patient's race. Value set: 2d9b5abe-e939-4c55-b8e5-a2816ecb08eb |
| `Patient.Demographics.IsHispanic` | boolean or null | No | Indicates if the patient is of hispanic origin. Value set 731a7062-165a-434c-bef7-b02b824dfc7b: true, false, null |
| `Patient.Demographics.Religion` | string or null | No | 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 | 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 | Date and Time 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 | Patient's home phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Patient.Demographics.PhoneNumber.Office` | string or null | No | Patient's office phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Patient.Demographics.PhoneNumber.Mobile` | string or null | No | Patient's mobile phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Patient.Demographics.EmailAddresses` | Array of string | No | Patient's email address(es) |
| `Patient.Demographics.Language` | string or null | No | 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 | 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 | Patient-level notes |
| `AppointmentInfo` | Array of object | No | Contains a list of supplementary clinical information associated with the appointment. |
| `AppointmentInfo[].Code` | string or null | No | Code for the information element |
| `AppointmentInfo[].Codeset` | string or null | No | Code set used to identify the information element. *Codeset will be blank for system-defined codes. LOINC or other codesets may be used where appropriate.* |
| `AppointmentInfo[].Description` | string or null | No | Description of the information element. *Additional information that may come from patient-completed forms or other sources* |
| `AppointmentInfo[].Value` | string or null | No | Displays the value of the corresponding appointment info code. For example, the code identifies the question being answered, and this property contains the answer. |

## Example

```json
{
  "Meta": {
    "DataModel": "Scheduling",
    "EventType": "Cancel",
    "EventDateTime": "2026-11-13T22:05:58.042Z",
    "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": []
  },
  "AppointmentInfo": [
    {
      "Code": "23457",
      "Codeset": "Redox EHR Codes",
      "Description": "Priority",
      "Value": "Normal"
    },
    {
      "Code": "23457",
      "Codeset": "Redox EHR Codes",
      "Description": "Form",
      "Value": "Lumbar"
    }
  ],
  "Visit": {
    "VisitNumber": "1234",
    "AccountNumber": null,
    "VisitDateTime": "2026-11-13T22:05:58.261Z",
    "PatientClass": null,
    "Status": null,
    "Duration": 15,
    "Reason": "Check up",
    "CancelReason": "Conflicting appointment",
    "Type": null,
    "Instructions": [],
    "AttendingProvider": {
      "ID": "4356789876",
      "IDType": "NPI",
      "FirstName": "Pat",
      "LastName": "Granite",
      "Credentials": [
        "MD"
      ],
      "Address": {
        "StreetAddress": "123 Main St.",
        "City": "Madison",
        "State": "WI",
        "ZIP": "53703",
        "County": "Dane",
        "Country": "USA"
      },
      "EmailAddresses": [],
      "PhoneNumber": {
        "Office": "+16085551234"
      },
      "Location": {
        "Type": null,
        "Facility": null,
        "FacilityIdentifiers": [],
        "Department": null,
        "DepartmentIdentifiers": [],
        "Room": null
      }
    },
    "ConsultingProvider": {
      "ID": null,
      "IDType": null,
      "FirstName": null,
      "LastName": null,
      "Credentials": [],
      "Address": {
        "StreetAddress": null,
        "City": null,
        "State": null,
        "ZIP": null,
        "County": null,
        "Country": null
      },
      "EmailAddresses": [],
      "PhoneNumber": {
        "Office": null
      },
      "Location": {
        "Type": null,
        "Facility": null,
        "FacilityIdentifiers": [],
        "Department": null,
        "DepartmentIdentifiers": [],
        "Room": null
      }
    },
    "ReferringProvider": {
      "ID": null,
      "IDType": null,
      "FirstName": null,
      "LastName": null,
      "Credentials": [],
      "Address": {
        "StreetAddress": null,
        "City": null,
        "State": null,
        "ZIP": null,
        "County": null,
        "Country": null
      },
      "EmailAddresses": [],
      "PhoneNumber": {
        "Office": null
      },
      "Location": {
        "Type": null,
        "Facility": null,
        "FacilityIdentifiers": [],
        "Department": null,
        "DepartmentIdentifiers": [],
        "Room": null
      }
    },
    "VisitProvider": {
      "ID": null,
      "IDType": null,
      "FirstName": null,
      "LastName": null,
      "Credentials": [],
      "Address": {
        "StreetAddress": null,
        "City": null,
        "State": null,
        "ZIP": null,
        "County": null,
        "Country": null
      },
      "EmailAddresses": [],
      "PhoneNumber": {
        "Office": null
      },
      "Location": {
        "Type": null,
        "Facility": null,
        "FacilityIdentifiers": [],
        "Department": null,
        "DepartmentIdentifiers": [],
        "Room": null
      }
    },
    "Location": {
      "Type": "Inpatient",
      "Facility": "RES General Hospital",
      "FacilityIdentifiers": [],
      "Department": "3N",
      "DepartmentIdentifiers": [],
      "Room": "136"
    },
    "AdditionalStaff": [],
    "Diagnoses": [
      {
        "Code": "R07.0",
        "Codeset": "ICD-10",
        "Name": "Pain in throat",
        "Type": null,
        "DocumentedDateTime": null
      }
    ],
    "Equipment": []
  }
}
```