Jump to

• Request
• Response

v1.0

post

/ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/visit/verify/history

Retrieves either the latest or the audit records for Source Data Verification (SDV) with site information where visit was completed.

Request

Path Parameters

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

  Example:

  active

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

  Example:

  5D5F9311C591424F852B99FD902E98A4

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request to fetch visit verify history for specified subjects within a date range. Dates must be provided in dd-MMM-yyyy format (Example- 01-Jan-2023).

Show Source

• endDate: string (date-time)
  End date in dd-MMM-yyyy format
• startDate: string (date-time)
  Start date in dd-MMM-yyyy format
• subjects: array subjects
  List of subject unique identifiers in UUID, 32-character uppercase hexadecimal string format to filter by

{
    "type":"object",
    "properties":{
        "subjects":{
            "type":"array",
            "description":"List of subject unique identifiers in UUID, 32-character uppercase hexadecimal string format to filter by",
            "example":[
                "5D5F9311C591424F852B99FD902E98A4",
                "6D5F9311C591424F852B99FD902E98A4"
            ],
            "items":{
                "type":"string",
                "description":"List of subject unique identifiers in UUID, 32-character uppercase hexadecimal string format to filter by",
                "format":"uuid"
            }
        },
        "startDate":{
            "type":"string",
            "description":"Start date in dd-MMM-yyyy format",
            "format":"date-time"
        },
        "endDate":{
            "type":"string",
            "description":"End date in dd-MMM-yyyy format",
            "format":"date-time"
        }
    },
    "description":"Request to fetch visit verify history for specified subjects within a date range. Dates must be provided in dd-MMM-yyyy format (Example- 01-Jan-2023)."
}

Nested Schema : subjects

Type: array

List of subject unique identifiers in UUID, 32-character uppercase hexadecimal string format to filter by

Show Source

• Array of: string(uuid)
  List of subject unique identifiers in UUID, 32-character uppercase hexadecimal string format to filter by

{
    "type":"array",
    "description":"List of subject unique identifiers in UUID, 32-character uppercase hexadecimal string format to filter by",
    "example":[
        "5D5F9311C591424F852B99FD902E98A4",
        "6D5F9311C591424F852B99FD902E98A4"
    ],
    "items":{
        "type":"string",
        "description":"List of subject unique identifiers in UUID, 32-character uppercase hexadecimal string format to filter by",
        "format":"uuid"
    }
}

Example:

[
    "5D5F9311C591424F852B99FD902E98A4",
    "6D5F9311C591424F852B99FD902E98A4"
]

Examples

Select an example SubjectVisitVerifyHistoryRequest

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object SubjectVisitVerifyHistoryDto2
  Visit verification history for a subject and event including version window, siteId and study version.

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

Nested Schema : SubjectVisitVerifyHistoryDto2

Type: object

Visit verification history for a subject and event including version window, siteId and study version.

Show Source

• eventId: string
  Study event identifier

  Example: ADF5A7800A954FA5B831E7B6B9CA39A9
• eventInstanceNum: integer (int64)
  Instance number of the event

  Example: 1
• siteId: string
  Site identifier where the visit verification occurred

  Example: SITE001
• studyVersion: string
  Study version string

  Example: 3.0.0.1
• subjectId: string
  Subject identifier

  Example: 93CC828113AC439181071CB44D2C6FE5
• verifyStatus: string
  Verification status of the subject's visit, Example values can be SIGNED, VERIFIED, UNSIGNED, UNVERIFIED, NEVER_SIGNED, NEVER_VERIFIED, VERIFY_REQUIRED, NOT_APPLICABLE, FROZEN, UNFROZEN, NEVER_FROZEN, PARTIAL_SIGNED

  Example: VERIFIED
• versionEnd: string (date-time)
  End of version validity window (exclusive, if present)

  Example: 2023-01-31T09:00:00Z
• versionSatrt: string (date-time)
  Start of version validity window (inclusive)

  Example: 2023-01-01T09:00:00Z

{
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string",
            "description":"Subject identifier",
            "example":"93CC828113AC439181071CB44D2C6FE5"
        },
        "eventId":{
            "type":"string",
            "description":"Study event identifier",
            "example":"ADF5A7800A954FA5B831E7B6B9CA39A9"
        },
        "verifyStatus":{
            "type":"string",
            "description":"Verification status of the subject's visit, Example values can be SIGNED, VERIFIED, UNSIGNED, UNVERIFIED, NEVER_SIGNED, NEVER_VERIFIED, VERIFY_REQUIRED, NOT_APPLICABLE, FROZEN, UNFROZEN, NEVER_FROZEN, PARTIAL_SIGNED",
            "example":"VERIFIED"
        },
        "eventInstanceNum":{
            "type":"integer",
            "description":"Instance number of the event",
            "format":"int64",
            "example":1
        },
        "versionSatrt":{
            "type":"string",
            "description":"Start of version validity window (inclusive)",
            "format":"date-time",
            "example":"2023-01-01T09:00:00Z"
        },
        "versionEnd":{
            "type":"string",
            "description":"End of version validity window (exclusive, if present)",
            "format":"date-time",
            "example":"2023-01-31T09:00:00Z"
        },
        "studyVersion":{
            "type":"string",
            "description":"Study version string",
            "example":"3.0.0.1"
        },
        "siteId":{
            "type":"string",
            "description":"Site identifier where the visit verification occurred",
            "example":"SITE001"
        }
    },
    "description":"Visit verification history for a subject and event including version window, siteId and study version."
}

Examples

Select an example SubjectVisitVerifyHistoryDto2Response

Back to Top