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][Supported browsers]
- A valid PSS token. It could be obtained from [eHealth Token eXchange][eHealth IAM] 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 four web components will be provided:
1. pss-amb-consent
2. pss-amb-get-support-parameters
3. pss-amb-summary
4. 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/

This project supports three environment modes:
- demo: Initializes the web component with mock data, without requiring a token or making any API requests. This mode is intended for integrators during development.
- acc: Acceptance environment, also intended for integrators during development and testing.
- prod: Production environment, used for the live deployment of the component.

Documentations, example, changelog

The documentation is accessible at:
Shared Prescription Search Support

The web components implement the contract (structure and naming of inputs and outputs):
@smals-belgium/myhealth-wc-integration v5.0.1

For styling, the components are defined in Storybook:
MyHealth Storybook Design Kit

The CHANGELOG.md are available directly in the artifact, along with an example (example_PSSa.html) of PSSa integration in a demo environment.

Versioning

This project follows [Semantic Versioning][Semver]. 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][OFAC], including ARIA labels and keyboard navigation

Customizations

The web components are build with [Angular Material][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][eHealth IAM].
- 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

GNU Lesser General Public License v3.0 or later

[Web component explanations]: https://www.webcomponents.org/introduction
[eHealth IAM]:https://www.ehealth.fgov.be/ehealthplatform/nl/service-i.am-identity-access-management
[Angular Material]: https://material.angular.io/
[OFAC]: https://openfed.github.io/AccessibilityCheck/
[Semver]: https://docs.npmjs.com/about-semantic-versioning
[MHWCI]: https://www.npmjs.com/package/@myhealth-belgium/webcomponent-integration
[Supported browsers]: https://www.ehealth.fgov.be/nl/page/hoe-toegang-krijgen-tot-applicaties