Versions Compared

Old Version 21

changes.mady.by.user Unknown User (gaelle.laurent.ext@imec.be)

Saved on

compared with

New Version Current

changes.mady.by.user Unknown User (gaelle.laurent.ext@imec.be)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Used Documentation

Cookbook
/ Materials
VersionLocation
Therapeutic Link
Web Service
WS Cookbook1.
5
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 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:

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


ID
AR
UC-
UC14
226-BF
NamePut Therapeutic Link - HC Professional – new-
born - Non-referral
born 
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

non-referral Actor(s)
  • HC Professional (Physician, Nurse, Dentist or Midwife)
RequirementsEnd-user is a HC professional

Put Therapeutic Link for a new-born. The concept of proof is not applied when the concerned patient is a new-born. 

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

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 
  • (Physician, Nurse, Dentist
or Midwife )
  • End-user manages the therapeutic links throughout his usual software
  • Valid personal eHealth Certificate
  • Concerned patient is a new-born
  • Identification HC professional: SSIN, NIHII (if available), HC professional category
  • Identification concerned patient: SSIN, first and family name
  • Identification concerned HC party: SSIN, NIHII, HC party category, first and family name (optional)
  • Type of therapeutic link: non-referral
  • Period of validity: 15 months
    • , 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
    • Concerned patient is a new-born
    • Identification HC professional: SSIN, NIHII (if available), HC professional category
    • Identification concerned patient: SSIN, first and family name
    • Identification concerned HC party: SSIN, NIHII, HC party category, first and family name (optional)
    • Type of therapeutic link

          °physician: gpconsultation or specialistconsultation 

          °nurse: nurseconsultation 

          °other professionals: consultation 

    • Period of validity: 15 months
    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
    TriggerThe user wants to put 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
    1. is sent to the Secure Token Service (STS)
    2. The STS responds with a SAML Token
    3. The user has access to the eHealth WS Therapeutic Link
    4. The user does a request for Put Therapeutic Link
    5. The Put Therapeutic Link Request is sent to the WS Therapeutic Link 
    ° Post
    1. The Therapeutic link is created in eHealth Database
    2. The request is logged
    3. The WS Consent responds with a Therapeutic Link Response

          ° The request is logged 

          ° The Therapeutic link is created in eHealth Database

    Post condition(s)
    • Request is logged
    • The Therapeutic Link is created in eHealth Database
    Test Data
    Endpoint(s)Therapeutic Links Database
    Remarks end-usersShould be available soon for clinical orthopedic pedagogue, clinical psychologist & dental hygienist



    Alternative Flow

    FlowSpecifications


    ID
    AR
    UC-
    UC14
    226-AF01
    NamePut Therapeutic Link - HC Professional – new-born
    - Non
    -
    referral -
    Comment 
    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

    non-referral

    Put Therapeutic Link for a new-born. The concept of proof is not applied when the concerned patient is a new-born. 

    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

    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)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
    • Concerned patient is a new-born
    • Identification HC professional: SSIN, NIHII (if available), HC professional category
    • Identification concerned patient: SSIN, first and family name
    • Identification concerned HC party: SSIN, NIHII, HC party category, first and family name (optional)
    • Type of therapeutic link: non-referral
    • Period of validity: 15 months
    • Comment to justify the declaration
    TriggerThe user wants to put 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
    • , 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
    • Concerned patient is a new-born
    • Identification HC professional: SSIN, NIHII (if available), HC professional category
    • Identification concerned patient: SSIN, first and family name
    • Identification concerned HC party: SSIN, NIHII, HC party category, first and family name (optional)
    • Type of therapeutic link

          °physician: gpconsultation or specialistconsultation 

          °nurse: nurseconsultation 

          °other professionals: consultation 

    • Period of validity: 15 months
    • Comment to justify the declaration
    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
    The user needs to request a SAML Token by using
    1. it's personal eHealth Certificate
    2. A request for a SAML Token is sent to the Secure Token Service (STS)
    3. The STS responds with a SAML Token
    4. The user has access to the eHealth WS Therapeutic Link
    5. The user does a request for Put Therapeutic Link
    6. The Put Therapeutic Link Request is sent to the WS Therapeutic Link 
    ° Post
    1. The Therapeutic link is created in eHealth Database
    2. The request is logged
    3. The WS Consent responds with a Therapeutic Link Response

          ° The request is logged 

          ° The Therapeutic link is created in eHealth Database

    Post Condition(s)
    • Request is logged
    • The Therapeutic Link is created in eHealth Database
    Test Data
    End point(s)Therapeutic Links Database
    Remarks end-usersShould be available soon for clinical orthopedic pedagogue, clinical psychologist & dental hygienist



    Exception Flow 1

    FlowSpecifications


    ID
    AR
    UC-
    UC14
    226-EF01
    NamePut Therapeutic Link - HC Professional – new-born
    - Non
    -
    referral -
    HC party performing the declaration does not belong to the same HC party category as the HC party concerned by the therapeutic link
    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

    non-referral

    Put Therapeutic Link for a new-born. The concept of proof is not applied when the concerned patient is a new-born. 

    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

    and Midwife.

    , 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 does not belong to the same HC party category as the HC party concerned by the therapeutic link

    Actor(s)
    • HC
    Professional
    • Professional (Physician, Nurse, Dentist
    or Midwife)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
    • Concerned patient is a new-born
    • Identification HC professional: SSIN, NIHII (if available), HC professional category
    • Identification concerned patient: SSIN, first and family name
    • Identification concerned HC party: SSIN, NIHII, HC party category, first and family name (optional)
    • Type of therapeutic link: non-referral
    • Period of validity: 15 months
    • Comment to justify the declaration
    • HC party performing the declaration does not belong to the same HC party category as the HC party concerned by the therapeutic link
    TriggerThe user wants to put 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
    • , 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
    • Concerned patient is a new-born
    • Identification HC professional: SSIN, NIHII (if available), HC professional category
    • Identification concerned patient: SSIN, first and family name
    • Identification concerned HC party: SSIN, NIHII, HC party category, first and family name (optional)
    • Type of therapeutic link

          °physician: gpconsultation or specialistconsultation 

          °nurse: nurseconsultation 

          °other professionals: consultation 

    • Period of validity: 15 months
    • Comment to justify the declaration
    • HC party performing the declaration does not belong to the same HC party category as the HC party concerned by the therapeutic link
    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
    A request for a SAML Token
    1. is sent to the Secure Token Service (STS)
    2. The STS responds with a SAML Token
    3. The user has access to the eHealth WS Therapeutic Link
    4. The user does a request for Put Therapeutic Link
    5. The Put Therapeutic Link Request is sent to the WS Therapeutic Link 
    6. 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

    Exception Flow 2

    FlowSpecificationsIDAR-UC14-EF02
    FlowSpecifications


    IDUC-226-EF02
    NamePut Therapeutic Link - HC Professional – new-born
    - Non-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

    non-referral

    Put Therapeutic Link for a new-born. The concept of proof is not applied when the concerned patient is a new-born. 

    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
    • Concerned patient is a new-born
    • Identification HC professional: SSIN, NIHII (if available), HC professional category
    • Identification concerned patient: SSIN, first and family name
    • Identification concerned HC party: SSIN, NIHII, HC party category, first and family name (optional)
    • Type of therapeutic link

          °physician: gpconsultation or specialistconsultation 

          °nurse: nurseconsultation 

          °other professionals: consultation 

    • Period of validity: 15 months
    • Comment to justify the declaration
    • 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 3

    FlowSpecifications


    IDUC-226-EF03
    NamePut Therapeutic Link - HC Professional – new-born - 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 Put Therapeutic Link for a new-born. The concept of proof is not applied when the concerned patient is a new-born. 

    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

    concept of proof

    sender is not

    applied when the concerned patient is a new-born. 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:

    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

    and Midwife. A valid therapeutic link of the same type and for the same HC party already existsActor(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)

    Requirements
    • End-user is a HC
    professional (Physician, Nurse, Dentist or Midwife 
    • 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
    • Concerned patient is a new-born
    • Identification HC professional: SSIN, NIHII (if available), HC professional category
    • Identification concerned patient: SSIN, first and family name
    • Identification concerned HC party: SSIN, NIHII, HC party category, first and family name (optional)
    • Type of therapeutic link
    : non-referral

          °physician: gpconsultation or specialistconsultation 

          °nurse: nurseconsultation 

          °other professionals: consultation 

    • Period of validity: 15 months
    • Comment to
    justify the declaration
    • justify the declaration
    • The sender is not allowed to perform the declaration according to the predefined rules e.g. validation on the author (NIHII valid, SSIN valid,...?)
    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