Versions Compared

Old Version 14

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
MetaHub V2 Cookbook1.
5
9https://www.ehealth.fgov.be/ehealthplatform/nl/service-
ehealth
verwijzingsrepertorium-
therapeutic
hubs-
linksIssue 20 in Jira-http://jira.ivlab.ilabt.imec.be/browse/MHEH-20?filter=-3
metahub



General Information

MetaHub

The ‘MetaHub’ component is introduced to support the interconnection between ‘Hubs’. This component is accessible to ‘recognized’ hubs. The word ‘hub’ denotes the kernel of a ‘recognized’ regional or sub regional health network.

The main purpose of the MetaHub is to allow a hub to know where it can find information about a patient outside of its network. More precisely, the MetaHub simply provides the list of hubs that have information about a patient. It is not the MetaHub’s role to know where, within a (sub)regional health network, the information is stored.

The MetaHub is thus more a ‘locator service’ than a ‘routing component’: there are no ‘document’ exchanges transiting throughout the component. MetaHub v2 also allows the hubs to consult and manage the registration of patient consents and exclusions1. A major feature is that the hubs themselves feed the MetaHub. See figure below.

Image Modified


It is not the task of the MetaHub to store or to manage any data regarding ‘therapeutic links’ nor is it the purpose of the MetaHub to register or verify the therapeutic links.
However, for some types of therapeutic links for which an authentic source is defined and available, the MetaHub will offer a ‘relay’ service to the hubs to check the existence of such a therapeutic link.
Again, the interface of the services is more ‘generic’ (in order to be aligned with the specifications defined at the hub level and to potentially support other kinds of therapeutic links if required). For more information on
the methods to use, please refer to the WS TherapeuticLink cookbook. 


PutTherapeuticLink Allows a hub to declare the therapeutic links. Its main purpose is to allow one to declare a therapeutic link.
RevokeTherapeuticLinkAllows a hub to revoke the therapeutic links. Its main purpose is to allow one to “end” the (declaration of a) therapeutic link.
GetTherapeuticLinkAllows a hub 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.


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 eHealth MetaHub WS.


Basic Flow

FlowSpecifications


ID
AR
UC-
UC35
601-BF
NamePut Therapeutic Link - Hub as author of the request
Description

Hub acts as author of the Put Therapeutic Link Request. The hub does the request for the referral therapeutic link. Certificate used to access the MetaHub WS is the eHealth Certificate of the Hub.

 

 Only following HC professional end-users are supported:

Physician, Nurse, Dentist, Midwife, Audician, Physiotherapist, Occupational therapist, Practical nurse, Dietician, Audiologist, Podologist, Truss maker, Logopedist, Orthopedist, Lab technologist, Imaging technologist

Actor(s)Health care professional through a Hub (Physician, Nurse, Dentist, Midwife, Audician, Physiotherapist, Occupational therapist, Practical nurse, Dietician, Audiologist, Podologist, Truss maker, Logopedist, Orthopedist, Lab technologist, Imaging technologist)
Requirements
  • End-user
is a
  • does the request through a Hub (Hub acts as author of the request)
  • End-user only following HC professionals: Physician, Nurse, Dentist, Midwife, Audician, Physiotherapist, Occupational therapist, Practical nurse, Dietician, Audiologist, Podologist, Truss maker, Logopedist, Orthopedist, Lab technologist, Imaging technologist
  • Valid eHealth certificate of the Hub
  • Identification Hub: ID, Organization category, Hub name (optional)
  • Identification HC Professional end-user:  INSS, NIHII (if available), HC professional category
  • SSIN of the patient
  • Therapeutic Link type: referral
  • Period of validity: 3 months
TriggerThe user wants to declare 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 to the eHealth MetaHub WS
  2. The user needs to request a SAML Token by using the eHealth Certificate of the Hub
  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 MetaHub
  6. The user does a request for Put Therapeutic Link
  7. The Put
Patient Consent
  1. Therapeutic Link Request is sent to the MetaHub WS
°
  1. The
MetaHub WS responds with a Put       °
  1. Therapeutic Link
Response
  1. is created in the MetaHub
  1. The request is logged 
      °
  1. The
Informed Patient Consent is stored in the MetaHub
  1. MetaHub WS responds with a Put Therapeutic Link Response
Post Condition(s)
  • Request is logged
  • The
informed patient consent is stored
  • therapeutic link is created in the MetaHub Database
Test Data
Active consent
no Active consent
  • Example Put Therapeutic Link unsuccessful Response
    • End Point(s)WS MetaHub
    Additional Information
    • A link between a patient and a hub indicates that at least a transaction is declared within the hub about the patient. A patient link can be declared before the
         registration of a patient’s consent. However, if there is no active consent for the patient in the system, the patient-hub link will not be returned by the
         getPatientLinks service.
    • It is only possible to declare a patient link for the hub that sends the request. The hub is identified in the sender of the request and the coherence is checked with the technical identification and authentication system.
    Database




    Exception Flow 1

    Alternative Flow

    FlowSpecifications


    IDAR-UC35-

    AF01
    EF01
    NamePut Therapeutic Link - Hub as author of the request -
    e-ID
    HC party performing the declaration is excluded by the concerned patient  
    Description

    Hub acts as author of the Put Therapeutic Link Request. The hub does the request for the referral therapeutic link. Certificate used to access the MetaHub WS is the eHealth Certificate of the Hub.

    INSS support card number used is the e-ID card

     HC party performing the declaration is excluded by the concerned patient. Authorized HC party as end-user. 

    Actor(s)
    Hub
    Authorized HC party as end-user 
    Requirements
    • End-user
    is a
    • does the request through a Hub (Hub acts as author of the request)
    • Authorized HC party as end-user 
    • Valid eHealth certificate of the Hub
    • Identification Hub: ID, Organization category, Hub name (optional)
    • Identification HC Party
    • SSIN of the patient
    • Therapeutic Link type: referral
    • Period of validity: 3 months
    • HC party performing the declaration is excluded by the concerned patient
    Patient e-ID
    TriggerThe user wants to declare 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 to the eHealth MetaHub WS
    2. The user needs to request a SAML Token by using the eHealth Certificate of the Hub
    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 MetaHub
    6. The user does a request for Put Therapeutic Link
    7. The Put
    Patient Consent
    1. Therapeutic Link Request is sent to the MetaHub WS
    2. ° The MetaHub WS responds with a Put Therapeutic Link Response

          ° The request is logged 

          ° The Informed Patient Consent is stored in the MetaHub

    1. : error message
    Post Condition(s)
    • Request is logged
    • The informed patient consent is stored in the MetaHub
    Error message
    Test Data
    Active consent
    no Active consent
  • Example Put Therapeutic Link unsuccessful Response
    • End point(s)WS MetaHub
    Additional Information
    • A link between a patient and a hub indicates that at least a transaction is declared within the hub about the patient. A patient link can be declared before the
         registration of a patient’s consent. However, if there is no active consent for the patient in the system, the patient-hub link will not be returned by the
         getPatientLinks service.
    • It is only possible to declare a patient link for the hub that sends the request. The hub is identified in the sender of the request and the coherence is checked with the technical identification and authentication system.
    Database




    Exception Flow 2

    Alternative Flow

    FlowSpecifications


    IDAR-UC35-

    AF02
    EF02
    NamePut Therapeutic Link - Hub as author of the request -
    ISI+
    An active therapeutic link does not exist between the HC party performing the declaration and the concerned patient 
    DescriptionHub acts as author of the Put Therapeutic Link Request. The hub does the request for the referral therapeutic link. Certificate used to access the MetaHub WS is the eHealth Certificate of the Hub.
     INSS support card number used is the ISI+ card.
      Authorized HC party as end-user.  An active therapeutic link does not exist between the HC party performing the declaration and the concerned patient 
    Actor(s)
    Hub
    Authorized HC party as end-user 
    Requirements
    • End-user
    is a
    • does the request through a Hub (Hub acts as author of the request)
    • Authorized HC party as end-user 
    • Valid eHealth certificate of the Hub
    • Identification Hub: ID, Organization category, Hub name (optional)
    • Identification HC Party
    • SSIN of the patient
    Patient ISI+
    • Therapeutic Link type: referral
    • Period of validity: 3 months
    • An active therapeutic link does not exist between the HC party performing the declaration and the concerned patient 
    TriggerThe user wants to declare 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 to the eHealth MetaHub WS
    2. The user needs to request a SAML Token by using the eHealth Certificate of the Hub
    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 MetaHub
    6. The user does a request for Put Therapeutic Link
    7. The Put
    Patient Consent
    1. Therapeutic Link Request is sent to the MetaHub WS
    2. ° The MetaHub WS responds with a Put Therapeutic Link Response

          ° The request is logged 

          ° The Informed Patient Consent is stored in the MetaHub

    1. : error message
    Post Condition(s)
    • Request is logged
    • The informed patient consent is stored in the MetaHub
    Error message
    Test Data
    Active consent
  • Example Put Therapeutic Link unsuccessful Response
    • no Active consent
    End point(s)WS MetaHub
    Additional Information
    • A link between a patient and a hub indicates that at least a transaction is declared within the hub about the patient. A patient link can be declared before the
         registration of a patient’s
    Database




    Exception Flow 3

    FlowSpecifications


    IDAR-UC35-EF03
    NamePut Therapeutic Link - Hub as author of the request - A valid therapeutic link of the same type and for the same HC party already exists  
    DescriptionHub acts as author of the Put Therapeutic Link Request. The hub does the request for the referral therapeutic link. Certificate used to access the MetaHub WS is the eHealth Certificate of the Hub.  Authorized HC party as end-user.  A valid therapeutic link of the same type and for the same HC party already exists  
    Actor(s)Authorized HC party as end-user 
    Requirements
    • End-user does the request through a Hub (Hub acts as author of the request)
    • Authorized HC party as end-user 
    • Valid eHealth certificate of the Hub
    • Identification Hub: ID, Organization category, Hub name (optional)
    • Identification HC Party
    • SSIN of the patient
    • Therapeutic Link type: referral
    • Period of validity: 3 months
    • A valid therapeutic link of the same type and for the same HC party already exists  
    TriggerThe user wants to declare 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 to the eHealth MetaHub WS
    2. The user needs to request a SAML Token by using the eHealth Certificate of the Hub
    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 MetaHub
    6. The user does a request for Put Therapeutic Link
    7. The Put Therapeutic Link Request is sent to the MetaHub WS
    8. ° The MetaHub WS responds with a Put Therapeutic Link Response : error message
    Post Condition(s)Error message
    Test Data
    End point(s)WS MetaHub Database
    consent. However, if there is no active consent for the patient in the system, the patient-hub link will not be returned by the
         getPatientLinks service.
    It is only possible to declare a patient link for the hub that sends the request. The hub is identified in the sender of the request and the coherence is checked with the technical identification and authentication system.