Overview

The OpenMRS Patient Flag FHIR module is built based on the OpenMRS FHIR2 module to map the OpenMRS patient flag data model to the FHIR Flag resource. This module provides translation from the OpenMRS flag data model to the FHIR Flag resource and includes FHIR search functionality.

sample mapping

{
    "resourceType": "Flag",
    "id": "2d34f4b5-ff5d-4678-9580-f9cfd86f7d60",
    "status": "active",
    "category": [
        {
            "coding": [
                {
                    "code": "ALLEGRY",
                    "display": "ALLERGY"
                }
            ],
            "text": "ALLERGY"
        }
    ],
    "code": {
        "coding": [
            {
                "display": "Allergy"
            }
        ],
        "text": "BEEF ALLERGY"
    },
    "subject": {
        "reference": "Patient/7111e9af-e91e-4a99-97b6-19ca60d08afc",
        "type": "Patient",
        "display": "Gasia Winchester (OpenMRS ID: 10001V)"
    },
    "period": {
        "start": "2024-08-10T19:07:36+05:30"
    }
}

Installation

The patient flag fhir module package along with the patient flag module.

Prerequisite

openMRS FHIR2 module >= version 2.0.0

Installation instructions for Module can be found here - Patient Flags Module Documentation

Patient Flag Module FHIR API

Method	URL	Parameters / Body	Description	Rep Default

Method	URL	Parameters / Body	Description	Rep Default
GET	/openmrs/ws/fhir2/R4/Flag/<patient flag UUID>		fetch the patient flag by patient flag UUID	resource type ID status category code subject Period
Search patient flags by patient
GET	/openmrs/ws/fhir2/R4/Flag?	patient=patient UUID patient.name=patient name patient.given= patient given name patient.family= patient family name patient.identidentifier = patinet identifier	search patient flags by patient name, given name, family name , patient UUID and patient identifier	resource type ID status category code subject Period
Search patient flags by flag category
GET	/openmrs/ws/fhir2/R4/Flag?	category=flag category	search patient flags by flag category	resource type ID status category code subject Period
Search patient flags by flag code
GET	/openmrs/ws/fhir2/R4/Flag?	code=flag code	search patient flags by flag code	resource type ID status category code subject Period
Search patient flags by date
GET	/openmrs/ws/fhir2/R4/Flag?	date ( eg: 2024-08-11)	search patient flag by date	resource type ID status category code subject Period

Future Improvements

improve the search functionality
implement the mechanism that translate FHIR flag resource to openmrs patient flag

Resources

OpenMRS FHIR 2 module : GitHub - openmrs/openmrs-module-fhir2: The FHIR REST API and related services for OpenMRS
openMRS FHIR documentation : FHIR: OpenMRS Strategy, Tools, FHIR API, and Help

Archives

Patient Flag FHIR Module User Guide