Skip to main content

Official websites use .gov
A .gov website belongs to an official government organization in the United States.

Secure .gov websites use HTTPS
A lock ( ) or https:// means you’ve safely connected to the .gov website. Share sensitive information only on official, secure websites.

Application Programming Interface (API)

Introduction

RADx MARS offers an application programming interface (API) that developers can use to:

  1. Construct a MARS-compatible HL7v2 message
  2. Programmatically validate the message with the NIST validator [COMING SOON]
  3. Send the message to a RADx MARS data hub

The API abstracts away the need for developers to understand the intricacies of the MARS HL7v2 message structure and to develop custom code for constructing MARS HL7v2 messages.

Instructions

The RADx MARS API is available on the NIBIB GitHub site.

Enumerated repositories at the above link are as follows:

  • radx-mars-lib - The base library containing common code.
  • aims-mars-lib - The library to be used when communicating with the APHL AIMS hub.
  • reportstream-mars-lib - The library to be used when communicating with the CDC ReportStream hub.
  • radx-mars-demo - The library that shows how to use all of the above.  It also includes a "debug hub" and important documentation.

It is recommended that developers begin with the radx-mars-demo.