REST API
Some considerations
The functions we want, are basically CRUD on:
OpenMRS | dcm4chee |
---|---|
Users | Users |
Patients | Patients |
Orders | Worklists/workitems |
Observations | Studies/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:
- If we decide to put the module on OpenMRS, we would have a URL like /ws/rest/**/radiology/patients (service for an OpenMRS module)
- If we decide to run an independet server the URLs would be /patients
Function | Method | Path example |
---|---|---|
Create | POST | /patients |
Read | GET | /patients/:search |
Update | PUT | /patients/:id |
Delete | DELETE | /patients/:id |
I was thinking that :search could be a string like:
- 1, in this case the API would fetch patient with id 1
- ?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.
- empty string, in this case the API would return a list all patients.Â
Â