Used Documentation

Cookbook	Version	Location
Therapeutic Link

Web Service

WS Cookbook

1.

5

6	https://www.ehealth.fgov.be/ehealthplatform/nl/service-ehealth-therapeutic-links

General Information

Therapeutic Links

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 relationship 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 relationships 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 relationshiprelation). A therapeutic link is a relationship relation between a patient and a HC party for a certain type of therapeutic
relationship 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:

PutTherapeuticLink	Used to declare the therapeutic links. Its main purpose is to allow one to declare a therapeutic link.
RevokeTherapeuticLink	Used to revoke the therapeutic links. Its main purpose is to allow one to “end” the (declaration of a) therapeutic link.
GetTherapeuticLink	Used 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
HasTherapeuticLink	Used 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/Put	Revoke	Consult (Get)	Has
Citizen (patient, parent, mandatary)	Yes	Yes	Yes	Yes
Authorized HC Parties (HC professionals)	Yes	Yes	Yes	Yes
Authorized HC organizations	No	No	Yes	Yes

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.

cd : This is the key element used to code information: this section is completely based on the description from the KMEHR standard, as can be found on: https://www.ehealth.fgov.be/standards/kmehr/en/page/key-elements#cd
id: This element is used to uniquely identify key elements like request, response of the WS, patient, HCParty. It can also be used to specify any unique identifier: this section is completely based on the description from the KMEHR standard, as can be found on: https://www.ehealth.fgov.be/standards/kmehr/en/page/key-elements#id
HC Party: The hcparty element is a generic element that aims to represent any kind of healthcare party: organization, physician, medical specialty, or even IT systems: this section is entirely based on the description from the KMEHR standard, as can be found on: https://www.ehealth.fgov.be/standards/kmehr/en/page/hcparty

Basic Flow

Flow

Specifications

ID	ARUC-UC81263-BF
Name	Get Therapeutic Link - HC Professional - NIHII - Referral
Description	Get Therapeutic Link allows users to check the existence of therapeutic links between a HC party and a patient. HC Professional acts as author of the Get Therapeutic Link for a referral therapeutic link. Certificate used to access the WS Therapeutic Link is the personal eHealth Certificate of the end-user (HC Professional). Only following HC party categories are allowed to manage therapeutic links: Physician, Nurse, Dentist and Midwife
Actor(s)	HC Professional (Physician, Nurse, Dentist or Midwife)
, Midwife, Audician, Physiotherapist, Occupational therapist, Practical nurse, Dietician, Audiologist, Podologist, Truss maker, Logopedist, Orthoptist, Lab technologist, Imaging technologist, clinical orthopedic pedagogue
Actor(s)	HC Professional	Requirements	End-user is a HC professional (Physician, Nurse, Dentist or Midwife ) End-user manages the therapeutic links throughout his usual software Valid personal eHealth Certificate e-ID card of concerned patient Identification end-user: SSIN, NIHII (if available), professional category Identification concerned patient: SSIN, support card number (optional) Identification data concerned HC party: NIHII, HC party category, first and last name (optional) Therapeutic link type: referral Time period: start & end date Status of consulted therapeutic link Information about the evidence Type of proof: e-ID reading with pincode HC professional that performs the operations (end-user) is different from the healthcare professional concerned by the therapeutic link
Trigger	The user wants to get a therapeutic link
Precondition(s)	The user has an account for the application The user is logged out
Flow	The user attempts to access the eHealth WS Therapeutic Link The user needs to request a SAML Token by using it's personal eHealth Certificate A request for a SAML Token is sent to the Secure Token Service (STS) The STS responds with a SAML Token The user has access to the eHealth WS Therapeutic Link The user does a request to Get a Therapeutic Link The Get Therapeutic Link Request is sent to the WS Therapeutic Link ° The WS Therapeutic link responds with a Therapeutic Link Response ° The request is logged ° A list of therapeutic links fulfilling the criteria related to the concerned patient and HC party is returned
, Midwife, Audician, Physiotherapist, Occupational therapist, Practical nurse, Dietician, Audiologist, Podologist, Truss maker, Logopedist, Orthoptist, Lab technologist, Imaging technologist, clinical orthopedic pedagogue)
Requirements	End-user is a HC professional (Physician, Nurse, Dentist, Midwife, Audician, Physiotherapist, Occupational therapist, Practical nurse, Dietician, Audiologist, Podologist, Truss maker, Logopedist, Orthoptist, Lab technologist, Imaging technologist, clinical orthopedic pedagogue) End-user manages the therapeutic links throughout his usual software Valid personal eHealth Certificate e-ID card of concerned patient Identification end-user: SSIN, NIHII (if available), professional category Identification concerned patient: SSIN, support card number (optional) Identification data concerned HC party: NIHII, HC party category, first and last name (optional) Therapeutic link type: referral Time period: start & end date Status of consulted therapeutic link Information about the evidence Type of proof: e-ID reading with pincode HC professional that performs the operations (end-user) is different from the healthcare professional concerned by the therapeutic link
Trigger	The user wants to get a therapeutic link
Precondition(s)	The user has an account for the application The user is logged out
Flow	Post Condition(s)	The request is logged The user attempts to access the eHealth WS Therapeutic Link The user needs to request a SAML Token by using it's personal eHealth Certificate A request for a SAML Token is sent to the Secure Token Service (STS) The STS responds with a SAML Token The user has access to the eHealth WS Therapeutic Link The user does a request to Get a Therapeutic Link The Get Therapeutic Link Request is sent to the WS Therapeutic Link A list of therapeutic links fulfilling the criteria related to the concerned patient and HC party is returned
Test Data	Example Get Therapeutic Link p48
The request is logged The WS Therapeutic link responds with a Therapeutic Link Response
Post Condition(s)	The request is logged A list of therapeutic links fulfilling the criteria related to the concerned patient and HC party is returned
Test Data	Example Get Therapeutic Link p48
End point(s)	End point(s)	Therapeutic Links
Remarks*	Recorded date time : date time of the DB when the therapeutic link is created or revoked The author of the operation : only NIHII, if any and HC party category of the author are returned as legally the SSIN of the author cannot be known If no therapeutic links corresponding to the criteria could be found, an empty list is returned
Additional Information	If the begin date is provided then the end date must be also provided (and respectively) A therapeutic link is active when the current date is part of its period of validity
Remarks end-users	Should be available soon for clinical orthopedic pedagogue, clinical psychologist & dental hygienist

Alternative Flow

Flow

Specifications

ID	ARUC-UC81263-AF01
Name	Get Therapeutic Link - HC Professional - NIHII - Referral - no time period - no status
Description	Get Therapeutic Link allows users to check the existence of therapeutic links between a HC party and a patient. HC Professional acts as author of the Get Therapeutic Link for a referral therapeutic link. Certificate used to access the WS Therapeutic Link is the personal eHealth Certificate of the end-user (HC Professional). Only following HC party categories are allowed to manage therapeutic links: Physician, Nurse, Dentist and Midwife, Midwife, Audician, Physiotherapist, Occupational therapist, Practical nurse, Dietician, Audiologist, Podologist, Truss maker, Logopedist, Orthoptist, Lab technologist, Imaging technologist, clinical orthopedic pedagogue
Actor(s)	HC Professional (Professional Physician, Nurse, Dentist or Midwife), Midwife, Audician, Physiotherapist, Occupational therapist, Practical nurse, Dietician, Audiologist, Podologist, Truss maker, Logopedist, Orthoptist, Lab technologist, Imaging technologist, clinical orthopedic pedagogue
Requirements	End-user is a HC professional (Physician, Nurse, Dentist, Midwife, Audician, Physiotherapist, Occupational therapist, Practical nurse, Dietician, Audiologist, Podologist, Truss maker, Logopedist, Orthoptist, Lab technologist, Imaging technologist, clinical orthopedic pedagogue) End-user manages the therapeutic links throughout his usual software Valid personal eHealth	Requirements	End-user is a HC professional (Physician, Nurse, Dentist or Midwife ) End-user manages the therapeutic links throughout his usual software Valid personal eHealth Certificate e-ID card of concerned patient Identification end-user: SSIN, NIHII (if available), professional category Identification concerned patient: SSIN, support card number (optional) Identification data concerned HC party: NIHII, HC party category, first and last name (optional) Therapeutic link type: referral Information about the evidence Type of proof: e-ID reading with pincode HC professional that performs the operations (end-user) is different from the healthcare professional concerned by the therapeutic link
Trigger	The user wants to get a therapeutic link
Precondition(s)	The user has an account for the application The user is logged out
Flow	The user attempts to access the eHealth WS Therapeutic Link The user needs to request a SAML Token by using it's personal eHealth Certificate A request for a SAML Token is sent to the Secure Token Service (STS) The STS responds with a SAML Token The user has access to the eHealth WS Therapeutic Link The user does a request to Get a Therapeutic Link The Get Therapeutic Link Request is sent to the WS Therapeutic Link ° The WS Therapeutic link responds with a Therapeutic Link Response ° The request is logged ° A list of therapeutic links A list of therapeutic links fulfilling the criteria related to the concerned patient and HC party is returned The request is logged The WS Therapeutic link responds with a Therapeutic Link Response
Post Condition(s)	The request is logged A list of therapeutic links fulfilling the criteria related to the concerned patient and HC party is returned
Test Data	Example Get Therapeutic Link p48
End point(s)	Therapeutic Links
Remarks*	Recorded date time : date time of the DB when the therapeutic link is created or revoked The author of the operation : only NIHII, if any and HC party category of the author are returned as legally the SSIN of the author cannot be known If no therapeutic links corresponding to the criteria could be found, an empty list is returned
Remarks end-users	Should be available soon for clinical orthopedic pedagogue, clinical psychologist & dental hygienist

Exception Flow 1

Flow

Specifications

ID	UC-263-EF01
Name

Exception Flow 1

Flow

Specifications

End-user is a HC professional (Physician, Nurse, Dentist or Midwife )

HC party performing the consultation is excluded by

ID	AR-UC81-EF01
Name	Get Therapeutic Link - HC Professional - NIHII - Referral - HC party performing the consultation is excluded by the concerned patient
Description	Get Therapeutic Link allows users to check the existence of therapeutic links between a HC party and a patient. HC Professional acts as author of the Get Therapeutic Link for a referral therapeutic link. Certificate used to access the WS Therapeutic Link is the personal eHealth Certificate of the end-user (HC Professional). Only following HC party categories are allowed to manage therapeutic links: Physician, Nurse,Dentist and Midwife. HC party performing the consultation is excluded by the concerned patient
Actor(s)	HC Professional (Physician, Nurse, Dentist or Midwife)
Requirements
check the existence of therapeutic links between a HC party and a patient. HC Professional acts as author of the Get Therapeutic Link for a referral therapeutic link. Certificate used to access the WS Therapeutic Link is the personal eHealth Certificate of the end-user (HC Professional). Only following HC party categories are allowed to manage therapeutic links: Physician, Nurse, Dentist, Midwife, Audician, Physiotherapist, Occupational therapist, Practical nurse, Dietician, Audiologist, Podologist, Truss maker, Logopedist, Orthoptist, Lab technologist, Imaging technologist, clinical orthopedic pedagogue HC party performing the consultation is excluded by the concerned patient
Actor(s)	HC Professional (Physician, Nurse, Dentist, Midwife, Audician, Physiotherapist, Occupational therapist, Practical nurse, Dietician, Audiologist, Podologist, Truss maker, Logopedist, Orthoptist, Lab technologist, Imaging technologist, clinical orthopedic pedagogue)
Requirements	End-user is a HC professional (Physician, Nurse, Dentist, Midwife, Audician, Physiotherapist, Occupational therapist, Practical nurse, Dietician, Audiologist, Podologist, Truss maker, Logopedist, Orthoptist, Lab technologist, Imaging technologist, clinical orthopedic pedagogue) HC party performing the consultation is excluded by the concerned patient End-user manages the therapeutic links throughout his usual software Valid personal eHealth Certificate e-ID card of concerned patient Identification end-user: SSIN, NIHII (if available), professional category Identification concerned patient: SSIN, support card number (optional) Identification data concerned HC party: NIHII, HC party category, first and last name (optional) Therapeutic link type: referral Time period: start & end date Status of consulted therapeutic link Information about the evidence Type of proof: e-ID reading with pincode HC professional that performs the operations (end-user) is different from the healthcare professional concerned by the therapeutic link
Trigger	The user wants to get a therapeutic link
Precondition(s)	The user has an account for the application The user is logged out
Flow	The user attempts to access the eHealth WS Therapeutic Link The user needs to request a SAML Token by using it's personal eHealth Certificate A request for a SAML Token is sent to the Secure Token Service (STS) The STS responds with a SAML Token The user has access to the eHealth WS Therapeutic Link The user does a request to Get a Therapeutic Link The Get Therapeutic Link Request is sent to the WS Therapeutic Link The WS Therapeutic link responds with a Therapeutic Link Response: error message
Post Condition(s)	Error message
Test Data	Example Get Therapeutic Link p48
End point(s)	Therapeutic Links
Remarks end-users	Should be available soon for clinical orthopedic pedagogue, clinical psychologist & dental hygienist

Exception Flow 2

Flow

Specifications

ID	UC-263-EF02
Name	Get Therapeutic Link - HC Professional - NIHII - Referral - The therapeutic link does not exist between the HC party performing the consultation and the concerned patient
Description	Get Therapeutic Link allows users to check the existence of therapeutic links between a HC party and a patient. HC Professional acts as author of the Get Therapeutic Link for a referral therapeutic link. Certificate used to access the WS Therapeutic Link is the personal eHealth Certificate of the end-user (HC Professional). Only following HC party categories are allowed to manage therapeutic links: Physician, Nurse, Dentist, Midwife, Audician, Physiotherapist, Occupational therapist, Practical nurse, Dietician, Audiologist, Podologist, Truss maker, Logopedist, Orthoptist, Lab technologist, Imaging technologist, clinical orthopedic pedagogue. The therapeutic link does not exist between the HC party performing the consultation and the concerned patient
Actor(s)	HC Professional (Physician, Nurse, Dentist, Midwife, Audician, Physiotherapist, Occupational therapist, Practical nurse, Dietician, Audiologist, Podologist, Truss maker, Logopedist, Orthoptist, Lab technologist, Imaging technologist, clinical orthopedic pedagogue)
Requirements	End-user is a HC professional (Physician, Nurse, Dentist, Midwife, Audician, Physiotherapist, Occupational therapist, Practical nurse, Dietician, Audiologist, Podologist, Truss maker, Logopedist, Orthoptist, Lab technologist, Imaging technologist, clinical orthopedic pedagogue) The therapeutic link does not exist between the HC party performing the consultation and the concerned patient End-user manages the therapeutic links throughout his usual software Valid personal eHealth Certificate e-ID card of concerned patient Identification end-user: SSIN, NIHII (if available), professional category Identification concerned patient: SSIN, support card number (optional) Identification data concerned HC party: NIHII, HC party category, first and last name (optional) Therapeutic link type: referral Time period: start & end date Status of consulted therapeutic link Information about the evidence Type of proof: e-ID reading with pincode HC professional that performs the operations (end-user) is different from the healthcare professional concerned by the therapeutic link
Trigger	The user wants to get a therapeutic link
Precondition(s)	The user has an account for the application The user is logged out
Flow	The user attempts to access the eHealth WS Therapeutic Link The user needs to request a SAML Token by using it's personal eHealth Certificate A request for a SAML Token is sent to the Secure Token Service (STS) The STS responds with a SAML Token The user has access to the eHealth WS Therapeutic Link The user does a request to Get a Therapeutic Link The Get Therapeutic Link Request is sent to the WS Therapeutic Link The WS Therapeutic link responds with a Therapeutic Link Response: error message
Post Condition(s)	Error message
Test Data	Example Get Therapeutic Link p48
End point(s)	Therapeutic Links
Remarks end-users	Should be available soon for clinical orthopedic pedagogue, clinical psychologist & dental hygienist

Exception Flow

2

3

Flow

Specifications

ID

AR

UC-

UC81

263-

EF02

EF03
Name	Get Therapeutic Link - HC Professional - NIHII - Referral -

The therapeutic link does not exist between the HC party performing the consultation and the concerned patientActor(s)HC Professional

Sender is not allowed to perform the consultation

Description

Get Therapeutic Link allows users to check the existence of therapeutic links between a HC party and a patient.

HC Professional acts as author of the Get Therapeutic Link for a referral therapeutic link. Certificate used to access the WS Therapeutic Link is the personal eHealth Certificate of the end-user (HC Professional). Only following HC party categories are

allowed to manage therapeutic links: Physician, Nurse,Dentist and Midwife. The therapeutic link does not exist between the HC party performing the consultation and the concerned patient

allowed to manage therapeutic links: Physician, Nurse, Dentist, Midwife, Audician, Physiotherapist, Occupational therapist, Practical nurse, Dietician, Audiologist, Podologist, Truss maker, Logopedist, Orthoptist, Lab technologist, Imaging technologist, clinical orthopedic pedagogue. Sender is not allowed to perform the consultation according to the predefined rules e.g. validation on the author (NIHII valid, SSIN valid,...?)
Actor(s)	HC Professional (Physician, Nurse, Dentist, Midwife, Audician, Physiotherapist, Occupational therapist, Practical nurse, Dietician, Audiologist, Podologist, Truss maker, Logopedist, Orthoptist, Lab technologist, Imaging technologist, clinical orthopedic pedagogue)
Requirements	End-user is a HC professional

(Physician, Nurse, Dentist

or Midwife)Requirements

End-user is a HC professional (Physician, Nurse, Dentist or Midwife )

, Midwife, Audician, Physiotherapist, Occupational therapist, Practical nurse, Dietician, Audiologist, Podologist, Truss maker, Logopedist, Orthoptist, Lab technologist, Imaging technologist, clinical orthopedic pedagogue)
Sender is not allowed to perform the consultation according to the predefined rules e.g. validation on the author (NIHII valid, SSIN valid,...?)

The therapeutic link does not exist between the HC party performing the consultation and the concerned patient

End-user manages the therapeutic links throughout his usual software Valid personal eHealth Certificate e-ID card of concerned patient Identification end-user: SSIN, NIHII (if available), professional category Identification concerned patient: SSIN, support card number (optional) Identification data concerned HC party: NIHII, HC party category, first and last name (optional) Therapeutic link type: referral Time period: start & end date Status of consulted therapeutic link Information about the evidence Type of proof: e-ID reading with pincode HC professional that performs the operations (end-user) is different from the healthcare professional concerned by the therapeutic link
Trigger	The user wants to get a therapeutic link
Precondition(s)	The user has an account for the application The user is logged out
Flow	The user attempts to access the eHealth WS Therapeutic Link The user needs to request a SAML Token by using it's personal eHealth Certificate A request for a SAML Token is sent to the Secure Token Service (STS) The STS responds with a SAML Token The user has access to the eHealth WS Therapeutic Link The user does a request to Get a Therapeutic Link The Get Therapeutic Link Request is sent to the WS Therapeutic Link The WS Therapeutic link responds with a Therapeutic Link Response: error message
Post Condition(s)	Error message
Test Data	Example Get Therapeutic Link p48
End point(s)	Therapeutic Links
Remarks end-users	Should be available soon for clinical orthopedic pedagogue, clinical psychologist & dental hygienist

Page tree

Versions Compared

Old Version 52

New Version Current

Key

Used Documentation

General Information

Therapeutic Links

Basic Flow

Alternative Flow

Exception Flow 1

Exception Flow 1

Exception Flow 2

Exception Flow

3

Page tree

Page History

Versions Compared

Old Version 52

New Version Current

Key

Used Documentation

General Information

Therapeutic Links

Basic Flow

Alternative Flow

Exception Flow 1

Exception Flow 1

Exception Flow 2

Exception Flow

3