Page tree
Skip to end of metadata
Go to start of metadata

Track overview

Short Description

Learn about the FHIR Shorthand (FSH) language and related tools to help author FHIR resources and implementation guides (IGs). Try out using SUSHI (SUSHI Unshortens Short Hand Inputs), a FSH reference implementation and compiler, as well as the still-in-development FSH decompiler "GoFSH" and browser-based FSH authoring and compilation environment.

Tutorials

The track will feature "office hours" (open questions and discussion, hands on assistance) and the following four tutorials:

  • Introduction and Beginning FHIR Shorthand:  Motivations, Overview, Basics of the FHIR Shorthand language
  • Advanced FHIR Shorthand:  Producing IGs with SUSHI, extensions, slicing, instances, caret paths, rule sets, 
  • Wicked FHIR Shorthand:  Planned future power-user features:  Macros, soft indexing, context paths, logical models
  • FSHing Equipment: Tools to help with FSH: FSH Online, Go FSH, FSH School

Tutorials will be repeated on Thursday and Friday.

Schedule

Times are given Eastern US time zone:

THURSDAY:

9:00 am - 6:00 pm – Open Office hours

10:00 am     Introduction and Beginning FHIR Shorthand

12:00 noon  Advanced FHIR Shorthand

2:00 pm       Wicked FHIR Shorthand

4:00 pm       FSHing Equipment

FRIDAY:

9:00 am - 6:00 pm – Open Office hours

10:00 am     FSHing Equipment

12:00 noon  Wicked FHIR Shorthand

2:00 pm       Introduction and Beginning FHIR Shorthand

4:00 pm       Advanced FHIR Shorthand

Long Description

FHIR Shorthand (FSH) is an author-friendly language for defining the content of IGs, including profiles, extensions, value sets, examples, and more. As a purpose-designed language, FSH is concise, easy to understand, and aligned to user intentions. SUSHI is a reference implementation of a FSH-language compiler, which translates FSH definitions into JSON-format FHIR definitions.

Participants in this track are invited to bring their existing or in-progress implementation guides and try out FSH. Participants will learn more about FSH, help debug the reference implementation, and share suggestions for future development. Participants who used SUSHI at the previous Connectathon will be able to try using some of the new features that are now available, such as project initialization and YAML-based project configuration.

In addition to using SUSHI for defining content, participants will be able to try out two new FSH-related tools that are in development. The "GoFSH" tool translates FHIR resources in JSON format into FSH. This tool will provide a convenient way to start using FSH without having to manually convert existing FHIR artifacts. The browser-based FSH playground is a no-installation-required way of using FSH. This gives users the opportunity to experiment with FSH and receive immediate feedback without needing to install any software on their system.

Track participants will work with the FHIR Shorthand team, comprised of:
Mark Kramer - mkramer@mitre.org
Chris Moesel - cmoesel@mitre.org
Julia Afeltra - jafeltra@mitre.org
Nick Freiter - nfreiter@mitre.org
Mint Thompson - mathompson@mitre.org


Type

  • Educate on the use of a FHIR technology/IG

Submitting Work Group/Project/Accelerator/Affiliate/Implementer Group

FHIR Infrastructure Group

Proposed Track Lead

Mint Thompson - mathompson@mitre.org

Related tracks

N/A

FHIR Version

  • FHIR R4

Specification(s) this track uses

FHIR Shorthand - https://build.fhir.org/ig/HL7/fhir-shorthand/

Artifacts of focus

Expected participants

Based on attendance at Connectathon 24, 10-15 participants are expected.

Zulip stream

https://chat.fhir.org/#narrow/stream/215610-shorthand

Track Orientation

Track organizer will hold an orientation/introductory session prior to the Connectathon.

Track details

System Roles

This track emphasizes modeling and profiling. The relevant role is "Implementation Guide Creator".

Node.js is required to run SUSHI and GoFSH.

Scenarios

Scenario 1: Translate an existing IG

Action: IG Creator manually translates profiles from an existing IG into FHIR Shorthand to create a more maintainable form of the IG.

Precondition: Participant has an existing IG to translate.

Success Criteria: Existing IG reproduced with source expressed as FHIR Shorthand.

Bonus point: Put FSH files into source code control. Validate the profiles generated by FSH using FHIR validator.


Scenario 2: Create a new IG

Action: IG Creator creates profiles and examples for a new IG using FHIR shorthand.

Precondition: IG Creator has clinical information model to express as FHIR profiles.

Success Criteria: Draft version of IG produced.

Bonus point: IG Creator creates examples for each profile.


Scenario 3: Create a new FSH project from existing FHIR resources

Action: IG Creator uses GoFSH to create FSH definitions of Profiles and Extensions for their existing IG's resources.

Precondition: IG Creator has a set of StructureDefinitions in JSON format that describe Profiles and Extensions.

Success Criteria: FSH files corresponding to the available StructureDefinitions are produced.

Bonus point: The FSH files are edited and compiled into new StructureDefinitions.

TestScript(s)

A combination of three tools: SUSHI (the reference implementation of FHIR Shorthand compiler) provides initial validation; the HL7 FHIR IG Publisher also provides validation of the generated artifacts and IG content; the FHIR validator can also be used to determine the validity of examples.

Security and Privacy Considerations

None


Report Out

Our track included eight tutorial sessions (four on Thursday, four on Friday) along with the main track discussion and work session. Attendance for the tutorial sessions ranged between five (one of the FSHing Equipment sessions) and 29 (one of the Beginning FSH sessions) participants. The FSHing Equipment sessions marked the FSH team's first publicization of the new GoFSH tool to help increase adoption of FSH by IG authors. The FSH tutorial sessions covered the breadth and depth of FSH for authors of all experience levels.


In the FSH tutorial sessions, discussion focused on FSH and SUSHI:

  • The usefulness of parameterized RuleSets
  • Improvements to the representation of logical models
  • Ease of reading CapabilityStatement resources was brought up in Beginning FSH and discussed in Wicked FSH

In the FSHing Equipment sessions, participants provided valuable suggestions for GoFSH and FSH Online:

  • GoFSH exhibited some undesired behavior regarding the handling of canonical URLs. This behavior can be addressed as development of GoFSH continues.
  • A participant suggested a capability in FSH Online to download the produced JSON as a file. This feature will be added to the development plan for FSH Online.


Track Participants:

Yufang Liu, Abhishek Jain, Hugh Glover, David Hay, Reinhard Egelkraut, Shahim Essaid, Artim Sopim, Stephanie Hong, Oliver Egger, Jamie Lubbert, Kayla Kantola, Mukundan Parthasarathy, Ryan Moehrke, Benjamin McAlister, Reece Adamson, Thomas Chepucavage, Thomas Grannan, Ivan Osmolovsky, Rachel Foerster, Peter Muir, Ward Weistra, Mangai Thiagarajan, Mahesh Palan, Madhav Darji, David Lowry, Italo Costa, Reinhard Egelkraut, Cheng Liu, Shaheer Abdulkareem, Stoyan Halkaliev, Preston Lee, Chidubem Okam, Ming Yu, Frank McKinney, James Agnew, Colleen Parker

  • No labels