A top-tier healthcare IT company reached out to 3XM to improve documentation for their hallmark product: a healthcare platform that provides industry-leading analytics, expansive data, and unparalleled connection and data transfer between providers, payers, and consumers. Ultimately, the product’s aim is to enhance workflows, increase administrative and financial efficiencies, and improve clinical decisions.
To meet their clients’ growing needs, this healthcare IT company required help with creating robust documentation so that their clients could better leverage their APIs. By partnering with 3XM Group, they were able to simplify, clarify and expand their documentation to facilitate the integration process for their clients.
To accomplish this, 3XM Group moved forward with the development of a Postman collection, including all the API calls, and incorporated a description with guidelines for correct usage in every request. Additionally, a ReactJS web application was implemented, which used the Postman collection as a datasource for parsing this information using this healthcare IT company’s proprietary component libraries and following the UI guidelines and styles implemented throughout all their solutions.
For this solution, 3XM Group designed a simple architecture:
The solution was deployed in the AWS cloud using Amazon S3 for serving the static website and for storage. It works as follows: when the user calls the Documentation website, the React application gets the Postman collection, parses and formats it, and then returns it as HTML to the user. Since the documentation can contain Markdown, the site processes and renders it inside the pages.
Once the solution was deployed, this healthcare IT company was able to provide their clients with simple, comprehensive documentation and tools to help them utilize their APIs according to their standards. The Documentation website provides the information to the client's non-technical team, while the Postman collection helps their developer team with implementing calls as designed.
Our solution makes use of:
- AWS S3