THIS SPACE IS UNDER CONSTRUCTION

  • Created by Unknown User (gaelle.laurent.ext@imec.be), last modified on Aug 27, 2019

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 - HC Professional - eID - Referral - Binary Proof

FlowSpecifications

IDUC-225-BF
NamePut Therapeutic Link - HC Professional – e-ID - Referral
Description

Put Therapeutic Link, service used to declare a therapeutic link between a patient and a HC party.

HC Professional acts as author of the referral Therapeutic Link. The given proof is the e-ID reading with PIN code 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 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 
  • HC professional that performs the operations (end-user) is different from the healthcare professional concerned by the therapeutic link
  • Identification HC professional: SSIN, NIHII (if available), HC professional category
  • Identification concerned patient: SSIN, e-ID card number, first and family name
  • Identification concerned HC party: SSIN, NIHII (if available), HC party category, first and family name (optional)
  • Type of therapeutic link: referral
  • Period of validity: 3 months
  • Type of proof: e-ID reading with pincode
TriggerThe user wants to put 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 for Put Therapeutic Link
  7. The Put Therapeutic Link Request is sent to the WS Therapeutic Link 
  8. The Therapeutic link is created in eHealth Database
  9. The request is logged 
  10. The WS Consent responds with a Therapeutic Link Response
Post condition(s)
  • Request is logged
  • The Therapeutic Link is created in eHealth Database
Test Data
Endpoint(s)Therapeutic Links Database
Additional Information
  • Start date: If not provided the start date is enriched with the date when the declaration request is processed i.e. the current date
  • End date: if not provided then the end date is enriched with the ED=SD + default period of validity. Default period of validity is ED= SD+3 months
Remarks end-usersShould be available soon for clinical orthopedic pedagogue, clinical psychologist & dental hygienist

Alternative Flow

FlowSpecifications

IDUC-225-AF
NamePut Therapeutic Link - HC Professional – e-ID - Referral - Start & end date
Description

Put Therapeutic Link, service used to declare a therapeutic link between a patient and a HC party.

HC Professional acts as author of the referral Therapeutic Link. The given proof is the e-ID reading with PIN code 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 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 
  • HC professional that performs the operations (end-user) is different from the healthcare professional concerned by the therapeutic link
  • Identification HC professional: SSIN, NIHII (if available), HC professional category
  • Identification concerned patient: SSIN, e-ID card number, first and family name
  • Identification concerned HC party: SSIN, NIHII (if available), HC party category, first and family name (optional)
  • Type of therapeutic link: referral
  • Period of validity: 3 months
  • Type of proof: e-ID reading with pincode
  • Inclusive start date
  • Exclusive end date
TriggerThe user wants to put 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 for Put Therapeutic Link
  7. The Put Therapeutic Link Request is sent to the WS Therapeutic Link 
  8. The Therapeutic link is created in eHealth Database
  9. The request is logged 
  10. The WS Consent responds with a Therapeutic Link Response
Post Condition(s)
  • Request is logged
  • The Therapeutic Link is created in eHealth Database
Test Data
End point(s)Therapeutic Links Database
Remarks*
  • Start date must be equal to the declaration date i.e. the date when the declaration request is processed (the current date) else the request is rejected)
  • End date must be equal to start date plus the default period of validity else the end-date is discarded and enriched with the ED=SD the default period of validity

The default period of validity is ED=SD + 3 months

Additional InformationFor the overlapped relations, the start date of the new period must be greater or equal to the start date of the period to extended and the end-date of the new period must be greater than the end-date of the period to be extended
Remarks end-usersShould be available soon for clinical orthopedic pedagogue, clinical psychologist & dental hygienist

Exception Flow 1

FlowSpecifications

IDUC-225-EF01
NamePut Therapeutic Link - HC Professional – e-ID - Referral - HC party performing the declaration is excluded by the concerned patient 
Description

Put Therapeutic Link, service used to declare a therapeutic link between a patient and a HC party.

HC Professional acts as author of the referral Therapeutic Link. The given proof is the e-ID reading with PIN code 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. HC party performing the declaration 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).  (HC party performing the declaration is excluded by the concerned patient)

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 declaration 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 
  • HC professional that performs the operations (end-user) is different from the healthcare professional concerned by the therapeutic link
  • Identification HC professional: SSIN, NIHII (if available), HC professional category
  • Identification concerned patient: SSIN, e-ID card number, first and family name
  • Identification concerned HC party: SSIN, NIHII (if available), HC party category, first and family name (optional)
  • Type of therapeutic link: referral
  • Period of validity: 3 months
  • Type of proof: e-ID reading with pincode
TriggerThe user wants to put 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 for Put Therapeutic Link
  7. The Put Therapeutic Link Request is sent to the WS Therapeutic Link
  8. The WS Consent responds with a Therapeutic Link Response : error message
Post Condition(s)Error message
Test Data
End point(s)Therapeutic Links Database
Remarks end-usersShould be available soon for clinical orthopedic pedagogue, clinical psychologist & dental hygienist

Exception Flow 2

FlowSpecifications

IDUC-225-EF02
NamePut Therapeutic Link - HC Professional – e-ID - Referral - An active therapeutic link does not exist between the HC party performing the declaration and the concerned patient
Description

Put Therapeutic Link, service used to declare a therapeutic link between a patient and a HC party.

HC Professional acts as author of the referral Therapeutic Link. The given proof is the e-ID reading with PIN code 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. An active therapeutic link does not exist between the HC party performing the declaration 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)
  • End-user manages the therapeutic links throughout his usual software
  • Valid personal eHealth Certificate
  • e-ID card of concerned patient 
  • HC professional that performs the operations (end-user) is different from the healthcare professional concerned by the therapeutic link
  • Identification HC professional: SSIN, NIHII (if available), HC professional category
  • Identification concerned patient: SSIN, e-ID card number, first and family name
  • Identification concerned HC party: SSIN, NIHII (if available), HC party category, first and family name (optional)
  • Type of therapeutic link: referral
  • Period of validity: 3 months
  • Type of proof: e-ID reading with pincode
  • An active therapeutic link does not exist between the HC party performing the declaration and the concerned patient
TriggerThe user wants to put 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 for Put Therapeutic Link
  7. The Put Therapeutic Link Request is sent to the WS Therapeutic Link
  8. The WS Consent responds with a Therapeutic Link Response : error message
Post Condition(s)Error message
Test Data
End point(s)Therapeutic Links Database
Remarks end-usersShould be available soon for clinical orthopedic pedagogue, clinical psychologist & dental hygienist

Exception Flow 3

FlowSpecifications

IDUC-225-EF03
NamePut Therapeutic Link - HC Professional – e-ID - Referral - A valid therapeutic link of the same type and for the same HC party already exists
Description

Put Therapeutic Link, service used to declare a therapeutic link between a patient and a HC party.

HC Professional acts as author of the referral Therapeutic Link. The given proof is the e-ID reading with PIN code 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. A valid therapeutic link of the same type and for the same HC party already exists

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)
  • End-user manages the therapeutic links throughout his usual software
  • Valid personal eHealth Certificate
  • e-ID card of concerned patient 
  • HC professional that performs the operations (end-user) is different from the healthcare professional concerned by the therapeutic link
  • Identification HC professional: SSIN, NIHII (if available), HC professional category
  • Identification concerned patient: SSIN, e-ID card number, first and family name
  • Identification concerned HC party: SSIN, NIHII (if available), HC party category, first and family name (optional)
  • Type of therapeutic link: referral
  • Period of validity: 3 months
  • Type of proof: e-ID reading with pincode
  •  A valid therapeutic link of the same type and for the same HC party already exists
TriggerThe user wants to put 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 for Put Therapeutic Link
  7. The Put Therapeutic Link Request is sent to the WS Therapeutic Link
  8. The WS Consent responds with a Therapeutic Link Response : error message
Post Condition(s)Error message
Test Data
End point(s)Therapeutic Links Database
Remarks end-usersShould be available soon for clinical orthopedic pedagogue, clinical psychologist & dental hygienist

Exception Flow 4

FlowSpecifications

IDUC-225-EF04
NamePut Therapeutic Link - HC Professional – e-ID - Referral - Sender not allowed to perform the declaration
Description

Put Therapeutic Link, service used to declare a therapeutic link between a patient and a HC party.

HC Professional acts as author of the referral Therapeutic Link. The given proof is the e-ID reading with PIN code 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. 

The sender is not allowed to perform the declaration 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, 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 
  • HC professional that performs the operations (end-user) is different from the healthcare professional concerned by the therapeutic link
  • Identification HC professional: SSIN, NIHII (if available), HC professional category
  • Identification concerned patient: SSIN, e-ID card number, first and family name
  • Identification concerned HC party: SSIN, NIHII (if available), HC party category, first and family name (optional)
  • Type of therapeutic link: referral
  • Period of validity: 3 months
  • Type of proof: e-ID reading with pincode
  • The sender is not allowed to perform the declaration according to the predefined rules e.g. validation on the author (NIHII valid, SSIN valid,...?)
TriggerThe user wants to put 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 for Put Therapeutic Link
  7. The Put Therapeutic Link Request is sent to the WS Therapeutic Link
  8. The WS Consent responds with a Therapeutic Link Response : error message
Post Condition(s)Error message
Test Data
End point(s)Therapeutic Links Database
Remarks end-users Should be available soon for clinical orthopedic pedagogue, clinical psychologist & dental hygienist
  • No labels

THIS SPACE IS UNDER CONSTRUCTION