Jump to

• Request
• Response

Get EHR Data for a particular subject and visit

get

/ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/ehrdata/subjects/{subjectId}/visit/{eventId}/studyversion/{studyVersion}/{category}

Retrieves EHR Data for a particular subject and a visit. Fetches for the category provided, which can be any of the following:

• LABS
• MEDICAL
• MEDICATIONHISTORY
• VITALS
• DEMOGRAPHICS
• PROCEDURES

Rights: DataCaptureSubjectGet and SubjectDataClassificationGet.

Request

Path Parameters

• category(required): string
  EHR category name
• eventId(required): string
  Visit ID for Designer.
• mode(required): string
  Mode of the study. Accepts test, active, or training.
• studyId(required): string
  ID of the study to which the subject belongs.
• studyVersion(required): string
  Study version number.
• subjectId(required): string
  Subject ID.

Query Parameters

• dictionaryIds: array[string]
  The end date until which you want to retrieve the data values.
• endDateTime: string
  The end date until which you want to retrieve the data values.
• eventInstanceNum: integer
  eventInstanceNumber
• limit: integer(int32)
  limit
• offset: integer(int32)
  offset
• siteId: string
  Site ID in which subject is currently in
• sortOrder: string
  Order of sorting for records. DESC by default
• startDateTime: string
  Date for which you want to retrieve the data values.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Subjects success.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object SubjectDto

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SubjectDto"
    }
}

Nested Schema : SubjectDto

Type: object

Show Source

• codeBreak: string
• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• description: string
  Minimum Length: 0

  Maximum Length: 500
• dob: string (date-time)
• enrollmentFailure: string
  Minimum Length: 0

  Maximum Length: 255
• enrollmentOverride: string
  Minimum Length: 0

  Maximum Length: 255
• gender: string
  Minimum Length: 0

  Maximum Length: 10
• id: string (uuid)
• informedConsentDate: string (date-time)
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• screeningDate: string (date-time)
• screeningFailure: string
  Minimum Length: 0

  Maximum Length: 255
• siteId: string
• state(required): string
  Minimum Length: 0

  Maximum Length: 100
• stateDate: string (date-time)
• studyId: string
• studyVersion(required): string
• subjectNumber(required): string
  Minimum Length: 0

  Maximum Length: 500
• userId: string (uuid)
• versionStart: string (date-time)

{
    "required":[
        "state",
        "studyVersion",
        "subjectNumber"
    ],
    "type":"object",
    "properties":{
        "screeningDate":{
            "type":"string",
            "format":"date-time"
        },
        "codeBreak":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "description":{
            "maxLength":500,
            "minLength":0,
            "type":"string"
        },
        "subjectNumber":{
            "maxLength":500,
            "minLength":0,
            "type":"string"
        },
        "studyId":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "dob":{
            "type":"string",
            "format":"date-time"
        },
        "state":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "stateDate":{
            "type":"string",
            "format":"date-time"
        },
        "screeningFailure":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "enrollmentFailure":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "enrollmentOverride":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "informedConsentDate":{
            "type":"string",
            "format":"date-time"
        },
        "gender":{
            "maxLength":10,
            "minLength":0,
            "type":"string"
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "studyVersion":{
            "type":"string"
        }
    }
}

400 Response

Bad request.

Body ()

Root Schema : DcsResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "writeOnly":true
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Back to Top