Jump to

• Request
• Response

V4.0

post

/ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/studyVersion/{studyVersion}/signSubject/subject/{subjectId}/code/{code}/orgId/{orgId}

Signs a subject and all completed visits in the subject. Repeating sections supported. Use V4 in addition to V3 it utilizes signDTO subject signature.

Request

Path Parameters

• code(required): string
  Code is sent via IAMS as initial sign

  Example:

  SIGN

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

  Example:

  test

• orgId(required): string
  IAMS Tenant Short Org ID in format of UUID, 32-character uppercase hexadecimal string

  Example:

  1A6C7162760B4DB0AF446F495FE55A61

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

  Example:

  C39E34A9152148E0BB831239BAA3E502

• studyVersion(required): string
  String representing the version of the study configuration or protocol. Helps track changes in form or study design.

  Example:

  2.0.0.38

• subjectId(required): string
  Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.

  Example:

  C39E34A9152148E0BB831239BAA3E502

Query Parameters

• redirectUriHostname: string
  Redirect URI

  Example:

  tenant-app.oracle.com

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request body for subject signature. Contains a list of signatures to process.

Show Source

• signRequest(required): object SignDTO
  Details for a single sign request for the subject signature API.

{
    "required":[
        "signRequest"
    ],
    "type":"object",
    "properties":{
        "signRequest":{
            "$ref":"#/components/schemas/SignDTO"
        }
    },
    "description":"Request body for subject signature. Contains a list of signatures to process."
}

Nested Schema : SignDTO

Type: object

Details for a single sign request for the subject signature API.

Show Source

• configId: string
  Signature configuration identifier (UUID, 32-character uppercase hexadecimal string).

  Example: F9E5DBD829B34E298CB6FF4ED60DC927
• eventId: string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.

  Example: 3234E620DE2E41D69A36571064E727B2
• eventInstanceNum: integer (int64)
  Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.

  Example: 1
• formId: string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.

  Example: 7DB612AF851A442098B674AA1A97AF36
• innerRepeat: integer (int64)
  Indicates the repeat sequence number of a nested or inner repeating form within an outer repeating structure. This value is used to distinguish multiple occurrences of the same inner form for a given outer repeat instance.

  Example: 0
• outerRepeat: integer (int64)
  Indicates the repeat sequence number of the primary or outer repeating form. This value identifies each top-level occurrence of a repeating form and serves as the parent context for any nested inner repeats.

  Example: 0
• signLevel: string
  Level at which signature is required. Typical values: SUBJECT_LEVEL, FORM_LEVEL.

  Example: SUBJECT_LEVEL

{
    "type":"object",
    "properties":{
        "signLevel":{
            "type":"string",
            "description":"Level at which signature is required. Typical values: SUBJECT_LEVEL, FORM_LEVEL.",
            "example":"SUBJECT_LEVEL"
        },
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.",
            "example":"3234E620DE2E41D69A36571064E727B2"
        },
        "eventInstanceNum":{
            "type":"integer",
            "description":"Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.",
            "format":"int64",
            "example":1
        },
        "configId":{
            "type":"string",
            "description":"Signature configuration identifier (UUID, 32-character uppercase hexadecimal string).",
            "example":"F9E5DBD829B34E298CB6FF4ED60DC927"
        },
        "innerRepeat":{
            "type":"integer",
            "description":"Indicates the repeat sequence number of a nested or inner repeating form within an outer repeating structure. This value is used to distinguish multiple occurrences of the same inner form for a given outer repeat instance.",
            "format":"int64",
            "example":0
        },
        "outerRepeat":{
            "type":"integer",
            "description":"Indicates the repeat sequence number of the primary or outer repeating form. This value identifies each top-level occurrence of a repeating form and serves as the parent context for any nested inner repeats.",
            "format":"int64",
            "example":0
        },
        "formId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
            "example":"7DB612AF851A442098B674AA1A97AF36"
        }
    },
    "description":"Details for a single sign request for the subject signature API."
}

Examples

Select an example subject signature request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Subjects sign success

Body ()

Root Schema : SignVerifyFreezeDTOv30

Type: object

Extends v20 by adding form section identifier and repeat form number for repeating forms.

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048

  Additional comments if provided

  Example: Data discrepancy observed and clarified
• eventId: string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.

  Example: AF77C6450BE94DE293C9630142E0AFAD
• eventInstanceNum: integer (int32)
  Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.

  Example: 3
• formId: string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.

  Example: 7978B7DD0A0A4CA899C485990994300C
• formSectionId: string
  ID (UUID, 32-character uppercase hexadecimal string) of the form section.

  Example: 0C50E26E482246B2BB9646C739E97CAA
• freeze: string
  Freeze status can be of FROZEN, UNFROZEN, NEVER_FROZEN

  Example: FROZEN
• id: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) for the Sign/Verify/Freeze record in UUID format

  Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• itemId: string
  Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.

  Example: 33CAF3CB1DF64DF5A353A337CBE6B50A
• objectVersionNumber: number
  Object version number

  Example: 1
• operationType: string
  Operation type on the record, can have values CREATED, MODIFIED or REMOVED

  Example: CREATED
• reason: string
  Minimum Length: 0

  Maximum Length: 255

  reason to make this change

  Example: Other
• repeatFormNumber: integer (int64)
  Represents the ordinal number assigned to a repeated instance of a data collection form. It uniquely identifies each occurrence of a repeating form for a subject when multiple instances of the form.

  Example: 0
• repeatSequenceNumber: integer (int64)
  Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.

  Example: 1
• signed: string
  Signed status can be of SIGNED, UNSIGNED, NEVER_SIGNED, PARTIAL_SIGNED

  Example: 2C3F40649C654D0F995A7FDBBCEA4FAB
• softwareVersionNumber: number
  Software version number

  Example: 100
• studyVersion: string
  String representing the version of the study configuration or protocol. Helps track changes in form or study design.

  Example: 2.0.0.38
• subjectId: string
  Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.

  Example: C39E34A9152148E0BB831239BAA3E502
• userId: string
  Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the user

  Example: 2C3F40649C654D0F995A7FDBBCEA4FAB
• verify: string
  Verify status can be UNVERIFIED, VERIFIED, NEVER_VERIFIED, VERIFY_REQUIRED

  Example: VERIFIED
• versionEnd: string (date-time)
  The end date until which the data is applicable or valid.

  Example: 2023-01-02T17:30:00Z
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

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

{
    "type":"object",
    "properties":{
        "formSectionId":{
            "type":"string",
            "description":"ID (UUID, 32-character uppercase hexadecimal string) of the form section.",
            "example":"0C50E26E482246B2BB9646C739E97CAA"
        },
        "id":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) for the Sign/Verify/Freeze record in UUID format",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time",
            "example":"2023-01-01T09:00:00Z"
        },
        "versionEnd":{
            "type":"string",
            "description":"The end date until which the data is applicable or valid.",
            "format":"date-time",
            "example":"2023-01-02T17:30:00Z"
        },
        "operationType":{
            "type":"string",
            "description":"Operation type on the record, can have values CREATED, MODIFIED or REMOVED",
            "example":"CREATED"
        },
        "userId":{
            "type":"string",
            "description":"Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the user",
            "example":"2C3F40649C654D0F995A7FDBBCEA4FAB"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object version number",
            "example":1
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Software version number",
            "example":100
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"reason to make this change",
            "example":"Other"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional comments if provided",
            "example":"Data discrepancy observed and clarified"
        },
        "formId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
            "example":"7978B7DD0A0A4CA899C485990994300C"
        },
        "subjectId":{
            "type":"string",
            "description":"Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.",
            "example":"C39E34A9152148E0BB831239BAA3E502"
        },
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.",
            "example":"AF77C6450BE94DE293C9630142E0AFAD"
        },
        "repeatSequenceNumber":{
            "type":"integer",
            "description":"Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.",
            "format":"int64",
            "example":1
        },
        "itemId":{
            "type":"string",
            "description":"Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.",
            "example":"33CAF3CB1DF64DF5A353A337CBE6B50A"
        },
        "signed":{
            "type":"string",
            "description":"Signed status can be of SIGNED, UNSIGNED, NEVER_SIGNED, PARTIAL_SIGNED ",
            "example":"2C3F40649C654D0F995A7FDBBCEA4FAB"
        },
        "verify":{
            "type":"string",
            "description":"Verify status can be UNVERIFIED, VERIFIED, NEVER_VERIFIED, VERIFY_REQUIRED",
            "example":"VERIFIED"
        },
        "freeze":{
            "type":"string",
            "description":"Freeze status can be of FROZEN, UNFROZEN, NEVER_FROZEN",
            "example":"FROZEN"
        },
        "studyVersion":{
            "type":"string",
            "description":"String representing the version of the study configuration or protocol. Helps track changes in form or study design.",
            "example":"2.0.0.38"
        },
        "eventInstanceNum":{
            "type":"integer",
            "description":"Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.",
            "format":"int32",
            "example":3
        },
        "repeatFormNumber":{
            "type":"integer",
            "description":"Represents the ordinal number assigned to a repeated instance of a data collection form. It uniquely identifies each occurrence of a repeating form for a subject when multiple instances of the form.",
            "format":"int64",
            "example":0
        }
    },
    "description":"Extends v20 by adding form section identifier and repeat form number for repeating forms."
}

Examples

Select an example Subject signature result

400 Response

Bad request.

Body ()

Root 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 : 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