@smals-belgium-shared/shared-nihdi-pss-web-components v0.0.0
PSS Antimicrobials web components
Context
The web components developed for the PSS (Prescription Search Support) project, encompass both back-end and front-end functionalities. These components are designed to streamline the integration process by significantly reducing the development effort required by integrators. Notably, the solution does not require direct FHIR integration, which simplifies implementation within existing systems.
The container application will have to provide the input parameters to provision the web component with a working context.
Prerequisites
- A supported browser by our Web Components AND by eHealth
- A valid PSS token. It could be obtained from eHealth Token eXchange service. This token must be refreshed periodically in order to be used by PSS
⚠️ IE (internet explorer) is not supported. You can include polyfill scripts ("polyfills") for the browsers that you must support.
Description
The provided web components address complex clinical scenarios related to patient situation definitions in the antimicrobial domain. While the components encapsulate much of the required logic, certain responsibilities still remain with the integrator beyond embedding the web components themselves
The following three web components will be provided: 1. pss-amb-get-support-parameters 2. pss-amb-summarized-patient-situation 3. pss-amb-recommendation
The same web components are utilized in the PSS stand-alone web app, designed for both professional and educational purposes. You can explore the integration of these components in the following environments:
- acceptation environment: https://www.acc.prescriptionsearchsupport.be/
- production environment: www.prescriptionsearchsupport.be/
Documentation
The documentation is accessible from:
Usage
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>PSS Antimicrobials web component</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<script type="module" src="main.js"></script>
<link rel="stylesheet" href="style.css">
</head>
<body>
<script>
const wc = document.createElement("pss-amb-[get-support-parameters | recommendation | summary]");
// Common inputs for all PSS web components
// Refer to https://www.npmjs.com/package/@smals-belgium/myhealth-wc-integration for more details
wc.language = 'en'
wc.configName = 'acc';
wc.services = {
cache: {
get: (key) => (undefined),
set: (key, value) => {
},
remove: (key) => {
}
},
getAccessToken: async (audience) => "TODO : the eHealth OAuth2 JWT token.",
registerRefreshCallback: () => {
}
}
// Example on how to provide extra input parameter(s), if needed / requested by the component
// wc["attributeName"] = "myValue"
// Example on how to listen to output parameter(s)
wc.addEventListener("eventName", (event) => {
console.log(`event:`, event)
const params = event.detail;
console.log('param:', params);
})
document.body.append(wc);
</script>
</body>
</html>Versioning
This project follows Semantic Versioning. Each release is categorized by major, minor, and patch updates. Significant changes that may break existing integrations will be introduced with major versions. Please check CHANGELOG.md file for more info.
Accessibility
We are committed to making our web components accessible to all users. Our components are:
- Screen reader friendly : Designed to work well with popular screen readers (Talkback / VoiceOver / ...)
- Responsive : Adapt to various screen sizes (desktop / mobile).
- Compliant: Meet accessibility criteria, including ARIA labels and keyboard navigation
Customizations
The web components are build with Angular Material.
Troubleshoots
If you encounter issues while using the web components :
- Ensure that your token is valid and hasn't expired. For assistance, contact eHealth.
- Ensure you are using the latest version of the web components
- Ensure you are using a supported browser and that you have cleared your cache if issues persist.
- Ensure your organization, browser or device don't block calls to PSS API by any way.
License
1 month ago