Repository for the development of the Concept Dictionary Manager to support the SDP Vocabulary Service at https://github.com/CDCgov/SDP-Vocabulary-Service
To run this service locally, be sure to have the latest version of Go installed. Downloads are available here.
Then, clone this repository to your local system, or run go get github.com/CDCgov/concept-dictionary-manager to download the source to your $GOPATH.
Navigate to the directory of this repository, and run go build to build a binary version of the service and then run ./concept-dictionary-manager to start the service.
The concept dictionary manager requires an elasticsearch instance loaded with codes using the phinvads sync utility found here. In order to use the service api to search the codes in elasticsearch, you will need to have that running and populated as well.
Running locally, it is advised to set a $PORT environment variable to run this service on a different port to avoid port conflicts.
To get a list of the available dictionary services, open a browser and navigate to http://localhost:8085/systems (if you are running on port 8085).
To search the codes within the test system, navigate to http://localhost:8085/concepts?system={codeSystem}&search={string}, replacing {string} with a string you'd like to search for and {codeSystem} with the oid of the code system you would like to search. The value in the query string that populates codeSystem is resolved from the JSON you recieved from the /systems route.
To run this service in an OpenShift cluster, use a go source-to-image builder (see here for an example).
Point the source-to-image builder at this repository's URL on github.
Deploy whichever deployment and configuration of elasticsearch suits your needs.
Edit the deployment of this service to include the following environment variable:
ELASTIC_SEARCH_HOST - the hostname or IP address where elasticsearch is accessible. Include ports in this variable if necessary.
Once OpenShift redeploys this build, the service should be running and have access to elasticsearch.
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.
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
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.
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.
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
Please refer to CDC's Template Repository for more information about contributing to this repository, public domain notices and disclaimers, and code of conduct.