Codings endpoint

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.

Accessing the index

A GET request is used to access the index

Request structure

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.

Table 1. /api/v1/edc/studies/{studyKey}/codings
Parameter Description

studyKey

StudyKey to retrieve list of codings

Request parameters

Request parameters are optional. Default values are used unless specified.

Parameter Description

page

Which index page to be returned. Default value is 0.

size

Items per page to be returned. Default value is 25. Maximum items allowed per page is 500

sort

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 asc or desc. To sort by multiple properties add additional sort parameters. Default value is formId,asc.

filter

Optional filter search criteria. Must follow correct syntax. Refer to filter section for details.

Response body

Below is an example response payload.

{
  "metadata" : {
    "status" : "OK",
    "method" : "GET",
    "path" : "/api/v1/edc/studies/PHARMADEMO/codings",
    "timestamp" : "2024-11-04 16:03: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-11-04 16:03:19"
  } ]
}

Response fields

Path Type Description

metadata.status

String

Http status

metadata.method

String

Http method

metadata.path

String

Requested URI path

metadata.timestamp

String

Timestamp when response was generated

metadata.error

Object

Detail error message from request if error occur

pagination.currentPage

Number

Current index page

pagination.size

Number

Size per page

pagination.totalPages

Number

Total pages return from search

pagination.totalElements

Number

Total elements return from search

pagination.sort[].property

String

Sort property

pagination.sort[].direction

String

Sort direction

data[].studyKey

String

Unique study key for a given study

data[].siteName

String

Site name

data[].siteId

Number

Unique site id

data[].subjectId

Number

Mednet Subject ID

data[].subjectKey

String

Protocol-assigned subject identifier

data[].formId

Number

Mednet Form ID

data[].formName

String

Name of the eCRF

data[].formKey

String

Form key

data[].revision

Number

Number of modifications of the coding metadata

data[].recordId

Number

Unique system identifier for record

data[].variable

String

Name of the variable on the eCRF

data[].value

String

Value

data[].codingId

Number

Mednet Coding ID

data[].code

String

Code

data[].codedBy

String

User who recorded the code

data[].reason

String

Reason

data[].dictionaryName

String

Dictionary name

data[].dictionaryVersion

String

Dictionary version

data[].dateCoded

String

Date that code was added