Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

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
Apollo: Use case 04: Out-of-Office.

...

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.

...

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

FlowSpecifications


IDAP-UC04-BF
NameSet 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

/

TriggerA 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
  1. see Use case: login.
  2. When opening the OoO section, the application should automatically
    request a list of already inserted OoO periods.
  3. The inserted OoO period should be, for example,
    from the next monday until friday of the same week.
  4. 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
Endpoint(s)


...