1c. Is Your Project an Investigative Project (aka PSS-Lite)?
1d. Is your Project Artifact being Reaffirmed or proceeding to Normative directly after being either Informative or STU?
1e. Today's Date
1f. Name of standard being reaffirmed
1g. Project Artifact Information
1h. ISO/IEC Standard to Adopt
1i. Does the standard include excerpted text from one or more ISO, IEC or ISO/IEC standards, but is not an identical or modified adoption?
1j. Unit of Measure
2a. Primary/Sponsor WG
2d. Project Facilitator
2e. Other Interested Parties (and roles)
Chris Moesel (lead implementer), Rick Geimer (tester), Ewout Kramer (design advisor).
2f. Modeling Facilitator
2g. Publishing Facilitator
2h. Vocabulary Facilitator
2i. Domain Expert Representative
2j. Business Requirements Analyst
2k. Conformance Facilitator
2l. Other Facilitators
MITRE Corporation, Lantana
3a. Project Scope
FHIR Shorthand is a specification of a domain-specific language (DSL) to allow Implementation Guide authors to define conformance resources (e.g., StructureDefinitions, ValueSets, etc.) and general instances (e.g., examples). This project will define the syntax of FHIR Shorthand, and develop a reference implementation of an importer/exporter/compiler ("Sushi") that creates FHIR content ready for the FHIR IG Publisher or other consumers of Conformance Resources. Project will also explore importing StructureDefinitions to FSH.
To better support complex clinical modeling/profiling projects and effectively integrate across projects.
To grow, the FHIR community needs scalable, user-friendly tools for IG creation and maintenance. Currently, IG projects are difficult and slow, and the results inconsistent. As a user-facing format, StructureDefinitions (SDs) are complex and unwieldy. While available tools (Forge, Trifolia-on-FHIR, Excel spreadsheets) improve this situation, there are still shortcomings:
a. Although the current tools provide a friendlier interface, the tools are not particularly agile when it comes to refactoring.
b. Source code control system (SCCS) features such as differentials and merging changes are not well supported. Excel files cannot be effectively diff’ed, and the other tools can be managed in SCCS only as SDs.
To address these limitations, we propose a domain specific language (DSL) designed for the job of defining profiles, extensions, invariants, value sets, examples, search parameters, etc. FHIR Shorthand (FSH) will be designed to work optimally with SCCS, with meaningful differentials, support for merging and conflict resolution, and refactoring through global search/replace operations. These features will permit FSH to scale in ways that visual editors and spreadsheets cannot.
3c. Security Risk
3d. External Drivers
3e. Objectives/Deliverables and Target Dates
Version 1 for Connectathon testing by May 2020 with concurrent comment-only ballot.
First release version with STU ballot by Sept 2020 (at the earliest).
3f. Common Names / Keywords / Aliases:
FSH, SUSHI, DSL, shorthand, IG, language
Based on similar free, open source tool called CIMPL (Clinical Information Modeling and Profiling Language) developed primarily by MITRE Corp. and used to develop mCODE, ODH, and other balloted IGs.