THIS SPACE IS UNDER CONSTRUCTION

Used Documentation

CookbookVersionLocation
Therapeutic Link WS Cookbook1.6https://www.ehealth.fgov.be/ehealthplatform/nl/service-ehealth-therapeutic-links

General Information

Management of the Therapeutic Links: 

  • The eHealth consent WA will allow both patients (incl. patient's parents or mandataries) and authorized HC parties to manage the therapeutic links (declaration, revocation and consultation)
  • The authorized HC parties, citizin (incl. concerned patients, parents of patients or patient's mandataries) are also able to perform the same operations throughout their usual software by calling the eHealth therapeutic link WS. 
  • The authorized HC organizations are only authorized to verify the existence of the therapeutic links before allowing the HC parties ti access the medical data of the patients by calling the therapeutic link consultation WS through their application. 


The existence of a therapeutic relation is one of the fundamental prerequisites for the healthcare (HC) providers to access a patient’s medical data. Therefore, the eHealth platform makes available to the actors
involved in the exchange, storage or referencing personal data, a relay service to manage those therapeutic relations and associated means of evidence.

This relay service is obviously limited to kinds of therapeutic links made available at the eHealth platform level by the ‘owner’ of this therapeutic link (such as the HC party declaring a therapeutic link or the actor responsible
of a recognized specific database, e.g. for Global Medical File relation). A therapeutic link is a relation between a patient and a HC party for a certain type of therapeutic
relation over a period of validity depending on the given evidence. It is not possible to update an existing the therapeutic link; to update information you first need to revoke the existing therapeutic link.


However, the period of validity of an active therapeutic link could be extended on the condition that

  • The start date of the new period is greater or equal to the start date of the period to be extended 
  • The end date of the new period is greater than the end date of the period to be extended (overlap of period of validity) 


The following operations (request-response operation type) will support the management of these links:

PutTherapeuticLinkUsed to declare the therapeutic links. Its main purpose is to allow one to
declare a therapeutic link.
RevokeTherapeuticLinkUsed to revoke the therapeutic links. Its main purpose is to allow one to “end”
the (declaration of a) therapeutic link.
GetTherapeuticLinkUsed to consult therapeutic links according to basic search parameters. Its main
purpose is to allow one to check the existence of the therapeutic links when
executing a consultation process
HasTherapeuticLinkUsed to check the existence of a therapeutic link

 The therapeutic links are managed according to the rules corresponding to the type of therapeutic link through: 

  • Specific webservices (WS) by HC professionals as end-users through their usual software or through an authorized organization
  • A dedicated web application (WA), currently called eHealth Consent with following end-users: Patients and HC professionals/ HC professionals within an organization



Declare/PutRevokeConsult (Get)Has
Citizen (patient, parent, mandatary)YesYesYesYes
Authorized HC Parties (HC professionals)YesYesYesYes
Authorized HC organizationsNoNoYesYes



KMEHR

This service is a ‘KMEHR-based’ WS. We thus strongly recommend consulting the documentation related to the KMEHR normative elements. The KMEHR site aims to offer a central point for the documentation of the KMEHR normative elements.

https://www.ehealth.fgov.be/standards/kmehr/en

The three following generic elements are, in particular, essentials to build the request and the reply of the therapeutic link WS.

Basic Flow

FlowSpecifications

IDUC-299-BF
NameHas Ther Link - HC professional through an authorized organization
DescriptionHas Therapeutic Link allows users to check the existence of therapeutic links between a HC party and a patient. HC professional through an authorized organization
Actor(s)HC professional through an authorized organization
Requirements
  • End-user is a HC professional through an authorized organization
  • End-user manages the therapeutic links throughout his organization
  • Valid eHealth certificate of the organization
  • Identification end-user: SSIN, NIHII (if available), professional category
  • Identification HC organization: CBE or EHP number, HC party category
  • Identification concerned patient: SSIN, support card number (optional)
  • Identification data concerned HC party: SSIN,  NIHII (if available), HC party category, first and last name (optional)
  • Therapeutic link type (optional)
TriggerUser wants to check the existence of a therapeutic link between a patient and a HC professional
Precondition(s)
  • The user has an account for the application
  • The user is logged out
Flow
  1. The user attempts to access the eHealth WS Therapeutic Link
  2. The user needs to request a SAML Token by using the valid eHealth certificate of the organization
  3. A request for a SAML Token is sent to the Secure Token Service (STS)
  4. The STS responds with a SAML Token
  5. The user has access to the eHealth WS Therapeutic Link
  6. The user does a request to Has a Therapeutic Link
  7. The Has Therapeutic Link Request is sent to the WS Therapeutic Link 
  8. The WS Therapeutic link returns a boolean value
  9. The request is logged
  10. The WS Therapeutic link responds with a Therapeutic Link Response
Post Condition(s)
  • The WS Therapeutic link returns a boolean value
  • The request is logged
Test Data
End point(s)Therapeutic Links
RemarksBoolean value: It returns a true if a therapeutic link of this type exists between the patient and HC party. If no therapeutic links corresponding to the criteria could be found, the value false is returned. If no type is specified, any type of therapeutic link is considered.
Additional InformationThis operation takes a patient HC party identification and an (optional) type of therapeutic link as input. It returns true if a therapeutic link of this type exists between the patient and HC party. If no type is specified, any type of therapeutic link is considered. 

Exception Flow

FlowSpecifications

IDUC-299-EF
NameHas Ther Link - HC professional through an authorized organization - Exceptions
DescriptionHas Therapeutic Link allows users to check the existence of therapeutic links between a HC party and a patient. HC professional through an authorized organization. Possible exceptions
Actor(s)HC professional through an authorized organization
Requirements
  • End-user is a HC professional through an authorized organization
  • End-user manages the therapeutic links throughout his organization
  • Valid eHealth certificate of the organization
  • Identification end-user: SSIN, NIHII (if available), professional category
  • Identification HC organization: CBE or EHP number, HC party category
  • Identification concerned patient: SSIN, support card number (optional)
  • Identification data concerned HC party: SSIN,  NIHII (if available), HC party category, first and last name (optional)
  • Therapeutic link type (optional)
Possible exceptions
  1. Technical error
  2. Invalid data
  • Sender is not allowed to perform this operation
  • The HC party performing the operation does not have the same professional category as the HC professional concerned by the therapeutic link
  • Invalid patient (invalid SSIN or SSIN does not correspond to the provided support card number) 
  • Invalid HC party (incorrect NIHII or NIHII does not correspond to the HC professional category)
  • Invalid therapeutic link type
TriggerUser wants to check the existence of a therapeutic link between a patient and a HC professional
Precondition(s)
  • The user has an account for the application
  • The user is logged out
Flow
  1. The user attempts to access the eHealth WS Therapeutic Link
  2. The user needs to request a SAML Token by using it's personal eHealth Certificate
  3. A request for a SAML Token is sent to the Secure Token Service (STS)
  4. The STS responds with a SAML Token
  5. The user has access to the eHealth WS Therapeutic Link
  6. The user does a request to Has a Therapeutic Link
  7. The Has Therapeutic Link Request is sent to the WS Therapeutic Link 
  8. The WS Therapeutic link returns an error message
Post Condition(s)Error message
Test Data
End point(s)Therapeutic Links
Additional InformationThis operation takes a patient HC party identification and an (optional) type of therapeutic link as input. It returns true if a therapeutic link of this type exists between the patient and HC party. If no type is specified, any type of therapeutic link is considered. 
  • No labels