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-273-BF
NameGet Therapeutic Link -  HC Professional - HC party not in request - e- ID encoding
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. The given proof is the e-ID encoding of the patient. Certificate used to access the WS Therapeutic Link is the 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

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 different from the concerned 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 HC professional: SSIN, NIHII (if available), HC professional category
  • Identification concerned patient: SSIN, support card number (optional)
  • *Type of therapeutic link: 

      °physician: gpconsultation or specialistconsultation or patientmanagement

      °nurse: nurseconsultation or patientmanagement

      °other professionals: consultation or patientmanagement

  • Type of proof: e-ID card encoding
  • Time period
  • Status of consulted therapeutic link
TriggerThe user wants to get a therapeutic link
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 Get a Therapeutic Link
  7. The Get Therapeutic Link Request is sent to the WS Therapeutic Link 
  8. The therapeutic links of the concerned patient and the concerned author, the therapeutic links of the concerned patient and other concerned HC parties are returned
  9. The request is logged
  10. The WS Therapeutic link responds with a Therapeutic Link Response
Post Condition(s)
  • The request is logged
  • The therapeutic links of the concerned patient and the concerned author, the therapeutic links of the concerned patient and other concerned HC parties are returned
Test DataExample 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
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-usersShould be available soon for clinical orthopedic pedagogue, clinical psychologist & dental hygienist

Alternative Flow

FlowSpecifications

IDUC-273-AF01
NameGet Therapeutic Link -  HC Professional - HC party not in request - e- ID encoding- 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. The given proof is the e-ID encoding of the patient. Certificate used to access the WS Therapeutic Link is the 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

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 different from the concerned 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 HC professional: SSIN, NIHII (if available), HC professional category
  • Identification concerned patient: SSIN, support card number (optional)
  • *Type of therapeutic link:  

      °physician: gpconsultation or specialistconsultation or patientmanagement

      °nurse: nurseconsultation or patientmanagement

      °other professionals: consultation or patientmanagement

  • Type of proof: e-ID card encoding
TriggerThe user wants to get a therapeutic link
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 Get a Therapeutic Link
  7. The Get Therapeutic Link Request is sent to the WS Therapeutic Link 
  8. The therapeutic links of the concerned patient and the concerned author, the therapeutic links of the concerned patient and other concerned HC parties are returned
  9. The request is logged
  10. The WS Therapeutic link responds with a Therapeutic Link Response
Post Condition(s)
  • The request is logged
  • The therapeutic links of the concerned patient and the concerned author, the therapeutic links of the concerned patient and other concerned HC parties are returned
Test DataExample Get Therapeutic Link p48
End pointsTherapeutic 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-usersShould be available soon for clinical orthopedic pedagogue, clinical psychologist & dental hygienist

Exception Flow 1

FlowSpecifications

IDUC-273-EF01
NameGet Therapeutic Link -  HC Professional - HC party not in request - e- ID encoding- The HC party performing the consultation does not have the same professional category as the HC professional concerned by the therapeutic link
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. The given proof is the e-ID encoding of the patient. Certificate used to access the WS Therapeutic Link is the 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 pedagogueThe HC party performing the consultation does not have the same professional category as the HC professional concerned by the therapeutic link

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 different from the concerned 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 HC party performing the consultation does not have the same professional category as the HC professional concerned by the therapeutic link
  • End-user manages the therapeutic links throughout his usual software
  • Valid personal eHealth Certificate
  • e-ID card of concerned patient
  • Identification HC professional: SSIN, NIHII (if available), HC professional category
  • Identification concerned patient: SSIN, support card number (optional)
  • *Type of therapeutic link:  

      °physician: gpconsultation or specialistconsultation or patientmanagement

      °nurse: nurseconsultation or patientmanagement

      °other professionals: consultation or patientmanagement

  • Type of proof: e-ID card encoding
  • Time period
  • Status of consulted therapeutic link
TriggerThe user wants to get a therapeutic link
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 Get a Therapeutic Link
  7. The Get Therapeutic Link Request is sent to the WS Therapeutic Link 
  8. The WS Therapeutic link responds with a Therapeutic Link Response: error message
Post Condition(s)Error message
Test DataExample Get Therapeutic Link p48
End point(s)Therapeutic Links
Remarks end-usersShould be available soon for clinical orthopedic pedagogue, clinical psychologist & dental hygienist

Exception Flow 2

FlowSpecifications

IDUC-273-EF02
NameGet Therapeutic Link -  HC Professional - HC party not in request - e- ID encoding-  Sender is not allowed to perform the consultation according to the predefined rules e.g. validation on the author (NIHII valid, SSIN valid,...?)
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. The given proof is the e-ID encoding of the patient. Certificate used to access the WS Therapeutic Link is the 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 pedagogueSender 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 different from the concerned 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 HC party performing the consultation does not have the same professional category as the HC professional concerned by the therapeutic link
  • End-user manages the therapeutic links throughout his usual software
  • Valid personal eHealth Certificate
  • e-ID card of concerned patient
  • Identification HC professional: SSIN, NIHII (if available), HC professional category
  • Identification concerned patient: SSIN, support card number (optional)
  • *Type of therapeutic link: 

      °physician: gpconsultation or specialistconsultation or patientmanagement

      °nurse: nurseconsultation or patientmanagement

      °other professionals: consultation or patientmanagement

  • Type of proof: e-ID card encoding
  • Time period
  • Status of consulted therapeutic link
  • Sender is not allowed to perform the consultation according to the predefined rules e.g. validation on the author (NIHII valid, SSIN valid,...?)
TriggerThe user wants to get a therapeutic link
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 Get a Therapeutic Link
  7. The Get Therapeutic Link Request is sent to the WS Therapeutic Link 
  8. The WS Therapeutic link responds with a Therapeutic Link Response: error message
Post Condition(s)Error message
Test DataExample Get Therapeutic Link p48
End point(s)Therapeutic Links
Remarks end-usersShould be available soon for clinical orthopedic pedagogue, clinical psychologist & dental hygienist
  • No labels