...
FHIR Implementation Guides (IGs) provide a standard way of documenting FHIR services. The OpenMRS Community has an active “FHIR Squad” working on a variety of OpenMRS HL7 FHIR Solutions, including the OpenMRS FHIR2 module.
...
Objective 1: Present FHIR specifications for the OpenMRS FHIR2 module as a FHIR IG
Activity 1.1: Research tools and best practices for writing a FHIR IG
Activity 1.2: Use FHIR shorthand and compile it using Sushi
Activity 1.3: Write FHIR based specifications as part of the FHIR2 Module IG
Objective 2: Evaluate the FHIR2 module IG process
Activity 2.1: Gather feedback on the FHIR IG and creation process
Activity 2.2: Make recommendations on improvements and future contributions to the IG
Activity 2.3: Disseminate the FHIR2 Module IG, lessons learned, and recommendations through community showcases and videos
Community Approach
Our community approaches each project with sustainability in mind. We achieve this by integrating opportunities for professional development into each project. This project provides the technical writer with an opportunity to advance and apply their FHIR knowledge and/or share that knowledge with others in the community.
Specific individuals working on this project with the FHIR Squad:
Project Timeline
The project will take approximately six months. The first four months will mainly concentrate on gathering and trialing FHIR IG resources and tools, then applying these resources and tools to create the FHIR2 Module IG. The last two months will focus on gathering feedback from OpenMRS implementers and FHIR gurus, then disseminating the IG to relevant digital health communities (including OpenMRS) and implementations.
Objectives & Activities | Q2 | Q3 | ||||
A | M | J | J | A | S | |
Technical Writer & Fellow Recruitment and Orientation | ||||||
Objective 1: Present FHIR specifications for the OpenMRS FHIR2 module as a FHIR IG | ||||||
Activity 1.1: Research tools and best practices for writing a FHIR IG | ||||||
Activity 1.2: Use FHIR shorthand and compile it using Sushi | ||||||
Activity 1.3: Write FHIR based specifications as part of the FHIR2 Module IG | ||||||
Objective 2: Evaluate the FHIR2 module IG process | ||||||
Activity 2.1: Gather feedback on the FHIR IG and creation process | ||||||
Activity 2.2: Make recommendations on improvements and future contributions to the IG | ||||||
Activity 2.3: Disseminate the FHIR2 Module IG, lessons learned, and recommendations through community showcases and videos | ||||||
Measuring Success
The FHIR2 module IG created through this project will make it easier for a) OpenMRS implementers to use the FHIR2 module, and b) newcomers to the community who have a FHIR background and are familiar with the “FHIR way” of doing things.
...
- OpenMRS FHIR2 Module IG published
- OpenMRS FHIR2 Module IG demonstrated to the community in at least one community meeting or community mini-meeting
- X # of OpenMRS implementations are aware of the FHIR2 Module IG
Once published, we will determine the longer term success of this initiative using the following metrics:
...
'll consider this project a long term success if we receive fewer follow up questions about our FHIR2 Module resources and profiles.
Additional Information
In 2019, several members of the OpenMRS Community formed the OpenMRS FHIR Squad. Since its inception, the FHIR Squad has become a hub for innovation when it comes to leveraging FHIR to advance solutions supporting interoperability between OpenMRS and a range of other digital public goods and assuring the quality of these solutions.
In collaboration with technical writers through Google Season of Docs 2019, 2020, and 2021, OpenMRS has made several improvements to documentation available on our Wiki (https://wikiopenmrs.openmrsatlassian.org/net).
OpenMRS has participated in Google Season of Docs since its inception. In 2019, we were one of the few organizations to successfully work with three technical writers on two key projects: Developing OpenMRS REST API Documentation (two technical writers) and Updating the OpenMRS Wiki Information Architecture (one technical writer).Through Google Season of Docs in 2020, OpenMRS worked with one technical writer on a project designed to improve our OpenMRS Getting Started Guide for New Developers, which serves as inspiration for this project. Although not selected for Google Season of Docs 2020, another aspiring Season of Docs technical writer joined our Documentation Team and moved ahead with her proposed GSOD project, Developing a Suite of Volunteer Guides. All technical writers became members of our Documentation Team and had ongoing support from experienced community members, our Community Director, and Product Director.
...
As a result of these efforts, OpenMRS has a framework for working with technical writers to define and track a variety of documentation projects and tasks. This serves as strong foundation for success for this year’s Google Season of Docs.
Project budget
...
Description
...
Amount
...
Running Total
...
OpenMRS Community Management, onboarding, and project support
...
$5,250
...
$5,250
...
Technical Writer: Research FHIR documentation resources & tools; apply relevant resources and tools to OpenMRS FHIR IG; create OpenMRS FHIR2 module IG; gather feedback, recommend improvements, and disseminate FHIR IG.
...
$9,250
...
$14,500
...
Sub-Total
...
$14,500
...
$14,500
...
Total
...
$14,500
...