Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[1.0.0-rc1 release] Prepare for release #4

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
# healthcare-accelerator
# WSO2 Healthcare Accelerator
Provides core functionality to streamline healthcare integration by enabling rapid development and deployment of healthcare applications with support for standards like FHIR and HL7.

Currently WSO2 Healthcare Accelerator consists of following accelerator distributions:

- [WSO2 Healthcare API Manager Accelerator](apim-accelerator/README.md)
28 changes: 21 additions & 7 deletions distribution/apim-accelerator/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,29 @@
# WSO2 Healthcare API Manager 4.0.0 Accelerator - v${project.version}

# WSO2 Healthcare API Manager Accelerator - v${project.version}

The WSO2 Healthcare API Manager Accelerator provides features tailored for healthcare API management, particularly focusing on FHIR (Fast Healthcare Interoperability Resources), SMART on FHIR, and OAuth 2.0 support.

## Features Overview

### FHIR Capability Statement Auto-Generation
The FHIR metadata endpoint auto-generates a **CapabilityStatement** that describes the FHIR server's functionality. This endpoint, `https://<API_GW_HOST>:<PORT>/r4/metadata`, provides an essential overview of supported FHIR operations, resource types, and interactions, helping developers and integrators understand the server’s FHIR capabilities.

### OAuth 2.0 Discovery via Well-Known Endpoint
The well-known endpoint (`https://<API_GW_HOST>:<PORT>/r4/.well-known/smart-configuration`) allows OAuth 2.0 clients to easily discover authentication and token endpoints as well as supported scopes and claims. This simplifies the setup for applications integrating with OAuth 2.0 and OpenID Connect for healthcare data security.

### SMART on FHIR Integration
SMART on FHIR support enables the integration of applications that use the SMART on FHIR framework. This includes capabilities like SMART scopes registration, SMART App Launch flow features etc.

## Prerequisites:
1. Download WSO2 API Manager product
2. Download the WSO2 Healthcare API Manager Accelerator
1. Download WSO2 API Manager product from [WSO2 API Manager](https://apim.docs.wso2.com/en/latest/).
2. Download the WSO2 Healthcare API Manager Accelerator from [Releases](https://github.com/wso2/healthcare-accelerator/releases) section of the accelerator repository.


## Installation Steps:
1. Extract WSO2 APIM product and update the product. Let's call the installed location `<WSO2_APIM_HOME>`.
2. Extract WSO2 Healthcare APIM Accelerator to `<WSO2_APIM_HOME>`. Let's call it `<WSO2_HC_APIM_ACC_HOME>`.
3. Navigate to `<WSO2_HC_APIM_ACC_HOME>` directory and execute `./bin/merge.sh` command. This will copy the artifacts to the WSO2 APIM and add the required configurations.
4. Navigate to `<WSO2_APIM_HOME>` directory and execute `./bin/api-manager.sh` to start the APIM server with WSO2 Healthcare Accelerator.
3. [Optional] Check the accelerator configurations in `<WSO2_HC_APIM_ACC_HOME>/conf/config.toml` file to enable or disable features.
4. Navigate to `<WSO2_HC_APIM_ACC_HOME>` directory and execute `./bin/merge.sh` command. This will copy the artifacts to the WSO2 APIM and add the required configurations.
5. Navigate to `<WSO2_APIM_HOME>` directory and execute `./bin/api-manager.sh` to start the APIM server with WSO2 Healthcare Accelerator.

## Audit Logs:
Running `merge.sh` script creates a audit log folder in the product home. Structure of it looks like below;
Expand All @@ -24,7 +38,7 @@ hc-accelerator
```
- `merge_audit.log` will have an audit line per execution of the `merge.sh` script of the accelerator. Each line contains execution date and time, user account and the version of the accelerator. Example log line is below;
```sh
Mon May 31 22:01:55 +0530 2021 - john - WSO2 Healthcare API Manager 4.0.0 Accelerator - v${project.version}
Mon May 31 22:01:55 +0530 2021 - john - WSO2 Healthcare API Manager Accelerator - v${project.version}
```
- `backup` folder contains the files that were originally there in the APIM product before running the accelerator. Please note that only the last state will be there.

Expand Down
4 changes: 2 additions & 2 deletions distribution/apim-accelerator/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@
<parent>
<groupId>org.wso2.healthcare</groupId>
<artifactId>distribution</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>1.0.0-rc1</version>
</parent>

<artifactId>apim-accelerator</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>1.0.0-rc1</version>
<packaging>pom</packaging>

<build>
Expand Down
4 changes: 2 additions & 2 deletions distribution/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@
<parent>
<groupId>org.wso2.healthcare</groupId>
<artifactId>healthcare-accelerator</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>1.0.0-rc1</version>
</parent>

<artifactId>distribution</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>1.0.0-rc1</version>
<packaging>pom</packaging>

<modules>
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

<groupId>org.wso2.healthcare</groupId>
<artifactId>healthcare-accelerator</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>1.0.0-rc1</version>

<packaging>pom</packaging>
<modelVersion>4.0.0</modelVersion>
Expand Down
4 changes: 2 additions & 2 deletions product-accelerators/apim/apps/authentication-portal/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@
<parent>
<groupId>org.wso2.healthcare</groupId>
<artifactId>product-accelerators</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>1.0.0-rc1</version>
<relativePath>../../../pom.xml</relativePath>
</parent>

<artifactId>authentication-portal</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>1.0.0-rc1</version>
<packaging>pom</packaging>

<description>Open-Healthcare customized authentication-portal</description>
Expand Down
4 changes: 2 additions & 2 deletions product-accelerators/apim/apps/recovery-portal/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@
<parent>
<groupId>org.wso2.healthcare</groupId>
<artifactId>product-accelerators</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>1.0.0-rc1</version>
<relativePath>../../../pom.xml</relativePath>
</parent>

<artifactId>recovery-portal</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>1.0.0-rc1</version>

</project>
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@
<parent>
<groupId>org.wso2.healthcare</groupId>
<artifactId>product-accelerators</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>1.0.0-rc1</version>
<relativePath>../../../pom.xml</relativePath>
</parent>

<artifactId>org.wso2.healthcare.apim.claim.mgt</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>1.0.0-rc1</version>
<packaging>bundle</packaging>

<dependencies>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@
<parent>
<groupId>org.wso2.healthcare</groupId>
<artifactId>product-accelerators</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>1.0.0-rc1</version>
<relativePath>../../../pom.xml</relativePath>
</parent>

<artifactId>org.wso2.healthcare.apim.clientauth.jwt</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>1.0.0-rc1</version>
<packaging>bundle</packaging>

<dependencies>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@
<parent>
<groupId>org.wso2.healthcare</groupId>
<artifactId>product-accelerators</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>1.0.0-rc1</version>
<relativePath>../../../pom.xml</relativePath>
</parent>

<artifactId>org.wso2.healthcare.apim.conformance</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>1.0.0-rc1</version>
<packaging>bundle</packaging>

<dependencies>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@
<parent>
<groupId>org.wso2.healthcare</groupId>
<artifactId>product-accelerators</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>1.0.0-rc1</version>
<relativePath>../../../pom.xml</relativePath>
</parent>

<artifactId>org.wso2.healthcare.apim.core</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>1.0.0-rc1</version>

<description>WSO2 Healthcare API Management core component</description>
<packaging>bundle</packaging>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@
<parent>
<groupId>org.wso2.healthcare</groupId>
<artifactId>product-accelerators</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>1.0.0-rc1</version>
<relativePath>../../../pom.xml</relativePath>
</parent>

<artifactId>org.wso2.healthcare.apim.gateway.security.jwt.generator</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>1.0.0-rc1</version>
<packaging>bundle</packaging>

<dependencies>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@
<parent>
<groupId>org.wso2.healthcare</groupId>
<artifactId>product-accelerators</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>1.0.0-rc1</version>
<relativePath>../../../pom.xml</relativePath>
</parent>

<artifactId>org.wso2.healthcare.apim.multitenancy</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>1.0.0-rc1</version>
<packaging>bundle</packaging>

<dependencies>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@
<parent>
<groupId>org.wso2.healthcare</groupId>
<artifactId>product-accelerators</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>1.0.0-rc1</version>
<relativePath>../../../pom.xml</relativePath>
</parent>

<artifactId>org.wso2.healthcare.apim.scopemgt</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>1.0.0-rc1</version>
<packaging>bundle</packaging>

<dependencies>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@
<parent>
<groupId>org.wso2.healthcare</groupId>
<artifactId>product-accelerators</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>1.0.0-rc1</version>
<relativePath>../../../pom.xml</relativePath>
</parent>

<artifactId>org.wso2.healthcare.apim.tokenmgt</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>1.0.0-rc1</version>
<packaging>jar</packaging>

<dependencies>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@
<parent>
<groupId>org.wso2.healthcare</groupId>
<artifactId>product-accelerators</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>1.0.0-rc1</version>
<relativePath>../../../pom.xml</relativePath>
</parent>

<artifactId>org.wso2.healthcare.apim.workflow.extensions</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>1.0.0-rc1</version>
<packaging>jar</packaging>

<dependencies>
Expand Down
4 changes: 2 additions & 2 deletions product-accelerators/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@
<parent>
<groupId>org.wso2.healthcare</groupId>
<artifactId>healthcare-accelerator</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>1.0.0-rc1</version>
<relativePath>../pom.xml</relativePath>
</parent>

<artifactId>product-accelerators</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>1.0.0-rc1</version>
<packaging>pom</packaging>

<modules>
Expand Down
Loading