Table of contents
Used documentation
Cookbook | Version | Location |
---|---|---|
eHealthBox v3 Consultation WS | 3.2 | https://www.ehealth.fgov.be/ehealthplatform/nl/service-beveiligde-elektronische-brievenbus-ehealthbox |
General information
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
Method
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
Method
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.
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
Method
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 | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Alternative flow 1
Flow | Specifications | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Alternative flow 2
Flow | Specifications | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Remarks
to do