MedXChange provides programmatic access to case data and media items. The API is refered to as MIAPI, which stands for MedXChange IntegrationAPI.
The API is a REST API. All request/response formats are JSON.
- TBD
Before you can access any endpoint, you must first have a valid username and password setup on the device you are connecting with. Consult the manual for your MedXChange device to create a user that will be used for remote access to the device.
Every endpoint defined requires authentication, unless stated otherwise. A valid username and password must be provided to the [AUTHENTICATE] (endpoints/misc/authenticate.md) endpoint to retrieve a valid authentication token to use for each subsequent HTTP request. You must add the token to the header of each HTTP request being made to the device.
token: {your authentication token here}
If your authentication token is invalid, you will receive a HTTP 401 response with the following JSON response.
{
"TokenStatus" : 2,
"ErrorMessage" : "Your authorization token is invalid."
}Since this is a json service, all requests headers should indicate that you are sending JSON data in the request and are expecting JSON data in the response.
Use these headers for every JSON request made to the device.
Content-Type: application/json; charset=utf-8
Accept: application/json
ALL_CASESREVIEW_CASESWORKLIST_CASESCURRENT_CASEGET_CASEGET_CASE_FOR_EDITINSERT_CASEUPDATE_CASEDELETE_CASE
- TBD
Got rust on your skills? No worries. Here are the docs you might need to get started:
- HTTPS protocol
- REST software pattern
- Data serialization with JSON