Versions Compared

Key

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

Used Documentation

CookbookVersionLocation
Therapeutic Link WS Cookbook1.6https://www.ehealth.fgov.be/ehealthplatform/nl/service-ehealth-therapeutic-links


General Information

Basic Flow

FlowSpecifications


IDHas Ther Link - HC professional through an authorized organization
NameHas Ther Link - HC professional through an authorized organization
DescriptionHas Therapeutic Link allows users to check the existence of therapeutic links between a HC party and a patient. HC professional through an authorized organization
Actor(s)HC professional through an authorized organization
Requirements
  • End-user is a HC professional through an authorized organization
  • End-user manages the therapeutic links throughout his organization
  • Valid eHealth certificate of the organization
  • Identification end-user: SSIN, NIHII (if available), professional category
  • Identification HC organization: CBE or EHP number, HC party category
  • Identification concerned patient: SSIN, support card number (optional)
  • Identification data concerned HC party: SSIN,  NIHII (if available), HC party category, first and last name (optional)
  • Therapeutic link type (optional)
TriggerUser wants to check the existence of a therapeutic link between a patient and a HC professional
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 the valid eHealth certificate of the organization
  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 Has a Therapeutic Link
  7. The Has Therapeutic Link Request is sent to the WS Therapeutic Link 
  8. The WS Therapeutic link returns a boolean value
  9. The request is logged
  10. The WS Therapeutic link responds with a Therapeutic Link Response
Post Condition(s)
  • The WS Therapeutic link returns a boolean value
  • The request is logged
Test Data
End point(s)Therapeutic Links
RemarksBoolean value: It returns a true if a therapeutic link of this type exists between the patient and HC party. If no therapeutic links corresponding to the criteria could be found, the value false is returned. If no type is specified, any type of therapeutic link is considered.
Additional InformationThis operation takes a patient HC party identification and an (optional) type of therapeutic link as input. It returns true if a therapeutic link of this type exists between the patient and HC party. If no type is specified, any type of therapeutic link is considered. 



Exception Flow

FlowSpecifications


IDHas Ther Link - HC professional through an authorized organization - Exceptions
NameHas Ther Link - HC professional through an authorized organization - Exceptions
DescriptionHas Therapeutic Link allows users to check the existence of therapeutic links between a HC party and a patient. HC professional through an authorized organization. Possible exceptions
Actor(s)HC professional through an authorized organization
Requirements
  • End-user is a HC professional through an authorized organization
  • End-user manages the therapeutic links throughout his organization
  • Valid eHealth certificate of the organization
  • Identification end-user: SSIN, NIHII (if available), professional category
  • Identification HC organization: CBE or EHP number, HC party category
  • Identification concerned patient: SSIN, support card number (optional)
  • Identification data concerned HC party: SSIN,  NIHII (if available), HC party category, first and last name (optional)
  • Therapeutic link type (optional)
Possible exceptions
  1. Technical error
  2. Invalid data
  • Sender is not allowed to perform this operation
  • The HC party performing the operation does not have the same professional category as the HC professional concerned by the therapeutic link
  • Invalid patient (invalid SSIN or SSIN does not correspond to the provided support card number) 
  • Invalid HC party (incorrect NIHII or NIHII does not correspond to the HC professional category)
  • Invalid therapeutic link type
TriggerUser wants to check the existence of a therapeutic link between a patient and a HC professional
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 Has a Therapeutic Link
  7. The Has Therapeutic Link Request is sent to the WS Therapeutic Link 
  8. The WS Therapeutic link returns an error message
Post Condition(s)Error message
Test Data
End point(s)Therapeutic Links
Additional InformationThis operation takes a patient HC party identification and an (optional) type of therapeutic link as input. It returns true if a therapeutic link of this type exists between the patient and HC party. If no type is specified, any type of therapeutic link is considered.