https://github.com/sap/openui5-fhir
The openui5-fhir project connects the worlds of UI5 and FHIR®. Build beautiful and enterprise-ready web applications based on the FHIR® specification.
https://github.com/sap/openui5-fhir
fhir fhir-specification frontend open-source openui5 openui5-library ui5-artefacts web
Last synced: about 1 year ago
JSON representation
The openui5-fhir project connects the worlds of UI5 and FHIR®. Build beautiful and enterprise-ready web applications based on the FHIR® specification.
- Host: GitHub
- URL: https://github.com/sap/openui5-fhir
- Owner: SAP
- License: apache-2.0
- Created: 2019-04-16T10:48:42.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2025-03-24T14:10:08.000Z (about 1 year ago)
- Last Synced: 2025-04-05T13:13:36.595Z (about 1 year ago)
- Topics: fhir, fhir-specification, frontend, open-source, openui5, openui5-library, ui5-artefacts, web
- Language: JavaScript
- Homepage: https://sap.github.io/openui5-fhir
- Size: 7.45 MB
- Stars: 34
- Watchers: 8
- Forks: 7
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# OpenUI5-FHIR 
🔥
[](https://npmjs.com/package/openui5-fhir)
[](https://github.com/SAP/openui5-fhir/actions/workflows/ci.yml)
[](https://coveralls.io/github/SAP/openui5-fhir?branch=master)
[](https://npmjs.com/package/openui5-fhir)
[](https://david-dm.org/SAP/openui5-fhir/master)
[](https://david-dm.org/SAP/openui5-fhir?type=dev)
[](https://opensource.org/licenses/Apache-2.0)
[](CONTRIBUTING.md)
[](https://openui5.slack.com/messages/openui5-fhir)
[](https://api.reuse.software/info/github.com/SAP/openui5-fhir)
**The OpenUI5-FHIR project connects the worlds of UI5 and FHIR®. Build beautiful and enterprise-ready web applications based on the FHIR® specification.**
The world of healthcare is in change. Though being a highly regulated industry, more and more solutions move from on-premise into the cloud due to increasing costs. With this, there is a need to standardize communication between all players in the healthcare ecosystem (hospital, insurances, etc.). The [FHIR®](https://www.hl7.org/fhir/index.html) protocol, developed by HL7, has the goal to achieve that. To build UI5 applications based on a FHIR® server, there is a need to provide a UI5 library who enables FHIR® for UI5. The [OpenUI5-FHIR](https://github.com/SAP/openui5-fhir) project provides the *sap.fhir* UI5 library, which fills this gap. Currently, this library provides the *UI5 FHIR Model* which handles the communication with a FHIR® server by a central instance, like the ODataModel does it for OData services. The *UI5 FHIR Model* enables teams to implement fast and full scope UI5 applications based on a FHIR® server. In future, the *OpenUI5-FHIR* project might be enhanced by further FHIR® specific UI5 artefacts.
The complete documentation can be viewed in our [Documentation](https://sap.github.io/openui5-fhir/).
## History
OpenUI5 provides models out of the box, which can be fragmented in client or server-side [models](https://openui5.hana.ondemand.com/#/topic/e1b625940c104b558e52f47afe5ddb4f).
- Client-side models: JSON, XML and Resource
- Server-side models: OData V2, OData V4
Inside the healthcare community there are a few specifications for clinical/medical data. [FHIR®](https://www.hl7.org/fhir/) is one of them. Furthermore FHIR® provides a query language to access and modify the data.
To develop OpenUI5 applications based on FHIR® servers, there is a need to provide an easy to use way to bind the UI to an model which takes care of creating, reading, updating and deleting the corresponding data in the FHIR® server. This is the reason for the brand new *UI5 FHIR Model*, which is included in the *OpenUI5-FHIR* project.
## Features
The *OpenUI5-FHIR* project provides following UI5 artefacts:
- **UI5 FHIR Model**: The FHIR® specific UI5 model implementation to bind UI5 controls to content which is provided by a FHIR® server. The model takes care of requesting, creating, updating and removing FHIR® resources. The application developer doesn't have to care about which requests have to be sent to the FHIR® server at which point in time. The *UI5 FHIR Model* does the job!
## Requirements
The *OpenUI5-FHIR* project is completely integrated into the world of UI5. That means applications built with the *OpenUI5-FHIR* libary can be consumed in any modern browser.
The underlaying FHIR® server has to full following requirements:
- Provide the FHIR® data as JSON
## Download and Installation
The *OpenUI5-FHIR* project is published at npm on package `openui5-fhir`, which includes all necessary files. Add following snippet to your project `package.json` and update the version of `openui5-fhir` to the desired [version](https://github.com/SAP/openui5-fhir/releases).
```json
"dependencies": {
"openui5-fhir": "X.Y.Z"
}
```
## Sample App
There is already a [sample app](https://github.com/SAP-samples/openui5-fhir-sample-app) available, which illustrates the use of *OpenUI5-FHIR*. Check it out and have fun!
## Known Issues
The list of current issues is available [here](https://github.com/SAP/openui5-fhir/issues)
## Support
Do you've any questions? Don't hesitate to raise a [new issue](https://github.com/SAP/openui5-fhir/issues/new/choose).
## Contributing
The idea of the *OpenUI5-FHIR* project is ab initio to be driven by the community of healthcare players and enthusiastic individuals.
Please read [this document](CONTRIBUTING.md) to read more about your options:
- [Report Bugs](CONTRIBUTING.md#report-an-issue) as GitHub issues
- [Analyze Bugs](CONTRIBUTING.md#analyze-issues)
- [Contribute Code](CONTRIBUTING.md#contribute-code) (fixes and features)
## Compatibility
The following table displays the versions of *OpenUI5-FHIR* and the corresponding compatible *OpenUI5* versions:
| *OpenUI5-FHIR* | *OpenUI5* |
| ----------------- | --------- |
| 1.X.Y | > 1.58.0 |
## Licensing
Please see our [LICENSE.txt](LICENSE.txt) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the [REUSE tool](https://api.reuse.software/info/github.com/SAP/openui5-fhir).
## References
[OpenUI5-FHIR Documentation](https://sap.github.io/openui5-fhir/)
[OpenUI5 Documentation](https://openui5.hana.ondemand.com/)
[FHIR® Documentation](https://www.hl7.org/fhir/index.html)