Jump to

• Request
• Response

V1.0

get

/ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/ehrdata/medicalrecordnumber/{siteId}/{medicalRecordNumber}

Retrieves patient information based on the Medical Record Number (MRN). If MRN is not found, returns an empty response.

Request

Path Parameters

• medicalRecordNumber(required): string
  Medical Record Number (MRN) for which we need to fetch patient information.

  Example:

  MRN13456

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• siteId(required): string(uuid)
  Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : EHRtoEDCPatientInfoDTO

Type: object

DTO representing detailed EHR patient demographics for MRN-based lookup.

Show Source

• address: object EHRtoEDCAddressDTO
  Simple postal address details for an EHR patient.
• dateOfBirth: string (date)
  Date of birth in ISO format YYYY-MM-DD.

  Example: 1979-03-22
• gender: string
  Gender/sex of the patient (e.g. 'MALE', 'FEMALE').

  Example: FEMALE
• id: string
  Uppercase HEX patient unique identifier.

  Example: C0A8010AC8ED432F8A2AD12B28F95C84
• mrn: string
  Medical record number for patient.

  Example: MRN13456
• name: string
  Patient's full name.

  Example: Jane Doe

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Uppercase HEX patient unique identifier.",
            "example":"C0A8010AC8ED432F8A2AD12B28F95C84"
        },
        "mrn":{
            "type":"string",
            "description":"Medical record number for patient.",
            "example":"MRN13456"
        },
        "name":{
            "type":"string",
            "description":"Patient's full name.",
            "example":"Jane Doe"
        },
        "gender":{
            "type":"string",
            "description":"Gender/sex of the patient (e.g. 'MALE', 'FEMALE').",
            "example":"FEMALE"
        },
        "dateOfBirth":{
            "type":"string",
            "description":"Date of birth in ISO format YYYY-MM-DD.",
            "format":"date",
            "example":"1979-03-22"
        },
        "address":{
            "$ref":"#/components/schemas/EHRtoEDCAddressDTO"
        }
    },
    "description":"DTO representing detailed EHR patient demographics for MRN-based lookup."
}

Nested Schema : EHRtoEDCAddressDTO

Type: object

Simple postal address details for an EHR patient.

Show Source

• city: string
  Name of the city for patient residence.

  Example: Los Angeles
• state: string
  Two-letter state code.

  Example: CA

{
    "type":"object",
    "properties":{
        "city":{
            "type":"string",
            "description":"Name of the city for patient residence.",
            "example":"Los Angeles"
        },
        "state":{
            "type":"string",
            "description":"Two-letter state code.",
            "example":"CA"
        }
    },
    "description":"Simple postal address details for an EHR patient."
}

Examples

Select an example Get Patient Info Using MRN Example

400 Response

Bad request.

Body ()

Root Schema : DcsResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Back to Top