REST API for Clinical One Platform

Get patient summary

get

/ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/mrn/{medicalRecordNumber}

Retrieves the patient's information based on the Medical Record Number (MRN).

Request

Path Parameters

medicalRecordNumber(required): string
mode(required): string

Mode of the study. Accepts test, active, or training.
studyId(required): string

ID of the study to which the subject belongs.

There's no request body for this operation.

Response

Supported Media Types

application/json

Default Response

default response

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