FDNS HL7 Utilities Microservice
This is the repository with the HL7 utilities service to parse, validate and generate sample HL7 data.
Carefully read the following instructions for information on how to build, run, and test this microservice in your local environment.
Before you start
You will need to have the following installed before getting up and running locally:
- Docker, Installation guides
- Docker Compose, Installation guides
- Windows Users: This project uses
Make. Please use Cygwin or the Windows Subsystem for Linux for running the commands in this README
First, you'll need to build the image. You can build the image by running the following command:
Once the image has been built, you can run it with the following command:
To check if the microservice is running, open the following URL in your browser:
To access the Swagger documentation, open the following URL in your browser:
This microservice is designed to be used with other microservices. Please look at the docker-compose file for more information.
OBJECT_URL: This is a configurable environment variable to point to where the Object Microservice is running.
OAuth 2 Configuration
This microservice is configurable so that it can be secured via an OAuth 2 provider.
Scopes: This application uses the following scope:
Please see the following environment variables for configuring with your OAuth 2 provider:
OAUTH2_ACCESS_TOKEN_URI: This is the introspection URL of your provider, ex:
OAUTH2_PROTECTED_URIS: This is a path for which routes are to be restricted, ex:
OAUTH2_CLIENT_ID: This is your OAuth 2 client id with the provider
OAUTH2_CLIENT_SECRET: This is your OAuth 2 client secret with the provider
SSL_VERIFYING_DISABLE: This is an option to disable SSL verification, you can disable this when testing locally but this should be set to
falsefor all production systems
Here are other various configurations and their purposes:
HL7_UTILS_PORT: This is a configurable port the application is set to run on
HL7_UTILS_FLUENTD_HOST: This is the host of your Fluentd
HL7_UTILS_FLUENTD_PORT: This is the port of your Fluentd
HL7_UTILS_PROXY_HOSTNAME: This is the hostname of your environment for use with Swagger UI, ex:
This repository constitutes a work of the United States Government and is not subject to domestic copyright protection under 17 USC § 105. This repository 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 repository will be released under the CC0 dedication. By submitting a pull request you are agreeing to comply with this waiver of copyright interest.
The repository utilizes code licensed under the terms of the Apache Software License and therefore is licensed under ASL v2 or later.
The source code in this repository is free: 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.
The source code in this repository 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 https://www.apache.org/licenses/LICENSE-2.0.html
The source code forked from other open source projects will inherit its license.
Anyone is encouraged to contribute to the repository 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 https://www.cdc.gov/other/privacy.html.
This repository 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.