Merge pull request #124 from WorldHealthOrganization/main

catch up

README.md

@@ -8,6 +8,7 @@
 
 
 # WHO SMART Guidelines L3 SOP v1.0.0
+
 ---
 This is the v1.0.0 release of the SMART Guidelines L3 SOP
 <br> </br>

input/ignoreWarnings.txt

@@ -5,3 +5,4 @@
 An HTML fragment from the set [dependency-table.xhtml, dependency-table-short.xhtml] is not included anywhere in the produced implementation guide
 The HTML fragment 'globals-table.xhtml' is not included anywhere in the produced implementation guide
 Reference to deprecated item http://hl7.org/fhir/ValueSet/jurisdiction|5.0.0
+Reference to deprecated ValueSet http://hl7.org/fhir/ValueSet/jurisdiction|5.0.0

input/pagecontent/changes.md

@@ -1,5 +1,6 @@
 ### First Release (V1.0.0)
 
+
 'First release of the SOP'
 
 #### Known Issues

input/pagecontent/gov_overview.md

@@ -1,6 +1,6 @@
-SMART Guidelines artifacts are meant to be interoperable and shared. This means that the artifacts can be maintained and possibly reused and referenced across Guidelines.
+SMART Guidelines artifacts are meant to be interoperable, shared and adaptable. One of the implications is that the artifacts can be maintained and possibly reused and referenced across Guidelines. This is one of the reasons for the SMART Guidelines to use machine-readable content.
 
-The authoring process currently identifies some artifacts that are subject to "common" governance i.e. being maintained not within one single guideline, but as possibly reusable artifacts:
+In the authoring processes, there are some artifacts that are subject to "common" governance - this means that such artefacts are maintained not within one single guideline, but as possibly reusable artifacts:
 
 * Concept definitions may be defined in a common base - for example "Patient given name" and "Pregnancy status" are definitions that should be common across SMART Guidelines
 * Business Processes, Personas - several of such artifacts can be used when building up an architecture from the modular components, aiming at reuse or consistency

input/pagecontent/ig_configuration.md

@@ -11,15 +11,15 @@ For WHO-authored Guidelines (i.e. not for adaptations), the configuration includ
 * Version: `0.1.0` initially, see [Versioning](versioning.html) for more details on artifact versioning
 * Jurisdiction: Should be 001 from http://unstats.un.org/unsd/methods/m49/m49.htm for World (see https://www.hl7.org/fhir/valueset-jurisdiction.html)
 * Publisher: Set as appropriate for the publisher (i.e. steward) of the IG
-* ImplementationGuide resources SHALL conform to [CRMIShareableImplementationGuide]({{site.data.fhir.ver.crmi}}/StructureDefinition-crmi-shareableimplementationguide.html)
-* Active, published ImplementationGuide resources SHALL conform to [CRMIPublishableImplementationGuide]({{site.data.fhir.ver.crmi}}/StructureDefinition-crmi-publishableimplementationguide.html)
-* ImplementationGuide resources SHALL conform to [CPGComputableGuideline]({{site.data.fhir.ver.cpg}}/StructureDefinition-cpg-computableguideline.html)
+* ImplementationGuide resources SHALL conform to [CRMIShareableImplementationGuide](https://hl7.org/fhir/uv/crmi/StructureDefinition-crmi-shareableimplementationguide.html)
+* Active, published ImplementationGuide resources SHALL conform to [CRMIPublishableImplementationGuide](https://hl7.org/fhir/uv/crmi/StructureDefinition-crmi-publishableimplementationguide.html)
+* ImplementationGuide resources SHALL conform to [CPGComputableGuideline](https://build.fhir.org/ig/HL7/cqf-recommendations/StructureDefinition-cpg-computableguideline.html)
 
 
 For National adaptations: 
-- If the country or region has an an HL7 affiliate, the HL7 affiliate can include the smart guidelines in their publication process and use the defined conventions
-  - Package id convention is defined locally, e.g. `hl7.fhir.country.smart.xxx`
-- If there is no affiliate or the affiliate declines, other organizations 
-
+* If the country or region has an an HL7 affiliate, the HL7 affiliate can include the smart guidelines in their publication process and use the defined conventions
+  * Package id convention is defined locally, e.g. `hl7.fhir.country.smart.xxx`
+* If there is no affiliate or the affiliate declines, other organizations may fulfill that role
+* Jurisdiction should be adjusted
 * L3 authors should ensure that the content has some feedback mechanism.
 

input/pagecontent/ig_publication.md

@@ -82,7 +82,7 @@ The release publication steps are:
 
 2. Optionally, create a new branch, e.g. `release-candidate` for iterating changes.  
 
-3. Create the [`publication-request.json`](https://confluence.hl7.org/display/FHIR/IG+Publication+Request+Documentation) file. This file is critical and it is important to follow the instructions correctly, as incorrect changes may cause irreparable damage to previously published and normative specifications.   
+3. Create the `publication-request.json` file (see [documentation](https://confluence.hl7.org/display/FHIR/IG+Publication+Request+Documentation)). This file is critical and it is important to follow the instructions correctly, as incorrect changes may cause irreparable damage to previously published and normative specifications.   
 
 4. Update the ImplementationGuide (and all conformance artifacts in the IG):
     * The `status` of the IG (and all conformance artifacts in the IG) should be `active`;
@@ -96,10 +96,10 @@ The release publication steps are:
 
 7. If all is ok and the pages are created correctly, create a release and tag with the latest changes
 
-8. Make a PR of the built specification (all releases) to smart.who.int.
+8. Make a PR of the built specification (all releases) to the repository holding the content of http://smart.who.int .
 
 9. If a branch was created in step 2, optionally merge it with any updates that have been done meanwhile.
 
-10. In the main branch, update the ImplementationGuide resource
+10. In the main branch, update the ImplementationGuide resource for continuing work:
     * The `status` of the IG should be set back to `draft`;
     * The `version` should be updated - this way it's immediately assured that any new changes are for a new version.

input/pagecontent/index.md

@@ -24,6 +24,13 @@ This guide is divided into several sections that are displayed in the menu bar l
 - <a href="authoring_overview.html">Authoring</a> - Contains a step by step guidance and requirements on authoring L3 resources while transforming from L2 DAK to L3
 - <a href="qa_check.html">Validating IG</a> - Under development currently. Will contain guidance on running QA checks and available tooling to test the authored IG
 
+
+#### Keywords
+> The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
+NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED",  "MAY", and
+"OPTIONAL" in this document are to be interpreted as described in
+[RFC 2119](https://www.ietf.org/rfc/rfc2119.txt).
+
 ### Intellectual Property and Copyright considerations
 
 This documentation is distributed under the CC-BY-IGO license. Please see the [license details](license.html).

input/pagecontent/l2_l3_overview.md

@@ -196,12 +196,12 @@ The table and diagram below show the content types that are to be created as par
             <td>input/cql</td>
             <td><a href="l3_cql.html">CQL</a></td>
         </tr>
-        <tr>
+        <!-- <tr>
             <td rowspan="1">Scheduling Logic</td>
             <td>FHIR PlanDefinition</td>
             <td>input/plandefinitions</td>
             <td rowspan="1"><a href="l3_schedulinglogic.html">Scheduling Logic</a></td>
-        </tr>
+        </tr> -->
         <tr>
             <td rowspan="2">Indicators and Measures</td>
             <td>FHIR Measure</td>
@@ -237,7 +237,6 @@ While the exact authoring steps depend on the inputs, the key sequence could nor
 * [Libraries](l3_libraries.html)
 * [Decision Tables](l3_decisiontables.html)
 * [Indicators](l3_indicators.html)
-* [Scheduling Logic](l3_schedulinglogic.html)
 * [Test Cases](l3_testing.html)
 * [Personas](l3_personas.html)
 * [Scenarios](l3_scenarios.html)

input/pagecontent/l3_codesystems.md

@@ -35,8 +35,8 @@ This is the overview of the activities and related artifacts used:
 ### **Output Criteria / Definition of Done**
 
 * Appropriate CodeSystem resources are defined
-* CodeSystem resources SHALL conform to [CRMIShareableCodeSystem]({{site.data.fhir.ver.crmi}}/StructureDefinition-crmi-shareablecodesystem.html)
-* Active, published CodeSystem resources SHALL conform to [CRMIPublishableCodeSystem]({{site.data.fhir.ver.crmi}}/StructureDefinition-crmi-publishablecodesystem.html)
+* CodeSystem resources SHALL conform to [CRMIShareableCodeSystem](https://hl7.org/fhir/uv/crmi/StructureDefinition-crmi-shareablecodesystem.html)
+* Active, published CodeSystem resources SHALL conform to [CRMIPublishableCodeSystem](https://hl7.org/fhir/uv/crmi/StructureDefinition-crmi-publishablecodesystem.html)
 * no QA issues in the publisher
 
 ### **Change tracking**

input/pagecontent/l3_conceptmaps.md

@@ -15,8 +15,8 @@ ConceptMap resources are created to provide a mapping from the codes of one syst
 ### **Criteria / Definition of Done:**
 
 * A ConceptMap exists for each target code system identifier in the data dictionary terminology mappings
-* ConceptMaps SHALL conform to [CRMIShareableConceptMap]({{site.data.fhir.ver.crmi}}/StructureDefinition-crmi-shareableconceptmap.html)
-* Active, published ConceptMaps SHALL conform to [CRMIPublishableConceptMap]({{site.data.fhir.ver.crmi}}/StructureDefinition-crmi-publishableconceptmap.html)
+* ConceptMaps SHALL conform to [CRMIShareableConceptMap](https://hl7.org/fhir/uv/crmi/StructureDefinition-crmi-shareableconceptmap.html)
+* Active, published ConceptMaps SHALL conform to [CRMIPublishableConceptMap](https://hl7.org/fhir/uv/crmi/StructureDefinition-crmi-publishableconceptmap.html)
 
 ### **Change tracking**
 

input/pagecontent/l3_cql.md

@@ -1,5 +1,5 @@
 
-CQL - [Clinical Query Language](https://cql.hl7.org/) is a way to computably express queries and logic for the inputs and outputs of decision support - [decision logic](l3_decisiontables.html) and [scheduling logic](l3_schedulinglogic.html) - as well as [indicators](l3_indicators.html). 
+CQL - [Clinical Query Language](https://cql.hl7.org/) is a way to computably express queries and logic for the inputs and outputs of decision support - [decision logic](l3_decisiontables.html) - as well as [indicators](l3_indicators.html). 
 
 For background and introduction to CQL, refer to the [Getting Started](https://github.com/cqframework/CQL-Formatting-and-Usage-Wiki/wiki/Getting-Started) page of the CQFramework wiki.
 

input/pagecontent/l3_decisiontables.md

@@ -247,10 +247,10 @@ Which in turn makes use of the `EncounterElements` library.
 * Every parameter in the decision table should be in the data dictionary
 * An example instance of the outcome of the PlanDefinition (CarePlan) shall be authored as reference/test.
 * The PlanDefinition should be testable with the standard tools and should produce the same results as the  test CarePlan that is authored in the L3.
-* PlanDefinitions SHALL conform to [CRMIShareablePlanDefinition]({{site.data.fhir.ver.crmi}}/StructureDefinition-crmi-shareableplandefinition.html)
-* Active, published PlanDefinitions SHALL conform to [CRMIPublishablePlanDefinition]({{site.data.fhir.ver.crmi}}/StructureDefinition-crmi-publishableplandefinition.html)
-* PlanDefinitions representing decision tables SHALL conform to [CPGRecommendationDefinition]({{site.data.fhir.ver.cpg}}/StructureDefinition-cpg-recommendationdefinition.html)
-* PlanDefinitions representing strategies SHALL conform to [CPGStrategyDefinition]({{site.data.fhir.ver.cpg}}/StructureDefinition-cpg-strategydefinition.html)
+* PlanDefinitions SHALL conform to [CRMIShareablePlanDefinition](https://hl7.org/fhir/uv/crmi/StructureDefinition-crmi-shareableplandefinition.html)
+* Active, published PlanDefinitions SHALL conform to [CRMIPublishablePlanDefinition](https://hl7.org/fhir/uv/crmi/StructureDefinition-crmi-publishableplandefinition.html)
+* PlanDefinitions representing decision tables SHALL conform to [CPGRecommendationDefinition](https://build.fhir.org/ig/HL7/cqf-recommendations/StructureDefinition-cpg-recommendationdefinition.html)
+* PlanDefinitions representing strategies SHALL conform to [CPGStrategyDefinition](https://build.fhir.org/ig/HL7/cqf-recommendations/StructureDefinition-cpg-strategydefinition.html)
 
 ### **Change tracking**
 

input/pagecontent/l3_forms.md

@@ -64,11 +64,11 @@ StructureMap authoring requires tooling for validation. Please see the tooling s
 * Example instances of the QuestionnaireResponses, the corresponding Logical Model instance and the FHIR resources are available (the latter should actually be obtained by running the data extraction).
 * No QA errors in the build
 * Confirmation that extraction is working with the reference extraction tool.
-* Questionnaires SHALL conform to [CRMIShareableQuestionnaire]({{site.data.fhir.ver.crmi}}/StructureDefinition-crmi-shareablequestionnaire.html)
-* Active, published Questionnaires SHALL conform to [CRMIPublishableQuestionnaire]({{site.data.fhir.ver.crmi}}/StructureDefinition-crmi-publishablequestionnaire.html)
-* Questionnaires SHALL conform to [CPGComputableQuestionnaire]({{site.data.fhir.ver.cpg}}/StructureDefinition-cpg-computablequestionnaire.html)
-* Questionnaires SHALL conform to [SDCBaseQuestionnaire]({{site.data.fhir.ver.sdc}}/StructureDefinition-sdc-questionnaire.html)
-* Questionnaires SHOULD conform to other [SDC Questionnaire Profiles]({{site.data.fhir.ver.sdc}}/artifacts.html#structures-resource-profiles) if they support other rendering and questionnaire behavior described by SDC.
+* Questionnaires SHALL conform to [CRMIShareableQuestionnaire](https://hl7.org/fhir/uv/crmi/StructureDefinition-crmi-shareablequestionnaire.html)
+* Active, published Questionnaires SHALL conform to [CRMIPublishableQuestionnaire](https://hl7.org/fhir/uv/crmi/StructureDefinition-crmi-publishablequestionnaire.html)
+* Questionnaires SHALL conform to [CPGComputableQuestionnaire](https://build.fhir.org/ig/HL7/cqf-recommendations/StructureDefinition-cpg-computablequestionnaire.html)
+* Questionnaires SHALL conform to [SDCBaseQuestionnaire](https://hl7.org/fhir/uv/sdc/STU3/StructureDefinition-sdc-questionnaire.html)
+* Questionnaires SHOULD conform to other [SDC Questionnaire Profiles](https://hl7.org/fhir/uv/sdc/STU3/artifacts.html#structures-resource-profiles) if they support other rendering and questionnaire behavior described by SDC.
 
 
 ### **Change tracking**