FHIR / FHIR/sushi

Consider exporting a Data Dictionary

Open
#284 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
188
Forks
64
Avg merge
8d 8h
Merged PRs (30d)
5

Description

Non-FHIR and non-technical audiences have trouble understanding FHIR IGs. Data dictionaries have proven to be a useful format to communicate to non-FHIR experts. We should consider exporting FHIR artifacts into a DD form. This does require a Snapshot, so it might be better downstream of SUSHI, working off complete StructureDefinitions, ValueSets, etc. produced by the IG Publisher.

The DD looks simple on the surface, but there are issues involving nested elements, sliced arrays (including extensions). I don't think these are insurmountable by any means.

This could be a project for a summer intern.

Contributor guide

Open the contributing guide

Research direction

Start by determining how SUSHI could consume complete Snapshot StructureDefinitions, ValueSets, and other FHIR artifacts produced downstream by the IG Publisher. Define the data-dictionary output and verify how it represents nested elements, sliced arrays, and extensions. Done means a usable export for non-FHIR and non-technical audiences.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.