CDCgov/phinvads-sync-util

Name: phinvads-sync-util

Owner: Centers for Disease Control and Prevention Surveillance Strategy

Description: null

Created: 2017-04-10 19:54:12.0

Updated: 2017-07-12 19:52:40.0

Pushed: 2017-07-12 20:07:21.0

Homepage: null

Size: 324

Language: Ruby

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Repository Template

This Github organization was created for use by CDC programs to collaborate on public health surveillance related projects in support of the CDC Surveillance Strategy. This third party web application is not hosted by the CDC, but is used by CDC and its partners to share information and collaborate on software.

This repository serves as a template for other repositories to follow in order to provide the appropriate notices for users in regards to privacy protection, contribution, licensing, copyright, records management and collaboration.

Public Domain:

This project constitutes a work of the United States Government and is not subject to domestic copyright protection under 17 USC § 105. This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication. All contributions to this project will be released under the CC0 dedication. By submitting a pull request you are agreeing to comply with this waiver of copyright interest.

License

The project utilizes code licensed under the terms of the Apache Software License and therefore is licensed under ASL v2 or later.

This program is free software: you can redistribute it and/or modify it under the terms of the Apache Software License version 2, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Apache Software License for more details.

You should have received a copy of the Apache Software License along with this program. If not, see http://www.apache.org/licenses/LICENSE-2.0.html

Privacy

This project contains only non-sensitive, publicly available data and information. All material and community participation is covered by the Surveillance Platform Disclaimer and Code of Conduct. For more information about CDC's privacy policy, please visit http://www.cdc.gov/privacy.html.

Contributing

Anyone is encouraged to contribute to the project by forking and submitting a pull request. (If you are new to GitHub, you might start with a basic tutorial.) By contributing to this project, you grant a world-wide, royalty-free, perpetual, irrevocable, non-exclusive, transferable license to all users under the terms of the Apache Software License v2 or later.

All comments, messages, pull requests, and other submissions received through CDC including this GitHub page are subject to the Presidential Records Act and may be archived. Learn more at http://www.cdc.gov/other/privacy.html.

Records

This project is not a source of government records, but is a copy to increase collaboration and collaborative potential. All government records will be published through the CDC web site

Notices

Please refer to CDC's Template Repository for more information about contributing to this repository, public domain notices and disclaimers, and code of conduct.

Hat-tips

Thanks to 18F's open source policy and code of conduct that were very useful in setting up this GitHub organization. Thanks to CDC's Informatics Innovation Unit that was helpful in modeling the code of conduct.

Sync Utility

The software contained in this repository is used to sync the code systems and valuesets contained within PHIN VADS into an elasticsearch server.

Code Systems

Code systems are mapped into elastic search in 2 different indexes.

Code system meta data is contained in an index with the follwoing semantics.

/code_systems/code_system/{oid}

The codes for a given code system are mapped into elastic search in a separate index that allows for easy searching across code systems as well as scoping to individual code systems. The index is sturctured as follows.

Codes for individual code systems are added to the codes index scoped under the oid for the coded system that they come from. The codes are added individually and are not contained in any grouping structure. The {id} portion of the url described below is generated by Elasticsearch when a code is added to the index and is meaningless outside the context of elastic search

/codes/{oid}/{id}

Valuesets

Valuesets are synced into the elasticserach server as valueset versions. Within Phinvads the codes for a given valueset are mapped to versions of a given valueset. Keeping with that system the valuesets are mapped into elastic search as versions with the given url semantics

/valueset_versions/{oid}/{version_number}

Each of the versions is formated as a FHIR ValueSet object complete with the codes that they contain.

Building
package
Running

java -jar target/phinvads-sync-util.jar

ions]
-e, --elasticsearch  elastic search host
-v, --vads           PHINVADS api url
-o, --operation      operation to run (sync_all, sync_vs[:oid:version], sync_cs[:oid])
-f, --force          force reindex
Deploying on an Openshift cluster

This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.