InterSystems READY 2025: Automated Provisioning and Management of FHIR Servers

IRIS Automation

Jaideep Majumdar, InterSystems Development Manager, presented new REST APIs for FHIR management, distinct from data access APIs, which enable users to provision, customize, delete, and retrieve information about FHIR servers. The presentation covered creating and updating servers, managing background jobs, handling custom packages and data loading, and included a Postman demo showcasing various API functionalities.


 

Introduction to FHIR Management APIs: Majumdar introduced FHIR management REST APIs, which allow users to provision, customize, delete, and get information about FHIR servers. These APIs are distinct from FHIR APIs used for data access. Majumdar explained that the base route for these APIs is the CSP FHIR management API.

Creating and Managing FHIR Servers: Majumdar described the process of creating a FHIR server, starting with identifying a suitable namespace using the ‘get namespaces’ API. Once a namespace is found, a FHIR server can be created by posting to the ‘/endpoints’ endpoint with the necessary parameters. Majumdar also covered updating FHIR servers using a PUT request and deleting them with a DELETE request. The APIs provide functionality to retrieve information about all FHIR servers or a specific one.

Background Job Management: Majumdar noted that creating FHIR servers is a long-lived background job. When a FHIR server creation is initiated, the API returns a job ID that can be used to monitor the job’s status via dedicated APIs. Majumdar mentioned that device management uses the same set of APIs for managing background jobs.

Custom Package and Data Loading: Majumdar explained how to manage custom packages by posting to the ‘/packages’ endpoint to create them and using DELETE to remove them. There is also an API to list all packages and retrieve information about a specific package. For loading data into a FHIR server, Majumdar outlined a three-step process involving setting up a job, specifying the files to load, and then kicking off the job. APIs are available to get the status of data load jobs and to cancel them if needed.

Demo of API Usage: Majumdar provided a demonstration using Postman, showing how to check for existing FHIR servers, create a new one, and monitor the job status. The demo also included loading data into the FHIR server in a three-step process. Majumdar further demonstrated loading and deleting custom packages, deactivating and resetting a FHIR server, and deleting a FHIR server. The UI uses the same APIs, and there is an API to clear up completed jobs.

Summary of API Capabilities: Majumdar summarized that the new APIs enable users to create, provision, update, and delete FHIR servers, as well as load custom packages and data without using the UI, allowing for scripting and automation of FHIR server management.
Security and Availability: In response to a question, Majumdar confirmed that the APIs have security implemented, including CSP and another methodology. However, he clarified that the APIs are not currently available.

J2 Interactive

J2 Interactive is an award-winning software development and IT consulting firm that specializes in customized solutions for healthcare and life sciences.