FHIR Profiling Tool

The FHIR Profiling tool is a development utility that can be used to generate FHIR Resource JSON schemas according to any FHIR version specification. The FHIR Profiling tool performs two key activities:

First creates a FHIR Profiling SQLite database (fhir_profiles.db) by parsing and storing JSON specification files uploaded to the project. By default, the tool generates resources according to FHIR v4.0.1, however this is configurable.
Using this database, the FHIR Profiling tool generates the desired FHIR Resource JSON schema, which you can then use in other projects to create and map FHIR resources.

How to use it:

STEP 1: Import the FHIR Profiling Tool

Using +COMPONENT, import the FHIR Profiling Tool

STEP 2: Set the FHIR version in the component card

By default, the FHIR Profiling Tool is pre-loaded with the FHIR v4.0.1 resources. The component contains specifications for FHIR v4.0.0 and v4.0.1, so you can change the default configuration to use v4.0.0 by changing the custom field FhirVersion in the component card to “4.0.0”.

STEP 2a: Optionally, upload an additional FHIR version specification

If needed, you can expand the versions available in the component:

Go to the official http://hl7.org/fhir/directory.html and download the FHIR specification for the version you need.

Screen Shot 2024-02-15 at 5.02.17 PM.png

In the downloaded specification files, locate “profiles-resources.json” and “types-resources.json”. Create a new folder with your version name (ex. v3_0_0) under the Specifications folder and upload these files into your version’s folder with the names “resources.json” and “types.json” respectively.

Update the FhirVersion custom field value to your new version (ex. 3.0.0)

STEP 3: Optionally, add any custom or extension profiles you wish to add onto the standard specification

If any custom or extension profiles are needed you can add the <custom_profiles>.json files to the Specifications/Custom folder. Note that if the custom profile’s specification exists as a standalone resource, it will need to be nested within a larger bundle resource definition. For example, this custom patient profile’s specification would go under the resource table:

{
    "entry": [
        {
            "fullUrl": "http://hl7.org/fhir/StructureDefinition/Patient",
            "resource": {
                "resourceType": "StructureDefinition",
                "id": "custom-patient-profile",
                ....
            }
        }
    ],
    "id": "resources",
    "meta": {
        "lastUpdated": "2019-11-01T09:29:23.356+11:00"
    },
    "resourceType": "Bundle",
    "type": "collection"
}

STEP 4: Set the component to refresh the database if using a new FHIR version or custom profiles

This component processes and stores specification data in a SQLite database (Specifications/fhir_profiles.db) for easy access. If you wish to update the FHIR version and/or load any custom profiles into that database, set the custom field Refresh in the component card to “true” before starting the component. This flag tells the component to reference the specified FHIR version and any files in the Specifications/Custom folder and refresh the database on startup.

STEP 6: Start the component

Now that the component card has been configured to the correct FhirVersion and Refresh details, you can start the component!

If the component was set with Refresh as true, it will take some time to initialize and load the database. It will reset the Refresh flag to false when done.

Once ready, the component will provide a URL in the component status:

STEP 7: Click on the provided URL to use the tool

Clicking on the provided URL will take you to the FHIR Profiling Tool’s menu which contains a list of all the FHIR resources and types available in the SQLite database.

Clicking on any of the links will trigger the tool to generate a template JSON for the specified FHIR resource or type:

You can now copy the template JSON and bring it over to your FHIR component to use in your interface. See <link confluence page on creating FHIR resources>.