Wiki Spaces


Get Help from Others

Q&A: Ask OpenMRS
Discussion: OpenMRS Talk
Real-Time: IRC Chat | Slack


Page tree
Skip to end of metadata
Go to start of metadata


In DiagnosticReport FHIR resource contains field called "serviceCategory". This filed has zero to one relationship and can take one of values presented in Codes for Diagnostic Service sections.

When the "serviceCategory" field is not presented in FHIR resource instance, those requests are handled by Default Service section.

FHIR module is using Handlers to support each type of serviceCategory sections. You can build your own handler and register for handler a particular type of DiagnosticReport.


Above diagram show the handler hierarchy for the DiagnosticReport.

  • Create a handler for particular Diagnostic Service Section with implementing DiagnosticReportHandler interface
  • Register handler using Spring injection by ModuleApplicationContext.xml
  • RESTfulDiagnosticReportResourceProvider listen to the HTTP requests and invoke appropriate method in DiagnosticReportServiceImpl according to the requested parameters
  • Then DiagnosticReportServiceImpl will select the register handler which can fulfill that request and forward it to the DiagnosticReportUtil
  • DiagnosticReportUtil trigger the handler and send back the response

How to Create a DiagnosticReportHandler


  • A DiagnosticReportHandler must implement the DiagnosticReportHandler interface
  • A DiagnosticReportHandler may extend the AbtractHandler which contains common set of functionalities
  • The DiagnosticReportHandler must be registered by Spring with a key


Laboratory Handler

  • Found in the org.openmrs.module.fhir.api.diagnosticreport.handler package
  • Extends org.openmrs.module.fhir.api.diagnosticreport.handler
package org.openmrs.module.fhir.api.diagnosticreport.handler;
public class LaboratoryHandler extends AbstractHandler implements DiagnosticReportHandler {
  private static final String ServiceCategory = "LAB";
  public LaboratoryHandler() {
  public String getServiceCategory() {
    return ServiceCategory;
  public DiagnosticReport getFHIRDiagnosticReportById(String id) {
    // Implement code here
  public List<DiagnosticReport> getFHIRDiagnosticReportBySubjectName(String name) {
    // Implement code here
  public DiagnosticReport saveFHIRDiagnosticReport(DiagnosticReport diagnosticReport) {
    // Implement code here
  public DiagnosticReport updateFHIRDiagnosticReport(DiagnosticReport diagnosticReport, String theId) {
    // Implement code here
  public void retireFHIRDiagnosticReport(String id) {
    // Implement code here

Register LaboratoryHandler

Register handler in FHIR module ModuleApplicationContext.xml configuration (locate in /api/src/main/resources/moduleApplicationContext.xml).

 <bean parent="serviceContext">
        <property name="moduleService">
                    <property name="transactionManager">
                        <ref bean="transactionManager"/>
                    <property name="target">
                        <bean class="org.openmrs.module.fhir.api.impl.DiagnosticReportServiceImpl">
                            <property name="dao">
                                <bean class="org.openmrs.module.fhir.api.db.hibernate.HibernateFHIRDAO">
                                    <property name="sessionFactory">
                                        <ref bean="sessionFactory"/>
                            <property name="handlers">
                                        <bean class="org.openmrs.module.fhir.api.diagnosticreport.handler.DefaultDiagnosticReportHandler"/>
                                        <bean class="org.openmrs.module.fhir.api.diagnosticreport.handler.LaboratoryHandler"/>

List of Handlers

Following is a list of currently implemented handlers for Different type of Diagnostic Service sections;