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

Submitting WG/Project/Implementer Group: FHIR Infrastructure

Justification and Objectives

FHIR Shorthand (FSH) is a new, author-friendly language for defining the content of IGs, including profiles, extensions, value sets, examples, and search parameters. As a purpose-designed language, FSH is concise, easy to understand, and aligned to user intentions. 

The track will allow participants are invited to bring their existing or in-progress implementation guide and try out FSH. Participants will learn more about FSH, help debug the reference implementation, and share suggestions for future development.

This track will use what version of FHIR?

R4

Clinical input requested (if any)

No

Related tracks

None

Proposed Track Lead

Mark Kramer, mkramer@mitre.org

Participants (actual)

Rick Geimer, Lantana

Sarah Gaunt, Lantana

David Hay

Ward Weistra, Firely

Nick George, Google

Eric Haas

Natasha Singh, Childrens Hospital of Philadephia

Hugo Leroux, CSIRO

Alejandro Metke, CSIRO

Michael Lawley, CSIRO

John Rhoads, Phillips Healthcare

John Moerke, 

Bob Milius, NMDP/CIBMTR

Andres Schuler, HL7 Austria

Reinhard Egelkraut, HL7 Austria

Vince McCauley


Track Orientation

Slides: FHIR Shorthand Connectathon Orientation Slides.pptx

(This is a single meeting ... but occurs on different days in different time zones)

Tuesday January 21, 5-6 pm Eastern US time (GMT-5)

Wednesday, January 22, 9-10 am, Sydney Daylight Time (GMT+11)

Join Skype Meeting

https://meet.mitre.org/mkramer/0SM9YVQV

System Roles

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

Scenarios

Scenario 1:

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

Precondition: Existing IG to translate.

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

Bonus point: Put FSH files until source code control. Profiles generated by FSH validated using FHIR validator.


Scenario 2:

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

Precondition: Clinical information model to express as FHIR profiles.

Success Criteria: Draft version of IG produced.

Bonus point: Create examples for each profile.


TestScript(s)

The FHIR validator will be used to assure validity of produced profiles, extensions, and examples.


Security and Privacy Considerations

None.

  • No labels

1 Comment

  1. Mark Kramer

    A big thanks to everyone who participated. The outcomes are given here:



    but for convenience, repeated below:

    FHIR Shorthand Track

    BACKGROUND

    • FHIR Shorthand is a domain-specific language (DSL) designed for the job of profiling and IG creation
    • It is a textual language
    • FSH is concise, understandable, and aligned to user intentions
    • Formal grammar (ANTLR4)
    • Reference implementation compiler (SUSHI)
    • Some users might find that the FSH representation is more understandable and agile
    • FSH is ideal for collaborative development under source code control
    • Supports meaningful version-to-version differentials, and merging and conflict resolutio
    • Ease of refactoring through global search/replace operation
    • These features allow FSH to scale and accelerate development in ways that other approaches cannot

    OBJECTIVE OF CONNECTATHON

    • Allow track participants to gain hands-on experience with FHIR Shorthand
    • Try producing an Implementation Guide using Shorthand
    • Provide feedback on the FHIR Shorthand specification and SUSHI tooling
    • Log any issues with Shorthand and SUSHI
    • Consider using Shorthand for your next IG project

    PARTICIPANTS

    • Mark Kramer, MITRE (Track Lead)
    • Rick Geimer, Lantana
    • Sarah Gaunt, Lantana
    • David Hay
    • Ward Weistra, Firely
    • Nick George, Google
    • Eric Haas
    • Natasha Singh, Childrens Hospital of Philadephia
    • Hugo Leroux, CSIRO
    • Alejandro Metke, CSIRO
    • Michael Lawley, CSIRO
    • John Rhoads, Phillips Healthcare
    • John Moerke, By Light
    • Bob Milius, NMDP/CIBMTR
    • Andres Schuler, HL7 Austria
    • Reinhard Egelkraut, HL7 Austria
    • Vince McCauley

    NOTABLE ACHIEVEMENTS

    • Held a tutorial to teach FSH 
    • All participants were able to learn and use the FHIR Shorthand and successfully create implementation guides
    • Validated the FSH concept as something that is useful and needed by the FHIR community
    • Several participants expressed their intention to using FHIR Shorthand on current and future IG projects
    • Google and Lantana expressed interest in FHIR Shorthand to augment existing FHIR toolsets
    • Rick Geimer developed a translator that converts StructureDefinitions to FSH
    • Rob McClure inspected our ValueSet implementation and did not tell us we were doing it wrong

    RELEVANT LINKS:

    FHIR Shorthand Zulip channel (#shorthand)

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

    FHIR Shorthand Documentation and Tutorial

    http://build.fhir.org/ig/HL7/fhir-shorthand

    FHIR Shorthand Documentation Issue Reports

    https://github.com/HL7/fhir-shorthand/issues

    SUSHI Code Repository

    https://github.com/FHIR/sushi

    SUSHI Issue Reports

    https://github.com/FHIR/sushi/issues

    HL7 Confluence Site

    https://confluence.hl7.org/display/FHIRI/FHIR+Shorthand

    Conference Calls

    See http://hl7.org/concalls for details

    DISCOVERED ISSUES

    • About 10 issues (both bugs and suggestions) were filed in our SUSHI git repository
    • Error messages were appreciated, but red color on black was not appreciated
    • Version compatibility between FHIR, FSH, and SUSHI
    • Users want to refer to to local packages in package.json
    • FSH needs a way to designate which instances are examples, as opposed to conformance resources

    NEXT STEPS

    • FSH needs some better documentation in some places and more examples
    • A high priority will be to improve the relationship between FSH and the IG Publisher
    • One of these tasks will be to put generated resources into multiple folders 
    • Provide syntax highlighting and look ahead