The "Edit Implementation Guide" screen has functionality to generate a JIRA Spec file that is required by the HL7 ballot process. You can read more information on the purpose of the JIRA Spec file here.

ToF provides basic support for generating the JIRA Spec file that is needed for HL7 ballots. The first time the user clicks generate, it creates a template of the JIRA Spec file with as many defaults filled in as possible. Some of the information will have to be manually entered by the user because the information is not available automatically to Trifolia-on-FHIR, such as the "ballot url", the "git url", the "ci url", etc.

ToF automatically populates the "artifact" and "page" elements in the JIRA Spec based on the resources and pages in the IG.

If the text field for the JIRA Spec is empty when the user clicks "Generate", the JIRA Spec is generated brand new, with defaults for fields such as "ballot url", "git url", etc. If the text field has a JIRA Spec already defined in it when the user clicks "Generate", the existing JIRA Spec's artifacts and pages are updated based on the current resources and pages defined in the IG. When re-generating, ToF will flag old artifacts and pages as deprecated if the resource/page is not found in the current IG with a matching "key".

The process a user should follow for working with the ToF-generated JIRA Spec is:

  1. Create an IG, define resources and pages within the IG.
  2. Click "Generate" for the JIRA Spec.
  3. Specify the correct values for default properties such as "ballot url", "git url", etc.
  4. Save the IG to persist the JIRA Spec within the IG.
  5. Follow the process defined by HL7 for creating a pull request for the JIRA Spec.
  6. Over time, the IG is updated with new resources/pages...
    1. The user clicks "Generate" for the JIRA Spec and the artifacts/pages are updated based on the current state of the IG.
    2. Save the IG to persist the JIRA Spec's updates within the IG.
    3. Update the JIRA Spec within HL7's GIT repository via a new pull request.