ballerinax/health.fhirr4 Ballerina library

Overview

FHIR R4 service type package for building FHIR APIs in Ballerina. It provides a listener and runtime capabilities to validate requests, process search parameters, and handle API-level FHIR concerns.

Trademark Notice: FHIR® and the FHIR® logo are the registered trademarks of Health Level Seven International and their use does not constitute endorsement by HL7®.

Key Features

• FHIR listener and service type abstractions for rapid API development
• Built-in validation for search parameters and request payloads
• Validation for content-related HTTP headers
• Hooks for pluggable post-processing logic
• Consistent FHIR error handling with OperationOutcome responses

Package containing the FHIR R4 service type that can be used for creating FHIR APIs

FHIR Service Type

Ballerina FHIR service type can be used for developing FHIR APIs. It provides a range of capabilities related to FHIR APIs that make development much easier.

Capabilitites and features

• Validating search parameters.
• Parsing and validating the request payload when creating FHIR resources.
• Validating content-related headers.
• Executing post-processing logic that can be plugged in.
• Handling errors in all these validations and responding an operation outcome.

Sample Usage

• Import the required packages.

import ballerinax/health.fhirr4;
import ballerinax/health.fhir.r4;

• Create a ResourceAPIConfig record similar to the following.

final r4:ResourceAPIConfig apiConfig = {
    resourceType: "Patient",
    profiles: [
        "http://hl7.org/fhir/StructureDefinition/Patient"
    ],
    defaultProfile: (),
    searchParameters: [
        {
            name: "name",
            active: true,
            information: {
                description: "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text",
                builtin: false,
                documentation: "http://hl7.org/fhir/SearchParameter/Patient-name"
            }
        },
        {
            name: "gender",
            active: true,
            information: {
                description: "[Patient](patient.html): Gender of the patient",
                builtin: false,
                documentation: "http://hl7.org/fhir/SearchParameter/individual-gender"
            }
        },
        {
            name: "telecom",
            active: true,
            information: {
                description: "[Patient](patient.html): The value in any kind of telecom details of the patient",
                builtin: false,
                documentation: "http://hl7.org/fhir/SearchParameter/individual-telecom"
            }
        }
    ],
    operations: [],
    serverConfig: (),
    authzConfig: ()
};

• Define a FHIR service similar to the following by passing the api-config record created in the previous step.

service / on new fhirr4:Listener(9090, apiConfig) {

    isolated resource function get fhir/r4/Patient(r4:FHIRContext fhirContext) returns r4:Bundle {

        //implementation of the API resource
    }
}

Analytics with FHIR R4 service

Refer to resources/analytics_README.md