1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Data Capture
  4. Lab
  5. Create lab for a subject

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
  • Indicates the operational mode of the study. Accepted values: active, test, or training.
    Example:
    active
  • Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.
    Example:
    1BC29B36F5D64B1B95F4BDBBCEA481BE
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • 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
  • 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
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.
    Example: 899EF3745FC545589F186D2198F3C65E
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) of the lab normals record. Include for update requests; omit for new create.
    Example: 999EF3745FC545589F186D2198F3C65E
  • Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.
    Example: 699EF3745FC545589F186D2198F3C65E
  • String representing the version of the study. Helps track changes in form or study design.
    Example: 1.0.0.3
  • 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
Examples

Back to Top

Response

Supported Media Types

200 Response

Success
Body ()
Root Schema : LabResponse
Type: object
Show Source
Nested Schema : labAddresses
Type: array
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : LabDetailsDto
Type: object
Show Source
Example:
{
    "studyLabId":"B1B8327AFAA6412287106192AB5984EF",
    "labId":"B1B8327AFAA6412287106192AB5984EF",
    "labStatus":"ACTIVE"
}
Nested Schema : labProperties
Type: array
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : SDFAddressAssociationDetailsDto
Type: object
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : entityAddressProperties
Type: array
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : sdfAddressProperties
Type: array
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : PROPERTY_DTO_TITLE
Type: object
Title: PROPERTY_DTO_TITLE
PROPERTY_DTO_DESC
Show Source
  • Title: Comment
    Minimum Length: 0
    Maximum Length: 2048
    Additional comment captured for the audited update.
    Example: Association adjusted after data reconciliation.
  • ENTITY_ID_DESC
    Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
  • Title: PROPERTY_DTO_ENTITY_TYPE_TITLE
    Minimum Length: 0
    Maximum Length: 50
    PROPERTY_DTO_ENTITY_TYPE_DESC
    Example: INSTITUTION
  • Title: PROPERTY_DTO_NAME_TITLE
    Minimum Length: 0
    Maximum Length: 100
    PROPERTY_DTO_NAME_DESC
    Example: LabId
  • Title: PROPERTY_DTO_VALUE_TITLE
    Minimum Length: 0
    Maximum Length: 500
    PROPERTY_DTO_VALUE_DESC
    Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
  • Title: Reason
    Minimum Length: 0
    Maximum Length: 255
    Reason provided for the audited update.
    Example: Protocol update requested by study operations.
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : SDFPropertyDetailsDto
Type: object
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Examples

400 Response

Bad request.
Body ()
Root Schema : DcsResponse
Type: object
Show Source
Nested Schema : ErrorResponseData
Type: object
Title: ErrorResponseData
Error Response Details Information
Show Source
  • Object
    Title: Object
    Object with error details information.
  • Error code which is stored in ErrorCode enum. Example : C1-003
    Example: C1-003
  • 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
Nested Schema : result
Type: object
Nested Schema : Object
Type: object
Title: Object
Object with error details information.
Example:
{
    "field":"studyId",
    "reason":"Invalid value"
}
Back to Top