FHIR Server QuickStart Tutorial

• Learning objectives

By the end of the tutorial, the learner will be able to:

• • Access FHIR Server Management in the Management Portal and identify the key areas

  • Create and install a new FHIR server endpoint, selecting the appropriate FHIR version (and possibly additional packages/profiles; see also below as optional follow-up step)

  • Verify the FHIR endpoint is working by performing a minimal set of API calls:

    • Create a Patient (or small Bundle) via POST

    • Read a resource by id via GET /Patient/{Id}

    • Search using a basic query via GET /Patient?name=...)

    • Upload a bundle of Resources (via the UI)

  • Potentially also include some more advanced configuration, like adding packages with Search Parameters, and see how those work

    • Examine a package folder and file with custom search parameter

    • Import the package to the Namespace

    • Assign the package to the endpoint (discuss re-indexing)

    • Search using the new search parameter

  • Another option - build a quick and basic FHIR SQL Builder projection

    • Create an analysis on the Repo.

    • Create a basic transformation with Patient & Encounter & Observation

    • Run a basic SQL query just on the Patient table, then also a more complex one with a JOIN on all 3 tables

• Target audience

  • Newcomers to InterSystems IRIS for Health, especially developers who have never deployed a FHIR endpoint before

  • Hackathon / prototype builders who need a working FHIR API quickly

• Value of this tutorial for the target audience

  • Fast time-to-first-success: learners leave with being able to create a real, functioning FHIR endpoint they can call immediately.

  • Reduces onboarding friction: focuses on the smallest set of steps that matter (deploy -> verify → basic CRUD/search), avoiding deep platform concepts at the start.

  • Builds confidence and vocabulary: learners understand where FHIR server configuration lives in the Portal and what “FHIR endpoint,” “base URL,” and “FHIR package/version” mean in practice.

• Related materials and references

  • Docs - Installing a New FHIR Server

  • GitHub (sub)Repo - Create a FHIR Server in 5 minutes with IRIS Health Community