ballerinax/health.fhir.templates.r4.metadata Ballerina library

FHIR Capability Statement API Template

Usage

This section focuses on how to use this template to implement, configure and deploy FHIR Metadata API of a FHIR server:

Prerequisites

1. Install Ballerina 2201.6.0 (Swan Lake Update 6) or later

Setup and run in VM or Developer Machine

1. Create an API project from this template

   bal new -t ballerinax/health.fhir.templates.r4.metadata <PROJECT_NAME>
   

2. Update deployed FHIR resource data in /resources/fhir_resources.json

3. Configure the necessary configs on Config.toml as in configurations.

4. Run by executing command: bal run in your terminal to run this package.

5. Invoke <BASE_URL>/fhir/r4/metadata/

   1. Invoke from localhost : http://localhost:9090/fhir/r4/metadata/

Setup and deploy on Choreo

1. Create an API project from this template

   bal new -t ballerinax/health.fhir.templates.r4.metadata <PROJECT_NAME>
   

2. Update deployed FHIR resource data in /resources/resources.json

3. Configure the necessary configs on Config.toml as in configurations.

4. Create GitHub repository and push created source to relevant branch

5. Follow instructions to connect project repository to Choreo

6. Deploy API by following instructions to deploy and test

7. Invoke <BASE_URL>/fhir/r4/metadata/

   https://<HOSTNAME>/<TENANT_CONTEXT>/fhir/r4/metadata/

Configurations

Following configurations can be configured in Config.toml or Choreo configurable editor

Sample Configurables in Config.toml

## server related configurables
[configFHIRServer]
version = "1.2.0"
name = "WSO2 Open Healthcare FHIR"
title = "FHIR Server"
status = "active"
experimental = true
date = "2022-11-24"
kind = "instance"
fhirVersion = "4.0.1"
format = ["json"]
patchFormat = ["application/json-patch+json"]
implementationUrl = "https://d52c48b3-b62e-4a9c-966b-585f22b4711d-dev.e1-us-east-azure.choreoapis.dev/d7k7/fhir_server/1.2.0""
implementationDescription = "WSO2 Open Healthcare FHIR"

[configRest]
mode = "server"
resourceFilePath = "resources/fhir_resources.json"
interaction = ["search-type"]
## server security related configurables
[configRest.security]
cors = false
discoveryEndpoint = "https://api.asgardeo.io/t/bifrost/oauth2/token/.well-known/openid-configuration"
##configure the following endpoints manually if there is no discovery EP defined
#tokenEndpoint = "https://sts.choreo.dev/oauth2/token"
#authorizeEndpoint = "https://sts.choreo.dev/oauth2/authorize"
#introspectEndpoint = "https://sts.choreo.dev/oauth2/introspect"
#revocationEndpoint = "https://sts.choreo.dev/oauth2/revoke"
#registrationEndpoint = "https://sts.choreo.dev/oauth2/register"
managementEndpoint = "https://sts.choreo.dev/oauth2/manage"