From 6171e1774eaa5ec29add2db4a8ef111e4e20327c Mon Sep 17 00:00:00 2001 From: Jose Costa Teixeira Date: Tue, 3 Sep 2024 09:39:29 +0200 Subject: [PATCH] add md content --- LICENSE.md | 47 ++++++++++++------ README.md | 14 +++--- input/pagecontent/feedback.md | 10 ++++ input/pagecontent/index-dak.md | 59 ++++++++++++++++++++++ input/pagecontent/index-ig.md | 47 ++++++++++++++++++ input/pagecontent/index.md | 50 ++----------------- input/pagecontent/license.md | 62 +++++++++++++----------- input/pagecontent/system-requirements.md | 6 +++ 8 files changed, 199 insertions(+), 96 deletions(-) create mode 100644 input/pagecontent/feedback.md create mode 100644 input/pagecontent/index-dak.md create mode 100644 input/pagecontent/index-ig.md create mode 100644 input/pagecontent/system-requirements.md diff --git a/LICENSE.md b/LICENSE.md index 902b41d..e0bc849 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,25 +1,44 @@ -# Creative Commons Attribution 3.0 IGO (CC-BY-3.0-IGO) +
-## Summary +

SMART Guidelines, including this one, are required to express the license their copyright license.

+

All WHO-authored SMART Guidelines shall be subject to the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 IGO License. This includes all commons and dependencies authored by the WHO and this current guidance.

-This is a human-readable summary of the [Creative Commons Attribution 3.0 IGO (CC-BY-3.0-IGO) License](https://creativecommons.org/licenses/by/3.0/igo/). This summary is not a substitute for the full license text. +

SMART Guidelines license details

-Under this license, you are free to: +Creative Commons License -- Share: Copy and redistribute the material in any medium or format. -- Adapt: Remix, transform, and build upon the material for any purpose, even commercially. +

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 IGO License.

-Under the following conditions: +

Copyright(c) 2022 World Health Organization Some rights reserved.

-- Attribution: You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use. +

+Under the terms of this licence, you may copy, redistribute and adapt the work for noncommercial purposes provided the work +is appropriately cited, as indicated below. In any use of this work, there should be no suggestion that WHO endorses any specific +organizations, products or services. The use of the WHO logo is not permitted. If you adapt the work, then you must license your +work under the same or equivalent Creative Commons licence. If you create a translation of this work, you should add the following +disclaimer along with the suggested citation: "This translation was not created by the World Health Organization (WHO). WHO is not +responsible for the content or accuracy of this translation. The original English edition shall be the binding and authentic edition." +Any mediation relating to disputes arising under the licence shall be conducted in accordance with the mediation rules of the World +Intellectual Property Organization. (http://www.wipo.int/amc/en/mediation/rules/). +

-- No Additional Restrictions: You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits. +

License details for Software

-- International Government Organizations (IGOs): This license is specifically designed for works created by International Government Organizations. +

Copyright(c) 2022 World Health Organization All rights reserved.

-## License Text +

3-clause BSD license

+

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

+
    +
  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
    2. -This work is licensed under the [Creative Commons Attribution 3.0 IGO (CC-BY-3.0-IGO) License](https://creativecommons.org/licenses/by/3.0/igo/). - -To view a copy of this license, visit [https://creativecommons.org/licenses/by/3.0/igo/](https://creativecommons.org/licenses/by/3.0/igo/) or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA. +
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
    3. +
  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
    4. +
+

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +

+
diff --git a/README.md b/README.md index f2a24b8..0669998 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ + [![License: CC BY-IGO 3.0](https://licensebuttons.net/l/by-nc/3.0/igo/80x15.png)](https://creativecommons.org/licenses/by/3.0/igo) -![CI Build](https://img.shields.io/github/actions/workflow/status/DigitalSQR/smart-ig-empty/ghbuild.yml) +![CI Build](https://img.shields.io/github/actions/workflow/status/WorldHealthOrganization/smart-ig-empty/ghbuild.yml) - -![QA errors](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fworldhealthorganization.github.io%2Fsmart-ig-empty%2Fqa.json&query=%24.errs&logoColor=red&label=QA%20errors&color=yellow) -![QA warnings](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fworldhealthorganization.github.io%2Fsmart-ig-empty%2Fqa.json&query=%24.warnings&logoColor=orange&label=QA%20warnings&color=yellow) -![QA hints](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fworldhealthorganization.github.io%2Fsmart-ig-empty%2Fqa.json&query=%24.hints&logoColor=yellow&label=QA%20hints&color=yellow) - +![QA errors](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2FWorldHealthOrganization.github.io%2Fsmart-ig-empty%2Fqa.json&query=%24.errs&logoColor=red&label=QA%20errors&color=yellow) +![QA warnings](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2FWorldHealthOrganization.github.io%2Fsmart-ig-empty%2Fqa.json&query=%24.warnings&logoColor=orange&label=QA%20warnings&color=yellow) +![QA hints](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2FWorldHealthOrganization.github.io%2Fsmart-ig-empty%2Fqa.json&query=%24.hints&logoColor=yellow&label=QA%20hints&color=yellow) + # WHO SMART GUIDELINES - EMPTY IG This is an empty framework, to be used to create SMART Implementation Guides. -This framework is published under a Creative Commons - IGO [license](LICENSE.md). ## Changes and feedback Feedback and issues about this empty framework can be submitted via the [issues](issues) page, and will be incorporated into subsequent releases. + diff --git a/input/pagecontent/feedback.md b/input/pagecontent/feedback.md new file mode 100644 index 0000000..0b2f770 --- /dev/null +++ b/input/pagecontent/feedback.md @@ -0,0 +1,10 @@ + +

+ Feedback specific to this specification can provided through: +

+ + diff --git a/input/pagecontent/index-dak.md b/input/pagecontent/index-dak.md new file mode 100644 index 0000000..dbc9fee --- /dev/null +++ b/input/pagecontent/index-dak.md @@ -0,0 +1,59 @@ + +
+

This DAK and set of implementation tools are still undergoing development.

+

Content is for demonstration purposes only.

+
{:.stu-note} + + +### Summary +This WHO [insert health domain here] DAK add content here + +### L1 Narrative guidelines +[insert content here] + +### L2 Operational guidelines +The L2 [insert health domain here] Digital adaptation kit publications and implementations tools can be found here: + + +- [Published DAK Document]() + +- [Link to core data dictionary]() + +- [Link to decision support logic]() + +- [Link to scheduling logic]() + +- [Link to indicators table]() + +- [Link to functional and non functional requirements]() + +### L3 Machine readable guidelines +The L3 FHIR Implementation Guide for the [insert health domain here] SMART Guidelines is yet to be published. Links will be published here as soon as they're available. + +### L4 Executable guidelines +Reference implementations representing the L4 layer for the [insert health domain here] SMART Guidelines are not yet available. Links will be published here as soon as they're available. + +### L5 Dynamic guidelines +Content representing the L5 layer for the [insert health domain here] SMART Guidelines are not yet available. Links will be published here as soon as they're available. + +### News + +### Contact Us +

Please let us know about your experience in using the DAK and questions you may have by contacting us at SMART@who.int

+ +### License +This work is licensed under a +[Creative Commons Attribution-NonCommercial-ShareAlike 3.0 IGO License][cc-by]. + +[![CC BY 3.0][cc-by-image]][cc-by] + +[cc-by]: http://creativecommons.org/licenses/by-nc-sa/3.0/igo/ +[cc-by-image]: https://i.creativecommons.org/l/by-nc-sa/3.0/igo/88x31.png +[cc-by-shield]: https://img.shields.io/badge/License-CC%20BY%203.0-lightgrey.svg + +### Providing Feedback +{% include feedback.md %} + + +### Disclaimer +The specification herewith documented is a demo working specification and may not be used for any implementation purposes. This draft is provided without warranty of completeness or consistency and the official publication supersedes this draft. No liability can be inferred from the use or misuse of this specification or its consequences. \ No newline at end of file diff --git a/input/pagecontent/index-ig.md b/input/pagecontent/index-ig.md new file mode 100644 index 0000000..d0e4e5f --- /dev/null +++ b/input/pagecontent/index-ig.md @@ -0,0 +1,47 @@ +This WHO [insert health domain here] Implementation Guide details how to use Health Level 7 (HL7) Fast Healthcare Interoperability Resources (FHIR) for consistent digital representation of [insert health domain here] services. + +
+

This implementation guide and set of artifacts are still undergoing development.

+

Content is for demonstration purposes only.

+
{:.stu-note} + + +### Summary +This implementation guide includes a machine-readable representation of WHO guidelines for [insert health domain here], as documented in the WHO Digital Adaptation Kit for [insert health domain here] (link forthcoming) and explicitly encodes computer-interoperable logic, including data models, terminologies, and logic expressions, in a computable language to support implementation of [insert health domain here] use cases by WHO Member States. + +The guide is part of the [WHO SMART Guidelines approach](https://www.who.int/teams/digital-health-and-innovation/smart-guidelines) to support countries to integrate WHO global health and data recommendations into digital systems accurately and consistently. It defines a series of FHIR Resources, Profiles, Extensions, and Terminology based on the WHO [insert health domain here] Digital Adaptation Kit (link forthcoming). + +Supporting guidance, recommendations, resources, and standards are included in the References and Dependencies. + +### About this implementation guide + +This implementation guide is broken into the following levels of [knowledge representation](https://hl7.org/fhir/uv/cpg/documentation-approach-06-01-levels-of-knowledge-representation.html): +- Home - contains references to the guidance, guidelines, policies and recommendations underpinning this implementation guide. +- Business Requirements - contains the requirements for this implementation guide including the definition of key concepts, use cases, and a data dictionary. +- Data Models and Exchange - contains the data models and data exchange protocols with actors and transactions defined. +- Deployment Guidance - contains relevant technical specifications and guidance, testing resources, reference implementation materials, and supporting guidance for adaptation to local contexts. + +This guide is prepared to facilitate digital implementation of WHO [insert health domain here] guidelines by providing FHIR-based computable representations of and implementation guidance for using the key components of the WHO [insert health domain here] digital adaptation kit (DAK): + +* Health Interventions & Recommendations +* Generic Personas +* User Scenarios +* Business Processes & Workflows +* Core Data Elements +* Decision Support Logic +* Indicators & Monitoring +* Functional & Non-functional Requirements + +This guide is a companion to the Digital Adaptation Kit (DAK) and should be used side-by-side with it. Implementers are strongly encouraged to make use of the Digital Adaptation Kit. The focus of this guide is on the explanation and use of the computable artifacts. + +This guide assumes use of the following resources: +* [IPS Patient](http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips) +* [CPG ActivityDefinitions](https://hl7.org/fhir/uv/cpg/artifacts.html#activitydefinition-index) + +- For a complete listing of the artifacts defined in this implementation guide, refer to the [Artifact Index](artifacts.html). +- A complete offline copy of this implementation guide can be found on the [Downloads](downloads.html) page. + +- This Implementation Guide makes use of [Clinical Quality Language](https://cql.hl7.org/) for the decision support artifacts including the PlanDefinitions and Measures. They are used to express how a calculation should occur and can be used with a CQL engine in order to process the decision or indicator directly from the applicable FHIR resources. Links to this specification, the FHIR Clinical Practice Guidelines Speciciation, and other helpful resources can be found in the Support dropdown. + +### Disclaimer +The specification herewith documented is a demo working specification and may not be used for any implementation purposes. This draft is provided without warranty of completeness or consistency and the official publication supersedes this draft. No liability can be inferred from the use or misuse of this specification or its consequences. diff --git a/input/pagecontent/index.md b/input/pagecontent/index.md index d0e4e5f..1b5d291 100644 --- a/input/pagecontent/index.md +++ b/input/pagecontent/index.md @@ -1,47 +1,5 @@ -This WHO [insert health domain here] Implementation Guide details how to use Health Level 7 (HL7) Fast Healthcare Interoperability Resources (FHIR) for consistent digital representation of [insert health domain here] services. + +{% include index-dak.md %} -
-

This implementation guide and set of artifacts are still undergoing development.

-

Content is for demonstration purposes only.

-
{:.stu-note} - - -### Summary -This implementation guide includes a machine-readable representation of WHO guidelines for [insert health domain here], as documented in the WHO Digital Adaptation Kit for [insert health domain here] (link forthcoming) and explicitly encodes computer-interoperable logic, including data models, terminologies, and logic expressions, in a computable language to support implementation of [insert health domain here] use cases by WHO Member States. - -The guide is part of the [WHO SMART Guidelines approach](https://www.who.int/teams/digital-health-and-innovation/smart-guidelines) to support countries to integrate WHO global health and data recommendations into digital systems accurately and consistently. It defines a series of FHIR Resources, Profiles, Extensions, and Terminology based on the WHO [insert health domain here] Digital Adaptation Kit (link forthcoming). - -Supporting guidance, recommendations, resources, and standards are included in the References and Dependencies. - -### About this implementation guide - -This implementation guide is broken into the following levels of [knowledge representation](https://hl7.org/fhir/uv/cpg/documentation-approach-06-01-levels-of-knowledge-representation.html): -- Home - contains references to the guidance, guidelines, policies and recommendations underpinning this implementation guide. -- Business Requirements - contains the requirements for this implementation guide including the definition of key concepts, use cases, and a data dictionary. -- Data Models and Exchange - contains the data models and data exchange protocols with actors and transactions defined. -- Deployment Guidance - contains relevant technical specifications and guidance, testing resources, reference implementation materials, and supporting guidance for adaptation to local contexts. - -This guide is prepared to facilitate digital implementation of WHO [insert health domain here] guidelines by providing FHIR-based computable representations of and implementation guidance for using the key components of the WHO [insert health domain here] digital adaptation kit (DAK): - -* Health Interventions & Recommendations -* Generic Personas -* User Scenarios -* Business Processes & Workflows -* Core Data Elements -* Decision Support Logic -* Indicators & Monitoring -* Functional & Non-functional Requirements - -This guide is a companion to the Digital Adaptation Kit (DAK) and should be used side-by-side with it. Implementers are strongly encouraged to make use of the Digital Adaptation Kit. The focus of this guide is on the explanation and use of the computable artifacts. - -This guide assumes use of the following resources: -* [IPS Patient](http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips) -* [CPG ActivityDefinitions](https://hl7.org/fhir/uv/cpg/artifacts.html#activitydefinition-index) - -- For a complete listing of the artifacts defined in this implementation guide, refer to the [Artifact Index](artifacts.html). -- A complete offline copy of this implementation guide can be found on the [Downloads](downloads.html) page. - -- This Implementation Guide makes use of [Clinical Quality Language](https://cql.hl7.org/) for the decision support artifacts including the PlanDefinitions and Measures. They are used to express how a calculation should occur and can be used with a CQL engine in order to process the decision or indicator directly from the applicable FHIR resources. Links to this specification, the FHIR Clinical Practice Guidelines Speciciation, and other helpful resources can be found in the Support dropdown. - -### Disclaimer -The specification herewith documented is a demo working specification and may not be used for any implementation purposes. This draft is provided without warranty of completeness or consistency and the official publication supersedes this draft. No liability can be inferred from the use or misuse of this specification or its consequences. + +{% include index-ig.md %} \ No newline at end of file diff --git a/input/pagecontent/license.md b/input/pagecontent/license.md index ca1cc90..e0bc849 100644 --- a/input/pagecontent/license.md +++ b/input/pagecontent/license.md @@ -1,40 +1,44 @@ ---- +
---- +

SMART Guidelines, including this one, are required to express the license their copyright license.

+

All WHO-authored SMART Guidelines shall be subject to the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 IGO License. This includes all commons and dependencies authored by the WHO and this current guidance.

-Creative Commons Attribution 3.0 IGO license (CC BY 3.0 IGO) +

SMART Guidelines license details

-You are free to: +Creative Commons License -**Share** — copy and redistribute the material in any medium or format +

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 IGO License.

-**Adapt** — remix, transform, and build upon the material for any purpose, even commercially. +

Copyright(c) 2022 World Health Organization Some rights reserved.

-This license is acceptable for Free Cultural Works. +

+Under the terms of this licence, you may copy, redistribute and adapt the work for noncommercial purposes provided the work +is appropriately cited, as indicated below. In any use of this work, there should be no suggestion that WHO endorses any specific +organizations, products or services. The use of the WHO logo is not permitted. If you adapt the work, then you must license your +work under the same or equivalent Creative Commons licence. If you create a translation of this work, you should add the following +disclaimer along with the suggested citation: "This translation was not created by the World Health Organization (WHO). WHO is not +responsible for the content or accuracy of this translation. The original English edition shall be the binding and authentic edition." +Any mediation relating to disputes arising under the licence shall be conducted in accordance with the mediation rules of the World +Intellectual Property Organization. (http://www.wipo.int/amc/en/mediation/rules/). +

-The licensor cannot revoke these freedoms as long as you follow the license terms. +

License details for Software

-Under the following terms: +

Copyright(c) 2022 World Health Organization All rights reserved.

-**Attribution** — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use. +

3-clause BSD license

+

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

+
    +
  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
    2. -**No additional restrictions** — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits. - -Notices: - -You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation. - -No warranties are given. The license may not give you all the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material. - -This is a human-readable summary of (and not a substitute for) the [license](https://creativecommons.org/licenses/by/3.0/igo/). - -Disclaimer - -The designations employed and the presentation of material on this map do not imply the expression of any opinion whatsoever on the part of Creative Commons or its partner organizations concerning the legal status of any country, territory, city or area or of its authorities, or concerning the delimitation of its frontiers or boundaries. - -This work is licensed under the Creative Commons Attribution 3.0 IGO license (CC BY 3.0 IGO) - -To view a copy of this license, visit [https://creativecommons.org/licenses/by/3.0/igo/](https://creativecommons.org/licenses/by/3.0/igo/) - -© 2023 Your Organization Name +
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
    3. +
  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
    4. +
+

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +

+
diff --git a/input/pagecontent/system-requirements.md b/input/pagecontent/system-requirements.md new file mode 100644 index 0000000..c7dc616 --- /dev/null +++ b/input/pagecontent/system-requirements.md @@ -0,0 +1,6 @@ +### Functional Requirements +{% include functional-requirements.md %} + + +### Non-functional Requirements +{% include non-functional-requirements.md %} \ No newline at end of file