Skip to end of metadata
Go to start of metadata


 Show Changes

Version

9

Modifier

Dave Hamill

Modify Date

Oct 16, 2019 16:28

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 now proceeding to Normative directly or after being either Informative or STU?

No

2a. Primary/Sponsor WG

Financial Management

2d. Project Facilitator

Mark Kramer

2e. Other Interested Parties (and roles)

Chris Moesel (lead implementer), Rick Geimer (tester), Ewout Kramer (design advisor).

2m. Implementers

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.

Attachments

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

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

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:

tbd

3j. Backwards Compatibility

No

3l. Using Current V3 Data Types?

No

3l. Reason for not using current V3 data types?

FHIR datatypes are used.

3m. External Vocabularies

No

3o. Earliest prior release and/or version to which the compatibility applies

n/a

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 +

5a. Project Intent

Create new standard

5b. Project Ballot Type

Comment (aka Comment-Only), STU to Normative

5d. Joint Copyright

No

6a. External Project Collaboration

Will work with FHIR Accelerator projects (e.g., DaVinci, CODEx).

6b. Content Already Developed

5%

6c. Content externally developed?

No

6e. Is this a hosted (externally funded) project?

No

6f. Stakeholders

Standards Development Organizations (SDOs), Other

6f. Other Stakeholders

FHIR Community (anyone who develops IGs)

6g. Vendors

N/A

6h. Providers

N/A

6i. Realm

Universal

7a. Management Group(s) to Review PSS

FHIR

7b. Sponsoring WG Approval Date

Sep 18, 2019

Version

8

Modifier

Mark Kramer

Modify Date

Sep 18, 2019 20:44

1a. Project Name

FHIR Shorthand

1c. Is Your Project an Investigative Project (aka PSS-Lite)?

No

1d. Is your Project Artifact now proceeding to Normative directly or after being either Informative or STU?

No

2a. Primary/Sponsor WG

Financial Management

2d. Project Facilitator

Mark Kramer

2e. Other Interested Parties (and roles)

Chris Moesel (lead implementer), Rick Geimer (tester), Ewout Kramer (design advisor).

2m. Implementers

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.

Attachments

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

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

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:

tbd

3j. Backwards Compatibility

No

3l. Using Current V3 Data Types?

No

3l. Reason for not using current V3 data types?

FHIR datatypes are used.

3m. External Vocabularies

No

3o. Earliest prior release and/or version to which the compatibility applies

n/a

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 +

5a. Project Intent

Create new standard

5b. Project Ballot Type

Comment (aka Comment-Only), STU to Normative

5d. Joint Copyright

No

6a. External Project Collaboration

Will work with FHIR Accelerator projects (e.g., DaVinci, CODEx).

6b. Content Already Developed

5%

6c. Content externally developed?

No

6e. Is this a hosted (externally funded) project?

No

6f. Stakeholders

Standards Development Organizations (SDOs), Other

6f. Other Stakeholders

FHIR Community (anyone who develops IGs)

6g. Vendors

N/A

6h. Providers

N/A

6i. Realm

Universal

7a. Management Group(s) to Review PSS

FHIR

7b. Sponsoring WG Approval Date

Sep 18, 2019

Version

7

Modifier

Mark Kramer

Modify Date

Sep 18, 2019 20:14

1a. Project Name

FHIR Shorthand

1c. Is Your Project an Investigative Project (aka PSS-Lite)?

No

1d. Is your Project Artifact now proceeding to Normative directly or after being either Informative or STU?

No

2a. Primary/Sponsor WG

Financial Management

2d. Project Facilitator

Mark Kramer

2e. Other Interested Parties (and roles)

Chris Moesel (lead implementer), Rick Geimer (tester), Ewout Kramer (design advisor).

2m. Implementers

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.

Attachments

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

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

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:

tbd

3j. Backwards Compatibility

No

3l. Using Current V3 Data Types?

No

3l. Reason for not using current V3 data types?

FHIR datatypes are used.

3m. External Vocabularies

No

3o. Earliest prior release and/or version to which the compatibility applies

n/a

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 +

5a. Project Intent

Create new standard

5b. Project Ballot Type

Comment (aka Comment-Only), STU to Normative

5d. Joint Copyright

No

6a. External Project Collaboration

Will work with FHIR Accelerator projects (e.g., DaVinci, CODEx).

6b. Content Already Developed

5%

6c. Content externally developed?

No

6e. Is this a hosted (externally funded) project?

No

6f. Stakeholders

Standards Development Organizations (SDOs), Other

6f. Other Stakeholders

FHIR Community (anyone who develops IGs)

6g. Vendors

N/A

6h. Providers

N/A

6i. Realm

Universal

7a. Management Group(s) to Review PSS

FHIR

Version

6

Modifier

Mark Kramer

Modify Date

Sep 18, 2019 20:07

1a. Project Name

FHIR Shorthand

1c. Is Your Project an Investigative Project (aka PSS-Lite)?

No

1d. Is your Project Artifact now proceeding to Normative directly or after being either Informative or STU?

No

2a. Primary/Sponsor WG

Financial Management

2d. Project Facilitator

Mark Kramer

2m. Implementers

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.

Attachments

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

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

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:

tbd

3j. Backwards Compatibility

No

3l. Using Current V3 Data Types?

No

3l. Reason for not using current V3 data types?

FHIR datatypes are used.

3m. External Vocabularies

No

3o. Earliest prior release and/or version to which the compatibility applies

n/a

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 +

5a. Project Intent

Create new standard

5b. Project Ballot Type

Comment (aka Comment-Only), STU to Normative

5d. Joint Copyright

No

6a. External Project Collaboration

Will work with FHIR Accelerator projects (e.g., DaVinci, CODEx).

6b. Content Already Developed

5%

6c. Content externally developed?

No

6e. Is this a hosted (externally funded) project?

No

6f. Stakeholders

Standards Development Organizations (SDOs), Other

6f. Other Stakeholders

FHIR Community (anyone who develops IGs)

6g. Vendors

N/A

6h. Providers

N/A

6i. Realm

Universal

7a. Management Group(s) to Review PSS

FHIR

Version

5

Modifier

Mark Kramer

Modify Date

Sep 18, 2019 14:46

1a. Project Name

FHIR Shorthand

1c. Is Your Project an Investigative Project (aka PSS-Lite)?

No

1d. Is your Project Artifact now proceeding to Normative directly or after being either Informative or STU?

No

2a. Primary/Sponsor WG

Financial Management

2d. Project Facilitator

Mark Kramer

2m. Implementers

MITRE Corporation

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.

Attachments

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 (no pun intended!) in ways that visual editors and spreadsheets cannot.

3c. Security Risk

No

3d. External Drivers

Need for accelerated generation of accurate, high quality IGs.

3e. Objectives/Deliverables and Target Dates

Version 1 for Connectathon testing by May 2020.
First release version by Sept 2020.

3f. Common Names / Keywords / Aliases:

FSH, DSL, shorthand, IG, language

3h. Project Dependencies

None.

3j. Backwards Compatibility

No

3l. Using Current V3 Data Types?

No

3m. External Vocabularies

No

3o. Earliest prior release and/or version to which the compatibility applies

n/a

4a. Products

Creating/Using a tool not listed in the HL7 Tool Inventory

5a. Project Intent

Create new standard

5d. Joint Copyright

No

6a. External Project Collaboration

no

6b. Content Already Developed

5%

6c. Content externally developed?

No

6e. Is this a hosted (externally funded) project?

No

6f. Stakeholders

Standards Development Organizations (SDOs), Other

6f. Other Stakeholders

FHIR Community

6i. Realm

Universal

7a. Management Group(s) to Review PSS

FHIR

Version

4

Modifier

Mark Kramer

Modify Date

Sep 18, 2019 14:45

1a. Project Name

FHIR Shorthand

1c. Is Your Project an Investigative Project (aka PSS-Lite)?

No

1d. Is your Project Artifact now proceeding to Normative directly or after being either Informative or STU?

No

2a. Primary/Sponsor WG

Financial Management

2d. Project Facilitator

Mark Kramer

2m. Implementers

MITRE Corporation

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.

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 (no pun intended!) in ways that visual editors and spreadsheets cannot.

3c. Security Risk

No

3d. External Drivers

Need for accelerated generation of accurate, high quality IGs.

3e. Objectives/Deliverables and Target Dates

Version 1 for Connectathon testing by May 2020.
First release version by Sept 2020.

3f. Common Names / Keywords / Aliases:

FSH, DSL, shorthand, IG, language

3h. Project Dependencies

None.

3j. Backwards Compatibility

No

3l. Using Current V3 Data Types?

No

3m. External Vocabularies

No

3o. Earliest prior release and/or version to which the compatibility applies

n/a

4a. Products

Creating/Using a tool not listed in the HL7 Tool Inventory

5a. Project Intent

Create new standard

5d. Joint Copyright

No

6a. External Project Collaboration

no

6b. Content Already Developed

5%

6c. Content externally developed?

No

6e. Is this a hosted (externally funded) project?

No

6f. Stakeholders

Standards Development Organizations (SDOs), Other

6f. Other Stakeholders

FHIR Community

6i. Realm

Universal

7a. Management Group(s) to Review PSS

FHIR

Version

3

Modifier

Mark Kramer

Modify Date

Sep 18, 2019 14:24

1a. Project Name

FHIR Shorthand

1c. Is Your Project an Investigative Project (aka PSS-Lite)?

No

1d. Is your Project Artifact now proceeding to Normative directly or after being either Informative or STU?

No

2a. Primary/Sponsor WG

Financial Management

2d. Project Facilitator

Mark Kramer

2m. Implementers

MITRE Corporation

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.

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 (no pun intended!) in ways that visual editors and spreadsheets cannot.

3c. Security Risk

No

3d. External Drivers

Need for accelerated generation of accurate, high quality IGs.

3e. Objectives/Deliverables and Target Dates

Version 1 for Connectathon testing by May 2020.
First release version by Sept 2020.

3f. Common Names / Keywords / Aliases:

FSH, DSL, shorthand, IG, language

3j. Backwards Compatibility

No

5a. Project Intent

Create new standard

Version

2

Modifier

Mark Kramer

Modify Date

Sep 18, 2019 14:15

1a. Project Name

FHIR Shorthand

1c. Is Your Project an Investigative Project (aka PSS-Lite)?

No

1d. Is your Project Artifact now proceeding to Normative directly or after being either Informative or STU?

No

2a. Primary/Sponsor WG

Financial Management

2d. Project Facilitator

Mark Kramer

2m. Implementers

MITRE Corporation

3a. Project Scope

FHIR Shorthand is an author-friendly specification for a domain-specific language (DSL) to allow authors to define conformance resources (e.g., StructureDefinition, ValueSet, ...) and general instances (e.g., examples). This project will define the grammar of FHIR Shorthand, and develop a reference implementation of a importer/exporter/compiler ("Sushi") that creates FHIR content ready for the FHIR IG Publisher.

3b. Project Need

To better support complex clinical modeling/profiling projects and effectively integrate across projects. The FHIR community needs scalable, fast, and user-friendly tools for IG creation and maintenance. Profiling projects are difficult and slow, and the resulting IG quality is inconsistent. As a user-facing format, SDs are complex and unwieldy. While available tools (Forge, Trifolia-on-FHIR, Excel spreadsheets) improve this situation, there are some shortcomings:
a. Although the tools provide a friendlier interface, the user must still understand many SD details.
b. The tools are not particularly agile when it comes to refactoring. Cross-cutting revisions happen all the time in non-trivial profiling projects.
c. 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. 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 (no pun intended!) in ways that visual editors and spreadsheets cannot.

3c. Security Risk

No

3d. External Drivers

Need for accelerated generation of accurate, high quality IGs.

3e. Objectives/Deliverables and Target Dates

Version 1 for Connectathon testing by May 2020.
First release version by Sept 2020.

3f. Common Names / Keywords / Aliases:

FSH, DSL, shorthand, IG, language

3j. Backwards Compatibility

No

5a. Project Intent

Create new standard

Version

1

Modifier

Mark Kramer

Modify Date

Sep 17, 2019 21:07

1a. Project Name

FHIR Shorthand

1c. Is Your Project an Investigative Project (aka PSS-Lite)?

No

1d. Is your Project Artifact now proceeding to Normative directly or after being either Informative or STU?

No

2a. Primary/Sponsor WG

Financial Management

2d. Project Facilitator

Mark Kramer

2m. Implementers

MITRE Corporation

3a. Project Scope

FHIR Shorthand is an author-friendly specification for profiling FHIR using a domain-specific language (DSL) to define profiles, extensions, invariants, value sets, examples, search parameters. This project will define the grammar of FHIR Shorthand, and develop a reference implementation of a importer/exporter/compiler that creates FHIR content ready for the FHIR IG Publisher.

3b. Project Need

To better support complex clinical modeling/profiling projects and effectively integrate across projects.
1. The FHIR community needs scalable, fast, and user-friendly tools for IG creation and maintenance. Profiling projects are difficult and slow, and the resulting IG quality is inconsistent.
2. As a user-facing format, SDs are complex and unwieldy.
3. Available tools (Forge, Trifolia-on-FHIR, Excel spreadsheets) improve this situation. These tools share certain characteristics:
a. Although the tools provide a friendlier interface, the user must still understand many SD details.
b. The tools are not particularly agile when it comes to refactoring. Cross-cutting revisions happen all the time in non-trivial profiling projects.
c. 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.
4. It can be difficult make sense of the Profile pages in IGs (see this example fr¬om the September 2019 ballot). FSH compiles to SD, but FSH itself is clearer and more compact and could represent the snapshot and differential.
5. Many years of experience has proven that creating and maintaining complex software projects is best approached with textual languages. As a DSL designed for the job of profiling, FSH is concise, understandable, and aligned to user intentions.
6. FSH is ideal for SCCS, with meaningful differentials, support for merging and conflict resolution, and refactoring through global search/replace operations. These features allow FSH to scale in ways that visual editors and spreadsheets cannot.
7. FSH will provide an easy path to migrate forward and backward between FHIR versions.

3c. Security Risk

No

3d. External Drivers

Need for accelerated generation of accurate, high quality IGs.

3e. Objectives/Deliverables and Target Dates

Version 1 for Connectathon testing by May 2020.
First release version by Sept 2020.

3f. Common Names / Keywords / Aliases:

FSH, DSL, shorthand, IG, language

3j. Backwards Compatibility

No

5a. Project Intent

Create new standard


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 now proceeding to Normative directly or after being either Informative or STU?

No

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).

2m. Implementers

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.

Attachments

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

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

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:

tbd

3j. Backwards Compatibility

No

3l. Using Current V3 Data Types?

No

3l. Reason for not using current V3 data types?

FHIR datatypes are used.

3m. External Vocabularies

No

3o. Earliest prior release and/or version to which the compatibility applies

n/a

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 +

5a. Project Intent

Create new standard

5b. Project Ballot Type

Comment (aka Comment-Only), STU to Normative

5d. Joint Copyright

No

6a. External Project Collaboration

Will work with FHIR Accelerator projects (e.g., DaVinci, CODEx).

6b. Content Already Developed

5%

6c. Content externally developed?

No

6e. Is this a hosted (externally funded) project?

No

6f. Stakeholders

Standards Development Organizations (SDOs), Other

6f. Other Stakeholders

FHIR Community (anyone who develops IGs)

6g. Vendors

N/A

6h. Providers

N/A

6i. Realm

Universal

7a. Management Group(s) to Review PSS

FHIR

7b. Sponsoring WG Approval Date

Sep 18, 2019