Kodjin FHIR Profiler

A FHIR profiling tool developed by Edenlab's software engineers for healthcare business analysts and IT specialists to create FHIR profiles faster, following an agile approach and using an intuitive graphical IDE.

It supports classic JSON notation for Structure Definition, resource validation and the resource tree render for visualization.

Getting started

Step 1. Create and save a new file with extension *.fhir.json
Step 2. Place { } brackets for JSON structure

Step 3. Start typing "res" then select "resourceType": "StructureDefinition" or another resource type from the drop-down list.

You should receive the code:

  {
    "resourceType": "StructureDefinition",
    "id": "",
    "url": "",
    "version": "0.01",
    "name": "",
    "title": "",
    "status": "draft",
    "experimental": true,
    "date": "",
    "publisher": "",
    "fhirVersion": "",
    "kind": "resource",
    "abstract": false,
    "derivation": "specialization",
    "type": "",
    "baseDefinition": ""
  }

Step 4. Tab through the fields and use the up and down keys for different values from the FHIR JSON scheme.

(Filling out the snippet)

Settings

FHIR Profiling Tool: FHIR Server base URL

Specifies FHIR server snapshot generation endpoint, validation endpoint and POST Structure Definition endpoint.

https://demo.kodjin.com/fhir use by default

FHIR Profiling Tool: Terminology URL

Specifies FHIR terminology server endpoint for expanding value set operation and terminology resource validation operation.

https://demo.kodjin.com/terminology use by default

Auth

Choose option:

No Auth - no options
Bearer token - enter you token (string)
OAuth 2.0 - specify next parameters and then click on "FHIR Generate Access Token" point by context menu:
- Grant Type - "Client Credentials" (by default)
- Access token url (required)
- Client ID (required)
- Client Secret (required)
- Scope (optional)

Functions

The Kodjin FHIR Profiling tool supports main functions by context menu:

FHIR expand value set
FHIR Load Base definition
FHIR Send to FHIR Server (POST Structure Definition to FHIR Server)
FHIR validate resource
FHIR create/refresh tree
FHIR Generate Access Token

(Extension context menu)

FHIR Expand value set

Expand of a value set is used to display a collection of codes from the Terminology server which is specified in the settings. This function can be used to preview changes in the Value set.

FHIR Load Base definition

Kodjin FHIR Profiler can upload in the creating Structure Definition the base Structure Definition which is specified in the “baseDefinition” to the "snapshot".

FHIR Send to FHIR Server

Send POST Structure Definition request with resource content to FHIR server base url.

FHIR validate resource

The resource is sent to the FHIR server (base URL) which checks the structure, data types, etc. If any errors are found, they will appear at the pop-up.

Create/refresh the resource tree

This is the most beautiful advantage of the plugin. When you have a full profile with the snapshot section, you could build the whole tree of the resource. This function will create a new window and render an FHIR-resource tree.

(FHIR-resource view)

Errors

Any syntax errors or validation errors retrieved from the operation outcome will be displayed at the bottom section in a PROBLEMS tab. Pointing the cursor to the problem will navigate to the corresponding line in the code.

(Profile validation example)

Feedback and further updates

If you have any questions or suggestions about Kodjin FHIR Profiler improvement - contact us via welcome@edenlab.io.