Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Primary Mentor
Backup Mentor
Student

Abstract

OpenMRS is using the FHIR API more and more in place of the REST API. However, the FHIR API is, by default, quite verbose. Supporting PATCH operations would allow us to support partial updates to FHIR resources without needing to send the whole resource from the client to the server.

PATCH requests essentially comprise of instructions on how to modify a resource or resources. Patch requests can be used to avoid sending a whole document when only a part has changed and this is where it basically differs with the PUT request. Patch Request formats include the following JSON PATCH, XML PATCH which have to be implemented within the openmrs fhir2 module and in addition to those, the FHIR PATCH has to be included as well as a way of ensuring that when slight changes are made to the Json document, the entire document does not have to be sent. The Patch operations used within the above mentioned patch formats are add, replace, move, copy, test, remove.

Format for supporting a single patch

  1. Detect the incoming format(either json-merge patch, json-patch or xml-patch)
  2. Load the existing resource in the appropriate format
  3. Apply the patch

Required Skills

  • Excellent Java skills.

Project Length

Medium, 175 hours.

Objectives

  • Leverage Hapi Fhir's support for Patch operations
  • support all resources of R4 version in the openmrs-fhir2-module.
  • support formats like Json-Merge Patch operations, Json Patch operations and XML-patch operations.
  • Write up documentation for the work done preferably on the FhirIG


Resources







  • No labels