Welcome

Welcome to the MEDrecord API documentation. Here you can find technical information on how the MEDrecord API works and how you can use it to develop your own "medical grade" applications. The overview picture below shows how we have setup our API structure, divided into separated API’s:

Clinical data

All our data is being stored using a strict data model defined by medical professionals in the openEHR community.
For your convenience we have developed an easy-to-use Formbuilder in order to handle these clinical data models (so-called archetypes) in a more user friendly approach by providing a drag-and-drop functionally for reusable clinical data models. See also our Formbuilder.

MEDrecord has a few hundred of these already validated clinical models (archetypes) available which can be re-used to create your own clinical Form. And if MEDrecord does not have the clinical model (archetype) available for your usecase, we can create the model for you or you can develop the model yourself. Also find a large repository of these open source clinical models (archetypes) in the OpenEHR CKM.

Sensor data

Please note that we make a clear separation between clinical relevant data and data derived from sensors and wearables. For the doctor there is absolutely no use in looking at all data collected from the user (patient) during the day, the doctor wants to know if he needs to pay attention to a specific part of the data. Therefore we make a clear separation between those two. All clinical data will be store in the context of a careplan using our Medical data API. All other data derived from sensors and wearables can be stored in our Sensor data API.

More resources

Full API reference

Please find the links to the complete and detailed documentation of the MEDrecord REST API, as also shown in the overview picture above:

  1. Medical Data
  2. Authentication
  3. Users Profiles
  4. Sensor (continious) data
Tutorials and examples
Follow these step by step tutorials and examples to implement a feature in minutes.
UI components

Quickly start a new app and re-use our UI components.

Quickly get started: 2 API calls to store blood pressure

You only need 2 API calls to store a medically validated blood pressure measurement:
curl \
  -X POST \
  -d @- \
  -H "Content-Type: application/json" \
  https://dev.medrecord.nl/auth/login/password <<EOF
{
  "email": "demo@medsafe",
  "password": "demo123"
}
EOF
On success this will return a JSON document with a token and an ehrId. Rember these for step 2.
curl \
    -X POST \
    -d @- \
    -H "Content-Type: application/json" \
    -H "Authorization: bearer $TOKEN" \
    https://dev.medrecord.nl/ehr/$EHRID/procedure/bloodpressure \
    <<EOF
{
  "applicationInfo": {
    "applicationName": "Example",
    "applicationVersion": "1.0",
    "locale": "en"
  },
  "bodyPart": "ARM",
  "caffeine": 0,
  "cuffSize": "NORMAL",
  "deviceBrand": "ACME",
  "deviceModel": "BigThumb",
  "intensity": "LOW",
  "leftRight": "LEFT",
  "nicotine": 0,
  "rest": 30,
  "sample1": {
    "diastolic": "100",
    "systolic": "110",
    "time": "2017-06-12T12:45:36Z"
  },
  "sample2": {
    "diastolic": "105",
    "systolic": "111",
    "time": "2017-06-12T12:55:17Z"
  },
  "startOfMeasurement": "2017-06-12T12:51:38Z"
}   
EOF
On success this call will return the ID of the measurement.

Even quicker: 1 form to store blood pressure

Using the formbuilder and our formfiller you can store medically validated blood pressure measurements without programming.

Developer Support

Didn't find what you where looking for? Try our forum, our developers are also there.
pluslistarrow-leftglobe