GET /api/v1/edc/studies/PHARMADEMO/codings?page=0&size=25&sort=recordId%2CASC&filter=dictionaryName%3DMedDRA HTTP/1.1
Content-Type: application/json
Host: localhost:8080
Given a StudyKey, fetch the coding activity. Coding activity occurs to data entered into iMednet that is then standardized to specific drug or medical terms.
A GET
request is used to access the index
GET /api/v1/edc/studies/PHARMADEMO/codings?page=0&size=25&sort=recordId%2CASC&filter=dictionaryName%3DMedDRA HTTP/1.1
Content-Type: application/json
Host: localhost:8080
Path parameters are required.
Parameter | Description |
---|---|
|
StudyKey to retrieve list of codings |
Request parameters are optional. Default values are used unless specified.
Parameter | Description |
---|---|
|
Which index page to be returned. Default value is 0. |
|
Items per page to be returned. Default value is 25. Maximum items allowed per page is 500 |
|
Name of the property by which to sort the result set. To sort in a particular direction add a comma to the property name and either |
|
Optional filter search criteria. Must follow correct syntax. Refer to filter section for details. |
Below is an example response payload.
{
"metadata" : {
"status" : "OK",
"method" : "GET",
"path" : "/api/v1/edc/studies/PHARMADEMO/codings",
"timestamp" : "2024-03-22 15:32:19",
"error" : { }
},
"pagination" : {
"currentPage" : 0,
"size" : 25,
"totalPages" : 1,
"totalElements" : 1,
"sort" : [ {
"property" : "recordId",
"direction" : "ASC"
} ]
},
"data" : [ {
"studyKey" : "PHARMADEMO",
"siteName" : "Chicago Hope Hospital",
"siteId" : 128,
"subjectId" : 247,
"subjectKey" : "111-005",
"formId" : 1,
"formName" : "Adverse Event",
"formKey" : "AE",
"revision" : 2,
"recordId" : 1,
"variable" : "AETERM",
"value" : "Angina",
"codingId" : 1,
"code" : "Angina agranulocytic",
"codedBy" : "John Smith",
"reason" : "Typo fix",
"dictionaryName" : "MedDRA",
"dictionaryVersion" : "24.0",
"dateCoded" : "2024-03-22 15:32:19"
} ]
}
Path | Type | Description |
---|---|---|
|
|
Http status |
|
|
Http method |
|
|
Requested URI path |
|
|
Timestamp when response was generated |
|
|
Detail error message from request if error occur |
|
|
Current index page |
|
|
Size per page |
|
|
Total pages return from search |
|
|
Total elements return from search |
|
|
Sort property |
|
|
Sort direction |
|
|
Unique study key for a given study |
|
|
Site name |
|
|
Unique site id |
|
|
Mednet Subject ID |
|
|
Protocol-assigned subject identifier |
|
|
Mednet Form ID |
|
|
Name of the eCRF |
|
|
Form key |
|
|
Number of modifications of the coding metadata |
|
|
Unique system identifier for record |
|
|
Name of the variable on the eCRF |
|
|
Value |
|
|
Mednet Coding ID |
|
|
Code |
|
|
User who recorded the code |
|
|
Reason |
|
|
Dictionary name |
|
|
Dictionary version |
|
|
Date that code was added |