FHIR® Profiler Instructions

Overview

Kodjin FHIR profiler tool for profiling with HL7 FHIR standard created by Edenlab.
It supports classic JSON notation for Structure Definition, resource validation, snapshot creation, and the resource tree render for visualization.

Available as a browser-based web editor and plugin for Visual Studio Code

System requirements

System

Windows, macOS

Visual Studio Code

(version 1.63 min.)

Features

JSON
Syntax control
FHIR JSON schema support
Slicing
Validation
Differential only or snapshot
Render (visualize) resource tree

Installation

Download the VSIX file with extension
In Visual Studio Code, open Preferences → Extensions
Choose “Install from VSIX”
Select downloaded file
Restart Visual Studio Code

Getting started

Please be sure the plugin has been installed (see Installation section)
Create and save a new file with extension *.fhir.json (optional, but required to support the JSON schema).
Place { } brackets for JSON structure
Select downloaded file
Start typing “res,” then select
“resourceType”: “StructureDefinition”
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”: “primitive-type”, “abstract”: true, “derivation”: “specialization”, “type”: “”, “baseDefinition”: “” }

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

Settings

FHIR® Profiling Tool: Snapshot URL

Specifies FHIR® server snapshot generation endpoint. To pass FHIR® resource type to URL use the ${resourceType} template variable./${resourceType}/$snapshot

FHIR® Profiling Tool: Validation URL

Specifies FHIR® server validation endpoint. To pass FHIR® resource type to URL use the ${resourceType} template variable./${resourceType}/$validate

Functions

The Kodjin FHIR® Profiling tool supports three main functions by context menu

FHIR® create/refresh tree
FHIR® validate resource
FHIR® create snapshot

Create snapshot

For this function, the resource should have a valid syntax structure and a differential section. If this function is selected, the plugin will send the data to the server, which is identified as the Snapshot URL in the settings. If the snapshot creation from the differential is successful, then the current code will be replaced by a full resource with both snapshot and differential sections.

Validate resource

For this function, the resource will be sent to the server, which is identified as a Validation URL in the settings. The validation server should check the structure, data types, etc. If any errors are found, they will appear at the bottom window in the PROBLEMS tab.

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.

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.

FHIR Profiler instructions