FHIR Shorthand, Release 1
|
2. Standards Material/Document
|
STU
|
Aug 24, 2020
|
2 years
|
|
|
|
|
|
FHIR Infrastructure
|
Aug 24, 2020
|
https://confluence.hl7.org/display/FHIRI/FHIR+Infrastructure+Minutes+CC+20200824
|
FHIR Management Group
|
Aug 26, 2020
|
https://confluence.hl7.org/pages/viewpage.action?pageId=91984601
|
Yes
|
|
HL7 IG Publisher
|
FHIR Shorthand
|
FHIR Shorthand
|
FHIR Shorthand
|
|
|
1569
|
Universal
|
2020-May
|
81
|
0
|
60
|
45
|
186
|
Aug 26, 2020
|
https://github.com/HL7/fhir-shorthand
|
Mark Kramer
|
|
http://www.hl7.org/documentcenter/public/ballots/2020MAY/reconciliation/recon_fhir_ig_shorthand_r1_d1_2020may.xls
|
Yes
|
FHIR-I
|
Aug 24, 2020
|
|
FHIR
|
Implementation Guides
|
|
A language for defining FHIR Artifacts (profiles, value sets, extensions, instances, and more), used to create implementation guides.
|
Implementation Guide Tools
|
45. Parent standard
|
FHIR
|
46. Parent Standard Status
|
Active
|
47. Update/replace standard
|
n/a
|
FSH, Shorthand, SUSHI, GoFSH, FSH Online, FSHing Trip
|
FHIR Shorthand (FSH) is a domain-specific language (DSL) for defining the contents of FHIR Implementation Guides (IG). The language is specifically designed for this purpose, simple and compact, and allows the author to express their intent with fewer concerns about underlying FHIR mechanics. FSH can be created and updated using any text editor, and because it is text, it enables distributed, team-based development using source code control tools such as Github.
|
Standards Development Organizations (SDOs)
|
|
|
FHIR Shorthand (FSH) simplifies the task of creating FHIR profiles, extensions, value sets, extensions and other artifacts needed for a FHIR IG. FSH provides a grammar is designed to express exactly what you want to do when profiling. It is a declarative language in which you specify what is to be done rather than how to do it. FSH language is readable and easily understandable. FSH is designed to be used with source code control-systems that support distributed development and meaningful version-to-version change tracking. FSH substantially speeds up IG projects.
|
There are currently over 40 profiling projects using FHIR Shorthand. Examples include Logica COVID-19 FHIR Profile Library IG and the SANER (Situational Awareness for Novel Epidemic Response) IG.
|
There are already several existing methods for IG creation: hand editing definitions, using Excel spreadsheets, Simplifier/Forge, and Trifolia-on-FHIR. Each of these methods have certain advantages as well as drawbacks:
* Hand-editing StructureDefinitions (SDs) is unwieldy, but authors get full control over every aspect of the resulting profiles and extensions.
* The spreadsheet method has existed since before FHIR 1.0 and has been used to produce sophisticated IGs such as US Core. A downside is that version management is difficult; either the files are saved in binary form (.xslx) or as XML files, with the content mixed with formatting directives.
* Simplifier/Forge and Trifolia-on-FHIR provide graphical interfaces that help guide users through common tasks. The potential downside is the need to navigate multiple screens visit different items and make cross-cutting changes.
Experience across many domains has shown that complex software projects are best approached with textual languages. As a language designed for the job of profiling and IG creation, FSH is concise, understandable, and aligned to user intentions. Users may find that the FSH language representation is the best way to understand a set of profiles. Because it is text-based, FSH brings a degree of editing agility not found in graphical tools (cutting and pasting, global search and replace, spell checking, etc.) FSH is ideal for distributed development under source code control, providing meaningful version-to-version differentials, support for merging and conflict resolution, and nimble refactoring. These features allow FSH to scale in ways that other approaches cannot. Any text editor can be used to create or modify FSH, but advanced text editor plugins may also be used to further aid authoring.
A reference implementation, SUSHI, has been created that compiles FSH into FHIR artifacts, ready for the HL7 FHIR IG Publisher.
|
|