SUSHI 3.4.0

What's Changed

• Support allowed R5 resources in R4/R4B IGs by @cmoesel in #1350 (details below)
• Use title, name, and description values in IG resource list by @mint-thompson in #1339 (details below)
• Update automatic dependencies by @cmoesel in #1342 (details below)
• Improve performance with Code Systems and Value Sets by @jafeltra in #1344
• Handle context StructureDefinition without derivation by @mint-thompson in #1348
• Improve parsing of date-like names by @cmoesel in #1352
• FshToFhir API: Process logicals by @mrcerf in #1345
• FshToFhir API: Process resources by @jafeltra in #1349
• Update regression to use FSHFinder as source (developer-facing change) by @cmoesel in #1338
• Update type signature for loadAutomaticDependencies (developer-facing change) by @mint-thompson in #1346
• Fix typo in comment (developer-facing change) by @masnick in #1343
• v3.4.0 by @cmoesel in #1354

Support allowed R5 resources in R4/R4B IGs

To better support emerging IG authoring features, a subset of R5 resources can be used in R4 and R4B IGs. Authors can create instances of these resources, but may not profile them. This feature has been available in the IG Publisher previously and is now available in SUSHI. Authors may now use FSH to define instances of the following R5 resources in R4 and R4B IGs:

• ActorDefinition
• Requirements
• SubscriptionTopic (R4 only; R4B uses the R4B SubscriptionTopic)
• TestPlan

Use title, name, and description values in IG resource list

When SUSHI creates the ImplementationGuide resource for an IG, it generates the resource list based on the items defined in the IG (or supplied in input/*). Since each resource in the list needs a name and description specified, SUSHI determines the appropriate name and description from the resource metadata. Prior to SUSHI 3.4.0, SUSHI only extracted metadata from FSH keyword values; now SUSHI will extract metadata from the title, name, or description resource elements when Title: or Description: keywords are not present.

With this change, authors may notice that their resources have more meaningful or user-friendly names in the IG's generated table of contents. In addition, the ordering of the resources in the table of contents may change since the default sort order is by name.

Update automatic dependencies

SUSHI now loads automatic dependencies in a way that is more consistent with the IG Publisher's approach:

• R4 and R4B IGs auto-load hl7.fhir.uv.tools (current), hl7.terminology.r4 (latest release), and hl7.fhir.uv.extensions.r4 (latest release)
• R5 IGs auto-load hl7.fhir.uv.tools (current), hl7.terminology.r5 (latest release), and hl7.fhir.uv.extensions.r5 (latest release)

New Contributors

• @mrcerf made their first contribution in #1345

Install or Update

SUSHI 3.4.0 is the latest stable release of fsh-sushi. To install or update to SUSHI 3.4.0, run the following command:

$ npm install -g fsh-sushi

To revert to the previous SUSHI stable release (3.3.3), run the following command:

$ npm install -g [email protected]

To check or confirm what version of SUSHI you have installed, you can run the following command:

$ sushi -v

Full Changelog: v3.3.3...v3.4.0

SUSHI 3.3.3

SUSHI 3.3.3 is a patch release that fixes a bug and improves logging in some cases.

What's Changed

• Fix problem with contentReference and Logic Models by @bkaney in #1334
• Log a warning when conformance and terminology instances default to Usage: #example by @jafeltra in #1329
• Log stacks from unexpected errors at the debug level by @cmoesel in #1331
• Better regression report by @cmoesel in #1332

Install or Update

SUSHI 3.3.3 is the latest stable release of fsh-sushi. To install or update to SUSHI 3.3.3, run the following command:

$ npm install -g fsh-sushi

To revert to the previous SUSHI stable release (3.3.2), run the following command:

$ npm install -g [email protected]

To check or confirm what version of SUSHI you have installed, you can run the following command:

$ sushi -v

Full Changelog: v3.3.2...v3.3.3

SUSHI 3.3.2

SUSHI 3.3.2 is a patch release that resolves some issues introduced in SUSHI 3.3.1, where the installation could fail if antlr4 was installed to an unexpected location.

What's Changed

• Better antlr4 workaround by @mint-thompson in #1325
• Add build command to antlr4 workaround script by @mint-thompson in #1327

Full Changelog: v3.3.1...v3.3.2

Install or Update

SUSHI 3.3.2 is the latest stable release of fsh-sushi. To install or update to SUSHI 3.3.2, run the following command:

$ npm install -g fsh-sushi

To revert to the previous SUSHI stable release (3.3.1), run the following command:

$ npm install -g [email protected]

To check or confirm what version of SUSHI you have installed, you can run the following command:

$ sushi -v

SUSHI 3.3.1

SUSHI 3.3.1 is a patch release intended to improve performance. There are no other new features or bug fixes included in this release. You may notice some additional output during the installation of this version. This output is a result of a temporary implementation that is needed until SUSHI's antlr4 dependency releases an update. This temporary implementation will be removed in a future version of SUSHI when the updated dependency is available.

What's Changed

• Antlr4 performance workaround by @mint-thompson in #1323

Full Changelog: v3.3.0...v3.3.1

Install or Update

SUSHI 3.3.1 is the latest stable release of fsh-sushi. To install or update to SUSHI 3.3.1, run the following command:

$ npm install -g fsh-sushi

To revert to the previous SUSHI stable release (3.3.0), run the following command:

$ npm install -g [email protected]

To check or confirm what version of SUSHI you have installed, you can run the following command:

$ sushi -v

SUSHI 3.3.0

SUSHI 3.3.0 is the first release to fully support all of the trial-use features introduced in the FHIR Shorthand 3.0 Ballot Specification.

What's Changed

• Allow caret and insert rules to be applied to concepts within a ValueSet by @mint-thompson in #1315 (details below)
• System version doesn't need to match when assigning a code by @mint-thompson in #1317
• Warn and ignore version when processing references by @mint-thompson in #1316
• Revise warning message for configuration "pages" property by @mint-thompson in #1318
• Add more error puns by @vadi2 in #1319
• Update FSH version to indicate full support for 3.0.0-ballot by @cmoesel in #1321

Full Changelog: v3.2.0...v3.3.0

Allow caret and insert rules to be applied to concepts within a ValueSet

Authors can now set the underlying metadata of concepts in a ValueSet using caret rules. This works in a similar way as setting metadata on concepts in CodeSystems and is primarily used to set concept designation properties.

For example, to specify a designation for the fully specified name of the included concept $SCT#84162001 using indented rules:

* $SCT#84162001  "Cold"
  * ^designation[0].use = $SCT#900000000000003001 "Fully specified name"
  * ^designation[0].value = "Cold sensation quality (qualifier value)"

Or, if you prefer, you may repeat the code on each caret assignment:

* $SCT#84162001  "Cold"
* $SCT#84162001 ^designation[0].use = $SCT#900000000000003001 "Fully specified name"
* $SCT#84162001 ^designation[0].value = "Cold sensation quality (qualifier value)"

For more information and examples, see the trial-use Concept Metadata documentation in the FSH 3.0.0 Ballot Specification.

Install or Update

SUSHI 3.3.0 is the latest stable release of fsh-sushi. To install or update to SUSHI 3.3.0, run the following command:

$ npm install -g fsh-sushi

To revert to the previous SUSHI stable release (3.2.0), run the following command:

$ npm install -g [email protected]

To check or confirm what version of SUSHI you have installed, you can run the following command:

$ sushi -v

SUSHI 3.2.0

What's Changed

• Support patch wildcard when including package versions in configuration by @jafeltra in #1310 (details below)
• Fix npx usage and update antlr4 dependency by @mint-thompson in #1309
• Fix problems when setting values on child elements in primitive arrays by @mint-thompson in #1302
• Improve Handling of ElementDefinition.binding without valueSet by @cmoesel in #1313
• Log the name of the file that is not processed by SUSHI by @mrinnetmaki in #1307
• Update for resolving tarball location of custom registries to support NPM clients by @bkaney in FHIR/fhir-package-loader#16

Support patch wildcard when including package versions in configuration

Authors can now indicate that a dependency should resolve to the latest patch version within a given minor release by specifying the patch version as x. For example:

dependencies:
  hl7.fhir.us.core: 6.0.x

In the above example, the US Core dependency would currently resolve to 6.0.0 because that is the latest 6.0 release. If US Core were to release a 6.0.1 version, however, the dependency would then resolve to 6.0.1.

Please note that SUSHI and the IG Publisher support this only for patch releases. It is not possible to use the x wildcard to indicate the latest major or minor release.

New Contributors

• @mrinnetmaki made their first contribution in #1307

Full Changelog: v3.1.0...v3.2.0

Install or Update

SUSHI 3.2.0 is the latest stable release of fsh-sushi. To install or update to SUSHI 3.2.0, run the following command:

$ npm install -g fsh-sushi

To revert to the previous SUSHI stable release (3.1.0), run the following command:

$ npm install -g [email protected]

To check or confirm what version of SUSHI you have installed, you can run the following command:

$ sushi -v

SUSHI 3.1.0

SUSHI 3.1.0 introduces new features that are proposed in FHIR Shorthand 3.0.0 (to be balloted in September 2023). SUSHI 3.1.0 also contains several minor enhancements and bug fixes.

What's Changed

• Support Context keyword when defining Extensions by @mint-thompson in #1282 (details below)
• Support Characteristics keyword when defining Logical models by @mint-thompson in #1293 (details below)
• Add CodeableReference keyword by @jafeltra in #1292 (details below)
• Log an error when applying type and binding constraints on CodeableReference subelements by @jafeltra in #1294
• Slicing rules should not be on slices by @mint-thompson in #1291
• Include version in Only Rules by @jafeltra in #1295
• Handle spaces after bracketed parameters by @mint-thompson in #1290
• Assignment on primitive satisfies cardinality of value element by @mint-thompson in #1284

Full Changelog: v3.0.0...v3.1.0

Extension Context Keyword

When defining extensions, it is considered best practice to specify the contexts under which the extension can be used. Until now, authors did this by setting StructureDefinition.context via caret assignment rules. FHIR Shorthand 3.0 (balloting in September 2023) introduces a new Context: keyword for specifying one or more extension contexts. Context values can be an entity, entity with a FSH path, or FHIRPath string.

For example, the following extension is applicable to most resources representing a person in FHIR:

Extension: FavoriteBaseballTeam
Id: favorite-baseball-team
Title: "Favorite Baseball Team"
Description: "The person's favorite baseball team"
Context: Patient, RelatedPerson, Person, Practitioner
* value[x] only CodeableConcept
* value[x] from BaseballTeamsVS

For more information, see Defining Extensions in the current build of the FSH specification.

Logical Model Characteristics Keyword

When defining logical models, authors may want to indicate the type characteristics that apply to the type (e.g., has-target, has-range, can-bind, etc.). Until now, authors did this by specifying one or more Type Characteristics extensions. FHIR Shorthand 3.0 (balloting in September 2023) introduces a new Characteristics: keyword for specifying one or more type characteristic codes.

For example, the following logical model indicates that it can be the target of a reference from another logical model:

Logical: Human
Id: human-being-logical-model
Title: "Human Being"
Description: "A member of the Homo sapiens species."
Characteristics: #can-be-target
* name 0..* SU HumanName "Name(s) of the human" "The names by which the human is or has been known"
// more rules...

NOTE: The can-be-target characteristic was mistakenly left out of the current version of the Type Characteristics code system. Since this is an important characteristic, however, SUSHI allows authors to specify the #can-be-target characteristic. While can-be-target remains missing from the code system, SUSHI will represent it using the Logical Target extension. Once the Type Characteristics code system supports can-be-target, SUSHI will represent it using the Type Characteristics extension. See the Reference to Logical Model topic on Zulip for more discussion.

For more information, see Defining Logical Models in the current build of the FSH specification.

CodeableReference Keyword

FHIR Shorthand 2.0 introduced trial-use support for CodeableReferences by leveraging the existing Reference keyword. While this works well for assigning the reference component of a CodeableReference, it does not always work well when constraining the reference type of a CodeableReference or adding a new CodeableReference element to a logical model or custom resource. To better support these use cases, FHIR Shorthand 3.0 (balloting in September 2023) introduces a new CodeableReference keyword for use with add element rules and type rules.

For example, the following rule constrains MedicationRequest.reason to a CodeableReference targeting an Observation:

* reason only CodeableReference(Observation)

For more information, see Add Element Rules and Type Rules in the current build of the FSH specification.

Other Features Introduced in FHIR Shorthand 3.0

The previous SUSHI release, SUSHI 3.0.0, introduced support for other proposed FHIR Shorthand 3.0 features, such as:

• defining instances of logical models (spec)
• using rules in Invariant definitions (spec)
• using assignment rules and constraining inherited elements in logical models (spec)
• avoiding excessive escapes in insert rules by using double square brackets (spec)

The following feature, also proposed in FHIR Shorthand 3.0.0, is not yet implemented in SUSHI:

• assigning metadata to concepts in value sets (spec)

Install or Update

SUSHI 3.1.0 is the latest stable release of fsh-sushi. To install or update to SUSHI 3.1.0, run the following command:

$ npm install -g fsh-sushi

To revert to the previous SUSHI 3.0.0 stable release, run the following command:

$ npm install -g [email protected]

To check or confirm what version of SUSHI you have installed, you can run the following command:

$ sushi -v

SUSHI 3.0.0

SUSHI 3.0.0 is a major release of SUSHI introducing a number of new features, enhancements, and bug fixes. In addition, it adds preliminary support for FSH syntax and features that will be balloted in September. As a major release, this version contains breaking changes and updated system requirements.

The SUSHI team recommends that all users upgrade to SUSHI 3.0.0 by running the following command:

$ npm install -g fsh-sushi

Breaking Changes

The following breaking changes affect how you use SUSHI:

• SUSHI now requires Node.js 18 (#933)
• SUSHI executable now uses commands (#1163)

The following changes are considered breaking in that they change SUSHI's output in significant ways:

• Element ids and paths no longer use choice type renaming (#954)
• Choice elements are not sliced when they are restricted to only a single type (#1088)
• The resource status element defaults to IG status instead of active (#1143)
• The resource version element is only included when specifically set by the author (#1143)
• Title and description elements are automatically assigned for Instances that support them (#1003)

New Features

The following new features support FSH specification changes that will be balloted in September:

• Instances of logical models can be defined in FSH (#1280)
• Elements of Invariant definitions can be defined using rules (#1272)
• Insert rule parameters can be enclosed in double brackets to avoid excessive escaping (#1216)
• Optional "manual slicing" mode improves control over slice order (#1121, #1200)
• Path rules may be used to force export of required fixed values (#1252)

The following new features are specific to SUSHI, but not related to the specification:

• Include the fsh-link-references.md file for easier linking in pages (#1136)
• Run the update-dependencies command to check for dependency updates (#1152)
• Configure log levels to affect logging output (#1208)
• Specify an alternate package server to use for downloading dependencies (#1260)

Enhancements

The following enhancements affect how SUSHI processes FSH and FSH projects:

• Support for scientific notation when defining number types (#1203)
• Improved support for versioned canonicals (#1275)
• Logical and Resource element names are checked against FHIR naming rules (#1230)
• Improved ordering of resources in generated IG file (#1118)
• Improved validation of sushi-config.yaml property names (#1265)
• Improved support for paths whose names contain FSH keywords (#1244)
• A new environment variable can be used to force fancy characters in console output (#1177)
• Dependency loading uses new FHIR Package Loader library (#1026)
• New and improved (?) puns (#1229)

Bug Fixes

The following bug fixes address bugs from the latest 2.x release:

• Correctly resolve references to non-instance items (#1254, #1257)
• Support versions in instance meta.profile when setting exampleCanonical in IG (#1228)
• Populate IG exampleCanonicals regardless of meta.profile configuration (#1245)
• Correctly parse unicode characters using \u escape sequence in strings (#1233)
• Improve assigning instance as values, especially when instance id is a number or boolean (#1242)
• Fix bug that sometimes caused primitives to be exported as objects (#1261)
• Don't create Instances if the nearest specialization ancestor is abstract (#1237)

Additional Details

Breaking: SUSHI now requires Node.js 18 (#933)

Node.js 12 and 14 have reached their end-of-life and Node.js 16 will reach end-of-life in September 2023 (see Node.js Releases). In order to ensure that SUSHI remains performant and secure, it now requires Node.js 18 (LTS). Although previous versions of Node.js may work with this release of SUSHI, they are not officially supported (and may stop working in the future).

To download a more recent version of Node.js go to: https://nodejs.org/en/download/.

Breaking: SUSHI executable now uses commands (#1163)

The sushi executable now takes a command as the second argument. Available commands are: build, init, update-dependencies, and help. This provides a more consistent approach to using SUSHI and allows for further functionality in the future.

• To build a project, use sushi build path/to/project (or sushi build to build the current directory).
• To initialize a new project, use sushi init.
• To update your dependencies to the latest versions, use sushi update-dependencies path/to/project (or sushi update-dependencies to update dependencies in the current directory).

For now, SUSHI will continue to accept the legacy usage for building, allowing for users to enter just sushi or sushi path/to/project. Future versions, however, may deprecate and/or remove legacy command support.

Breaking: Element ids and paths no longer use choice type renaming (#954)

SUSHI 2.x utilized an approach to choice types that simplified their element ids and paths. For example, Observation.value[x]:valueQuantity could be simplified to Observation.valueQuantity in the profile's differential and the IG Publisher would convert it to the "long form" during the snapshot generation process. This was referred to as choice type renaming.

As of 2023, this is no longer considered best practice. As a results, SUSHI 3.0.0 no longer uses choice type renaming.

Consider the following rule on an Observation profile:

* valueQuantity MS

In SUSHI 2.x, this results in a differential element with the following id and path:

{
  "id": "Observation.valueQuantity",
  "path": "Observation.valueQuantity",
  // additional properties
}

In SUSHI 3.0.0, this results in the following id and path instead:

{
  "id": "Observation.value[x]:valueQuantity",
  "path": "Observation.value[x]",
  // additional properties
}

This provides a more consistent representation of choice type elements without changing their meaning.

Breaking: Choice elements are not sliced when they are restricted to only a single type (#1088)

In SUSHI 2.x, whenever an author uses a type-specific path (such as valueCodeableConcept), it uses the standard type slicing mechanism to represent it. While this is necessary to distinguish types when there are multiple types to choose from, it is not necessary when a choice element has already been constrained to a single type.

For example, consider the following FSH definition:

Profile: MyObservation
Parent: Observation
* value[x] only CodeableConcept
* valueCodeableConcept from MyValueSet

Given the definition above, SUSHI 2.x will produce a differential that slices value[x] by type and introduces a specific choice type slice for valueCodeableConcept:

Given the same definition, SUSHI 3.0.0 will recognize that value[x] can only be a CodeableConcept and will simplify the differential by applying the constraint directly to value[x] instead of slicing it:

This maintains the intent of the profile while simplifying its representation by avoiding unnecessary slices when possible.

Note: If a choice element has already been sliced (i.e., by a parent profile), then SUSHI 3.0.0 will maintain consistency by using choice type slicing even if the choice element has already been reduced to a single type.

Breaking: The resource status element defaults to IG status instead of active (#1143)

SUSHI 2.x automatically defaults the status field to active on Profiles, Extensions, Logical Models, Resources, Value Sets, and Code Systems. SUSHI 3.0.0, however, now defaults the status to be the same as the overall IG status. This aligns more closely to the behavior of the IG Publisher and more likely reflects the intended status of resources. Authors can always override the status on individual definitions via a caret rule (e.g., * ^status = #active).

Breaking: The resource version element is only included when specifically set by the author (#1143)

SUSHI 2.x automatically defaults the version field on Profiles, Extensions, Logical Models, Resources, Value Sets, and Code Systems to the version of the IG. SUSHI 3.0.0, however, no longer sets the version unless the author has specifically set it via a FSH rule. This allows the version to be controlled by the FHIR templates and IG Publisher. The default behavior for these is to apply the IG version across all resources, so most authors will not see a change in the end result when using the IG Publisher.

Authors who want more control over when and how version is set should look into the apply-version and default-version IG parameters, which can be set in the sushi-config.yaml parameters object.

Breaking: Title and description elements are automatically assigned for Instances that support them (#1003)

To define conformance resources other than profiles, extensions, code systems, and value sets, authors must define an Instance of the resource. Although conformance resources often have a title and description, SUSHI 2.x requires authors to set those using assignment rules (e.g., * title = "My Operation Definition"), even when the author already specified a title using the Title: keyword.

In SUSHI 3.0.0, if an author specifies a Title: on an Instance whose type supports a title element, SUSHI 3.0.0 will automatically assign that value to the instance's title element. Similarly, if an author specifies a `Descri...

v2.10.2

What's Changed

• SUSHI 2.x: Use R5 5.0.0 for cross-version (implied) extensions by @cmoesel in #1277

To install or update, run:

npm install -g fsh-sushi

Full Changelog: v2.10.1...v2.10.2

SUSHI 3.0.0 Beta 3

SUSHI 3.0.0 Beta 3 is the third beta release for SUSHI 3.0. The SUSHI 3.0 beta releases change SUSHI behavior and output. They also require a later version of Node.js. As such, SUSHI 3.0 is considered to have breaking changes.

SUSHI 3.0.0 Beta 3 Overview

SUSHI 3.0.0 Beta 3 introduces the following changes from the SUSHI 3.0.0 Beta 2 release:

• Insert rule parameters can be enclosed in double brackets by @mint-thompson in #1216
• Parse Path Rules on Instances by @jafeltra in #1252
• Improve import & export of ids/extensions on primitives by @cmoesel in #1240
• Import and Parse Unicode Characters by @jafeltra in #1233
• Automatically load hl7.fhir.uv.extensions for FHIR R5 (Draft Final and Final) by @cmoesel in #1234
• Change hl7.fhir.uv.extensions autoload to use 'latest' version by @cmoesel in #1248
• Correctly resolve references to non-instance items by @cmoesel in #1254
• Replace references to contained canonicals w/ fragment reference by @cmoesel in #1257
• Allow most FSH keywords to be used as paths. by @mint-thompson in #1244
• Populate exampleCanonical regardless of meta.profile configuration by @mint-thompson in #1245
• Allow versioned URL in extension contains rule by @mint-thompson in #1251
• Support versions in instance meta.profile when setting exampleCanonical in IG by @mint-thompson in #1228
• Allow assignment of Instance values in any entity using Assignment or Caret Value rules, even when Instance has a numeric or boolean id by @mint-thompson in #1242
• Check ElementDefinition invariants related to element name when adding elements to Logical or Resource by @mint-thompson in #1230
• Don't create Instances if the nearest specialization ancestor is abstract by @mint-thompson in #1237
• Introduce an ENV variable to force fancy characters use by @qligier in #1177
• Update puns.ts by @markkramerus in #1229
• Update fhir-package-loader to v0.2.0 by @cmoesel in #1246
• Update find-repos script, repos-all, and repos-select by @cmoesel in #1231

SUSHI 3.0.0 Beta 3 Details

Insert rule parameters can be enclosed in double brackets

Parameter values used in insert rules can be enclosed in double brackets to avoid most of instances of needing to escape ) and ,. More details on the use of this syntax are available in the FSH language reference.

Parse Path Rules on Instances, and use them when exporting the Instance

A path rule on a FSH Instance now has two useful side effects:

• If a path rule refers to an optional element, fixed values on that element will be set on that element. Additionally, any required child elements with fixed values will be set on that element. This is useful if those fixed values are the only values the author wants to set on the parent element.
• When manual slice ordering is enabled, path rules can be used to define the ordering of slices.
  More details about path rules are available in the FSH language reference.

Improve import & export of ids/extensions on primitives

SUSHI now correctly handles extensions on ElementDefinition.type.profile and ElementDefinition.type.targetProfile, as well as other cases where primitive values have child elements. This applies to importing and exporting resources. Previously, SUSHI would drop all properties starting with _ when importing a StructureDefinition from a JSON definition, and would not check properties starting with _ when calculating a differential.

Import and Parse Unicode Characters

Unicode characters can be used in FSH strings by using \u followed by the character's four-digit code. For example:

* valueString = "F\u00FCmms b\u00F6"

Automatically load hl7.fhir.uv.extensions for FHIR R5 (Draft Final and Final)

Core FHIR extensions are provided by the hl7.fhir.uv.extensions package as of FHIR R5 Draft Final. This package is automatically loaded when a SUSHI project's FHIR version is FHIR R5 Draft Final or later. The latest published version of the extensions package is used.

Correctly resolve references to non-instance items, and Replace references to contained canonicals w/ fragment reference

References to non-Instance items will be resolved using relative URLs, when possible. This applies to References to both local and external items. Furthermore, if the Reference points to a contained resource, the fragment id of the referenced item will be used.

Allow most FSH keywords to be used as paths

SUSHI's parser now correctly recognizes when a FSH keyword, such as exclude, is being used as a path. Most FSH keywords can now be used as paths. There are still some cases that can result in ambiguous statements, but for most uses, there should no longer be any problems.

Populate exampleCanonical regardless of meta.profile configuration

SUSHI will add an exampleCanonical for example instances defined in FSH to the IG's resource list, even if the example instance's meta.profile element is not set.

Allow versioned URL in extension contains rule

When defining slices on an extension element, an extension's URL may be followed by a | and a version. For example:

* extension contains http://hl7.org/fhir/StructureDefinition/familymemberhistory-type|4.0.1 named history 0..1

If the version specified in the rule doesn't match the version of the available extension, SUSHI emits a warning.

Support versions in instance meta.profile when setting exampleCanonical in IG

Example instances may have a URL with a version in their meta.profile. If the profile with that URL and version are available, use that URL to set exampleCanonical in the IG.

Allow assignment of Instance values in any entity using Assignment or Caret Value rules, even when Instance has a numeric or boolean id

Assignment rules, with or without caret paths, now consistently allow for the assignment of instances. Previously, SUSHI would not allow instance assignment in many situations, such as when defining a ValueSet. Additionally, since instances can legally have an id that looks like a number or boolean, SUSHI will be flexible when trying to assign such values. For example, an instance with id 12E1 can now be used in assignment rules.

Check ElementDefinition invariants related to element name when adding elements to Logical or Resource

The specification for ElementDefinition defines two invariants regarding element names: a strict invariant regarding prohibited characters and name length, and a less strict invariant regarding recommended format. When adding elements on Logical or Resource definitions, SUSHI now outputs errors for violations of the strict invariant and warnings for violations of the less strict invariant.

Don't create Instances if the nearest specialization ancestor is abstract

SUSHI will not allow authors to create instances of abstract specializations, such as DomainResource. An instance of an abstract Profile is fine, as long as the nearest specialization ancestor is not abstract.

Introduce an ENV variable to force fancy characters use

The environment variable FORCE_FANCY_CHARACTERS can be set to force SUSHI to output fancy characters when being run by the IG publisher. Previously, SUSHI would never output fancy characters when being run by the IG publisher. The FORCE_FANCY_CHARACTERS environment variable should be set to 1 or true to enable this feature. Users may also wish to set the FORCE_COLOR environment variable, which is defined and used by chalk, to control color output.

Update puns

Some freshly-caught fish puns are added in this release.

SUSHI 3.0.0 Beta 1 and 2 Overview

The previous beta releases, SUSHI 3.0.0 Beta 1 and SUSHI 3.0.0 Beta 2, introduced the following changes from the SUSHI 2.x releases:

Changes from SUSHI 3.0.0 Beta 2

• Changes to how you use SUSHI on the command line (#1163)
• New optional "manual slicing" mode for improved control over slice order (#1121, #1200) (breaking change if enabled)
• Do not set resource version unless specifically set by author (#1143) (breaking change)
• Default resource status to IG status instead of active (#1143) (breaking change)
• New fsh-link-references.md file for easier linking in pages (#1136)
• Support for scientific notation of numbers (#1203)
• Order IG resources based on the configuration order (#1118)
• New update-dependencies command (#1152)
• Configurable log levels (#1208)
• Include default type slicing in differential (#1179)
• All updates from SUSHI 2.6.1, 2.7.0, 2.7.1, 2.8.0, and 2.9.0

Changes from SUSHI 3.0.0 Beta 1

• Require Node.js 16 or Node.js 18 (breaking change)
• Do not use choice type renaming in element ids or paths (#954) (breaking change)
• Do not slice choice elements when ...