-
Notifications
You must be signed in to change notification settings - Fork 18
Add smart on fhir and on prem accelerator deployment guides #56
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
148 changes: 148 additions & 0 deletions
148
en/docs/assets/img/learn/smart-on-fhir/smart_on_fhir.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| --- | ||
| sidebar_position: 5 | ||
| title: "Configure IS 7.x as Key Manager" | ||
| description: This guide provides step-by-step instructions to configure WSO2 Identity Server 7.x as a Key Manager for WSO2 API Manager, enabling secure API access and management. | ||
| --- | ||
|
|
||
| This guide provides step-by-step instructions to configure WSO2 Identity Server 7.x as a Key Manager for WSO2 API Manager, enabling secure API access and management. | ||
|
|
||
| 1. Sign in to the Admin Portal of API Manager at https://localhost:9443/admin. | ||
| 2. Go to **Key Managers** on the left main menu. | ||
|  | ||
| 3. Configure [WSO2 IS 7.x as a keymanager](https://apim.docs.wso2.com/en/latest/api-security/key-management/third-party-key-managers/configure-wso2is7-connector/). Enable role creation in WSO2 Identity Server 7. | ||
| :::tip | ||
| You can configure well-known URL (`https://<WSO2_APIM_BASE>:9453/oauth2/token/.well-known/openid-configuration`) and import Key manager endpoints. | ||
| ::: | ||
|
|
||
|
|
||
| :::note | ||
| Use the introspection endpoint in the iam-service-extension service to enable healthcare specific introspection response. `https://<IAM_SERVICE_EXTENSION_BASE>:<PORT>/introspect`. | ||
| ::: | ||
| 4. Go to the list of Key Managers and select **Resident Key Manager**. | ||
| 5. Disable the Resident Key Manager. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| --- | ||
| sidebar_position: 6 | ||
| title: "Deploy FHIR APIs" | ||
| description: This guide provides step-by-step instructions to deploy FHIR APIs in WSO2 API Manager, enabling healthcare organizations to securely expose and manage their FHIR-based services. | ||
| --- | ||
|
|
||
| # Deploy FHIR APIs | ||
|
|
||
| This guide walks through the steps to generate an OpenAPI specification from a FHIR Implementation Guide using the Ballerina Health Tool, and then deploy it as a managed API in WSO2 API Manager using the FHIR Repository as the backend. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| 1. Install and setup [WSO2 Open Healthcare](./manual.md). | ||
| 2. Install [Ballerina](./manual.md#ballerina-installation-steps) (Swan Lake or later). | ||
| 3. A FHIR Implementation Guide (IG) to generate the API. | ||
|
|
||
| ## Step 1 - Generate OpenAPI Specification from a FHIR Implementation Guide | ||
|
|
||
| The [Ballerina Health Tool](https://ballerina.io/learn/health-tool/#fhir-template-generation) can generate an OpenAPI specification and a Ballerina project template directly from a FHIR Implementation Guide. | ||
|
|
||
| 1. Pull the Ballerina Health Tool: | ||
|
|
||
| ```bash | ||
| bal tool pull health | ||
| ``` | ||
|
|
||
| 2. Run the FHIR template generation command, pointing to your Implementation Guide package: | ||
|
|
||
| ```bash | ||
| bal health gen fhir -m template --org-name [ORG_NAME] [IG_PACKAGE_NAME] | ||
| ``` | ||
|
|
||
| Replace the placeholders with: | ||
| - `[ORG_NAME]`: Your Ballerina organization name (e.g., `healthcare`) | ||
| - `[IG_PACKAGE_NAME]`: The Ballerina package name of the FHIR IG (e.g., `ballerinax/health.fhir.r4.uscore501`) | ||
|
|
||
| Example: | ||
|
|
||
| ```bash | ||
| bal health gen fhir -m template --org-name healthcare ballerinax/health.fhir.r4.uscore501 | ||
| ``` | ||
|
|
||
| 3. The tool generates a Ballerina project with: | ||
| - An OpenAPI specification (OAS) file for each FHIR resource in the IG. | ||
| - A Ballerina service template with boilerplate FHIR resource handlers. | ||
|
|
||
| 4. Locate the generated OAS file(s) in the output directory. These will be used to create the API in WSO2 API Manager. | ||
|
|
||
| ## Step 2 - Create and Deploy the API in WSO2 API Manager | ||
|
|
||
| 1. Log in to the WSO2 APIM Publisher Portal at `https://localhost:9443/publisher`. | ||
|
|
||
|  | ||
|
|
||
| 2. Click **Create API** and select **Import Open API**. | ||
|
|
||
| 3. Upload the OAS file generated in Step 1 and click **Next**. | ||
|
|
||
| 4. Fill in the API details: | ||
| - **Name**: e.g., `USCorePatientAPI` | ||
| - **Context**: e.g., `/fhir/r4` | ||
| - **Version**: e.g., `1.0.0` | ||
| - **Endpoint URL**: The URL of the running Ballerina FHIR service (e.g., `http://localhost:9090/r4`) | ||
|
|
||
| 5. Click **Create** to create the API. | ||
|
|
||
| 6. In the API overview, go to **Deployments** and click **Deploy**: | ||
| - Select the target **Gateway** (e.g., Default). | ||
| - Click **Deploy**. | ||
|
|
||
| 7. Go to **Lifecycle** and click **Publish** to make the API available in the Developer Portal. | ||
|
|
||
| :::note | ||
| Ensure the WSO2 APIM gateway can reach the Ballerina FHIR service endpoint. If running locally, use `host.docker.internal` instead of `localhost` when APIM runs in Docker. | ||
| ::: | ||
|
|
||
| ## Step 4 - Verify the Deployment | ||
|
coderabbitai[bot] marked this conversation as resolved.
Outdated
|
||
|
|
||
| 1. Navigate to the Developer Portal at `https://localhost:9443/devportal`. | ||
|
|
||
|  | ||
|
|
||
| 2. Find the published FHIR API and confirm it appears in the portal. | ||
| 3. Invoke the well-known endpoint to verify the FHIR gateway is responding: | ||
|
|
||
| ```bash | ||
| curl https://localhost:8243/r4/.well-known/smart-configuration | ||
| ``` | ||
|
|
||
| 4. Test a FHIR resource endpoint: | ||
|
|
||
| ```bash | ||
| curl https://localhost:8243/r4/metadata | ||
| ``` | ||
|
|
||
| A valid FHIR CapabilityStatement response confirms the API is deployed and the FHIR backend is reachable. | ||
|
|
||
| ## See Also | ||
|
|
||
| - [Manual Installation Guide](./manual.md) | ||
| - [Expose FHIR APIs](../fhir/guides/expose-fhir-apis.md) | ||
| - [SMART on FHIR — Deploy On Premise](../secure-health-apis/guides/configure-smart-on-fhir.md) | ||
| - [Ballerina Health Tool](https://ballerina.io/learn/health-tool/#fhir-template-generation) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.