Versions Compared

Key

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

Table of Contents

Used documentation

Cookbook/ materialsVersionLocation
eHealthConsent WS Cookbook1.9

https://www.ehealth.fgov.be/ehealthplatform/file/view/7cd655bc5f9ec7be387cfbc2d8710b5d?filename=cookbook_ehealthconsent_web_service.pdf

API eHealth Consent2.0http://jira.ivlab.ilabt.imec.be/secure/attachment/17424/swagger_consent_2-0-2.json
KMEHR-https://www.ehealth.fgov.be/standards/kmehr/en
Jira ticket MHEH-12-

Jira
serverimec Validation Lab
serverIdac11aa92-3976-3161-9ddb-5020cc76f1c7
keyMHEH-12

Jira ticket MHEH-13-
Jira
serverimec Validation Lab
serverIdac11aa92-3976-3161-9ddb-5020cc76f1c7
keyMHEH-13
Jira ticket MHEH-18-
Jira
serverimec Validation Lab
serverIdac11aa92-3976-3161-9ddb-5020cc76f1c7
keyMHEH-18
Jira ticket MHEH-20-

Jira
serverimec Validation Lab
serverIdac11aa92-3976-3161-9ddb-5020cc76f1c7
keyMHEH-20

Jira ticket MHEH-26- Jiraserverimec Validation LabserverIdac11aa92-3976-3161-9ddb-5020cc76f1c7keyMHEH-26
Jira ticket MHEH-31-

Jira
serverimec Validation Lab
serverIdac11aa92-3976-3161-9ddb-5020cc76f1c7
keyMHEH-31

Jira ticket MHEH-32-
Jira
serverimec Validation Lab
serverIdac11aa92-3976-3161-9ddb-5020cc76f1c7
keyMHEH-32

General information

In the figure below, we present a logical view about the relationship between the three basic services of the ehealth platform that are the WS Consent, the Therapeutic link WS, and the Therapeutic exclusion services. A consent can be managed by different types of end-users:

...

A consent may have two types. Indeed, it is called prospective when it is valuable for data posterior to the signing date (i.e. the date that should be taken into account is the ‘medical date’ of the transaction). It is referred to as retrospective in the opposite case. This does not mean that all documents with a medical date anterior to the signing date of the consent will automatically be made available

The The API eHealth Consent service provides four five methods (it . It is noteworthy that in this use case only the GetPatientConsent Ge tPatient Consent method is used):

...

.

...

Image Added



Basic flow

FlowSpecification






Image Added

Use case ID

ATH-UC-

12

16-BF

Use case name

Consult the consent of a patient using the 

GetPatientConsent method

GET /consents/{patientSsin} operation

Actors

  • Citizen

  • HC party

Short Description

In order

This use case enables to consult the consent status of a given patient using the

SOA-based version, it is important to use the Token exchange service in order to convert a JWT message into a SAML one (and vice versa). The aim of this use case is to check a consent status after its activation or revoke.

REST version of the WS Consent. 

Priority

1 (High)

Must have: The system must implement this goal/ assumption to be accepted.

Pre-Conditions

  • The user is already logged-in
via the Token exchange service
  • Information about the request (request identifier, end-user identifier, date and time of the request)
    • in the IAM connect 
    • SSIN of the concerned patient 
  • Type of the consent (optional)
  • Post-Conditions

  • Information about the response (response identifier, end-user identifier, data and time of the response, initial request)

  • An acknowledgement (status of the completion, errors if exist)
    • The SSIN of the concerned patient 
    • Information about the consent (
    SSIN of the patient, consent type, data of declaration, author of the declaration
    • consent status, the sign date)

    Steps (basic flow)

    1

    The
    user tries to consult the consent and the client sends a getPatientConsent request to the IAM connect
    client sends a GET /consents/ {patientSsin} request 

    2The IAM connect
    routes
    sends the request to the WS consent

    3

    The WS consent finds information about the consent of a patient 

    4The WS consent sends
    a SAML-based response
    a response to the IAM  

    5

    The IAM connect receives the response and sends it to the
    client using a JWT format by interacting with the token exchange service
    client 

    6The client receives information about the consent of the patient

    Exceptions (exception flows)

    Invalid or incorrect data:
  • Invalid transaction identifier.
  • Invalid request sender.
  • Invalid healthcare party identifier.
  • Invalid patient identifier (invalid SSIN, eID, SIS numbers).
  • Invalid consent type.


    Frequency

    • Every time the user wants to consult the consent of a given patient