search

HL7 / fhir-ig-publisher

Source code for the IG publisher
Apache License 2.0
69 stars 57 forks source link

Link additional binding uses (candidate, current, ui, starter, and component) to documentation that explains their meaning #958

Open dbojicic opened 1 month ago

dbojicic commented 1 month ago

In the Additional Bindings table, the purpose where the binding is required, extensible or preferred have links to the binding strength section of the FHIR standard. Max and min bindings also have resolving links.

However, the use of other additional bindings such as candidate, current, ui, starter and component is not explained in the IG, and there are no links to the documentation that explains their semantics (see a screenshot below, noting this was a test only). I am aware of issue #922, which proposes hyperlinking the "Additional Bindings" heading to the 'ElementDefinition-definitions.html' entry for additionalBindings, but I don't believe this offers a clear solution for this issue.

A specific change is requested to link these additional binding uses (candidate, current, ui, starter, and component) to documentation that explains their meaning and usage.

image

dbojicic commented 1 month ago

Noting here for the discussion in the FHIR Authoring Tools meeting although this will likely require one or more new issue to be raised:

  1. The latest IG Publisher (v1.6.28) does not seem to generate tables that include additional bindings documentation in the profile views and associated sections. See here for an IG generated using IG Publisher v1.6.20, and here for an IG generated using IG Publisher v1.6.28. Suggest a new tooling issue to be raised to ensure the missing documentation views are generated properly.

  2. The Purpose does not render the full display names from the Additional Binding Purpose Codes code system. For example, for the purpose 'maximum', 'Max Binding' is displayed in the IG instead of 'Maximum Binding' as shown in the Additional Binding Purpose Codes display. Suggest a new tooling issue to be raised to ensure that the full display names from the Additional Bindings Purpose Codes code system are used when generating IGs.

  3. The purpose 'current' is rendered as 'Required'.

  4. Regarding the Additional Bindings table in the profile view in the IG, I suggest making all table headings (i.e. Purpose) bold for consistency.

lmckenzi commented 1 month ago

We need to land https://jira.hl7.org/browse/FHIR-48479 before we'll have a good place to link to.

We will fix 'current' so it doesn't display as 'required'

Also 'Purpose' should be bolded in the table heading for additional bindings.