IG Content: Documented Open Issues
Confirm that any JIRA trackers that have addressed in this version of the IG have been marked with the "Implemented in version" field in JIRA. (Note: to complete this step, the new version of the specification needs to be added within JIRA. Read more about how to configure Specification Feedback.
Confirm that any Open Issues present at the end of Ballot Reconciliation are documented in the relevant JIRA trackers with a note on planned release. In some cases this may be 'future' without a set date.
Implementer notes, such as FHIR "dragons be here", may be included within an IG when appropriate.
Do not documented open issues on the Confluence page associated with the project. Open issues should be addressed only as open JIRA trackers or as Implementer Notes within the IG.
added version 1.2.0 and the list of artefacts to HL7/JIRA-Spec-Artifacts. Updates already active in Jira.
Cover page, footer and TOC Information < ---- Future Update Will Be Needed based on new Guidance in the GOM on Specification Name
Confirm the specification files (Volume 1, Volume 2 or could be a single file that has both volume 1 and volume 2 content in it) word documents contain no tracked changes or comments.
Confirm the Cover Page and footer version number aligns with the version that is used in Jira to log comments. (It is used in the field called "Raised in version" which is documented in the HL7 essentials area of Confluence: https://confluence.hl7.org/pages/viewpage.action?pageId=19136736#SpecificationFeedback-RaisedinVersion)
Example Cover Page information:
Specification Date: August 2015
Specification Name: HL7 CDA R2 Implementation Guide: Consolidated CDA Templates for Clinical Notes (C-CDA)
Specification Version: 188.8.131.52 August 2022
Example Footer: 184.108.40.206 August 2022
Confirm the TOC(s) have no visual errors and the links are working.
Notes: There are no word documents
Generated PDF in https://github.com/HL7/CDA-pharma/tree/main/input/pdf
Added the Spec. Version and Updated the Footer.
Use Case Review
Confirm that the specification includes at least one clearly enumerated Use Case that illustrate the expected uses for the implementation guidance.
Code System and Value Set Review < ---- Proposed Update on 10/24 for Review
For each code system used in the IG or used by value sets referenced in the IG:
For each value set referenced in the IG, confirm that:
Confirm all value set bindings:
Confirm No Terminology Related Errors in IG Publishing Tool.
There are no links in the pdf for the value sets (links are active in the web available version; links are resolvable and satisfy the requirements.
No STATIC bindings
All checked value bindings have a binding stability (this is added by default by the tool)
Sample File and Schema Review
For each sample file:
Below, list the included sample files included with descriptions:
No CDA samples provided, because no document level templates are defined by this IG. This exception was agreed for the previous STU 1 release.
Notes to document any validation errors present.
This IG doesn't define any document level template, so no document level samples are provided, nor external fragment examples.
In line fragment examples are validated by the editing tool (ART-DECOR)
Github Repository Review
Confirm that a Github repository has been established for the Specification.
Confirm that the content associated with this version of the Specification has been loaded into the Github repository following best practice guidelines listed as instructions below.
CDA Artifact Github repo management guidance: https://confluence.hl7.org/display/SD/CDA+Github+Repository+Best+Practices
Paste link to github repo
_Readme.txt Package File Review
Confirm the _Readme.txt file and content meets the requirements of the template included by reference below.
These are the correct permalinks to be used when explaining where the CDA stylesheet and CDA schema's are located (Only a pointer to these materials can be included in the download package published on the HL7.org standards grid.):
When using the CDA_SDTC schema, use this link address for the extension schema: https://github.com/HL7/cda-core-2.0/tree/master/schema/extensions/SDTC
When using specialized stylesheets, include the specialized stylesheets or a link to the location of the specialized stylesheets within the Github repository.
Check the _Readme.txt file for accuracy:
Link to _Readme.txt template (template includes text to be updated): _Readme.txt Template
_Readme.txt to be updated with the Publication date when this will be available
Publication Request Form Review
Confirm the Publication Request is populated correctly:
Publication Request in HL7 CDA Pharmacy Template STU2
Publication Request quality attestation
Sponsoring WG Co-chair or technical resource from Sponsoring WG attests to having completed all required QA checklist steps and attests to the Implementation Guide and its publication package as meeting all requirements checked during the Publication Request QA review.
NOTE: After a Publication Request has been fully approved, the specification author is responsible for updates to support Configuring Specification Feedback. ALSO NOTE: Configuring Specification Feedback updates also must be made prior to a specification going to ballot. When a ballot version of a specification completes reconciliation and all comments have been resolved and the specification is approved to be published, the ballot version of the specification needs to be deprecated in JIRA and the newly published version needs to be added with deprecation=false. The default specification version also needs to updated.
By checking complete below, confirm that the following language appears in the Sponsoring WG's motion for approval:
"Based on this WG's review of the CDA Publication Checklist for this IG (insert link here to the completed Publication Request Checklist for the IG) and confirmation that no quality variations have been detected during the performed review, a motion has been made to approve the CDA IG Publication Request."
Link to minutes of approving workgroup:
--------------------------------------------------Steps to complete the vote CMG ONLY -------------------------------------------------