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
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

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

  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 of the site. Uses UUID in a 32-character uppercase hexadecimal string format.

{
    "type":"object",
    "properties":{
        "siteIds":{
            "type":"array",
            "description":"Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "example":[
                "AA12BB34CC56DD78EE90FF98DD11CC22",
                "11223344AABBCC55DD66EE77FF88GG99"
            ],
            "items":{
                "type":"string",
                "description":"Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.",
                "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 of the site. Uses UUID in a 32-character uppercase hexadecimal string format.

Show Source

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

{
    "type":"array",
    "description":"Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.",
    "example":[
        "AA12BB34CC56DD78EE90FF98DD11CC22",
        "11223344AABBCC55DD66EE77FF88GG99"
    ],
    "items":{
        "type":"string",
        "description":"Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.",
        "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 of the site. Uses UUID in a 32-character uppercase hexadecimal string format.",
                    "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 of the site. Uses UUID in a 32-character uppercase hexadecimal string format.

  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 of the site. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "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
  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