MDR REST Interface
Specific requests must include the access token in the Authorization Header
Namespaces¶
Namespaces list¶
GET/namespaces
Get a list of all namespaces defined in the MDR.
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
[
{
"name": "mdr",
"writeable": true,
"designations": [
{
"definition": "Der Default Namespace",
"designation": "MDR",
"lang": "de"
},
{
"definition": "The default namespace",
"designation": "MDR",
"lang": "en"
}
]
}
]
Schema
{to be added}
Root members of a namespace¶
GET/namespaces/{namespace}/members
Get the root member items of a requested resource.
- namespace
string
(required) Example: dktkThe name of the requested namespace
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"totalcount": 57,
"results": [
{
"id": "urn:mdr:dataelement:8132:1",
"type": "DATAELEMENT",
"designations": [
{
"definition": "Sex of a patient",
"designation": "Sex",
"lang": "en"
}
]
}
]
}
Schema
{to be added}
Search inside a namespace¶
GET/namespaces/{namespace}/search{?query}
Search inside a namespace.
- namespace
string
(required) Example: dktkThe name of the requested namespace
- query
string
(required) Example: sexThe search term
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"totalcount": 57,
"results": [
{
"id": "urn:mdr:dataelement:8132:1",
"type": "DATAELEMENT",
"designations": [
{
"definition": "Sex of a patient",
"designation": "Sex",
"lang": "en"
}
]
}
]
}
Schema
{to be added}
Data elements¶
Get a data element¶
GET/dataelements/{urn}
Get a specific data element identified by its URN.
- urn
string
(required) Example: urn:dktk:dataelement:123:1The URN of a data element
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"designations": [
{
"definition": "Sex of a patient",
"designation": "Sex",
"lang": "en"
}
],
"validation": {
"value_domain_type": "described",
"description": "Weight of a patient in kilogram",
"datatype": "INTEGER",
"format": "0<=x<=150",
"maximum_character_quantity": "3",
"unit_of_measure": "kg",
"validation_type": "INTEGERRANGE",
"validation_data": "0<=x<=150",
"meanings": [
{
"definition": "an integer used for quantification by additionally specifying a unit of measure",
"designation": "a number",
"lang": "en"
}
],
"errorMessages": [
{
"definition": "the entered value has to be between 0 and 200",
"designation": "invalid value",
"lang": "en"
}
]
},
"slots": [
{
"slot_name": "STUDYCONTEXT",
"slot_value": "NCI4711"
}
],
"identification": {
"urn": "urn:mdr:dataelement:4711:1"
}
}
Schema
{to be added}
Get the labels of a data element¶
GET/dataelements/{urn}/labels
Get the labels of a specific data element identified by its URN.
- urn
string
(required) Example: urn:dktk:dataelement:123:1The URN of a data element
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
[
{
"definition": "Sex of a patient",
"designation": "Sex",
"lang": "en"
}
]
Schema
{to be added}
Get the validation information of a data element¶
GET/dataelements/{urn}/validations
Get the validation information of a specific data element identified by its URN.
- urn
string
(required) Example: urn:dktk:dataelement:123:1The URN of a data element
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"value_domain_type": "described",
"description": "Weight of a patient in kilogram",
"datatype": "INTEGER",
"format": "0<=x<=150",
"maximum_character_quantity": "3",
"unit_of_measure": "kg",
"validation_type": "INTEGERRANGE",
"validation_data": "0<=x<=150",
"meanings": [
{
"definition": "an integer used for quantification by additionally specifying a unit of measure",
"designation": "a number",
"lang": "en"
}
],
"errorMessages": [
{
"definition": "the entered value has to be between 0 and 200",
"designation": "invalid value",
"lang": "en"
}
]
}
Schema
{to be added}
Get the labels and the validation information of a data element¶
GET/dataelements/{urn}/uimodel
Get the labels and validation information of a specific data element identified by its URN.
- urn
string
(required) Example: urn:dktk:dataelement:123:1The URN of a data element
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"designations": [
{
"definition": "Sex of a patient",
"designation": "Sex",
"lang": "en"
}
],
"validation": {
"value_domain_type": "described",
"description": "Weight of a patient in kilogram",
"datatype": "INTEGER",
"format": "0<=x<=150",
"maximum_character_quantity": "3",
"unit_of_measure": "kg",
"validation_type": "INTEGERRANGE",
"validation_data": "0<=x<=150",
"meanings": [
{
"definition": "an integer used for quantification by additionally specifying a unit of measure",
"designation": "a number",
"lang": "en"
}
],
"errorMessages": [
{
"definition": "the entered value has to be between 0 and 200",
"designation": "invalid value",
"lang": "en"
}
]
}
}
Schema
{to be added}
Get the slots of a data element¶
GET/dataelements/{urn}/slots
Get the slots of a specific data element identified by its URN.
- urn
string
(required) Example: urn:dktk:dataelement:123:1The URN of a data element
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
[
{
"slot_name": "STUDYCONTEXT",
"slot_value": "NCI4711"
}
]
Schema
{to be added}
Data element groups¶
Get the labels of a data element group¶
GET/dataelementgroups/{urn}/labels
Get the labels of a specific data element group identified by its URN.
- urn
string
(required) Example: urn:dktk:dataelement:123:1The URN of a data element
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
[
{
"definition": "Information about the classification of the tumour",
"designation": "Tumour classification",
"lang": "en"
}
]
Schema
{to be added}
Get the members of a data element group¶
GET/dataelementgroups/{urn}/members
Get the members (subgroups, dataelements, records) of a specific data element group identified by its URN.
- urn
string
(required) Example: urn:dktk:dataelement:123:1The URN of a data element
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"totalcount": 5,
"results": [
{
"id": "urn:mdr:dataelementgroup:4713:1",
"type": "DATAELEMENTGROUP",
"designations": [
{
"definition": "Information about the classification of the tumour",
"designation": "Tumour classification",
"lang": "en"
}
]
}
]
}
Schema
{to be added}
Records¶
Get the labels of a record¶
GET/records/{urn}/labels
Get the labels of a specific record identified by its URN.
- urn
string
(required) Example: urn:dktk:dataelement:123:1The URN of a data element
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
[
{
"definition": "Numeric identifier to specify the position within a storage rack or box in which a cell product is located",
"designation": "Cell Product Storage Position Location Identifier",
"lang": "en"
}
]
Schema
{to be added}
Get the members of a record¶
GET/records/{urn}/members
Get the members of a specific record identified by its URN.
- urn
string
(required) Example: urn:dktk:dataelement:123:1The URN of a data element
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
[
{
"id": "urn:mdr:dataelement:87:1",
"type": "DATAELEMENT",
"order": 1,
"designations": [
{
"definition": "Numeric identifier to specify the position within a storage rack or box in which a cell product is located",
"designation": "Cell Product Storage Position Location Identifier",
"lang": "en"
}
]
}
]
Schema
{to be added}