HL7 / fhir-shorthand

FHIR Shorthand
44 stars 8 forks source link

FSH 3.0 Resolutions - Language Reference and Index #176

Closed jafeltra closed 10 months ago

jafeltra commented 10 months ago

This PR contains a batch of changes that were agreed up as part of the FSH ballot resolution process. These changes are in both the index page and the language reference page. The following Jira issues were addressed:

FHIR-42322 - Rephrase to remove double "but" FHIR-42323 - Clarify which rules Context is preferred over FHIR-42324 - Clarify Extension keywords FHIR-42625 - Overriding the url of an Extension Note: In the resolution for this, I added links to the "caret path" section to remain consistent with other places we link to it in the spec and for ease of reference. I also aligned the examples to refer to the same properties that are mentioned in the note, which wasn't specified in the issue, but @cmoesel and I agreed it was helpful. FHIR-42319 - Clarify that alias cannot be used to construct urls FHIR-42618 - Invariant keyword TU statement must be split Note: I made the updates suggested in this issue in a second place where they seemed to also apply. FHIR-42329 - Consistent description of keywords FHIR-42318 - Remind reader of relationship between FSH profile and FHIR StructureDefinition, etc. FHIR-42316 - Don't mix profiling best practice with language features FHIR-42301 - Clarify if examples are normative FHIR-42321 - Follow syntax styling guidelines FHIR-42311 - Clarify use of non-ASCII characters FHIR-42312 - Clarify whether $ in alias name removes other name requirements FHIR-42313 - Rearrange item names for readability Note: FHIR-42311, FHIR-42312, and FHIR-42313 are all resolved in one commit. Each issue touches on the "item names" section, and I think the resolution in the commit encompasses the intent of each issue, but they were all a little different, so please review to ensure the resolution seems to cover all issues and that the resulting spec is still accurate to our intent for FSH. Note (again): The changes in the "item names" section make the restriction on characters in Aliases stronger than SUSHI currently imposes, but we have a Jira issue to track implementing those changes. FHIR-42289 - Remove spreadsheet IG authoring FHIR-42288 - Soften compatibility assertion

At least one reviewer should review each commit alongside its Jira issue to ensure the resolution was followed. Other reviewer(s) should ensure the content makes sense, there are no typos, etc.

Note: This PR should be merged using the rebase strategy to maintain commits.