Versions Compared

Key

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

Used Documentation

Cookbook / MaterialsVersionLocation
Consent WS
MetaHub V2 Cookbook1.9https://www.ehealth.fgov.be/ehealthplatform/nl/service
-ehealthconsentSecure Token Service 1.3
-verwijzingsrepertorium-hubs-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 Added


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/

ehealthplatform

standards/

nl/service-iam-identity-access-management

kmehr/en

The three following generic elements are, in particular, essentials to build the request and the reply of eHealth MetaHub WS.

MetaHub V2 Cookbook1.9
  • 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:

ehealthplatform/nl/service-verwijzingsrepertorium-hubs-metahub

General Information

Basic Flow

FlowSpecification


IDUC-501-BF
NamePut Patient Consent - Hub as author of the request
DescriptionHub acts as author of the Informed Patient Consent Request. The hub does the request. Certificate used to access the MetaHub WS is the eHealth Certificate of the Hub. 
Actor(s)
  • Hub
Requirements
  • End-user is a Hub (Hub acts as author of the request)
  • Valid eHealth certificate of the Hub
  • Identification of the Hub: Hub ID, organization category, Name (optional)
  • Information consent : 

      °Patient SSIN 

      °Patient SSIN Support card number (optional)

      °Date of registration consent by the patient

      °Type of consent: retrospective

TriggerThe user wants to declare a Patient Consent on behalf of the patient
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 Patient Consent 
  7. The Put Patient Consent Request is sent to the MetaHub WS
  8. The Informed Patient Consent is stored in the MetaHub
  9. The request is logged 
  10. The MetaHub WS responds with a Put Patient Consent Response
Post condition(s)
  • Request is logged
  • The informed patient consent is stored in the MetaHub
Test Data 
Endpoint(s)
  • MetaHub WS
Remarks *Patient SSIN Support card number is optional, if provided then the card number is ignored (INSS and support card number are not submitted to status validation) Hub Third Trusted Party
Additional InformationAdditional information of the hub as name is optional. If provided, it will be used for audit purposes. 



Exception Flow

FlowSpecifications


IDUC-501-EF
NamePut Patient Consent - Hub as author of the request - There already exists an active consent for the concerned patient
DescriptionHub acts as author of the Informed Patient Consent Request. The hub does the request. Certificate used to access the MetaHub WS is the eHealth Certificate of the Hub. There already exists an active consent for the concerned patient
Actor(s)
  • Hub
Requirements
  • End-user is a Hub (Hub acts as author of the request)
  • Valid eHealth certificate of the Hub
  • Identification of the Hub: Hub ID, organization category, Name (optional)
  • Information consent : 

      °Patient SSIN 

      °Patient SSIN Support card number (optional)

      °Date of registration consent by the patient

      °Type of consent: retrospective

  • There already exists an active consent for the concerned patient
TriggerThe user wants to declare a Patient Consent on behalf of the patient
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 Patient Consent 
  7. The Put Patient Consent Request is sent to the MetaHub WS
  8. The MetaHub WS responds with a Put Patient Consent Response: error message
Post Condition(s)Error message
Test Data
End point(s)
  • MetaHub
Basic Flow - Health Care giver AR78 put patient consent through HUB → HUB certificate → Metahub
  • WS