THIS SPACE IS UNDER CONSTRUCTION

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

Table of contents

Used documentation

CookbookVersionLocation
eHealthBox v3 Consultation WS3.2https://www.ehealth.fgov.be/ehealthplatform/nl/service-beveiligde-elektronische-brievenbus-ehealthbox

General information

GetBoxInfo

The getBoxInfo method allows an authenticated user to receive general information about his mailbox: the
current used size of your mailbox, the maximum allowed size of your mailbox, and the number of messages,
which could not be received because the mailbox was full. These messages are still waiting to be put in your
mailbox. You need to clean your mailbox until the current size is lower than the max size. The messages will then
enter into your mailbox.

Request

You can optionally request information of another of your mailboxes by specifying it via BoxId.

Response

The response contains a success status code and general information on the eHealthBox as explained below. The
BoxId element enables you to discover information on the current eHealthBox if you currently do not have any.
Attention should be paid to NbrMessagesInStandBy larger than zero and if CurrentSize > MaxSize.

Basic flow

FlowSpecifications


IDAP-UC11-BF
NameView the eHealthBox info
Description/
Actor(s)One healthcare professional
Requirements/
TriggerA healthcare professional wants to see the info of his/her eHealthBox.
Precondition(s)
  • The user is logged in.
  • The user wants to see the info of his/her eHealthBox.
Flow
  1. See use case: login.
  2. The user wants to view the contents of one of his message boxes.
    The user will see a list with all of his message for the specific folder he/she requested.
    See use case: consultation for more information about the GetMessageList method.
  3. The user selects one message to read. The message will be opened.
  4. The user, for example, clicks on a button the show the acknowledgement status of the current message.
Postcondition(s)
  • The acknowledgement status is visible and correct.
Test Data

GetBoxInfo

Endpoint(s)

Remarks

to do

  • No labels

THIS SPACE IS UNDER CONSTRUCTION