REST API

Some considerations

The functions we want, are basically CRUD on:

OpenMRSdcm4chee
UsersUsers
PatientsPatients
OrdersWorklists/workitems
ObservationsStudies/Series/Images

The users would be: referring physician, modality/radiographer, and radiologist.

We need to define where the radiology module server would be to reduce implementation efforts. I mean:

  1. If we decide to put the module on OpenMRS, we would have a URL like /ws/rest/**/radiology/patients (service for an OpenMRS module)
  2. If we decide to run an independet server the URLs would be /patients
FunctionMethodPath example
CreatePOST/patients
ReadGET/patients/:search
UpdatePUT/patients/:id
DeleteDELETE/patients/:id

I was thinking that :search could be a string like:

  1. 1, in this case the API would fetch patient with id 1
  2. ?name=john&age=45, in this case the API would fetch a list of patients whose names contain john and them ages are 45 years.
  3. empty string, in this case the API would return a list all patients.