Versions Compared

Old Version 7

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

Saved on

compared with

New Version 8

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

CookbookVersionLocation
Therapeutic Link Web Service Cookbook1.5https://www.ehealth.fgov.be/ehealthplatform/nl/service-ehealth-therapeutic-links


General Information

A therapeutic link is a relationship between a patient and a HC party for a certain type of therapeutic
relationship 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.

Image Added


The schema gives the users of this cookbook the overview of the 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, citizen (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 to access the medical data of the patients by calling the therapeutic link
    consultation WS through their application.


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.


Basic Flow

FlowSpecifications


IDAR-UC92-BF
NameGet Therapeutic Link -  HC Professional ISI+ reading - non-referral
Description

Get Therapeutic Link allows users to check the existence of therapeutic links between a HC party and a patient. 

HC Professional acts as author of the non-referral Therapeutic Link. The given proof is the ISI+ reading 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 and Midwife. 

Actor(s)
  • HC Professional (Physician, Nurse, Dentist or Midwife)
Requirements
  • End-user is different from the concerned HC professional (Physician, Nurse, Dentist or Midwife )
  • End-user manages the therapeutic links throughout his usual software
  • Valid personal eHealth Certificate
  • ISI+ card of concerned patient
  • Status is given
  • Time period is given
  • SSIN of concerned HC party
  • HC party category of concerned HC party
TriggerThe user wants to get 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 to Get a Therapeutic Link
  7. The Get Therapeutic Link Request is sent to the WS Therapeutic Link 
  8. ° The WS Therapeutic link responds with a Therapeutic Link Response

      ° The request is logged

      ° The therapeutic links of the concerned patient and the concerned author, the therapeutic links of the concerned patient and other concerned HC parties are returned

Post Condition(s)
  • The request is logged
  • The therapeutic links of the concerned patient and the concerned author, the therapeutic links of the concerned patient and other concerned HC parties are returned
Test DataExample Get Therapeutic Link p48
End pointsTherapeutic Links
Remarks*
  • Recorded date time : date time of the DB when the therapeutic link is created or revoked
  • The author of the operation : only NIHII, if any and HC party category of the author are returned as legally the SSIN of the author cannot be known
  • If no therapeutic links corresponding to the criteria could be found, an empty list is returned
Additional Information
  • If the begin date is provided then the end date must be also provided (and respectively)
  • A therapeutic link is active when the current date is part of its period of validity



Alternative Flow

FlowSpecifications


IDAR-UC92-AF01
NameGet Therapeutic Link -  HC Professional ISI+ reading - non-referral - No time period - No status
Description

Get Therapeutic Link allows users to check the existence of therapeutic links between a HC party and a patient. 

HC Professional acts as author of the non-referral Therapeutic Link. The given proof is the ISI+ reading 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 and Midwife.

Actor(s)
  • HC Professional (Physician, Nurse, Dentist or Midwife)
Requirements
  • End-user is different from the concerned HC professional (Physician, Nurse, Dentist or Midwife )
  • End-user manages the therapeutic links throughout his usual software
  • Valid personal eHealth Certificate
  • ISI+ card of concerned patient
  • No status is given
  • No time period is given
  • SSIN of concerned HC party
  • HC party category of concerned HC party
TriggerThe user wants to get 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 to Get a Therapeutic Link
  7. The Get Therapeutic Link Request is sent to the WS Therapeutic Link 
  8. ° The WS Therapeutic link responds with a Therapeutic Link Response

      ° The request is logged

      ° The therapeutic links of the concerned patient and the concerned author, the therapeutic links of the concerned patient and other concerned HC parties are returned

Post condition(s)
  • The request is logged
  • The therapeutic links of the concerned patient and the concerned author, the therapeutic links of the concerned patient and other concerned HC parties are returned
Test DataExample Get Therapeutic Link p48
End point(s)Therapeutic Links
Remarks*
  • Recorded date time : date time of the DB when the therapeutic link is created or revoked
  • The author of the operation : only NIHII, if any and HC party category of the author are returned as legally the SSIN of the author cannot be known
  • If no therapeutic links corresponding to the criteria could be found, an empty list is returned
Additional Information
  • If the begin date is provided then the end date must be also provided (and respectively)
  • A therapeutic link is active when the current date is part of its period of validity