FHIR Shorthand, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 3.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-shorthand/ and changes regularly. See the Directory of published versions

Change Log

FHIR Shorthand 3.0.0 (HL7 Mixed Normative/Trial Use Release)

The FHIR Shorthand 3.0.0 release contains non-substantive changes from the balloted specification. These changes are based on ballot feedback and primarily improve the clarity and consistency of the specification. This release also includes the following additional enhancements based on ballot feedback:

• Concepts and references may be directly assigned to CodeableReference elements (3.6.4.7)
• Unified Code for Units of Measure (UCUM) units may be assigned to Quantity elements without assigning a value (3.6.4.5)

For a complete list of changes, see all commits from FSH 3.0.0-ballot to FSH 3.0.0 release on GitHub.

FHIR Shorthand 3.0.0-ballot (HL7 Mixed Normative/Trial Use Ballot)

The FHIR Shorthand 3.0.0 Mixed Normative/Trial Use Ballot (September 2023) promoted the following features to NORMATIVE status. These features have been thoroughly tested by the community after being introduced as trial use in FHIR Shorthand 2.0.0 and are expected to remain stable in the future.

• Parameterized rule sets (3.5.11.2, 3.6.11.2)
• Indented rules (3.6.2)
• Path rules (3.6.16)
• Logical models (3.5.7, 3.6.3)
• Custom resources (3.5.10, 3.6.3)
• Hierarchical code systems (3.5.3.1)
• Concept-specific caret rules in code systems (3.5.3.2)
• Inserting rule sets with path context (3.6.12.3)

The FHIR Shorthand 3.0.0 Mixed Normative/Trial Use Ballot (September 2023) introduced the following substantive changes as TRIAL USE features. Many of these features have been tested by the community, but some may undergo changes in the future.

• Specifying Extension context using the Context keyword (3.5.4)
• Authors may define instances of logical models (3.5.5)
• Using rules in Invariant definitions (3.5.6)
• Assigning metadata values for concepts in value sets (3.5.12.2)
• Logical model definitions may now use assignment rules and constrain inherited elements (3.5.7)
• Inserting parameterized rule sets with values in double square brackets (3.6.12.2)
• Path rules can be used to add optional fixed values and set slice order on Instances (3.6.16)
• CodeableReference keyword can be used in add element rules (3.6.3) and type rules (3.6.17)
• Specifying type characteristics of Logical models using the Characteristics keyword (3.5.7)

Additional minor changes and clarifications to the specification include the following:

• Insert rules in the context of a concept (3.6.12.3)
• Add element rules with content references (3.6.3)
• Minor correction to indicate Path Rules may be used on Mappings (Table 7 in 3.5.1.3)
• Additional explanation and examples for using include (3.5.12)
• Include Reference and Canonical in the reserved words list (3.3.2)
• Indicate that R5 removed support for xpath invariants (3.5.6)
• Indicate that slices can be discriminated by position in R5 (3.6.8.1)
• Provide example of constraining Reference datatype and its targets (3.6.17)
• Clarify that extension paths may also have bracketed indices (3.4.8)
• Clarify correct and incorrect definition and use of aliases (3.5.2)
• Clarify that Usage: #definition can be used to define any formal item in an IG (3.5.5)
• Clarify value set rules syntax for versions code systems and value sets (3.5.12)
• Clarify allowed value types in value set filter expressions (3.5.12.1)
• Update all links for core FHIR to point to FHIR R5

FHIR Shorthand 2.0.0 (HL7 Mixed Normative/Trial Use Release)

There were no substantive changes in FHIR Shorthand 2.0.0 compared to the balloted FHIR Shorthand 1.2.0 version.

FHIR Shorthand 1.2.0 (HL7 Mixed Normative/Trial Use Ballot)

The FHIR Shorthand Mixed Normative/Trial Use Ballot (September 2021) introduced the following substantive changes as NORMATIVE features. These features have been thoroughly tested by the community and are not expected to change in the future.

• Soft indexing for array paths (3.4.6)
• Extended Quantity syntax (3.3.9)

The FHIR Shorthand Mixed Normative/Trial Use Ballot (September 2021) introduced the following substantive changes as TRIAL USE features. Many of these features have been tested by the community, but some may undergo changes in the future.

• Parameterized rule sets (3.5.11.2, 3.6.12.2)
• Indented rules (3.6.2)
• Path rules (3.6.16)
• Logical models (3.5.7, 3.6.3)
• Custom resources (3.5.10, 3.6.3)
• Hierarchical code systems (3.5.3.1)
• Concept-specific caret rules (3.5.3.2)
• Inserting rule sets with path context (3.6.12.3)
• Support for integer64 and CodeableReference (3.2.3, 3.6.4.2, 3.6.4.7, 3.6.5, 3.6.17)

All other existing features originally introduced in FHIR Shorthand 1.0.0 were promoted to NORMATIVE status.

FHIR Shorthand 1.0.0 (HL7 Standard for Trial Use Release)

Initial Standard for Trial Use release.