Move to HL7 URLs and standard template branding - #387
Merged
Conversation
Change the package ID to hl7.fhir.uv.sql-on-fhir and the canonical base to http://hl7.org/fhir/uv/sql-on-fhir, adopting HL7 publication mode. Add the governance metadata HL7 mode requires: publisher "HL7 International / FHIR Infrastructure" with the FHIR-I contact, wg = fhir, and standards-status = draft. Remove the special-url parameter now that operations use the conventional canonical URL form, and update the per-instance logical-resource canonicals in the resources block. No OID configuration is carried here; that remains with #381.
Cascade the new canonical base to operation definitions, the ViewDefinition logical model content references, example ViewDefinitions and SQLQuery/SQLView Libraries, and the JSON snippets in the operation and profile narrative pages. Operations move to the conventional .../OperationDefinition/<Id> form.
The "not an official HL7 project" suppression no longer applies now that the IG declares wg = fhir and builds in HL7 publication mode.
In HL7 publication mode the IG Publisher rejects the hl7.fhir.uv.extensions.r5 dependency: the shared canonical http://hl7.org/fhir/extensions resolves to the .r4 package, which is inconsistent with the stated .r5 packageId. Depend on the base hl7.fhir.uv.extensions package (native R5) instead - the conventional dependency for an R5 IG - which clears both dependsOn errors.
Update publication-request.json to the new package ID and canonical-derived path so the publication descriptor no longer declares the old identity. Add justified suppressions for the operation active/draft-status and FMM warnings surfaced by HL7 mode. Credit the sql-on-fhir.org community site in the index narrative (FR-006).
The standard HL7 FHIR template validates the IG's package-list and publication request during onGenerate and rejects the status value "release". Move to the HL7-accepted set ahead of re-basing the template: - sushi-config.yaml: releaseLabel release -> ci-build (this is the continuously built, not-yet-published current version). - publication-request.json: status release -> trial-use for 2.0.0, which was published as an STU milestone. - .gitignore: ignore the generated FHIR-sql-on-fhir.xml (a proposed Jira spec file the template emits for the HL7/JIRA-Spec-Artifacts repository).
Re-base custom-template from fhir.base.template onto hl7.fhir.template 1.0.0 so the IG inherits standard HL7/FHIR product family branding (header, colour scheme, footer, search), addressing the standard-template quality criterion in issue #378. - package/package.json: base -> hl7.fhir.template, pinned to 1.0.0. - Delete fragment-header.html, the header override that replaced standard branding, and add _append.fragment-header.html, which appends the SQL on FHIR project logo after the inherited branding via the supported extension point. - Delete sof.css and the empty _append.fragment-css.html: the custom colour scheme the standard branding supersedes. - Delete the duplicate fhir-logo-www.png: supplied by the standard template. - Delete _append.fragment-pageend.html, the jsdelivr CDN mermaid script; the base template renders mermaid natively via its bundled mermaid-init.js. History assets (assets-hist/) and sof-logo.svg are retained.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Moves the IG onto the HL7
uvnamespace and re-bases the local template on the standard HL7 FHIR template, so the published guide uses the official HL7/FHIR product family branding and the HL7 canonical URLs. Resolves the standard-template quality criterion raised in #378.There are two related parts:
URLs and identity. The IG id moves to
hl7.fhir.uv.sql-on-fhirand the canonical tohttp://hl7.org/fhir/uv/sql-on-fhir, with derived resource and prose URLs updated to match, the R5 base extensions dependency adopted for HL7 mode, and a stale warning suppression removed.Template and styling.
custom-templateis re-based fromfhir.base.templateontohl7.fhir.template1.0.0. The header override that replaced standard branding is removed and replaced with an_append.fragment-header.htmlthat adds the SQL on FHIR logo after the inherited HL7/FHIR branding via the supported extension point. The custom colour scheme (sof.css), the empty CSS append, the duplicate FHIR logo and the jsdelivr CDN mermaid script are all deleted; mermaid now renders via the base template's bundled support. History assets and the project logo are retained.Adopting the HL7 template also enforces publication-governance conventions, so
releaseLabelmoves fromreleasetoci-build, the 2.0.0publication-request.jsonstatus moves fromreleasetotrial-use(it was the STU R2 milestone), and the template-generatedFHIR-sql-on-fhir.xmlis gitignored.Verification: standard HL7 branding, the appended project logo and native mermaid rendering were all confirmed in the built output; before/after screenshots of the home page and a mermaid page are available and will be attached here.
One thing for reviewers: the HL7 template expects a Jira spec artefact named
FHIR-sql-on-fhirto exist in HL7/JIRA-Spec-Artifacts before ballot or publication. Until that is registered, the build reports it as an error, which will show up in CI. It needs HL7/FMG registration rather than a change in this repository.