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

1.1.0
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/resources.json

  3. Perform necessary updates 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. Perform necessary updates 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

ConfigurationDescription
versionBusiness version of the capability statement

eg: 0.1.7
nameName for this capability statement (computer friendly)

eg: WSO2 Open Healthcare FHIR
titleName for this capability statement (human friendly)

eg: FHIR Server
statusdraft / active / retired / unknown

eg: active
experimentalFor testing purposes, not real usage

eg: true
dateDate last changed

eg: 26-01-2023
kindinstance / capability / requirements

eg: instance
fhir_versionFHIR Version the system supports

eg: 4.0.1
formatformats supported (json)

eg: [json]
patch_formatPatch formats supported

eg: [application/json-patch+json]
implementation_urlBase URL for the installation

eg: https://choreoapis/dev/fhir_server/0.1.5
implementation_descriptionDescribes this specific instance

eg: WSO2 Open Healthcare FHIR
interactionsThe that operations are supported

eg: [search-system, history-system]
security_corsCORS Headers availability

eg: true
token_urlOAUTH2 access token url

eg: https://sts.choreo.dev/oauth2/token
revoke_urlOAUTH2 access revoke url

eg: https://sts.choreo.dev/oauth2/revoke
authorize_urlOAUTH2 access authorize url

eg: https://sts.choreo.dev/oauth2/authorize

Sample Configurables in Config.toml

## server related configurables
[server_info]
version = "0.1.5"
name = "WSO2 Open Healthcare FHIR"
title = "FHIR Server"
status = "active"
experimental = true
date = "2023-01-08"
kind = "instance"
fhir_version = "4.0.1"
format = ["json", "xml"]
patch_format = ["application/json-patch+json"]
implementation_url = "https://d52c48b3-b62e-4a9c-966b-585f22b4711d-dev.e1-us-east-azure.choreoapis.dev/d7k7/fhir_server/0.1.5"
implementation_description = "WSO2 Open Healthcare FHIR"
interactions = ["search-system"]

## server security related configurables
[security]
security_cors = true
token_url = "https://sts.choreo.dev/oauth2/token"
revoke_url = "https://sts.choreo.dev/oauth2/revoke"
authorize_url = "https://sts.choreo.dev/oauth2/authorize"

Import

import ballerinax/health.fhir.templates.r4.metadata;Copy

Metadata

Released date: 11 months ago

Version: 1.1.0


Compatibility

Platform: any

Ballerina version: 2201.7.0


Pull count

Total: 7

Current verison: 1


Weekly downloads


Source repository


Keywords

Healthcare

FHIR

Metadata


Contributors

Other versions