Table of Contents > Use Cases
Use Cases
The use cases below provide a basic illustration of how different actors interact with SERIS using conceptual data exchange operations described in the HL7 FHIR Implementation Guide (IG).
These use cases are intended to provide context for the data exchange operations defined in this specification. These use cases are not intended to prescribe practitioner workflow.
OR Schedule Use Cases
| S.NO | Requirement | USE CASE DESCRIPTION | SCENARIO | HTTP VERB | SAMPLE PAYLOAD LINK |
|---|---|---|---|---|---|
| 1. | Ability for facilities to submit an OR Schedule. | UC1- Designated OR Personnel creates a new OR Schedule for a shift. | Scenario 1: The Designated OR Personnel creates a new OR Schedule for a shift. | POST | Schedule_UC1-Create_OR_Schedule |
| 2. | Ability for facilities to create a block for a specific service or Surgeon(s) | UC2- Designated OR Personnel updates an OR Schedule by adding a block for a specific service and/or Surgeon(s). | Scenario 2: An Open slot exists in the Schedule. Designated OR Personnel assigns the block to the slot | POST | Schedule_UC2-Create_Block |
| 3. | Ability for facilities to remove the specific service or Surgeon(s) assigned to a block | UC3- Designated OR Personnel updates an OR Schedule by removing the block Surgeon(s) or Service. | Scenario 3: Designated OR Personnel removes the Block from the slot. | POST | Schedule_UC3-Release_Block_1 Schedule_UC3-Release_Block_2 |
| 4. | Ability for facilities to update a block | UC4- Designated OR Personnel updates the OR Schedule by updating the block Surgeon(s) or Service. | Scenario 4: Designated OR Personnel updates the Service/Surgeon allocation for a time slot. | POST | Schedule_UC4-Update_Block_Surgeon_Service_1 Schedule_UC4-Update_Block_Surgeon_Service_2 |
| 5. | Ability for facilities to update the slot metadata | UC5- Designated OR Personnel updates the OR Schedule by updating the Slot metadata (excluding changes to the Surgeons, Service, BlockType, and status). | Scenario 5: Block Frequency and/or Auto-Release hours are changed for the block. | POST | Schedule_UC5-Adjust_Block_1 Schedule_UC5-Adjust_Block_2 |
| 6. | Ability for facilities to create a new Slot | UC6- Designated OR Personnel creates a new Block/Slot in the Schedule. | Scenario 6: Designated OR Personnel creates a slot in an existing Schedule. | POST | Schedule_UC6-Create_Slot |
| 7. | Ability for facilities to close a schedule | UC7- Designated OR Personnel closes an existing OR Schedule. | Scenario 7: Designated OR Personnel inactivates the current OR schedule by adjusting the planning horizon to end at an earlier date. | POST | Schedule_UC7-Close_OR_Schedule_1 Schedule_UC7-Close_OR_Schedule_2 |
| 8. | Ability for facilities to modify the duration of available and unavailable time slots | UC8- Designated OR Personnel updates the OR schedule to modify the duration of available and unavailable timeslots. | Scenario 8.1.1: The Designated OR Personnel updates a given slot by decreasing the duration. The Designated OR Personnel also provides an adjustment reason and metadata to support the slot/block change if applicable. By decreasing the duration of a slot, a gap is created within the shift. To address this shift impact, the Designated OR Personnel adjusts the remainder of a shift by increasing the duration of other slots (s). | POST | Schedule_UC8_1-B-Adjust_Slot_1 Schedule_UC8_1-B-Adjust_Slot_2 Schedule_UC8_1-B-Adjust_Slot_3 Schedule_UC8_1-B-Adjust_Slot_4 |
| Scenario 8.1.2: The Designated OR Personnel updates a given slot by decreasing the duration. The Designated OR Personnel also provides an adjustment reason and metadata to support the slot/block change if applicable. By decreasing the duration of a slot, a gap is created within the shift. To address this shift impact, the Designated OR Personnel adjusts the remainder of a shift by adding new slot(s). | POST | Schedule_UC8_1-A-Adjust_Slot_1 Schedule_UC8_1-A-Adjust_Slot_2 Schedule_UC8_1-A-Adjust_Slot_3 | |||
| Scenario 8.2.1: By increasing the duration of a slot, an overlap is created within the shift. To address this shift impact, the Designated OR Personnel adjusts the remainder of the shift by removing impacted slots. | POST | Schedule_UC8_2-B-Adjust_Slot_1 Schedule_UC8_2-B-Adjust_Slot_2 Schedule_UC8_2-B-Adjust_Slot_3 Schedule_UC8_2-B-Adjust_Slot_4 | |||
| Scenario 8.2.2: By increasing the duration of a slot, an overlap is created within the shift. To address this shift impact, the Designated OR Personnel adjusts the remainder of the shift by decreasing the duration of impacted slot(s). | POST | Schedule_UC8_2-A-Adjust_Slot_1 Schedule_UC8_2-A-Adjust_Slot_2 Schedule_UC8_2-A-Adjust_Slot_3 Schedule_UC8_2-A-Adjust_Slot_4 | |||
| 9. | Ability for facilities to update OR location details | UC9- Designated OR Personnel updates the OR Room details (Name, MIS Functional Center, and Functional Center. | Scenario 9.1: The Designated OR Personnel updates the OR Room Name, MIS Functional Center, and Functional Center. | POST | Schedule_UC9_1-A-Update_Location_1 Schedule_UC9_1-A-Update_Location_3 |
| Scenario 9.2: The Designated OR Personnel updates the OR Room Status. | POST | Schedule_UC9_1-B-Update_Location_1 Schedule_UC9_1-B-Update_Location_3 | |||
| 10. | Ability for facilities to update future OR Schedule shift availability hours (shift operating hours) | UC10- Designated OR Personnel updates future OR Schedule shift availability hours (shift operating hours). | To update future OR Schedule shift operating hours the current schedule is to be closed, allowing for a new schedule to be created to reflect the desired future shift hours. This is achieved by performing two use cases(UC7 & UC1). Scenario 10: Designated OR Personnel updates future OR Schedule shift availability hours (shift operating hours). | POST | Schedule_UC10-Changing_Operating_Hours_1 Schedule_UC10-Changing_Operating_Hours_2 Schedule_UC10-Changing_Operating_Hours_3 |
| 11. | Ability for facilities to update OR Schedule to temporarily close an OR room | UC11- Update OR Schedule to temporarily close an OR room or temporarily reserve OR for emergency use. | To temporarily close an OR room or reserve the OR room for emergency use, the status of each Slot during the closure should be set to unavailable. A closure reason should be provided. Scenario 11:Designated OR Personnel updates the status of each Slot to be unavailable and provides an adjustment reason. | POST | Schedule_UC11-Temporary_Closure_Slot_1 Schedule_UC11-Temporary_Closure_Slot_2 |
| 12. | Ability for facilities to permanently close an OR room | UC12- Closing an OR Room permanently. | To close an OR permanently, each Schedule should be closed, along with the OR room. A closure reason must be provided. Designated OR Personnel updates the Planning Horizon to close each Schedule, closes the OR room, and provides a reason for the closure.This is achieved by performing two use cases (UC1 & UC9). Scenario 12: Designated OR Personnel close an OR Room permanently. | POST | Schedule_UC12-Close_OR_1 Schedule_UC12-Close_OR_2 Schedule_UC12-Close_OR_3 Schedule_UC12-Close_OR_4 |
| 13. | Ability for facilities to update schedule planning horizon | UC13- updating schedule planning horizon. | To update the planning horizon the current OR Schedule is to be closed, allowing for a new schedule to be created to reflect the desired future planning horizon.Designated OR Personnel closes the current schedule and creates a new Schedule with the new Planning Horizon. This is achieved by performing two use cases (UC7 & UC1). Scenario 13: Designated OR Personnel updates schedule planning horizon. | POST | Schedule_UC13-Changing_Planning_Horizon_1 Schedule_UC13-Changing_Planning_Horizon_2 Schedule_UC13-Changing_Planning_Horizon_3 |
| 14. | Ability for facilities to indicate data entered in error for an OR Schedule or Slot | UC14- Designated OR Personnel indicates that data for an OR Location, Schedule or Slot entered in error. | Scenario 14.1: The Designated OR Personnel updates an OR Schedule and marks it as entered in error. | POST | Schedule_UC14-A-Schedule_Entered_In_Error_1 Schedule_UC14-A-Schedule_Entered_In_Error_2 |
| Scenario 14.2: The Designated OR Personnel updates a Slot and marks it as entered in error. | POST | Schedule_UC14-B-Slot_Entered_In_Error_1 Schedule_UC14-B-Slot_Entered_In_Error_2 | |||
| Scenario 14.3: The Designated OR Personnel updates a Location and marks it as entered in error. | POST | Schedule_UC14-C-Location_Entered_In_Error_1 Schedule_UC14-C-Location_Entered_In_Error_2 | |||
| 15. | Ability for facilities to adjust the schedule by removing a Slot | UC15- Designated OR Personnel removes a block/slot from the OR Schedule. | Scenario 15: The Designated OR Personnel removes a block/slot from the schedule. | POST | Schedule_UC15_Remove_Slot_1 Schedule_UC15_Remove_Slot_2 |
| 16. | Ability for facilities to adjust the schedule by removing a Slot | UC16- Designated OR Personnel creates a new OR room for a Site. | Scenario 16: Designated OR Personnel creates a new OR room for a Site. | POST | Schedule_UC16-Create_OR_1 |
OR Case Use Cases
| S.NO | Requirement | USE CASE DESCRIPTION | SCENARIO | EVENT | CASE STATE | SAMPLE PAYLOAD LINK |
|---|---|---|---|---|---|---|
| 1. | Ability for facilities to submit elective surgery case information when a surgery is Booked | UC1- The Operating Room time is booked for an elective surgery by the Designated OR Personnel as requested by the Surgeon’s office. | Scenario 1: The Operating Room is booked for a new elective case; detailed information is entered in the HIS. | case-scheduled | booked | Case_UC1_Create_Case_Scheduled |
| 2. | Ability for facilities to submit updates to elective surgery case Information when a surgery is Performed. | UC2- Updating the details of a booked case. | Scenario 2: The Designated OR Personnel updates the location for the case (OR). This is achieved by performing use case UC1. | case-scheduled | booked | Case_UC2_Update_Case_Scheduled_1 Case_UC2_Update_Case_Scheduled_2 |
| 3. | Ability for facilities to submit updates to elective surgery case Information when a surgery is Performed | UC3- An elective case is performed. The Designated OR Personnel updates the case with procedure details. | Scenario 3.1: Performed Procedure details are entered in the HIS for a booked OR case. | case-performed | performed | Case_UC3_Case_Performed_1 Case_UC3_Case_Performed_2 |
| 4. | Ability for facilities to submit updates to elective surgery case Information when a surgery is Performed | UC4-The Designated OR Personnel updates the details to a performed case. | Scenario 4: This is achieved by performing Use Case (UC3): An elective case is performed. The Designated OR Personnel updates the case with procedure details | case-performed | performed | Case_UC4_Update_Case_Performed_1 Case_UC4_Update_Case_Performed_2 Case_UC4_Update_Case_Performed_3 |
| 5. | Ability for facilities to submit updates to Elective Surgery case information when surgery is Cancelled | UC5-An elective case is cancelled | Scenario 5.1: Scheduled OR Case is cancelled in advance or same day. The Designated OR Personnel updates the case with the Cancellation date and Reason. If the case is to be rescheduled, the Designated OR Personnel provides the rescheduled date. | case-cancelled | cancelled | Case_UC5_Elective_Case_Cancelled_1 Case_UC5_Elective_Case_Cancelled_2 |
| Scenario 5.2: An elective case is cancelled in-room. The Designated OR Personnel updates the case with the Cancellation date and Reason. If the case is to be rescheduled, the Designated OR Personnel provides the rescheduled date. | case-cancelled | cancelled | Case_UC5-A_Elective_Case_Cancelled_In_Room_1 Case_UC5-A_Elective_Case_Cancelled_In_Room_2 | |||
| 6. | Ability for facilities to submit Add-On Surgery case Information when a Surgery is Performed | UC6- An Add-On case is performed. | Scenario 6.1: Details of Performed Add-On OR Case details are captured in the system | case-performed | performed | Case_UC6_Addon_Case_Performed_1 |
| 7. | Ability for facilities to submit Add-On Surgery case Information when a Surgery is Cancelled | UC7- Ability for facilities to submit Add-On Surgery case Information when a Surgery is Cancelled. | Scenario 7.1: Details of in-room Cancelled Add-On OR Case details are captured in the system | case-cancelled | cancelled | Case_UC7_Addon_Case_Cancelled_1 |
| 8. | Ability for Facilities to indicate that a case was entered in error | UC8- Designated OR Personnel cancels the case and marks it entered in error | Scenario 8.1: Designated OR Personnel cancels a case with a reason of entered in error. | case-cancelled | enterred-in-error | Case_UC8_EnteredInError |