Note: While this is not a complex task, it is very large. Requires being broken down into further sub-tasks.

The RESTful API is necessary for interacting with the Client Registry in a more standard way. It should adhere to FHIR standards and support PIXm and PDQm profiles.

Dev notes

The RESTful API should be FHIR based meaning we may have to extend the FHIR2 module.

Endpoints

1. Read Patient:

   1. Description: Fetch Patient by a business Identifier

   2. Endpoint: GET cr/Patient/{identifier}

2. Read Patient (PIXm):

   1. Description: Fetch Patient by an OpenMRS local identifier

   2. Endpoint: GET cr/Patient/$ihe-pix?sourceIdentifier=<identifier>&targetSystem=<systemUris>

3. Create Patient:

   1. Description: Create Patient record

   2. Endpoint: POST cr/Patient

4. Update Patient:

   1. Description: Update Patient record

   2. Endpoint: PUT cr/Patient/{identifier}

5. Purge Patient:

   1. Description: Purge Patient record

   2. Endpoint: DELETE cr/Patient/{identifier}

6. Patient Search:

   1. Description: Retrieves patients based on search criteria

   2. Endpoint: GET cr/Patient?param1=value1&param2=value2

7. Post Search:

   1. Description: Searches for potential patient matches or conflicts based on the provided patient data and returns patient bundles in different categories such as matches, conflicts, etc.

   2. Endpoint: POST /cr/patient/match

8. Deduplication:

   1. Description: Performs deduplication of patient records

   2. Endpoint: POST /cr/patient/deduplicate