Stream: argonaut
Topic: US-Core / Issue #13 Prepublish punch list
us-core (Sep 26 2017 at 00:50):
Healthedata1 commented on Issue #13
Prepublish punch list:
1. make sure publisher, contacts and jurisdiction are all aligned in conformance resources
e.g.,
<publisher value="HL7 US Realm Steering Committee"/> <contact> <telecom> <system value="url"/> <value value="http://www.healthit.gov"/> </telecom> </contact> <jurisdiction> <coding> <system value="urn:iso:std:iso:3166"/> <code value="US"/> <display value="United States"/> </coding> </jurisdiction>1. Update Title
- Change title to reflect the published vs developmental version e.g., "US Core Implementation Guide CI Build" to "US Core Implementation Guide (Release 1)"1. Update the published version
- Update the Title
- Update footer
- publish history - how to do this..
1. create an archive list of version like this http://hl7.org/fhir/directory.html
- note you can use the IG Business version specification you define in ig.json: "{{site.data.fhir.ig.version}} "1. Update path to the main FHIR specification published base ( not build.fhir.org )
- **use Jekyll site variable**" {{site.data.fhir.path}}" ( or "{{ site.data.fhir.path }}" inside xml - the spaces matter for proper rendering) and define the the main FHIR specification in the `ig.json` configuration file "specification" : "[specification]" see [IG Pub Documentation](http://wiki.hl7.org/index.php?title=IG_Publisher_Documentation#Paths) - if DSTU2 then update specification to `http://hl7.org/fhir/DSTU2` - if STU3 then update specification to `http://hl7.org/fhir/STU3`1. update links to the latest version of dependencies
- use Jekyll site variable dependency url "{{site.data.fhir.[dependency-name]}}" or "{{ site.data.fhir.[dependency-name] }}" inside xml"e.g. “uscore” : Base url of a dependency implementation Guide (defined in ig.json) - "{{site.data.fhir.uscore}}" = http://hl7.org/fhir/us/core/stu1/ again see see [IG Pub Documentation](http://wiki.hl7.org/index.php?title=IG_Publisher_Documentation#Paths) for how these are defined in `ig.json`1. update any paths (links) in narrative sections to conformance resources using the Conformance resource variable:
- for relative paths use "{{site.data.structuredefinitions.[id].path}}" or "{{ site.data.structuredefinitions.[id].path }}" inside xml.
- for absolute paths use "{{site.data.fhir.canonical}}/{{site.data.structuredefinitions.[id].path}}" or "{{ site.data.fhir.canonical }}/{{ site.data.structuredefinitions.[id].path }}" inside xml.1. QA for typos grammar and content errors
1. fix all qa.html errors
- can view this at [canonical path to ig]/qa/html
- lists bad links
- errors and warnings for all conformance resources and examples1. push repo to GitHub - check for any rendering errors there
1. Contact Publisher and coordinate with them
us-core (Nov 01 2018 at 17:23):
Healthedata1 closed Issue #13
Last updated: Apr 12 2022 at 19:14 UTC