Building a Testable FHIR Implementation Guide

Primary mentor	piort
Backup mentor	Mozzy
Assigned to	sharif, abert

Abstract

In an effort to validate the capabilities of the OpenMRS FHIR2 Module using standard FHIR structures, we're proposing a project to develop the OpenMRS FHIR Implementation Guide(IG) into a testable IG that connects the contained technical specifications with the testing packages for the FHIR2 module.

FHIR Implementation Guides (IGs) provide a standard way of documenting FHIR services, and our primary goal is to align the FHIR2 module documentation with this standard, using the available best practices for IG development. This github repository currently houses the skeleton IG for the FHIR2 module, of which a compiled version is viewable at https://fhir.openmrs.org. You can see more about the FHIR2 project on the wiki page: FHIR 101: OpenMRS Strategy, Tools, FHIR API, and Help.

Our implementation guide is based on the OpenHIE Implementation Guide created by Jose Costa Teixeira, but it’s been lightly retouched to closer match OpenMRS branding.

Project Rating and length

Medium

175 hours

Objectives

Build out the FHIR2 Module Implementation Guide with testable resource templates, example resources, and profiles.
Integrate testable IG feature with FHIR2 module integration tests.
Pilot the use of TestScript, TestReport, and other components of the FHIR Implementation Support Module in testing the FHIR2 module capabilities. (see more).

Project Champions

Ian Bacher

Piotr Mankowski

Moses Mutesasira

Recommended Prerequisites

Some experience working with RESTful APIs
Some experience with software development and testing processes (TDD, BDD, etc.)

Developed Skills and Competencies

General understanding of OpenMRS and the OpenMRS data model
FHIR Shorthand (FSH ) and Sushi
Testing FHIR-based applications using cutting-edge features
Java Development

Extra Credit

Resources

Overview of IGs
https://build.fhir.org/ig/FHIR/ig-guidance/
https://build.fhir.org/ig/FHIR/ig-guidance/best-practice.html
http://build.fhir.org/ig/FHIR/ig-guidance/using-templates.html

Overview Of FSH
http://hl7.org/fhir/uv/shorthand/2020May/reference.html
http://hl7.org/fhir/uv/shorthand/2020May/

Overview of SUSHI
https://build.fhir.org/ig/HL7/fhir-shorthand/reference.html
http://hl7.org/fhir/uv/shorthand/2020May/sushi.html