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:
Rights: DataCaptureSubjectGet and SubjectDataClassificationGet.
- 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 TopResponse
Supported Media Types
- application/json
200 Response
Subjects success.
400 Response
Bad request.
Root Schema : DcsResponse
Type:
Show Source
object-
errorData: object
ErrorResponseData
Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
-
result: object
result
-
status: string
-
version: integer
(int32)
Nested Schema : ErrorResponseData
Type:
objectStructure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
-
details: string
Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.Example:
User role is missing required permission REPORTING_VIEW. Field: userId -
errorCode: string
Application or business-specific error code representing the error type.Example:
REPT_401 -
errorMessage: string
Human-readable error message describing the failure or issue.Example:
Unauthorized: User does not have access to the requested resource
Nested Schema : result
Type:
object