| Table of Contents |
|---|
Used documentation
| Cookbook/ materials | Version | Location |
|---|---|---|
| Therapeutic Link Web Service | 1.5 | |
| Identity & Authorization Management (I.AM) Token eXchange Technical specifications | 1.0 | https://www.ehealth.fgov.be/ehealthplatform/nl/data/file/view/83dd54fee269ec086696b0290d242907c6e9f994?name=IAM%20Connect%20Token%20eXchange%20-%20Tech%20Specs%20v1%20-%2004072018.pdf |
| API eHealth Therapeutic Link | 2.0 | http://jira.ivlab.ilabt.imec.be/secure/attachment/17425/swagger_therlink_2-0-3.json |
| KMEHR | - | https://www.ehealth.fgov.be/standards/kmehr/en |
| Jira | ||||||
|---|---|---|---|---|---|---|
|
| Jira | ||||||
|---|---|---|---|---|---|---|
|
| Jira | ||||||
|---|---|---|---|---|---|---|
|
| Jira | ||||||
|---|---|---|---|---|---|---|
|
| Jira | ||||||
|---|---|---|---|---|---|---|
|
| Jira | ||||||
|---|---|---|---|---|---|---|
|
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 Therapeutic link can be managed by the following end-users:
- Health Care (HC) parties: a physician, nurse, dentist, midwife, a pharmacy (it is noteworthy that there is no difference between pharmacy and a pharmacist), authorized organization.
- Citizen: a patient, a parent of a patient, a mandatary
The API eHealth Therapeutic Link provides four methods. It is noteworthy that in this use case only the Get a therapeutic link method is used.
Basic flow
| Flow | Specification | ||
|---|---|---|---|
| Use case ID | ATH-UC- | |
18-BF | ||
Use case name | Consult the therapeutic links of a patient using the GET /therapeuticLinks/{patientSsin} operation | |
Actors |
| |
Short Description | ||
| Priority | 1 (High) Must have: The system must implement this goal/ assumption to be accepted. | |
Pre-Conditions | ||
|
|
|
| ||
Post-Conditions |
| |
Steps (basic flow) | 1 | The client sends a GET /therapeuticLinks/{patientSsin} request |
| 2 | The IAM connect sends the request to the Therapeutic link WS | |
3 | The Therapeutic link WS finds information about the therapeutic link(s) of a patient | |
| 4 | The Therapeutic link WS sends a response to the IAM | |
5 | The IAM connect receives the response and sends it to the client | |
| 6 | The client receives information about the therapeutic link(s) of the patient | |
- Type of the proof
- only if the type of proof is the reading of the eID card with PIN code entering, the binary proof including the encryption method (mandatory) and the binary value (mandatory).
Post-Conditions
Information about the response (response identifier, end-user identifier, data and time of the response, initial request)
- An acknowledgement about the request completion (status of the completion, errors if exist)
- A list of the therapeutic links fulfilling the criteria:
- if the HCP is provided in the request
- if the HCP is a professional identified by his/her SSIN and his/her category: all the therapeutic links containing the given SSIN - category are returned;
- if the HCP is a professional identified by his/her NIHII and his/her category: all the therapeutic links containing the given NIHII - category are returned;
- if the HCP is a professional identified by his/her SSIN, his/her NIHII and his/her category: all therapeutic links containing the given SSIN - NIHII - category category are returned;
- if the HCP is an organization identified by its NIHII and its category: all the therapeutic links containing the given NIHII - category are returned.
- if the HCP is not provided in the request
- if the proof is not given
- if the end-user of the request acts as a HC professional: the therapeutic links of the concerned patient and the concerned author are returned;
- if the end-user of the request acts for an organization: the therapeutic links of the concerned patient and the concerned HC organization of the end-user are returned.
- if the proof is given
- if the end-user of the request acts as a HC professional: the therapeutic links of the concerned patient and the concerned end-user, the therapeutic links of the concerned patient and other concerned HCP are returned;
- if the end-user of the request acts for a HC organization: the therapeutic links of the concerned patient and the concerned organization, the therapeutic links of the concerned patient and other concerned HC parties are returned.
- if the proof is not given
- if the HCP is provided in the request
- If a (list of) therapeutic link type is provided: the therapeutic link(s) matching this (these) type(s) are returned
- If a time period is provided: the list of therapeutic links found over this given time period
- If a status (i.e. ‘active’, ‘inactive’, ‘all’) is provided: the therapeutic link matching the provided status are returned.
Steps (basic flow)
1
3
5
Exceptions (exception flows) | ||
| ||