Skip to content

Commit

Permalink
Reset to be based on the SOPs and cleanout legacy files. Will copy th…
Browse files Browse the repository at this point in the history
…em back in on a case by case basis to ensure alignment with the SOPs.
  • Loading branch information
lukeaduncan committed Dec 6, 2024
1 parent 95f54ab commit ed2cdea
Show file tree
Hide file tree
Showing 1,299 changed files with 739 additions and 95,247 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/fhirbuild.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# This workflow reuses the openHIE GitHub action for building IGs
# Initial idea by Carl Leitner, developed by Elliot Silver, available from: https://www.argentixinfo.com/archives/156
# Change log:
# v0.1.0
# 2021-06-18: publish default branches to / , other branches branches/<branch>
# 2021-11-26: reusable workflow

name: FHIR CI Build

# Controls when the action will run.
on:
# Triggers the workflow on push or pull request events for any main branch
push:
branches-ignore:
- 'gh-pages'
pull_request:

workflow_dispatch:

jobs:
# This workflow contains a single job called "build"
call_build:
uses: WorldHealthOrganization/smart-base/.github/workflows/fhirbuild.yml@main
23 changes: 23 additions & 0 deletions .github/workflows/ghbuild.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# This workflow reuses the openHIE GitHub action for building IGs
# Initial idea by Carl Leitner, developed by Elliot Silver, available from: https://www.argentixinfo.com/archives/156
# Change log:
# v0.1.0
# 2021-06-18: publish default branches to / , other branches branches/<branch>
# 2021-11-26: reusable workflow

name: GitHub Pages build

# Controls when the action will run.
on:
# Triggers the workflow on push or pull request events for any main branch
push:
branches-ignore:
- 'gh-pages'
pull_request:

workflow_dispatch:

jobs:
# This workflow contains a single job called "build"
call_build:
uses: WorldHealthOrganization/smart-base/.github/workflows/ghbuild.yml@main
35 changes: 35 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# This workflow calls a remote workflow for setting up a release publication,
# This workflow is triggered by the creation of a GitHub release and requires a file called publication-request.json in the branch.

name: Release build

on:
release:
types: [created]
workflow_dispatch:

jobs:
check:
runs-on: ubuntu-latest
outputs:
file_exists: ${{ steps.checkfile.outputs.exists }}
steps:
- name: Checkout code
uses: actions/checkout@v3
with:
ref: ${{ github.event.release.tag_name }}

- name: Check for publication-request.json
id: checkfile
run: |
if [[ -f "publication-request.json" ]]; then
echo "::set-output name=exists::true"
else
echo "::set-output name=exists::false"
fi
trigger:
needs: check
if: needs.check.outputs.file_exists == 'true'
uses: WorldHealthOrganization/smart-html/.github/workflows/release.yml@main

20 changes: 20 additions & 0 deletions .github/workflows/repo_actions.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# This workflow uses a remote action to do some repository actions like updating the readme files

name: Call remote repo actions

# Controls when the action will run.
on:
# Triggers the workflow on push or pull request events for any main branch
push:
branches-ignore:
- 'gh-pages'
pull_request:

workflow_dispatch:

jobs:
call-update-readme:
uses: WorldHealthOrganization/smart-base/.github/workflows/update_readme.yml@main
with:
repositoryOwner: ${{ github.repository_owner }}
repositoryName: ${{ github.event.repository.name }}
57 changes: 34 additions & 23 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,44 @@
> CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER.
<div xmlns="http://www.w3.org/1999/xhtml"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://hl7.org/fhir ../../src-generated/schemas/fhir-single.xsd"
xmlns:xi="http://www.w3.org/2001/XInclude"
lang="en">

<p>SMART Guidelines, including this one, are required to express the license their copyright license.</p>
<p>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.<p>

----------
<h3>SMART Guidelines license details</h3>

<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/3.0/igo/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/3.0/igo/88x31.png"/></a>

### <em>Statement of Purpose</em>
The laws of most jurisdictions throughout the world automatically confer exclusive Copyright and Related Rights (defined below) upon the creator and subsequent owner(s) (each and all, an "owner") of an original work of authorship and/or a database (each, a "Work").
<p>This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/3.0/igo/">Creative Commons Attribution-NonCommercial-ShareAlike 3.0 IGO License</a>.</p>

Certain owners wish to permanently relinquish those rights to a Work for the purpose of contributing to a commons of creative, cultural and scientific works ("Commons") that the public can reliably and without fear of later claims of infringement build upon, modify, incorporate in other works, reuse and redistribute as freely as possible in any form whatsoever and for any purposes, including without limitation commercial purposes. These owners may contribute to the Commons to promote the ideal of a free culture and the further production of creative, cultural and scientific works, or to gain reputation or greater distribution for their Work in part through the use and efforts of others.
<p>Copyright(c) 2022 World Health Organization Some rights reserved.</p>

For these and/or other purposes and motivations, and without any expectation of additional consideration or compensation, the person associating CC0 with a Work (the "Affirmer"), to the extent that he or she is an owner of Copyright and Related Rights in the Work, voluntarily elects to apply CC0 to the Work and publicly distribute the Work under its terms, with knowledge of his or her Copyright and Related Rights in the Work and the meaning and intended legal effect of CC0 on those rights.
<p>
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/).
</p>

**1. Copyright and Related Rights**. A Work made available under CC0 may be protected by copyright and related or neighboring rights ("Copyright and Related Rights"). Copyright and Related Rights include, but are not limited to, the following:
<ol type="i"><li>the right to reproduce, adapt, distribute, perform, display, communicate, and translate a Work; </li>
<li>moral rights retained by the original author(s) and/or performer(s); </li>
<li>publicity and privacy rights pertaining to a person's image or likeness depicted in a Work;</li>
<li>rights protecting against unfair competition in regards to a Work, subject to the limitations in paragraph 4(a), below;</li>
<li>rights protecting the extraction, dissemination, use and reuse of data in a Work;</li>
<li>database rights (such as those arising under Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, and under any national implementation thereof, including any amended or successor version of such directive); and </li>
<li>other similar, equivalent or corresponding rights throughout the world based on applicable law or treaty, and any national implementations thereof.</li>
</ol>
<h3>License details for Software</h3>

<p>Copyright(c) 2022 World Health Organization All rights reserved.</p>

**2. Waiver**. To the greatest extent permitted by, but not in contravention of, applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and unconditionally waives, abandons, and surrenders all of Affirmer's Copyright and Related Rights and associated claims and causes of action, whether now known or unknown (including existing as well as future claims and causes of action), in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each member of the public at large and to the detriment of Affirmer's heirs and successors, fully intending that such Waiver shall not be subject to revocation, rescission, cancellation, termination, or any other legal or equitable action to disrupt the quiet enjoyment of the Work by the public as contemplated by Affirmer's express Statement of Purpose.
<p><a href ="https://opensource.org/license/bsd-3-clause/">3-clause BSD license</a></p>
<p>Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:</p>
<ol>
<li>Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.</li>

**3. Public License Fallback**. Should any part of the Waiver for any reason be judged legally invalid or ineffective under applicable law, then the Waiver shall be preserved to the maximum extent permitted taking into account Affirmer's express Statement of Purpose. In addition, to the extent the Waiver is so judged Affirmer hereby grants to each affected person a royalty-free, non transferable, non sublicensable, non exclusive, irrevocable and unconditional license to exercise Affirmer's Copyright and Related Rights in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "License"). The License shall be deemed effective as of the date CC0 was applied by Affirmer to the Work. Should any part of the License for any reason be judged legally invalid or ineffective under applicable law, such partial invalidity or ineffectiveness shall not invalidate the remainder of the License, and in such case Affirmer hereby affirms that he or she will not (i) exercise any of his or her remaining Copyright and Related Rights in the Work or (ii) assert any associated claims and causes of action with respect to the Work, in either case contrary to Affirmer's express Statement of Purpose.
<li>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.</li>

**4. Limitations and Disclaimers**.
<ol type="a"><li>No trademark or patent rights held by Affirmer are waived, abandoned, surrendered, licensed or otherwise affected by this document</li>
<li>Affirmer offers the Work as-is and makes no representations or warranties of any kind concerning the Work, express, implied, statutory or otherwise, including without limitation warranties of title, merchantability, fitness for a particular purpose, non infringement, or the absence of latent or other defects, accuracy, or the present or absence of errors, whether or not discoverable, all to the greatest extent permissible under applicable law.</li>
<li> Affirmer disclaims responsibility for clearing rights of other persons that may apply to the Work or any use thereof, including without limitation any person's Copyright and Related Rights in the Work. Further, Affirmer disclaims responsibility for obtaining any necessary consents, permissions or other rights required for any use of the Work.</li>
<li>Affirmer understands and acknowledges that Creative Commons is not a party to this document and has no duty or obligation with respect to this CC0 or use of the Work.</li>
</ol>
<li>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.</li>
</ol>
<p>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.
</p>
</div>
81 changes: 12 additions & 69 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,75 +1,18 @@
# WHO Immunization Implementation Guide (FHIR R4 (4.0.1))
<!--badges-->
[![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/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)
<!--/badges-->

This implementation guide defines core data element profiles for use for the World Health Organization (WHO) Immunization computable guideline content.
# WHO SMART GUIDELINES - EMPTY IG

The current draft of the implementation guide is available [here](https://build.fhir.org/ig/WorldHealthOrganization/smart-immunizations/branches/main).
This is an empty framework, to be used to create SMART Implementation Guides.

The guide is published under a Creative Commons [license](LICENSE.md).

## Change Management
## Changes and feedback

Feedback and issues can be submitted via the [issues](issues) page, and will be incorporated into subsequent releases as time and resources allow.

## Roadmap
### Completed

* PlanDefinitions
* ActivityDefinitions
* Measures
* CQL libraries for Indicators
* CQL libraries for Decision Support

### ToDo

* Examples

## Repository and Build Information

This repository contains the source for the WHO Core Implementation Guide, and uses the [FHIR Implementation Guide publisher](http://wiki.hl7.org/index.php?title=IG_Publisher_Documentation) to produce a FHIR Implementation Guide.

Commits to this repository will automatically trigger a new build of the implementation guide, which will then be published to the following location:

[https://build.fhir.org/ig/WorldHealthOrganization/smart-immunizations/branches/main](https://build.fhir.org/ig/WorldHealthOrganization/smart-immunizations/branches/main)

Build log is available here:

[http://build.fhir.org.s3-website-us-east-1.amazonaws.com/logs/WorldHealthOrganization/smart-immunization](http://build.fhir.org.s3-website-us-east-1.amazonaws.com/logs/WorldHealthOrganization/smart-immunization)

Debugging information is available here:

[http://build.fhir.org/ig/WorldHealthOrganization/smart-immunization/debug.tgz](https://build.fhir.org/ig/WorldHealthOrganization/smart-immunizations/debug.tgz)

### Local Build

The HL7 IG Publisher can be downloaded locally to make building as easy as possible. To build locally, download the publisher tooling locally using the _updatePublisher script:

_updatePublisher

Once the publication tooling is cached locally, use the _genOnce script to build locally:

_genOnce

The output will be available in the `output` folder.

### Refreshing CQL

The CQF tooling can be installed or updated using the _updateCQFTooling script:

_updateCQFTooling

Once that has been updated the _refresh script can be used to generate the CQL Libraries and create test bundles for the applicable PlanDefinitions.

_refresh

### Organizing Tests

The tests were generated using [BulkFSH repo](https://github.com/PuraJuniper/bulk-fsh)).

Use the _testMagick.sh scrip to sort the tests into the appropriate folders to execute the CQL tests.

### Executing CQL Tests

Using a CQL plugin in Atom or [VSCode](https://github.com/PuraJuniper/bulk-fsh), right click on your CQL file and click "Execute Tests"

After running the _testMagick.sh script this should produce an output file with the results of how each CQL file executed against your test patients.
Feedback and issues about this empty framework can be submitted via the [issues](issues) page, and will be incorporated into subsequent releases.

32 changes: 0 additions & 32 deletions _autoPublish.bat

This file was deleted.

2 changes: 0 additions & 2 deletions _gencontinuous.bat

This file was deleted.

2 changes: 0 additions & 2 deletions _gencontinuous.sh

This file was deleted.

Empty file modified _genonce.sh
100755 → 100644
Empty file.
Loading

0 comments on commit ed2cdea

Please sign in to comment.