Jump to

• Request
• Response

v1.0

post

/ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/ehrdata/subjectslinkstatus

Retrieves the EHR???EDC link status for subjects at the provided sites within the specified study and mode.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training.

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request DTO for querying the EHR-to-EDC patient link status for a set of site IDs.

Show Source

• siteIds: array siteIds
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.

{
    "type":"object",
    "properties":{
        "siteIds":{
            "type":"array",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
            "example":[
                "AA12BB34CC56DD78EE90FF98DD11CC22",
                "11223344AABBCC55DD66EE77FF88GG99"
            ],
            "items":{
                "type":"string",
                "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
                "format":"uuid"
            }
        }
    },
    "description":"Request DTO for querying the EHR-to-EDC patient link status for a set of site IDs."
}

Nested Schema : siteIds

Type: array

Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.

Show Source

• Array of: string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.

{
    "type":"array",
    "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
    "example":[
        "AA12BB34CC56DD78EE90FF98DD11CC22",
        "11223344AABBCC55DD66EE77FF88GG99"
    ],
    "items":{
        "type":"string",
        "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
        "format":"uuid"
    }
}

Example:

[
    "AA12BB34CC56DD78EE90FF98DD11CC22",
    "11223344AABBCC55DD66EE77FF88GG99"
]

Examples

Select an example Site and Patient Link Status

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object EHRtoEDCPatientLinkStatusCollectionDTO
  Response wrapper containing an array of patient link statuses for one or more sites.

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

Nested Schema : EHRtoEDCPatientLinkStatusCollectionDTO

Type: object

Response wrapper containing an array of patient link statuses for one or more sites.

Show Source

• subjectLinks: object subjectLinks
  Result DTO detailing link status for a site in an EHR-to-EDC patient link status response.

{
    "type":"object",
    "properties":{
        "subjectLinks":{
            "type":"object",
            "properties":{
                "siteId":{
                    "type":"string",
                    "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
                    "example":"AB12CD34EF56A7890B12C34D56EF7890"
                },
                "subjectLinkStatus":{
                    "type":"string",
                    "description":"The EHR/EDC patient link status it values can LINKED/UNLINKED).",
                    "example":"LINKED"
                }
            },
            "description":"Result DTO detailing link status for a site in an EHR-to-EDC patient link status response."
        }
    },
    "description":"Response wrapper containing an array of patient link statuses for one or more sites."
}

Nested Schema : subjectLinks

Type: object

Result DTO detailing link status for a site in an EHR-to-EDC patient link status response.

Show Source

• siteId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.

  Example: AB12CD34EF56A7890B12C34D56EF7890
• subjectLinkStatus: string
  The EHR/EDC patient link status it values can LINKED/UNLINKED).

  Example: LINKED

{
    "type":"object",
    "properties":{
        "siteId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
            "example":"AB12CD34EF56A7890B12C34D56EF7890"
        },
        "subjectLinkStatus":{
            "type":"string",
            "description":"The EHR/EDC patient link status it values can LINKED/UNLINKED).",
            "example":"LINKED"
        }
    },
    "description":"Result DTO detailing link status for a site in an EHR-to-EDC patient link status response."
}

Examples

Select an example Get Site and Patient Link Status Example

400 Response

Bad request.

Body ()

Root Schema : DcsResponse

Type: object

Show Source

• 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)

{
    "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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"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"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

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

Back to Top