...
The response contains a success status code and as many OoO elements as there are OoO in the considered
eHealthBox. Each element contains all OoO data when it was inserted.
InsertOoO
The InsertOoO method is used to insert an OoO for the considered eHealthBox. In order to insert an OoO for
another eHealthBox, BoxId can be used. There are a number of rules and limitations to respect as described in Restrictions.
Request
Only one OoO can be inserted by request, but multiple substitutes may be specified.
Response
The response is “Success” without further details if everything went right. Otherwise the wrong or absent
substitutes will be returned in the response as detailed below.
DeleteOoO
The DeleteOoO method is used to delete an OoO for the considered eHealthBox. In order to delete an OoO for
another eHealthBox, BoxId can be used. The OoO Id must be specified. It can be retrieved from InsertOoO, in the
Id element or from GetOoOList.
Request
One or more OoO's can be deleted by request.
Response
The response is “Success” without further details if everything went right. Otherwise, the OoOId which could not
be found, will be returned in the response as detailed below. All other OoO that were found were deleted.
Basic flow
Flow | Specifications |
---|
|
ID | AP-UC04UC408-BF | Name | Set an out-of-office with 1 substitute | Description | / | Actor(s) | Two healthcare professionals: - One who will be OoO.
- One who will be the substitute.
| Requirements | / | Trigger | A user wants to set an out-of-office. | Precondition(s) | - The user is logged in.
- The user wants to set an out-of-office.
| Flow | - see Use case: login.
- When opening the OoO section, the application should automatically
request a list of already inserted OoO periods. - The inserted OoO period should be, for example,
from the next monday until friday of the same week. - Add the substitute (Example_Test_Actor). There are two ways to do this:
| Postcondition(s) | - The OoO is successfully added.
- There is one more OoO period than there was before the insert.
| Test Data | GetOoOList InsertOoO | Endpoint(s) | |
|
Alternative flow 1
Flow | Specifications |
---|
|
ID | AP-UC04UC408-AF01 | Name | Set an out-of-office with 2 or more substitutes | Description | / | Actor(s) | Three or more healthcare professionals: - One who will be OoO.
- Two or more who will be substitutes.
| Requirements | / | Trigger | A user wants to set an out-of-office. | Precondition(s) | - The user is logged in.
- The user wants to set an out-of-office.
| Flow | - see Use case: login.
- When opening the OoO section, the application should automatically
request a list of already inserted OoO periods. - The inserted OoO period should be, for example,
from the next monday until friday of the same week. - Add the substitutes (Example_Test_Actor1) and (ExampleTest_Actor2).
There are two ways to do this:
| Postcondition(s) | - The OoO is successfully added.
- There is one more OoO period than there was before the insert.
| Test Data | GetOoOList InsertOoO | Endpoint(s) | |
|
Alternative flow 2
Flow | Specifications |
---|
|
ID | AP-UC04UC408-AF02 | Name | Delete an out-of-office. | Description | / | Actor(s) | One healthcare professional | Requirements | / | Trigger | A user wants to delete an out-of-office. | Precondition(s) | - The user is logged in.
- The user has atleast one out-of-office period.
- The user wants to delete an out-of-office.
| Flow | - see Use case: login.
- When opening the OoO section, the application should automatically
request a list of already inserted OoO periods.
| Postcondition(s) | - The OoO is successfully deleted.
- There is one less OoO period than there was before the delete.
| Test Data | GetOoOList DeleteOoO | Endpoint(s) | |
|
Alternative flow 3
Flow | Specifications |
---|
|
ID | AP-UC04UC408-AF02 | Name | Update an out-of-office. | Description | / | Actor(s) | One healthcare professional | Requirements | / | Trigger | A user wants to update an out-of-office. | Precondition(s) | - The user is logged in.
- The user has atleast one out-of-office period.
- The user wants to update an out-of-office.
| Flow |
| Postcondition(s) | - The OoO is successfully updated.
| Test Data | GetOoOList InsertOoO DeleteOoO | Endpoint(s) | |
|
...