Overview
Info | ||
---|---|---|
| ||
This is a work in progress and may change without notice |
The simple SHR REST interface module that mimics the API expected by the content handler module in a RESTful way. This allows for an easy way to test the system without building a complex interface module.
The module is available at: https://github.com/jembi/openmrs-module-shr-rest.
Requests
It supports POST and GET requests on the following endpoints:
...
Code Block | ||||
---|---|---|---|---|
| ||||
curl --user user:password "host:8080/openmrs/ws/rest/v1/shr/document?patientId=1&patientIdType=ECID&providerId=1&providerIdType=EPID&encounterType=TestImage&formatCode=Image&isURL=true" -H "Content-Type: image/jpg" -X POST -d "http://imageserver/image.jpg" |
GET: ws/rest/v1/shr/document
Parameters:
contentType | The type of content to retrieve |
encounterUUID | The UUID for the specific encounter that needs to be retrieved |
uniqueID | (NOT YET IMPLEMENTED) The unique document ID of the encounter that needs to be retrieved |
Retrieve a specific encounter. Either encounterUUID must be specified or uniqueID, but not both or none.
GET: ws/rest/v1/shr/documents
contentType | The type of contents to retrieve |
patientId | The patient identifier |
patientIdType | The type of identifier |
dateStart | (optional) Format yyyy-MM-dd'T'HH:mm:ss |
dateEnd | (optional) Format yyyy-MM-dd'T'HH:mm:ss |
...
Code Block | ||||
---|---|---|---|---|
| ||||
curl --user user:password "host:8080/openmrs/ws/rest/v1/shr/documents?contentType=text%2Fxml&patientId=1&patientIdType=ECID" -H "Accept: text/xml" Response: <linked-list> <org.openmrs.module.shr.contenthandler.api.Content> <payload><data>...</data></payload> <formatCode>xml< <formatCode>ANC_Summary</formatCode> <contentType>text/xml</contentType> <encoding>UTF-8</encoding> <representation>TXT</representation> <payloadIsUrl>false</payloadIsUrl> <payload><data>...</data></payload> </org.openmrs.module.shr.contenthandler.api.Content> </linked-list> |
Code Block | ||||
---|---|---|---|---|
| ||||
curl --user user:password "host:8080/openmrs/ws/rest/v1/shr/documents?contentType=image%2Fjpg&patientId=1&patientIdType=ECID" -H "Accept: text/xml" Response: <linked-list> <org.openmrs.module.shr.contenthandler.api.Content> <payload>BASE64 Content...</payload> <formatCode>Image</formatCode> <contentType>image/jpg</contentType> <encoding>Binary</encoding> <representation>B64</representation> <payloadIsUrl>false</payloadIsUrl> <payload>BASE64 Content...</payload> </org.openmrs.module.shr.contenthandler.api.Content> <org.openmrs.module.shr.contenthandler.api.Content> <payload>http://imageserver/image.jpg</payload> <formatCode>Image</formatCode> <contentType>image/jpg</contentType> <encoding>Binary</encoding> <representation>BINARY</representation> <payloadIsUrl>true</payloadIsUrl> <payload>http://imageserver/image.jpg</payload> </org.openmrs.module.shr.contenthandler.api.Content> </linked-list> |