Table of contents
Used documentation
Restrictions
- A person cannot be defined as a substitute if he is already absent for this period (or part of the period).
- It is however possible to introduce an OoO while being a substitute for someone else.
- A person may be substitute for several other persons.
- The absent person and his substitutes are persons, not organizations.
- A person is identified by his ID and his quality.
- There may be maximum five substitues per OoO.
- A maximum of ten periods OoO may exist per eHealthBox.
- OoO periods may not overlap.
- A period may not end later than J + 1 year.
- A period can last up to 1 year.
- The end date is mandatory.
A WS request contains one period and a maximum of five substitutes may be specified for that period.
The OoO activates automatically when the time is reached.
GetOoOList
The GetOoOList method is used to list all inserted OoO for the considered eHealthBox. The list contains all OoO:
past, active and future OoO. The OoOId returned can further be used to delete an OoO.
Request
Response
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.
Basic flow
| Flow | Specifications |
|---|
| | ID | UC408-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 | UC408-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 | UC408-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 | UC408-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) | |
|