REST API for Clinical One Cloud Service

V1.0

post

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

Creates lab data elements for a subject for a particular visit and particular form.

Request

Path Parameters

mode(required): string
Indicates the operational mode of the study. Accepted values: active, test, or training.
Example:
```
active
```
studyId(required): string(uuid)
Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.
Example:
```
1BC29B36F5D64B1B95F4BDBBCEA481BE
```

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

eventId(required): string

Unique identifier(UUID, 32-character uppercase hexadecimal string) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.

Example: 799EF3745FC545589F186D2198F3C65E
eventInstanceNum: integer (int32)

Numeric value representing the instance number of the event. Used for repeated or unscheduled visits (e.g., 1, 2, 3). It is null for scheduled events.

Example: 1
formId(required): string

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

Example: 899EF3745FC545589F186D2198F3C65E
labId: string

Unique identifier (UUID, 32-character uppercase hexadecimal string) of the lab normals record. Include for update requests; omit for new create.

Example: 999EF3745FC545589F186D2198F3C65E
siteId(required): string

Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.

Example: 699EF3745FC545589F186D2198F3C65E
studyVersion(required): string

String representing the version of the study. Helps track changes in form or study design.

Example: 1.0.0.3
subjectId(required): string

Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.

Example: A1B2C3D4E5F6471890ABCDEF12345678

{
    "required":[
        "eventId",
        "formId",
        "siteId",
        "studyVersion",
        "subjectId"
    ],
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string",
            "description":"Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "example":"A1B2C3D4E5F6471890ABCDEF12345678"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "example":"699EF3745FC545589F186D2198F3C65E"
        },
        "studyVersion":{
            "type":"string",
            "description":"String representing the version of the study. Helps track changes in form or study design.",
            "example":"1.0.0.3"
        },
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "example":"799EF3745FC545589F186D2198F3C65E"
        },
        "eventInstanceNum":{
            "type":"integer",
            "description":"Numeric value representing the instance number of the event. Used for repeated or unscheduled visits (e.g., 1, 2, 3). It is null for scheduled events.",
            "format":"int32",
            "example":1
        },
        "formId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
            "example":"899EF3745FC545589F186D2198F3C65E"
        },
        "labId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the lab normals record. Include for update requests; omit for new create.",
            "example":"999EF3745FC545589F186D2198F3C65E"
        }
    }
}

Examples

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : LabResponse

Type: object

Response containing lab normals processing status and created/updated data elements for v1

Show Source

items: array items

List of data elements generated or updated for the lab normals request
labnormalsStatus: array labnormalsStatus

List of lab normals processing status codes resulting from validation and mapping

{
    "type":"object",
    "properties":{
        "labnormalsStatus":{
            "type":"array",
            "description":"List of lab normals processing status codes resulting from validation and mapping",
            "example":[
                "SUCCESS"
            ],
            "items":{
                "type":"string",
                "description":"List of lab normals processing status codes resulting from validation and mapping",
                "example":"[\"SUCCESS\"]"
            }
        },
        "items":{
            "type":"array",
            "description":"List of data elements generated or updated for the lab normals request",
            "example":[
                {
                    "id":"1BC29B36F5D64B1B95F4BDBBCEA481BE",
                    "versionStart":"2025-10-16T14:30:31.892Z",
                    "transactionStart":"2025-10-16T14:30:31.892Z",
                    "transactionEnd":"2025-10-16T14:35:00.000Z",
                    "validationStatus":"SUCCESS",
                    "validationFailure":null,
                    "studyId":"ABCDEF1234567890ABCDEF1234567890",
                    "studyName":"STUDY-ABC",
                    "studyVersion":"21",
                    "subjectId":"10F75668189F422F9A461A315D211111",
                    "eventId":"ADF5A7800A954FA5B831E7B6B9CA39A9",
                    "formId":"FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF",
                    "formSectionId":"B6E0C7D5A1F3428C8B8B6A77C5E9D4AA",
                    "repeatSequenceNumber":1,
                    "itemId":"DEADBEEFDEADBEEFDEADBEEFDEADBEEF",
                    "siteId":"ABCDEF1234567890ABCDEF1234567890",
                    "variableId":"0123456789ABCDEF0123456789ABCDEF",
                    "originatorId":"FEDCBA9876543210FEDCBA9876543210",
                    "vendorCode":"VENDOR1",
                    "value":"13.5",
                    "measureUnit":"g/dL",
                    "normalizedValue":"A78AD8C31CD843CD8B847C06C0420FF5",
                    "normalizedUnitId":"A78AD8C31CD843CD8B847C06C0420FF5",
                    "numValue":13,
                    "floatValue":13.5,
                    "dateTimeValueUTC":"2025-10-16T14:30:31.892Z",
                    "monthValue":10,
                    "dayValue":16,
                    "yearValue":2025,
                    "hourValue":14,
                    "minuteValue":30,
                    "secondValue":31,
                    "reason":"Initial entry",
                    "comment":"Captured by device",
                    "objectVersionNumber":14,
                    "eventInstanceNum":1,
                    "targets":[
                        "93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE5",
                        "93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE7"
                    ],
                    "dataFlag":"1BC29B36F5D64B1B95F4BDBBCEA481BE",
                    "propertyId":"40DB4EF4847849CCB24EFCCB71CDA436",
                    "propertyVersionStart":"2025-10-16T14:30:31.892Z"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/DataElementDto6"
            }
        }
    },
    "description":"Response containing lab normals processing status and created/updated data elements for v1"
}

Nested Schema : items

Type: array

List of data elements generated or updated for the lab normals request

Show Source

Array of: object DataElementDto6

Data element response with additional property linkage details

{
    "type":"array",
    "description":"List of data elements generated or updated for the lab normals request",
    "example":[
        {
            "id":"1BC29B36F5D64B1B95F4BDBBCEA481BE",
            "versionStart":"2025-10-16T14:30:31.892Z",
            "transactionStart":"2025-10-16T14:30:31.892Z",
            "transactionEnd":"2025-10-16T14:35:00.000Z",
            "validationStatus":"SUCCESS",
            "validationFailure":null,
            "studyId":"ABCDEF1234567890ABCDEF1234567890",
            "studyName":"STUDY-ABC",
            "studyVersion":"21",
            "subjectId":"10F75668189F422F9A461A315D211111",
            "eventId":"ADF5A7800A954FA5B831E7B6B9CA39A9",
            "formId":"FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF",
            "formSectionId":"B6E0C7D5A1F3428C8B8B6A77C5E9D4AA",
            "repeatSequenceNumber":1,
            "itemId":"DEADBEEFDEADBEEFDEADBEEFDEADBEEF",
            "siteId":"ABCDEF1234567890ABCDEF1234567890",
            "variableId":"0123456789ABCDEF0123456789ABCDEF",
            "originatorId":"FEDCBA9876543210FEDCBA9876543210",
            "vendorCode":"VENDOR1",
            "value":"13.5",
            "measureUnit":"g/dL",
            "normalizedValue":"A78AD8C31CD843CD8B847C06C0420FF5",
            "normalizedUnitId":"A78AD8C31CD843CD8B847C06C0420FF5",
            "numValue":13,
            "floatValue":13.5,
            "dateTimeValueUTC":"2025-10-16T14:30:31.892Z",
            "monthValue":10,
            "dayValue":16,
            "yearValue":2025,
            "hourValue":14,
            "minuteValue":30,
            "secondValue":31,
            "reason":"Initial entry",
            "comment":"Captured by device",
            "objectVersionNumber":14,
            "eventInstanceNum":1,
            "targets":[
                "93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE5",
                "93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE7"
            ],
            "dataFlag":"1BC29B36F5D64B1B95F4BDBBCEA481BE",
            "propertyId":"40DB4EF4847849CCB24EFCCB71CDA436",
            "propertyVersionStart":"2025-10-16T14:30:31.892Z"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/DataElementDto6"
    }
}

Example:

[
    {
        "id":"1BC29B36F5D64B1B95F4BDBBCEA481BE",
        "versionStart":"2025-10-16T14:30:31.892Z",
        "transactionStart":"2025-10-16T14:30:31.892Z",
        "transactionEnd":"2025-10-16T14:35:00.000Z",
        "validationStatus":"SUCCESS",
        "validationFailure":null,
        "studyId":"ABCDEF1234567890ABCDEF1234567890",
        "studyName":"STUDY-ABC",
        "studyVersion":"21",
        "subjectId":"10F75668189F422F9A461A315D211111",
        "eventId":"ADF5A7800A954FA5B831E7B6B9CA39A9",
        "formId":"FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF",
        "formSectionId":"B6E0C7D5A1F3428C8B8B6A77C5E9D4AA",
        "repeatSequenceNumber":1,
        "itemId":"DEADBEEFDEADBEEFDEADBEEFDEADBEEF",
        "siteId":"ABCDEF1234567890ABCDEF1234567890",
        "variableId":"0123456789ABCDEF0123456789ABCDEF",
        "originatorId":"FEDCBA9876543210FEDCBA9876543210",
        "vendorCode":"VENDOR1",
        "value":"13.5",
        "measureUnit":"g/dL",
        "normalizedValue":"A78AD8C31CD843CD8B847C06C0420FF5",
        "normalizedUnitId":"A78AD8C31CD843CD8B847C06C0420FF5",
        "numValue":13,
        "floatValue":13.5,
        "dateTimeValueUTC":"2025-10-16T14:30:31.892Z",
        "monthValue":10,
        "dayValue":16,
        "yearValue":2025,
        "hourValue":14,
        "minuteValue":30,
        "secondValue":31,
        "reason":"Initial entry",
        "comment":"Captured by device",
        "objectVersionNumber":14,
        "eventInstanceNum":1,
        "targets":[
            "93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE5",
            "93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE7"
        ],
        "dataFlag":"1BC29B36F5D64B1B95F4BDBBCEA481BE",
        "propertyId":"40DB4EF4847849CCB24EFCCB71CDA436",
        "propertyVersionStart":"2025-10-16T14:30:31.892Z"
    }
]

Nested Schema : labnormalsStatus

Type: array

List of lab normals processing status codes resulting from validation and mapping

Show Source

Array of: string

List of lab normals processing status codes resulting from validation and mapping

Example: ["SUCCESS"]

{
    "type":"array",
    "description":"List of lab normals processing status codes resulting from validation and mapping",
    "example":[
        "SUCCESS"
    ],
    "items":{
        "type":"string",
        "description":"List of lab normals processing status codes resulting from validation and mapping",
        "example":"[\"SUCCESS\"]"
    }
}

Example:

[
    "SUCCESS"
]

Nested Schema : DataElementDto6

Type: object

Data element response with additional property linkage details

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048

Comment for the data element change

Example: Captured by device
dataFlag: string (UUID)

Unique Data flag identifier(UUID, 32-character uppercase hexadecimal string).

Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
dateTimeValueUTC: string (date-time)

Date-time value in UTC

Example: 2025-10-16T14:30:31.892Z
dayValue: integer (int32)

Day part of date

Example: 16
eventId: string (UUID)

Unique identifier(UUID, 32-character uppercase hexadecimal string) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.

Example: ADF5A7800A954FA5B831E7B6B9CA39A9
eventInstanceNum: integer (int32)

Numeric value representing the instance number of the event. Used for repeated or unscheduled visits (e.g., 1, 2, 3). It is null for scheduled events.

Example: 1
floatValue: number (decimal)

Numeric decimal value

Example: 12.34
formId: string (UUID)

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

Example: 40DB4EF4847849CCB24EFCCB71CDA436
formSectionId: string (UUID)

Unique identifier of the table within a two section form or lab form. Uses UUID in a 32-character uppercase hexadecimal string format.

Example: B6E0C7D5A1F3428C8B8B6A77C5E9D4AA
hourValue: integer (int32)

Hour part of time

Example: 14
id: string (UUID)

Unique identifier(UUID, 32-character uppercase hexadecimal string) of the data element

Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
itemId: string (UUID)

Unique identifier (UUID, 32-character uppercase hexadecimal string) of the question within a form. This ID corresponds to the reference code set by the study designer when creating or updating a form question in draft mode.

Example: DEADBEEFDEADBEEFDEADBEEFDEADBEEF
measureUnit: string

Minimum Length: 0

Maximum Length: 64

Measurement unit

Example: mg/dL
minuteValue: integer (int32)

Minute part of time

Example: 30
monthValue: integer (int32)

Month part of date

Example: 10
normalizedUnitId: string

Identifier of normalized unit

Example: A78AD8C31CD843CD8B847C06C0420FF5
normalizedValue: string

Minimum Length: 0

Maximum Length: 100

Normalized value if applicable

Example: 120
numValue: integer (int32)

Numeric integer value

Example: 120
objectVersionNumber: number

Audit trail field that represents the version number of the data.

Example: 14
originatorId: string (UUID)

An identifier representing the system, or user that initiated the transaction (UUID, 32-character uppercase hexadecimal string).

Example: FEDCBA9876543210FEDCBA9876543210
propertyId: string

Unique Identfier (UUID, 32-character uppercase hexadecimal string) of data capture properties

Example: AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
propertyVersionStart: 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
reason: string

Minimum Length: 0

Maximum Length: 255

Reason associated with the data element change

Example: Initial entry
repeatSequenceNumber: integer (int32)

Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.

Example: 1
secondValue: integer (int32)

Second part of time

Example: 31
siteId: string (UUID)

Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.

Example: ABCDEF1234567890ABCDEF1234567890
studyId: string (UUID)

Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

Example: ABCDEF1234567890ABCDEF1234567890
studyName: string

Minimum Length: 0

Maximum Length: 100

Study name

Example: STUDY-ABC
studyVersion(required): string

Minimum Length: 0

Maximum Length: 100

String representing the version of the study. Helps track changes in form or study design.

Example: 3.0.0.1
subjectId: string (UUID)

Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.

Example: 10F75668189F422F9A461A315D211111
transactionEnd: string (date-time)

The date and time at which the transaction processing completed.

Example: 2025-10-16T14:30:31.892Z
transactionStart: string (date-time)

The date and time at which the transaction processing began.

Example: 2025-10-16T14:30:31.892Z
validationFailure: string

Minimum Length: 0

Maximum Length: 32767

Validation failure details if any

Example: Incorrect values not allowed
validationStatus: string

Minimum Length: 0

Maximum Length: 25

Validation status of the data element. The validation status can be null or SUCCESS.

Example: SUCCESS
value: string

Minimum Length: 0

Maximum Length: 4000

Raw value captured for the item

Example: 120
variableId: string (UUID)

Variable identifier (UUID, 32-character uppercase hexadecimal string) in uppercase hex format.

Example: 0123456789ABCDEF0123456789ABCDEF
vendorCode: string

Minimum Length: 0

Maximum Length: 100

Vendor code if provided

Example: VENDOR1
versionStart: string (date-time)

The timestamp marking the beginning of the validity period for this record version within the system.

Example: 2025-10-16T14:30:31.892Z
yearValue: integer (int32)

Year part of date

Example: 2025

{
    "required":[
        "studyVersion"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) of the data element",
            "format":"UUID",
            "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":"2025-10-16T14:30:31.892Z"
        },
        "transactionStart":{
            "type":"string",
            "description":"The date and time at which the transaction processing began.",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "transactionEnd":{
            "type":"string",
            "description":"The date and time at which the transaction processing completed.",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "validationStatus":{
            "maxLength":25,
            "minLength":0,
            "type":"string",
            "description":"Validation status of the data element. The validation status can be null or SUCCESS.",
            "example":"SUCCESS"
        },
        "validationFailure":{
            "maxLength":32767,
            "minLength":0,
            "type":"string",
            "description":"Validation failure details if any",
            "example":"Incorrect values not allowed"
        },
        "studyId":{
            "type":"string",
            "description":"Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "format":"UUID",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "studyName":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Study name",
            "example":"STUDY-ABC"
        },
        "studyVersion":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"String representing the version of the study. Helps track changes in form or study design.",
            "example":"3.0.0.1"
        },
        "subjectId":{
            "type":"string",
            "description":"Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "format":"UUID",
            "example":"10F75668189F422F9A461A315D211111"
        },
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "format":"UUID",
            "example":"ADF5A7800A954FA5B831E7B6B9CA39A9"
        },
        "formId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
            "format":"UUID",
            "example":"40DB4EF4847849CCB24EFCCB71CDA436"
        },
        "formSectionId":{
            "type":"string",
            "description":"Unique identifier of the table within a two section form or lab form. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "format":"UUID",
            "example":"B6E0C7D5A1F3428C8B8B6A77C5E9D4AA"
        },
        "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":"int32",
            "example":1
        },
        "itemId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the question within a form. This ID corresponds to the reference code set by the study designer when creating or updating a form question in draft mode.",
            "format":"UUID",
            "example":"DEADBEEFDEADBEEFDEADBEEFDEADBEEF"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "format":"UUID",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "variableId":{
            "type":"string",
            "description":"Variable identifier (UUID, 32-character uppercase hexadecimal string) in uppercase hex format.",
            "format":"UUID",
            "example":"0123456789ABCDEF0123456789ABCDEF"
        },
        "originatorId":{
            "type":"string",
            "description":"An identifier representing the system, or user that initiated the transaction (UUID, 32-character uppercase hexadecimal string).",
            "format":"UUID",
            "example":"FEDCBA9876543210FEDCBA9876543210"
        },
        "vendorCode":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Vendor code if provided",
            "example":"VENDOR1"
        },
        "value":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Raw value captured for the item",
            "example":"120"
        },
        "measureUnit":{
            "maxLength":64,
            "minLength":0,
            "type":"string",
            "description":"Measurement unit",
            "example":"mg/dL"
        },
        "normalizedValue":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Normalized value if applicable",
            "example":"120"
        },
        "normalizedUnitId":{
            "type":"string",
            "description":"Identifier of normalized unit",
            "example":"A78AD8C31CD843CD8B847C06C0420FF5"
        },
        "numValue":{
            "type":"integer",
            "description":"Numeric integer value",
            "format":"int32",
            "example":120
        },
        "floatValue":{
            "type":"number",
            "description":"Numeric decimal value",
            "format":"decimal",
            "example":12.34
        },
        "dateTimeValueUTC":{
            "type":"string",
            "description":"Date-time value in UTC",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "monthValue":{
            "type":"integer",
            "description":"Month part of date",
            "format":"int32",
            "example":10
        },
        "dayValue":{
            "type":"integer",
            "description":"Day part of date",
            "format":"int32",
            "example":16
        },
        "yearValue":{
            "type":"integer",
            "description":"Year part of date",
            "format":"int32",
            "example":2025
        },
        "hourValue":{
            "type":"integer",
            "description":"Hour part of time",
            "format":"int32",
            "example":14
        },
        "minuteValue":{
            "type":"integer",
            "description":"Minute part of time",
            "format":"int32",
            "example":30
        },
        "secondValue":{
            "type":"integer",
            "description":"Second part of time",
            "format":"int32",
            "example":31
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason associated with the data element change",
            "example":"Initial entry"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Comment for the data element change",
            "example":"Captured by device"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Audit trail field that represents the version number of the data.",
            "example":14
        },
        "eventInstanceNum":{
            "type":"integer",
            "description":"Numeric value representing the instance number of the event. Used for repeated or unscheduled visits (e.g., 1, 2, 3). It is null for scheduled events.",
            "format":"int32",
            "example":1
        },
        "dataFlag":{
            "type":"string",
            "description":"Unique Data flag identifier(UUID, 32-character uppercase hexadecimal string).",
            "format":"UUID",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "propertyId":{
            "type":"string",
            "description":"Unique Identfier (UUID, 32-character uppercase hexadecimal string) of data capture properties",
            "example":"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
        },
        "propertyVersionStart":{
            "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"
        }
    },
    "description":"Data element response with additional property linkage details"
}

Examples

400 Response

Bad request.

Root Schema : DcsResponse

Type: object

Show Source

errorData: object ErrorResponseData
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

Show Source

details: object details
errorCode: string
errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object