Form Repository REST Interface
Resource Group¶
Retrieve a resume of all forms¶
GET/forms
Retrieve a resume of all forms.
Request
Headers
Accept: application/jsonResponse
200Headers
Content-Type: application/jsonBody
[
{
"id": 3,
"version": 1,
"name": "Anamnesis",
"description": "A form to use for the documentation of the anamnesis of the patient",
"type": {
"id": 3,
"name": "Base Data"
},
"created": {
"createdAt": "1398674198000",
"person": {
"id": 3,
"name": "Miller"
}
},
"updated": {
"updatedAt": "1414491468160",
"person": {
"id": 1,
"name": "Becker"
}
}
}
]Schema
{to be added}Retrieve a form by id¶
GET/forms/{id}
Retrieve the latest version of a form by id.
Parameters
- id
string(required) Example: 3the id of the form
Request
Headers
Accept: application/jsonResponse
200Headers
Content-Type: application/jsonBody
{
"id": 2,
"version": 1,
"name": "Diagnosis",
"description": "A form to use for the documentation of the actual diagnosis of the patient",
"type": {
"id": 2,
"name": "Episodes"
},
"items": [
{
"mdrId": "richText",
"position": 1,
"label": "null",
"repeatable": false,
"mandatory": false,
"html": "<p><span style=\\\"font-size: 36px; line-height: 22.8571434020996px;\\\">Form subtitle</span></p><p><span style=\\\"line-height: 22.8571434020996px; font-size: 24px;\\\">This is the form subtitle introduction</span></p>"
},
{
"mdrId": "urn:mdr:dataelement:32:1",
"position": 3,
"label": "null",
"repeatable": false,
"mandatory": false,
"html": "null"
},
{
"mdrId": "urn:mdr:dataelement:46:1",
"position": 4,
"label": "null",
"repeatable": true,
"mandatory": true,
"html": "null"
},
{
"mdrId": "urn:mdr:dataelement:58:1",
"position": 2,
"label": "Distant Metastasis Present Date",
"repeatable": true,
"mandatory": false,
"html": "null"
}
]
}Schema
{to be added}Retrieve a form by id in a specific version¶
GET/forms/{id}/{version}
Retrieve the latest version of a form by id.
Parameters
- id
string(required) Example: 3the id of the form
- version
string(required) Example: 1the version of the form
Request
Headers
Accept: application/jsonResponse
200Headers
Content-Type: application/jsonBody
{
"id": 2,
"version": 1,
"name": "Diagnosis",
"description": "A form to use for the documentation of the actual diagnosis of the patient",
"type": {
"id": 2,
"name": "Episodes"
},
"items": [
{
"mdrId": "richText",
"position": 1,
"label": "null",
"repeatable": false,
"mandatory": false,
"html": "<p><span style=\\\"font-size: 36px; line-height: 22.8571434020996px;\\\">Form subtitle</span></p><p><span style=\\\"line-height: 22.8571434020996px; font-size: 24px;\\\">This is the form subtitle introduction</span></p>"
},
{
"mdrId": "urn:mdr:dataelement:32:1",
"position": 3,
"label": "null",
"repeatable": false,
"mandatory": false,
"html": "null"
},
{
"mdrId": "urn:mdr:dataelement:46:1",
"position": 4,
"label": "null",
"repeatable": true,
"mandatory": true,
"html": "null"
},
{
"mdrId": "urn:mdr:dataelement:58:1",
"position": 2,
"label": "Distant Metastasis Present Date",
"repeatable": true,
"mandatory": false,
"html": "null"
}
]
}Schema
{to be added}