FHIR Shorthand - PSS

1a. Project Name FHIR Shorthand 1b. Project ID 1569 1c. Is Your Project an Investigative Project (aka PSS-Lite)? No 1d. Is your Project Artifact being Reaffirmed or proceeding to Normative directly after being either Informative or STU? Yes 1e. Today's Date Aug 03, 2021 1f. Name of standard being reaffirmed 1g. Project Artifact Information A project artifact has balloted STU and now will ballot Normative 1h. ISO/IEC Standard to Adopt n/a -- Proceeding to Normative directly after being STU 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? No 1j. Unit of Measure N/A (no measurements are in the standard 2a. Primary/Sponsor WG FHIR Infrastructure 2d. Project Facilitator Mark Kramer 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 2m. Implementers MITRE Corporation, Lantana, athenahealth, HL7 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. Attachments FHIR Shorthand - v3.docx 3b. Project Need To better support complex clinical modeling/profiling projects and effectively integrate across projects. Explanation: 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 No 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). Second release by August 2021 3f. Common Names / Keywords / Aliases: FSH, SUSHI, DSL, shorthand, IG, language 3g. Lineage 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. 3h. Project Dependencies None 3i. HL7-Managed Project Document Repository URL: https://confluence.hl7.org/display/FHIRI/FHIR+Shorthand 3j. Backwards Compatibility No 3k. Additional Backwards Compatibility Information (if applicable) 3l. Using Current V3 Data Types? No 3l. Reason for not using current V3 data types? FHIR datatypes (R4, pre-release R5) are used. 3m. External Vocabularies No 3n. List of Vocabularies 3o. Earliest prior release and/or version to which the compatibility applies http://hl7.org/fhir/us/mcode/STU1 Note: the spec is primarily (95%) backwards compatible with STU1. A few exceptions exist 4a. Products Creating/Using a tool not listed in the HL7 Tool Inventory 4b. For FHIR IGs and FHIR Profiles, what product version(s) will the profiles apply to? R4 + 4c. FHIR Profiles Version 4d. Please define your New Product Definition 4d. Please define your New Product Family 5a. Project Intent Create new standard 5a. White Paper Type 5a. Is the project adopting/endorsing an externally developed IG? 5a. Externally developed IG is to be (select one) 5a. Specify external organization 5a. Revising Current Standard Info 5b. Project Ballot Type Comment (aka Comment-Only), STU to Normative 5c. Additional Ballot Info 5d. Joint Copyright No 5e. I understand I must submit a Joint Copyright Letter of Agreement to the TSC in order for the PSS to receive TSC approval. no 6a. External Project Collaboration Will work with FHIR Accelerator projects (e.g., DaVinci, CODEx). 6b. Content Already Developed 100% 6c. Content externally developed? No 6d. List Developers of Externally Developed Content 6e. Is this a hosted (externally funded) project? No 6f. Stakeholders Standards Development Organizations (SDOs), Other 6f. Other Stakeholders FHIR Community (anyone who develops FHIR IGs) 6g. Vendors N/A 6g. Other Vendors 6h. Providers N/A 6h. Other Providers 6i. Realm Universal 7d. US Realm Approval Date 7a. Management Group(s) to Review PSS FHIR 7b. Sponsoring WG Approval Date Sep 18, 2019 7c. Co-Sponsor Approval Date 7c. Co-Sponsor 2 Approval Date 7c. Co-Sponsor 3 Approval Date 7c. Co-Sponsor 4 Approval Date 7c. Co-Sponsor 5 Approval Date 7c. Co-Sponsor 6 Approval Date 7c. Co-Sponsor 7 Approval Date 7c. Co-Sponsor 8 Approval Date 7c. Co-Sponsor 9 Approval Date 7c. Co-Sponsor 10 Approval Date 7e. CDA MG Approval Date 7f. FMG Approval Date Nov 06, 2019 7g. V2 MG Approval Date 7h. Architecture Review Board Approval Date 7i. Steering Division Approval Date Nov 21, 2019 7j. TSC Approval Date