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 53 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

GetMessagesList

Method

The getMessagesList method provides a list of messages for a specific folder of your eHealthBox listed in order
by date (most recent first, index “1”). A consequence could be that if a new message arrives between two
consecutive queries, a message will be shown two times (message “1” becomes “2”, “2” becomes “3”, etc.). E.g.
if you requested the messages between “1” and “100” and then the messages between “101” and “200”, then
the message “100” would be the same as message “101”.
The messages contents are not yet returned by this method but it returns a list with all the information needed
to treat, filter, sorts the messages. The sender, recipient, title message, publication date, message size, custom
metas are all displayed for example.

Request

You can optionally request information of another of your mailboxes by specifying it via BoxId, This method can
only return 100 messages at a time; consequently, you must use it multiple times if necessary.

Example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:be:fgov:ehealth:ehbox:consultation:protocol:v3">
	<soapenv:Header/>
	<soapenv:Body>
		<urn:GetMessagesListRequest>
			<Source>INBOX</Source>
			<StartIndex>1</StartIndex>
			<EndIndex>100</EndIndex>
		</urn:GetMessagesListRequest>
	</soapenv:Body>
</soapenv:Envelope>


Response

The response contains a success status code and as many Message elements as there are messages in the
considered eHealthBox. Each element contains all necessary information to treat the message without
downloading each individual message.

Example:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
	<S:Body>
		<ns4:GetMessagesListResponse
		xmlns:ns2="urn:be:fgov:ehealth:errors:service:v1"
		xmlns:ns4="urn:be:fgov:ehealth:ehbox:consultation:protocol:v3">
			<Status>
				<Code>100</Code>
				<Message Lang="EN">SUCCESS</Message>
			</Status>
			<Source>INBOX</Source>
			<Message>
				<MessageId>9Y0002LKM100K</MessageId>
				<Destination>
					<Id>77012824158</Id>
					<Type>INSS</Type>
					<Quality>DOCTOR</Quality>
				</Destination>
				<Sender>
					<Id>71000139</Id>
					<Type>NIHII</Type>
					<Quality>HOSPITAL</Quality>
					<Name>Doe</Name>
					<FirstName>John</FirstName>
				</Sender>
				<MessageInfo>
					<PublicationDate>2011-06-28+02:00</PublicationDate>
					<ExpirationDate>2011-12-31+01:00</ExpirationDate>
					<Size>46</Size>
				</MessageInfo>
				<ContentInfo>
					<EncryptableINSSPatient>OTgwNTMwNDU3NDYyMQ0K</EncryptableINSSPatient>
					<ContentType>NEWS</ContentType>
					<Title>News in eHealthBox</Title>
					<MimeType>text/plain</MimeType>
					<HasFreeInformations>true</HasFreeInformations>
					<HasAnnex>false</HasAnnex>
				</ContentInfo>
				<ContentSpecification>
					<IsImportant>false</IsImportant>
					<IsEncrypted>false</IsEncrypted>
				</ContentSpecification>
			</Message>
		</ns4:GetMessagesListResponse>
	</S:Body>
</S:Envelope>


Basic flow

FlowSpecifications


IDAP-UC05-BF
NameView the messages in one of your message boxes
Description'One of your message boxes' is in this case one of the following: inbox, sent box, bin inbox and bin sent box.
Actor(s)One healthcare professional
Requirements

/

TriggerA healthcare professional wants to view his/her messages.
Precondition(s)
  • The user is logged in.
  • The user wants to view his/her messages.
Flow
  1. See use case: login.
  2. OPTIONAL: Information about the eHealthBox can be shown.
    See use case: eHealthBox info.
  3. The user can view the contents of one of his message boxes.
Postcondition(s)
  • The user can see the page of his chosen message box.
  • The list of messages that the users can see is correct.
Test Data
Endpoint(s)

Alternative flow 1

FlowSpecifications


IDAP-UC05-AF01
NameView the messages in one of your message boxes from another eHealthBox
Description'One of your message boxes' is in this case one of the following: inbox, sent box, bin inbox and bin sent box.
Actor(s)One healthcare professional
Requirements

/

TriggerA healthcare professional wants to view his/her messages from another eHealthBox.
Precondition(s)
  • The user is logged in.
  • The user wants to view his/her messages.
Flow
  1. See use case: login.
  2. OPTIONAL: Information about the eHealthBox can be shown.
    See use case: eHealthBox info.
  3. The user can view the contents of one of his message boxes.
Postcondition(s)
  • The user can see the page of his chosen message box.
  • The list of messages that the users can see is correct.
Test Data
Endpoint(s)
  • No labels

THIS SPACE IS UNDER CONSTRUCTION